# Actions
<a name="API_Operations"></a>

The following actions are supported by Amazon Connect Service:
+  [ActivateEvaluationForm](API_ActivateEvaluationForm.md) 
+  [AssociateAnalyticsDataSet](API_AssociateAnalyticsDataSet.md) 
+  [AssociateApprovedOrigin](API_AssociateApprovedOrigin.md) 
+  [AssociateBot](API_AssociateBot.md) 
+  [AssociateContactWithUser](API_AssociateContactWithUser.md) 
+  [AssociateDefaultVocabulary](API_AssociateDefaultVocabulary.md) 
+  [AssociateEmailAddressAlias](API_AssociateEmailAddressAlias.md) 
+  [AssociateFlow](API_AssociateFlow.md) 
+  [AssociateHoursOfOperations](API_AssociateHoursOfOperations.md) 
+  [AssociateInstanceStorageConfig](API_AssociateInstanceStorageConfig.md) 
+  [AssociateLambdaFunction](API_AssociateLambdaFunction.md) 
+  [AssociateLexBot](API_AssociateLexBot.md) 
+  [AssociatePhoneNumberContactFlow](API_AssociatePhoneNumberContactFlow.md) 
+  [AssociateQueueEmailAddresses](API_AssociateQueueEmailAddresses.md) 
+  [AssociateQueueQuickConnects](API_AssociateQueueQuickConnects.md) 
+  [AssociateRoutingProfileQueues](API_AssociateRoutingProfileQueues.md) 
+  [AssociateSecurityKey](API_AssociateSecurityKey.md) 
+  [AssociateSecurityProfiles](API_AssociateSecurityProfiles.md) 
+  [AssociateTrafficDistributionGroupUser](API_AssociateTrafficDistributionGroupUser.md) 
+  [AssociateUserProficiencies](API_AssociateUserProficiencies.md) 
+  [AssociateWorkspace](API_AssociateWorkspace.md) 
+  [BatchAssociateAnalyticsDataSet](API_BatchAssociateAnalyticsDataSet.md) 
+  [BatchCreateDataTableValue](API_BatchCreateDataTableValue.md) 
+  [BatchDeleteDataTableValue](API_BatchDeleteDataTableValue.md) 
+  [BatchDescribeDataTableValue](API_BatchDescribeDataTableValue.md) 
+  [BatchDisassociateAnalyticsDataSet](API_BatchDisassociateAnalyticsDataSet.md) 
+  [BatchGetAttachedFileMetadata](API_BatchGetAttachedFileMetadata.md) 
+  [BatchGetFlowAssociation](API_BatchGetFlowAssociation.md) 
+  [BatchPutContact](API_BatchPutContact.md) 
+  [BatchUpdateDataTableValue](API_BatchUpdateDataTableValue.md) 
+  [ClaimPhoneNumber](API_ClaimPhoneNumber.md) 
+  [CompleteAttachedFileUpload](API_CompleteAttachedFileUpload.md) 
+  [CreateAgentStatus](API_CreateAgentStatus.md) 
+  [CreateContact](API_CreateContact.md) 
+  [CreateContactFlow](API_CreateContactFlow.md) 
+  [CreateContactFlowModule](API_CreateContactFlowModule.md) 
+  [CreateContactFlowModuleAlias](API_CreateContactFlowModuleAlias.md) 
+  [CreateContactFlowModuleVersion](API_CreateContactFlowModuleVersion.md) 
+  [CreateContactFlowVersion](API_CreateContactFlowVersion.md) 
+  [CreateDataTable](API_CreateDataTable.md) 
+  [CreateDataTableAttribute](API_CreateDataTableAttribute.md) 
+  [CreateEmailAddress](API_CreateEmailAddress.md) 
+  [CreateEvaluationForm](API_CreateEvaluationForm.md) 
+  [CreateHoursOfOperation](API_CreateHoursOfOperation.md) 
+  [CreateHoursOfOperationOverride](API_CreateHoursOfOperationOverride.md) 
+  [CreateInstance](API_CreateInstance.md) 
+  [CreateIntegrationAssociation](API_CreateIntegrationAssociation.md) 
+  [CreateNotification](API_CreateNotification.md) 
+  [CreateParticipant](API_CreateParticipant.md) 
+  [CreatePersistentContactAssociation](API_CreatePersistentContactAssociation.md) 
+  [CreatePredefinedAttribute](API_CreatePredefinedAttribute.md) 
+  [CreatePrompt](API_CreatePrompt.md) 
+  [CreatePushNotificationRegistration](API_CreatePushNotificationRegistration.md) 
+  [CreateQueue](API_CreateQueue.md) 
+  [CreateQuickConnect](API_CreateQuickConnect.md) 
+  [CreateRoutingProfile](API_CreateRoutingProfile.md) 
+  [CreateRule](API_CreateRule.md) 
+  [CreateSecurityProfile](API_CreateSecurityProfile.md) 
+  [CreateTaskTemplate](API_CreateTaskTemplate.md) 
+  [CreateTestCase](API_CreateTestCase.md) 
+  [CreateTrafficDistributionGroup](API_CreateTrafficDistributionGroup.md) 
+  [CreateUseCase](API_CreateUseCase.md) 
+  [CreateUser](API_CreateUser.md) 
+  [CreateUserHierarchyGroup](API_CreateUserHierarchyGroup.md) 
+  [CreateView](API_CreateView.md) 
+  [CreateViewVersion](API_CreateViewVersion.md) 
+  [CreateVocabulary](API_CreateVocabulary.md) 
+  [CreateWorkspace](API_CreateWorkspace.md) 
+  [CreateWorkspacePage](API_CreateWorkspacePage.md) 
+  [DeactivateEvaluationForm](API_DeactivateEvaluationForm.md) 
+  [DeleteAttachedFile](API_DeleteAttachedFile.md) 
+  [DeleteContactEvaluation](API_DeleteContactEvaluation.md) 
+  [DeleteContactFlow](API_DeleteContactFlow.md) 
+  [DeleteContactFlowModule](API_DeleteContactFlowModule.md) 
+  [DeleteContactFlowModuleAlias](API_DeleteContactFlowModuleAlias.md) 
+  [DeleteContactFlowModuleVersion](API_DeleteContactFlowModuleVersion.md) 
+  [DeleteContactFlowVersion](API_DeleteContactFlowVersion.md) 
+  [DeleteDataTable](API_DeleteDataTable.md) 
+  [DeleteDataTableAttribute](API_DeleteDataTableAttribute.md) 
+  [DeleteEmailAddress](API_DeleteEmailAddress.md) 
+  [DeleteEvaluationForm](API_DeleteEvaluationForm.md) 
+  [DeleteHoursOfOperation](API_DeleteHoursOfOperation.md) 
+  [DeleteHoursOfOperationOverride](API_DeleteHoursOfOperationOverride.md) 
+  [DeleteInstance](API_DeleteInstance.md) 
+  [DeleteIntegrationAssociation](API_DeleteIntegrationAssociation.md) 
+  [DeleteNotification](API_DeleteNotification.md) 
+  [DeletePredefinedAttribute](API_DeletePredefinedAttribute.md) 
+  [DeletePrompt](API_DeletePrompt.md) 
+  [DeletePushNotificationRegistration](API_DeletePushNotificationRegistration.md) 
+  [DeleteQueue](API_DeleteQueue.md) 
+  [DeleteQuickConnect](API_DeleteQuickConnect.md) 
+  [DeleteRoutingProfile](API_DeleteRoutingProfile.md) 
+  [DeleteRule](API_DeleteRule.md) 
+  [DeleteSecurityProfile](API_DeleteSecurityProfile.md) 
+  [DeleteTaskTemplate](API_DeleteTaskTemplate.md) 
+  [DeleteTestCase](API_DeleteTestCase.md) 
+  [DeleteTrafficDistributionGroup](API_DeleteTrafficDistributionGroup.md) 
+  [DeleteUseCase](API_DeleteUseCase.md) 
+  [DeleteUser](API_DeleteUser.md) 
+  [DeleteUserHierarchyGroup](API_DeleteUserHierarchyGroup.md) 
+  [DeleteView](API_DeleteView.md) 
+  [DeleteViewVersion](API_DeleteViewVersion.md) 
+  [DeleteVocabulary](API_DeleteVocabulary.md) 
+  [DeleteWorkspace](API_DeleteWorkspace.md) 
+  [DeleteWorkspaceMedia](API_DeleteWorkspaceMedia.md) 
+  [DeleteWorkspacePage](API_DeleteWorkspacePage.md) 
+  [DescribeAgentStatus](API_DescribeAgentStatus.md) 
+  [DescribeAuthenticationProfile](API_DescribeAuthenticationProfile.md) 
+  [DescribeContact](API_DescribeContact.md) 
+  [DescribeContactEvaluation](API_DescribeContactEvaluation.md) 
+  [DescribeContactFlow](API_DescribeContactFlow.md) 
+  [DescribeContactFlowModule](API_DescribeContactFlowModule.md) 
+  [DescribeContactFlowModuleAlias](API_DescribeContactFlowModuleAlias.md) 
+  [DescribeDataTable](API_DescribeDataTable.md) 
+  [DescribeDataTableAttribute](API_DescribeDataTableAttribute.md) 
+  [DescribeEmailAddress](API_DescribeEmailAddress.md) 
+  [DescribeEvaluationForm](API_DescribeEvaluationForm.md) 
+  [DescribeHoursOfOperation](API_DescribeHoursOfOperation.md) 
+  [DescribeHoursOfOperationOverride](API_DescribeHoursOfOperationOverride.md) 
+  [DescribeInstance](API_DescribeInstance.md) 
+  [DescribeInstanceAttribute](API_DescribeInstanceAttribute.md) 
+  [DescribeInstanceStorageConfig](API_DescribeInstanceStorageConfig.md) 
+  [DescribeNotification](API_DescribeNotification.md) 
+  [DescribePhoneNumber](API_DescribePhoneNumber.md) 
+  [DescribePredefinedAttribute](API_DescribePredefinedAttribute.md) 
+  [DescribePrompt](API_DescribePrompt.md) 
+  [DescribeQueue](API_DescribeQueue.md) 
+  [DescribeQuickConnect](API_DescribeQuickConnect.md) 
+  [DescribeRoutingProfile](API_DescribeRoutingProfile.md) 
+  [DescribeRule](API_DescribeRule.md) 
+  [DescribeSecurityProfile](API_DescribeSecurityProfile.md) 
+  [DescribeTestCase](API_DescribeTestCase.md) 
+  [DescribeTrafficDistributionGroup](API_DescribeTrafficDistributionGroup.md) 
+  [DescribeUser](API_DescribeUser.md) 
+  [DescribeUserHierarchyGroup](API_DescribeUserHierarchyGroup.md) 
+  [DescribeUserHierarchyStructure](API_DescribeUserHierarchyStructure.md) 
+  [DescribeView](API_DescribeView.md) 
+  [DescribeVocabulary](API_DescribeVocabulary.md) 
+  [DescribeWorkspace](API_DescribeWorkspace.md) 
+  [DisassociateAnalyticsDataSet](API_DisassociateAnalyticsDataSet.md) 
+  [DisassociateApprovedOrigin](API_DisassociateApprovedOrigin.md) 
+  [DisassociateBot](API_DisassociateBot.md) 
+  [DisassociateEmailAddressAlias](API_DisassociateEmailAddressAlias.md) 
+  [DisassociateFlow](API_DisassociateFlow.md) 
+  [DisassociateHoursOfOperations](API_DisassociateHoursOfOperations.md) 
+  [DisassociateInstanceStorageConfig](API_DisassociateInstanceStorageConfig.md) 
+  [DisassociateLambdaFunction](API_DisassociateLambdaFunction.md) 
+  [DisassociateLexBot](API_DisassociateLexBot.md) 
+  [DisassociatePhoneNumberContactFlow](API_DisassociatePhoneNumberContactFlow.md) 
+  [DisassociateQueueEmailAddresses](API_DisassociateQueueEmailAddresses.md) 
+  [DisassociateQueueQuickConnects](API_DisassociateQueueQuickConnects.md) 
+  [DisassociateRoutingProfileQueues](API_DisassociateRoutingProfileQueues.md) 
+  [DisassociateSecurityKey](API_DisassociateSecurityKey.md) 
+  [DisassociateSecurityProfiles](API_DisassociateSecurityProfiles.md) 
+  [DisassociateTrafficDistributionGroupUser](API_DisassociateTrafficDistributionGroupUser.md) 
+  [DisassociateUserProficiencies](API_DisassociateUserProficiencies.md) 
+  [DisassociateWorkspace](API_DisassociateWorkspace.md) 
+  [DismissUserContact](API_DismissUserContact.md) 
+  [EvaluateDataTableValues](API_EvaluateDataTableValues.md) 
+  [GetAttachedFile](API_GetAttachedFile.md) 
+  [GetContactAttributes](API_GetContactAttributes.md) 
+  [GetContactMetrics](API_GetContactMetrics.md) 
+  [GetCurrentMetricData](API_GetCurrentMetricData.md) 
+  [GetCurrentUserData](API_GetCurrentUserData.md) 
+  [GetEffectiveHoursOfOperations](API_GetEffectiveHoursOfOperations.md) 
+  [GetFederationToken](API_GetFederationToken.md) 
+  [GetFlowAssociation](API_GetFlowAssociation.md) 
+  [GetMetricData](API_GetMetricData.md) 
+  [GetMetricDataV2](API_GetMetricDataV2.md) 
+  [GetPromptFile](API_GetPromptFile.md) 
+  [GetTaskTemplate](API_GetTaskTemplate.md) 
+  [GetTestCaseExecutionSummary](API_GetTestCaseExecutionSummary.md) 
+  [GetTrafficDistribution](API_GetTrafficDistribution.md) 
+  [ImportPhoneNumber](API_ImportPhoneNumber.md) 
+  [ImportWorkspaceMedia](API_ImportWorkspaceMedia.md) 
+  [ListAgentStatuses](API_ListAgentStatuses.md) 
+  [ListAnalyticsDataAssociations](API_ListAnalyticsDataAssociations.md) 
+  [ListAnalyticsDataLakeDataSets](API_ListAnalyticsDataLakeDataSets.md) 
+  [ListApprovedOrigins](API_ListApprovedOrigins.md) 
+  [ListAssociatedContacts](API_ListAssociatedContacts.md) 
+  [ListAuthenticationProfiles](API_ListAuthenticationProfiles.md) 
+  [ListBots](API_ListBots.md) 
+  [ListChildHoursOfOperations](API_ListChildHoursOfOperations.md) 
+  [ListContactEvaluations](API_ListContactEvaluations.md) 
+  [ListContactFlowModuleAliases](API_ListContactFlowModuleAliases.md) 
+  [ListContactFlowModules](API_ListContactFlowModules.md) 
+  [ListContactFlowModuleVersions](API_ListContactFlowModuleVersions.md) 
+  [ListContactFlows](API_ListContactFlows.md) 
+  [ListContactFlowVersions](API_ListContactFlowVersions.md) 
+  [ListContactReferences](API_ListContactReferences.md) 
+  [ListDataTableAttributes](API_ListDataTableAttributes.md) 
+  [ListDataTablePrimaryValues](API_ListDataTablePrimaryValues.md) 
+  [ListDataTables](API_ListDataTables.md) 
+  [ListDataTableValues](API_ListDataTableValues.md) 
+  [ListDefaultVocabularies](API_ListDefaultVocabularies.md) 
+  [ListEntitySecurityProfiles](API_ListEntitySecurityProfiles.md) 
+  [ListEvaluationForms](API_ListEvaluationForms.md) 
+  [ListEvaluationFormVersions](API_ListEvaluationFormVersions.md) 
+  [ListFlowAssociations](API_ListFlowAssociations.md) 
+  [ListHoursOfOperationOverrides](API_ListHoursOfOperationOverrides.md) 
+  [ListHoursOfOperations](API_ListHoursOfOperations.md) 
+  [ListInstanceAttributes](API_ListInstanceAttributes.md) 
+  [ListInstances](API_ListInstances.md) 
+  [ListInstanceStorageConfigs](API_ListInstanceStorageConfigs.md) 
+  [ListIntegrationAssociations](API_ListIntegrationAssociations.md) 
+  [ListLambdaFunctions](API_ListLambdaFunctions.md) 
+  [ListLexBots](API_ListLexBots.md) 
+  [ListNotifications](API_ListNotifications.md) 
+  [ListPhoneNumbers](API_ListPhoneNumbers.md) 
+  [ListPhoneNumbersV2](API_ListPhoneNumbersV2.md) 
+  [ListPredefinedAttributes](API_ListPredefinedAttributes.md) 
+  [ListPrompts](API_ListPrompts.md) 
+  [ListQueueEmailAddresses](API_ListQueueEmailAddresses.md) 
+  [ListQueueQuickConnects](API_ListQueueQuickConnects.md) 
+  [ListQueues](API_ListQueues.md) 
+  [ListQuickConnects](API_ListQuickConnects.md) 
+  [ListRealtimeContactAnalysisSegmentsV2](API_ListRealtimeContactAnalysisSegmentsV2.md) 
+  [ListRoutingProfileManualAssignmentQueues](API_ListRoutingProfileManualAssignmentQueues.md) 
+  [ListRoutingProfileQueues](API_ListRoutingProfileQueues.md) 
+  [ListRoutingProfiles](API_ListRoutingProfiles.md) 
+  [ListRules](API_ListRules.md) 
+  [ListSecurityKeys](API_ListSecurityKeys.md) 
+  [ListSecurityProfileApplications](API_ListSecurityProfileApplications.md) 
+  [ListSecurityProfileFlowModules](API_ListSecurityProfileFlowModules.md) 
+  [ListSecurityProfilePermissions](API_ListSecurityProfilePermissions.md) 
+  [ListSecurityProfiles](API_ListSecurityProfiles.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListTaskTemplates](API_ListTaskTemplates.md) 
+  [ListTestCaseExecutionRecords](API_ListTestCaseExecutionRecords.md) 
+  [ListTestCaseExecutions](API_ListTestCaseExecutions.md) 
+  [ListTestCases](API_ListTestCases.md) 
+  [ListTrafficDistributionGroups](API_ListTrafficDistributionGroups.md) 
+  [ListTrafficDistributionGroupUsers](API_ListTrafficDistributionGroupUsers.md) 
+  [ListUseCases](API_ListUseCases.md) 
+  [ListUserHierarchyGroups](API_ListUserHierarchyGroups.md) 
+  [ListUserNotifications](API_ListUserNotifications.md) 
+  [ListUserProficiencies](API_ListUserProficiencies.md) 
+  [ListUsers](API_ListUsers.md) 
+  [ListViews](API_ListViews.md) 
+  [ListViewVersions](API_ListViewVersions.md) 
+  [ListWorkspaceMedia](API_ListWorkspaceMedia.md) 
+  [ListWorkspacePages](API_ListWorkspacePages.md) 
+  [ListWorkspaces](API_ListWorkspaces.md) 
+  [MonitorContact](API_MonitorContact.md) 
+  [PauseContact](API_PauseContact.md) 
+  [PutUserStatus](API_PutUserStatus.md) 
+  [ReleasePhoneNumber](API_ReleasePhoneNumber.md) 
+  [ReplicateInstance](API_ReplicateInstance.md) 
+  [ResumeContact](API_ResumeContact.md) 
+  [ResumeContactRecording](API_ResumeContactRecording.md) 
+  [SearchAgentStatuses](API_SearchAgentStatuses.md) 
+  [SearchAvailablePhoneNumbers](API_SearchAvailablePhoneNumbers.md) 
+  [SearchContactEvaluations](API_SearchContactEvaluations.md) 
+  [SearchContactFlowModules](API_SearchContactFlowModules.md) 
+  [SearchContactFlows](API_SearchContactFlows.md) 
+  [SearchContacts](API_SearchContacts.md) 
+  [SearchDataTables](API_SearchDataTables.md) 
+  [SearchEmailAddresses](API_SearchEmailAddresses.md) 
+  [SearchEvaluationForms](API_SearchEvaluationForms.md) 
+  [SearchHoursOfOperationOverrides](API_SearchHoursOfOperationOverrides.md) 
+  [SearchHoursOfOperations](API_SearchHoursOfOperations.md) 
+  [SearchNotifications](API_SearchNotifications.md) 
+  [SearchPredefinedAttributes](API_SearchPredefinedAttributes.md) 
+  [SearchPrompts](API_SearchPrompts.md) 
+  [SearchQueues](API_SearchQueues.md) 
+  [SearchQuickConnects](API_SearchQuickConnects.md) 
+  [SearchResourceTags](API_SearchResourceTags.md) 
+  [SearchRoutingProfiles](API_SearchRoutingProfiles.md) 
+  [SearchSecurityProfiles](API_SearchSecurityProfiles.md) 
+  [SearchTestCases](API_SearchTestCases.md) 
+  [SearchUserHierarchyGroups](API_SearchUserHierarchyGroups.md) 
+  [SearchUsers](API_SearchUsers.md) 
+  [SearchViews](API_SearchViews.md) 
+  [SearchVocabularies](API_SearchVocabularies.md) 
+  [SearchWorkspaceAssociations](API_SearchWorkspaceAssociations.md) 
+  [SearchWorkspaces](API_SearchWorkspaces.md) 
+  [SendChatIntegrationEvent](API_SendChatIntegrationEvent.md) 
+  [SendOutboundEmail](API_SendOutboundEmail.md) 
+  [StartAttachedFileUpload](API_StartAttachedFileUpload.md) 
+  [StartChatContact](API_StartChatContact.md) 
+  [StartContactEvaluation](API_StartContactEvaluation.md) 
+  [StartContactMediaProcessing](API_StartContactMediaProcessing.md) 
+  [StartContactRecording](API_StartContactRecording.md) 
+  [StartContactStreaming](API_StartContactStreaming.md) 
+  [StartEmailContact](API_StartEmailContact.md) 
+  [StartOutboundChatContact](API_StartOutboundChatContact.md) 
+  [StartOutboundEmailContact](API_StartOutboundEmailContact.md) 
+  [StartOutboundVoiceContact](API_StartOutboundVoiceContact.md) 
+  [StartScreenSharing](API_StartScreenSharing.md) 
+  [StartTaskContact](API_StartTaskContact.md) 
+  [StartTestCaseExecution](API_StartTestCaseExecution.md) 
+  [StartWebRTCContact](API_StartWebRTCContact.md) 
+  [StopContact](API_StopContact.md) 
+  [StopContactMediaProcessing](API_StopContactMediaProcessing.md) 
+  [StopContactRecording](API_StopContactRecording.md) 
+  [StopContactStreaming](API_StopContactStreaming.md) 
+  [StopTestCaseExecution](API_StopTestCaseExecution.md) 
+  [SubmitContactEvaluation](API_SubmitContactEvaluation.md) 
+  [SuspendContactRecording](API_SuspendContactRecording.md) 
+  [TagContact](API_TagContact.md) 
+  [TagResource](API_TagResource.md) 
+  [TransferContact](API_TransferContact.md) 
+  [UntagContact](API_UntagContact.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateAgentStatus](API_UpdateAgentStatus.md) 
+  [UpdateAuthenticationProfile](API_UpdateAuthenticationProfile.md) 
+  [UpdateContact](API_UpdateContact.md) 
+  [UpdateContactAttributes](API_UpdateContactAttributes.md) 
+  [UpdateContactEvaluation](API_UpdateContactEvaluation.md) 
+  [UpdateContactFlowContent](API_UpdateContactFlowContent.md) 
+  [UpdateContactFlowMetadata](API_UpdateContactFlowMetadata.md) 
+  [UpdateContactFlowModuleAlias](API_UpdateContactFlowModuleAlias.md) 
+  [UpdateContactFlowModuleContent](API_UpdateContactFlowModuleContent.md) 
+  [UpdateContactFlowModuleMetadata](API_UpdateContactFlowModuleMetadata.md) 
+  [UpdateContactFlowName](API_UpdateContactFlowName.md) 
+  [UpdateContactRoutingData](API_UpdateContactRoutingData.md) 
+  [UpdateContactSchedule](API_UpdateContactSchedule.md) 
+  [UpdateDataTableAttribute](API_UpdateDataTableAttribute.md) 
+  [UpdateDataTableMetadata](API_UpdateDataTableMetadata.md) 
+  [UpdateDataTablePrimaryValues](API_UpdateDataTablePrimaryValues.md) 
+  [UpdateEmailAddressMetadata](API_UpdateEmailAddressMetadata.md) 
+  [UpdateEvaluationForm](API_UpdateEvaluationForm.md) 
+  [UpdateHoursOfOperation](API_UpdateHoursOfOperation.md) 
+  [UpdateHoursOfOperationOverride](API_UpdateHoursOfOperationOverride.md) 
+  [UpdateInstanceAttribute](API_UpdateInstanceAttribute.md) 
+  [UpdateInstanceStorageConfig](API_UpdateInstanceStorageConfig.md) 
+  [UpdateNotificationContent](API_UpdateNotificationContent.md) 
+  [UpdateParticipantAuthentication](API_UpdateParticipantAuthentication.md) 
+  [UpdateParticipantRoleConfig](API_UpdateParticipantRoleConfig.md) 
+  [UpdatePhoneNumber](API_UpdatePhoneNumber.md) 
+  [UpdatePhoneNumberMetadata](API_UpdatePhoneNumberMetadata.md) 
+  [UpdatePredefinedAttribute](API_UpdatePredefinedAttribute.md) 
+  [UpdatePrompt](API_UpdatePrompt.md) 
+  [UpdateQueueHoursOfOperation](API_UpdateQueueHoursOfOperation.md) 
+  [UpdateQueueMaxContacts](API_UpdateQueueMaxContacts.md) 
+  [UpdateQueueName](API_UpdateQueueName.md) 
+  [UpdateQueueOutboundCallerConfig](API_UpdateQueueOutboundCallerConfig.md) 
+  [UpdateQueueOutboundEmailConfig](API_UpdateQueueOutboundEmailConfig.md) 
+  [UpdateQueueStatus](API_UpdateQueueStatus.md) 
+  [UpdateQuickConnectConfig](API_UpdateQuickConnectConfig.md) 
+  [UpdateQuickConnectName](API_UpdateQuickConnectName.md) 
+  [UpdateRoutingProfileAgentAvailabilityTimer](API_UpdateRoutingProfileAgentAvailabilityTimer.md) 
+  [UpdateRoutingProfileConcurrency](API_UpdateRoutingProfileConcurrency.md) 
+  [UpdateRoutingProfileDefaultOutboundQueue](API_UpdateRoutingProfileDefaultOutboundQueue.md) 
+  [UpdateRoutingProfileName](API_UpdateRoutingProfileName.md) 
+  [UpdateRoutingProfileQueues](API_UpdateRoutingProfileQueues.md) 
+  [UpdateRule](API_UpdateRule.md) 
+  [UpdateSecurityProfile](API_UpdateSecurityProfile.md) 
+  [UpdateTaskTemplate](API_UpdateTaskTemplate.md) 
+  [UpdateTestCase](API_UpdateTestCase.md) 
+  [UpdateTrafficDistribution](API_UpdateTrafficDistribution.md) 
+  [UpdateUserConfig](API_UpdateUserConfig.md) 
+  [UpdateUserHierarchy](API_UpdateUserHierarchy.md) 
+  [UpdateUserHierarchyGroupName](API_UpdateUserHierarchyGroupName.md) 
+  [UpdateUserHierarchyStructure](API_UpdateUserHierarchyStructure.md) 
+  [UpdateUserIdentityInfo](API_UpdateUserIdentityInfo.md) 
+  [UpdateUserNotificationStatus](API_UpdateUserNotificationStatus.md) 
+  [UpdateUserPhoneConfig](API_UpdateUserPhoneConfig.md) 
+  [UpdateUserProficiencies](API_UpdateUserProficiencies.md) 
+  [UpdateUserRoutingProfile](API_UpdateUserRoutingProfile.md) 
+  [UpdateUserSecurityProfiles](API_UpdateUserSecurityProfiles.md) 
+  [UpdateViewContent](API_UpdateViewContent.md) 
+  [UpdateViewMetadata](API_UpdateViewMetadata.md) 
+  [UpdateWorkspaceMetadata](API_UpdateWorkspaceMetadata.md) 
+  [UpdateWorkspacePage](API_UpdateWorkspacePage.md) 
+  [UpdateWorkspaceTheme](API_UpdateWorkspaceTheme.md) 
+  [UpdateWorkspaceVisibility](API_UpdateWorkspaceVisibility.md) 

The following actions are supported by Amazon AppIntegrations Service:
+  [CreateApplication](API_connect-app-integrations_CreateApplication.md) 
+  [CreateDataIntegration](API_connect-app-integrations_CreateDataIntegration.md) 
+  [CreateDataIntegrationAssociation](API_connect-app-integrations_CreateDataIntegrationAssociation.md) 
+  [CreateEventIntegration](API_connect-app-integrations_CreateEventIntegration.md) 
+  [DeleteApplication](API_connect-app-integrations_DeleteApplication.md) 
+  [DeleteDataIntegration](API_connect-app-integrations_DeleteDataIntegration.md) 
+  [DeleteEventIntegration](API_connect-app-integrations_DeleteEventIntegration.md) 
+  [GetApplication](API_connect-app-integrations_GetApplication.md) 
+  [GetDataIntegration](API_connect-app-integrations_GetDataIntegration.md) 
+  [GetEventIntegration](API_connect-app-integrations_GetEventIntegration.md) 
+  [ListApplicationAssociations](API_connect-app-integrations_ListApplicationAssociations.md) 
+  [ListApplications](API_connect-app-integrations_ListApplications.md) 
+  [ListDataIntegrationAssociations](API_connect-app-integrations_ListDataIntegrationAssociations.md) 
+  [ListDataIntegrations](API_connect-app-integrations_ListDataIntegrations.md) 
+  [ListEventIntegrationAssociations](API_connect-app-integrations_ListEventIntegrationAssociations.md) 
+  [ListEventIntegrations](API_connect-app-integrations_ListEventIntegrations.md) 
+  [ListTagsForResource](API_connect-app-integrations_ListTagsForResource.md) 
+  [TagResource](API_connect-app-integrations_TagResource.md) 
+  [UntagResource](API_connect-app-integrations_UntagResource.md) 
+  [UpdateApplication](API_connect-app-integrations_UpdateApplication.md) 
+  [UpdateDataIntegration](API_connect-app-integrations_UpdateDataIntegration.md) 
+  [UpdateDataIntegrationAssociation](API_connect-app-integrations_UpdateDataIntegrationAssociation.md) 
+  [UpdateEventIntegration](API_connect-app-integrations_UpdateEventIntegration.md) 

The following actions are supported by Amazon Connect Contact Lens:
+  [ListRealtimeContactAnalysisSegments](API_connect-contact-lens_ListRealtimeContactAnalysisSegments.md) 

The following actions are supported by Amazon Connect Outbound Campaigns:
+  [CreateCampaign](API_connect-outbound-campaigns_CreateCampaign.md) 
+  [DeleteCampaign](API_connect-outbound-campaigns_DeleteCampaign.md) 
+  [DeleteConnectInstanceConfig](API_connect-outbound-campaigns_DeleteConnectInstanceConfig.md) 
+  [DeleteInstanceOnboardingJob](API_connect-outbound-campaigns_DeleteInstanceOnboardingJob.md) 
+  [DescribeCampaign](API_connect-outbound-campaigns_DescribeCampaign.md) 
+  [GetCampaignState](API_connect-outbound-campaigns_GetCampaignState.md) 
+  [GetCampaignStateBatch](API_connect-outbound-campaigns_GetCampaignStateBatch.md) 
+  [GetConnectInstanceConfig](API_connect-outbound-campaigns_GetConnectInstanceConfig.md) 
+  [GetInstanceOnboardingJobStatus](API_connect-outbound-campaigns_GetInstanceOnboardingJobStatus.md) 
+  [ListCampaigns](API_connect-outbound-campaigns_ListCampaigns.md) 
+  [ListTagsForResource](API_connect-outbound-campaigns_ListTagsForResource.md) 
+  [PauseCampaign](API_connect-outbound-campaigns_PauseCampaign.md) 
+  [PutDialRequestBatch](API_connect-outbound-campaigns_PutDialRequestBatch.md) 
+  [ResumeCampaign](API_connect-outbound-campaigns_ResumeCampaign.md) 
+  [StartCampaign](API_connect-outbound-campaigns_StartCampaign.md) 
+  [StartInstanceOnboardingJob](API_connect-outbound-campaigns_StartInstanceOnboardingJob.md) 
+  [StopCampaign](API_connect-outbound-campaigns_StopCampaign.md) 
+  [TagResource](API_connect-outbound-campaigns_TagResource.md) 
+  [UntagResource](API_connect-outbound-campaigns_UntagResource.md) 
+  [UpdateCampaignDialerConfig](API_connect-outbound-campaigns_UpdateCampaignDialerConfig.md) 
+  [UpdateCampaignName](API_connect-outbound-campaigns_UpdateCampaignName.md) 
+  [UpdateCampaignOutboundCallConfig](API_connect-outbound-campaigns_UpdateCampaignOutboundCallConfig.md) 

The following actions are supported by Amazon Connect Outbound Campaigns V2:
+  [CreateCampaign](API_connect-outbound-campaigns-v2_CreateCampaign.md) 
+  [DeleteCampaign](API_connect-outbound-campaigns-v2_DeleteCampaign.md) 
+  [DeleteCampaignChannelSubtypeConfig](API_connect-outbound-campaigns-v2_DeleteCampaignChannelSubtypeConfig.md) 
+  [DeleteCampaignCommunicationLimits](API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationLimits.md) 
+  [DeleteCampaignCommunicationTime](API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationTime.md) 
+  [DeleteConnectInstanceConfig](API_connect-outbound-campaigns-v2_DeleteConnectInstanceConfig.md) 
+  [DeleteConnectInstanceIntegration](API_connect-outbound-campaigns-v2_DeleteConnectInstanceIntegration.md) 
+  [DeleteInstanceOnboardingJob](API_connect-outbound-campaigns-v2_DeleteInstanceOnboardingJob.md) 
+  [DescribeCampaign](API_connect-outbound-campaigns-v2_DescribeCampaign.md) 
+  [GetCampaignState](API_connect-outbound-campaigns-v2_GetCampaignState.md) 
+  [GetCampaignStateBatch](API_connect-outbound-campaigns-v2_GetCampaignStateBatch.md) 
+  [GetConnectInstanceConfig](API_connect-outbound-campaigns-v2_GetConnectInstanceConfig.md) 
+  [GetInstanceOnboardingJobStatus](API_connect-outbound-campaigns-v2_GetInstanceOnboardingJobStatus.md) 
+  [ListCampaigns](API_connect-outbound-campaigns-v2_ListCampaigns.md) 
+  [ListConnectInstanceIntegrations](API_connect-outbound-campaigns-v2_ListConnectInstanceIntegrations.md) 
+  [ListTagsForResource](API_connect-outbound-campaigns-v2_ListTagsForResource.md) 
+  [PauseCampaign](API_connect-outbound-campaigns-v2_PauseCampaign.md) 
+  [PutConnectInstanceIntegration](API_connect-outbound-campaigns-v2_PutConnectInstanceIntegration.md) 
+  [PutOutboundRequestBatch](API_connect-outbound-campaigns-v2_PutOutboundRequestBatch.md) 
+  [PutProfileOutboundRequestBatch](API_connect-outbound-campaigns-v2_PutProfileOutboundRequestBatch.md) 
+  [ResumeCampaign](API_connect-outbound-campaigns-v2_ResumeCampaign.md) 
+  [StartCampaign](API_connect-outbound-campaigns-v2_StartCampaign.md) 
+  [StartInstanceOnboardingJob](API_connect-outbound-campaigns-v2_StartInstanceOnboardingJob.md) 
+  [StopCampaign](API_connect-outbound-campaigns-v2_StopCampaign.md) 
+  [TagResource](API_connect-outbound-campaigns-v2_TagResource.md) 
+  [UntagResource](API_connect-outbound-campaigns-v2_UntagResource.md) 
+  [UpdateCampaignChannelSubtypeConfig](API_connect-outbound-campaigns-v2_UpdateCampaignChannelSubtypeConfig.md) 
+  [UpdateCampaignCommunicationLimits](API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationLimits.md) 
+  [UpdateCampaignCommunicationTime](API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationTime.md) 
+  [UpdateCampaignFlowAssociation](API_connect-outbound-campaigns-v2_UpdateCampaignFlowAssociation.md) 
+  [UpdateCampaignName](API_connect-outbound-campaigns-v2_UpdateCampaignName.md) 
+  [UpdateCampaignSchedule](API_connect-outbound-campaigns-v2_UpdateCampaignSchedule.md) 
+  [UpdateCampaignSource](API_connect-outbound-campaigns-v2_UpdateCampaignSource.md) 

The following actions are supported by Amazon Connect Cases:
+  [BatchGetCaseRule](API_connect-cases_BatchGetCaseRule.md) 
+  [BatchGetField](API_connect-cases_BatchGetField.md) 
+  [BatchPutFieldOptions](API_connect-cases_BatchPutFieldOptions.md) 
+  [CreateCase](API_connect-cases_CreateCase.md) 
+  [CreateCaseRule](API_connect-cases_CreateCaseRule.md) 
+  [CreateDomain](API_connect-cases_CreateDomain.md) 
+  [CreateField](API_connect-cases_CreateField.md) 
+  [CreateLayout](API_connect-cases_CreateLayout.md) 
+  [CreateRelatedItem](API_connect-cases_CreateRelatedItem.md) 
+  [CreateTemplate](API_connect-cases_CreateTemplate.md) 
+  [DeleteCase](API_connect-cases_DeleteCase.md) 
+  [DeleteCaseRule](API_connect-cases_DeleteCaseRule.md) 
+  [DeleteDomain](API_connect-cases_DeleteDomain.md) 
+  [DeleteField](API_connect-cases_DeleteField.md) 
+  [DeleteLayout](API_connect-cases_DeleteLayout.md) 
+  [DeleteRelatedItem](API_connect-cases_DeleteRelatedItem.md) 
+  [DeleteTemplate](API_connect-cases_DeleteTemplate.md) 
+  [GetCase](API_connect-cases_GetCase.md) 
+  [GetCaseAuditEvents](API_connect-cases_GetCaseAuditEvents.md) 
+  [GetCaseEventConfiguration](API_connect-cases_GetCaseEventConfiguration.md) 
+  [GetDomain](API_connect-cases_GetDomain.md) 
+  [GetLayout](API_connect-cases_GetLayout.md) 
+  [GetTemplate](API_connect-cases_GetTemplate.md) 
+  [ListCaseRules](API_connect-cases_ListCaseRules.md) 
+  [ListCasesForContact](API_connect-cases_ListCasesForContact.md) 
+  [ListDomains](API_connect-cases_ListDomains.md) 
+  [ListFieldOptions](API_connect-cases_ListFieldOptions.md) 
+  [ListFields](API_connect-cases_ListFields.md) 
+  [ListLayouts](API_connect-cases_ListLayouts.md) 
+  [ListTagsForResource](API_connect-cases_ListTagsForResource.md) 
+  [ListTemplates](API_connect-cases_ListTemplates.md) 
+  [PutCaseEventConfiguration](API_connect-cases_PutCaseEventConfiguration.md) 
+  [SearchAllRelatedItems](API_connect-cases_SearchAllRelatedItems.md) 
+  [SearchCases](API_connect-cases_SearchCases.md) 
+  [SearchRelatedItems](API_connect-cases_SearchRelatedItems.md) 
+  [TagResource](API_connect-cases_TagResource.md) 
+  [UntagResource](API_connect-cases_UntagResource.md) 
+  [UpdateCase](API_connect-cases_UpdateCase.md) 
+  [UpdateCaseRule](API_connect-cases_UpdateCaseRule.md) 
+  [UpdateField](API_connect-cases_UpdateField.md) 
+  [UpdateLayout](API_connect-cases_UpdateLayout.md) 
+  [UpdateRelatedItem](API_connect-cases_UpdateRelatedItem.md) 
+  [UpdateTemplate](API_connect-cases_UpdateTemplate.md) 

The following actions are supported by Amazon Connect Participant Service:
+  [CancelParticipantAuthentication](API_connect-participant_CancelParticipantAuthentication.md) 
+  [CompleteAttachmentUpload](API_connect-participant_CompleteAttachmentUpload.md) 
+  [CreateParticipantConnection](API_connect-participant_CreateParticipantConnection.md) 
+  [DescribeView](API_connect-participant_DescribeView.md) 
+  [DisconnectParticipant](API_connect-participant_DisconnectParticipant.md) 
+  [GetAttachment](API_connect-participant_GetAttachment.md) 
+  [GetAuthenticationUrl](API_connect-participant_GetAuthenticationUrl.md) 
+  [GetTranscript](API_connect-participant_GetTranscript.md) 
+  [SendEvent](API_connect-participant_SendEvent.md) 
+  [SendMessage](API_connect-participant_SendMessage.md) 
+  [StartAttachmentUpload](API_connect-participant_StartAttachmentUpload.md) 

The following actions are supported by Amazon Connect Customer Profiles:
+  [AddProfileKey](API_connect-customer-profiles_AddProfileKey.md) 
+  [BatchGetCalculatedAttributeForProfile](API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile.md) 
+  [BatchGetProfile](API_connect-customer-profiles_BatchGetProfile.md) 
+  [CreateCalculatedAttributeDefinition](API_connect-customer-profiles_CreateCalculatedAttributeDefinition.md) 
+  [CreateDomain](API_connect-customer-profiles_CreateDomain.md) 
+  [CreateDomainLayout](API_connect-customer-profiles_CreateDomainLayout.md) 
+  [CreateEventStream](API_connect-customer-profiles_CreateEventStream.md) 
+  [CreateEventTrigger](API_connect-customer-profiles_CreateEventTrigger.md) 
+  [CreateIntegrationWorkflow](API_connect-customer-profiles_CreateIntegrationWorkflow.md) 
+  [CreateProfile](API_connect-customer-profiles_CreateProfile.md) 
+  [CreateRecommender](API_connect-customer-profiles_CreateRecommender.md) 
+  [CreateSegmentDefinition](API_connect-customer-profiles_CreateSegmentDefinition.md) 
+  [CreateSegmentEstimate](API_connect-customer-profiles_CreateSegmentEstimate.md) 
+  [CreateSegmentSnapshot](API_connect-customer-profiles_CreateSegmentSnapshot.md) 
+  [CreateUploadJob](API_connect-customer-profiles_CreateUploadJob.md) 
+  [DeleteCalculatedAttributeDefinition](API_connect-customer-profiles_DeleteCalculatedAttributeDefinition.md) 
+  [DeleteDomain](API_connect-customer-profiles_DeleteDomain.md) 
+  [DeleteDomainLayout](API_connect-customer-profiles_DeleteDomainLayout.md) 
+  [DeleteDomainObjectType](API_connect-customer-profiles_DeleteDomainObjectType.md) 
+  [DeleteEventStream](API_connect-customer-profiles_DeleteEventStream.md) 
+  [DeleteEventTrigger](API_connect-customer-profiles_DeleteEventTrigger.md) 
+  [DeleteIntegration](API_connect-customer-profiles_DeleteIntegration.md) 
+  [DeleteProfile](API_connect-customer-profiles_DeleteProfile.md) 
+  [DeleteProfileKey](API_connect-customer-profiles_DeleteProfileKey.md) 
+  [DeleteProfileObject](API_connect-customer-profiles_DeleteProfileObject.md) 
+  [DeleteProfileObjectType](API_connect-customer-profiles_DeleteProfileObjectType.md) 
+  [DeleteRecommender](API_connect-customer-profiles_DeleteRecommender.md) 
+  [DeleteSegmentDefinition](API_connect-customer-profiles_DeleteSegmentDefinition.md) 
+  [DeleteWorkflow](API_connect-customer-profiles_DeleteWorkflow.md) 
+  [DetectProfileObjectType](API_connect-customer-profiles_DetectProfileObjectType.md) 
+  [GetAutoMergingPreview](API_connect-customer-profiles_GetAutoMergingPreview.md) 
+  [GetCalculatedAttributeDefinition](API_connect-customer-profiles_GetCalculatedAttributeDefinition.md) 
+  [GetCalculatedAttributeForProfile](API_connect-customer-profiles_GetCalculatedAttributeForProfile.md) 
+  [GetDomain](API_connect-customer-profiles_GetDomain.md) 
+  [GetDomainLayout](API_connect-customer-profiles_GetDomainLayout.md) 
+  [GetDomainObjectType](API_connect-customer-profiles_GetDomainObjectType.md) 
+  [GetEventStream](API_connect-customer-profiles_GetEventStream.md) 
+  [GetEventTrigger](API_connect-customer-profiles_GetEventTrigger.md) 
+  [GetIdentityResolutionJob](API_connect-customer-profiles_GetIdentityResolutionJob.md) 
+  [GetIntegration](API_connect-customer-profiles_GetIntegration.md) 
+  [GetMatches](API_connect-customer-profiles_GetMatches.md) 
+  [GetObjectTypeAttributeStatistics](API_connect-customer-profiles_GetObjectTypeAttributeStatistics.md) 
+  [GetProfileHistoryRecord](API_connect-customer-profiles_GetProfileHistoryRecord.md) 
+  [GetProfileObjectType](API_connect-customer-profiles_GetProfileObjectType.md) 
+  [GetProfileObjectTypeTemplate](API_connect-customer-profiles_GetProfileObjectTypeTemplate.md) 
+  [GetProfileRecommendations](API_connect-customer-profiles_GetProfileRecommendations.md) 
+  [GetRecommender](API_connect-customer-profiles_GetRecommender.md) 
+  [GetSegmentDefinition](API_connect-customer-profiles_GetSegmentDefinition.md) 
+  [GetSegmentEstimate](API_connect-customer-profiles_GetSegmentEstimate.md) 
+  [GetSegmentMembership](API_connect-customer-profiles_GetSegmentMembership.md) 
+  [GetSegmentSnapshot](API_connect-customer-profiles_GetSegmentSnapshot.md) 
+  [GetSimilarProfiles](API_connect-customer-profiles_GetSimilarProfiles.md) 
+  [GetUploadJob](API_connect-customer-profiles_GetUploadJob.md) 
+  [GetUploadJobPath](API_connect-customer-profiles_GetUploadJobPath.md) 
+  [GetWorkflow](API_connect-customer-profiles_GetWorkflow.md) 
+  [GetWorkflowSteps](API_connect-customer-profiles_GetWorkflowSteps.md) 
+  [ListAccountIntegrations](API_connect-customer-profiles_ListAccountIntegrations.md) 
+  [ListCalculatedAttributeDefinitions](API_connect-customer-profiles_ListCalculatedAttributeDefinitions.md) 
+  [ListCalculatedAttributesForProfile](API_connect-customer-profiles_ListCalculatedAttributesForProfile.md) 
+  [ListDomainLayouts](API_connect-customer-profiles_ListDomainLayouts.md) 
+  [ListDomainObjectTypes](API_connect-customer-profiles_ListDomainObjectTypes.md) 
+  [ListDomains](API_connect-customer-profiles_ListDomains.md) 
+  [ListEventStreams](API_connect-customer-profiles_ListEventStreams.md) 
+  [ListEventTriggers](API_connect-customer-profiles_ListEventTriggers.md) 
+  [ListIdentityResolutionJobs](API_connect-customer-profiles_ListIdentityResolutionJobs.md) 
+  [ListIntegrations](API_connect-customer-profiles_ListIntegrations.md) 
+  [ListObjectTypeAttributes](API_connect-customer-profiles_ListObjectTypeAttributes.md) 
+  [ListObjectTypeAttributeValues](API_connect-customer-profiles_ListObjectTypeAttributeValues.md) 
+  [ListProfileAttributeValues](API_connect-customer-profiles_ListProfileAttributeValues.md) 
+  [ListProfileHistoryRecords](API_connect-customer-profiles_ListProfileHistoryRecords.md) 
+  [ListProfileObjects](API_connect-customer-profiles_ListProfileObjects.md) 
+  [ListProfileObjectTypes](API_connect-customer-profiles_ListProfileObjectTypes.md) 
+  [ListProfileObjectTypeTemplates](API_connect-customer-profiles_ListProfileObjectTypeTemplates.md) 
+  [ListRecommenderRecipes](API_connect-customer-profiles_ListRecommenderRecipes.md) 
+  [ListRecommenders](API_connect-customer-profiles_ListRecommenders.md) 
+  [ListRuleBasedMatches](API_connect-customer-profiles_ListRuleBasedMatches.md) 
+  [ListSegmentDefinitions](API_connect-customer-profiles_ListSegmentDefinitions.md) 
+  [ListTagsForResource](API_connect-customer-profiles_ListTagsForResource.md) 
+  [ListUploadJobs](API_connect-customer-profiles_ListUploadJobs.md) 
+  [ListWorkflows](API_connect-customer-profiles_ListWorkflows.md) 
+  [MergeProfiles](API_connect-customer-profiles_MergeProfiles.md) 
+  [PutDomainObjectType](API_connect-customer-profiles_PutDomainObjectType.md) 
+  [PutIntegration](API_connect-customer-profiles_PutIntegration.md) 
+  [PutProfileObject](API_connect-customer-profiles_PutProfileObject.md) 
+  [PutProfileObjectType](API_connect-customer-profiles_PutProfileObjectType.md) 
+  [SearchProfiles](API_connect-customer-profiles_SearchProfiles.md) 
+  [StartRecommender](API_connect-customer-profiles_StartRecommender.md) 
+  [StartUploadJob](API_connect-customer-profiles_StartUploadJob.md) 
+  [StopRecommender](API_connect-customer-profiles_StopRecommender.md) 
+  [StopUploadJob](API_connect-customer-profiles_StopUploadJob.md) 
+  [TagResource](API_connect-customer-profiles_TagResource.md) 
+  [UntagResource](API_connect-customer-profiles_UntagResource.md) 
+  [UpdateCalculatedAttributeDefinition](API_connect-customer-profiles_UpdateCalculatedAttributeDefinition.md) 
+  [UpdateDomain](API_connect-customer-profiles_UpdateDomain.md) 
+  [UpdateDomainLayout](API_connect-customer-profiles_UpdateDomainLayout.md) 
+  [UpdateEventTrigger](API_connect-customer-profiles_UpdateEventTrigger.md) 
+  [UpdateProfile](API_connect-customer-profiles_UpdateProfile.md) 
+  [UpdateRecommender](API_connect-customer-profiles_UpdateRecommender.md) 

The following actions are supported by Amazon Q Connect:
+  [ActivateMessageTemplate](API_amazon-q-connect_ActivateMessageTemplate.md) 
+  [CreateAIAgent](API_amazon-q-connect_CreateAIAgent.md) 
+  [CreateAIAgentVersion](API_amazon-q-connect_CreateAIAgentVersion.md) 
+  [CreateAIGuardrail](API_amazon-q-connect_CreateAIGuardrail.md) 
+  [CreateAIGuardrailVersion](API_amazon-q-connect_CreateAIGuardrailVersion.md) 
+  [CreateAIPrompt](API_amazon-q-connect_CreateAIPrompt.md) 
+  [CreateAIPromptVersion](API_amazon-q-connect_CreateAIPromptVersion.md) 
+  [CreateAssistant](API_amazon-q-connect_CreateAssistant.md) 
+  [CreateAssistantAssociation](API_amazon-q-connect_CreateAssistantAssociation.md) 
+  [CreateContent](API_amazon-q-connect_CreateContent.md) 
+  [CreateContentAssociation](API_amazon-q-connect_CreateContentAssociation.md) 
+  [CreateKnowledgeBase](API_amazon-q-connect_CreateKnowledgeBase.md) 
+  [CreateMessageTemplate](API_amazon-q-connect_CreateMessageTemplate.md) 
+  [CreateMessageTemplateAttachment](API_amazon-q-connect_CreateMessageTemplateAttachment.md) 
+  [CreateMessageTemplateVersion](API_amazon-q-connect_CreateMessageTemplateVersion.md) 
+  [CreateQuickResponse](API_amazon-q-connect_CreateQuickResponse.md) 
+  [CreateSession](API_amazon-q-connect_CreateSession.md) 
+  [DeactivateMessageTemplate](API_amazon-q-connect_DeactivateMessageTemplate.md) 
+  [DeleteAIAgent](API_amazon-q-connect_DeleteAIAgent.md) 
+  [DeleteAIAgentVersion](API_amazon-q-connect_DeleteAIAgentVersion.md) 
+  [DeleteAIGuardrail](API_amazon-q-connect_DeleteAIGuardrail.md) 
+  [DeleteAIGuardrailVersion](API_amazon-q-connect_DeleteAIGuardrailVersion.md) 
+  [DeleteAIPrompt](API_amazon-q-connect_DeleteAIPrompt.md) 
+  [DeleteAIPromptVersion](API_amazon-q-connect_DeleteAIPromptVersion.md) 
+  [DeleteAssistant](API_amazon-q-connect_DeleteAssistant.md) 
+  [DeleteAssistantAssociation](API_amazon-q-connect_DeleteAssistantAssociation.md) 
+  [DeleteContent](API_amazon-q-connect_DeleteContent.md) 
+  [DeleteContentAssociation](API_amazon-q-connect_DeleteContentAssociation.md) 
+  [DeleteImportJob](API_amazon-q-connect_DeleteImportJob.md) 
+  [DeleteKnowledgeBase](API_amazon-q-connect_DeleteKnowledgeBase.md) 
+  [DeleteMessageTemplate](API_amazon-q-connect_DeleteMessageTemplate.md) 
+  [DeleteMessageTemplateAttachment](API_amazon-q-connect_DeleteMessageTemplateAttachment.md) 
+  [DeleteQuickResponse](API_amazon-q-connect_DeleteQuickResponse.md) 
+  [GetAIAgent](API_amazon-q-connect_GetAIAgent.md) 
+  [GetAIGuardrail](API_amazon-q-connect_GetAIGuardrail.md) 
+  [GetAIPrompt](API_amazon-q-connect_GetAIPrompt.md) 
+  [GetAssistant](API_amazon-q-connect_GetAssistant.md) 
+  [GetAssistantAssociation](API_amazon-q-connect_GetAssistantAssociation.md) 
+  [GetContent](API_amazon-q-connect_GetContent.md) 
+  [GetContentAssociation](API_amazon-q-connect_GetContentAssociation.md) 
+  [GetContentSummary](API_amazon-q-connect_GetContentSummary.md) 
+  [GetImportJob](API_amazon-q-connect_GetImportJob.md) 
+  [GetKnowledgeBase](API_amazon-q-connect_GetKnowledgeBase.md) 
+  [GetMessageTemplate](API_amazon-q-connect_GetMessageTemplate.md) 
+  [GetNextMessage](API_amazon-q-connect_GetNextMessage.md) 
+  [GetQuickResponse](API_amazon-q-connect_GetQuickResponse.md) 
+  [GetRecommendations](API_amazon-q-connect_GetRecommendations.md) 
+  [GetSession](API_amazon-q-connect_GetSession.md) 
+  [ListAIAgents](API_amazon-q-connect_ListAIAgents.md) 
+  [ListAIAgentVersions](API_amazon-q-connect_ListAIAgentVersions.md) 
+  [ListAIGuardrails](API_amazon-q-connect_ListAIGuardrails.md) 
+  [ListAIGuardrailVersions](API_amazon-q-connect_ListAIGuardrailVersions.md) 
+  [ListAIPrompts](API_amazon-q-connect_ListAIPrompts.md) 
+  [ListAIPromptVersions](API_amazon-q-connect_ListAIPromptVersions.md) 
+  [ListAssistantAssociations](API_amazon-q-connect_ListAssistantAssociations.md) 
+  [ListAssistants](API_amazon-q-connect_ListAssistants.md) 
+  [ListContentAssociations](API_amazon-q-connect_ListContentAssociations.md) 
+  [ListContents](API_amazon-q-connect_ListContents.md) 
+  [ListImportJobs](API_amazon-q-connect_ListImportJobs.md) 
+  [ListKnowledgeBases](API_amazon-q-connect_ListKnowledgeBases.md) 
+  [ListMessages](API_amazon-q-connect_ListMessages.md) 
+  [ListMessageTemplates](API_amazon-q-connect_ListMessageTemplates.md) 
+  [ListMessageTemplateVersions](API_amazon-q-connect_ListMessageTemplateVersions.md) 
+  [ListQuickResponses](API_amazon-q-connect_ListQuickResponses.md) 
+  [ListSpans](API_amazon-q-connect_ListSpans.md) 
+  [ListTagsForResource](API_amazon-q-connect_ListTagsForResource.md) 
+  [NotifyRecommendationsReceived](API_amazon-q-connect_NotifyRecommendationsReceived.md) 
+  [PutFeedback](API_amazon-q-connect_PutFeedback.md) 
+  [QueryAssistant](API_amazon-q-connect_QueryAssistant.md) 
+  [RemoveAssistantAIAgent](API_amazon-q-connect_RemoveAssistantAIAgent.md) 
+  [RemoveKnowledgeBaseTemplateUri](API_amazon-q-connect_RemoveKnowledgeBaseTemplateUri.md) 
+  [RenderMessageTemplate](API_amazon-q-connect_RenderMessageTemplate.md) 
+  [Retrieve](API_amazon-q-connect_Retrieve.md) 
+  [SearchContent](API_amazon-q-connect_SearchContent.md) 
+  [SearchMessageTemplates](API_amazon-q-connect_SearchMessageTemplates.md) 
+  [SearchQuickResponses](API_amazon-q-connect_SearchQuickResponses.md) 
+  [SearchSessions](API_amazon-q-connect_SearchSessions.md) 
+  [SendMessage](API_amazon-q-connect_SendMessage.md) 
+  [StartContentUpload](API_amazon-q-connect_StartContentUpload.md) 
+  [StartImportJob](API_amazon-q-connect_StartImportJob.md) 
+  [TagResource](API_amazon-q-connect_TagResource.md) 
+  [UntagResource](API_amazon-q-connect_UntagResource.md) 
+  [UpdateAIAgent](API_amazon-q-connect_UpdateAIAgent.md) 
+  [UpdateAIGuardrail](API_amazon-q-connect_UpdateAIGuardrail.md) 
+  [UpdateAIPrompt](API_amazon-q-connect_UpdateAIPrompt.md) 
+  [UpdateAssistantAIAgent](API_amazon-q-connect_UpdateAssistantAIAgent.md) 
+  [UpdateContent](API_amazon-q-connect_UpdateContent.md) 
+  [UpdateKnowledgeBaseTemplateUri](API_amazon-q-connect_UpdateKnowledgeBaseTemplateUri.md) 
+  [UpdateMessageTemplate](API_amazon-q-connect_UpdateMessageTemplate.md) 
+  [UpdateMessageTemplateMetadata](API_amazon-q-connect_UpdateMessageTemplateMetadata.md) 
+  [UpdateQuickResponse](API_amazon-q-connect_UpdateQuickResponse.md) 
+  [UpdateSession](API_amazon-q-connect_UpdateSession.md) 
+  [UpdateSessionData](API_amazon-q-connect_UpdateSessionData.md) 

The following actions are supported by Amazon Voice ID:
+  [AssociateFraudster](API_connect-voice-id_AssociateFraudster.md) 
+  [CreateDomain](API_connect-voice-id_CreateDomain.md) 
+  [CreateWatchlist](API_connect-voice-id_CreateWatchlist.md) 
+  [DeleteDomain](API_connect-voice-id_DeleteDomain.md) 
+  [DeleteFraudster](API_connect-voice-id_DeleteFraudster.md) 
+  [DeleteSpeaker](API_connect-voice-id_DeleteSpeaker.md) 
+  [DeleteWatchlist](API_connect-voice-id_DeleteWatchlist.md) 
+  [DescribeDomain](API_connect-voice-id_DescribeDomain.md) 
+  [DescribeFraudster](API_connect-voice-id_DescribeFraudster.md) 
+  [DescribeFraudsterRegistrationJob](API_connect-voice-id_DescribeFraudsterRegistrationJob.md) 
+  [DescribeSpeaker](API_connect-voice-id_DescribeSpeaker.md) 
+  [DescribeSpeakerEnrollmentJob](API_connect-voice-id_DescribeSpeakerEnrollmentJob.md) 
+  [DescribeWatchlist](API_connect-voice-id_DescribeWatchlist.md) 
+  [DisassociateFraudster](API_connect-voice-id_DisassociateFraudster.md) 
+  [EvaluateSession](API_connect-voice-id_EvaluateSession.md) 
+  [ListDomains](API_connect-voice-id_ListDomains.md) 
+  [ListFraudsterRegistrationJobs](API_connect-voice-id_ListFraudsterRegistrationJobs.md) 
+  [ListFraudsters](API_connect-voice-id_ListFraudsters.md) 
+  [ListSpeakerEnrollmentJobs](API_connect-voice-id_ListSpeakerEnrollmentJobs.md) 
+  [ListSpeakers](API_connect-voice-id_ListSpeakers.md) 
+  [ListTagsForResource](API_connect-voice-id_ListTagsForResource.md) 
+  [ListWatchlists](API_connect-voice-id_ListWatchlists.md) 
+  [OptOutSpeaker](API_connect-voice-id_OptOutSpeaker.md) 
+  [StartFraudsterRegistrationJob](API_connect-voice-id_StartFraudsterRegistrationJob.md) 
+  [StartSpeakerEnrollmentJob](API_connect-voice-id_StartSpeakerEnrollmentJob.md) 
+  [TagResource](API_connect-voice-id_TagResource.md) 
+  [UntagResource](API_connect-voice-id_UntagResource.md) 
+  [UpdateDomain](API_connect-voice-id_UpdateDomain.md) 
+  [UpdateWatchlist](API_connect-voice-id_UpdateWatchlist.md) 

# Amazon Connect Service
<a name="API_Operations_Amazon_Connect_Service"></a>

The following actions are supported by Amazon Connect Service:
+  [ActivateEvaluationForm](API_ActivateEvaluationForm.md) 
+  [AssociateAnalyticsDataSet](API_AssociateAnalyticsDataSet.md) 
+  [AssociateApprovedOrigin](API_AssociateApprovedOrigin.md) 
+  [AssociateBot](API_AssociateBot.md) 
+  [AssociateContactWithUser](API_AssociateContactWithUser.md) 
+  [AssociateDefaultVocabulary](API_AssociateDefaultVocabulary.md) 
+  [AssociateEmailAddressAlias](API_AssociateEmailAddressAlias.md) 
+  [AssociateFlow](API_AssociateFlow.md) 
+  [AssociateHoursOfOperations](API_AssociateHoursOfOperations.md) 
+  [AssociateInstanceStorageConfig](API_AssociateInstanceStorageConfig.md) 
+  [AssociateLambdaFunction](API_AssociateLambdaFunction.md) 
+  [AssociateLexBot](API_AssociateLexBot.md) 
+  [AssociatePhoneNumberContactFlow](API_AssociatePhoneNumberContactFlow.md) 
+  [AssociateQueueEmailAddresses](API_AssociateQueueEmailAddresses.md) 
+  [AssociateQueueQuickConnects](API_AssociateQueueQuickConnects.md) 
+  [AssociateRoutingProfileQueues](API_AssociateRoutingProfileQueues.md) 
+  [AssociateSecurityKey](API_AssociateSecurityKey.md) 
+  [AssociateSecurityProfiles](API_AssociateSecurityProfiles.md) 
+  [AssociateTrafficDistributionGroupUser](API_AssociateTrafficDistributionGroupUser.md) 
+  [AssociateUserProficiencies](API_AssociateUserProficiencies.md) 
+  [AssociateWorkspace](API_AssociateWorkspace.md) 
+  [BatchAssociateAnalyticsDataSet](API_BatchAssociateAnalyticsDataSet.md) 
+  [BatchCreateDataTableValue](API_BatchCreateDataTableValue.md) 
+  [BatchDeleteDataTableValue](API_BatchDeleteDataTableValue.md) 
+  [BatchDescribeDataTableValue](API_BatchDescribeDataTableValue.md) 
+  [BatchDisassociateAnalyticsDataSet](API_BatchDisassociateAnalyticsDataSet.md) 
+  [BatchGetAttachedFileMetadata](API_BatchGetAttachedFileMetadata.md) 
+  [BatchGetFlowAssociation](API_BatchGetFlowAssociation.md) 
+  [BatchPutContact](API_BatchPutContact.md) 
+  [BatchUpdateDataTableValue](API_BatchUpdateDataTableValue.md) 
+  [ClaimPhoneNumber](API_ClaimPhoneNumber.md) 
+  [CompleteAttachedFileUpload](API_CompleteAttachedFileUpload.md) 
+  [CreateAgentStatus](API_CreateAgentStatus.md) 
+  [CreateContact](API_CreateContact.md) 
+  [CreateContactFlow](API_CreateContactFlow.md) 
+  [CreateContactFlowModule](API_CreateContactFlowModule.md) 
+  [CreateContactFlowModuleAlias](API_CreateContactFlowModuleAlias.md) 
+  [CreateContactFlowModuleVersion](API_CreateContactFlowModuleVersion.md) 
+  [CreateContactFlowVersion](API_CreateContactFlowVersion.md) 
+  [CreateDataTable](API_CreateDataTable.md) 
+  [CreateDataTableAttribute](API_CreateDataTableAttribute.md) 
+  [CreateEmailAddress](API_CreateEmailAddress.md) 
+  [CreateEvaluationForm](API_CreateEvaluationForm.md) 
+  [CreateHoursOfOperation](API_CreateHoursOfOperation.md) 
+  [CreateHoursOfOperationOverride](API_CreateHoursOfOperationOverride.md) 
+  [CreateInstance](API_CreateInstance.md) 
+  [CreateIntegrationAssociation](API_CreateIntegrationAssociation.md) 
+  [CreateNotification](API_CreateNotification.md) 
+  [CreateParticipant](API_CreateParticipant.md) 
+  [CreatePersistentContactAssociation](API_CreatePersistentContactAssociation.md) 
+  [CreatePredefinedAttribute](API_CreatePredefinedAttribute.md) 
+  [CreatePrompt](API_CreatePrompt.md) 
+  [CreatePushNotificationRegistration](API_CreatePushNotificationRegistration.md) 
+  [CreateQueue](API_CreateQueue.md) 
+  [CreateQuickConnect](API_CreateQuickConnect.md) 
+  [CreateRoutingProfile](API_CreateRoutingProfile.md) 
+  [CreateRule](API_CreateRule.md) 
+  [CreateSecurityProfile](API_CreateSecurityProfile.md) 
+  [CreateTaskTemplate](API_CreateTaskTemplate.md) 
+  [CreateTestCase](API_CreateTestCase.md) 
+  [CreateTrafficDistributionGroup](API_CreateTrafficDistributionGroup.md) 
+  [CreateUseCase](API_CreateUseCase.md) 
+  [CreateUser](API_CreateUser.md) 
+  [CreateUserHierarchyGroup](API_CreateUserHierarchyGroup.md) 
+  [CreateView](API_CreateView.md) 
+  [CreateViewVersion](API_CreateViewVersion.md) 
+  [CreateVocabulary](API_CreateVocabulary.md) 
+  [CreateWorkspace](API_CreateWorkspace.md) 
+  [CreateWorkspacePage](API_CreateWorkspacePage.md) 
+  [DeactivateEvaluationForm](API_DeactivateEvaluationForm.md) 
+  [DeleteAttachedFile](API_DeleteAttachedFile.md) 
+  [DeleteContactEvaluation](API_DeleteContactEvaluation.md) 
+  [DeleteContactFlow](API_DeleteContactFlow.md) 
+  [DeleteContactFlowModule](API_DeleteContactFlowModule.md) 
+  [DeleteContactFlowModuleAlias](API_DeleteContactFlowModuleAlias.md) 
+  [DeleteContactFlowModuleVersion](API_DeleteContactFlowModuleVersion.md) 
+  [DeleteContactFlowVersion](API_DeleteContactFlowVersion.md) 
+  [DeleteDataTable](API_DeleteDataTable.md) 
+  [DeleteDataTableAttribute](API_DeleteDataTableAttribute.md) 
+  [DeleteEmailAddress](API_DeleteEmailAddress.md) 
+  [DeleteEvaluationForm](API_DeleteEvaluationForm.md) 
+  [DeleteHoursOfOperation](API_DeleteHoursOfOperation.md) 
+  [DeleteHoursOfOperationOverride](API_DeleteHoursOfOperationOverride.md) 
+  [DeleteInstance](API_DeleteInstance.md) 
+  [DeleteIntegrationAssociation](API_DeleteIntegrationAssociation.md) 
+  [DeleteNotification](API_DeleteNotification.md) 
+  [DeletePredefinedAttribute](API_DeletePredefinedAttribute.md) 
+  [DeletePrompt](API_DeletePrompt.md) 
+  [DeletePushNotificationRegistration](API_DeletePushNotificationRegistration.md) 
+  [DeleteQueue](API_DeleteQueue.md) 
+  [DeleteQuickConnect](API_DeleteQuickConnect.md) 
+  [DeleteRoutingProfile](API_DeleteRoutingProfile.md) 
+  [DeleteRule](API_DeleteRule.md) 
+  [DeleteSecurityProfile](API_DeleteSecurityProfile.md) 
+  [DeleteTaskTemplate](API_DeleteTaskTemplate.md) 
+  [DeleteTestCase](API_DeleteTestCase.md) 
+  [DeleteTrafficDistributionGroup](API_DeleteTrafficDistributionGroup.md) 
+  [DeleteUseCase](API_DeleteUseCase.md) 
+  [DeleteUser](API_DeleteUser.md) 
+  [DeleteUserHierarchyGroup](API_DeleteUserHierarchyGroup.md) 
+  [DeleteView](API_DeleteView.md) 
+  [DeleteViewVersion](API_DeleteViewVersion.md) 
+  [DeleteVocabulary](API_DeleteVocabulary.md) 
+  [DeleteWorkspace](API_DeleteWorkspace.md) 
+  [DeleteWorkspaceMedia](API_DeleteWorkspaceMedia.md) 
+  [DeleteWorkspacePage](API_DeleteWorkspacePage.md) 
+  [DescribeAgentStatus](API_DescribeAgentStatus.md) 
+  [DescribeAuthenticationProfile](API_DescribeAuthenticationProfile.md) 
+  [DescribeContact](API_DescribeContact.md) 
+  [DescribeContactEvaluation](API_DescribeContactEvaluation.md) 
+  [DescribeContactFlow](API_DescribeContactFlow.md) 
+  [DescribeContactFlowModule](API_DescribeContactFlowModule.md) 
+  [DescribeContactFlowModuleAlias](API_DescribeContactFlowModuleAlias.md) 
+  [DescribeDataTable](API_DescribeDataTable.md) 
+  [DescribeDataTableAttribute](API_DescribeDataTableAttribute.md) 
+  [DescribeEmailAddress](API_DescribeEmailAddress.md) 
+  [DescribeEvaluationForm](API_DescribeEvaluationForm.md) 
+  [DescribeHoursOfOperation](API_DescribeHoursOfOperation.md) 
+  [DescribeHoursOfOperationOverride](API_DescribeHoursOfOperationOverride.md) 
+  [DescribeInstance](API_DescribeInstance.md) 
+  [DescribeInstanceAttribute](API_DescribeInstanceAttribute.md) 
+  [DescribeInstanceStorageConfig](API_DescribeInstanceStorageConfig.md) 
+  [DescribeNotification](API_DescribeNotification.md) 
+  [DescribePhoneNumber](API_DescribePhoneNumber.md) 
+  [DescribePredefinedAttribute](API_DescribePredefinedAttribute.md) 
+  [DescribePrompt](API_DescribePrompt.md) 
+  [DescribeQueue](API_DescribeQueue.md) 
+  [DescribeQuickConnect](API_DescribeQuickConnect.md) 
+  [DescribeRoutingProfile](API_DescribeRoutingProfile.md) 
+  [DescribeRule](API_DescribeRule.md) 
+  [DescribeSecurityProfile](API_DescribeSecurityProfile.md) 
+  [DescribeTestCase](API_DescribeTestCase.md) 
+  [DescribeTrafficDistributionGroup](API_DescribeTrafficDistributionGroup.md) 
+  [DescribeUser](API_DescribeUser.md) 
+  [DescribeUserHierarchyGroup](API_DescribeUserHierarchyGroup.md) 
+  [DescribeUserHierarchyStructure](API_DescribeUserHierarchyStructure.md) 
+  [DescribeView](API_DescribeView.md) 
+  [DescribeVocabulary](API_DescribeVocabulary.md) 
+  [DescribeWorkspace](API_DescribeWorkspace.md) 
+  [DisassociateAnalyticsDataSet](API_DisassociateAnalyticsDataSet.md) 
+  [DisassociateApprovedOrigin](API_DisassociateApprovedOrigin.md) 
+  [DisassociateBot](API_DisassociateBot.md) 
+  [DisassociateEmailAddressAlias](API_DisassociateEmailAddressAlias.md) 
+  [DisassociateFlow](API_DisassociateFlow.md) 
+  [DisassociateHoursOfOperations](API_DisassociateHoursOfOperations.md) 
+  [DisassociateInstanceStorageConfig](API_DisassociateInstanceStorageConfig.md) 
+  [DisassociateLambdaFunction](API_DisassociateLambdaFunction.md) 
+  [DisassociateLexBot](API_DisassociateLexBot.md) 
+  [DisassociatePhoneNumberContactFlow](API_DisassociatePhoneNumberContactFlow.md) 
+  [DisassociateQueueEmailAddresses](API_DisassociateQueueEmailAddresses.md) 
+  [DisassociateQueueQuickConnects](API_DisassociateQueueQuickConnects.md) 
+  [DisassociateRoutingProfileQueues](API_DisassociateRoutingProfileQueues.md) 
+  [DisassociateSecurityKey](API_DisassociateSecurityKey.md) 
+  [DisassociateSecurityProfiles](API_DisassociateSecurityProfiles.md) 
+  [DisassociateTrafficDistributionGroupUser](API_DisassociateTrafficDistributionGroupUser.md) 
+  [DisassociateUserProficiencies](API_DisassociateUserProficiencies.md) 
+  [DisassociateWorkspace](API_DisassociateWorkspace.md) 
+  [DismissUserContact](API_DismissUserContact.md) 
+  [EvaluateDataTableValues](API_EvaluateDataTableValues.md) 
+  [GetAttachedFile](API_GetAttachedFile.md) 
+  [GetContactAttributes](API_GetContactAttributes.md) 
+  [GetContactMetrics](API_GetContactMetrics.md) 
+  [GetCurrentMetricData](API_GetCurrentMetricData.md) 
+  [GetCurrentUserData](API_GetCurrentUserData.md) 
+  [GetEffectiveHoursOfOperations](API_GetEffectiveHoursOfOperations.md) 
+  [GetFederationToken](API_GetFederationToken.md) 
+  [GetFlowAssociation](API_GetFlowAssociation.md) 
+  [GetMetricData](API_GetMetricData.md) 
+  [GetMetricDataV2](API_GetMetricDataV2.md) 
+  [GetPromptFile](API_GetPromptFile.md) 
+  [GetTaskTemplate](API_GetTaskTemplate.md) 
+  [GetTestCaseExecutionSummary](API_GetTestCaseExecutionSummary.md) 
+  [GetTrafficDistribution](API_GetTrafficDistribution.md) 
+  [ImportPhoneNumber](API_ImportPhoneNumber.md) 
+  [ImportWorkspaceMedia](API_ImportWorkspaceMedia.md) 
+  [ListAgentStatuses](API_ListAgentStatuses.md) 
+  [ListAnalyticsDataAssociations](API_ListAnalyticsDataAssociations.md) 
+  [ListAnalyticsDataLakeDataSets](API_ListAnalyticsDataLakeDataSets.md) 
+  [ListApprovedOrigins](API_ListApprovedOrigins.md) 
+  [ListAssociatedContacts](API_ListAssociatedContacts.md) 
+  [ListAuthenticationProfiles](API_ListAuthenticationProfiles.md) 
+  [ListBots](API_ListBots.md) 
+  [ListChildHoursOfOperations](API_ListChildHoursOfOperations.md) 
+  [ListContactEvaluations](API_ListContactEvaluations.md) 
+  [ListContactFlowModuleAliases](API_ListContactFlowModuleAliases.md) 
+  [ListContactFlowModules](API_ListContactFlowModules.md) 
+  [ListContactFlowModuleVersions](API_ListContactFlowModuleVersions.md) 
+  [ListContactFlows](API_ListContactFlows.md) 
+  [ListContactFlowVersions](API_ListContactFlowVersions.md) 
+  [ListContactReferences](API_ListContactReferences.md) 
+  [ListDataTableAttributes](API_ListDataTableAttributes.md) 
+  [ListDataTablePrimaryValues](API_ListDataTablePrimaryValues.md) 
+  [ListDataTables](API_ListDataTables.md) 
+  [ListDataTableValues](API_ListDataTableValues.md) 
+  [ListDefaultVocabularies](API_ListDefaultVocabularies.md) 
+  [ListEntitySecurityProfiles](API_ListEntitySecurityProfiles.md) 
+  [ListEvaluationForms](API_ListEvaluationForms.md) 
+  [ListEvaluationFormVersions](API_ListEvaluationFormVersions.md) 
+  [ListFlowAssociations](API_ListFlowAssociations.md) 
+  [ListHoursOfOperationOverrides](API_ListHoursOfOperationOverrides.md) 
+  [ListHoursOfOperations](API_ListHoursOfOperations.md) 
+  [ListInstanceAttributes](API_ListInstanceAttributes.md) 
+  [ListInstances](API_ListInstances.md) 
+  [ListInstanceStorageConfigs](API_ListInstanceStorageConfigs.md) 
+  [ListIntegrationAssociations](API_ListIntegrationAssociations.md) 
+  [ListLambdaFunctions](API_ListLambdaFunctions.md) 
+  [ListLexBots](API_ListLexBots.md) 
+  [ListNotifications](API_ListNotifications.md) 
+  [ListPhoneNumbers](API_ListPhoneNumbers.md) 
+  [ListPhoneNumbersV2](API_ListPhoneNumbersV2.md) 
+  [ListPredefinedAttributes](API_ListPredefinedAttributes.md) 
+  [ListPrompts](API_ListPrompts.md) 
+  [ListQueueEmailAddresses](API_ListQueueEmailAddresses.md) 
+  [ListQueueQuickConnects](API_ListQueueQuickConnects.md) 
+  [ListQueues](API_ListQueues.md) 
+  [ListQuickConnects](API_ListQuickConnects.md) 
+  [ListRealtimeContactAnalysisSegmentsV2](API_ListRealtimeContactAnalysisSegmentsV2.md) 
+  [ListRoutingProfileManualAssignmentQueues](API_ListRoutingProfileManualAssignmentQueues.md) 
+  [ListRoutingProfileQueues](API_ListRoutingProfileQueues.md) 
+  [ListRoutingProfiles](API_ListRoutingProfiles.md) 
+  [ListRules](API_ListRules.md) 
+  [ListSecurityKeys](API_ListSecurityKeys.md) 
+  [ListSecurityProfileApplications](API_ListSecurityProfileApplications.md) 
+  [ListSecurityProfileFlowModules](API_ListSecurityProfileFlowModules.md) 
+  [ListSecurityProfilePermissions](API_ListSecurityProfilePermissions.md) 
+  [ListSecurityProfiles](API_ListSecurityProfiles.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListTaskTemplates](API_ListTaskTemplates.md) 
+  [ListTestCaseExecutionRecords](API_ListTestCaseExecutionRecords.md) 
+  [ListTestCaseExecutions](API_ListTestCaseExecutions.md) 
+  [ListTestCases](API_ListTestCases.md) 
+  [ListTrafficDistributionGroups](API_ListTrafficDistributionGroups.md) 
+  [ListTrafficDistributionGroupUsers](API_ListTrafficDistributionGroupUsers.md) 
+  [ListUseCases](API_ListUseCases.md) 
+  [ListUserHierarchyGroups](API_ListUserHierarchyGroups.md) 
+  [ListUserNotifications](API_ListUserNotifications.md) 
+  [ListUserProficiencies](API_ListUserProficiencies.md) 
+  [ListUsers](API_ListUsers.md) 
+  [ListViews](API_ListViews.md) 
+  [ListViewVersions](API_ListViewVersions.md) 
+  [ListWorkspaceMedia](API_ListWorkspaceMedia.md) 
+  [ListWorkspacePages](API_ListWorkspacePages.md) 
+  [ListWorkspaces](API_ListWorkspaces.md) 
+  [MonitorContact](API_MonitorContact.md) 
+  [PauseContact](API_PauseContact.md) 
+  [PutUserStatus](API_PutUserStatus.md) 
+  [ReleasePhoneNumber](API_ReleasePhoneNumber.md) 
+  [ReplicateInstance](API_ReplicateInstance.md) 
+  [ResumeContact](API_ResumeContact.md) 
+  [ResumeContactRecording](API_ResumeContactRecording.md) 
+  [SearchAgentStatuses](API_SearchAgentStatuses.md) 
+  [SearchAvailablePhoneNumbers](API_SearchAvailablePhoneNumbers.md) 
+  [SearchContactEvaluations](API_SearchContactEvaluations.md) 
+  [SearchContactFlowModules](API_SearchContactFlowModules.md) 
+  [SearchContactFlows](API_SearchContactFlows.md) 
+  [SearchContacts](API_SearchContacts.md) 
+  [SearchDataTables](API_SearchDataTables.md) 
+  [SearchEmailAddresses](API_SearchEmailAddresses.md) 
+  [SearchEvaluationForms](API_SearchEvaluationForms.md) 
+  [SearchHoursOfOperationOverrides](API_SearchHoursOfOperationOverrides.md) 
+  [SearchHoursOfOperations](API_SearchHoursOfOperations.md) 
+  [SearchNotifications](API_SearchNotifications.md) 
+  [SearchPredefinedAttributes](API_SearchPredefinedAttributes.md) 
+  [SearchPrompts](API_SearchPrompts.md) 
+  [SearchQueues](API_SearchQueues.md) 
+  [SearchQuickConnects](API_SearchQuickConnects.md) 
+  [SearchResourceTags](API_SearchResourceTags.md) 
+  [SearchRoutingProfiles](API_SearchRoutingProfiles.md) 
+  [SearchSecurityProfiles](API_SearchSecurityProfiles.md) 
+  [SearchTestCases](API_SearchTestCases.md) 
+  [SearchUserHierarchyGroups](API_SearchUserHierarchyGroups.md) 
+  [SearchUsers](API_SearchUsers.md) 
+  [SearchViews](API_SearchViews.md) 
+  [SearchVocabularies](API_SearchVocabularies.md) 
+  [SearchWorkspaceAssociations](API_SearchWorkspaceAssociations.md) 
+  [SearchWorkspaces](API_SearchWorkspaces.md) 
+  [SendChatIntegrationEvent](API_SendChatIntegrationEvent.md) 
+  [SendOutboundEmail](API_SendOutboundEmail.md) 
+  [StartAttachedFileUpload](API_StartAttachedFileUpload.md) 
+  [StartChatContact](API_StartChatContact.md) 
+  [StartContactEvaluation](API_StartContactEvaluation.md) 
+  [StartContactMediaProcessing](API_StartContactMediaProcessing.md) 
+  [StartContactRecording](API_StartContactRecording.md) 
+  [StartContactStreaming](API_StartContactStreaming.md) 
+  [StartEmailContact](API_StartEmailContact.md) 
+  [StartOutboundChatContact](API_StartOutboundChatContact.md) 
+  [StartOutboundEmailContact](API_StartOutboundEmailContact.md) 
+  [StartOutboundVoiceContact](API_StartOutboundVoiceContact.md) 
+  [StartScreenSharing](API_StartScreenSharing.md) 
+  [StartTaskContact](API_StartTaskContact.md) 
+  [StartTestCaseExecution](API_StartTestCaseExecution.md) 
+  [StartWebRTCContact](API_StartWebRTCContact.md) 
+  [StopContact](API_StopContact.md) 
+  [StopContactMediaProcessing](API_StopContactMediaProcessing.md) 
+  [StopContactRecording](API_StopContactRecording.md) 
+  [StopContactStreaming](API_StopContactStreaming.md) 
+  [StopTestCaseExecution](API_StopTestCaseExecution.md) 
+  [SubmitContactEvaluation](API_SubmitContactEvaluation.md) 
+  [SuspendContactRecording](API_SuspendContactRecording.md) 
+  [TagContact](API_TagContact.md) 
+  [TagResource](API_TagResource.md) 
+  [TransferContact](API_TransferContact.md) 
+  [UntagContact](API_UntagContact.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateAgentStatus](API_UpdateAgentStatus.md) 
+  [UpdateAuthenticationProfile](API_UpdateAuthenticationProfile.md) 
+  [UpdateContact](API_UpdateContact.md) 
+  [UpdateContactAttributes](API_UpdateContactAttributes.md) 
+  [UpdateContactEvaluation](API_UpdateContactEvaluation.md) 
+  [UpdateContactFlowContent](API_UpdateContactFlowContent.md) 
+  [UpdateContactFlowMetadata](API_UpdateContactFlowMetadata.md) 
+  [UpdateContactFlowModuleAlias](API_UpdateContactFlowModuleAlias.md) 
+  [UpdateContactFlowModuleContent](API_UpdateContactFlowModuleContent.md) 
+  [UpdateContactFlowModuleMetadata](API_UpdateContactFlowModuleMetadata.md) 
+  [UpdateContactFlowName](API_UpdateContactFlowName.md) 
+  [UpdateContactRoutingData](API_UpdateContactRoutingData.md) 
+  [UpdateContactSchedule](API_UpdateContactSchedule.md) 
+  [UpdateDataTableAttribute](API_UpdateDataTableAttribute.md) 
+  [UpdateDataTableMetadata](API_UpdateDataTableMetadata.md) 
+  [UpdateDataTablePrimaryValues](API_UpdateDataTablePrimaryValues.md) 
+  [UpdateEmailAddressMetadata](API_UpdateEmailAddressMetadata.md) 
+  [UpdateEvaluationForm](API_UpdateEvaluationForm.md) 
+  [UpdateHoursOfOperation](API_UpdateHoursOfOperation.md) 
+  [UpdateHoursOfOperationOverride](API_UpdateHoursOfOperationOverride.md) 
+  [UpdateInstanceAttribute](API_UpdateInstanceAttribute.md) 
+  [UpdateInstanceStorageConfig](API_UpdateInstanceStorageConfig.md) 
+  [UpdateNotificationContent](API_UpdateNotificationContent.md) 
+  [UpdateParticipantAuthentication](API_UpdateParticipantAuthentication.md) 
+  [UpdateParticipantRoleConfig](API_UpdateParticipantRoleConfig.md) 
+  [UpdatePhoneNumber](API_UpdatePhoneNumber.md) 
+  [UpdatePhoneNumberMetadata](API_UpdatePhoneNumberMetadata.md) 
+  [UpdatePredefinedAttribute](API_UpdatePredefinedAttribute.md) 
+  [UpdatePrompt](API_UpdatePrompt.md) 
+  [UpdateQueueHoursOfOperation](API_UpdateQueueHoursOfOperation.md) 
+  [UpdateQueueMaxContacts](API_UpdateQueueMaxContacts.md) 
+  [UpdateQueueName](API_UpdateQueueName.md) 
+  [UpdateQueueOutboundCallerConfig](API_UpdateQueueOutboundCallerConfig.md) 
+  [UpdateQueueOutboundEmailConfig](API_UpdateQueueOutboundEmailConfig.md) 
+  [UpdateQueueStatus](API_UpdateQueueStatus.md) 
+  [UpdateQuickConnectConfig](API_UpdateQuickConnectConfig.md) 
+  [UpdateQuickConnectName](API_UpdateQuickConnectName.md) 
+  [UpdateRoutingProfileAgentAvailabilityTimer](API_UpdateRoutingProfileAgentAvailabilityTimer.md) 
+  [UpdateRoutingProfileConcurrency](API_UpdateRoutingProfileConcurrency.md) 
+  [UpdateRoutingProfileDefaultOutboundQueue](API_UpdateRoutingProfileDefaultOutboundQueue.md) 
+  [UpdateRoutingProfileName](API_UpdateRoutingProfileName.md) 
+  [UpdateRoutingProfileQueues](API_UpdateRoutingProfileQueues.md) 
+  [UpdateRule](API_UpdateRule.md) 
+  [UpdateSecurityProfile](API_UpdateSecurityProfile.md) 
+  [UpdateTaskTemplate](API_UpdateTaskTemplate.md) 
+  [UpdateTestCase](API_UpdateTestCase.md) 
+  [UpdateTrafficDistribution](API_UpdateTrafficDistribution.md) 
+  [UpdateUserConfig](API_UpdateUserConfig.md) 
+  [UpdateUserHierarchy](API_UpdateUserHierarchy.md) 
+  [UpdateUserHierarchyGroupName](API_UpdateUserHierarchyGroupName.md) 
+  [UpdateUserHierarchyStructure](API_UpdateUserHierarchyStructure.md) 
+  [UpdateUserIdentityInfo](API_UpdateUserIdentityInfo.md) 
+  [UpdateUserNotificationStatus](API_UpdateUserNotificationStatus.md) 
+  [UpdateUserPhoneConfig](API_UpdateUserPhoneConfig.md) 
+  [UpdateUserProficiencies](API_UpdateUserProficiencies.md) 
+  [UpdateUserRoutingProfile](API_UpdateUserRoutingProfile.md) 
+  [UpdateUserSecurityProfiles](API_UpdateUserSecurityProfiles.md) 
+  [UpdateViewContent](API_UpdateViewContent.md) 
+  [UpdateViewMetadata](API_UpdateViewMetadata.md) 
+  [UpdateWorkspaceMetadata](API_UpdateWorkspaceMetadata.md) 
+  [UpdateWorkspacePage](API_UpdateWorkspacePage.md) 
+  [UpdateWorkspaceTheme](API_UpdateWorkspaceTheme.md) 
+  [UpdateWorkspaceVisibility](API_UpdateWorkspaceVisibility.md) 

# ActivateEvaluationForm
<a name="API_ActivateEvaluationForm"></a>

Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form. 

## Request Syntax
<a name="API_ActivateEvaluationForm_RequestSyntax"></a>

```
POST /evaluation-forms/InstanceId/EvaluationFormId/activate HTTP/1.1
Content-type: application/json

{
   "EvaluationFormVersion": number
}
```

## URI Request Parameters
<a name="API_ActivateEvaluationForm_RequestParameters"></a>

The request uses the following URI parameters.

 ** [EvaluationFormId](#API_ActivateEvaluationForm_RequestSyntax) **   <a name="connect-ActivateEvaluationForm-request-uri-EvaluationFormId"></a>
The unique identifier for the evaluation form.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [InstanceId](#API_ActivateEvaluationForm_RequestSyntax) **   <a name="connect-ActivateEvaluationForm-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_ActivateEvaluationForm_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [EvaluationFormVersion](#API_ActivateEvaluationForm_RequestSyntax) **   <a name="connect-ActivateEvaluationForm-request-EvaluationFormVersion"></a>
The version of the evaluation form to activate. If the version property is not provided, the latest version of the evaluation form is activated.  
Type: Integer  
Required: Yes

## Response Syntax
<a name="API_ActivateEvaluationForm_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EvaluationFormArn": "string",
   "EvaluationFormId": "string",
   "EvaluationFormVersion": number
}
```

## Response Elements
<a name="API_ActivateEvaluationForm_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EvaluationFormArn](#API_ActivateEvaluationForm_ResponseSyntax) **   <a name="connect-ActivateEvaluationForm-response-EvaluationFormArn"></a>
The Amazon Resource Name (ARN) for the evaluation form resource.  
Type: String

 ** [EvaluationFormId](#API_ActivateEvaluationForm_ResponseSyntax) **   <a name="connect-ActivateEvaluationForm-response-EvaluationFormId"></a>
The unique identifier for the evaluation form.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [EvaluationFormVersion](#API_ActivateEvaluationForm_ResponseSyntax) **   <a name="connect-ActivateEvaluationForm-response-EvaluationFormVersion"></a>
A version of the evaluation form.  
Type: Integer

## Errors
<a name="API_ActivateEvaluationForm_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_ActivateEvaluationForm_Examples"></a>

### Example
<a name="API_ActivateEvaluationForm_Example_1"></a>

The following example activates version 3 of an evaluation form. 

#### Sample Request
<a name="API_ActivateEvaluationForm_Example_1_Request"></a>

```
{
   "InstanceId": "[instance_id]",
   "EvaluationFormId": "[evaluation_form_id]",
   "EvaluationFormVersion": 3
}
```

#### Sample Response
<a name="API_ActivateEvaluationForm_Example_1_Response"></a>

```
{
   "EvaluationFormId": "[evaluation_form_id]",
   "EvaluationFormArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/evaluation-form/[evaluation_form_id]",
   "EvaluationFormVersion": 3
}
```

## See Also
<a name="API_ActivateEvaluationForm_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ActivateEvaluationForm) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ActivateEvaluationForm) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ActivateEvaluationForm) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ActivateEvaluationForm) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ActivateEvaluationForm) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ActivateEvaluationForm) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ActivateEvaluationForm) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ActivateEvaluationForm) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ActivateEvaluationForm) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ActivateEvaluationForm) 

# AssociateAnalyticsDataSet
<a name="API_AssociateAnalyticsDataSet"></a>

Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.

## Request Syntax
<a name="API_AssociateAnalyticsDataSet_RequestSyntax"></a>

```
PUT /analytics-data/instance/InstanceId/association HTTP/1.1
Content-type: application/json

{
   "DataSetId": "string",
   "TargetAccountId": "string"
}
```

## URI Request Parameters
<a name="API_AssociateAnalyticsDataSet_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_AssociateAnalyticsDataSet_RequestSyntax) **   <a name="connect-AssociateAnalyticsDataSet-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_AssociateAnalyticsDataSet_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [DataSetId](#API_AssociateAnalyticsDataSet_RequestSyntax) **   <a name="connect-AssociateAnalyticsDataSet-request-DataSetId"></a>
The identifier of the dataset to associate with the target account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** [TargetAccountId](#API_AssociateAnalyticsDataSet_RequestSyntax) **   <a name="connect-AssociateAnalyticsDataSet-request-TargetAccountId"></a>
The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the AWS account that has the Amazon Connect instance.  
Type: String  
Required: No

## Response Syntax
<a name="API_AssociateAnalyticsDataSet_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DataSetId": "string",
   "ResourceShareArn": "string",
   "ResourceShareId": "string",
   "TargetAccountId": "string"
}
```

## Response Elements
<a name="API_AssociateAnalyticsDataSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DataSetId](#API_AssociateAnalyticsDataSet_ResponseSyntax) **   <a name="connect-AssociateAnalyticsDataSet-response-DataSetId"></a>
The identifier of the dataset that was associated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [ResourceShareArn](#API_AssociateAnalyticsDataSet_ResponseSyntax) **   <a name="connect-AssociateAnalyticsDataSet-response-ResourceShareArn"></a>
The Amazon Resource Name (ARN) of the AWS Resource Access Manager share.   
Type: String

 ** [ResourceShareId](#API_AssociateAnalyticsDataSet_ResponseSyntax) **   <a name="connect-AssociateAnalyticsDataSet-response-ResourceShareId"></a>
The AWS Resource Access Manager share ID that is generated.  
Type: String

 ** [TargetAccountId](#API_AssociateAnalyticsDataSet_ResponseSyntax) **   <a name="connect-AssociateAnalyticsDataSet-response-TargetAccountId"></a>
The identifier of the target account.   
Type: String

## Errors
<a name="API_AssociateAnalyticsDataSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_AssociateAnalyticsDataSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/AssociateAnalyticsDataSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/AssociateAnalyticsDataSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/AssociateAnalyticsDataSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/AssociateAnalyticsDataSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/AssociateAnalyticsDataSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/AssociateAnalyticsDataSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/AssociateAnalyticsDataSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/AssociateAnalyticsDataSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/AssociateAnalyticsDataSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/AssociateAnalyticsDataSet) 

# AssociateApprovedOrigin
<a name="API_AssociateApprovedOrigin"></a>

This API is in preview release for Amazon Connect and is subject to change.

Associates an approved origin to an Amazon Connect instance.

## Request Syntax
<a name="API_AssociateApprovedOrigin_RequestSyntax"></a>

```
PUT /instance/InstanceId/approved-origin HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "Origin": "string"
}
```

## URI Request Parameters
<a name="API_AssociateApprovedOrigin_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_AssociateApprovedOrigin_RequestSyntax) **   <a name="connect-AssociateApprovedOrigin-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_AssociateApprovedOrigin_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_AssociateApprovedOrigin_RequestSyntax) **   <a name="connect-AssociateApprovedOrigin-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [Origin](#API_AssociateApprovedOrigin_RequestSyntax) **   <a name="connect-AssociateApprovedOrigin-request-Origin"></a>
The domain to add to your allow list.  
Type: String  
Length Constraints: Maximum length of 267.  
Required: Yes

## Response Syntax
<a name="API_AssociateApprovedOrigin_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_AssociateApprovedOrigin_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateApprovedOrigin_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_AssociateApprovedOrigin_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/AssociateApprovedOrigin) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/AssociateApprovedOrigin) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/AssociateApprovedOrigin) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/AssociateApprovedOrigin) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/AssociateApprovedOrigin) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/AssociateApprovedOrigin) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/AssociateApprovedOrigin) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/AssociateApprovedOrigin) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/AssociateApprovedOrigin) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/AssociateApprovedOrigin) 

# AssociateBot
<a name="API_AssociateBot"></a>

This API is in preview release for Amazon Connect and is subject to change.

Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot.

## Request Syntax
<a name="API_AssociateBot_RequestSyntax"></a>

```
PUT /instance/InstanceId/bot HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "LexBot": { 
      "LexRegion": "string",
      "Name": "string"
   },
   "LexV2Bot": { 
      "AliasArn": "string"
   }
}
```

## URI Request Parameters
<a name="API_AssociateBot_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_AssociateBot_RequestSyntax) **   <a name="connect-AssociateBot-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_AssociateBot_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_AssociateBot_RequestSyntax) **   <a name="connect-AssociateBot-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [LexBot](#API_AssociateBot_RequestSyntax) **   <a name="connect-AssociateBot-request-LexBot"></a>
Configuration information of an Amazon Lex bot.  
Type: [LexBot](API_LexBot.md) object  
Required: No

 ** [LexV2Bot](#API_AssociateBot_RequestSyntax) **   <a name="connect-AssociateBot-request-LexV2Bot"></a>
The Amazon Lex V2 bot to associate with the instance.  
Type: [LexV2Bot](API_LexV2Bot.md) object  
Required: No

## Response Syntax
<a name="API_AssociateBot_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_AssociateBot_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateBot_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_AssociateBot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/AssociateBot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/AssociateBot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/AssociateBot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/AssociateBot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/AssociateBot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/AssociateBot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/AssociateBot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/AssociateBot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/AssociateBot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/AssociateBot) 

# AssociateContactWithUser
<a name="API_AssociateContactWithUser"></a>

Associates a queued contact with an agent.

 **Use cases** 

Following are common uses cases for this API:
+ Programmatically assign queued contacts to available users.
+ Leverage the IAM context key `connect:PreferredUserArn` to restrict contact association to specific preferred user.

 **Important things to know** 
+ Use this API with chat, email, and task contacts. It does not support voice contacts.
+ Use it to associate contacts with users regardless of their current state, including custom states. Ensure your application logic accounts for user availability before making associations.
+ It honors the IAM context key `connect:PreferredUserArn` to prevent unauthorized contact associations.
+ It respects the IAM context key `connect:PreferredUserArn` to enforce authorization controls and prevent unauthorized contact associations. Verify that your IAM policies are properly configured to support your intended use cases.
+ The service quota *Queues per routing profile per instance* applies to manually assigned queues, too. For more information about this quota, see [Amazon Connect quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas) in the *Amazon Connect Administrator Guide*.

 **Endpoints**: See [Amazon Connect endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/connect_region.html).

## Request Syntax
<a name="API_AssociateContactWithUser_RequestSyntax"></a>

```
POST /contacts/InstanceId/ContactId/associate-user HTTP/1.1
Content-type: application/json

{
   "UserId": "string"
}
```

## URI Request Parameters
<a name="API_AssociateContactWithUser_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactId](#API_AssociateContactWithUser_RequestSyntax) **   <a name="connect-AssociateContactWithUser-request-uri-ContactId"></a>
The identifier of the contact in this instance of Amazon Connect.   
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_AssociateContactWithUser_RequestSyntax) **   <a name="connect-AssociateContactWithUser-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_AssociateContactWithUser_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [UserId](#API_AssociateContactWithUser_RequestSyntax) **   <a name="connect-AssociateContactWithUser-request-UserId"></a>
The identifier for the user. This can be the ID or the ARN of the user.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Response Syntax
<a name="API_AssociateContactWithUser_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_AssociateContactWithUser_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateContactWithUser_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_AssociateContactWithUser_Examples"></a>

### Example request to associate a queued contact with a user
<a name="API_AssociateContactWithUser_Example_1"></a>

Following is an example of associating a queued contact with a user.

```
POST https://connect.us-west-2.amazonaws.com/contacts/{InstanceId}/{ContactId}/associate-user HTTP/1.1
Content-type: application/json

{
     "UserId": "string"
}
```

### Example response if the association succeeds
<a name="API_AssociateContactWithUser_Example_2"></a>

If the association succeeds an HTTP 200 OK response is returned.

```
HTTP/1.1 200
```

## See Also
<a name="API_AssociateContactWithUser_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/AssociateContactWithUser) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/AssociateContactWithUser) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/AssociateContactWithUser) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/AssociateContactWithUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/AssociateContactWithUser) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/AssociateContactWithUser) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/AssociateContactWithUser) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/AssociateContactWithUser) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/AssociateContactWithUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/AssociateContactWithUser) 

# AssociateDefaultVocabulary
<a name="API_AssociateDefaultVocabulary"></a>

Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.

## Request Syntax
<a name="API_AssociateDefaultVocabulary_RequestSyntax"></a>

```
PUT /default-vocabulary/InstanceId/LanguageCode HTTP/1.1
Content-type: application/json

{
   "VocabularyId": "string"
}
```

## URI Request Parameters
<a name="API_AssociateDefaultVocabulary_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_AssociateDefaultVocabulary_RequestSyntax) **   <a name="connect-AssociateDefaultVocabulary-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [LanguageCode](#API_AssociateDefaultVocabulary_RequestSyntax) **   <a name="connect-AssociateDefaultVocabulary-request-uri-LanguageCode"></a>
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see [What is Amazon Transcribe?](https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html)   
Valid Values: `ar-AE | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fr-CA | fr-FR | hi-IN | it-IT | ja-JP | ko-KR | pt-BR | pt-PT | zh-CN | en-NZ | en-ZA | ca-ES | da-DK | fi-FI | id-ID | ms-MY | nl-NL | no-NO | pl-PL | sv-SE | tl-PH`   
Required: Yes

## Request Body
<a name="API_AssociateDefaultVocabulary_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [VocabularyId](#API_AssociateDefaultVocabulary_RequestSyntax) **   <a name="connect-AssociateDefaultVocabulary-request-VocabularyId"></a>
The identifier of the custom vocabulary. If this is empty, the default is set to none.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: No

## Response Syntax
<a name="API_AssociateDefaultVocabulary_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_AssociateDefaultVocabulary_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateDefaultVocabulary_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_AssociateDefaultVocabulary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/AssociateDefaultVocabulary) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/AssociateDefaultVocabulary) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/AssociateDefaultVocabulary) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/AssociateDefaultVocabulary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/AssociateDefaultVocabulary) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/AssociateDefaultVocabulary) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/AssociateDefaultVocabulary) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/AssociateDefaultVocabulary) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/AssociateDefaultVocabulary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/AssociateDefaultVocabulary) 

# AssociateEmailAddressAlias
<a name="API_AssociateEmailAddressAlias"></a>

Associates an email address alias with an existing email address in an Amazon Connect instance. This creates a forwarding relationship where emails sent to the alias email address are automatically forwarded to the primary email address. 

 **Use cases** 

Following are common uses cases for this API:
+  **Unified customer support**: Create multiple entry points (for example, support@example.com, help@example.com, customercare@example.com) that all forward to a single agent queue for streamlined management.
+  **Department consolidation**: Forward emails from legacy department addresses (for example, sales@example.com, info@example.com) to a centralized customer service email during organizational restructuring.
+  **Brand management**: Enable you to use familiar brand-specific email addresses that forward to the appropriate Amazon Connect instance email address.

 **Important things to know** 
+ Each email address can have a maximum of one alias. You cannot create multiple aliases for the same email address. 
+ If the alias email address already receives direct emails, it continues to receive direct emails plus forwarded emails.
+ You cannot chain email aliases together (that is, create an alias of an alias).

 `AssociateEmailAddressAlias` does not return the following information:
+ A confirmation of the alias relationship details (you must call [DescribeEmailAddress](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeEmailAddress.html) to verify).
+ The timestamp of when the association occurred.
+ The status of the forwarding configuration.

 **Endpoints**: See [Amazon Connect endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/connect_region.html).

 **Related operations** 
+  [DisassociateEmailAddressAlias](https://docs.aws.amazon.com/connect/latest/APIReference/API_DisassociateEmailAddressAlias.html): Removes the alias association between two email addresses in an Amazon Connect instance.
+  [DescribeEmailAddress](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeEmailAddress.html): View current alias configurations for an email address.
+  [SearchEmailAddresses](https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchEmailAddresses.html): Find email addresses and their alias relationships across an instance.
+  [CreateEmailAddress](https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateEmailAddress.html): Create new email addresses that can participate in alias relationships.
+  [DeleteEmailAddress](https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteEmailAddress.html): Remove email addresses (automatically removes any alias relationships).
+  [UpdateEmailAddressMetadata](https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateEmailAddressMetadata.html): Modify email address properties (does not affect alias relationships).

## Request Syntax
<a name="API_AssociateEmailAddressAlias_RequestSyntax"></a>

```
POST /email-addresses/InstanceId/EmailAddressId/associate-alias HTTP/1.1
Content-type: application/json

{
   "AliasConfiguration": { 
      "EmailAddressId": "string"
   },
   "ClientToken": "string"
}
```

## URI Request Parameters
<a name="API_AssociateEmailAddressAlias_RequestParameters"></a>

The request uses the following URI parameters.

 ** [EmailAddressId](#API_AssociateEmailAddressAlias_RequestSyntax) **   <a name="connect-AssociateEmailAddressAlias-request-uri-EmailAddressId"></a>
The identifier of the email address.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [InstanceId](#API_AssociateEmailAddressAlias_RequestSyntax) **   <a name="connect-AssociateEmailAddressAlias-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_AssociateEmailAddressAlias_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AliasConfiguration](#API_AssociateEmailAddressAlias_RequestSyntax) **   <a name="connect-AssociateEmailAddressAlias-request-AliasConfiguration"></a>
Configuration object that specifies which email address will serve as the alias. The specified email address must already exist in the Amazon Connect instance and cannot already be configured as an alias or have an alias of its own.  
Type: [AliasConfiguration](API_AliasConfiguration.md) object  
Required: Yes

 ** [ClientToken](#API_AssociateEmailAddressAlias_RequestSyntax) **   <a name="connect-AssociateEmailAddressAlias-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

## Response Syntax
<a name="API_AssociateEmailAddressAlias_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_AssociateEmailAddressAlias_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateEmailAddressAlias_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** IdempotencyException **   
An entity with the same name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_AssociateEmailAddressAlias_Examples"></a>

### Example 1: Basic alias association
<a name="API_AssociateEmailAddressAlias_Example_1"></a>

The following example creates a forwarding relationship where support@example.com (87654321-4321-4321-4321-210987654321) forwards to customerservice@example.com (11111111-2222-3333-4444-555555555555).

 **Request** 

```
POST / HTTP/1.1
Host: connect.us-east-1.amazonaws.com
Content-Length: 152
X-Amz-Target: AmazonConnectService.AssociateEmailAddressAlias
X-Amz-Date: 20170705T211529Z
Authorization: AWS4-HMAC-SHA256\
 Credential=AKIAI44QH8DHBEXAMPLE/20170705/us-east-1/connect/aws4_request,\
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,\
 Signature=6bcb6a5ef9ee7585d83955e8a5c3f6d47cf581596208fc0e436fa1de26ef3f6a
Content-Type: application/x-amz-json-1.1
{
    "InstanceId": "12345678-1234-1234-1234-123456789012",
    "EmailAddressId": "87654321-4321-4321-4321-210987654321",
    "AliasConfiguration": {
        "EmailAddressId": "11111111-2222-3333-4444-555555555555"
    }
}
```

### Example 2: Alias association with client token for idempotency
<a name="API_AssociateEmailAddressAlias_Example_2"></a>

The following example response shows a safely created alias association with guaranteed idempotency for retry scenarios.

```
HTTP/1.1 200 OK
Date: Wed, 05 Jul 2017 21:15:29 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 2
Connection: keep-alive
x-amzn-RequestId: 12345678-1234-1234-1234-123456789012
{}
```

## See Also
<a name="API_AssociateEmailAddressAlias_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/AssociateEmailAddressAlias) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/AssociateEmailAddressAlias) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/AssociateEmailAddressAlias) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/AssociateEmailAddressAlias) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/AssociateEmailAddressAlias) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/AssociateEmailAddressAlias) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/AssociateEmailAddressAlias) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/AssociateEmailAddressAlias) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/AssociateEmailAddressAlias) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/AssociateEmailAddressAlias) 

# AssociateFlow
<a name="API_AssociateFlow"></a>

Associates a connect resource to a flow.

## Request Syntax
<a name="API_AssociateFlow_RequestSyntax"></a>

```
PUT /flow-associations/InstanceId HTTP/1.1
Content-type: application/json

{
   "FlowId": "string",
   "ResourceId": "string",
   "ResourceType": "string"
}
```

## URI Request Parameters
<a name="API_AssociateFlow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_AssociateFlow_RequestSyntax) **   <a name="connect-AssociateFlow-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_AssociateFlow_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [FlowId](#API_AssociateFlow_RequestSyntax) **   <a name="connect-AssociateFlow-request-FlowId"></a>
The identifier of the flow.  
Type: String  
Required: Yes

 ** [ResourceId](#API_AssociateFlow_RequestSyntax) **   <a name="connect-AssociateFlow-request-ResourceId"></a>
The identifier of the resource.  
+  AWS End User Messaging SMS phone number ARN when using `SMS_PHONE_NUMBER` 
+  AWS End User Messaging Social phone number ARN when using `WHATSAPP_MESSAGING_PHONE_NUMBER` 
Type: String  
Required: Yes

 ** [ResourceType](#API_AssociateFlow_RequestSyntax) **   <a name="connect-AssociateFlow-request-ResourceType"></a>
A valid resource type.  
Type: String  
Valid Values: `SMS_PHONE_NUMBER | INBOUND_EMAIL | OUTBOUND_EMAIL | ANALYTICS_CONNECTOR | WHATSAPP_MESSAGING_PHONE_NUMBER`   
Required: Yes

## Response Syntax
<a name="API_AssociateFlow_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_AssociateFlow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateFlow_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_AssociateFlow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/AssociateFlow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/AssociateFlow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/AssociateFlow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/AssociateFlow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/AssociateFlow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/AssociateFlow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/AssociateFlow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/AssociateFlow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/AssociateFlow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/AssociateFlow) 

# AssociateHoursOfOperations
<a name="API_AssociateHoursOfOperations"></a>

Associates a set of hours of operations with another hours of operation. Refer to Administrator Guide [ here ](https://docs.aws.amazon.com/connect/latest/adminguide/hours-of-operation-overrides.html) for more information on inheriting overrides from parent hours of operation(s).

## Request Syntax
<a name="API_AssociateHoursOfOperations_RequestSyntax"></a>

```
POST /hours-of-operations/InstanceId/HoursOfOperationId/associate-hours HTTP/1.1
Content-type: application/json

{
   "ParentHoursOfOperationConfigs": [ 
      { 
         "HoursOfOperationId": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_AssociateHoursOfOperations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [HoursOfOperationId](#API_AssociateHoursOfOperations_RequestSyntax) **   <a name="connect-AssociateHoursOfOperations-request-uri-HoursOfOperationId"></a>
The identifier of the child hours of operation.  
Required: Yes

 ** [InstanceId](#API_AssociateHoursOfOperations_RequestSyntax) **   <a name="connect-AssociateHoursOfOperations-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_AssociateHoursOfOperations_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ParentHoursOfOperationConfigs](#API_AssociateHoursOfOperations_RequestSyntax) **   <a name="connect-AssociateHoursOfOperations-request-ParentHoursOfOperationConfigs"></a>
The Amazon Resource Names (ARNs) of the parent hours of operation resources to associate with the child hours of operation resource.  
Type: Array of [ParentHoursOfOperationConfig](API_ParentHoursOfOperationConfig.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 3 items.  
Required: Yes

## Response Syntax
<a name="API_AssociateHoursOfOperations_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_AssociateHoursOfOperations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateHoursOfOperations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** ConditionalOperationFailedException **   
Request processing failed because dependent condition failed.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_AssociateHoursOfOperations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/AssociateHoursOfOperations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/AssociateHoursOfOperations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/AssociateHoursOfOperations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/AssociateHoursOfOperations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/AssociateHoursOfOperations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/AssociateHoursOfOperations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/AssociateHoursOfOperations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/AssociateHoursOfOperations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/AssociateHoursOfOperations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/AssociateHoursOfOperations) 

# AssociateInstanceStorageConfig
<a name="API_AssociateInstanceStorageConfig"></a>

This API is in preview release for Amazon Connect and is subject to change.

Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts.

This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.

## Request Syntax
<a name="API_AssociateInstanceStorageConfig_RequestSyntax"></a>

```
PUT /instance/InstanceId/storage-config HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "ResourceType": "string",
   "StorageConfig": { 
      "AssociationId": "string",
      "KinesisFirehoseConfig": { 
         "FirehoseArn": "string"
      },
      "KinesisStreamConfig": { 
         "StreamArn": "string"
      },
      "KinesisVideoStreamConfig": { 
         "EncryptionConfig": { 
            "EncryptionType": "string",
            "KeyId": "string"
         },
         "Prefix": "string",
         "RetentionPeriodHours": number
      },
      "S3Config": { 
         "BucketName": "string",
         "BucketPrefix": "string",
         "EncryptionConfig": { 
            "EncryptionType": "string",
            "KeyId": "string"
         }
      },
      "StorageType": "string"
   }
}
```

## URI Request Parameters
<a name="API_AssociateInstanceStorageConfig_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_AssociateInstanceStorageConfig_RequestSyntax) **   <a name="connect-AssociateInstanceStorageConfig-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_AssociateInstanceStorageConfig_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_AssociateInstanceStorageConfig_RequestSyntax) **   <a name="connect-AssociateInstanceStorageConfig-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [ResourceType](#API_AssociateInstanceStorageConfig_RequestSyntax) **   <a name="connect-AssociateInstanceStorageConfig-request-ResourceType"></a>
A valid resource type. To [enable streaming for real-time analysis of contacts](https://docs.aws.amazon.com/connect/latest/adminguide/enable-contact-analysis-segment-streams.html), use the following types:  
+ For chat contacts, use `REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS`.
+ For voice contacts, use `REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS`.
 `REAL_TIME_CONTACT_ANALYSIS_SEGMENTS` is deprecated, but it is still supported and will apply only to VOICE channel contacts. Use `REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS` for voice contacts moving forward.  
If you have previously associated a stream with `REAL_TIME_CONTACT_ANALYSIS_SEGMENTS`, no action is needed to update the stream to `REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS`.
Type: String  
Valid Values: `CHAT_TRANSCRIPTS | CALL_RECORDINGS | SCHEDULED_REPORTS | MEDIA_STREAMS | CONTACT_TRACE_RECORDS | AGENT_EVENTS | REAL_TIME_CONTACT_ANALYSIS_SEGMENTS | ATTACHMENTS | CONTACT_EVALUATIONS | SCREEN_RECORDINGS | REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS | REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS | EMAIL_MESSAGES`   
Required: Yes

 ** [StorageConfig](#API_AssociateInstanceStorageConfig_RequestSyntax) **   <a name="connect-AssociateInstanceStorageConfig-request-StorageConfig"></a>
A valid storage type.  
Type: [InstanceStorageConfig](API_InstanceStorageConfig.md) object  
Required: Yes

## Response Syntax
<a name="API_AssociateInstanceStorageConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AssociationId": "string"
}
```

## Response Elements
<a name="API_AssociateInstanceStorageConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AssociationId](#API_AssociateInstanceStorageConfig_ResponseSyntax) **   <a name="connect-AssociateInstanceStorageConfig-response-AssociationId"></a>
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

## Errors
<a name="API_AssociateInstanceStorageConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_AssociateInstanceStorageConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/AssociateInstanceStorageConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/AssociateInstanceStorageConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/AssociateInstanceStorageConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/AssociateInstanceStorageConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/AssociateInstanceStorageConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/AssociateInstanceStorageConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/AssociateInstanceStorageConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/AssociateInstanceStorageConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/AssociateInstanceStorageConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/AssociateInstanceStorageConfig) 

# AssociateLambdaFunction
<a name="API_AssociateLambdaFunction"></a>

This API is in preview release for Amazon Connect and is subject to change.

Allows the specified Amazon Connect instance to access the specified Lambda function.

## Request Syntax
<a name="API_AssociateLambdaFunction_RequestSyntax"></a>

```
PUT /instance/InstanceId/lambda-function HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "FunctionArn": "string"
}
```

## URI Request Parameters
<a name="API_AssociateLambdaFunction_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_AssociateLambdaFunction_RequestSyntax) **   <a name="connect-AssociateLambdaFunction-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_AssociateLambdaFunction_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_AssociateLambdaFunction_RequestSyntax) **   <a name="connect-AssociateLambdaFunction-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [FunctionArn](#API_AssociateLambdaFunction_RequestSyntax) **   <a name="connect-AssociateLambdaFunction-request-FunctionArn"></a>
The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 140.  
Required: Yes

## Response Syntax
<a name="API_AssociateLambdaFunction_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_AssociateLambdaFunction_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateLambdaFunction_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_AssociateLambdaFunction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/AssociateLambdaFunction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/AssociateLambdaFunction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/AssociateLambdaFunction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/AssociateLambdaFunction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/AssociateLambdaFunction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/AssociateLambdaFunction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/AssociateLambdaFunction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/AssociateLambdaFunction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/AssociateLambdaFunction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/AssociateLambdaFunction) 

# AssociateLexBot
<a name="API_AssociateLexBot"></a>

This API is in preview release for Amazon Connect and is subject to change.

Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.

## Request Syntax
<a name="API_AssociateLexBot_RequestSyntax"></a>

```
PUT /instance/InstanceId/lex-bot HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "LexBot": { 
      "LexRegion": "string",
      "Name": "string"
   }
}
```

## URI Request Parameters
<a name="API_AssociateLexBot_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_AssociateLexBot_RequestSyntax) **   <a name="connect-AssociateLexBot-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_AssociateLexBot_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_AssociateLexBot_RequestSyntax) **   <a name="connect-AssociateLexBot-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [LexBot](#API_AssociateLexBot_RequestSyntax) **   <a name="connect-AssociateLexBot-request-LexBot"></a>
The Amazon Lex bot to associate with the instance.  
Type: [LexBot](API_LexBot.md) object  
Required: Yes

## Response Syntax
<a name="API_AssociateLexBot_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_AssociateLexBot_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateLexBot_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_AssociateLexBot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/AssociateLexBot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/AssociateLexBot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/AssociateLexBot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/AssociateLexBot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/AssociateLexBot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/AssociateLexBot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/AssociateLexBot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/AssociateLexBot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/AssociateLexBot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/AssociateLexBot) 

# AssociatePhoneNumberContactFlow
<a name="API_AssociatePhoneNumberContactFlow"></a>

Associates a flow with a phone number claimed to your Amazon Connect instance.

**Important**  
If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the AWS Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the `PhoneNumberId` URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate AWS Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a `ResourceNotFoundException`.

## Request Syntax
<a name="API_AssociatePhoneNumberContactFlow_RequestSyntax"></a>

```
PUT /phone-number/PhoneNumberId/contact-flow HTTP/1.1
Content-type: application/json

{
   "ContactFlowId": "string",
   "InstanceId": "string"
}
```

## URI Request Parameters
<a name="API_AssociatePhoneNumberContactFlow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [PhoneNumberId](#API_AssociatePhoneNumberContactFlow_RequestSyntax) **   <a name="connect-AssociatePhoneNumberContactFlow-request-uri-PhoneNumberId"></a>
A unique identifier for the phone number.  
Required: Yes

## Request Body
<a name="API_AssociatePhoneNumberContactFlow_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ContactFlowId](#API_AssociatePhoneNumberContactFlow_RequestSyntax) **   <a name="connect-AssociatePhoneNumberContactFlow-request-ContactFlowId"></a>
The identifier of the flow.  
Type: String  
Length Constraints: Maximum length of 500.  
Required: Yes

 ** [InstanceId](#API_AssociatePhoneNumberContactFlow_RequestSyntax) **   <a name="connect-AssociatePhoneNumberContactFlow-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Syntax
<a name="API_AssociatePhoneNumberContactFlow_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_AssociatePhoneNumberContactFlow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociatePhoneNumberContactFlow_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_AssociatePhoneNumberContactFlow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/AssociatePhoneNumberContactFlow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/AssociatePhoneNumberContactFlow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/AssociatePhoneNumberContactFlow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/AssociatePhoneNumberContactFlow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/AssociatePhoneNumberContactFlow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/AssociatePhoneNumberContactFlow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/AssociatePhoneNumberContactFlow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/AssociatePhoneNumberContactFlow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/AssociatePhoneNumberContactFlow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/AssociatePhoneNumberContactFlow) 

# AssociateQueueEmailAddresses
<a name="API_AssociateQueueEmailAddresses"></a>

Associates a set of email addresses with a queue to enable agents to select different "From" (system) email addresses when replying to inbound email contacts or initiating outbound email contacts. This allows agents to handle email contacts across different brands and business units within the same queue.

 **Important things to know** 
+ You can associate up to 49 additional email addresses with a single queue, plus 1 default outbound email address, for a total of 50.
+ The email addresses must already exist in the Amazon Connect instance before they can be associated with a queue.
+ Agents will be able to select from these associated email addresses when handling email contacts in the queue.
+ For inbound email contacts, agents can select from email addresses associated with the queue where the contact was accepted.
+ For outbound email contacts, agents can select from email addresses associated with their default outbound queue configured in their routing profile.

## Request Syntax
<a name="API_AssociateQueueEmailAddresses_RequestSyntax"></a>

```
POST /queues/InstanceId/QueueId/associate-email-addresses HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "EmailAddressesConfig": [ 
      { 
         "EmailAddressId": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_AssociateQueueEmailAddresses_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_AssociateQueueEmailAddresses_RequestSyntax) **   <a name="connect-AssociateQueueEmailAddresses-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [QueueId](#API_AssociateQueueEmailAddresses_RequestSyntax) **   <a name="connect-AssociateQueueEmailAddresses-request-uri-QueueId"></a>
The identifier for the queue.  
Required: Yes

## Request Body
<a name="API_AssociateQueueEmailAddresses_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_AssociateQueueEmailAddresses_RequestSyntax) **   <a name="connect-AssociateQueueEmailAddresses-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [EmailAddressesConfig](#API_AssociateQueueEmailAddresses_RequestSyntax) **   <a name="connect-AssociateQueueEmailAddresses-request-EmailAddressesConfig"></a>
Configuration list containing the email addresses to associate with the queue. Each configuration specifies an email address ID that should be linked to this queue for routing purposes.  
Type: Array of [EmailAddressConfig](API_EmailAddressConfig.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: Yes

## Response Syntax
<a name="API_AssociateQueueEmailAddresses_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_AssociateQueueEmailAddresses_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateQueueEmailAddresses_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_AssociateQueueEmailAddresses_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/AssociateQueueEmailAddresses) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/AssociateQueueEmailAddresses) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/AssociateQueueEmailAddresses) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/AssociateQueueEmailAddresses) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/AssociateQueueEmailAddresses) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/AssociateQueueEmailAddresses) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/AssociateQueueEmailAddresses) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/AssociateQueueEmailAddresses) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/AssociateQueueEmailAddresses) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/AssociateQueueEmailAddresses) 

# AssociateQueueQuickConnects
<a name="API_AssociateQueueQuickConnects"></a>

Associates a set of quick connects with a queue.

## Request Syntax
<a name="API_AssociateQueueQuickConnects_RequestSyntax"></a>

```
POST /queues/InstanceId/QueueId/associate-quick-connects HTTP/1.1
Content-type: application/json

{
   "QuickConnectIds": [ "string" ]
}
```

## URI Request Parameters
<a name="API_AssociateQueueQuickConnects_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_AssociateQueueQuickConnects_RequestSyntax) **   <a name="connect-AssociateQueueQuickConnects-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [QueueId](#API_AssociateQueueQuickConnects_RequestSyntax) **   <a name="connect-AssociateQueueQuickConnects-request-uri-QueueId"></a>
The identifier for the queue.  
Required: Yes

## Request Body
<a name="API_AssociateQueueQuickConnects_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [QuickConnectIds](#API_AssociateQueueQuickConnects_RequestSyntax) **   <a name="connect-AssociateQueueQuickConnects-request-QuickConnectIds"></a>
The quick connects to associate with this queue.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: Yes

## Response Syntax
<a name="API_AssociateQueueQuickConnects_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_AssociateQueueQuickConnects_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateQueueQuickConnects_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_AssociateQueueQuickConnects_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/AssociateQueueQuickConnects) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/AssociateQueueQuickConnects) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/AssociateQueueQuickConnects) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/AssociateQueueQuickConnects) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/AssociateQueueQuickConnects) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/AssociateQueueQuickConnects) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/AssociateQueueQuickConnects) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/AssociateQueueQuickConnects) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/AssociateQueueQuickConnects) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/AssociateQueueQuickConnects) 

# AssociateRoutingProfileQueues
<a name="API_AssociateRoutingProfileQueues"></a>

Associates a set of queues with a routing profile.

## Request Syntax
<a name="API_AssociateRoutingProfileQueues_RequestSyntax"></a>

```
POST /routing-profiles/InstanceId/RoutingProfileId/associate-queues HTTP/1.1
Content-type: application/json

{
   "ManualAssignmentQueueConfigs": [ 
      { 
         "QueueReference": { 
            "Channel": "string",
            "QueueId": "string"
         }
      }
   ],
   "QueueConfigs": [ 
      { 
         "Delay": number,
         "Priority": number,
         "QueueReference": { 
            "Channel": "string",
            "QueueId": "string"
         }
      }
   ]
}
```

## URI Request Parameters
<a name="API_AssociateRoutingProfileQueues_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_AssociateRoutingProfileQueues_RequestSyntax) **   <a name="connect-AssociateRoutingProfileQueues-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [RoutingProfileId](#API_AssociateRoutingProfileQueues_RequestSyntax) **   <a name="connect-AssociateRoutingProfileQueues-request-uri-RoutingProfileId"></a>
The identifier of the routing profile.  
Required: Yes

## Request Body
<a name="API_AssociateRoutingProfileQueues_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ManualAssignmentQueueConfigs](#API_AssociateRoutingProfileQueues_RequestSyntax) **   <a name="connect-AssociateRoutingProfileQueues-request-ManualAssignmentQueueConfigs"></a>
The manual assignment queues to associate with this routing profile.  
Note: Use this config for chat, email, and task contacts. It does not support voice contacts.  
Type: Array of [RoutingProfileManualAssignmentQueueConfig](API_RoutingProfileManualAssignmentQueueConfig.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: No

 ** [QueueConfigs](#API_AssociateRoutingProfileQueues_RequestSyntax) **   <a name="connect-AssociateRoutingProfileQueues-request-QueueConfigs"></a>
The queues to associate with this routing profile.  
Type: Array of [RoutingProfileQueueConfig](API_RoutingProfileQueueConfig.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: No

## Response Syntax
<a name="API_AssociateRoutingProfileQueues_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_AssociateRoutingProfileQueues_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateRoutingProfileQueues_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_AssociateRoutingProfileQueues_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/AssociateRoutingProfileQueues) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/AssociateRoutingProfileQueues) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/AssociateRoutingProfileQueues) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/AssociateRoutingProfileQueues) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/AssociateRoutingProfileQueues) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/AssociateRoutingProfileQueues) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/AssociateRoutingProfileQueues) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/AssociateRoutingProfileQueues) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/AssociateRoutingProfileQueues) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/AssociateRoutingProfileQueues) 

# AssociateSecurityKey
<a name="API_AssociateSecurityKey"></a>

This API is in preview release for Amazon Connect and is subject to change.

Associates a security key to the instance.

## Request Syntax
<a name="API_AssociateSecurityKey_RequestSyntax"></a>

```
PUT /instance/InstanceId/security-key HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "Key": "string"
}
```

## URI Request Parameters
<a name="API_AssociateSecurityKey_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_AssociateSecurityKey_RequestSyntax) **   <a name="connect-AssociateSecurityKey-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_AssociateSecurityKey_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_AssociateSecurityKey_RequestSyntax) **   <a name="connect-AssociateSecurityKey-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [Key](#API_AssociateSecurityKey_RequestSyntax) **   <a name="connect-AssociateSecurityKey-request-Key"></a>
A valid security key in PEM format as a String.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

## Response Syntax
<a name="API_AssociateSecurityKey_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AssociationId": "string"
}
```

## Response Elements
<a name="API_AssociateSecurityKey_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AssociationId](#API_AssociateSecurityKey_ResponseSyntax) **   <a name="connect-AssociateSecurityKey-response-AssociationId"></a>
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

## Errors
<a name="API_AssociateSecurityKey_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_AssociateSecurityKey_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/AssociateSecurityKey) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/AssociateSecurityKey) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/AssociateSecurityKey) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/AssociateSecurityKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/AssociateSecurityKey) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/AssociateSecurityKey) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/AssociateSecurityKey) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/AssociateSecurityKey) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/AssociateSecurityKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/AssociateSecurityKey) 

# AssociateSecurityProfiles
<a name="API_AssociateSecurityProfiles"></a>

 Associate security profiles with an Entity in an Amazon Connect instance. 

## Request Syntax
<a name="API_AssociateSecurityProfiles_RequestSyntax"></a>

```
POST /associate-security-profiles/InstanceId HTTP/1.1
Content-type: application/json

{
   "EntityArn": "string",
   "EntityType": "string",
   "SecurityProfiles": [ 
      { 
         "Id": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_AssociateSecurityProfiles_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_AssociateSecurityProfiles_RequestSyntax) **   <a name="connect-AssociateSecurityProfiles-request-uri-InstanceId"></a>
 The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.   
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_AssociateSecurityProfiles_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [EntityArn](#API_AssociateSecurityProfiles_RequestSyntax) **   <a name="connect-AssociateSecurityProfiles-request-EntityArn"></a>
 Arn of a Q in Connect AI Agent.   
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

 ** [EntityType](#API_AssociateSecurityProfiles_RequestSyntax) **   <a name="connect-AssociateSecurityProfiles-request-EntityType"></a>
 Only supported type is AI\$1AGENT.   
Type: String  
Valid Values: `USER | AI_AGENT`   
Required: Yes

 ** [SecurityProfiles](#API_AssociateSecurityProfiles_RequestSyntax) **   <a name="connect-AssociateSecurityProfiles-request-SecurityProfiles"></a>
 List of Security Profile Object.   
Type: Array of [SecurityProfileItem](API_SecurityProfileItem.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: Yes

## Response Syntax
<a name="API_AssociateSecurityProfiles_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_AssociateSecurityProfiles_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateSecurityProfiles_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** ConditionalOperationFailedException **   
Request processing failed because dependent condition failed.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

## See Also
<a name="API_AssociateSecurityProfiles_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/AssociateSecurityProfiles) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/AssociateSecurityProfiles) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/AssociateSecurityProfiles) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/AssociateSecurityProfiles) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/AssociateSecurityProfiles) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/AssociateSecurityProfiles) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/AssociateSecurityProfiles) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/AssociateSecurityProfiles) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/AssociateSecurityProfiles) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/AssociateSecurityProfiles) 

# AssociateTrafficDistributionGroupUser
<a name="API_AssociateTrafficDistributionGroupUser"></a>

Associates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

## Request Syntax
<a name="API_AssociateTrafficDistributionGroupUser_RequestSyntax"></a>

```
PUT /traffic-distribution-group/TrafficDistributionGroupId/user HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "UserId": "string"
}
```

## URI Request Parameters
<a name="API_AssociateTrafficDistributionGroupUser_RequestParameters"></a>

The request uses the following URI parameters.

 ** [TrafficDistributionGroupId](#API_AssociateTrafficDistributionGroupUser_RequestSyntax) **   <a name="connect-AssociateTrafficDistributionGroupUser-request-uri-TrafficDistributionGroupId"></a>
The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z-]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

## Request Body
<a name="API_AssociateTrafficDistributionGroupUser_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_AssociateTrafficDistributionGroupUser_RequestSyntax) **   <a name="connect-AssociateTrafficDistributionGroupUser-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [UserId](#API_AssociateTrafficDistributionGroupUser_RequestSyntax) **   <a name="connect-AssociateTrafficDistributionGroupUser-request-UserId"></a>
The identifier of the user account. This can be the ID or the ARN of the user.   
Type: String  
Required: Yes

## Response Syntax
<a name="API_AssociateTrafficDistributionGroupUser_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_AssociateTrafficDistributionGroupUser_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateTrafficDistributionGroupUser_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_AssociateTrafficDistributionGroupUser_Examples"></a>

### Example
<a name="API_AssociateTrafficDistributionGroupUser_Example_1"></a>

The following example associates an agent with a traffic distribution group.

#### Sample Request
<a name="API_AssociateTrafficDistributionGroupUser_Example_1_Request"></a>

```
PUT connect.[region].amazonaws.com/traffic-distribution-group/[traffic_distribution_group_id]/user
{
   "InstanceId": "[instance_id]",
   "UserId": "[user_id]"
}
```

#### Sample Response
<a name="API_AssociateTrafficDistributionGroupUser_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_AssociateTrafficDistributionGroupUser_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/AssociateTrafficDistributionGroupUser) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/AssociateTrafficDistributionGroupUser) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/AssociateTrafficDistributionGroupUser) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/AssociateTrafficDistributionGroupUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/AssociateTrafficDistributionGroupUser) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/AssociateTrafficDistributionGroupUser) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/AssociateTrafficDistributionGroupUser) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/AssociateTrafficDistributionGroupUser) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/AssociateTrafficDistributionGroupUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/AssociateTrafficDistributionGroupUser) 

# AssociateUserProficiencies
<a name="API_AssociateUserProficiencies"></a>

Associates a set of proficiencies with a user.

## Request Syntax
<a name="API_AssociateUserProficiencies_RequestSyntax"></a>

```
POST /users/InstanceId/UserId/associate-proficiencies HTTP/1.1
Content-type: application/json

{
   "UserProficiencies": [ 
      { 
         "AttributeName": "string",
         "AttributeValue": "string",
         "Level": number
      }
   ]
}
```

## URI Request Parameters
<a name="API_AssociateUserProficiencies_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_AssociateUserProficiencies_RequestSyntax) **   <a name="connect-AssociateUserProficiencies-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN of the instance).  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [UserId](#API_AssociateUserProficiencies_RequestSyntax) **   <a name="connect-AssociateUserProficiencies-request-uri-UserId"></a>
The identifier of the user account.  
Required: Yes

## Request Body
<a name="API_AssociateUserProficiencies_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [UserProficiencies](#API_AssociateUserProficiencies_RequestSyntax) **   <a name="connect-AssociateUserProficiencies-request-UserProficiencies"></a>
The proficiencies to associate with the user.  
Type: Array of [UserProficiency](API_UserProficiency.md) objects  
Required: Yes

## Response Syntax
<a name="API_AssociateUserProficiencies_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_AssociateUserProficiencies_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_AssociateUserProficiencies_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_AssociateUserProficiencies_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/AssociateUserProficiencies) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/AssociateUserProficiencies) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/AssociateUserProficiencies) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/AssociateUserProficiencies) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/AssociateUserProficiencies) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/AssociateUserProficiencies) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/AssociateUserProficiencies) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/AssociateUserProficiencies) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/AssociateUserProficiencies) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/AssociateUserProficiencies) 

# AssociateWorkspace
<a name="API_AssociateWorkspace"></a>

Associates a workspace with one or more users or routing profiles, allowing them to access the workspace's configured views and pages.

## Request Syntax
<a name="API_AssociateWorkspace_RequestSyntax"></a>

```
POST /workspaces/InstanceId/WorkspaceId/associate HTTP/1.1
Content-type: application/json

{
   "ResourceArns": [ "string" ]
}
```

## URI Request Parameters
<a name="API_AssociateWorkspace_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_AssociateWorkspace_RequestSyntax) **   <a name="connect-AssociateWorkspace-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [WorkspaceId](#API_AssociateWorkspace_RequestSyntax) **   <a name="connect-AssociateWorkspace-request-uri-WorkspaceId"></a>
The identifier of the workspace.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_AssociateWorkspace_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ResourceArns](#API_AssociateWorkspace_RequestSyntax) **   <a name="connect-AssociateWorkspace-request-ResourceArns"></a>
The Amazon Resource Names (ARNs) of the resources to associate with the workspace. Valid resource types are users and routing profiles.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 25 items.  
Required: Yes

## Response Syntax
<a name="API_AssociateWorkspace_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "FailedList": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "ResourceArn": "string"
      }
   ],
   "SuccessfulList": [ 
      { 
         "ResourceArn": "string"
      }
   ]
}
```

## Response Elements
<a name="API_AssociateWorkspace_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FailedList](#API_AssociateWorkspace_ResponseSyntax) **   <a name="connect-AssociateWorkspace-response-FailedList"></a>
A list of resources that failed to be associated with the workspace, including error details.  
Type: Array of [FailedBatchAssociationSummary](API_FailedBatchAssociationSummary.md) objects

 ** [SuccessfulList](#API_AssociateWorkspace_ResponseSyntax) **   <a name="connect-AssociateWorkspace-response-SuccessfulList"></a>
A list of resources that were successfully associated with the workspace.  
Type: Array of [SuccessfulBatchAssociationSummary](API_SuccessfulBatchAssociationSummary.md) objects

## Errors
<a name="API_AssociateWorkspace_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_AssociateWorkspace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/AssociateWorkspace) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/AssociateWorkspace) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/AssociateWorkspace) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/AssociateWorkspace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/AssociateWorkspace) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/AssociateWorkspace) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/AssociateWorkspace) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/AssociateWorkspace) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/AssociateWorkspace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/AssociateWorkspace) 

# BatchAssociateAnalyticsDataSet
<a name="API_BatchAssociateAnalyticsDataSet"></a>

Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call.

## Request Syntax
<a name="API_BatchAssociateAnalyticsDataSet_RequestSyntax"></a>

```
PUT /analytics-data/instance/InstanceId/associations HTTP/1.1
Content-type: application/json

{
   "DataSetIds": [ "string" ],
   "TargetAccountId": "string"
}
```

## URI Request Parameters
<a name="API_BatchAssociateAnalyticsDataSet_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_BatchAssociateAnalyticsDataSet_RequestSyntax) **   <a name="connect-BatchAssociateAnalyticsDataSet-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_BatchAssociateAnalyticsDataSet_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [DataSetIds](#API_BatchAssociateAnalyticsDataSet_RequestSyntax) **   <a name="connect-BatchAssociateAnalyticsDataSet-request-DataSetIds"></a>
An array of dataset identifiers to associate.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** [TargetAccountId](#API_BatchAssociateAnalyticsDataSet_RequestSyntax) **   <a name="connect-BatchAssociateAnalyticsDataSet-request-TargetAccountId"></a>
The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the AWS account that has the Amazon Connect instance.  
Type: String  
Required: No

## Response Syntax
<a name="API_BatchAssociateAnalyticsDataSet_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Created": [ 
      { 
         "DataSetId": "string",
         "ResourceShareArn": "string",
         "ResourceShareId": "string",
         "ResourceShareStatus": "string",
         "TargetAccountId": "string"
      }
   ],
   "Errors": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string"
      }
   ]
}
```

## Response Elements
<a name="API_BatchAssociateAnalyticsDataSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Created](#API_BatchAssociateAnalyticsDataSet_ResponseSyntax) **   <a name="connect-BatchAssociateAnalyticsDataSet-response-Created"></a>
Information about associations that are successfully created: `DataSetId`, `TargetAccountId`, `ResourceShareId`, `ResourceShareArn`.   
Type: Array of [AnalyticsDataAssociationResult](API_AnalyticsDataAssociationResult.md) objects

 ** [Errors](#API_BatchAssociateAnalyticsDataSet_ResponseSyntax) **   <a name="connect-BatchAssociateAnalyticsDataSet-response-Errors"></a>
A list of errors for datasets that aren't successfully associated with the target account.  
Type: Array of [ErrorResult](API_ErrorResult.md) objects

## Errors
<a name="API_BatchAssociateAnalyticsDataSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_BatchAssociateAnalyticsDataSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/BatchAssociateAnalyticsDataSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/BatchAssociateAnalyticsDataSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/BatchAssociateAnalyticsDataSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/BatchAssociateAnalyticsDataSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/BatchAssociateAnalyticsDataSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/BatchAssociateAnalyticsDataSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/BatchAssociateAnalyticsDataSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/BatchAssociateAnalyticsDataSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/BatchAssociateAnalyticsDataSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/BatchAssociateAnalyticsDataSet) 

# BatchCreateDataTableValue
<a name="API_BatchCreateDataTableValue"></a>

Creates values for attributes in a data table. The value may be a default or it may be associated with a primary value. The value must pass all customer defined validation as well as the default validation for the value type. The operation must conform to Batch Operation API Standards. Although the standard specifies that successful and failed entities are listed separately in the response, authorization fails if any primary values or attributes are unauthorized. The combination of primary values and the attribute name serve as the identifier for the individual item request.

## Request Syntax
<a name="API_BatchCreateDataTableValue_RequestSyntax"></a>

```
POST /data-tables/InstanceId/DataTableId/values/create HTTP/1.1
Content-type: application/json

{
   "Values": [ 
      { 
         "AttributeName": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "LockVersion": { 
            "Attribute": "string",
            "DataTable": "string",
            "PrimaryValues": "string",
            "Value": "string"
         },
         "PrimaryValues": [ 
            { 
               "AttributeName": "string",
               "Value": "string"
            }
         ],
         "Value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_BatchCreateDataTableValue_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DataTableId](#API_BatchCreateDataTableValue_RequestSyntax) **   <a name="connect-BatchCreateDataTableValue-request-uri-DataTableId"></a>
The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If no alias is provided, the default behavior is identical to providing the \$1LATEST alias.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_BatchCreateDataTableValue_RequestSyntax) **   <a name="connect-BatchCreateDataTableValue-request-uri-InstanceId"></a>
The unique identifier for the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_BatchCreateDataTableValue_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Values](#API_BatchCreateDataTableValue_RequestSyntax) **   <a name="connect-BatchCreateDataTableValue-request-Values"></a>
A list of values to create. Each value must specify the attribute name and optionally primary values if the table has primary attributes.  
Type: Array of [DataTableValue](API_DataTableValue.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## Response Syntax
<a name="API_BatchCreateDataTableValue_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Failed": [ 
      { 
         "AttributeName": "string",
         "Message": "string",
         "PrimaryValues": [ 
            { 
               "AttributeName": "string",
               "Value": "string"
            }
         ]
      }
   ],
   "Successful": [ 
      { 
         "AttributeName": "string",
         "LockVersion": { 
            "Attribute": "string",
            "DataTable": "string",
            "PrimaryValues": "string",
            "Value": "string"
         },
         "PrimaryValues": [ 
            { 
               "AttributeName": "string",
               "Value": "string"
            }
         ],
         "RecordId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_BatchCreateDataTableValue_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Failed](#API_BatchCreateDataTableValue_ResponseSyntax) **   <a name="connect-BatchCreateDataTableValue-response-Failed"></a>
A list of values that failed to be created with error messages explaining the failure reason.  
Type: Array of [BatchCreateDataTableValueFailureResult](API_BatchCreateDataTableValueFailureResult.md) objects

 ** [Successful](#API_BatchCreateDataTableValue_ResponseSyntax) **   <a name="connect-BatchCreateDataTableValue-response-Successful"></a>
A list of successfully created values with their identifiers and lock versions.  
Type: Array of [BatchCreateDataTableValueSuccessResult](API_BatchCreateDataTableValueSuccessResult.md) objects

## Errors
<a name="API_BatchCreateDataTableValue_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
Operation cannot be performed at this time as there is a conflict with another operation or contact state.  
HTTP Status Code: 409

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_BatchCreateDataTableValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/BatchCreateDataTableValue) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/BatchCreateDataTableValue) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/BatchCreateDataTableValue) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/BatchCreateDataTableValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/BatchCreateDataTableValue) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/BatchCreateDataTableValue) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/BatchCreateDataTableValue) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/BatchCreateDataTableValue) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/BatchCreateDataTableValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/BatchCreateDataTableValue) 

# BatchDeleteDataTableValue
<a name="API_BatchDeleteDataTableValue"></a>

Deletes multiple values from a data table. API users may delete values at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the attribute and its values were accessed. System managed values are not deletable by customers.

## Request Syntax
<a name="API_BatchDeleteDataTableValue_RequestSyntax"></a>

```
POST /data-tables/InstanceId/DataTableId/values/delete HTTP/1.1
Content-type: application/json

{
   "Values": [ 
      { 
         "AttributeName": "string",
         "LockVersion": { 
            "Attribute": "string",
            "DataTable": "string",
            "PrimaryValues": "string",
            "Value": "string"
         },
         "PrimaryValues": [ 
            { 
               "AttributeName": "string",
               "Value": "string"
            }
         ]
      }
   ]
}
```

## URI Request Parameters
<a name="API_BatchDeleteDataTableValue_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DataTableId](#API_BatchDeleteDataTableValue_RequestSyntax) **   <a name="connect-BatchDeleteDataTableValue-request-uri-DataTableId"></a>
The unique identifier for the data table. Must also accept the table ARN with or without a version alias.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_BatchDeleteDataTableValue_RequestSyntax) **   <a name="connect-BatchDeleteDataTableValue-request-uri-InstanceId"></a>
The unique identifier for the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_BatchDeleteDataTableValue_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Values](#API_BatchDeleteDataTableValue_RequestSyntax) **   <a name="connect-BatchDeleteDataTableValue-request-Values"></a>
A list of value identifiers to delete, each specifying primary values, attribute name, and lock version information.  
Type: Array of [DataTableDeleteValueIdentifier](API_DataTableDeleteValueIdentifier.md) objects  
Required: Yes

## Response Syntax
<a name="API_BatchDeleteDataTableValue_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Failed": [ 
      { 
         "AttributeName": "string",
         "Message": "string",
         "PrimaryValues": [ 
            { 
               "AttributeName": "string",
               "Value": "string"
            }
         ]
      }
   ],
   "Successful": [ 
      { 
         "AttributeName": "string",
         "LockVersion": { 
            "Attribute": "string",
            "DataTable": "string",
            "PrimaryValues": "string",
            "Value": "string"
         },
         "PrimaryValues": [ 
            { 
               "AttributeName": "string",
               "Value": "string"
            }
         ]
      }
   ]
}
```

## Response Elements
<a name="API_BatchDeleteDataTableValue_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Failed](#API_BatchDeleteDataTableValue_ResponseSyntax) **   <a name="connect-BatchDeleteDataTableValue-response-Failed"></a>
A list of values that failed to be deleted with error messages explaining the failure reason.  
Type: Array of [BatchDeleteDataTableValueFailureResult](API_BatchDeleteDataTableValueFailureResult.md) objects

 ** [Successful](#API_BatchDeleteDataTableValue_ResponseSyntax) **   <a name="connect-BatchDeleteDataTableValue-response-Successful"></a>
A list of successfully deleted values with their identifiers and updated lock versions.  
Type: Array of [BatchDeleteDataTableValueSuccessResult](API_BatchDeleteDataTableValueSuccessResult.md) objects

## Errors
<a name="API_BatchDeleteDataTableValue_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
Operation cannot be performed at this time as there is a conflict with another operation or contact state.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_BatchDeleteDataTableValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/BatchDeleteDataTableValue) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/BatchDeleteDataTableValue) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/BatchDeleteDataTableValue) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/BatchDeleteDataTableValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/BatchDeleteDataTableValue) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/BatchDeleteDataTableValue) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/BatchDeleteDataTableValue) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/BatchDeleteDataTableValue) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/BatchDeleteDataTableValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/BatchDeleteDataTableValue) 

# BatchDescribeDataTableValue
<a name="API_BatchDescribeDataTableValue"></a>

Retrieves multiple values from a data table without evaluating expressions. Returns the raw stored values along with metadata such as lock versions and modification timestamps. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.

## Request Syntax
<a name="API_BatchDescribeDataTableValue_RequestSyntax"></a>

```
POST /data-tables/InstanceId/DataTableId/values/describe HTTP/1.1
Content-type: application/json

{
   "Values": [ 
      { 
         "AttributeName": "string",
         "PrimaryValues": [ 
            { 
               "AttributeName": "string",
               "Value": "string"
            }
         ]
      }
   ]
}
```

## URI Request Parameters
<a name="API_BatchDescribeDataTableValue_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DataTableId](#API_BatchDescribeDataTableValue_RequestSyntax) **   <a name="connect-BatchDescribeDataTableValue-request-uri-DataTableId"></a>
The unique identifier for the data table. Must also accept the table ARN with or without a version alias.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_BatchDescribeDataTableValue_RequestSyntax) **   <a name="connect-BatchDescribeDataTableValue-request-uri-InstanceId"></a>
The unique identifier for the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_BatchDescribeDataTableValue_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Values](#API_BatchDescribeDataTableValue_RequestSyntax) **   <a name="connect-BatchDescribeDataTableValue-request-Values"></a>
A list of value identifiers to retrieve, each specifying primary values and attribute names.  
Type: Array of [DataTableValueIdentifier](API_DataTableValueIdentifier.md) objects  
Required: Yes

## Response Syntax
<a name="API_BatchDescribeDataTableValue_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Failed": [ 
      { 
         "AttributeName": "string",
         "Message": "string",
         "PrimaryValues": [ 
            { 
               "AttributeName": "string",
               "Value": "string"
            }
         ]
      }
   ],
   "Successful": [ 
      { 
         "AttributeId": "string",
         "AttributeName": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "LockVersion": { 
            "Attribute": "string",
            "DataTable": "string",
            "PrimaryValues": "string",
            "Value": "string"
         },
         "PrimaryValues": [ 
            { 
               "AttributeId": "string",
               "AttributeName": "string",
               "Value": "string"
            }
         ],
         "RecordId": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_BatchDescribeDataTableValue_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Failed](#API_BatchDescribeDataTableValue_ResponseSyntax) **   <a name="connect-BatchDescribeDataTableValue-response-Failed"></a>
A list of values that failed to be retrieved with error messages explaining the failure reason.  
Type: Array of [BatchDescribeDataTableValueFailureResult](API_BatchDescribeDataTableValueFailureResult.md) objects

 ** [Successful](#API_BatchDescribeDataTableValue_ResponseSyntax) **   <a name="connect-BatchDescribeDataTableValue-response-Successful"></a>
A list of successfully retrieved values with their data, metadata, and lock version information.  
Type: Array of [BatchDescribeDataTableValueSuccessResult](API_BatchDescribeDataTableValueSuccessResult.md) objects

## Errors
<a name="API_BatchDescribeDataTableValue_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_BatchDescribeDataTableValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/BatchDescribeDataTableValue) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/BatchDescribeDataTableValue) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/BatchDescribeDataTableValue) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/BatchDescribeDataTableValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/BatchDescribeDataTableValue) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/BatchDescribeDataTableValue) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/BatchDescribeDataTableValue) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/BatchDescribeDataTableValue) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/BatchDescribeDataTableValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/BatchDescribeDataTableValue) 

# BatchDisassociateAnalyticsDataSet
<a name="API_BatchDisassociateAnalyticsDataSet"></a>

Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.

## Request Syntax
<a name="API_BatchDisassociateAnalyticsDataSet_RequestSyntax"></a>

```
POST /analytics-data/instance/InstanceId/associations HTTP/1.1
Content-type: application/json

{
   "DataSetIds": [ "string" ],
   "TargetAccountId": "string"
}
```

## URI Request Parameters
<a name="API_BatchDisassociateAnalyticsDataSet_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_BatchDisassociateAnalyticsDataSet_RequestSyntax) **   <a name="connect-BatchDisassociateAnalyticsDataSet-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_BatchDisassociateAnalyticsDataSet_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [DataSetIds](#API_BatchDisassociateAnalyticsDataSet_RequestSyntax) **   <a name="connect-BatchDisassociateAnalyticsDataSet-request-DataSetIds"></a>
An array of associated dataset identifiers to remove.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** [TargetAccountId](#API_BatchDisassociateAnalyticsDataSet_RequestSyntax) **   <a name="connect-BatchDisassociateAnalyticsDataSet-request-TargetAccountId"></a>
The identifier of the target account. Use to disassociate a dataset from a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the AWS account that has the Amazon Connect instance.  
Type: String  
Required: No

## Response Syntax
<a name="API_BatchDisassociateAnalyticsDataSet_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Deleted": [ "string" ],
   "Errors": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string"
      }
   ]
}
```

## Response Elements
<a name="API_BatchDisassociateAnalyticsDataSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Deleted](#API_BatchDisassociateAnalyticsDataSet_ResponseSyntax) **   <a name="connect-BatchDisassociateAnalyticsDataSet-response-Deleted"></a>
An array of successfully disassociated dataset identifiers.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [Errors](#API_BatchDisassociateAnalyticsDataSet_ResponseSyntax) **   <a name="connect-BatchDisassociateAnalyticsDataSet-response-Errors"></a>
A list of errors for any datasets not successfully removed.  
Type: Array of [ErrorResult](API_ErrorResult.md) objects

## Errors
<a name="API_BatchDisassociateAnalyticsDataSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_BatchDisassociateAnalyticsDataSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/BatchDisassociateAnalyticsDataSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/BatchDisassociateAnalyticsDataSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/BatchDisassociateAnalyticsDataSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/BatchDisassociateAnalyticsDataSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/BatchDisassociateAnalyticsDataSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/BatchDisassociateAnalyticsDataSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/BatchDisassociateAnalyticsDataSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/BatchDisassociateAnalyticsDataSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/BatchDisassociateAnalyticsDataSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/BatchDisassociateAnalyticsDataSet) 

# BatchGetAttachedFileMetadata
<a name="API_BatchGetAttachedFileMetadata"></a>

Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.

## Request Syntax
<a name="API_BatchGetAttachedFileMetadata_RequestSyntax"></a>

```
POST /attached-files/InstanceId?associatedResourceArn=AssociatedResourceArn HTTP/1.1
Content-type: application/json

{
   "FileIds": [ "string" ]
}
```

## URI Request Parameters
<a name="API_BatchGetAttachedFileMetadata_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AssociatedResourceArn](#API_BatchGetAttachedFileMetadata_RequestSyntax) **   <a name="connect-BatchGetAttachedFileMetadata-request-uri-AssociatedResourceArn"></a>
The resource to which the attached file is (being) uploaded to. The supported resources are [Cases](https://docs.aws.amazon.com/connect/latest/adminguide/cases.html) and [Email](https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html).  
This value must be a valid ARN.
Required: Yes

 ** [InstanceId](#API_BatchGetAttachedFileMetadata_RequestSyntax) **   <a name="connect-BatchGetAttachedFileMetadata-request-uri-InstanceId"></a>
The unique identifier of the Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_BatchGetAttachedFileMetadata_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [FileIds](#API_BatchGetAttachedFileMetadata_RequestSyntax) **   <a name="connect-BatchGetAttachedFileMetadata-request-FileIds"></a>
The unique identifiers of the attached file resource.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Response Syntax
<a name="API_BatchGetAttachedFileMetadata_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Errors": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "FileId": "string"
      }
   ],
   "Files": [ 
      { 
         "AssociatedResourceArn": "string",
         "CreatedBy": { ... },
         "CreationTime": "string",
         "FileArn": "string",
         "FileId": "string",
         "FileName": "string",
         "FileSizeInBytes": number,
         "FileStatus": "string",
         "FileUseCaseType": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ]
}
```

## Response Elements
<a name="API_BatchGetAttachedFileMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Errors](#API_BatchGetAttachedFileMetadata_ResponseSyntax) **   <a name="connect-BatchGetAttachedFileMetadata-response-Errors"></a>
List of errors of attached files that could not be retrieved.   
Type: Array of [AttachedFileError](API_AttachedFileError.md) objects

 ** [Files](#API_BatchGetAttachedFileMetadata_ResponseSyntax) **   <a name="connect-BatchGetAttachedFileMetadata-response-Files"></a>
List of attached files that were successfully retrieved.   
Type: Array of [AttachedFile](API_AttachedFile.md) objects

## Errors
<a name="API_BatchGetAttachedFileMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_BatchGetAttachedFileMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/BatchGetAttachedFileMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/BatchGetAttachedFileMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/BatchGetAttachedFileMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/BatchGetAttachedFileMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/BatchGetAttachedFileMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/BatchGetAttachedFileMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/BatchGetAttachedFileMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/BatchGetAttachedFileMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/BatchGetAttachedFileMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/BatchGetAttachedFileMetadata) 

# BatchGetFlowAssociation
<a name="API_BatchGetFlowAssociation"></a>

Retrieve the flow associations for the given resources.

## Request Syntax
<a name="API_BatchGetFlowAssociation_RequestSyntax"></a>

```
POST /flow-associations-batch/InstanceId HTTP/1.1
Content-type: application/json

{
   "ResourceIds": [ "string" ],
   "ResourceType": "string"
}
```

## URI Request Parameters
<a name="API_BatchGetFlowAssociation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_BatchGetFlowAssociation_RequestSyntax) **   <a name="connect-BatchGetFlowAssociation-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_BatchGetFlowAssociation_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ResourceIds](#API_BatchGetFlowAssociation_RequestSyntax) **   <a name="connect-BatchGetFlowAssociation-request-ResourceIds"></a>
A list of resource identifiers to retrieve flow associations.  
+  AWS End User Messaging SMS phone number ARN when using `SMS_PHONE_NUMBER` 
+  AWS End User Messaging Social phone number ARN when using `WHATSAPP_MESSAGING_PHONE_NUMBER` 
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Required: Yes

 ** [ResourceType](#API_BatchGetFlowAssociation_RequestSyntax) **   <a name="connect-BatchGetFlowAssociation-request-ResourceType"></a>
The type of resource association.  
Type: String  
Valid Values: `VOICE_PHONE_NUMBER`   
Required: No

## Response Syntax
<a name="API_BatchGetFlowAssociation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "FlowAssociationSummaryList": [ 
      { 
         "FlowId": "string",
         "ResourceId": "string",
         "ResourceType": "string"
      }
   ]
}
```

## Response Elements
<a name="API_BatchGetFlowAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FlowAssociationSummaryList](#API_BatchGetFlowAssociation_ResponseSyntax) **   <a name="connect-BatchGetFlowAssociation-response-FlowAssociationSummaryList"></a>
Information about flow associations.  
Type: Array of [FlowAssociationSummary](API_FlowAssociationSummary.md) objects

## Errors
<a name="API_BatchGetFlowAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_BatchGetFlowAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/BatchGetFlowAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/BatchGetFlowAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/BatchGetFlowAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/BatchGetFlowAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/BatchGetFlowAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/BatchGetFlowAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/BatchGetFlowAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/BatchGetFlowAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/BatchGetFlowAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/BatchGetFlowAssociation) 

# BatchPutContact
<a name="API_BatchPutContact"></a>

**Note**  
Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.

Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the [PutDialRequestBatch](https://docs.aws.amazon.com/connect-outbound/latest/APIReference/API_PutDialRequestBatch.html) API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact. 

## Request Syntax
<a name="API_BatchPutContact_RequestSyntax"></a>

```
PUT /contact/batch/InstanceId HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "ContactDataRequestList": [ 
      { 
         "Attributes": { 
            "string" : "string" 
         },
         "Campaign": { 
            "CampaignId": "string"
         },
         "CustomerEndpoint": { 
            "Address": "string",
            "Type": "string"
         },
         "OutboundStrategy": { 
            "Config": { 
               "AgentFirst": { 
                  "Preview": { 
                     "AllowedUserActions": [ "string" ],
                     "PostAcceptTimeoutConfig": { 
                        "DurationInSeconds": number
                     }
                  }
               }
            },
            "Type": "string"
         },
         "QueueId": "string",
         "RequestIdentifier": "string",
         "SystemEndpoint": { 
            "Address": "string",
            "Type": "string"
         }
      }
   ]
}
```

## URI Request Parameters
<a name="API_BatchPutContact_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_BatchPutContact_RequestSyntax) **   <a name="connect-BatchPutContact-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_BatchPutContact_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_BatchPutContact_RequestSyntax) **   <a name="connect-BatchPutContact-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [ContactDataRequestList](#API_BatchPutContact_RequestSyntax) **   <a name="connect-BatchPutContact-request-ContactDataRequestList"></a>
List of individual contact requests.  
Type: Array of [ContactDataRequest](API_ContactDataRequest.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 25 items.  
Required: Yes

## Response Syntax
<a name="API_BatchPutContact_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "FailedRequestList": [ 
      { 
         "FailureReasonCode": "string",
         "FailureReasonMessage": "string",
         "RequestIdentifier": "string"
      }
   ],
   "SuccessfulRequestList": [ 
      { 
         "ContactId": "string",
         "RequestIdentifier": "string"
      }
   ]
}
```

## Response Elements
<a name="API_BatchPutContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FailedRequestList](#API_BatchPutContact_ResponseSyntax) **   <a name="connect-BatchPutContact-response-FailedRequestList"></a>
List of requests for which contact creation failed.  
Type: Array of [FailedRequest](API_FailedRequest.md) objects

 ** [SuccessfulRequestList](#API_BatchPutContact_ResponseSyntax) **   <a name="connect-BatchPutContact-response-SuccessfulRequestList"></a>
List of requests for which contact was successfully created.  
Type: Array of [SuccessfulRequest](API_SuccessfulRequest.md) objects

## Errors
<a name="API_BatchPutContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** IdempotencyException **   
An entity with the same name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

## See Also
<a name="API_BatchPutContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/BatchPutContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/BatchPutContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/BatchPutContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/BatchPutContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/BatchPutContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/BatchPutContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/BatchPutContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/BatchPutContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/BatchPutContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/BatchPutContact) 

# BatchUpdateDataTableValue
<a name="API_BatchUpdateDataTableValue"></a>

Updates multiple data table values using all properties from BatchCreateDataTableValue. System managed values are not modifiable by customers. The operation requires proper lock versions to prevent concurrent modification conflicts.

## Request Syntax
<a name="API_BatchUpdateDataTableValue_RequestSyntax"></a>

```
POST /data-tables/InstanceId/DataTableId/values/update HTTP/1.1
Content-type: application/json

{
   "Values": [ 
      { 
         "AttributeName": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "LockVersion": { 
            "Attribute": "string",
            "DataTable": "string",
            "PrimaryValues": "string",
            "Value": "string"
         },
         "PrimaryValues": [ 
            { 
               "AttributeName": "string",
               "Value": "string"
            }
         ],
         "Value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_BatchUpdateDataTableValue_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DataTableId](#API_BatchUpdateDataTableValue_RequestSyntax) **   <a name="connect-BatchUpdateDataTableValue-request-uri-DataTableId"></a>
The unique identifier for the data table. Must also accept the table ARN with or without a version alias.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_BatchUpdateDataTableValue_RequestSyntax) **   <a name="connect-BatchUpdateDataTableValue-request-uri-InstanceId"></a>
The unique identifier for the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_BatchUpdateDataTableValue_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Values](#API_BatchUpdateDataTableValue_RequestSyntax) **   <a name="connect-BatchUpdateDataTableValue-request-Values"></a>
A list of values to update, each including the current lock version to ensure optimistic locking.  
Type: Array of [DataTableValue](API_DataTableValue.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## Response Syntax
<a name="API_BatchUpdateDataTableValue_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Failed": [ 
      { 
         "AttributeName": "string",
         "Message": "string",
         "PrimaryValues": [ 
            { 
               "AttributeName": "string",
               "Value": "string"
            }
         ]
      }
   ],
   "Successful": [ 
      { 
         "AttributeName": "string",
         "LockVersion": { 
            "Attribute": "string",
            "DataTable": "string",
            "PrimaryValues": "string",
            "Value": "string"
         },
         "PrimaryValues": [ 
            { 
               "AttributeName": "string",
               "Value": "string"
            }
         ]
      }
   ]
}
```

## Response Elements
<a name="API_BatchUpdateDataTableValue_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Failed](#API_BatchUpdateDataTableValue_ResponseSyntax) **   <a name="connect-BatchUpdateDataTableValue-response-Failed"></a>
A list of values that failed to be updated with error messages explaining the failure reason.  
Type: Array of [BatchUpdateDataTableValueFailureResult](API_BatchUpdateDataTableValueFailureResult.md) objects

 ** [Successful](#API_BatchUpdateDataTableValue_ResponseSyntax) **   <a name="connect-BatchUpdateDataTableValue-response-Successful"></a>
A list of successfully updated values with their new lock versions and identifiers.  
Type: Array of [BatchUpdateDataTableValueSuccessResult](API_BatchUpdateDataTableValueSuccessResult.md) objects

## Errors
<a name="API_BatchUpdateDataTableValue_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
Operation cannot be performed at this time as there is a conflict with another operation or contact state.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_BatchUpdateDataTableValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/BatchUpdateDataTableValue) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/BatchUpdateDataTableValue) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/BatchUpdateDataTableValue) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/BatchUpdateDataTableValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/BatchUpdateDataTableValue) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/BatchUpdateDataTableValue) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/BatchUpdateDataTableValue) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/BatchUpdateDataTableValue) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/BatchUpdateDataTableValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/BatchUpdateDataTableValue) 

# ClaimPhoneNumber
<a name="API_ClaimPhoneNumber"></a>

Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same AWS Region where the Amazon Connect instance or traffic distribution group was created.

For more information about how to use this operation, see [Claim a phone number in your country](https://docs.aws.amazon.com/connect/latest/adminguide/claim-phone-number.html) and [Claim phone numbers to traffic distribution groups](https://docs.aws.amazon.com/connect/latest/adminguide/claim-phone-numbers-traffic-distribution-groups.html) in the *Amazon Connect Administrator Guide*. 

**Important**  
You can call the [SearchAvailablePhoneNumbers](https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchAvailablePhoneNumbers.html) API for available phone numbers that you can claim. Call the [DescribePhoneNumber](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html) API to verify the status of a previous [ClaimPhoneNumber](https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html) operation.

If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.

By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired. 

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an AWS support ticket.

## Request Syntax
<a name="API_ClaimPhoneNumber_RequestSyntax"></a>

```
POST /phone-number/claim HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "InstanceId": "string",
   "PhoneNumber": "string",
   "PhoneNumberDescription": "string",
   "Tags": { 
      "string" : "string" 
   },
   "TargetArn": "string"
}
```

## URI Request Parameters
<a name="API_ClaimPhoneNumber_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ClaimPhoneNumber_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_ClaimPhoneNumber_RequestSyntax) **   <a name="connect-ClaimPhoneNumber-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [InstanceId](#API_ClaimPhoneNumber_RequestSyntax) **   <a name="connect-ClaimPhoneNumber-request-InstanceId"></a>
The identifier of the Amazon Connect instance that phone numbers are claimed to. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance. You must enter `InstanceId` or `TargetArn`.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [PhoneNumber](#API_ClaimPhoneNumber_RequestSyntax) **   <a name="connect-ClaimPhoneNumber-request-PhoneNumber"></a>
The phone number you want to claim. Phone numbers are formatted `[+] [country code] [subscriber number including area code]`.  
Type: String  
Pattern: `\\+[1-9]\\d{1,14}$`   
Required: Yes

 ** [PhoneNumberDescription](#API_ClaimPhoneNumber_RequestSyntax) **   <a name="connect-ClaimPhoneNumber-request-PhoneNumberDescription"></a>
The description of the phone number.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Pattern: `^[\W\S_]*`   
Required: No

 ** [Tags](#API_ClaimPhoneNumber_RequestSyntax) **   <a name="connect-ClaimPhoneNumber-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

 ** [TargetArn](#API_ClaimPhoneNumber_RequestSyntax) **   <a name="connect-ClaimPhoneNumber-request-TargetArn"></a>
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter `InstanceId` or `TargetArn`.   
Type: String  
Required: No

## Response Syntax
<a name="API_ClaimPhoneNumber_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "PhoneNumberArn": "string",
   "PhoneNumberId": "string"
}
```

## Response Elements
<a name="API_ClaimPhoneNumber_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PhoneNumberArn](#API_ClaimPhoneNumber_ResponseSyntax) **   <a name="connect-ClaimPhoneNumber-response-PhoneNumberArn"></a>
The Amazon Resource Name (ARN) of the phone number.  
Type: String

 ** [PhoneNumberId](#API_ClaimPhoneNumber_ResponseSyntax) **   <a name="connect-ClaimPhoneNumber-response-PhoneNumberId"></a>
A unique identifier for the phone number.  
Type: String

## Errors
<a name="API_ClaimPhoneNumber_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** IdempotencyException **   
An entity with the same name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ClaimPhoneNumber_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ClaimPhoneNumber) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ClaimPhoneNumber) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ClaimPhoneNumber) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ClaimPhoneNumber) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ClaimPhoneNumber) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ClaimPhoneNumber) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ClaimPhoneNumber) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ClaimPhoneNumber) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ClaimPhoneNumber) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ClaimPhoneNumber) 

# CompleteAttachedFileUpload
<a name="API_CompleteAttachedFileUpload"></a>

Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.

## Request Syntax
<a name="API_CompleteAttachedFileUpload_RequestSyntax"></a>

```
POST /attached-files/InstanceId/FileId?associatedResourceArn=AssociatedResourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_CompleteAttachedFileUpload_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AssociatedResourceArn](#API_CompleteAttachedFileUpload_RequestSyntax) **   <a name="connect-CompleteAttachedFileUpload-request-uri-AssociatedResourceArn"></a>
The resource to which the attached file is (being) uploaded to. The supported resources are [Cases](https://docs.aws.amazon.com/connect/latest/adminguide/cases.html) and [Email](https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html).  
This value must be a valid ARN.
Required: Yes

 ** [FileId](#API_CompleteAttachedFileUpload_RequestSyntax) **   <a name="connect-CompleteAttachedFileUpload-request-uri-FileId"></a>
The unique identifier of the attached file resource.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_CompleteAttachedFileUpload_RequestSyntax) **   <a name="connect-CompleteAttachedFileUpload-request-uri-InstanceId"></a>
The unique identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CompleteAttachedFileUpload_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_CompleteAttachedFileUpload_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_CompleteAttachedFileUpload_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_CompleteAttachedFileUpload_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CompleteAttachedFileUpload_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CompleteAttachedFileUpload) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CompleteAttachedFileUpload) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CompleteAttachedFileUpload) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CompleteAttachedFileUpload) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CompleteAttachedFileUpload) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CompleteAttachedFileUpload) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CompleteAttachedFileUpload) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CompleteAttachedFileUpload) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CompleteAttachedFileUpload) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CompleteAttachedFileUpload) 

# CreateAgentStatus
<a name="API_CreateAgentStatus"></a>

Creates an agent status for the specified Amazon Connect instance.

## Request Syntax
<a name="API_CreateAgentStatus_RequestSyntax"></a>

```
PUT /agent-status/InstanceId HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "DisplayOrder": number,
   "Name": "string",
   "State": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateAgentStatus_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateAgentStatus_RequestSyntax) **   <a name="connect-CreateAgentStatus-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateAgentStatus_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_CreateAgentStatus_RequestSyntax) **   <a name="connect-CreateAgentStatus-request-Description"></a>
The description of the status.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Required: No

 ** [DisplayOrder](#API_CreateAgentStatus_RequestSyntax) **   <a name="connect-CreateAgentStatus-request-DisplayOrder"></a>
The display order of the status.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [Name](#API_CreateAgentStatus_RequestSyntax) **   <a name="connect-CreateAgentStatus-request-Name"></a>
The name of the status.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Required: Yes

 ** [State](#API_CreateAgentStatus_RequestSyntax) **   <a name="connect-CreateAgentStatus-request-State"></a>
The state of the status.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: Yes

 ** [Tags](#API_CreateAgentStatus_RequestSyntax) **   <a name="connect-CreateAgentStatus-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateAgentStatus_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AgentStatusARN": "string",
   "AgentStatusId": "string"
}
```

## Response Elements
<a name="API_CreateAgentStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AgentStatusARN](#API_CreateAgentStatus_ResponseSyntax) **   <a name="connect-CreateAgentStatus-response-AgentStatusARN"></a>
The Amazon Resource Name (ARN) of the agent status.  
Type: String

 ** [AgentStatusId](#API_CreateAgentStatus_ResponseSyntax) **   <a name="connect-CreateAgentStatus-response-AgentStatusId"></a>
The identifier of the agent status.  
Type: String

## Errors
<a name="API_CreateAgentStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateAgentStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateAgentStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateAgentStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateAgentStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateAgentStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateAgentStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateAgentStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateAgentStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateAgentStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateAgentStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateAgentStatus) 

# CreateContact
<a name="API_CreateContact"></a>

**Important**  
Only the VOICE, EMAIL, and TASK channels are supported.   
For VOICE: The supported initiation method is `TRANSFER`. The contacts created with this initiation method have a subtype `connect:ExternalAudio`. 
For EMAIL: The supported initiation methods are `OUTBOUND`, `AGENT_REPLY`, and `FLOW`. 
For TASK: The supported initiation method is `API`. Contacts created with this API have a sub-type of `connect:ExternalTask`.

Creates a new VOICE, EMAIL, or TASK contact. 

After a contact is created, you can move it to the desired state by using the `InitiateAs` parameter. While you can use API to create task contacts that are in the `COMPLETED` state, you must contact AWS Support before using it for bulk import use cases. Bulk import causes your requests to be throttled or fail if your CreateContact limits aren't high enough. 

## Request Syntax
<a name="API_CreateContact_RequestSyntax"></a>

```
PUT /contact/create-contact HTTP/1.1
Content-type: application/json

{
   "Attributes": { 
      "string" : "string" 
   },
   "Channel": "string",
   "ClientToken": "string",
   "Description": "string",
   "ExpiryDurationInMinutes": number,
   "InitiateAs": "string",
   "InitiationMethod": "string",
   "InstanceId": "string",
   "Name": "string",
   "PreviousContactId": "string",
   "References": { 
      "string" : { 
         "Arn": "string",
         "Status": "string",
         "StatusReason": "string",
         "Type": "string",
         "Value": "string"
      }
   },
   "RelatedContactId": "string",
   "SegmentAttributes": { 
      "string" : { 
         "ValueArn": "string",
         "ValueInteger": number,
         "ValueList": [ 
            "SegmentAttributeValue"
         ],
         "ValueMap": { 
            "string" : "SegmentAttributeValue"
         },
         "ValueString": "string"
      }
   },
   "UserInfo": { 
      "UserId": "string"
   }
}
```

## URI Request Parameters
<a name="API_CreateContact_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateContact_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Attributes](#API_CreateContact_RequestSyntax) **   <a name="connect-CreateContact-request-Attributes"></a>
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.  
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 32767.  
Value Length Constraints: Minimum length of 0. Maximum length of 32767.  
Required: No

 ** [Channel](#API_CreateContact_RequestSyntax) **   <a name="connect-CreateContact-request-Channel"></a>
The channel for the contact.  
The CHAT channel is not supported. The following information is incorrect. We're working to correct it.
Type: String  
Valid Values: `VOICE | CHAT | TASK | EMAIL`   
Required: Yes

 ** [ClientToken](#API_CreateContact_RequestSyntax) **   <a name="connect-CreateContact-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [Description](#API_CreateContact_RequestSyntax) **   <a name="connect-CreateContact-request-Description"></a>
A description of the contact.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.  
Required: No

 ** [ExpiryDurationInMinutes](#API_CreateContact_RequestSyntax) **   <a name="connect-CreateContact-request-ExpiryDurationInMinutes"></a>
Number of minutes the contact will be active for before expiring  
Type: Integer  
Required: No

 ** [InitiateAs](#API_CreateContact_RequestSyntax) **   <a name="connect-CreateContact-request-InitiateAs"></a>
Initial state of the contact when it's created. Only TASK channel contacts can be initiated with `COMPLETED` state.  
Type: String  
Valid Values: `CONNECTED_TO_USER | COMPLETED`   
Required: No

 ** [InitiationMethod](#API_CreateContact_RequestSyntax) **   <a name="connect-CreateContact-request-InitiationMethod"></a>
Indicates how the contact was initiated.   
CreateContact only supports the following initiation methods. Valid values by channel are:   
+ For VOICE: `TRANSFER` and the subtype `connect:ExternalAudio` 
+ For EMAIL: `OUTBOUND` \$1 `AGENT_REPLY` \$1 `FLOW` 
+ For TASK: `API` 
The other channels listed below are incorrect. We're working to correct this information.
Type: String  
Valid Values: `INBOUND | OUTBOUND | TRANSFER | QUEUE_TRANSFER | CALLBACK | API | DISCONNECT | MONITOR | EXTERNAL_OUTBOUND | WEBRTC_API | AGENT_REPLY | FLOW`   
Required: Yes

 ** [InstanceId](#API_CreateContact_RequestSyntax) **   <a name="connect-CreateContact-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [Name](#API_CreateContact_RequestSyntax) **   <a name="connect-CreateContact-request-Name"></a>
The name of a the contact.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [PreviousContactId](#API_CreateContact_RequestSyntax) **   <a name="connect-CreateContact-request-PreviousContactId"></a>
The ID of the previous contact when creating a transfer contact. This value can be provided only for external audio contacts. For more information, see [Integrate Amazon Connect Contact Lens with external voice systems](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html) in the *Amazon Connect Administrator Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [References](#API_CreateContact_RequestSyntax) **   <a name="connect-CreateContact-request-References"></a>
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: `URL` \$1 `NUMBER` \$1 `STRING` \$1 `DATE` \$1 `EMAIL` \$1 `ATTACHMENT`.  
Type: String to [Reference](API_Reference.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [RelatedContactId](#API_CreateContact_RequestSyntax) **   <a name="connect-CreateContact-request-RelatedContactId"></a>
The identifier of the contact in this instance of Amazon Connect.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [SegmentAttributes](#API_CreateContact_RequestSyntax) **   <a name="connect-CreateContact-request-SegmentAttributes"></a>
A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.  
Attribute keys can include only alphanumeric, -, and \$1.  
This field can be used to set Segment Contact Expiry as a duration in minutes.  
To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with `SegmentAttributes` like \$1 ` "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger": 135}}}}`. 
Type: String to [SegmentAttributeValue](API_SegmentAttributeValue.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [UserInfo](#API_CreateContact_RequestSyntax) **   <a name="connect-CreateContact-request-UserInfo"></a>
User details for the contact  
UserInfo is required when creating an EMAIL contact with `OUTBOUND` and `AGENT_REPLY` contact initiation methods.
Type: [UserInfo](API_UserInfo.md) object  
Required: No

## Response Syntax
<a name="API_CreateContact_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactArn": "string",
   "ContactId": "string"
}
```

## Response Elements
<a name="API_CreateContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContactArn](#API_CreateContact_ResponseSyntax) **   <a name="connect-CreateContact-response-ContactArn"></a>
The Amazon Resource Name (ARN) of the created contact.  
Type: String

 ** [ContactId](#API_CreateContact_ResponseSyntax) **   <a name="connect-CreateContact-response-ContactId"></a>
The identifier of the contact in this instance of Amazon Connect.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_CreateContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
Operation cannot be performed at this time as there is a conflict with another operation or contact state.  
HTTP Status Code: 409

 ** IdempotencyException **   
An entity with the same name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateContact) 

# CreateContactFlow
<a name="API_CreateContactFlow"></a>

Creates a flow for the specified Amazon Connect instance.

You can also create and update flows using the [Amazon Connect Flow language](https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html).

## Request Syntax
<a name="API_CreateContactFlow_RequestSyntax"></a>

```
PUT /contact-flows/InstanceId HTTP/1.1
Content-type: application/json

{
   "Content": "string",
   "Description": "string",
   "Name": "string",
   "Status": "string",
   "Tags": { 
      "string" : "string" 
   },
   "Type": "string"
}
```

## URI Request Parameters
<a name="API_CreateContactFlow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateContactFlow_RequestSyntax) **   <a name="connect-CreateContactFlow-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateContactFlow_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Content](#API_CreateContactFlow_RequestSyntax) **   <a name="connect-CreateContactFlow-request-Content"></a>
The JSON string that represents the content of the flow. For an example, see [Example flow in Amazon Connect Flow language](https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html).   
Length Constraints: Minimum length of 1. Maximum length of 256000.  
Type: String  
Required: Yes

 ** [Description](#API_CreateContactFlow_RequestSyntax) **   <a name="connect-CreateContactFlow-request-Description"></a>
The description of the flow.   
Type: String  
Required: No

 ** [Name](#API_CreateContactFlow_RequestSyntax) **   <a name="connect-CreateContactFlow-request-Name"></a>
The name of the flow.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

 ** [Status](#API_CreateContactFlow_RequestSyntax) **   <a name="connect-CreateContactFlow-request-Status"></a>
Indicates the flow status as either `SAVED` or `PUBLISHED`. The `PUBLISHED` status will initiate validation on the content. the `SAVED` status does not initiate validation of the content. `SAVED` \$1 `PUBLISHED`.  
Type: String  
Valid Values: `PUBLISHED | SAVED`   
Required: No

 ** [Tags](#API_CreateContactFlow_RequestSyntax) **   <a name="connect-CreateContactFlow-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

 ** [Type](#API_CreateContactFlow_RequestSyntax) **   <a name="connect-CreateContactFlow-request-Type"></a>
The type of the flow. For descriptions of the available types, see [Choose a flow type](https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types) in the *Amazon Connect Administrator Guide*.  
Type: String  
Valid Values: `CONTACT_FLOW | CUSTOMER_QUEUE | CUSTOMER_HOLD | CUSTOMER_WHISPER | AGENT_HOLD | AGENT_WHISPER | OUTBOUND_WHISPER | AGENT_TRANSFER | QUEUE_TRANSFER | CAMPAIGN`   
Required: Yes

## Response Syntax
<a name="API_CreateContactFlow_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactFlowArn": "string",
   "ContactFlowId": "string",
   "FlowContentSha256": "string"
}
```

## Response Elements
<a name="API_CreateContactFlow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContactFlowArn](#API_CreateContactFlow_ResponseSyntax) **   <a name="connect-CreateContactFlow-response-ContactFlowArn"></a>
The Amazon Resource Name (ARN) of the flow.  
Type: String

 ** [ContactFlowId](#API_CreateContactFlow_ResponseSyntax) **   <a name="connect-CreateContactFlow-response-ContactFlowId"></a>
The identifier of the flow.  
Type: String  
Length Constraints: Maximum length of 500.

 ** [FlowContentSha256](#API_CreateContactFlow_ResponseSyntax) **   <a name="connect-CreateContactFlow-response-FlowContentSha256"></a>
Indicates the checksum value of the latest published flow content.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9]{64}$` 

## Errors
<a name="API_CreateContactFlow_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidContactFlowException **   
The flow is not valid.    
 ** problems **   
The problems with the flow. Please fix before trying again.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateContactFlow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateContactFlow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateContactFlow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateContactFlow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateContactFlow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateContactFlow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateContactFlow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateContactFlow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateContactFlow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateContactFlow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateContactFlow) 

# CreateContactFlowModule
<a name="API_CreateContactFlowModule"></a>

Creates a flow module for the specified Amazon Connect instance. 

## Request Syntax
<a name="API_CreateContactFlowModule_RequestSyntax"></a>

```
PUT /contact-flow-modules/InstanceId HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "Content": "string",
   "Description": "string",
   "ExternalInvocationConfiguration": { 
      "Enabled": boolean
   },
   "Name": "string",
   "Settings": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateContactFlowModule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateContactFlowModule_RequestSyntax) **   <a name="connect-CreateContactFlowModule-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateContactFlowModule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateContactFlowModule_RequestSyntax) **   <a name="connect-CreateContactFlowModule-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [Content](#API_CreateContactFlowModule_RequestSyntax) **   <a name="connect-CreateContactFlowModule-request-Content"></a>
The JSON string that represents the content of the flow. For an example, see [Example flow in Amazon Connect Flow language](https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html).   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256000.  
Required: Yes

 ** [Description](#API_CreateContactFlowModule_RequestSyntax) **   <a name="connect-CreateContactFlowModule-request-Description"></a>
The description of the flow module.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Pattern: `.*\S.*`   
Required: No

 ** [ExternalInvocationConfiguration](#API_CreateContactFlowModule_RequestSyntax) **   <a name="connect-CreateContactFlowModule-request-ExternalInvocationConfiguration"></a>
The external invocation configuration for the flow module.  
Type: [ExternalInvocationConfiguration](API_ExternalInvocationConfiguration.md) object  
Required: No

 ** [Name](#API_CreateContactFlowModule_RequestSyntax) **   <a name="connect-CreateContactFlowModule-request-Name"></a>
The name of the flow module.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `.*\S.*`   
Required: Yes

 ** [Settings](#API_CreateContactFlowModule_RequestSyntax) **   <a name="connect-CreateContactFlowModule-request-Settings"></a>
The configuration settings for the flow module.  
Type: String  
Required: No

 ** [Tags](#API_CreateContactFlowModule_RequestSyntax) **   <a name="connect-CreateContactFlowModule-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateContactFlowModule_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Id": "string"
}
```

## Response Elements
<a name="API_CreateContactFlowModule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_CreateContactFlowModule_ResponseSyntax) **   <a name="connect-CreateContactFlowModule-response-Arn"></a>
The Amazon Resource Name (ARN) of the flow module.  
Type: String

 ** [Id](#API_CreateContactFlowModule_ResponseSyntax) **   <a name="connect-CreateContactFlowModule-response-Id"></a>
The identifier of the flow module.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_CreateContactFlowModule_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** IdempotencyException **   
An entity with the same name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidContactFlowModuleException **   
The problems with the module. Please fix before trying again.  
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateContactFlowModule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateContactFlowModule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateContactFlowModule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateContactFlowModule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateContactFlowModule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateContactFlowModule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateContactFlowModule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateContactFlowModule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateContactFlowModule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateContactFlowModule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateContactFlowModule) 

# CreateContactFlowModuleAlias
<a name="API_CreateContactFlowModuleAlias"></a>

Creates a named alias that points to a specific version of a contact flow module.

## Request Syntax
<a name="API_CreateContactFlowModuleAlias_RequestSyntax"></a>

```
PUT /contact-flow-modules/InstanceId/ContactFlowModuleId/alias HTTP/1.1
Content-type: application/json

{
   "AliasName": "string",
   "ContactFlowModuleVersion": number,
   "Description": "string"
}
```

## URI Request Parameters
<a name="API_CreateContactFlowModuleAlias_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactFlowModuleId](#API_CreateContactFlowModuleAlias_RequestSyntax) **   <a name="connect-CreateContactFlowModuleAlias-request-uri-ContactFlowModuleId"></a>
The identifier of the flow module.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_CreateContactFlowModuleAlias_RequestSyntax) **   <a name="connect-CreateContactFlowModuleAlias-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

## Request Body
<a name="API_CreateContactFlowModuleAlias_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AliasName](#API_CreateContactFlowModuleAlias_RequestSyntax) **   <a name="connect-CreateContactFlowModuleAlias-request-AliasName"></a>
The name of the alias.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^([$0-9a-zA-Z][_-]?)+$`   
Required: Yes

 ** [ContactFlowModuleVersion](#API_CreateContactFlowModuleAlias_RequestSyntax) **   <a name="connect-CreateContactFlowModuleAlias-request-ContactFlowModuleVersion"></a>
The version of the flow module.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: Yes

 ** [Description](#API_CreateContactFlowModuleAlias_RequestSyntax) **   <a name="connect-CreateContactFlowModuleAlias-request-Description"></a>
The description of the alias.  
Type: String  
Required: No

## Response Syntax
<a name="API_CreateContactFlowModuleAlias_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactFlowModuleArn": "string",
   "Id": "string"
}
```

## Response Elements
<a name="API_CreateContactFlowModuleAlias_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContactFlowModuleArn](#API_CreateContactFlowModuleAlias_ResponseSyntax) **   <a name="connect-CreateContactFlowModuleAlias-response-ContactFlowModuleArn"></a>
The Amazon Resource Name (ARN) of the flow module.  
Type: String

 ** [Id](#API_CreateContactFlowModuleAlias_ResponseSyntax) **   <a name="connect-CreateContactFlowModuleAlias-response-Id"></a>
The identifier of the alias.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_CreateContactFlowModuleAlias_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_CreateContactFlowModuleAlias_Examples"></a>

### Sample Request
<a name="API_CreateContactFlowModuleAlias_Example_1"></a>

This example illustrates one usage of CreateContactFlowModuleAlias.

```
{
  "AliasName": "production",
  "ContactFlowModuleVersion": 2,
  "Description": "Production version of the customer service module"
}
```

### Sample Response
<a name="API_CreateContactFlowModuleAlias_Example_2"></a>

This example illustrates one usage of CreateContactFlowModuleAlias.

```
{
  "ContactFlowModuleArn": "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-1234-1234-123456789012/flow-module/abcdefgh-1234-5678-9012-abcdefghijkl",
  "Id": "12345678-1234-1234-1234-1234678-1234-1234-1234-123456789012-12345678"
}
```

## See Also
<a name="API_CreateContactFlowModuleAlias_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateContactFlowModuleAlias) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateContactFlowModuleAlias) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateContactFlowModuleAlias) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateContactFlowModuleAlias) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateContactFlowModuleAlias) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateContactFlowModuleAlias) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateContactFlowModuleAlias) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateContactFlowModuleAlias) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateContactFlowModuleAlias) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateContactFlowModuleAlias) 

# CreateContactFlowModuleVersion
<a name="API_CreateContactFlowModuleVersion"></a>

Creates an immutable snapshot of a contact flow module, preserving its content and settings at a specific point in time for version control and rollback capabilities.

## Request Syntax
<a name="API_CreateContactFlowModuleVersion_RequestSyntax"></a>

```
PUT /contact-flow-modules/InstanceId/ContactFlowModuleId/version HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "FlowModuleContentSha256": "string"
}
```

## URI Request Parameters
<a name="API_CreateContactFlowModuleVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactFlowModuleId](#API_CreateContactFlowModuleVersion_RequestSyntax) **   <a name="connect-CreateContactFlowModuleVersion-request-uri-ContactFlowModuleId"></a>
The identifier of the flow module.  
Required: Yes

 ** [InstanceId](#API_CreateContactFlowModuleVersion_RequestSyntax) **   <a name="connect-CreateContactFlowModuleVersion-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateContactFlowModuleVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_CreateContactFlowModuleVersion_RequestSyntax) **   <a name="connect-CreateContactFlowModuleVersion-request-Description"></a>
The description of the flow module version.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Pattern: `.*\S.*`   
Required: No

 ** [FlowModuleContentSha256](#API_CreateContactFlowModuleVersion_RequestSyntax) **   <a name="connect-CreateContactFlowModuleVersion-request-FlowModuleContentSha256"></a>
Indicates the checksum value of the flow module content.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9]{64}$`   
Required: No

## Response Syntax
<a name="API_CreateContactFlowModuleVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactFlowModuleArn": "string",
   "Version": number
}
```

## Response Elements
<a name="API_CreateContactFlowModuleVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContactFlowModuleArn](#API_CreateContactFlowModuleVersion_ResponseSyntax) **   <a name="connect-CreateContactFlowModuleVersion-response-ContactFlowModuleArn"></a>
The Amazon Resource Name (ARN) of the flow module.  
Type: String

 ** [Version](#API_CreateContactFlowModuleVersion_ResponseSyntax) **   <a name="connect-CreateContactFlowModuleVersion-response-Version"></a>
The version of the flow module.  
Type: Long  
Valid Range: Minimum value of 1.

## Errors
<a name="API_CreateContactFlowModuleVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_CreateContactFlowModuleVersion_Examples"></a>

### Sample Request
<a name="API_CreateContactFlowModuleVersion_Example_1"></a>

This example illustrates one usage of CreateContactFlowModuleVersion.

```
{
  "Description": "Initial version of the customer service module"
}
```

### Sample Response
<a name="API_CreateContactFlowModuleVersion_Example_2"></a>

This example illustrates one usage of CreateContactFlowModuleVersion.

```
{
  "ContactFlowModuleArn": "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-1234-1234-123456789012/flow-module/abcdefgh-1234-5678-9012-abcdefghijkl",
  "Version": 1
}
```

## See Also
<a name="API_CreateContactFlowModuleVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateContactFlowModuleVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateContactFlowModuleVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateContactFlowModuleVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateContactFlowModuleVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateContactFlowModuleVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateContactFlowModuleVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateContactFlowModuleVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateContactFlowModuleVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateContactFlowModuleVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateContactFlowModuleVersion) 

# CreateContactFlowVersion
<a name="API_CreateContactFlowVersion"></a>

Publishes a new version of the flow provided. Versions are immutable and monotonically increasing. If the `FlowContentSha256` provided is different from the `FlowContentSha256` of the `$LATEST` published flow content, then an error is returned. This API only supports creating versions for flows of type `Campaign`.

## Request Syntax
<a name="API_CreateContactFlowVersion_RequestSyntax"></a>

```
PUT /contact-flows/InstanceId/ContactFlowId/version HTTP/1.1
Content-type: application/json

{
   "ContactFlowVersion": number,
   "Description": "string",
   "FlowContentSha256": "string",
   "LastModifiedRegion": "string",
   "LastModifiedTime": number
}
```

## URI Request Parameters
<a name="API_CreateContactFlowVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactFlowId](#API_CreateContactFlowVersion_RequestSyntax) **   <a name="connect-CreateContactFlowVersion-request-uri-ContactFlowId"></a>
The identifier of the flow.  
Required: Yes

 ** [InstanceId](#API_CreateContactFlowVersion_RequestSyntax) **   <a name="connect-CreateContactFlowVersion-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateContactFlowVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ContactFlowVersion](#API_CreateContactFlowVersion_RequestSyntax) **   <a name="connect-CreateContactFlowVersion-request-ContactFlowVersion"></a>
The identifier of the flow version.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

 ** [Description](#API_CreateContactFlowVersion_RequestSyntax) **   <a name="connect-CreateContactFlowVersion-request-Description"></a>
The description of the flow version.  
Type: String  
Required: No

 ** [FlowContentSha256](#API_CreateContactFlowVersion_RequestSyntax) **   <a name="connect-CreateContactFlowVersion-request-FlowContentSha256"></a>
Indicates the checksum value of the flow content.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9]{64}$`   
Required: No

 ** [LastModifiedRegion](#API_CreateContactFlowVersion_RequestSyntax) **   <a name="connect-CreateContactFlowVersion-request-LastModifiedRegion"></a>
The AWS Region where this resource was last modified.  
Type: String  
Pattern: `[a-z]{2}(-[a-z]+){1,2}(-[0-9])?`   
Required: No

 ** [LastModifiedTime](#API_CreateContactFlowVersion_RequestSyntax) **   <a name="connect-CreateContactFlowVersion-request-LastModifiedTime"></a>
The AWS Region where this resource was last modified.  
Type: Timestamp  
Required: No

## Response Syntax
<a name="API_CreateContactFlowVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactFlowArn": "string",
   "Version": number
}
```

## Response Elements
<a name="API_CreateContactFlowVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContactFlowArn](#API_CreateContactFlowVersion_ResponseSyntax) **   <a name="connect-CreateContactFlowVersion-response-ContactFlowArn"></a>
The Amazon Resource Name (ARN) of the flow.  
Type: String

 ** [Version](#API_CreateContactFlowVersion_ResponseSyntax) **   <a name="connect-CreateContactFlowVersion-response-Version"></a>
The identifier of the flow version.  
Type: Long  
Valid Range: Minimum value of 1.

## Errors
<a name="API_CreateContactFlowVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_CreateContactFlowVersion_Examples"></a>

### Sample Request
<a name="API_CreateContactFlowVersion_Example_1"></a>

This example illustrates one usage of CreateContactFlowVersion.

```
{
  "Description": "description of the flow version"
}
```

### Sample Response
<a name="API_CreateContactFlowVersion_Example_2"></a>

This example illustrates one usage of CreateContactFlowVersion.

```
{
  "ContactFlowArn": "[contact_flow_arn]",
  "Version": 1
}
```

## See Also
<a name="API_CreateContactFlowVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateContactFlowVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateContactFlowVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateContactFlowVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateContactFlowVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateContactFlowVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateContactFlowVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateContactFlowVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateContactFlowVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateContactFlowVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateContactFlowVersion) 

# CreateDataTable
<a name="API_CreateDataTable"></a>

Creates a new data table with the specified properties. Supports the creation of all table properties except for attributes and values. A table with no attributes and values is a valid state for a table. The number of tables per instance is limited to 100 per instance. Customers can request an increase by using AWS Service Quotas.

## Request Syntax
<a name="API_CreateDataTable_RequestSyntax"></a>

```
PUT /data-tables/InstanceId HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "Status": "string",
   "Tags": { 
      "string" : "string" 
   },
   "TimeZone": "string",
   "ValueLockLevel": "string"
}
```

## URI Request Parameters
<a name="API_CreateDataTable_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateDataTable_RequestSyntax) **   <a name="connect-CreateDataTable-request-uri-InstanceId"></a>
The unique identifier for the Amazon Connect instance where the data table will be created.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateDataTable_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_CreateDataTable_RequestSyntax) **   <a name="connect-CreateDataTable-request-Description"></a>
An optional description for the data table. Must conform to Connect human readable string specification and have 0-250 characters. Whitespace must be trimmed first.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 250.  
Pattern: `^[\\P{C}\r\n\t]+$`   
Required: No

 ** [Name](#API_CreateDataTable_RequestSyntax) **   <a name="connect-CreateDataTable-request-Name"></a>
The name for the data table. Must conform to Connect human readable string specification and have 1-127 characters. Whitespace must be trimmed first. Must not start with the reserved case insensitive values 'connect:' and 'aws:'. Must be unique for the instance using case-insensitive comparison.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `^[\p{L}\p{Z}\p{N}\-_.:=@'|]+$`   
Required: Yes

 ** [Status](#API_CreateDataTable_RequestSyntax) **   <a name="connect-CreateDataTable-request-Status"></a>
The status of the data table. One of PUBLISHED or SAVED. Required parameter that determines the initial state of the table.  
Type: String  
Valid Values: `PUBLISHED`   
Required: Yes

 ** [Tags](#API_CreateDataTable_RequestSyntax) **   <a name="connect-CreateDataTable-request-Tags"></a>
Key value pairs for attribute based access control (TBAC or ABAC). Optional tags to apply to the data table for organization and access control purposes.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

 ** [TimeZone](#API_CreateDataTable_RequestSyntax) **   <a name="connect-CreateDataTable-request-TimeZone"></a>
The IANA timezone identifier to use when resolving time based dynamic values. Required even if no time slices are specified.  
Type: String  
Required: Yes

 ** [ValueLockLevel](#API_CreateDataTable_RequestSyntax) **   <a name="connect-CreateDataTable-request-ValueLockLevel"></a>
The data level that concurrent value edits are locked on. One of DATA\$1TABLE, PRIMARY\$1VALUE, ATTRIBUTE, VALUE, and NONE. NONE is the default if unspecified. This determines how concurrent edits are handled when multiple users attempt to modify values simultaneously.  
Type: String  
Valid Values: `NONE | DATA_TABLE | PRIMARY_VALUE | ATTRIBUTE | VALUE`   
Required: Yes

## Response Syntax
<a name="API_CreateDataTable_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Id": "string",
   "LockVersion": { 
      "Attribute": "string",
      "DataTable": "string",
      "PrimaryValues": "string",
      "Value": "string"
   }
}
```

## Response Elements
<a name="API_CreateDataTable_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_CreateDataTable_ResponseSyntax) **   <a name="connect-CreateDataTable-response-Arn"></a>
The Amazon Resource Name (ARN) for the created data table. Does not include the version alias.  
Type: String

 ** [Id](#API_CreateDataTable_ResponseSyntax) **   <a name="connect-CreateDataTable-response-Id"></a>
The unique identifier for the created data table. Does not include the version alias.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [LockVersion](#API_CreateDataTable_ResponseSyntax) **   <a name="connect-CreateDataTable-response-LockVersion"></a>
The lock version information for the created data table, used for optimistic locking and table versioning.  
Type: [DataTableLockVersion](API_DataTableLockVersion.md) object

## Errors
<a name="API_CreateDataTable_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
Operation cannot be performed at this time as there is a conflict with another operation or contact state.  
HTTP Status Code: 409

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateDataTable_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateDataTable) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateDataTable) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateDataTable) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateDataTable) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateDataTable) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateDataTable) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateDataTable) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateDataTable) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateDataTable) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateDataTable) 

# CreateDataTableAttribute
<a name="API_CreateDataTableAttribute"></a>

Adds an attribute to an existing data table. Creating a new primary attribute uses the empty value for the specified value type for all existing records. This should not affect uniqueness of published data tables since the existing primary values will already be unique. Creating attributes does not create any values. System managed tables may not allow customers to create new attributes.

## Request Syntax
<a name="API_CreateDataTableAttribute_RequestSyntax"></a>

```
PUT /data-tables/InstanceId/DataTableId/attributes HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "Primary": boolean,
   "Validation": { 
      "Enum": { 
         "Strict": boolean,
         "Values": [ "string" ]
      },
      "ExclusiveMaximum": number,
      "ExclusiveMinimum": number,
      "IgnoreCase": boolean,
      "Maximum": number,
      "MaxLength": number,
      "MaxValues": number,
      "Minimum": number,
      "MinLength": number,
      "MinValues": number,
      "MultipleOf": number
   },
   "ValueType": "string"
}
```

## URI Request Parameters
<a name="API_CreateDataTableAttribute_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DataTableId](#API_CreateDataTableAttribute_RequestSyntax) **   <a name="connect-CreateDataTableAttribute-request-uri-DataTableId"></a>
The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If the version is provided as part of the identifier or ARN, the version must be one of the two available system managed aliases, \$1SAVED or \$1LATEST.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_CreateDataTableAttribute_RequestSyntax) **   <a name="connect-CreateDataTableAttribute-request-uri-InstanceId"></a>
The unique identifier for the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateDataTableAttribute_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_CreateDataTableAttribute_RequestSyntax) **   <a name="connect-CreateDataTableAttribute-request-Description"></a>
An optional description for the attribute. Must conform to Connect human readable string specification and have 0-250 characters. Whitespace trimmed before persisting.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 250.  
Pattern: `^[\\P{C}\r\n\t]+$`   
Required: No

 ** [Name](#API_CreateDataTableAttribute_RequestSyntax) **   <a name="connect-CreateDataTableAttribute-request-Name"></a>
The name for the attribute. Must conform to Connect human readable string specification and have 1-127 characters. Must not start with the reserved case insensitive values 'connect:' and 'aws:'. Whitespace trimmed before persisting. Must be unique for the data table using case-insensitive comparison.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `^[\p{L}\p{Z}\p{N}\-_.:=@'|]+$`   
Required: Yes

 ** [Primary](#API_CreateDataTableAttribute_RequestSyntax) **   <a name="connect-CreateDataTableAttribute-request-Primary"></a>
Optional boolean that defaults to false. Determines if the value is used to identify a record in the table. Values for primary attributes must not be expressions.  
Type: Boolean  
Required: No

 ** [Validation](#API_CreateDataTableAttribute_RequestSyntax) **   <a name="connect-CreateDataTableAttribute-request-Validation"></a>
Optional validation rules for the attribute. Borrows heavily from JSON Schema - Draft 2020-12. The maximum length of arrays within validations and depth of validations is 5. There are default limits that apply to all types. Customer specified limits in excess of the default limits are not permitted.  
Type: [Validation](API_Validation.md) object  
Required: No

 ** [ValueType](#API_CreateDataTableAttribute_RequestSyntax) **   <a name="connect-CreateDataTableAttribute-request-ValueType"></a>
The type of value allowed or the resultant type after the value's expression is evaluated. Must be one of TEXT, TEXT\$1LIST, NUMBER, NUMBER\$1LIST, and BOOLEAN.  
Type: String  
Valid Values: `TEXT | NUMBER | BOOLEAN | TEXT_LIST | NUMBER_LIST`   
Required: Yes

## Response Syntax
<a name="API_CreateDataTableAttribute_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AttributeId": "string",
   "LockVersion": { 
      "Attribute": "string",
      "DataTable": "string",
      "PrimaryValues": "string",
      "Value": "string"
   },
   "Name": "string"
}
```

## Response Elements
<a name="API_CreateDataTableAttribute_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AttributeId](#API_CreateDataTableAttribute_ResponseSyntax) **   <a name="connect-CreateDataTableAttribute-response-AttributeId"></a>
The unique identifier assigned to the created attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [LockVersion](#API_CreateDataTableAttribute_ResponseSyntax) **   <a name="connect-CreateDataTableAttribute-response-LockVersion"></a>
The lock version information for the data table and attribute, used for optimistic locking and versioning.  
Type: [DataTableLockVersion](API_DataTableLockVersion.md) object

 ** [Name](#API_CreateDataTableAttribute_ResponseSyntax) **   <a name="connect-CreateDataTableAttribute-response-Name"></a>
The name of the created attribute since it also serves as the identifier. This could be different than the parameter passed in since it will be trimmed for whitespace.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `^[\p{L}\p{Z}\p{N}\-_.:=@'|]+$` 

## Errors
<a name="API_CreateDataTableAttribute_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
Operation cannot be performed at this time as there is a conflict with another operation or contact state.  
HTTP Status Code: 409

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateDataTableAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateDataTableAttribute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateDataTableAttribute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateDataTableAttribute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateDataTableAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateDataTableAttribute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateDataTableAttribute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateDataTableAttribute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateDataTableAttribute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateDataTableAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateDataTableAttribute) 

# CreateEmailAddress
<a name="API_CreateEmailAddress"></a>

Create new email address in the specified Amazon Connect instance. For more information about email addresses, see [Create email addresses](https://docs.aws.amazon.com/connect/latest/adminguide/create-email-address1.html) in the Amazon Connect Administrator Guide.

## Request Syntax
<a name="API_CreateEmailAddress_RequestSyntax"></a>

```
PUT /email-addresses/InstanceId HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "Description": "string",
   "DisplayName": "string",
   "EmailAddress": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateEmailAddress_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateEmailAddress_RequestSyntax) **   <a name="connect-CreateEmailAddress-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateEmailAddress_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateEmailAddress_RequestSyntax) **   <a name="connect-CreateEmailAddress-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [Description](#API_CreateEmailAddress_RequestSyntax) **   <a name="connect-CreateEmailAddress-request-Description"></a>
The description of the email address.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.  
Required: No

 ** [DisplayName](#API_CreateEmailAddress_RequestSyntax) **   <a name="connect-CreateEmailAddress-request-DisplayName"></a>
The display name of email address  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

 ** [EmailAddress](#API_CreateEmailAddress_RequestSyntax) **   <a name="connect-CreateEmailAddress-request-EmailAddress"></a>
The email address, including the domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[^\s@]+@[^\s@]+\.[^\s@]+`   
Required: Yes

 ** [Tags](#API_CreateEmailAddress_RequestSyntax) **   <a name="connect-CreateEmailAddress-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateEmailAddress_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EmailAddressArn": "string",
   "EmailAddressId": "string"
}
```

## Response Elements
<a name="API_CreateEmailAddress_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EmailAddressArn](#API_CreateEmailAddress_ResponseSyntax) **   <a name="connect-CreateEmailAddress-response-EmailAddressArn"></a>
The Amazon Resource Name (ARN) of the email address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [EmailAddressId](#API_CreateEmailAddress_ResponseSyntax) **   <a name="connect-CreateEmailAddress-response-EmailAddressId"></a>
The identifier of the email address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_CreateEmailAddress_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** IdempotencyException **   
An entity with the same name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateEmailAddress_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateEmailAddress) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateEmailAddress) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateEmailAddress) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateEmailAddress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateEmailAddress) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateEmailAddress) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateEmailAddress) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateEmailAddress) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateEmailAddress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateEmailAddress) 

# CreateEvaluationForm
<a name="API_CreateEvaluationForm"></a>

Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form.

## Request Syntax
<a name="API_CreateEvaluationForm_RequestSyntax"></a>

```
PUT /evaluation-forms/InstanceId HTTP/1.1
Content-type: application/json

{
   "AsDraft": boolean,
   "AutoEvaluationConfiguration": { 
      "Enabled": boolean
   },
   "ClientToken": "string",
   "Description": "string",
   "Items": [ 
      { ... }
   ],
   "LanguageConfiguration": { 
      "FormLanguage": "string"
   },
   "ReviewConfiguration": { 
      "EligibilityDays": number,
      "ReviewNotificationRecipients": [ 
         { 
            "Type": "string",
            "Value": { 
               "UserId": "string"
            }
         }
      ]
   },
   "ScoringStrategy": { 
      "Mode": "string",
      "Status": "string"
   },
   "Tags": { 
      "string" : "string" 
   },
   "TargetConfiguration": { 
      "ContactInteractionType": "string"
   },
   "Title": "string"
}
```

## URI Request Parameters
<a name="API_CreateEvaluationForm_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateEvaluationForm_RequestSyntax) **   <a name="connect-CreateEvaluationForm-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateEvaluationForm_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AsDraft](#API_CreateEvaluationForm_RequestSyntax) **   <a name="connect-CreateEvaluationForm-request-AsDraft"></a>
A boolean flag indicating whether to create evaluation form in draft state.  
Type: Boolean  
Required: No

 ** [AutoEvaluationConfiguration](#API_CreateEvaluationForm_RequestSyntax) **   <a name="connect-CreateEvaluationForm-request-AutoEvaluationConfiguration"></a>
Configuration information about automated evaluations.  
Type: [EvaluationFormAutoEvaluationConfiguration](API_EvaluationFormAutoEvaluationConfiguration.md) object  
Required: No

 ** [ClientToken](#API_CreateEvaluationForm_RequestSyntax) **   <a name="connect-CreateEvaluationForm-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [Description](#API_CreateEvaluationForm_RequestSyntax) **   <a name="connect-CreateEvaluationForm-request-Description"></a>
The description of the evaluation form.  
Type: String  
Required: No

 ** [Items](#API_CreateEvaluationForm_RequestSyntax) **   <a name="connect-CreateEvaluationForm-request-Items"></a>
Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.  
Type: Array of [EvaluationFormItem](API_EvaluationFormItem.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Required: Yes

 ** [LanguageConfiguration](#API_CreateEvaluationForm_RequestSyntax) **   <a name="connect-CreateEvaluationForm-request-LanguageConfiguration"></a>
Configuration for language settings of the evaluation form.  
Type: [EvaluationFormLanguageConfiguration](API_EvaluationFormLanguageConfiguration.md) object  
Required: No

 ** [ReviewConfiguration](#API_CreateEvaluationForm_RequestSyntax) **   <a name="connect-CreateEvaluationForm-request-ReviewConfiguration"></a>
Configuration information about evaluation reviews.  
Type: [EvaluationReviewConfiguration](API_EvaluationReviewConfiguration.md) object  
Required: No

 ** [ScoringStrategy](#API_CreateEvaluationForm_RequestSyntax) **   <a name="connect-CreateEvaluationForm-request-ScoringStrategy"></a>
A scoring strategy of the evaluation form.  
Type: [EvaluationFormScoringStrategy](API_EvaluationFormScoringStrategy.md) object  
Required: No

 ** [Tags](#API_CreateEvaluationForm_RequestSyntax) **   <a name="connect-CreateEvaluationForm-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

 ** [TargetConfiguration](#API_CreateEvaluationForm_RequestSyntax) **   <a name="connect-CreateEvaluationForm-request-TargetConfiguration"></a>
Configuration that specifies the target for the evaluation form.  
Type: [EvaluationFormTargetConfiguration](API_EvaluationFormTargetConfiguration.md) object  
Required: No

 ** [Title](#API_CreateEvaluationForm_RequestSyntax) **   <a name="connect-CreateEvaluationForm-request-Title"></a>
A title of the evaluation form.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Syntax
<a name="API_CreateEvaluationForm_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EvaluationFormArn": "string",
   "EvaluationFormId": "string"
}
```

## Response Elements
<a name="API_CreateEvaluationForm_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EvaluationFormArn](#API_CreateEvaluationForm_ResponseSyntax) **   <a name="connect-CreateEvaluationForm-response-EvaluationFormArn"></a>
The Amazon Resource Name (ARN) for the evaluation form resource.  
Type: String

 ** [EvaluationFormId](#API_CreateEvaluationForm_ResponseSyntax) **   <a name="connect-CreateEvaluationForm-response-EvaluationFormId"></a>
The unique identifier for the evaluation form.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_CreateEvaluationForm_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_CreateEvaluationForm_Examples"></a>

### Example
<a name="API_CreateEvaluationForm_Example_1"></a>

The following example creates an evaluation form with two sections and two questions for each section.

#### Sample Request
<a name="API_CreateEvaluationForm_Example_1_Request"></a>

```
{
   "InstanceId": "[instance_id]",
   "Title": "form-title",
   "Description": "form-description",
   "ScoringStrategy": {
        "Mode": "SECTION_ONLY",
        "Status": "ENABLED"
   },
   "Items": [
   {
        "Section": {
            "Title": "section-title-1",
            "RefId": "section-1",
            "Instructions": "section-instruction-1",
            "Weight": 50,
            "Items": [
                {
                    "Question": {
                        "Title": "question-title-1-1",
                        "RefId": "question-1-1",
                        "Instructions": "question-instructions",
                        "NotApplicableEnabled": false,
                        "QuestionType": "TEXT"
                    }
                },
                {
                    "Question": {
                        "Title": "question-title-1-2",
                        "RefId": "question-1-2",
                        "QuestionType": "SINGLESELECT",
                        "NotApplicableEnabled": false,
                        "QuestionTypeProperties": {
                            "SingleSelect": {
                                "Options": [
                                    {
                                        "RefId": "option-1-2-1",
                                        "Text": "first-option",
                                        "Score": 1,
                                        "AutomaticFail": true
                                    },
                                    {
                                        "RefId": "option-1-2-2",
                                        "Text": "second-option",
                                        "Score": 1,
                                        "AutomaticFail": false
                                    },
                                    {
                                        "RefId": "option-1-2-3",
                                        "Text": "third-option",
                                        "Score": 1,
                                        "AutomaticFail": true
                                    }
                                ],
                                "DisplayAs": "DROPDOWN",
                                "Automation": {
                                    "Options": [
                                        {
                                            "RuleCategory": {
                                                "Category": "CATEGORY_LABEL",
                                                "Condition": "PRESENT",
                                                "OptionRefId": "option-1-2-2"
                                            }
                                        }
                                    ],
                                    "DefaultOptionRefId": "option-1-2-1"
                                }
                            }
                        }
                    }
                }
            ]
        }
    },
    {
        "Section": {
            "Title": "section-title-2",
            "RefId": "section-2",
            "Instructions": "section-instruction-2",
            "Weight":50,
            "Items": [
                {
                    "Question": {
                        "Title": "question-title-2-1",
                        "RefId": "question-2-1",
                        "QuestionType": "TEXT",
                        "NotApplicableEnabled": true
                    }
                },
                {
                    "Question": {
                        "Title": "question-title-2-2",
                        "RefId": "question-2-2",
                        "QuestionType": "NUMERIC",
                        "QuestionTypeProperties": {
                            "Numeric": {
                                "MinValue": 0,
                                "MaxValue": 28800,
                                "Options": [
                                    {
                                        "MinValue": 0,
                                        "MaxValue": 28800,
                                        "Score": 1,
                                        "AutomaticFail": false
                                    }
                                ],
                                "Automation": {
                                    "PropertyValue": {
                                        "Label": "AGENT_INTERACTION_DURATION"
                                    }
                                }
                            }
                        }
                    }
                }
            ]
        }
    }
    ]
}
```

#### Sample Response
<a name="API_CreateEvaluationForm_Example_1_Response"></a>

```
{
    "EvaluationFormId": "[evaluation_form_id]",
    "EvaluationFormArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/evaluation-form/[evaluation_form_id]"
}
```

## See Also
<a name="API_CreateEvaluationForm_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateEvaluationForm) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateEvaluationForm) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateEvaluationForm) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateEvaluationForm) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateEvaluationForm) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateEvaluationForm) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateEvaluationForm) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateEvaluationForm) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateEvaluationForm) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateEvaluationForm) 

# CreateHoursOfOperation
<a name="API_CreateHoursOfOperation"></a>

Creates hours of operation. 

## Request Syntax
<a name="API_CreateHoursOfOperation_RequestSyntax"></a>

```
PUT /hours-of-operations/InstanceId HTTP/1.1
Content-type: application/json

{
   "Config": [ 
      { 
         "Day": "string",
         "EndTime": { 
            "Hours": number,
            "Minutes": number
         },
         "StartTime": { 
            "Hours": number,
            "Minutes": number
         }
      }
   ],
   "Description": "string",
   "Name": "string",
   "ParentHoursOfOperationConfigs": [ 
      { 
         "HoursOfOperationId": "string"
      }
   ],
   "Tags": { 
      "string" : "string" 
   },
   "TimeZone": "string"
}
```

## URI Request Parameters
<a name="API_CreateHoursOfOperation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateHoursOfOperation_RequestSyntax) **   <a name="connect-CreateHoursOfOperation-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateHoursOfOperation_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Config](#API_CreateHoursOfOperation_RequestSyntax) **   <a name="connect-CreateHoursOfOperation-request-Config"></a>
Configuration information for the hours of operation: day, start time, and end time.  
Type: Array of [HoursOfOperationConfig](API_HoursOfOperationConfig.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Required: Yes

 ** [Description](#API_CreateHoursOfOperation_RequestSyntax) **   <a name="connect-CreateHoursOfOperation-request-Description"></a>
The description of the hours of operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Required: No

 ** [Name](#API_CreateHoursOfOperation_RequestSyntax) **   <a name="connect-CreateHoursOfOperation-request-Name"></a>
The name of the hours of operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Required: Yes

 ** [ParentHoursOfOperationConfigs](#API_CreateHoursOfOperation_RequestSyntax) **   <a name="connect-CreateHoursOfOperation-request-ParentHoursOfOperationConfigs"></a>
Configuration for parent hours of operations. Eg: ResourceArn.   
For more information about parent hours of operations, see [Link overrides from different hours of operation](https://docs.aws.amazon.com/https:/docs.aws.amazon.com/connect/latest/adminguide/hours-of-operation-overrides.html) in the * Administrator Guide*.  
Type: Array of [ParentHoursOfOperationConfig](API_ParentHoursOfOperationConfig.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 3 items.  
Required: No

 ** [Tags](#API_CreateHoursOfOperation_RequestSyntax) **   <a name="connect-CreateHoursOfOperation-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

 ** [TimeZone](#API_CreateHoursOfOperation_RequestSyntax) **   <a name="connect-CreateHoursOfOperation-request-TimeZone"></a>
The time zone of the hours of operation.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_CreateHoursOfOperation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "HoursOfOperationArn": "string",
   "HoursOfOperationId": "string"
}
```

## Response Elements
<a name="API_CreateHoursOfOperation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [HoursOfOperationArn](#API_CreateHoursOfOperation_ResponseSyntax) **   <a name="connect-CreateHoursOfOperation-response-HoursOfOperationArn"></a>
The Amazon Resource Name (ARN) for the hours of operation.  
Type: String

 ** [HoursOfOperationId](#API_CreateHoursOfOperation_ResponseSyntax) **   <a name="connect-CreateHoursOfOperation-response-HoursOfOperationId"></a>
The identifier for the hours of operation.  
Type: String

## Errors
<a name="API_CreateHoursOfOperation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateHoursOfOperation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateHoursOfOperation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateHoursOfOperation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateHoursOfOperation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateHoursOfOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateHoursOfOperation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateHoursOfOperation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateHoursOfOperation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateHoursOfOperation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateHoursOfOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateHoursOfOperation) 

# CreateHoursOfOperationOverride
<a name="API_CreateHoursOfOperationOverride"></a>

Creates an hours of operation override in an Amazon Connect hours of operation resource.

## Request Syntax
<a name="API_CreateHoursOfOperationOverride_RequestSyntax"></a>

```
PUT /hours-of-operations/InstanceId/HoursOfOperationId/overrides HTTP/1.1
Content-type: application/json

{
   "Config": [ 
      { 
         "Day": "string",
         "EndTime": { 
            "Hours": number,
            "Minutes": number
         },
         "StartTime": { 
            "Hours": number,
            "Minutes": number
         }
      }
   ],
   "Description": "string",
   "EffectiveFrom": "string",
   "EffectiveTill": "string",
   "Name": "string",
   "OverrideType": "string",
   "RecurrenceConfig": { 
      "RecurrencePattern": { 
         "ByMonth": [ number ],
         "ByMonthDay": [ number ],
         "ByWeekdayOccurrence": [ number ],
         "Frequency": "string",
         "Interval": number
      }
   }
}
```

## URI Request Parameters
<a name="API_CreateHoursOfOperationOverride_RequestParameters"></a>

The request uses the following URI parameters.

 ** [HoursOfOperationId](#API_CreateHoursOfOperationOverride_RequestSyntax) **   <a name="connect-CreateHoursOfOperationOverride-request-uri-HoursOfOperationId"></a>
The identifier for the hours of operation  
Required: Yes

 ** [InstanceId](#API_CreateHoursOfOperationOverride_RequestSyntax) **   <a name="connect-CreateHoursOfOperationOverride-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateHoursOfOperationOverride_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Config](#API_CreateHoursOfOperationOverride_RequestSyntax) **   <a name="connect-CreateHoursOfOperationOverride-request-Config"></a>
Configuration information for the hours of operation override: day, start time, and end time.  
Type: Array of [HoursOfOperationOverrideConfig](API_HoursOfOperationOverrideConfig.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Required: Yes

 ** [Description](#API_CreateHoursOfOperationOverride_RequestSyntax) **   <a name="connect-CreateHoursOfOperationOverride-request-Description"></a>
The description of the hours of operation override.  
Type: String  
Pattern: `^[\P{C}\r\n\t]{1,250}$`   
Required: No

 ** [EffectiveFrom](#API_CreateHoursOfOperationOverride_RequestSyntax) **   <a name="connect-CreateHoursOfOperationOverride-request-EffectiveFrom"></a>
The date from when the hours of operation override is effective.  
Type: String  
Pattern: `^\d{4}-\d{2}-\d{2}$`   
Required: Yes

 ** [EffectiveTill](#API_CreateHoursOfOperationOverride_RequestSyntax) **   <a name="connect-CreateHoursOfOperationOverride-request-EffectiveTill"></a>
The date until when the hours of operation override is effective.  
Type: String  
Pattern: `^\d{4}-\d{2}-\d{2}$`   
Required: Yes

 ** [Name](#API_CreateHoursOfOperationOverride_RequestSyntax) **   <a name="connect-CreateHoursOfOperationOverride-request-Name"></a>
The name of the hours of operation override.  
Type: String  
Pattern: `^[\P{C}\r\n\t]{1,127}$`   
Required: Yes

 ** [OverrideType](#API_CreateHoursOfOperationOverride_RequestSyntax) **   <a name="connect-CreateHoursOfOperationOverride-request-OverrideType"></a>
Whether the override will be defined as a *standard* or as a *recurring event*.  
For more information about how override types are applied, see [Build your list of overrides](https://docs.aws.amazon.com/https:/docs.aws.amazon.com/connect/latest/adminguide/hours-of-operation-overrides.html) in the * Administrator Guide*.  
Type: String  
Valid Values: `STANDARD | OPEN | CLOSED`   
Required: No

 ** [RecurrenceConfig](#API_CreateHoursOfOperationOverride_RequestSyntax) **   <a name="connect-CreateHoursOfOperationOverride-request-RecurrenceConfig"></a>
Configuration for a recurring event.  
Type: [RecurrenceConfig](API_RecurrenceConfig.md) object  
Required: No

## Response Syntax
<a name="API_CreateHoursOfOperationOverride_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "HoursOfOperationOverrideId": "string"
}
```

## Response Elements
<a name="API_CreateHoursOfOperationOverride_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [HoursOfOperationOverrideId](#API_CreateHoursOfOperationOverride_ResponseSyntax) **   <a name="connect-CreateHoursOfOperationOverride-response-HoursOfOperationOverrideId"></a>
The identifier for the hours of operation override.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.

## Errors
<a name="API_CreateHoursOfOperationOverride_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateHoursOfOperationOverride_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateHoursOfOperationOverride) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateHoursOfOperationOverride) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateHoursOfOperationOverride) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateHoursOfOperationOverride) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateHoursOfOperationOverride) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateHoursOfOperationOverride) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateHoursOfOperationOverride) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateHoursOfOperationOverride) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateHoursOfOperationOverride) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateHoursOfOperationOverride) 

# CreateInstance
<a name="API_CreateInstance"></a>

This API is in preview release for Amazon Connect and is subject to change.

Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect. 

For more information, see [Create an Amazon Connect instance](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-instances.html) in the *Amazon Connect Administrator Guide*.

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. 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. You must wait 30 days before you can restart creating and deleting instances in your account.

## Request Syntax
<a name="API_CreateInstance_RequestSyntax"></a>

```
PUT /instance HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "DirectoryId": "string",
   "IdentityManagementType": "string",
   "InboundCallsEnabled": boolean,
   "InstanceAlias": "string",
   "OutboundCallsEnabled": boolean,
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateInstance_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateInstance_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateInstance_RequestSyntax) **   <a name="connect-CreateInstance-request-ClientToken"></a>
The idempotency token.  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [DirectoryId](#API_CreateInstance_RequestSyntax) **   <a name="connect-CreateInstance-request-DirectoryId"></a>
The identifier for the directory.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `^d-[0-9a-f]{10}$`   
Required: No

 ** [IdentityManagementType](#API_CreateInstance_RequestSyntax) **   <a name="connect-CreateInstance-request-IdentityManagementType"></a>
The type of identity management for your Amazon Connect users.  
Type: String  
Valid Values: `SAML | CONNECT_MANAGED | EXISTING_DIRECTORY`   
Required: Yes

 ** [InboundCallsEnabled](#API_CreateInstance_RequestSyntax) **   <a name="connect-CreateInstance-request-InboundCallsEnabled"></a>
Your contact center handles incoming contacts.  
Type: Boolean  
Required: Yes

 ** [InstanceAlias](#API_CreateInstance_RequestSyntax) **   <a name="connect-CreateInstance-request-InstanceAlias"></a>
The name for your instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 45.  
Pattern: `^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*$`   
Required: No

 ** [OutboundCallsEnabled](#API_CreateInstance_RequestSyntax) **   <a name="connect-CreateInstance-request-OutboundCallsEnabled"></a>
Your contact center allows outbound calls.  
Type: Boolean  
Required: Yes

 ** [Tags](#API_CreateInstance_RequestSyntax) **   <a name="connect-CreateInstance-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, `{ "tags": {"key1":"value1", "key2":"value2"} }`.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateInstance_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Id": "string"
}
```

## Response Elements
<a name="API_CreateInstance_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_CreateInstance_ResponseSyntax) **   <a name="connect-CreateInstance-response-Arn"></a>
The Amazon Resource Name (ARN) of the instance.  
Type: String

 ** [Id](#API_CreateInstance_ResponseSyntax) **   <a name="connect-CreateInstance-response-Id"></a>
The identifier for the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

## Errors
<a name="API_CreateInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateInstance) 

# CreateIntegrationAssociation
<a name="API_CreateIntegrationAssociation"></a>

Creates an AWS resource association with an Amazon Connect instance.

## Request Syntax
<a name="API_CreateIntegrationAssociation_RequestSyntax"></a>

```
PUT /instance/InstanceId/integration-associations HTTP/1.1
Content-type: application/json

{
   "IntegrationArn": "string",
   "IntegrationType": "string",
   "SourceApplicationName": "string",
   "SourceApplicationUrl": "string",
   "SourceType": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateIntegrationAssociation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateIntegrationAssociation_RequestSyntax) **   <a name="connect-CreateIntegrationAssociation-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateIntegrationAssociation_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [IntegrationArn](#API_CreateIntegrationAssociation_RequestSyntax) **   <a name="connect-CreateIntegrationAssociation-request-IntegrationArn"></a>
The Amazon Resource Name (ARN) of the integration.  
When integrating with AWS End User Messaging, the Amazon Connect and AWS End User Messaging instances must be in the same account.
Type: String  
Required: Yes

 ** [IntegrationType](#API_CreateIntegrationAssociation_RequestSyntax) **   <a name="connect-CreateIntegrationAssociation-request-IntegrationType"></a>
The type of information to be ingested.  
Type: String  
Valid Values: `EVENT | VOICE_ID | PINPOINT_APP | WISDOM_ASSISTANT | WISDOM_KNOWLEDGE_BASE | WISDOM_QUICK_RESPONSES | Q_MESSAGE_TEMPLATES | CASES_DOMAIN | APPLICATION | FILE_SCANNER | SES_IDENTITY | ANALYTICS_CONNECTOR | CALL_TRANSFER_CONNECTOR | COGNITO_USER_POOL | MESSAGE_PROCESSOR`   
Required: Yes

 ** [SourceApplicationName](#API_CreateIntegrationAssociation_RequestSyntax) **   <a name="connect-CreateIntegrationAssociation-request-SourceApplicationName"></a>
The name of the external application. This field is only required for the EVENT integration type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9_ -]+$`   
Required: No

 ** [SourceApplicationUrl](#API_CreateIntegrationAssociation_RequestSyntax) **   <a name="connect-CreateIntegrationAssociation-request-SourceApplicationUrl"></a>
The URL for the external application. This field is only required for the EVENT integration type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Required: No

 ** [SourceType](#API_CreateIntegrationAssociation_RequestSyntax) **   <a name="connect-CreateIntegrationAssociation-request-SourceType"></a>
The type of the data source. This field is only required for the EVENT integration type.  
Type: String  
Valid Values: `SALESFORCE | ZENDESK | CASES`   
Required: No

 ** [Tags](#API_CreateIntegrationAssociation_RequestSyntax) **   <a name="connect-CreateIntegrationAssociation-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateIntegrationAssociation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "IntegrationAssociationArn": "string",
   "IntegrationAssociationId": "string"
}
```

## Response Elements
<a name="API_CreateIntegrationAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [IntegrationAssociationArn](#API_CreateIntegrationAssociation_ResponseSyntax) **   <a name="connect-CreateIntegrationAssociation-response-IntegrationAssociationArn"></a>
The Amazon Resource Name (ARN) for the association.  
Type: String

 ** [IntegrationAssociationId](#API_CreateIntegrationAssociation_ResponseSyntax) **   <a name="connect-CreateIntegrationAssociation-response-IntegrationAssociationId"></a>
The identifier for the integration association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.

## Errors
<a name="API_CreateIntegrationAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateIntegrationAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateIntegrationAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateIntegrationAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateIntegrationAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateIntegrationAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateIntegrationAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateIntegrationAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateIntegrationAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateIntegrationAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateIntegrationAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateIntegrationAssociation) 

# CreateNotification
<a name="API_CreateNotification"></a>

Creates a new notification to be delivered to specified recipients. Notifications can include localized content with links, and an optional expiration time. Recipients can be specified as individual user ARNs or instance ARNs to target all users in an instance.

## Request Syntax
<a name="API_CreateNotification_RequestSyntax"></a>

```
PUT /notifications/InstanceId HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "Content": { 
      "string" : "string" 
   },
   "ExpiresAt": number,
   "PredefinedNotificationId": "string",
   "Priority": "string",
   "Recipients": [ "string" ],
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateNotification_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateNotification_RequestSyntax) **   <a name="connect-CreateNotification-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateNotification_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateNotification_RequestSyntax) **   <a name="connect-CreateNotification-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [Content](#API_CreateNotification_RequestSyntax) **   <a name="connect-CreateNotification-request-Content"></a>
The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale. Content supports links. Maximum 250 characters per locale.  
Type: String to string map  
Valid Keys: `en_US | de_DE | es_ES | fr_FR | id_ID | it_IT | ja_JP | ko_KR | pt_BR | zh_CN | zh_TW`   
Value Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: Yes

 ** [ExpiresAt](#API_CreateNotification_RequestSyntax) **   <a name="connect-CreateNotification-request-ExpiresAt"></a>
The timestamp when the notification should expire and no longer be displayed to users. If not specified, defaults to one week from creation.  
Type: Timestamp  
Required: No

 ** [PredefinedNotificationId](#API_CreateNotification_RequestSyntax) **   <a name="connect-CreateNotification-request-PredefinedNotificationId"></a>
 *This parameter has been deprecated.*   
The unique identifier for a notification.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [Priority](#API_CreateNotification_RequestSyntax) **   <a name="connect-CreateNotification-request-Priority"></a>
The priority level of the notification. Valid values are HIGH and LOW. High priority notifications are displayed above low priority notifications.  
Type: String  
Valid Values: `HIGH | LOW`   
Required: No

 ** [Recipients](#API_CreateNotification_RequestSyntax) **   <a name="connect-CreateNotification-request-Recipients"></a>
A list of Amazon Resource Names (ARNs) identifying the recipients of the notification. Can include user ARNs or instance ARNs to target all users in an instance. Maximum of 200 recipients.  
Type: Array of strings  
Array Members: Maximum number of 200 items.  
Required: Yes

 ** [Tags](#API_CreateNotification_RequestSyntax) **   <a name="connect-CreateNotification-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, `{ "Tags": {"key1":"value1", "key2":"value2"} }`.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateNotification_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NotificationArn": "string",
   "NotificationId": "string"
}
```

## Response Elements
<a name="API_CreateNotification_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NotificationArn](#API_CreateNotification_ResponseSyntax) **   <a name="connect-CreateNotification-response-NotificationArn"></a>
The Amazon Resource Name (ARN) of the created notification.  
Type: String

 ** [NotificationId](#API_CreateNotification_ResponseSyntax) **   <a name="connect-CreateNotification-response-NotificationId"></a>
The unique identifier assigned to the created notification.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_CreateNotification_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateNotification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateNotification) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateNotification) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateNotification) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateNotification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateNotification) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateNotification) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateNotification) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateNotification) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateNotification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateNotification) 

# CreateParticipant
<a name="API_CreateParticipant"></a>

Adds a new participant into an on-going chat contact or webRTC call. For more information, see [Customize chat flow experiences by integrating custom participants](https://docs.aws.amazon.com/connect/latest/adminguide/chat-customize-flow.html) or [Enable multi-user web, in-app, and video calling](https://docs.aws.amazon.com/connect/latest/adminguide/enable-multiuser-inapp.html).

## Request Syntax
<a name="API_CreateParticipant_RequestSyntax"></a>

```
POST /contact/create-participant HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "ContactId": "string",
   "InstanceId": "string",
   "ParticipantDetails": { 
      "DisplayName": "string",
      "ParticipantCapabilities": { 
         "ScreenShare": "string",
         "Video": "string"
      },
      "ParticipantRole": "string"
   }
}
```

## URI Request Parameters
<a name="API_CreateParticipant_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateParticipant_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateParticipant_RequestSyntax) **   <a name="connect-CreateParticipant-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [ContactId](#API_CreateParticipant_RequestSyntax) **   <a name="connect-CreateParticipant-request-ContactId"></a>
The identifier of the contact in this instance of Amazon Connect. Supports contacts in the CHAT channel and VOICE (WebRTC) channels. For WebRTC calls, this should be the initial contact ID that was generated when the contact was first created (from the StartWebRTCContact API) in the VOICE channel  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_CreateParticipant_RequestSyntax) **   <a name="connect-CreateParticipant-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [ParticipantDetails](#API_CreateParticipant_RequestSyntax) **   <a name="connect-CreateParticipant-request-ParticipantDetails"></a>
Information identifying the participant.  
The only valid value for `ParticipantRole` is `CUSTOM_BOT` for chat contact and `CUSTOMER` for voice contact.
Type: [ParticipantDetailsToAdd](API_ParticipantDetailsToAdd.md) object  
Required: Yes

## Response Syntax
<a name="API_CreateParticipant_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ParticipantCredentials": { 
      "Expiry": "string",
      "ParticipantToken": "string"
   },
   "ParticipantId": "string"
}
```

## Response Elements
<a name="API_CreateParticipant_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ParticipantCredentials](#API_CreateParticipant_ResponseSyntax) **   <a name="connect-CreateParticipant-response-ParticipantCredentials"></a>
The token used by the chat participant to call `CreateParticipantConnection`. The participant token is valid for the lifetime of a chat participant.  
Type: [ParticipantTokenCredentials](API_ParticipantTokenCredentials.md) object

 ** [ParticipantId](#API_CreateParticipant_ResponseSyntax) **   <a name="connect-CreateParticipant-response-ParticipantId"></a>
The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_CreateParticipant_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** ConflictException **   
Operation cannot be performed at this time as there is a conflict with another operation or contact state.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateParticipant_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateParticipant) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateParticipant) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateParticipant) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateParticipant) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateParticipant) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateParticipant) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateParticipant) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateParticipant) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateParticipant) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateParticipant) 

# CreatePersistentContactAssociation
<a name="API_CreatePersistentContactAssociation"></a>

Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see [Enable persistent chat](https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html) in the *Amazon Connect Administrator Guide*. 

## Request Syntax
<a name="API_CreatePersistentContactAssociation_RequestSyntax"></a>

```
POST /contact/persistent-contact-association/InstanceId/InitialContactId HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "RehydrationType": "string",
   "SourceContactId": "string"
}
```

## URI Request Parameters
<a name="API_CreatePersistentContactAssociation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InitialContactId](#API_CreatePersistentContactAssociation_RequestSyntax) **   <a name="connect-CreatePersistentContactAssociation-request-uri-InitialContactId"></a>
This is the contactId of the current contact that the `CreatePersistentContactAssociation` API is being called from.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_CreatePersistentContactAssociation_RequestSyntax) **   <a name="connect-CreatePersistentContactAssociation-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreatePersistentContactAssociation_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreatePersistentContactAssociation_RequestSyntax) **   <a name="connect-CreatePersistentContactAssociation-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [RehydrationType](#API_CreatePersistentContactAssociation_RequestSyntax) **   <a name="connect-CreatePersistentContactAssociation-request-RehydrationType"></a>
The contactId chosen for rehydration depends on the type chosen.  
+  `ENTIRE_PAST_SESSION`: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the `initialContactId` of the past ended chat session in the `sourceContactId` field. In this type, Amazon Connect determines what the most recent chat contact on the past ended chat session and uses it to start a persistent chat. 
+  `FROM_SEGMENT`: Rehydrates a chat from the specified past chat contact provided in the `sourceContactId` field. 
The actual contactId used for rehydration is provided in the response of this API.  
To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID **C1**. Agent a1 then transfers the chat to Agent a2. This creates another contact ID **C2**. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID **C3**. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases:   
+  **Use Case 1**: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration:
  +  **Configuration** 
    + SourceContactId = "C2"
    + RehydrationType = "FROM\$1SEGMENT"
  +  **Expected behavior** 
    + This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session.
+  **Use Case 2**: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration:
  +  **Configuration** 
    + SourceContactId = "C1"
    + RehydrationType = "ENTIRE\$1PAST\$1SESSION"
  +  **Expected behavior** 
    + This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session.
Type: String  
Valid Values: `ENTIRE_PAST_SESSION | FROM_SEGMENT`   
Required: Yes

 ** [SourceContactId](#API_CreatePersistentContactAssociation_RequestSyntax) **   <a name="connect-CreatePersistentContactAssociation-request-SourceContactId"></a>
The contactId from which a persistent chat session must be started.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Response Syntax
<a name="API_CreatePersistentContactAssociation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContinuedFromContactId": "string"
}
```

## Response Elements
<a name="API_CreatePersistentContactAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContinuedFromContactId](#API_CreatePersistentContactAssociation_ResponseSyntax) **   <a name="connect-CreatePersistentContactAssociation-response-ContinuedFromContactId"></a>
The contactId from which a persistent chat session is started. This field is populated only for persistent chat.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_CreatePersistentContactAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreatePersistentContactAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreatePersistentContactAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreatePersistentContactAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreatePersistentContactAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreatePersistentContactAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreatePersistentContactAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreatePersistentContactAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreatePersistentContactAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreatePersistentContactAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreatePersistentContactAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreatePersistentContactAssociation) 

# CreatePredefinedAttribute
<a name="API_CreatePredefinedAttribute"></a>

Creates a new predefined attribute for the specified Amazon Connect instance. A *predefined attribute* is made up of a name and a value.

For the predefined attributes per instance quota, see [Amazon Connect quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas).

 **Use cases** 

Following are common uses cases for this API:
+ Create an attribute for routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see [Create predefined attributes for routing contacts to agents](https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html).
+ Create an attribute for business unit name that has a list of predefined business unit names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see [Use contact segment attributes](https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html).

 **Endpoints**: See [Amazon Connect endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/connect_region.html).

## Request Syntax
<a name="API_CreatePredefinedAttribute_RequestSyntax"></a>

```
PUT /predefined-attributes/InstanceId HTTP/1.1
Content-type: application/json

{
   "AttributeConfiguration": { 
      "EnableValueValidationOnAssociation": boolean
   },
   "Name": "string",
   "Purposes": [ "string" ],
   "Values": { ... }
}
```

## URI Request Parameters
<a name="API_CreatePredefinedAttribute_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreatePredefinedAttribute_RequestSyntax) **   <a name="connect-CreatePredefinedAttribute-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreatePredefinedAttribute_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AttributeConfiguration](#API_CreatePredefinedAttribute_RequestSyntax) **   <a name="connect-CreatePredefinedAttribute-request-AttributeConfiguration"></a>
Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.  
Type: [InputPredefinedAttributeConfiguration](API_InputPredefinedAttributeConfiguration.md) object  
Required: No

 ** [Name](#API_CreatePredefinedAttribute_RequestSyntax) **   <a name="connect-CreatePredefinedAttribute-request-Name"></a>
 The name of the predefined attribute.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [Purposes](#API_CreatePredefinedAttribute_RequestSyntax) **   <a name="connect-CreatePredefinedAttribute-request-Purposes"></a>
Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [Values](#API_CreatePredefinedAttribute_RequestSyntax) **   <a name="connect-CreatePredefinedAttribute-request-Values"></a>
 The values of the predefined attribute.   
Type: [PredefinedAttributeValues](API_PredefinedAttributeValues.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## Response Syntax
<a name="API_CreatePredefinedAttribute_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_CreatePredefinedAttribute_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_CreatePredefinedAttribute_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_CreatePredefinedAttribute_Examples"></a>

### Example
<a name="API_CreatePredefinedAttribute_Example_1"></a>

The following request and response example shows setting the proficiency on an attribute named Name1.

```
PUT https://connect.us-west-2.amazonaws.com/predefined-attributes/InstanceId HTTP/1.1
Content-type: application/json
{
    "Name": "Name1",
    "Values": {
        "StringList": [
            "value1"
        ]
    },
    "Purposes": [
        "proficiency"
    ],
    "Configuration": {
        "EnableValueValidationOnAssociation": true
    }
}

Response:
200
```

## See Also
<a name="API_CreatePredefinedAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreatePredefinedAttribute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreatePredefinedAttribute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreatePredefinedAttribute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreatePredefinedAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreatePredefinedAttribute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreatePredefinedAttribute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreatePredefinedAttribute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreatePredefinedAttribute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreatePredefinedAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreatePredefinedAttribute) 

# CreatePrompt
<a name="API_CreatePrompt"></a>

Creates a prompt. For more information about prompts, such as supported file types and maximum length, see [Create prompts](https://docs.aws.amazon.com/connect/latest/adminguide/prompts.html) in the *Amazon Connect Administrator Guide*.

## Request Syntax
<a name="API_CreatePrompt_RequestSyntax"></a>

```
PUT /prompts/InstanceId HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "S3Uri": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreatePrompt_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreatePrompt_RequestSyntax) **   <a name="connect-CreatePrompt-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreatePrompt_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_CreatePrompt_RequestSyntax) **   <a name="connect-CreatePrompt-request-Description"></a>
The description of the prompt.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Required: No

 ** [Name](#API_CreatePrompt_RequestSyntax) **   <a name="connect-CreatePrompt-request-Name"></a>
The name of the prompt.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Required: Yes

 ** [S3Uri](#API_CreatePrompt_RequestSyntax) **   <a name="connect-CreatePrompt-request-S3Uri"></a>
The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the [GetPromptFile](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetPromptFile.html) API instead of providing S3 URIs.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Pattern: `s3://\S+/.+|https://\\S+\\.s3\\.\\S+\\.amazonaws\\.com/\\S+`   
Required: Yes

 ** [Tags](#API_CreatePrompt_RequestSyntax) **   <a name="connect-CreatePrompt-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreatePrompt_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "PromptARN": "string",
   "PromptId": "string"
}
```

## Response Elements
<a name="API_CreatePrompt_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PromptARN](#API_CreatePrompt_ResponseSyntax) **   <a name="connect-CreatePrompt-response-PromptARN"></a>
The Amazon Resource Name (ARN) of the prompt.  
Type: String

 ** [PromptId](#API_CreatePrompt_ResponseSyntax) **   <a name="connect-CreatePrompt-response-PromptId"></a>
A unique identifier for the prompt.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_CreatePrompt_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreatePrompt_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreatePrompt) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreatePrompt) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreatePrompt) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreatePrompt) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreatePrompt) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreatePrompt) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreatePrompt) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreatePrompt) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreatePrompt) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreatePrompt) 

# CreatePushNotificationRegistration
<a name="API_CreatePushNotificationRegistration"></a>

Creates registration for a device token and a chat contact to receive real-time push notifications. For more information about push notifications, see [Set up push notifications in Amazon Connect for mobile chat](https://docs.aws.amazon.com/connect/latest/adminguide/enable-push-notifications-for-mobile-chat.html) in the *Amazon Connect Administrator Guide*.

## Request Syntax
<a name="API_CreatePushNotificationRegistration_RequestSyntax"></a>

```
PUT /push-notification/InstanceId/registrations HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "ContactConfiguration": { 
      "ContactId": "string",
      "IncludeRawMessage": boolean,
      "ParticipantRole": "string"
   },
   "DeviceToken": "string",
   "DeviceType": "string",
   "PinpointAppArn": "string"
}
```

## URI Request Parameters
<a name="API_CreatePushNotificationRegistration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreatePushNotificationRegistration_RequestSyntax) **   <a name="connect-CreatePushNotificationRegistration-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreatePushNotificationRegistration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreatePushNotificationRegistration_RequestSyntax) **   <a name="connect-CreatePushNotificationRegistration-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [ContactConfiguration](#API_CreatePushNotificationRegistration_RequestSyntax) **   <a name="connect-CreatePushNotificationRegistration-request-ContactConfiguration"></a>
The contact configuration for push notification registration.  
Type: [ContactConfiguration](API_ContactConfiguration.md) object  
Required: Yes

 ** [DeviceToken](#API_CreatePushNotificationRegistration_RequestSyntax) **   <a name="connect-CreatePushNotificationRegistration-request-DeviceToken"></a>
The push notification token issued by the Apple or Google gateways.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [DeviceType](#API_CreatePushNotificationRegistration_RequestSyntax) **   <a name="connect-CreatePushNotificationRegistration-request-DeviceType"></a>
The device type to use when sending the message.  
Type: String  
Valid Values: `GCM | APNS | APNS_SANDBOX`   
Required: Yes

 ** [PinpointAppArn](#API_CreatePushNotificationRegistration_RequestSyntax) **   <a name="connect-CreatePushNotificationRegistration-request-PinpointAppArn"></a>
The Amazon Resource Name (ARN) of the Pinpoint application.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_CreatePushNotificationRegistration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "RegistrationId": "string"
}
```

## Response Elements
<a name="API_CreatePushNotificationRegistration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [RegistrationId](#API_CreatePushNotificationRegistration_ResponseSyntax) **   <a name="connect-CreatePushNotificationRegistration-response-RegistrationId"></a>
The identifier for the registration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_CreatePushNotificationRegistration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreatePushNotificationRegistration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreatePushNotificationRegistration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreatePushNotificationRegistration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreatePushNotificationRegistration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreatePushNotificationRegistration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreatePushNotificationRegistration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreatePushNotificationRegistration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreatePushNotificationRegistration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreatePushNotificationRegistration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreatePushNotificationRegistration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreatePushNotificationRegistration) 

# CreateQueue
<a name="API_CreateQueue"></a>

Creates a new queue for the specified Amazon Connect instance.

**Important**  
If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for `OutboundCallerIdNumberId`. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another AWS Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a `ResourceNotFoundException`.
Only use the phone number ARN format that doesn't contain `instance` in the path, for example, `arn:aws:connect:us-east-1:1234567890:phone-number/uuid`. This is the same ARN format that is returned when you call the [ListPhoneNumbersV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html) API.
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see [Allow or Deny queue API actions for phone numbers in a replica Region](https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_resource-level-policy-examples.html#allow-deny-queue-actions-replica-region).

## Request Syntax
<a name="API_CreateQueue_RequestSyntax"></a>

```
PUT /queues/InstanceId HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "EmailAddressesConfig": [ 
      { 
         "EmailAddressId": "string"
      }
   ],
   "HoursOfOperationId": "string",
   "MaxContacts": number,
   "Name": "string",
   "OutboundCallerConfig": { 
      "OutboundCallerIdName": "string",
      "OutboundCallerIdNumberId": "string",
      "OutboundFlowId": "string"
   },
   "OutboundEmailConfig": { 
      "OutboundEmailAddressId": "string"
   },
   "QuickConnectIds": [ "string" ],
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateQueue_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateQueue_RequestSyntax) **   <a name="connect-CreateQueue-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateQueue_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_CreateQueue_RequestSyntax) **   <a name="connect-CreateQueue-request-Description"></a>
The description of the queue.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Required: No

 ** [EmailAddressesConfig](#API_CreateQueue_RequestSyntax) **   <a name="connect-CreateQueue-request-EmailAddressesConfig"></a>
Configuration list containing the email addresses to associate with the queue during creation. Each configuration specifies an email address ID that agents can select when handling email contacts in this queue.  
Type: Array of [EmailAddressConfig](API_EmailAddressConfig.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: No

 ** [HoursOfOperationId](#API_CreateQueue_RequestSyntax) **   <a name="connect-CreateQueue-request-HoursOfOperationId"></a>
The identifier for the hours of operation.  
Type: String  
Required: Yes

 ** [MaxContacts](#API_CreateQueue_RequestSyntax) **   <a name="connect-CreateQueue-request-MaxContacts"></a>
The maximum number of contacts that can be in the queue before it is considered full.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** [Name](#API_CreateQueue_RequestSyntax) **   <a name="connect-CreateQueue-request-Name"></a>
The name of the queue.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Required: Yes

 ** [OutboundCallerConfig](#API_CreateQueue_RequestSyntax) **   <a name="connect-CreateQueue-request-OutboundCallerConfig"></a>
The outbound caller ID name, number, and outbound whisper flow.  
Type: [OutboundCallerConfig](API_OutboundCallerConfig.md) object  
Required: No

 ** [OutboundEmailConfig](#API_CreateQueue_RequestSyntax) **   <a name="connect-CreateQueue-request-OutboundEmailConfig"></a>
The outbound email address ID for a specified queue.  
Type: [OutboundEmailConfig](API_OutboundEmailConfig.md) object  
Required: No

 ** [QuickConnectIds](#API_CreateQueue_RequestSyntax) **   <a name="connect-CreateQueue-request-QuickConnectIds"></a>
The quick connects available to agents who are working the queue.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: No

 ** [Tags](#API_CreateQueue_RequestSyntax) **   <a name="connect-CreateQueue-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateQueue_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "QueueArn": "string",
   "QueueId": "string"
}
```

## Response Elements
<a name="API_CreateQueue_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [QueueArn](#API_CreateQueue_ResponseSyntax) **   <a name="connect-CreateQueue-response-QueueArn"></a>
The Amazon Resource Name (ARN) of the queue.  
Type: String

 ** [QueueId](#API_CreateQueue_ResponseSyntax) **   <a name="connect-CreateQueue-response-QueueId"></a>
The identifier for the queue.  
Type: String

## Errors
<a name="API_CreateQueue_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateQueue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateQueue) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateQueue) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateQueue) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateQueue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateQueue) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateQueue) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateQueue) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateQueue) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateQueue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateQueue) 

# CreateQuickConnect
<a name="API_CreateQuickConnect"></a>

Creates a quick connect for the specified Amazon Connect instance.

## Request Syntax
<a name="API_CreateQuickConnect_RequestSyntax"></a>

```
PUT /quick-connects/InstanceId HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "QuickConnectConfig": { 
      "FlowConfig": { 
         "ContactFlowId": "string"
      },
      "PhoneConfig": { 
         "PhoneNumber": "string"
      },
      "QueueConfig": { 
         "ContactFlowId": "string",
         "QueueId": "string"
      },
      "QuickConnectType": "string",
      "UserConfig": { 
         "ContactFlowId": "string",
         "UserId": "string"
      }
   },
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateQuickConnect_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateQuickConnect_RequestSyntax) **   <a name="connect-CreateQuickConnect-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateQuickConnect_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_CreateQuickConnect_RequestSyntax) **   <a name="connect-CreateQuickConnect-request-Description"></a>
The description of the quick connect.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Required: No

 ** [Name](#API_CreateQuickConnect_RequestSyntax) **   <a name="connect-CreateQuickConnect-request-Name"></a>
A unique name of the quick connect.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Required: Yes

 ** [QuickConnectConfig](#API_CreateQuickConnect_RequestSyntax) **   <a name="connect-CreateQuickConnect-request-QuickConnectConfig"></a>
Configuration settings for the quick connect.  
Type: [QuickConnectConfig](API_QuickConnectConfig.md) object  
Required: Yes

 ** [Tags](#API_CreateQuickConnect_RequestSyntax) **   <a name="connect-CreateQuickConnect-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateQuickConnect_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "QuickConnectARN": "string",
   "QuickConnectId": "string"
}
```

## Response Elements
<a name="API_CreateQuickConnect_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [QuickConnectARN](#API_CreateQuickConnect_ResponseSyntax) **   <a name="connect-CreateQuickConnect-response-QuickConnectARN"></a>
The Amazon Resource Name (ARN) for the quick connect.   
Type: String

 ** [QuickConnectId](#API_CreateQuickConnect_ResponseSyntax) **   <a name="connect-CreateQuickConnect-response-QuickConnectId"></a>
The identifier for the quick connect.   
Type: String

## Errors
<a name="API_CreateQuickConnect_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateQuickConnect_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateQuickConnect) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateQuickConnect) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateQuickConnect) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateQuickConnect) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateQuickConnect) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateQuickConnect) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateQuickConnect) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateQuickConnect) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateQuickConnect) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateQuickConnect) 

# CreateRoutingProfile
<a name="API_CreateRoutingProfile"></a>

Creates a new routing profile.

## Request Syntax
<a name="API_CreateRoutingProfile_RequestSyntax"></a>

```
PUT /routing-profiles/InstanceId HTTP/1.1
Content-type: application/json

{
   "AgentAvailabilityTimer": "string",
   "DefaultOutboundQueueId": "string",
   "Description": "string",
   "ManualAssignmentQueueConfigs": [ 
      { 
         "QueueReference": { 
            "Channel": "string",
            "QueueId": "string"
         }
      }
   ],
   "MediaConcurrencies": [ 
      { 
         "Channel": "string",
         "Concurrency": number,
         "CrossChannelBehavior": { 
            "BehaviorType": "string"
         }
      }
   ],
   "Name": "string",
   "QueueConfigs": [ 
      { 
         "Delay": number,
         "Priority": number,
         "QueueReference": { 
            "Channel": "string",
            "QueueId": "string"
         }
      }
   ],
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateRoutingProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateRoutingProfile_RequestSyntax) **   <a name="connect-CreateRoutingProfile-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateRoutingProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AgentAvailabilityTimer](#API_CreateRoutingProfile_RequestSyntax) **   <a name="connect-CreateRoutingProfile-request-AgentAvailabilityTimer"></a>
Whether agents with this routing profile will have their routing order calculated based on *longest idle time* or *time since their last inbound contact*.   
Type: String  
Valid Values: `TIME_SINCE_LAST_ACTIVITY | TIME_SINCE_LAST_INBOUND`   
Required: No

 ** [DefaultOutboundQueueId](#API_CreateRoutingProfile_RequestSyntax) **   <a name="connect-CreateRoutingProfile-request-DefaultOutboundQueueId"></a>
The default outbound queue for the routing profile.  
Type: String  
Required: Yes

 ** [Description](#API_CreateRoutingProfile_RequestSyntax) **   <a name="connect-CreateRoutingProfile-request-Description"></a>
Description of the routing profile. Must not be more than 250 characters.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Required: Yes

 ** [ManualAssignmentQueueConfigs](#API_CreateRoutingProfile_RequestSyntax) **   <a name="connect-CreateRoutingProfile-request-ManualAssignmentQueueConfigs"></a>
The manual assignment queues associated with the routing profile. If no queue is added, agents and supervisors can't pick or assign any contacts from this routing profile. The limit of 10 array members applies to the maximum number of RoutingProfileManualAssignmentQueueConfig objects that can be passed during a CreateRoutingProfile API request. It is different from the quota of 50 queues per routing profile per instance that is listed in Amazon Connect service quotas.  
Note: Use this config for chat, email, and task contacts. It does not support voice contacts.  
Type: Array of [RoutingProfileManualAssignmentQueueConfig](API_RoutingProfileManualAssignmentQueueConfig.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: No

 ** [MediaConcurrencies](#API_CreateRoutingProfile_RequestSyntax) **   <a name="connect-CreateRoutingProfile-request-MediaConcurrencies"></a>
The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.  
Type: Array of [MediaConcurrency](API_MediaConcurrency.md) objects  
Required: Yes

 ** [Name](#API_CreateRoutingProfile_RequestSyntax) **   <a name="connect-CreateRoutingProfile-request-Name"></a>
The name of the routing profile. Must not be more than 127 characters.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Required: Yes

 ** [QueueConfigs](#API_CreateRoutingProfile_RequestSyntax) **   <a name="connect-CreateRoutingProfile-request-QueueConfigs"></a>
The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.  
The limit of 10 array members applies to the maximum number of `RoutingProfileQueueConfig` objects that can be passed during a CreateRoutingProfile API request. It is different from the quota of 50 queues per routing profile per instance that is listed in [Amazon Connect service quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html).   
Type: Array of [RoutingProfileQueueConfig](API_RoutingProfileQueueConfig.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: No

 ** [Tags](#API_CreateRoutingProfile_RequestSyntax) **   <a name="connect-CreateRoutingProfile-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateRoutingProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "RoutingProfileArn": "string",
   "RoutingProfileId": "string"
}
```

## Response Elements
<a name="API_CreateRoutingProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [RoutingProfileArn](#API_CreateRoutingProfile_ResponseSyntax) **   <a name="connect-CreateRoutingProfile-response-RoutingProfileArn"></a>
The Amazon Resource Name (ARN) of the routing profile.  
Type: String

 ** [RoutingProfileId](#API_CreateRoutingProfile_ResponseSyntax) **   <a name="connect-CreateRoutingProfile-response-RoutingProfileId"></a>
The identifier of the routing profile.  
Type: String

## Errors
<a name="API_CreateRoutingProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateRoutingProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateRoutingProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateRoutingProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateRoutingProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateRoutingProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateRoutingProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateRoutingProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateRoutingProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateRoutingProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateRoutingProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateRoutingProfile) 

# CreateRule
<a name="API_CreateRule"></a>

Creates a rule for the specified Amazon Connect instance.

Use the [Rules Function language](https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html) to code conditions for the rule. 

## Request Syntax
<a name="API_CreateRule_RequestSyntax"></a>

```
POST /rules/InstanceId HTTP/1.1
Content-type: application/json

{
   "Actions": [ 
      { 
         "ActionType": "string",
         "AssignContactCategoryAction": { 
         },
         "AssignSlaAction": { 
            "CaseSlaConfiguration": { 
               "FieldId": "string",
               "Name": "string",
               "TargetFieldValues": [ 
                  { 
                     "BooleanValue": boolean,
                     "DoubleValue": number,
                     "EmptyValue": { 
                     },
                     "StringValue": "string"
                  }
               ],
               "TargetSlaMinutes": number,
               "Type": "string"
            },
            "SlaAssignmentType": "string"
         },
         "CreateCaseAction": { 
            "Fields": [ 
               { 
                  "Id": "string",
                  "Value": { 
                     "BooleanValue": boolean,
                     "DoubleValue": number,
                     "EmptyValue": { 
                     },
                     "StringValue": "string"
                  }
               }
            ],
            "TemplateId": "string"
         },
         "EndAssociatedTasksAction": { 
         },
         "EventBridgeAction": { 
            "Name": "string"
         },
         "SendNotificationAction": { 
            "Content": "string",
            "ContentType": "string",
            "DeliveryMethod": "string",
            "Exclusion": { 
               "UserIds": [ "string" ],
               "UserTags": { 
                  "string" : "string" 
               }
            },
            "Recipient": { 
               "UserIds": [ "string" ],
               "UserTags": { 
                  "string" : "string" 
               }
            },
            "Subject": "string"
         },
         "SubmitAutoEvaluationAction": { 
            "EvaluationFormId": "string"
         },
         "TaskAction": { 
            "ContactFlowId": "string",
            "Description": "string",
            "Name": "string",
            "References": { 
               "string" : { 
                  "Arn": "string",
                  "Status": "string",
                  "StatusReason": "string",
                  "Type": "string",
                  "Value": "string"
               }
            }
         },
         "UpdateCaseAction": { 
            "Fields": [ 
               { 
                  "Id": "string",
                  "Value": { 
                     "BooleanValue": boolean,
                     "DoubleValue": number,
                     "EmptyValue": { 
                     },
                     "StringValue": "string"
                  }
               }
            ]
         }
      }
   ],
   "ClientToken": "string",
   "Function": "string",
   "Name": "string",
   "PublishStatus": "string",
   "TriggerEventSource": { 
      "EventSourceName": "string",
      "IntegrationAssociationId": "string"
   }
}
```

## URI Request Parameters
<a name="API_CreateRule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateRule_RequestSyntax) **   <a name="connect-CreateRule-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateRule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Actions](#API_CreateRule_RequestSyntax) **   <a name="connect-CreateRule-request-Actions"></a>
A list of actions to be run when the rule is triggered.  
Type: Array of [RuleAction](API_RuleAction.md) objects  
Required: Yes

 ** [ClientToken](#API_CreateRule_RequestSyntax) **   <a name="connect-CreateRule-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [Function](#API_CreateRule_RequestSyntax) **   <a name="connect-CreateRule-request-Function"></a>
The conditions of the rule.  
Type: String  
Required: Yes

 ** [Name](#API_CreateRule_RequestSyntax) **   <a name="connect-CreateRule-request-Name"></a>
A unique name for the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z._-]+`   
Required: Yes

 ** [PublishStatus](#API_CreateRule_RequestSyntax) **   <a name="connect-CreateRule-request-PublishStatus"></a>
The publish status of the rule.  
Type: String  
Valid Values: `DRAFT | PUBLISHED`   
Required: Yes

 ** [TriggerEventSource](#API_CreateRule_RequestSyntax) **   <a name="connect-CreateRule-request-TriggerEventSource"></a>
The event source to trigger the rule.  
Type: [RuleTriggerEventSource](API_RuleTriggerEventSource.md) object  
Required: Yes

## Response Syntax
<a name="API_CreateRule_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "RuleArn": "string",
   "RuleId": "string"
}
```

## Response Elements
<a name="API_CreateRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [RuleArn](#API_CreateRule_ResponseSyntax) **   <a name="connect-CreateRule-response-RuleArn"></a>
The Amazon Resource Name (ARN) of the rule.  
Type: String

 ** [RuleId](#API_CreateRule_ResponseSyntax) **   <a name="connect-CreateRule-response-RuleId"></a>
A unique identifier for the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_CreateRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateRule) 

# CreateSecurityProfile
<a name="API_CreateSecurityProfile"></a>

Creates a security profile.

For information about security profiles, see [Security Profiles](https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html) in the *Amazon Connect Administrator Guide*. For a mapping of the API name and user interface name of the security profile permissions, see [List of security profile permissions](https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html). 

## Request Syntax
<a name="API_CreateSecurityProfile_RequestSyntax"></a>

```
PUT /security-profiles/InstanceId HTTP/1.1
Content-type: application/json

{
   "AllowedAccessControlHierarchyGroupId": "string",
   "AllowedAccessControlTags": { 
      "string" : "string" 
   },
   "AllowedFlowModules": [ 
      { 
         "FlowModuleId": "string",
         "Type": "string"
      }
   ],
   "Applications": [ 
      { 
         "ApplicationPermissions": [ "string" ],
         "Namespace": "string",
         "Type": "string"
      }
   ],
   "Description": "string",
   "GranularAccessControlConfiguration": { 
      "DataTableAccessControlConfiguration": { 
         "PrimaryAttributeAccessControlConfiguration": { 
            "PrimaryAttributeValues": [ 
               { 
                  "AccessType": "string",
                  "AttributeName": "string",
                  "Values": [ "string" ]
               }
            ]
         }
      }
   },
   "HierarchyRestrictedResources": [ "string" ],
   "Permissions": [ "string" ],
   "SecurityProfileName": "string",
   "TagRestrictedResources": [ "string" ],
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateSecurityProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateSecurityProfile_RequestSyntax) **   <a name="connect-CreateSecurityProfile-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateSecurityProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AllowedAccessControlHierarchyGroupId](#API_CreateSecurityProfile_RequestSyntax) **   <a name="connect-CreateSecurityProfile-request-AllowedAccessControlHierarchyGroupId"></a>
The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.  
Type: String  
Required: No

 ** [AllowedAccessControlTags](#API_CreateSecurityProfile_RequestSyntax) **   <a name="connect-CreateSecurityProfile-request-AllowedAccessControlTags"></a>
The list of tags that a security profile uses to restrict access to resources in Amazon Connect.  
Type: String to string map  
Map Entries: Maximum number of 4 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Maximum length of 256.  
Required: No

 ** [AllowedFlowModules](#API_CreateSecurityProfile_RequestSyntax) **   <a name="connect-CreateSecurityProfile-request-AllowedFlowModules"></a>
 A list of Flow Modules an AI Agent can invoke as a tool.   
Type: Array of [FlowModule](API_FlowModule.md) objects  
Array Members: Maximum number of 10 items.  
Required: No

 ** [Applications](#API_CreateSecurityProfile_RequestSyntax) **   <a name="connect-CreateSecurityProfile-request-Applications"></a>
A list of third-party applications or MCP Servers that the security profile will give access to.  
Type: Array of [Application](API_Application.md) objects  
Array Members: Maximum number of 10 items.  
Required: No

 ** [Description](#API_CreateSecurityProfile_RequestSyntax) **   <a name="connect-CreateSecurityProfile-request-Description"></a>
The description of the security profile.  
Type: String  
Length Constraints: Maximum length of 250.  
Required: No

 ** [GranularAccessControlConfiguration](#API_CreateSecurityProfile_RequestSyntax) **   <a name="connect-CreateSecurityProfile-request-GranularAccessControlConfiguration"></a>
The granular access control configuration for the security profile, including data table permissions.  
Type: [GranularAccessControlConfiguration](API_GranularAccessControlConfiguration.md) object  
Required: No

 ** [HierarchyRestrictedResources](#API_CreateSecurityProfile_RequestSyntax) **   <a name="connect-CreateSecurityProfile-request-HierarchyRestrictedResources"></a>
The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: `User`.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [Permissions](#API_CreateSecurityProfile_RequestSyntax) **   <a name="connect-CreateSecurityProfile-request-Permissions"></a>
Permissions assigned to the security profile. For a list of valid permissions, see [List of security profile permissions](https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html).   
Type: Array of strings  
Array Members: Maximum number of 500 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [SecurityProfileName](#API_CreateSecurityProfile_RequestSyntax) **   <a name="connect-CreateSecurityProfile-request-SecurityProfileName"></a>
The name of the security profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `^[ a-zA-Z0-9_@-]+$`   
Required: Yes

 ** [TagRestrictedResources](#API_CreateSecurityProfile_RequestSyntax) **   <a name="connect-CreateSecurityProfile-request-TagRestrictedResources"></a>
The list of resources that a security profile applies tag restrictions to in Amazon Connect. For a list of Amazon Connect resources that you can tag, see [Add tags to resources in Amazon Connect](https://docs.aws.amazon.com/connect/latest/adminguide/tagging.html) in the *Amazon Connect Administrator Guide*.   
Type: Array of strings  
Array Members: Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [Tags](#API_CreateSecurityProfile_RequestSyntax) **   <a name="connect-CreateSecurityProfile-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateSecurityProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "SecurityProfileArn": "string",
   "SecurityProfileId": "string"
}
```

## Response Elements
<a name="API_CreateSecurityProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [SecurityProfileArn](#API_CreateSecurityProfile_ResponseSyntax) **   <a name="connect-CreateSecurityProfile-response-SecurityProfileArn"></a>
The Amazon Resource Name (ARN) for the security profile.  
Type: String

 ** [SecurityProfileId](#API_CreateSecurityProfile_ResponseSyntax) **   <a name="connect-CreateSecurityProfile-response-SecurityProfileId"></a>
The identifier for the security profle.  
Type: String

## Errors
<a name="API_CreateSecurityProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateSecurityProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateSecurityProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateSecurityProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateSecurityProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateSecurityProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateSecurityProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateSecurityProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateSecurityProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateSecurityProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateSecurityProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateSecurityProfile) 

# CreateTaskTemplate
<a name="API_CreateTaskTemplate"></a>

Creates a new task template in the specified Amazon Connect instance.

## Request Syntax
<a name="API_CreateTaskTemplate_RequestSyntax"></a>

```
PUT /instance/InstanceId/task/template HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "Constraints": { 
      "InvisibleFields": [ 
         { 
            "Id": { 
               "Name": "string"
            }
         }
      ],
      "ReadOnlyFields": [ 
         { 
            "Id": { 
               "Name": "string"
            }
         }
      ],
      "RequiredFields": [ 
         { 
            "Id": { 
               "Name": "string"
            }
         }
      ]
   },
   "ContactFlowId": "string",
   "Defaults": { 
      "DefaultFieldValues": [ 
         { 
            "DefaultValue": "string",
            "Id": { 
               "Name": "string"
            }
         }
      ]
   },
   "Description": "string",
   "Fields": [ 
      { 
         "Description": "string",
         "Id": { 
            "Name": "string"
         },
         "SingleSelectOptions": [ "string" ],
         "Type": "string"
      }
   ],
   "Name": "string",
   "SelfAssignFlowId": "string",
   "Status": "string"
}
```

## URI Request Parameters
<a name="API_CreateTaskTemplate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateTaskTemplate_RequestSyntax) **   <a name="connect-CreateTaskTemplate-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateTaskTemplate_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateTaskTemplate_RequestSyntax) **   <a name="connect-CreateTaskTemplate-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [Constraints](#API_CreateTaskTemplate_RequestSyntax) **   <a name="connect-CreateTaskTemplate-request-Constraints"></a>
Constraints that are applicable to the fields listed.  
Type: [TaskTemplateConstraints](API_TaskTemplateConstraints.md) object  
Required: No

 ** [ContactFlowId](#API_CreateTaskTemplate_RequestSyntax) **   <a name="connect-CreateTaskTemplate-request-ContactFlowId"></a>
The identifier of the flow that runs by default when a task is created by referencing this template.  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [Defaults](#API_CreateTaskTemplate_RequestSyntax) **   <a name="connect-CreateTaskTemplate-request-Defaults"></a>
The default values for fields when a task is created by referencing this template.  
Type: [TaskTemplateDefaults](API_TaskTemplateDefaults.md) object  
Required: No

 ** [Description](#API_CreateTaskTemplate_RequestSyntax) **   <a name="connect-CreateTaskTemplate-request-Description"></a>
The description of the task template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [Fields](#API_CreateTaskTemplate_RequestSyntax) **   <a name="connect-CreateTaskTemplate-request-Fields"></a>
Fields that are part of the template.  
Type: Array of [TaskTemplateField](API_TaskTemplateField.md) objects  
Required: Yes

 ** [Name](#API_CreateTaskTemplate_RequestSyntax) **   <a name="connect-CreateTaskTemplate-request-Name"></a>
The name of the task template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [SelfAssignFlowId](#API_CreateTaskTemplate_RequestSyntax) **   <a name="connect-CreateTaskTemplate-request-SelfAssignFlowId"></a>
The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [Status](#API_CreateTaskTemplate_RequestSyntax) **   <a name="connect-CreateTaskTemplate-request-Status"></a>
Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to it. Tasks can only be created from `ACTIVE` templates. If a template is marked as `INACTIVE`, then a task that refers to this template cannot be created.   
Type: String  
Valid Values: `ACTIVE | INACTIVE`   
Required: No

## Response Syntax
<a name="API_CreateTaskTemplate_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Id": "string"
}
```

## Response Elements
<a name="API_CreateTaskTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_CreateTaskTemplate_ResponseSyntax) **   <a name="connect-CreateTaskTemplate-response-Arn"></a>
The Amazon Resource Name (ARN) for the task template resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [Id](#API_CreateTaskTemplate_ResponseSyntax) **   <a name="connect-CreateTaskTemplate-response-Id"></a>
The identifier of the task template resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_CreateTaskTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** PropertyValidationException **   
The property is not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateTaskTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateTaskTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateTaskTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateTaskTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateTaskTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateTaskTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateTaskTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateTaskTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateTaskTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateTaskTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateTaskTemplate) 

# CreateTestCase
<a name="API_CreateTestCase"></a>

Creates a test case with its content and metadata for the specified Amazon Connect instance.

## Request Syntax
<a name="API_CreateTestCase_RequestSyntax"></a>

```
PUT /test-cases/InstanceId HTTP/1.1
x-amz-resource-id: TestCaseId
x-amz-last-modified-time: LastModifiedTime
x-amz-last-modified-region: LastModifiedRegion
Content-type: application/json

{
   "Content": "string",
   "Description": "string",
   "EntryPoint": { 
      "ChatEntryPointParameters": { 
         "FlowId": "string"
      },
      "Type": "string",
      "VoiceCallEntryPointParameters": { 
         "DestinationPhoneNumber": "string",
         "FlowId": "string",
         "SourcePhoneNumber": "string"
      }
   },
   "InitializationData": "string",
   "Name": "string",
   "Status": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateTestCase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateTestCase_RequestSyntax) **   <a name="connect-CreateTestCase-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

 ** [LastModifiedRegion](#API_CreateTestCase_RequestSyntax) **   <a name="connect-CreateTestCase-request-LastModifiedRegion"></a>
The region in which the resource was last modified  
Pattern: `[a-z]{2}(-[a-z]+){1,2}(-[0-9])?` 

 ** [LastModifiedTime](#API_CreateTestCase_RequestSyntax) **   <a name="connect-CreateTestCase-request-LastModifiedTime"></a>
The time at which the resource was last modified.

 ** [TestCaseId](#API_CreateTestCase_RequestSyntax) **   <a name="connect-CreateTestCase-request-TestCaseId"></a>
Id of the test case if you want to create it in a replica region using Amazon Connect Global Resiliency  
Length Constraints: Maximum length of 500.

## Request Body
<a name="API_CreateTestCase_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Content](#API_CreateTestCase_RequestSyntax) **   <a name="connect-CreateTestCase-request-Content"></a>
The JSON string that represents the content of the test.  
Type: String  
Required: Yes

 ** [Description](#API_CreateTestCase_RequestSyntax) **   <a name="connect-CreateTestCase-request-Description"></a>
The description of the test.  
Type: String  
Required: No

 ** [EntryPoint](#API_CreateTestCase_RequestSyntax) **   <a name="connect-CreateTestCase-request-EntryPoint"></a>
Defines the starting point for your test.  
Type: [TestCaseEntryPoint](API_TestCaseEntryPoint.md) object  
Required: No

 ** [InitializationData](#API_CreateTestCase_RequestSyntax) **   <a name="connect-CreateTestCase-request-InitializationData"></a>
Defines the initial custom attributes for your test.  
Type: String  
Required: No

 ** [Name](#API_CreateTestCase_RequestSyntax) **   <a name="connect-CreateTestCase-request-Name"></a>
The name of the test.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

 ** [Status](#API_CreateTestCase_RequestSyntax) **   <a name="connect-CreateTestCase-request-Status"></a>
Indicates the test status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. The SAVED status does not initiate validation of the content.  
Type: String  
Valid Values: `PUBLISHED | SAVED`   
Required: No

 ** [Tags](#API_CreateTestCase_RequestSyntax) **   <a name="connect-CreateTestCase-request-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateTestCase_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "TestCaseArn": "string",
   "TestCaseId": "string"
}
```

## Response Elements
<a name="API_CreateTestCase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TestCaseArn](#API_CreateTestCase_ResponseSyntax) **   <a name="connect-CreateTestCase-response-TestCaseArn"></a>
The Amazon Resource Name (ARN) of the test.  
Type: String

 ** [TestCaseId](#API_CreateTestCase_ResponseSyntax) **   <a name="connect-CreateTestCase-response-TestCaseId"></a>
The identifier of the test.  
Type: String  
Length Constraints: Maximum length of 500.

## Errors
<a name="API_CreateTestCase_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** IdempotencyException **   
An entity with the same name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** InvalidTestCaseException **   
The test is not valid.    
 ** Problems **   
The problems with the test. Please fix before trying again.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateTestCase_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateTestCase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateTestCase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateTestCase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateTestCase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateTestCase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateTestCase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateTestCase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateTestCase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateTestCase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateTestCase) 

# CreateTrafficDistributionGroup
<a name="API_CreateTrafficDistributionGroup"></a>

Creates a traffic distribution group given an Amazon Connect instance that has been replicated.

**Note**  
The `SignInConfig` distribution is available only on a default `TrafficDistributionGroup` (see the `IsDefault` parameter in the [TrafficDistributionGroup](https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html) data type). If you call `UpdateTrafficDistribution` with a modified `SignInConfig` and a non-default `TrafficDistributionGroup`, an `InvalidRequestException` is returned.

For more information about creating traffic distribution groups, see [Set up traffic distribution groups](https://docs.aws.amazon.com/connect/latest/adminguide/setup-traffic-distribution-groups.html) in the *Amazon Connect Administrator Guide*. 

## Request Syntax
<a name="API_CreateTrafficDistributionGroup_RequestSyntax"></a>

```
PUT /traffic-distribution-group HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "Description": "string",
   "InstanceId": "string",
   "Name": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateTrafficDistributionGroup_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateTrafficDistributionGroup_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateTrafficDistributionGroup_RequestSyntax) **   <a name="connect-CreateTrafficDistributionGroup-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [Description](#API_CreateTrafficDistributionGroup_RequestSyntax) **   <a name="connect-CreateTrafficDistributionGroup-request-Description"></a>
A description for the traffic distribution group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Pattern: `(^[\S].*[\S]$)|(^[\S]$)`   
Required: No

 ** [InstanceId](#API_CreateTrafficDistributionGroup_RequestSyntax) **   <a name="connect-CreateTrafficDistributionGroup-request-InstanceId"></a>
The identifier of the Amazon Connect instance that has been replicated. You can find the `instanceId` in the ARN of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

 ** [Name](#API_CreateTrafficDistributionGroup_RequestSyntax) **   <a name="connect-CreateTrafficDistributionGroup-request-Name"></a>
The name for the traffic distribution group.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `(^[\S].*[\S]$)|(^[\S]$)`   
Required: Yes

 ** [Tags](#API_CreateTrafficDistributionGroup_RequestSyntax) **   <a name="connect-CreateTrafficDistributionGroup-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateTrafficDistributionGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Id": "string"
}
```

## Response Elements
<a name="API_CreateTrafficDistributionGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_CreateTrafficDistributionGroup_ResponseSyntax) **   <a name="connect-CreateTrafficDistributionGroup-response-Arn"></a>
The Amazon Resource Name (ARN) of the traffic distribution group.  
Type: String  
Pattern: `^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` 

 ** [Id](#API_CreateTrafficDistributionGroup_ResponseSyntax) **   <a name="connect-CreateTrafficDistributionGroup-response-Id"></a>
The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.  
Type: String  
Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` 

## Errors
<a name="API_CreateTrafficDistributionGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ResourceNotReadyException **   
The resource is not ready.  
HTTP Status Code: 409

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateTrafficDistributionGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateTrafficDistributionGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateTrafficDistributionGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateTrafficDistributionGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateTrafficDistributionGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateTrafficDistributionGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateTrafficDistributionGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateTrafficDistributionGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateTrafficDistributionGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateTrafficDistributionGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateTrafficDistributionGroup) 

# CreateUseCase
<a name="API_CreateUseCase"></a>

Creates a use case for an integration association.

## Request Syntax
<a name="API_CreateUseCase_RequestSyntax"></a>

```
PUT /instance/InstanceId/integration-associations/IntegrationAssociationId/use-cases HTTP/1.1
Content-type: application/json

{
   "Tags": { 
      "string" : "string" 
   },
   "UseCaseType": "string"
}
```

## URI Request Parameters
<a name="API_CreateUseCase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateUseCase_RequestSyntax) **   <a name="connect-CreateUseCase-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [IntegrationAssociationId](#API_CreateUseCase_RequestSyntax) **   <a name="connect-CreateUseCase-request-uri-IntegrationAssociationId"></a>
The identifier for the integration association.  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: Yes

## Request Body
<a name="API_CreateUseCase_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Tags](#API_CreateUseCase_RequestSyntax) **   <a name="connect-CreateUseCase-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

 ** [UseCaseType](#API_CreateUseCase_RequestSyntax) **   <a name="connect-CreateUseCase-request-UseCaseType"></a>
The type of use case to associate to the integration association. Each integration association can have only one of each use case type.  
Type: String  
Valid Values: `RULES_EVALUATION | CONNECT_CAMPAIGNS`   
Required: Yes

## Response Syntax
<a name="API_CreateUseCase_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "UseCaseArn": "string",
   "UseCaseId": "string"
}
```

## Response Elements
<a name="API_CreateUseCase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [UseCaseArn](#API_CreateUseCase_ResponseSyntax) **   <a name="connect-CreateUseCase-response-UseCaseArn"></a>
The Amazon Resource Name (ARN) for the use case.  
Type: String

 ** [UseCaseId](#API_CreateUseCase_ResponseSyntax) **   <a name="connect-CreateUseCase-response-UseCaseId"></a>
The identifier of the use case.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.

## Errors
<a name="API_CreateUseCase_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateUseCase_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateUseCase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateUseCase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateUseCase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateUseCase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateUseCase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateUseCase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateUseCase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateUseCase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateUseCase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateUseCase) 

# CreateUser
<a name="API_CreateUser"></a>

Creates a user account for the specified Amazon Connect instance.

**Important**  
Certain [UserIdentityInfo](https://docs.aws.amazon.com/connect/latest/APIReference/API_UserIdentityInfo.html) parameters are required in some situations. For example, `Email`, `FirstName` and `LastName` are required if you are using Amazon Connect or SAML for identity management.

**Note**  
Fields in `PhoneConfig` cannot be set simultaneously with their corresponding channel-specific configuration parameters. Specifically:  
 `PhoneConfig.AutoAccept` conflicts with `AutoAcceptConfigs` 
 `PhoneConfig.AfterContactWorkTimeLimit` conflicts with `AfterContactWorkConfigs` 
 `PhoneConfig.PhoneType` and `PhoneConfig.PhoneNumber` conflict with `PhoneNumberConfigs` 
 `PhoneConfig.PersistentConnection` conflicts with `PersistentConnectionConfigs` 
We recommend using channel-specific parameters such as `AutoAcceptConfigs`, `AfterContactWorkConfigs`, `PhoneNumberConfigs`, `PersistentConnectionConfigs`, and `VoiceEnhancementConfigs` for per-channel configuration.

For information about how to create users using the Amazon Connect admin website, see [Add Users](https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html) in the *Amazon Connect Administrator Guide*.

## Request Syntax
<a name="API_CreateUser_RequestSyntax"></a>

```
PUT /users/InstanceId HTTP/1.1
Content-type: application/json

{
   "AfterContactWorkConfigs": [ 
      { 
         "AfterContactWorkConfig": { 
            "AfterContactWorkTimeLimit": number
         },
         "AgentFirstCallbackAfterContactWorkConfig": { 
            "AfterContactWorkTimeLimit": number
         },
         "Channel": "string"
      }
   ],
   "AutoAcceptConfigs": [ 
      { 
         "AgentFirstCallbackAutoAccept": boolean,
         "AutoAccept": boolean,
         "Channel": "string"
      }
   ],
   "DirectoryUserId": "string",
   "HierarchyGroupId": "string",
   "IdentityInfo": { 
      "Email": "string",
      "FirstName": "string",
      "LastName": "string",
      "Mobile": "string",
      "SecondaryEmail": "string"
   },
   "Password": "string",
   "PersistentConnectionConfigs": [ 
      { 
         "Channel": "string",
         "PersistentConnection": boolean
      }
   ],
   "PhoneConfig": { 
      "AfterContactWorkTimeLimit": number,
      "AutoAccept": boolean,
      "DeskPhoneNumber": "string",
      "PersistentConnection": boolean,
      "PhoneType": "string"
   },
   "PhoneNumberConfigs": [ 
      { 
         "Channel": "string",
         "PhoneNumber": "string",
         "PhoneType": "string"
      }
   ],
   "RoutingProfileId": "string",
   "SecurityProfileIds": [ "string" ],
   "Tags": { 
      "string" : "string" 
   },
   "Username": "string",
   "VoiceEnhancementConfigs": [ 
      { 
         "Channel": "string",
         "VoiceEnhancementMode": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_CreateUser_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateUser_RequestSyntax) **   <a name="connect-CreateUser-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateUser_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AfterContactWorkConfigs](#API_CreateUser_RequestSyntax) **   <a name="connect-CreateUser-request-AfterContactWorkConfigs"></a>
The list of after contact work (ACW) timeout configuration settings for each channel.  
Type: Array of [AfterContactWorkConfigPerChannel](API_AfterContactWorkConfigPerChannel.md) objects  
Required: No

 ** [AutoAcceptConfigs](#API_CreateUser_RequestSyntax) **   <a name="connect-CreateUser-request-AutoAcceptConfigs"></a>
The list of auto-accept configuration settings for each channel.  
Type: Array of [AutoAcceptConfig](API_AutoAcceptConfig.md) objects  
Required: No

 ** [DirectoryUserId](#API_CreateUser_RequestSyntax) **   <a name="connect-CreateUser-request-DirectoryUserId"></a>
The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.  
This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.  
Type: String  
Required: No

 ** [HierarchyGroupId](#API_CreateUser_RequestSyntax) **   <a name="connect-CreateUser-request-HierarchyGroupId"></a>
The identifier of the hierarchy group for the user.  
Type: String  
Required: No

 ** [IdentityInfo](#API_CreateUser_RequestSyntax) **   <a name="connect-CreateUser-request-IdentityInfo"></a>
The information about the identity of the user.  
Type: [UserIdentityInfo](API_UserIdentityInfo.md) object  
Required: No

 ** [Password](#API_CreateUser_RequestSyntax) **   <a name="connect-CreateUser-request-Password"></a>
The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.  
Type: String  
Pattern: `/^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[a-zA-Z\d\S]{8,64}$/`   
Required: No

 ** [PersistentConnectionConfigs](#API_CreateUser_RequestSyntax) **   <a name="connect-CreateUser-request-PersistentConnectionConfigs"></a>
The list of persistent connection configuration settings for each channel.  
Type: Array of [PersistentConnectionConfig](API_PersistentConnectionConfig.md) objects  
Required: No

 ** [PhoneConfig](#API_CreateUser_RequestSyntax) **   <a name="connect-CreateUser-request-PhoneConfig"></a>
The phone settings for the user. This parameter is optional. If not provided, the user can be configured using channel-specific parameters such as `AutoAcceptConfigs`, `AfterContactWorkConfigs`, `PhoneNumberConfigs`, `PersistentConnectionConfigs`, and `VoiceEnhancementConfigs`.  
Type: [UserPhoneConfig](API_UserPhoneConfig.md) object  
Required: No

 ** [PhoneNumberConfigs](#API_CreateUser_RequestSyntax) **   <a name="connect-CreateUser-request-PhoneNumberConfigs"></a>
The list of phone number configuration settings for each channel.  
Type: Array of [PhoneNumberConfig](API_PhoneNumberConfig.md) objects  
Required: No

 ** [RoutingProfileId](#API_CreateUser_RequestSyntax) **   <a name="connect-CreateUser-request-RoutingProfileId"></a>
The identifier of the routing profile for the user.  
Type: String  
Required: Yes

 ** [SecurityProfileIds](#API_CreateUser_RequestSyntax) **   <a name="connect-CreateUser-request-SecurityProfileIds"></a>
The identifier of the security profile for the user.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: Yes

 ** [Tags](#API_CreateUser_RequestSyntax) **   <a name="connect-CreateUser-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

 ** [Username](#API_CreateUser_RequestSyntax) **   <a name="connect-CreateUser-request-Username"></a>
The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9\$1-.\$1@]\$1.  
Username can include @ only if used in an email format. For example:  
+ Correct: testuser
+ Correct: testuser@example.com
+ Incorrect: testuser@example
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [VoiceEnhancementConfigs](#API_CreateUser_RequestSyntax) **   <a name="connect-CreateUser-request-VoiceEnhancementConfigs"></a>
The list of voice enhancement configuration settings for each channel.  
Type: Array of [VoiceEnhancementConfig](API_VoiceEnhancementConfig.md) objects  
Required: No

## Response Syntax
<a name="API_CreateUser_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "UserArn": "string",
   "UserId": "string"
}
```

## Response Elements
<a name="API_CreateUser_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [UserArn](#API_CreateUser_ResponseSyntax) **   <a name="connect-CreateUser-response-UserArn"></a>
The Amazon Resource Name (ARN) of the user account.  
Type: String

 ** [UserId](#API_CreateUser_ResponseSyntax) **   <a name="connect-CreateUser-response-UserId"></a>
The identifier of the user account.  
Type: String

## Errors
<a name="API_CreateUser_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateUser_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateUser) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateUser) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateUser) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateUser) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateUser) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateUser) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateUser) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateUser) 

# CreateUserHierarchyGroup
<a name="API_CreateUserHierarchyGroup"></a>

Creates a new user hierarchy group.

## Request Syntax
<a name="API_CreateUserHierarchyGroup_RequestSyntax"></a>

```
PUT /user-hierarchy-groups/InstanceId HTTP/1.1
Content-type: application/json

{
   "Name": "string",
   "ParentGroupId": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateUserHierarchyGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateUserHierarchyGroup_RequestSyntax) **   <a name="connect-CreateUserHierarchyGroup-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateUserHierarchyGroup_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Name](#API_CreateUserHierarchyGroup_RequestSyntax) **   <a name="connect-CreateUserHierarchyGroup-request-Name"></a>
The name of the user hierarchy group. Must not be more than 100 characters.  
Type: String  
Required: Yes

 ** [ParentGroupId](#API_CreateUserHierarchyGroup_RequestSyntax) **   <a name="connect-CreateUserHierarchyGroup-request-ParentGroupId"></a>
The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.  
Type: String  
Required: No

 ** [Tags](#API_CreateUserHierarchyGroup_RequestSyntax) **   <a name="connect-CreateUserHierarchyGroup-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateUserHierarchyGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "HierarchyGroupArn": "string",
   "HierarchyGroupId": "string"
}
```

## Response Elements
<a name="API_CreateUserHierarchyGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [HierarchyGroupArn](#API_CreateUserHierarchyGroup_ResponseSyntax) **   <a name="connect-CreateUserHierarchyGroup-response-HierarchyGroupArn"></a>
The Amazon Resource Name (ARN) of the hierarchy group.   
Type: String

 ** [HierarchyGroupId](#API_CreateUserHierarchyGroup_ResponseSyntax) **   <a name="connect-CreateUserHierarchyGroup-response-HierarchyGroupId"></a>
The identifier of the hierarchy group.  
Type: String

## Errors
<a name="API_CreateUserHierarchyGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateUserHierarchyGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateUserHierarchyGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateUserHierarchyGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateUserHierarchyGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateUserHierarchyGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateUserHierarchyGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateUserHierarchyGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateUserHierarchyGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateUserHierarchyGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateUserHierarchyGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateUserHierarchyGroup) 

# CreateView
<a name="API_CreateView"></a>

Creates a new view with the possible status of `SAVED` or `PUBLISHED`.

The views will have a unique name for each connect instance.

It performs basic content validation if the status is `SAVED` or full content validation if the status is set to `PUBLISHED`. An error is returned if validation fails. It associates either the `$SAVED` qualifier or both of the `$SAVED` and `$LATEST` qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided.

## Request Syntax
<a name="API_CreateView_RequestSyntax"></a>

```
PUT /views/InstanceId HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "Content": { 
      "Actions": [ "string" ],
      "Template": "string"
   },
   "Description": "string",
   "Name": "string",
   "Status": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_CreateView_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateView_RequestSyntax) **   <a name="connect-CreateView-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9\_\-:\/]+$`   
Required: Yes

## Request Body
<a name="API_CreateView_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateView_RequestSyntax) **   <a name="connect-CreateView-request-ClientToken"></a>
A unique Id for each create view request to avoid duplicate view creation. For example, the view is idempotent ClientToken is provided.  
Type: String  
Length Constraints: Maximum length of 500.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$`   
Required: No

 ** [Content](#API_CreateView_RequestSyntax) **   <a name="connect-CreateView-request-Content"></a>
View content containing all content necessary to render a view except for runtime input data.  
The total uncompressed content has a maximum file size of 400kB.  
Type: [ViewInputContent](API_ViewInputContent.md) object  
Required: Yes

 ** [Description](#API_CreateView_RequestSyntax) **   <a name="connect-CreateView-request-Description"></a>
The description of the view.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `^([\p{L}\p{N}_.:\/=+\-@,()']+[\p{L}\p{Z}\p{N}_.:\/=+\-@,()']*)$`   
Required: No

 ** [Name](#API_CreateView_RequestSyntax) **   <a name="connect-CreateView-request-Name"></a>
The name of the view.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^([\p{L}\p{N}_.:\/=+\-@()']+[\p{L}\p{Z}\p{N}_.:\/=+\-@()']*)$`   
Required: Yes

 ** [Status](#API_CreateView_RequestSyntax) **   <a name="connect-CreateView-request-Status"></a>
Indicates the view status as either `SAVED` or `PUBLISHED`. The `PUBLISHED` status will initiate validation on the content.  
Type: String  
Valid Values: `PUBLISHED | SAVED`   
Required: Yes

 ** [Tags](#API_CreateView_RequestSyntax) **   <a name="connect-CreateView-request-Tags"></a>
The tags associated with the view resource (not specific to view version).These tags can be used to organize, track, or control access for this resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_CreateView_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "View": { 
      "Arn": "string",
      "Content": { 
         "Actions": [ "string" ],
         "InputSchema": "string",
         "Template": "string"
      },
      "CreatedTime": number,
      "Description": "string",
      "Id": "string",
      "LastModifiedTime": number,
      "Name": "string",
      "Status": "string",
      "Tags": { 
         "string" : "string" 
      },
      "Type": "string",
      "Version": number,
      "VersionDescription": "string",
      "ViewContentSha256": "string"
   }
}
```

## Response Elements
<a name="API_CreateView_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [View](#API_CreateView_ResponseSyntax) **   <a name="connect-CreateView-response-View"></a>
A view resource object. Contains metadata and content necessary to render the view.  
Type: [View](API_View.md) object

## Errors
<a name="API_CreateView_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceInUseException **   
That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.    
 ** ResourceId **   
The identifier for the resource.  
 ** ResourceType **   
The type of resource.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** TooManyRequestsException **   
Displayed when rate-related API limits are exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateView_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateView) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateView) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateView) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateView) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateView) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateView) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateView) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateView) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateView) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateView) 

# CreateViewVersion
<a name="API_CreateViewVersion"></a>

Publishes a new version of the view identifier.

Versions are immutable and monotonically increasing.

It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the `$LATEST` alias.

## Request Syntax
<a name="API_CreateViewVersion_RequestSyntax"></a>

```
PUT /views/InstanceId/ViewId/versions HTTP/1.1
Content-type: application/json

{
   "VersionDescription": "string",
   "ViewContentSha256": "string"
}
```

## URI Request Parameters
<a name="API_CreateViewVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateViewVersion_RequestSyntax) **   <a name="connect-CreateViewVersion-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9\_\-:\/]+$`   
Required: Yes

 ** [ViewId](#API_CreateViewVersion_RequestSyntax) **   <a name="connect-CreateViewVersion-request-uri-ViewId"></a>
The identifier of the view. Both `ViewArn` and `ViewId` can be used.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Pattern: `^[a-zA-Z0-9\_\-:\/$]+$`   
Required: Yes

## Request Body
<a name="API_CreateViewVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [VersionDescription](#API_CreateViewVersion_RequestSyntax) **   <a name="connect-CreateViewVersion-request-VersionDescription"></a>
The description for the version being published.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `^([\p{L}\p{N}_.:\/=+\-@,()']+[\p{L}\p{Z}\p{N}_.:\/=+\-@,()']*)$`   
Required: No

 ** [ViewContentSha256](#API_CreateViewVersion_RequestSyntax) **   <a name="connect-CreateViewVersion-request-ViewContentSha256"></a>
Indicates the checksum value of the latest published view content.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9]$`   
Required: No

## Response Syntax
<a name="API_CreateViewVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "View": { 
      "Arn": "string",
      "Content": { 
         "Actions": [ "string" ],
         "InputSchema": "string",
         "Template": "string"
      },
      "CreatedTime": number,
      "Description": "string",
      "Id": "string",
      "LastModifiedTime": number,
      "Name": "string",
      "Status": "string",
      "Tags": { 
         "string" : "string" 
      },
      "Type": "string",
      "Version": number,
      "VersionDescription": "string",
      "ViewContentSha256": "string"
   }
}
```

## Response Elements
<a name="API_CreateViewVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [View](#API_CreateViewVersion_ResponseSyntax) **   <a name="connect-CreateViewVersion-response-View"></a>
All view data is contained within the View object.  
Type: [View](API_View.md) object

## Errors
<a name="API_CreateViewVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceInUseException **   
That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.    
 ** ResourceId **   
The identifier for the resource.  
 ** ResourceType **   
The type of resource.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** TooManyRequestsException **   
Displayed when rate-related API limits are exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateViewVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateViewVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateViewVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateViewVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateViewVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateViewVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateViewVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateViewVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateViewVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateViewVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateViewVersion) 

# CreateVocabulary
<a name="API_CreateVocabulary"></a>

Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language.

## Request Syntax
<a name="API_CreateVocabulary_RequestSyntax"></a>

```
POST /vocabulary/InstanceId HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "Content": "string",
   "LanguageCode": "string",
   "Tags": { 
      "string" : "string" 
   },
   "VocabularyName": "string"
}
```

## URI Request Parameters
<a name="API_CreateVocabulary_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateVocabulary_RequestSyntax) **   <a name="connect-CreateVocabulary-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateVocabulary_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_CreateVocabulary_RequestSyntax) **   <a name="connect-CreateVocabulary-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [Content](#API_CreateVocabulary_RequestSyntax) **   <a name="connect-CreateVocabulary-request-Content"></a>
The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with `Phrase`, `IPA`, `SoundsLike`, and `DisplayAs` fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see [Create a custom vocabulary using a table](https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 60000.  
Required: Yes

 ** [LanguageCode](#API_CreateVocabulary_RequestSyntax) **   <a name="connect-CreateVocabulary-request-LanguageCode"></a>
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see [What is Amazon Transcribe?](https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html)   
Type: String  
Valid Values: `ar-AE | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fr-CA | fr-FR | hi-IN | it-IT | ja-JP | ko-KR | pt-BR | pt-PT | zh-CN | en-NZ | en-ZA | ca-ES | da-DK | fi-FI | id-ID | ms-MY | nl-NL | no-NO | pl-PL | sv-SE | tl-PH`   
Required: Yes

 ** [Tags](#API_CreateVocabulary_RequestSyntax) **   <a name="connect-CreateVocabulary-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

 ** [VocabularyName](#API_CreateVocabulary_RequestSyntax) **   <a name="connect-CreateVocabulary-request-VocabularyName"></a>
A unique name of the custom vocabulary.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 140.  
Pattern: `^[0-9a-zA-Z._-]+`   
Required: Yes

## Response Syntax
<a name="API_CreateVocabulary_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "State": "string",
   "VocabularyArn": "string",
   "VocabularyId": "string"
}
```

## Response Elements
<a name="API_CreateVocabulary_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [State](#API_CreateVocabulary_ResponseSyntax) **   <a name="connect-CreateVocabulary-response-State"></a>
The current state of the custom vocabulary.  
Type: String  
Valid Values: `CREATION_IN_PROGRESS | ACTIVE | CREATION_FAILED | DELETE_IN_PROGRESS` 

 ** [VocabularyArn](#API_CreateVocabulary_ResponseSyntax) **   <a name="connect-CreateVocabulary-response-VocabularyArn"></a>
The Amazon Resource Name (ARN) of the custom vocabulary.  
Type: String

 ** [VocabularyId](#API_CreateVocabulary_ResponseSyntax) **   <a name="connect-CreateVocabulary-response-VocabularyId"></a>
The identifier of the custom vocabulary.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_CreateVocabulary_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateVocabulary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateVocabulary) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateVocabulary) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateVocabulary) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateVocabulary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateVocabulary) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateVocabulary) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateVocabulary) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateVocabulary) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateVocabulary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateVocabulary) 

# CreateWorkspace
<a name="API_CreateWorkspace"></a>

Creates a workspace that defines the user experience by mapping views to pages. Workspaces can be assigned to users or routing profiles.

## Request Syntax
<a name="API_CreateWorkspace_RequestSyntax"></a>

```
PUT /workspaces/InstanceId HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "Tags": { 
      "string" : "string" 
   },
   "Theme": { 
      "Dark": { 
         "Images": { 
            "Logo": { 
               "Default": "string",
               "Favicon": "string"
            }
         },
         "Palette": { 
            "Canvas": { 
               "ActiveBackground": "string",
               "ContainerBackground": "string",
               "PageBackground": "string"
            },
            "Header": { 
               "Background": "string",
               "InvertActionsColors": boolean,
               "Text": "string",
               "TextHover": "string"
            },
            "Navigation": { 
               "Background": "string",
               "InvertActionsColors": boolean,
               "Text": "string",
               "TextActive": "string",
               "TextBackgroundActive": "string",
               "TextBackgroundHover": "string",
               "TextHover": "string"
            },
            "Primary": { 
               "Active": "string",
               "ContrastText": "string",
               "Default": "string"
            }
         },
         "Typography": { 
            "FontFamily": { 
               "Default": "string"
            }
         }
      },
      "Light": { 
         "Images": { 
            "Logo": { 
               "Default": "string",
               "Favicon": "string"
            }
         },
         "Palette": { 
            "Canvas": { 
               "ActiveBackground": "string",
               "ContainerBackground": "string",
               "PageBackground": "string"
            },
            "Header": { 
               "Background": "string",
               "InvertActionsColors": boolean,
               "Text": "string",
               "TextHover": "string"
            },
            "Navigation": { 
               "Background": "string",
               "InvertActionsColors": boolean,
               "Text": "string",
               "TextActive": "string",
               "TextBackgroundActive": "string",
               "TextBackgroundHover": "string",
               "TextHover": "string"
            },
            "Primary": { 
               "Active": "string",
               "ContrastText": "string",
               "Default": "string"
            }
         },
         "Typography": { 
            "FontFamily": { 
               "Default": "string"
            }
         }
      }
   },
   "Title": "string"
}
```

## URI Request Parameters
<a name="API_CreateWorkspace_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateWorkspace_RequestSyntax) **   <a name="connect-CreateWorkspace-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_CreateWorkspace_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_CreateWorkspace_RequestSyntax) **   <a name="connect-CreateWorkspace-request-Description"></a>
The description of the workspace. Maximum length is 250 characters.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Pattern: `^[\\P{C}\r\n\t]*$`   
Required: No

 ** [Name](#API_CreateWorkspace_RequestSyntax) **   <a name="connect-CreateWorkspace-request-Name"></a>
The name of the workspace. Must be unique within the instance and can contain 1-127 characters.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `.*\\S.*`   
Required: Yes

 ** [Tags](#API_CreateWorkspace_RequestSyntax) **   <a name="connect-CreateWorkspace-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, `{ "Tags": {"key1":"value1", "key2":"value2"} }`.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

 ** [Theme](#API_CreateWorkspace_RequestSyntax) **   <a name="connect-CreateWorkspace-request-Theme"></a>
The theme configuration for the workspace, including colors and styling.  
Type: [WorkspaceTheme](API_WorkspaceTheme.md) object  
Required: No

 ** [Title](#API_CreateWorkspace_RequestSyntax) **   <a name="connect-CreateWorkspace-request-Title"></a>
The title displayed for the workspace.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 127.  
Pattern: `^[\\P{C}]*$`   
Required: No

## Response Syntax
<a name="API_CreateWorkspace_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "WorkspaceArn": "string",
   "WorkspaceId": "string"
}
```

## Response Elements
<a name="API_CreateWorkspace_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [WorkspaceArn](#API_CreateWorkspace_ResponseSyntax) **   <a name="connect-CreateWorkspace-response-WorkspaceArn"></a>
The Amazon Resource Name (ARN) of the workspace.  
Type: String

 ** [WorkspaceId](#API_CreateWorkspace_ResponseSyntax) **   <a name="connect-CreateWorkspace-response-WorkspaceId"></a>
The identifier of the workspace.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_CreateWorkspace_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateWorkspace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateWorkspace) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateWorkspace) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateWorkspace) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateWorkspace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateWorkspace) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateWorkspace) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateWorkspace) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateWorkspace) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateWorkspace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateWorkspace) 

# CreateWorkspacePage
<a name="API_CreateWorkspacePage"></a>

Associates a view with a page in a workspace, defining what users see when they navigate to that page.

## Request Syntax
<a name="API_CreateWorkspacePage_RequestSyntax"></a>

```
PUT /workspaces/InstanceId/WorkspaceId/pages HTTP/1.1
Content-type: application/json

{
   "InputData": "string",
   "Page": "string",
   "ResourceArn": "string",
   "Slug": "string"
}
```

## URI Request Parameters
<a name="API_CreateWorkspacePage_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_CreateWorkspacePage_RequestSyntax) **   <a name="connect-CreateWorkspacePage-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [WorkspaceId](#API_CreateWorkspacePage_RequestSyntax) **   <a name="connect-CreateWorkspacePage-request-uri-WorkspaceId"></a>
The identifier of the workspace.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_CreateWorkspacePage_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InputData](#API_CreateWorkspacePage_RequestSyntax) **   <a name="connect-CreateWorkspacePage-request-InputData"></a>
A JSON string containing input parameters for the view, validated against the view's input schema.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.  
Required: No

 ** [Page](#API_CreateWorkspacePage_RequestSyntax) **   <a name="connect-CreateWorkspacePage-request-Page"></a>
The page identifier. Valid system pages include `HOME` and `AGENT_EXPERIENCE`. Custom pages cannot use the `aws:` or `connect:` prefixes.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 25.  
Pattern: `^(?!\\.$)(?!\\.\\.$)[\\p{L}\\p{Z}\\p{N}\\-_.:=@'|]+$`   
Required: Yes

 ** [ResourceArn](#API_CreateWorkspacePage_RequestSyntax) **   <a name="connect-CreateWorkspacePage-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the view to associate with the page.  
Type: String  
Required: Yes

 ** [Slug](#API_CreateWorkspacePage_RequestSyntax) **   <a name="connect-CreateWorkspacePage-request-Slug"></a>
The URL-friendly identifier for the page.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 63.  
Pattern: `^$|^[\\p{L}\\p{Z}\\p{N}\\-_.:=@'|]{3,}$`   
Required: No

## Response Syntax
<a name="API_CreateWorkspacePage_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_CreateWorkspacePage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_CreateWorkspacePage_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_CreateWorkspacePage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/CreateWorkspacePage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/CreateWorkspacePage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/CreateWorkspacePage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/CreateWorkspacePage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/CreateWorkspacePage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/CreateWorkspacePage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/CreateWorkspacePage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/CreateWorkspacePage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/CreateWorkspacePage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/CreateWorkspacePage) 

# DeactivateEvaluationForm
<a name="API_DeactivateEvaluationForm"></a>

Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form. 

## Request Syntax
<a name="API_DeactivateEvaluationForm_RequestSyntax"></a>

```
POST /evaluation-forms/InstanceId/EvaluationFormId/deactivate HTTP/1.1
Content-type: application/json

{
   "EvaluationFormVersion": number
}
```

## URI Request Parameters
<a name="API_DeactivateEvaluationForm_RequestParameters"></a>

The request uses the following URI parameters.

 ** [EvaluationFormId](#API_DeactivateEvaluationForm_RequestSyntax) **   <a name="connect-DeactivateEvaluationForm-request-uri-EvaluationFormId"></a>
The unique identifier for the evaluation form.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [InstanceId](#API_DeactivateEvaluationForm_RequestSyntax) **   <a name="connect-DeactivateEvaluationForm-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DeactivateEvaluationForm_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [EvaluationFormVersion](#API_DeactivateEvaluationForm_RequestSyntax) **   <a name="connect-DeactivateEvaluationForm-request-EvaluationFormVersion"></a>
A version of the evaluation form. If the version property is not provided, the latest version of the evaluation form is deactivated.  
Type: Integer  
Required: Yes

## Response Syntax
<a name="API_DeactivateEvaluationForm_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EvaluationFormArn": "string",
   "EvaluationFormId": "string",
   "EvaluationFormVersion": number
}
```

## Response Elements
<a name="API_DeactivateEvaluationForm_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EvaluationFormArn](#API_DeactivateEvaluationForm_ResponseSyntax) **   <a name="connect-DeactivateEvaluationForm-response-EvaluationFormArn"></a>
The Amazon Resource Name (ARN) for the evaluation form resource.  
Type: String

 ** [EvaluationFormId](#API_DeactivateEvaluationForm_ResponseSyntax) **   <a name="connect-DeactivateEvaluationForm-response-EvaluationFormId"></a>
The unique identifier for the evaluation form.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [EvaluationFormVersion](#API_DeactivateEvaluationForm_ResponseSyntax) **   <a name="connect-DeactivateEvaluationForm-response-EvaluationFormVersion"></a>
The version of the deactivated evaluation form resource.  
Type: Integer

## Errors
<a name="API_DeactivateEvaluationForm_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_DeactivateEvaluationForm_Examples"></a>

### Example
<a name="API_DeactivateEvaluationForm_Example_1"></a>

The following example deactivates version 3 of the evaluation form. 

#### Sample Request
<a name="API_DeactivateEvaluationForm_Example_1_Request"></a>

```
{
   "InstanceId": "[instance_id]",
   "EvaluationFormId": "[evaluation_form_id]",
   "EvaluationFormVersion": 3
}
```

#### Sample Response
<a name="API_DeactivateEvaluationForm_Example_1_Response"></a>

```
{
   "EvaluationFormId": "[evaluation_form_id]",
   "EvaluationFormArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/evaluation-form/[evaluation_form_id]",
   "EvaluationFormVersion": 3
}
```

## See Also
<a name="API_DeactivateEvaluationForm_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeactivateEvaluationForm) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeactivateEvaluationForm) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeactivateEvaluationForm) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeactivateEvaluationForm) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeactivateEvaluationForm) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeactivateEvaluationForm) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeactivateEvaluationForm) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeactivateEvaluationForm) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeactivateEvaluationForm) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeactivateEvaluationForm) 

# DeleteAttachedFile
<a name="API_DeleteAttachedFile"></a>

Deletes an attached file along with the underlying S3 Object.

**Important**  
The attached file is **permanently deleted** if S3 bucket versioning is not enabled.

## Request Syntax
<a name="API_DeleteAttachedFile_RequestSyntax"></a>

```
DELETE /attached-files/InstanceId/FileId?associatedResourceArn=AssociatedResourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteAttachedFile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AssociatedResourceArn](#API_DeleteAttachedFile_RequestSyntax) **   <a name="connect-DeleteAttachedFile-request-uri-AssociatedResourceArn"></a>
The resource to which the attached file is (being) uploaded to. [Cases](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html) are the only current supported resource.  
This value must be a valid ARN.
Required: Yes

 ** [FileId](#API_DeleteAttachedFile_RequestSyntax) **   <a name="connect-DeleteAttachedFile-request-uri-FileId"></a>
The unique identifier of the attached file resource.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_DeleteAttachedFile_RequestSyntax) **   <a name="connect-DeleteAttachedFile-request-uri-InstanceId"></a>
The unique identifier of the Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DeleteAttachedFile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteAttachedFile_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteAttachedFile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteAttachedFile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteAttachedFile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteAttachedFile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteAttachedFile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteAttachedFile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteAttachedFile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteAttachedFile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteAttachedFile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteAttachedFile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteAttachedFile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteAttachedFile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteAttachedFile) 

# DeleteContactEvaluation
<a name="API_DeleteContactEvaluation"></a>

Deletes a contact evaluation in the specified Amazon Connect instance.

## Request Syntax
<a name="API_DeleteContactEvaluation_RequestSyntax"></a>

```
DELETE /contact-evaluations/InstanceId/EvaluationId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteContactEvaluation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [EvaluationId](#API_DeleteContactEvaluation_RequestSyntax) **   <a name="connect-DeleteContactEvaluation-request-uri-EvaluationId"></a>
A unique identifier for the contact evaluation.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [InstanceId](#API_DeleteContactEvaluation_RequestSyntax) **   <a name="connect-DeleteContactEvaluation-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DeleteContactEvaluation_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteContactEvaluation_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteContactEvaluation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteContactEvaluation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_DeleteContactEvaluation_Examples"></a>

### Example
<a name="API_DeleteContactEvaluation_Example_1"></a>

The following example deletes a contact evaluation.

#### Sample Request
<a name="API_DeleteContactEvaluation_Example_1_Request"></a>

```
{
   "InstanceId": "[instance_id]",
   "EvaluationId": "[evaluation_id]"
}
```

#### Sample Response
<a name="API_DeleteContactEvaluation_Example_1_Response"></a>

```
(empty response)
```

## See Also
<a name="API_DeleteContactEvaluation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteContactEvaluation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteContactEvaluation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteContactEvaluation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteContactEvaluation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteContactEvaluation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteContactEvaluation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteContactEvaluation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteContactEvaluation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteContactEvaluation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteContactEvaluation) 

# DeleteContactFlow
<a name="API_DeleteContactFlow"></a>

Deletes a flow for the specified Amazon Connect instance.

## Request Syntax
<a name="API_DeleteContactFlow_RequestSyntax"></a>

```
DELETE /contact-flows/InstanceId/ContactFlowId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteContactFlow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactFlowId](#API_DeleteContactFlow_RequestSyntax) **   <a name="connect-DeleteContactFlow-request-uri-ContactFlowId"></a>
The identifier of the flow.  
Length Constraints: Maximum length of 500.  
Required: Yes

 ** [InstanceId](#API_DeleteContactFlow_RequestSyntax) **   <a name="connect-DeleteContactFlow-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DeleteContactFlow_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteContactFlow_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteContactFlow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteContactFlow_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteContactFlow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteContactFlow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteContactFlow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteContactFlow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteContactFlow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteContactFlow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteContactFlow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteContactFlow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteContactFlow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteContactFlow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteContactFlow) 

# DeleteContactFlowModule
<a name="API_DeleteContactFlowModule"></a>

Deletes the specified flow module.

## Request Syntax
<a name="API_DeleteContactFlowModule_RequestSyntax"></a>

```
DELETE /contact-flow-modules/InstanceId/ContactFlowModuleId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteContactFlowModule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactFlowModuleId](#API_DeleteContactFlowModule_RequestSyntax) **   <a name="connect-DeleteContactFlowModule-request-uri-ContactFlowModuleId"></a>
The identifier of the flow module.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_DeleteContactFlowModule_RequestSyntax) **   <a name="connect-DeleteContactFlowModule-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DeleteContactFlowModule_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteContactFlowModule_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteContactFlowModule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteContactFlowModule_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteContactFlowModule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteContactFlowModule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteContactFlowModule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteContactFlowModule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteContactFlowModule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteContactFlowModule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteContactFlowModule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteContactFlowModule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteContactFlowModule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteContactFlowModule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteContactFlowModule) 

# DeleteContactFlowModuleAlias
<a name="API_DeleteContactFlowModuleAlias"></a>

Removes an alias reference, breaking the named connection to the underlying module version without affecting the version itself.

## Request Syntax
<a name="API_DeleteContactFlowModuleAlias_RequestSyntax"></a>

```
DELETE /contact-flow-modules/InstanceId/ContactFlowModuleId/alias/AliasId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteContactFlowModuleAlias_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AliasId](#API_DeleteContactFlowModuleAlias_RequestSyntax) **   <a name="connect-DeleteContactFlowModuleAlias-request-uri-AliasId"></a>
The identifier of the alias.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [ContactFlowModuleId](#API_DeleteContactFlowModuleAlias_RequestSyntax) **   <a name="connect-DeleteContactFlowModuleAlias-request-uri-ContactFlowModuleId"></a>
The identifier of the flow module.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [InstanceId](#API_DeleteContactFlowModuleAlias_RequestSyntax) **   <a name="connect-DeleteContactFlowModuleAlias-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

## Request Body
<a name="API_DeleteContactFlowModuleAlias_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteContactFlowModuleAlias_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteContactFlowModuleAlias_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteContactFlowModuleAlias_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_DeleteContactFlowModuleAlias_Examples"></a>

### Sample Request
<a name="API_DeleteContactFlowModuleAlias_Example_1"></a>

This example illustrates one usage of DeleteContactFlowModuleAlias.

```
DELETE /contact-flow-modules/12345678-1234-1234-1234-123456789012/abcdefgh-1234-5678-9012-abcdefghijkl/alias/alias-12345678
```

### Sample Response
<a name="API_DeleteContactFlowModuleAlias_Example_2"></a>

This example illustrates one usage of DeleteContactFlowModuleAlias.

```
HTTP/1.1 200 OK
```

## See Also
<a name="API_DeleteContactFlowModuleAlias_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteContactFlowModuleAlias) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteContactFlowModuleAlias) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteContactFlowModuleAlias) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteContactFlowModuleAlias) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteContactFlowModuleAlias) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteContactFlowModuleAlias) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteContactFlowModuleAlias) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteContactFlowModuleAlias) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteContactFlowModuleAlias) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteContactFlowModuleAlias) 

# DeleteContactFlowModuleVersion
<a name="API_DeleteContactFlowModuleVersion"></a>

Removes a specific version of a contact flow module.

## Request Syntax
<a name="API_DeleteContactFlowModuleVersion_RequestSyntax"></a>

```
DELETE /contact-flow-modules/InstanceId/ContactFlowModuleId/version/ContactFlowModuleVersion HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteContactFlowModuleVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactFlowModuleId](#API_DeleteContactFlowModuleVersion_RequestSyntax) **   <a name="connect-DeleteContactFlowModuleVersion-request-uri-ContactFlowModuleId"></a>
The identifier of the flow module.  
Required: Yes

 ** [ContactFlowModuleVersion](#API_DeleteContactFlowModuleVersion_RequestSyntax) **   <a name="connect-DeleteContactFlowModuleVersion-request-uri-ContactFlowModuleVersion"></a>
The version of the flow module to delete.  
Valid Range: Minimum value of 1.  
Required: Yes

 ** [InstanceId](#API_DeleteContactFlowModuleVersion_RequestSyntax) **   <a name="connect-DeleteContactFlowModuleVersion-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DeleteContactFlowModuleVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteContactFlowModuleVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteContactFlowModuleVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteContactFlowModuleVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_DeleteContactFlowModuleVersion_Examples"></a>

### Sample Request
<a name="API_DeleteContactFlowModuleVersion_Example_1"></a>

This example illustrates one usage of DeleteContactFlowModuleVersion.

```
DELETE /contact-flow-modules/12345678-1234-1234-1234-123456789012/abcdefgh-1234-5678-9012-abcdefghijkl/version/2
```

### Sample Response
<a name="API_DeleteContactFlowModuleVersion_Example_2"></a>

This example illustrates one usage of DeleteContactFlowModuleVersion.

```
HTTP/1.1 200 OK
```

## See Also
<a name="API_DeleteContactFlowModuleVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteContactFlowModuleVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteContactFlowModuleVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteContactFlowModuleVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteContactFlowModuleVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteContactFlowModuleVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteContactFlowModuleVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteContactFlowModuleVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteContactFlowModuleVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteContactFlowModuleVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteContactFlowModuleVersion) 

# DeleteContactFlowVersion
<a name="API_DeleteContactFlowVersion"></a>

Deletes the particular version specified in flow version identifier.

## Request Syntax
<a name="API_DeleteContactFlowVersion_RequestSyntax"></a>

```
DELETE /contact-flows/InstanceId/ContactFlowId/version/ContactFlowVersion HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteContactFlowVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactFlowId](#API_DeleteContactFlowVersion_RequestSyntax) **   <a name="connect-DeleteContactFlowVersion-request-uri-ContactFlowId"></a>
The identifier of the flow.  
Required: Yes

 ** [ContactFlowVersion](#API_DeleteContactFlowVersion_RequestSyntax) **   <a name="connect-DeleteContactFlowVersion-request-uri-ContactFlowVersion"></a>
The identifier of the flow version.  
Valid Range: Minimum value of 1.  
Required: Yes

 ** [InstanceId](#API_DeleteContactFlowVersion_RequestSyntax) **   <a name="connect-DeleteContactFlowVersion-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DeleteContactFlowVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteContactFlowVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteContactFlowVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteContactFlowVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteContactFlowVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteContactFlowVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteContactFlowVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteContactFlowVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteContactFlowVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteContactFlowVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteContactFlowVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteContactFlowVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteContactFlowVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteContactFlowVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteContactFlowVersion) 

# DeleteDataTable
<a name="API_DeleteDataTable"></a>

Deletes a data table and all associated attributes, versions, audits, and values. Does not update any references to the data table, even from other data tables. This includes dynamic values and conditional validations. System managed data tables are not deletable by customers. API users may delete the table at any time. When deletion is requested from the admin website, a warning is shown alerting the user of the most recent time the table and its values were accessed.

## Request Syntax
<a name="API_DeleteDataTable_RequestSyntax"></a>

```
DELETE /data-tables/InstanceId/DataTableId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteDataTable_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DataTableId](#API_DeleteDataTable_RequestSyntax) **   <a name="connect-DeleteDataTable-request-uri-DataTableId"></a>
The unique identifier for the data table to delete. Must also accept the table ARN. Fails with an error if the version is provided and is not \$1LATEST.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_DeleteDataTable_RequestSyntax) **   <a name="connect-DeleteDataTable-request-uri-InstanceId"></a>
The unique identifier for the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DeleteDataTable_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteDataTable_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteDataTable_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteDataTable_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
Operation cannot be performed at this time as there is a conflict with another operation or contact state.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteDataTable_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteDataTable) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteDataTable) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteDataTable) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteDataTable) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteDataTable) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteDataTable) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteDataTable) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteDataTable) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteDataTable) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteDataTable) 

# DeleteDataTableAttribute
<a name="API_DeleteDataTableAttribute"></a>

Deletes an attribute and all its values from a data table.

## Request Syntax
<a name="API_DeleteDataTableAttribute_RequestSyntax"></a>

```
DELETE /data-tables/InstanceId/DataTableId/attributes/AttributeName HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteDataTableAttribute_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AttributeName](#API_DeleteDataTableAttribute_RequestSyntax) **   <a name="connect-DeleteDataTableAttribute-request-uri-AttributeName"></a>
The name of the attribute to delete.  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `^[\p{L}\p{Z}\p{N}\-_.:=@'|]+$`   
Required: Yes

 ** [DataTableId](#API_DeleteDataTableAttribute_RequestSyntax) **   <a name="connect-DeleteDataTableAttribute-request-uri-DataTableId"></a>
The unique identifier for the data table.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_DeleteDataTableAttribute_RequestSyntax) **   <a name="connect-DeleteDataTableAttribute-request-uri-InstanceId"></a>
The unique identifier for the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DeleteDataTableAttribute_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteDataTableAttribute_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "LockVersion": { 
      "Attribute": "string",
      "DataTable": "string",
      "PrimaryValues": "string",
      "Value": "string"
   }
}
```

## Response Elements
<a name="API_DeleteDataTableAttribute_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LockVersion](#API_DeleteDataTableAttribute_ResponseSyntax) **   <a name="connect-DeleteDataTableAttribute-response-LockVersion"></a>
The updated lock version of the data table.  
Type: [DataTableLockVersion](API_DataTableLockVersion.md) object

## Errors
<a name="API_DeleteDataTableAttribute_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
Operation cannot be performed at this time as there is a conflict with another operation or contact state.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteDataTableAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteDataTableAttribute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteDataTableAttribute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteDataTableAttribute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteDataTableAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteDataTableAttribute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteDataTableAttribute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteDataTableAttribute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteDataTableAttribute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteDataTableAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteDataTableAttribute) 

# DeleteEmailAddress
<a name="API_DeleteEmailAddress"></a>

Deletes email address from the specified Amazon Connect instance.

## Request Syntax
<a name="API_DeleteEmailAddress_RequestSyntax"></a>

```
DELETE /email-addresses/InstanceId/EmailAddressId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteEmailAddress_RequestParameters"></a>

The request uses the following URI parameters.

 ** [EmailAddressId](#API_DeleteEmailAddress_RequestSyntax) **   <a name="connect-DeleteEmailAddress-request-uri-EmailAddressId"></a>
The identifier of the email address.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [InstanceId](#API_DeleteEmailAddress_RequestSyntax) **   <a name="connect-DeleteEmailAddress-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DeleteEmailAddress_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteEmailAddress_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteEmailAddress_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteEmailAddress_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteEmailAddress_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteEmailAddress) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteEmailAddress) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteEmailAddress) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteEmailAddress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteEmailAddress) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteEmailAddress) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteEmailAddress) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteEmailAddress) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteEmailAddress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteEmailAddress) 

# DeleteEvaluationForm
<a name="API_DeleteEvaluationForm"></a>

Deletes an evaluation form in the specified Amazon Connect instance. 
+ If the version property is provided, only the specified version of the evaluation form is deleted.
+ If no version is provided, then the full form (all versions) is deleted.

## Request Syntax
<a name="API_DeleteEvaluationForm_RequestSyntax"></a>

```
DELETE /evaluation-forms/InstanceId/EvaluationFormId?version=EvaluationFormVersion HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteEvaluationForm_RequestParameters"></a>

The request uses the following URI parameters.

 ** [EvaluationFormId](#API_DeleteEvaluationForm_RequestSyntax) **   <a name="connect-DeleteEvaluationForm-request-uri-EvaluationFormId"></a>
The unique identifier for the evaluation form.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [EvaluationFormVersion](#API_DeleteEvaluationForm_RequestSyntax) **   <a name="connect-DeleteEvaluationForm-request-uri-EvaluationFormVersion"></a>
The unique identifier for the evaluation form.

 ** [InstanceId](#API_DeleteEvaluationForm_RequestSyntax) **   <a name="connect-DeleteEvaluationForm-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DeleteEvaluationForm_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteEvaluationForm_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteEvaluationForm_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteEvaluationForm_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_DeleteEvaluationForm_Examples"></a>

### Example
<a name="API_DeleteEvaluationForm_Example_1"></a>

The following example deletes version 1 of an evaluation form.

#### Sample Request
<a name="API_DeleteEvaluationForm_Example_1_Request"></a>

```
{
   "InstanceId": "[instance_id]",
   "EvaluationFormId": "[evaluation_form_id]",
   "EvaluationFormVersion": 1
}
```

#### Sample Response
<a name="API_DeleteEvaluationForm_Example_1_Response"></a>

```
(empty)
```

## See Also
<a name="API_DeleteEvaluationForm_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteEvaluationForm) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteEvaluationForm) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteEvaluationForm) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteEvaluationForm) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteEvaluationForm) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteEvaluationForm) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteEvaluationForm) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteEvaluationForm) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteEvaluationForm) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteEvaluationForm) 

# DeleteHoursOfOperation
<a name="API_DeleteHoursOfOperation"></a>

Deletes an hours of operation.

## Request Syntax
<a name="API_DeleteHoursOfOperation_RequestSyntax"></a>

```
DELETE /hours-of-operations/InstanceId/HoursOfOperationId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteHoursOfOperation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [HoursOfOperationId](#API_DeleteHoursOfOperation_RequestSyntax) **   <a name="connect-DeleteHoursOfOperation-request-uri-HoursOfOperationId"></a>
The identifier for the hours of operation.  
Required: Yes

 ** [InstanceId](#API_DeleteHoursOfOperation_RequestSyntax) **   <a name="connect-DeleteHoursOfOperation-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DeleteHoursOfOperation_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteHoursOfOperation_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteHoursOfOperation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteHoursOfOperation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteHoursOfOperation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteHoursOfOperation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteHoursOfOperation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteHoursOfOperation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteHoursOfOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteHoursOfOperation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteHoursOfOperation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteHoursOfOperation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteHoursOfOperation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteHoursOfOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteHoursOfOperation) 

# DeleteHoursOfOperationOverride
<a name="API_DeleteHoursOfOperationOverride"></a>

Deletes an hours of operation override in an Amazon Connect hours of operation resource.

## Request Syntax
<a name="API_DeleteHoursOfOperationOverride_RequestSyntax"></a>

```
DELETE /hours-of-operations/InstanceId/HoursOfOperationId/overrides/HoursOfOperationOverrideId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteHoursOfOperationOverride_RequestParameters"></a>

The request uses the following URI parameters.

 ** [HoursOfOperationId](#API_DeleteHoursOfOperationOverride_RequestSyntax) **   <a name="connect-DeleteHoursOfOperationOverride-request-uri-HoursOfOperationId"></a>
The identifier for the hours of operation.  
Required: Yes

 ** [HoursOfOperationOverrideId](#API_DeleteHoursOfOperationOverride_RequestSyntax) **   <a name="connect-DeleteHoursOfOperationOverride-request-uri-HoursOfOperationOverrideId"></a>
The identifier for the hours of operation override.  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Required: Yes

 ** [InstanceId](#API_DeleteHoursOfOperationOverride_RequestSyntax) **   <a name="connect-DeleteHoursOfOperationOverride-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DeleteHoursOfOperationOverride_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteHoursOfOperationOverride_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteHoursOfOperationOverride_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteHoursOfOperationOverride_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteHoursOfOperationOverride_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteHoursOfOperationOverride) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteHoursOfOperationOverride) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteHoursOfOperationOverride) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteHoursOfOperationOverride) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteHoursOfOperationOverride) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteHoursOfOperationOverride) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteHoursOfOperationOverride) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteHoursOfOperationOverride) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteHoursOfOperationOverride) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteHoursOfOperationOverride) 

# DeleteInstance
<a name="API_DeleteInstance"></a>

This API is in preview release for Amazon Connect and is subject to change.

Deletes the Amazon Connect instance. For more information, see [Delete your Amazon Connect instance](https://docs.aws.amazon.com/connect/latest/adminguide/delete-connect-instance.html) in the *Amazon Connect Administrator Guide*.

Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. 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. You must wait 30 days before you can restart creating and deleting instances in your account.

## Request Syntax
<a name="API_DeleteInstance_RequestSyntax"></a>

```
DELETE /instance/InstanceId?clientToken=ClientToken HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteInstance_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ClientToken](#API_DeleteInstance_RequestSyntax) **   <a name="connect-DeleteInstance-request-uri-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Length Constraints: Maximum length of 500.

 ** [InstanceId](#API_DeleteInstance_RequestSyntax) **   <a name="connect-DeleteInstance-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DeleteInstance_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteInstance_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteInstance_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

## See Also
<a name="API_DeleteInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteInstance) 

# DeleteIntegrationAssociation
<a name="API_DeleteIntegrationAssociation"></a>

Deletes an AWS resource association from an Amazon Connect instance. The association must not have any use cases associated with it.

## Request Syntax
<a name="API_DeleteIntegrationAssociation_RequestSyntax"></a>

```
DELETE /instance/InstanceId/integration-associations/IntegrationAssociationId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteIntegrationAssociation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DeleteIntegrationAssociation_RequestSyntax) **   <a name="connect-DeleteIntegrationAssociation-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [IntegrationAssociationId](#API_DeleteIntegrationAssociation_RequestSyntax) **   <a name="connect-DeleteIntegrationAssociation-request-uri-IntegrationAssociationId"></a>
The identifier for the integration association.  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: Yes

## Request Body
<a name="API_DeleteIntegrationAssociation_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteIntegrationAssociation_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteIntegrationAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteIntegrationAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteIntegrationAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteIntegrationAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteIntegrationAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteIntegrationAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteIntegrationAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteIntegrationAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteIntegrationAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteIntegrationAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteIntegrationAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteIntegrationAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteIntegrationAssociation) 

# DeleteNotification
<a name="API_DeleteNotification"></a>

Deletes a notification. Once deleted, the notification is no longer visible to all users and cannot be managed through the Admin Website or APIs.

## Request Syntax
<a name="API_DeleteNotification_RequestSyntax"></a>

```
DELETE /notifications/InstanceId/NotificationId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteNotification_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DeleteNotification_RequestSyntax) **   <a name="connect-DeleteNotification-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [NotificationId](#API_DeleteNotification_RequestSyntax) **   <a name="connect-DeleteNotification-request-uri-NotificationId"></a>
The unique identifier for the notification to delete.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_DeleteNotification_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteNotification_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteNotification_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteNotification_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteNotification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteNotification) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteNotification) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteNotification) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteNotification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteNotification) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteNotification) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteNotification) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteNotification) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteNotification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteNotification) 

# DeletePredefinedAttribute
<a name="API_DeletePredefinedAttribute"></a>

Deletes a predefined attribute from the specified Amazon Connect instance.

## Request Syntax
<a name="API_DeletePredefinedAttribute_RequestSyntax"></a>

```
DELETE /predefined-attributes/InstanceId/Name HTTP/1.1
```

## URI Request Parameters
<a name="API_DeletePredefinedAttribute_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DeletePredefinedAttribute_RequestSyntax) **   <a name="connect-DeletePredefinedAttribute-request-uri-InstanceId"></a>
 The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [Name](#API_DeletePredefinedAttribute_RequestSyntax) **   <a name="connect-DeletePredefinedAttribute-request-uri-Name"></a>
 The name of the predefined attribute.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DeletePredefinedAttribute_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeletePredefinedAttribute_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeletePredefinedAttribute_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeletePredefinedAttribute_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceInUseException **   
That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.    
 ** ResourceId **   
The identifier for the resource.  
 ** ResourceType **   
The type of resource.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeletePredefinedAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeletePredefinedAttribute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeletePredefinedAttribute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeletePredefinedAttribute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeletePredefinedAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeletePredefinedAttribute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeletePredefinedAttribute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeletePredefinedAttribute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeletePredefinedAttribute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeletePredefinedAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeletePredefinedAttribute) 

# DeletePrompt
<a name="API_DeletePrompt"></a>

Deletes a prompt.

## Request Syntax
<a name="API_DeletePrompt_RequestSyntax"></a>

```
DELETE /prompts/InstanceId/PromptId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeletePrompt_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DeletePrompt_RequestSyntax) **   <a name="connect-DeletePrompt-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [PromptId](#API_DeletePrompt_RequestSyntax) **   <a name="connect-DeletePrompt-request-uri-PromptId"></a>
A unique identifier for the prompt.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_DeletePrompt_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeletePrompt_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeletePrompt_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeletePrompt_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeletePrompt_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeletePrompt) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeletePrompt) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeletePrompt) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeletePrompt) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeletePrompt) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeletePrompt) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeletePrompt) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeletePrompt) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeletePrompt) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeletePrompt) 

# DeletePushNotificationRegistration
<a name="API_DeletePushNotificationRegistration"></a>

Deletes registration for a device token and a chat contact.

## Request Syntax
<a name="API_DeletePushNotificationRegistration_RequestSyntax"></a>

```
DELETE /push-notification/InstanceId/registrations/RegistrationId?contactId=ContactId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeletePushNotificationRegistration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactId](#API_DeletePushNotificationRegistration_RequestSyntax) **   <a name="connect-DeletePushNotificationRegistration-request-uri-ContactId"></a>
The identifier of the contact within the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_DeletePushNotificationRegistration_RequestSyntax) **   <a name="connect-DeletePushNotificationRegistration-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [RegistrationId](#API_DeletePushNotificationRegistration_RequestSyntax) **   <a name="connect-DeletePushNotificationRegistration-request-uri-RegistrationId"></a>
The identifier for the registration.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_DeletePushNotificationRegistration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeletePushNotificationRegistration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeletePushNotificationRegistration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeletePushNotificationRegistration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeletePushNotificationRegistration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeletePushNotificationRegistration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeletePushNotificationRegistration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeletePushNotificationRegistration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeletePushNotificationRegistration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeletePushNotificationRegistration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeletePushNotificationRegistration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeletePushNotificationRegistration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeletePushNotificationRegistration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeletePushNotificationRegistration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeletePushNotificationRegistration) 

# DeleteQueue
<a name="API_DeleteQueue"></a>

Deletes a queue.

## Request Syntax
<a name="API_DeleteQueue_RequestSyntax"></a>

```
DELETE /queues/InstanceId/QueueId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteQueue_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DeleteQueue_RequestSyntax) **   <a name="connect-DeleteQueue-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [QueueId](#API_DeleteQueue_RequestSyntax) **   <a name="connect-DeleteQueue-request-uri-QueueId"></a>
The identifier for the queue.  
Required: Yes

## Request Body
<a name="API_DeleteQueue_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteQueue_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteQueue_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteQueue_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceInUseException **   
That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.    
 ** ResourceId **   
The identifier for the resource.  
 ** ResourceType **   
The type of resource.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteQueue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteQueue) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteQueue) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteQueue) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteQueue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteQueue) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteQueue) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteQueue) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteQueue) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteQueue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteQueue) 

# DeleteQuickConnect
<a name="API_DeleteQuickConnect"></a>

Deletes a quick connect. 

**Important**  
After calling [DeleteUser](https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteUser.html), it's important to call `DeleteQuickConnect` to delete any records related to the deleted users. This will help you:  
Avoid dangling resources that impact your service quotas.
Remove deleted users so they don't appear to agents as transfer options.
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using [Amazon Connect Global Resiliency](https://docs.aws.amazon.com/connect/latest/adminguide/setup-connect-global-resiliency.html). 

## Request Syntax
<a name="API_DeleteQuickConnect_RequestSyntax"></a>

```
DELETE /quick-connects/InstanceId/QuickConnectId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteQuickConnect_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DeleteQuickConnect_RequestSyntax) **   <a name="connect-DeleteQuickConnect-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [QuickConnectId](#API_DeleteQuickConnect_RequestSyntax) **   <a name="connect-DeleteQuickConnect-request-uri-QuickConnectId"></a>
The identifier for the quick connect.  
Required: Yes

## Request Body
<a name="API_DeleteQuickConnect_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteQuickConnect_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteQuickConnect_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteQuickConnect_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteQuickConnect_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteQuickConnect) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteQuickConnect) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteQuickConnect) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteQuickConnect) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteQuickConnect) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteQuickConnect) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteQuickConnect) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteQuickConnect) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteQuickConnect) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteQuickConnect) 

# DeleteRoutingProfile
<a name="API_DeleteRoutingProfile"></a>

Deletes a routing profile.

## Request Syntax
<a name="API_DeleteRoutingProfile_RequestSyntax"></a>

```
DELETE /routing-profiles/InstanceId/RoutingProfileId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteRoutingProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DeleteRoutingProfile_RequestSyntax) **   <a name="connect-DeleteRoutingProfile-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [RoutingProfileId](#API_DeleteRoutingProfile_RequestSyntax) **   <a name="connect-DeleteRoutingProfile-request-uri-RoutingProfileId"></a>
The identifier of the routing profile.  
Required: Yes

## Request Body
<a name="API_DeleteRoutingProfile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteRoutingProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteRoutingProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteRoutingProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceInUseException **   
That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.    
 ** ResourceId **   
The identifier for the resource.  
 ** ResourceType **   
The type of resource.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteRoutingProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteRoutingProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteRoutingProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteRoutingProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteRoutingProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteRoutingProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteRoutingProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteRoutingProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteRoutingProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteRoutingProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteRoutingProfile) 

# DeleteRule
<a name="API_DeleteRule"></a>

Deletes a rule for the specified Amazon Connect instance.

## Request Syntax
<a name="API_DeleteRule_RequestSyntax"></a>

```
DELETE /rules/InstanceId/RuleId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteRule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DeleteRule_RequestSyntax) **   <a name="connect-DeleteRule-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [RuleId](#API_DeleteRule_RequestSyntax) **   <a name="connect-DeleteRule-request-uri-RuleId"></a>
A unique identifier for the rule.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_DeleteRule_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteRule_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteRule) 

# DeleteSecurityProfile
<a name="API_DeleteSecurityProfile"></a>

Deletes a security profile.

## Request Syntax
<a name="API_DeleteSecurityProfile_RequestSyntax"></a>

```
DELETE /security-profiles/InstanceId/SecurityProfileId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteSecurityProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DeleteSecurityProfile_RequestSyntax) **   <a name="connect-DeleteSecurityProfile-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [SecurityProfileId](#API_DeleteSecurityProfile_RequestSyntax) **   <a name="connect-DeleteSecurityProfile-request-uri-SecurityProfileId"></a>
The identifier for the security profle.  
Required: Yes

## Request Body
<a name="API_DeleteSecurityProfile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteSecurityProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteSecurityProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteSecurityProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceInUseException **   
That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.    
 ** ResourceId **   
The identifier for the resource.  
 ** ResourceType **   
The type of resource.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteSecurityProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteSecurityProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteSecurityProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteSecurityProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteSecurityProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteSecurityProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteSecurityProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteSecurityProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteSecurityProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteSecurityProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteSecurityProfile) 

# DeleteTaskTemplate
<a name="API_DeleteTaskTemplate"></a>

Deletes the task template.

## Request Syntax
<a name="API_DeleteTaskTemplate_RequestSyntax"></a>

```
DELETE /instance/InstanceId/task/template/TaskTemplateId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteTaskTemplate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DeleteTaskTemplate_RequestSyntax) **   <a name="connect-DeleteTaskTemplate-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [TaskTemplateId](#API_DeleteTaskTemplate_RequestSyntax) **   <a name="connect-DeleteTaskTemplate-request-uri-TaskTemplateId"></a>
A unique identifier for the task template.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_DeleteTaskTemplate_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteTaskTemplate_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteTaskTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteTaskTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteTaskTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteTaskTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteTaskTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteTaskTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteTaskTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteTaskTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteTaskTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteTaskTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteTaskTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteTaskTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteTaskTemplate) 

# DeleteTestCase
<a name="API_DeleteTestCase"></a>

Deletes the test case that has already been created for the specified Amazon Connect instance.

## Request Syntax
<a name="API_DeleteTestCase_RequestSyntax"></a>

```
DELETE /test-cases/InstanceId/TestCaseId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteTestCase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DeleteTestCase_RequestSyntax) **   <a name="connect-DeleteTestCase-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

 ** [TestCaseId](#API_DeleteTestCase_RequestSyntax) **   <a name="connect-DeleteTestCase-request-uri-TestCaseId"></a>
The identifier of the test case to delete.  
Length Constraints: Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_DeleteTestCase_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteTestCase_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteTestCase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteTestCase_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteTestCase_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteTestCase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteTestCase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteTestCase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteTestCase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteTestCase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteTestCase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteTestCase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteTestCase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteTestCase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteTestCase) 

# DeleteTrafficDistributionGroup
<a name="API_DeleteTrafficDistributionGroup"></a>

Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

For more information about deleting traffic distribution groups, see [Delete traffic distribution groups](https://docs.aws.amazon.com/connect/latest/adminguide/delete-traffic-distribution-groups.html) in the *Amazon Connect Administrator Guide*.

## Request Syntax
<a name="API_DeleteTrafficDistributionGroup_RequestSyntax"></a>

```
DELETE /traffic-distribution-group/TrafficDistributionGroupId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteTrafficDistributionGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [TrafficDistributionGroupId](#API_DeleteTrafficDistributionGroup_RequestSyntax) **   <a name="connect-DeleteTrafficDistributionGroup-request-uri-TrafficDistributionGroupId"></a>
The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z-]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

## Request Body
<a name="API_DeleteTrafficDistributionGroup_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteTrafficDistributionGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteTrafficDistributionGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteTrafficDistributionGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceInUseException **   
That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.    
 ** ResourceId **   
The identifier for the resource.  
 ** ResourceType **   
The type of resource.
HTTP Status Code: 409

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteTrafficDistributionGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteTrafficDistributionGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteTrafficDistributionGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteTrafficDistributionGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteTrafficDistributionGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteTrafficDistributionGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteTrafficDistributionGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteTrafficDistributionGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteTrafficDistributionGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteTrafficDistributionGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteTrafficDistributionGroup) 

# DeleteUseCase
<a name="API_DeleteUseCase"></a>

Deletes a use case from an integration association.

## Request Syntax
<a name="API_DeleteUseCase_RequestSyntax"></a>

```
DELETE /instance/InstanceId/integration-associations/IntegrationAssociationId/use-cases/UseCaseId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteUseCase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DeleteUseCase_RequestSyntax) **   <a name="connect-DeleteUseCase-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [IntegrationAssociationId](#API_DeleteUseCase_RequestSyntax) **   <a name="connect-DeleteUseCase-request-uri-IntegrationAssociationId"></a>
The identifier for the integration association.  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: Yes

 ** [UseCaseId](#API_DeleteUseCase_RequestSyntax) **   <a name="connect-DeleteUseCase-request-uri-UseCaseId"></a>
The identifier for the use case.  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: Yes

## Request Body
<a name="API_DeleteUseCase_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteUseCase_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteUseCase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteUseCase_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteUseCase_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteUseCase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteUseCase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteUseCase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteUseCase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteUseCase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteUseCase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteUseCase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteUseCase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteUseCase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteUseCase) 

# DeleteUser
<a name="API_DeleteUser"></a>

Deletes a user account from the specified Amazon Connect instance.

For information about what happens to a user's data when their account is deleted, see [Delete Users from Your Amazon Connect Instance](https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html) in the *Amazon Connect Administrator Guide*.

**Important**  
After calling DeleteUser, call [DeleteQuickConnect](https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteQuickConnect.html) to delete any records related to the deleted users. This will help you:  
Avoid dangling resources that impact your service quotas.
Remove deleted users so they don't appear to agents as transfer options.
Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using [Amazon Connect Global Resiliency](https://docs.aws.amazon.com/connect/latest/adminguide/setup-connect-global-resiliency.html). 

## Request Syntax
<a name="API_DeleteUser_RequestSyntax"></a>

```
DELETE /users/InstanceId/UserId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteUser_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DeleteUser_RequestSyntax) **   <a name="connect-DeleteUser-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [UserId](#API_DeleteUser_RequestSyntax) **   <a name="connect-DeleteUser-request-uri-UserId"></a>
The identifier of the user.  
Required: Yes

## Request Body
<a name="API_DeleteUser_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteUser_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteUser_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteUser_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteUser_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteUser) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteUser) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteUser) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteUser) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteUser) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteUser) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteUser) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteUser) 

# DeleteUserHierarchyGroup
<a name="API_DeleteUserHierarchyGroup"></a>

Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.

## Request Syntax
<a name="API_DeleteUserHierarchyGroup_RequestSyntax"></a>

```
DELETE /user-hierarchy-groups/InstanceId/HierarchyGroupId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteUserHierarchyGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [HierarchyGroupId](#API_DeleteUserHierarchyGroup_RequestSyntax) **   <a name="connect-DeleteUserHierarchyGroup-request-uri-HierarchyGroupId"></a>
The identifier of the hierarchy group.  
Required: Yes

 ** [InstanceId](#API_DeleteUserHierarchyGroup_RequestSyntax) **   <a name="connect-DeleteUserHierarchyGroup-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DeleteUserHierarchyGroup_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteUserHierarchyGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteUserHierarchyGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteUserHierarchyGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceInUseException **   
That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.    
 ** ResourceId **   
The identifier for the resource.  
 ** ResourceType **   
The type of resource.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteUserHierarchyGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteUserHierarchyGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteUserHierarchyGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteUserHierarchyGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteUserHierarchyGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteUserHierarchyGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteUserHierarchyGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteUserHierarchyGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteUserHierarchyGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteUserHierarchyGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteUserHierarchyGroup) 

# DeleteView
<a name="API_DeleteView"></a>

Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).

## Request Syntax
<a name="API_DeleteView_RequestSyntax"></a>

```
DELETE /views/InstanceId/ViewId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteView_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DeleteView_RequestSyntax) **   <a name="connect-DeleteView-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9\_\-:\/]+$`   
Required: Yes

 ** [ViewId](#API_DeleteView_RequestSyntax) **   <a name="connect-DeleteView-request-uri-ViewId"></a>
The identifier of the view. Both `ViewArn` and `ViewId` can be used.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Pattern: `^[a-zA-Z0-9\_\-:\/$]+$`   
Required: Yes

## Request Body
<a name="API_DeleteView_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteView_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteView_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteView_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceInUseException **   
That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.    
 ** ResourceId **   
The identifier for the resource.  
 ** ResourceType **   
The type of resource.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** TooManyRequestsException **   
Displayed when rate-related API limits are exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteView_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteView) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteView) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteView) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteView) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteView) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteView) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteView) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteView) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteView) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteView) 

# DeleteViewVersion
<a name="API_DeleteViewVersion"></a>

Deletes the particular version specified in `ViewVersion` identifier.

## Request Syntax
<a name="API_DeleteViewVersion_RequestSyntax"></a>

```
DELETE /views/InstanceId/ViewId/versions/ViewVersion HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteViewVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DeleteViewVersion_RequestSyntax) **   <a name="connect-DeleteViewVersion-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9\_\-:\/]+$`   
Required: Yes

 ** [ViewId](#API_DeleteViewVersion_RequestSyntax) **   <a name="connect-DeleteViewVersion-request-uri-ViewId"></a>
The identifier of the view. Both `ViewArn` and `ViewId` can be used.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Pattern: `^[a-zA-Z0-9\_\-:\/$]+$`   
Required: Yes

 ** [ViewVersion](#API_DeleteViewVersion_RequestSyntax) **   <a name="connect-DeleteViewVersion-request-uri-ViewVersion"></a>
The version number of the view.  
Required: Yes

## Request Body
<a name="API_DeleteViewVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteViewVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteViewVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteViewVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceInUseException **   
That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.    
 ** ResourceId **   
The identifier for the resource.  
 ** ResourceType **   
The type of resource.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** TooManyRequestsException **   
Displayed when rate-related API limits are exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteViewVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteViewVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteViewVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteViewVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteViewVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteViewVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteViewVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteViewVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteViewVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteViewVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteViewVersion) 

# DeleteVocabulary
<a name="API_DeleteVocabulary"></a>

Deletes the vocabulary that has the given identifier.

## Request Syntax
<a name="API_DeleteVocabulary_RequestSyntax"></a>

```
POST /vocabulary-remove/InstanceId/VocabularyId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteVocabulary_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DeleteVocabulary_RequestSyntax) **   <a name="connect-DeleteVocabulary-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [VocabularyId](#API_DeleteVocabulary_RequestSyntax) **   <a name="connect-DeleteVocabulary-request-uri-VocabularyId"></a>
The identifier of the custom vocabulary.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_DeleteVocabulary_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteVocabulary_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "State": "string",
   "VocabularyArn": "string",
   "VocabularyId": "string"
}
```

## Response Elements
<a name="API_DeleteVocabulary_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [State](#API_DeleteVocabulary_ResponseSyntax) **   <a name="connect-DeleteVocabulary-response-State"></a>
The current state of the custom vocabulary.  
Type: String  
Valid Values: `CREATION_IN_PROGRESS | ACTIVE | CREATION_FAILED | DELETE_IN_PROGRESS` 

 ** [VocabularyArn](#API_DeleteVocabulary_ResponseSyntax) **   <a name="connect-DeleteVocabulary-response-VocabularyArn"></a>
The Amazon Resource Name (ARN) of the custom vocabulary.  
Type: String

 ** [VocabularyId](#API_DeleteVocabulary_ResponseSyntax) **   <a name="connect-DeleteVocabulary-response-VocabularyId"></a>
The identifier of the custom vocabulary.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_DeleteVocabulary_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceInUseException **   
That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.    
 ** ResourceId **   
The identifier for the resource.  
 ** ResourceType **   
The type of resource.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteVocabulary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteVocabulary) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteVocabulary) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteVocabulary) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteVocabulary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteVocabulary) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteVocabulary) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteVocabulary) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteVocabulary) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteVocabulary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteVocabulary) 

# DeleteWorkspace
<a name="API_DeleteWorkspace"></a>

Deletes a workspace and removes all associated view and resource assignments.

## Request Syntax
<a name="API_DeleteWorkspace_RequestSyntax"></a>

```
DELETE /workspaces/InstanceId/WorkspaceId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteWorkspace_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DeleteWorkspace_RequestSyntax) **   <a name="connect-DeleteWorkspace-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [WorkspaceId](#API_DeleteWorkspace_RequestSyntax) **   <a name="connect-DeleteWorkspace-request-uri-WorkspaceId"></a>
The identifier of the workspace.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_DeleteWorkspace_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteWorkspace_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteWorkspace_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteWorkspace_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteWorkspace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteWorkspace) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteWorkspace) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteWorkspace) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteWorkspace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteWorkspace) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteWorkspace) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteWorkspace) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteWorkspace) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteWorkspace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteWorkspace) 

# DeleteWorkspaceMedia
<a name="API_DeleteWorkspaceMedia"></a>

Deletes a media asset (such as a logo) from a workspace.

## Request Syntax
<a name="API_DeleteWorkspaceMedia_RequestSyntax"></a>

```
DELETE /workspaces/InstanceId/WorkspaceId/media?mediaType=MediaType HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteWorkspaceMedia_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DeleteWorkspaceMedia_RequestSyntax) **   <a name="connect-DeleteWorkspaceMedia-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MediaType](#API_DeleteWorkspaceMedia_RequestSyntax) **   <a name="connect-DeleteWorkspaceMedia-request-uri-MediaType"></a>
The type of media to delete. Valid values are: `IMAGE_LOGO_FAVICON` and `IMAGE_LOGO_HORIZONTAL`.  
Valid Values: `IMAGE_LOGO_LIGHT_FAVICON | IMAGE_LOGO_DARK_FAVICON | IMAGE_LOGO_LIGHT_HORIZONTAL | IMAGE_LOGO_DARK_HORIZONTAL`   
Required: Yes

 ** [WorkspaceId](#API_DeleteWorkspaceMedia_RequestSyntax) **   <a name="connect-DeleteWorkspaceMedia-request-uri-WorkspaceId"></a>
The identifier of the workspace.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_DeleteWorkspaceMedia_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteWorkspaceMedia_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteWorkspaceMedia_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteWorkspaceMedia_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteWorkspaceMedia_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteWorkspaceMedia) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteWorkspaceMedia) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteWorkspaceMedia) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteWorkspaceMedia) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteWorkspaceMedia) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteWorkspaceMedia) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteWorkspaceMedia) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteWorkspaceMedia) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteWorkspaceMedia) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteWorkspaceMedia) 

# DeleteWorkspacePage
<a name="API_DeleteWorkspacePage"></a>

Removes the association between a view and a page in a workspace. The page will display the default view after deletion.

## Request Syntax
<a name="API_DeleteWorkspacePage_RequestSyntax"></a>

```
DELETE /workspaces/InstanceId/WorkspaceId/pages/Page HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteWorkspacePage_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DeleteWorkspacePage_RequestSyntax) **   <a name="connect-DeleteWorkspacePage-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [Page](#API_DeleteWorkspacePage_RequestSyntax) **   <a name="connect-DeleteWorkspacePage-request-uri-Page"></a>
The page identifier.  
Length Constraints: Minimum length of 1. Maximum length of 25.  
Pattern: `^(?!\\.$)(?!\\.\\.$)[\\p{L}\\p{Z}\\p{N}\\-_.:=@'|]+$`   
Required: Yes

 ** [WorkspaceId](#API_DeleteWorkspacePage_RequestSyntax) **   <a name="connect-DeleteWorkspacePage-request-uri-WorkspaceId"></a>
The identifier of the workspace.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_DeleteWorkspacePage_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteWorkspacePage_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteWorkspacePage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteWorkspacePage_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DeleteWorkspacePage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DeleteWorkspacePage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DeleteWorkspacePage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DeleteWorkspacePage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DeleteWorkspacePage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DeleteWorkspacePage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DeleteWorkspacePage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DeleteWorkspacePage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DeleteWorkspacePage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DeleteWorkspacePage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DeleteWorkspacePage) 

# DescribeAgentStatus
<a name="API_DescribeAgentStatus"></a>

Describes an agent status.

## Request Syntax
<a name="API_DescribeAgentStatus_RequestSyntax"></a>

```
GET /agent-status/InstanceId/AgentStatusId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeAgentStatus_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AgentStatusId](#API_DescribeAgentStatus_RequestSyntax) **   <a name="connect-DescribeAgentStatus-request-uri-AgentStatusId"></a>
The identifier for the agent status.  
Required: Yes

 ** [InstanceId](#API_DescribeAgentStatus_RequestSyntax) **   <a name="connect-DescribeAgentStatus-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DescribeAgentStatus_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeAgentStatus_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AgentStatus": { 
      "AgentStatusARN": "string",
      "AgentStatusId": "string",
      "Description": "string",
      "DisplayOrder": number,
      "LastModifiedRegion": "string",
      "LastModifiedTime": number,
      "Name": "string",
      "State": "string",
      "Tags": { 
         "string" : "string" 
      },
      "Type": "string"
   }
}
```

## Response Elements
<a name="API_DescribeAgentStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AgentStatus](#API_DescribeAgentStatus_ResponseSyntax) **   <a name="connect-DescribeAgentStatus-response-AgentStatus"></a>
The agent status.  
Type: [AgentStatus](API_AgentStatus.md) object

## Errors
<a name="API_DescribeAgentStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeAgentStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeAgentStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeAgentStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeAgentStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeAgentStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeAgentStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeAgentStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeAgentStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeAgentStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeAgentStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeAgentStatus) 

# DescribeAuthenticationProfile
<a name="API_DescribeAuthenticationProfile"></a>

This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Support.

Describes the target authentication profile.

## Request Syntax
<a name="API_DescribeAuthenticationProfile_RequestSyntax"></a>

```
GET /authentication-profiles/InstanceId/AuthenticationProfileId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeAuthenticationProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AuthenticationProfileId](#API_DescribeAuthenticationProfile_RequestSyntax) **   <a name="connect-DescribeAuthenticationProfile-request-uri-AuthenticationProfileId"></a>
A unique identifier for the authentication profile.   
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [InstanceId](#API_DescribeAuthenticationProfile_RequestSyntax) **   <a name="connect-DescribeAuthenticationProfile-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DescribeAuthenticationProfile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeAuthenticationProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AuthenticationProfile": { 
      "AllowedIps": [ "string" ],
      "Arn": "string",
      "BlockedIps": [ "string" ],
      "CreatedTime": number,
      "Description": "string",
      "Id": "string",
      "IsDefault": boolean,
      "LastModifiedRegion": "string",
      "LastModifiedTime": number,
      "MaxSessionDuration": number,
      "Name": "string",
      "PeriodicSessionDuration": number,
      "SessionInactivityDuration": number,
      "SessionInactivityHandlingEnabled": boolean
   }
}
```

## Response Elements
<a name="API_DescribeAuthenticationProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AuthenticationProfile](#API_DescribeAuthenticationProfile_ResponseSyntax) **   <a name="connect-DescribeAuthenticationProfile-response-AuthenticationProfile"></a>
The authentication profile object being described.  
Type: [AuthenticationProfile](API_AuthenticationProfile.md) object

## Errors
<a name="API_DescribeAuthenticationProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeAuthenticationProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeAuthenticationProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeAuthenticationProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeAuthenticationProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeAuthenticationProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeAuthenticationProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeAuthenticationProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeAuthenticationProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeAuthenticationProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeAuthenticationProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeAuthenticationProfile) 

# DescribeContact
<a name="API_DescribeContact"></a>

This API is in preview release for Amazon Connect and is subject to change.

Describes the specified contact. 

 **Use cases** 

Following are common uses cases for this API:
+ Retrieve contact information such as the caller's phone number and the specific number the caller dialed to integrate into custom monitoring or custom agent experience solutions.
+ Detect when a customer chat session disconnects due to a network issue on the agent's end. Use the DisconnectReason field in the [ContactTraceRecord](https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord) to detect this event and then re-queue the chat for followup.
+ Identify after contact work (ACW) duration and call recordings information when a COMPLETED event is received by using the [contact event stream](https://docs.aws.amazon.com/connect/latest/adminguide/contact-events.html). 

 **Important things to know** 
+  `SystemEndpoint` is not populated for contacts with initiation method of MONITOR, QUEUE\$1TRANSFER, or CALLBACK
+ Contact information remains available in Amazon Connect for 24 months from the `InitiationTimestamp`, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API.

 **Endpoints**: See [Amazon Connect endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/connect_region.html).

## Request Syntax
<a name="API_DescribeContact_RequestSyntax"></a>

```
GET /contacts/InstanceId/ContactId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeContact_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactId](#API_DescribeContact_RequestSyntax) **   <a name="connect-DescribeContact-request-uri-ContactId"></a>
The identifier of the contact.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_DescribeContact_RequestSyntax) **   <a name="connect-DescribeContact-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DescribeContact_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeContact_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Contact": { 
      "AdditionalEmailRecipients": { 
         "CcList": [ 
            { 
               "Address": "string",
               "DisplayName": "string"
            }
         ],
         "ToList": [ 
            { 
               "Address": "string",
               "DisplayName": "string"
            }
         ]
      },
      "AgentInfo": { 
         "AcceptedByAgentTimestamp": number,
         "AfterContactWorkDuration": number,
         "AfterContactWorkEndTimestamp": number,
         "AfterContactWorkStartTimestamp": number,
         "AgentInitiatedHoldDuration": number,
         "AgentPauseDurationInSeconds": number,
         "Capabilities": { 
            "ScreenShare": "string",
            "Video": "string"
         },
         "ConnectedToAgentTimestamp": number,
         "DeviceInfo": { 
            "OperatingSystem": "string",
            "PlatformName": "string",
            "PlatformVersion": "string"
         },
         "HierarchyGroups": { 
            "Level1": { 
               "Arn": "string"
            },
            "Level2": { 
               "Arn": "string"
            },
            "Level3": { 
               "Arn": "string"
            },
            "Level4": { 
               "Arn": "string"
            },
            "Level5": { 
               "Arn": "string"
            }
         },
         "Id": "string",
         "PreviewEndTimestamp": number,
         "StateTransitions": [ 
            { 
               "State": "string",
               "StateEndTimestamp": number,
               "StateStartTimestamp": number
            }
         ]
      },
      "AnsweringMachineDetectionStatus": "string",
      "Arn": "string",
      "Attributes": { 
         "string" : "string" 
      },
      "Campaign": { 
         "CampaignId": "string"
      },
      "Channel": "string",
      "ChatMetrics": { 
         "AgentMetrics": { 
            "ConversationAbandon": boolean,
            "LastMessageTimestamp": number,
            "MaxResponseTimeInMillis": number,
            "MessageLengthInChars": number,
            "MessagesSent": number,
            "NumResponses": number,
            "ParticipantId": "string",
            "ParticipantType": "string",
            "TotalResponseTimeInMillis": number
         },
         "ChatContactMetrics": { 
            "AgentFirstResponseTimeInMillis": number,
            "AgentFirstResponseTimestamp": number,
            "ConversationCloseTimeInMillis": number,
            "ConversationTurnCount": number,
            "MultiParty": boolean,
            "TotalBotMessageLengthInChars": number,
            "TotalBotMessages": number,
            "TotalMessages": number
         },
         "CustomerMetrics": { 
            "ConversationAbandon": boolean,
            "LastMessageTimestamp": number,
            "MaxResponseTimeInMillis": number,
            "MessageLengthInChars": number,
            "MessagesSent": number,
            "NumResponses": number,
            "ParticipantId": "string",
            "ParticipantType": "string",
            "TotalResponseTimeInMillis": number
         }
      },
      "ConnectedToSystemTimestamp": number,
      "ContactAssociationId": "string",
      "ContactDetails": { 
         "Description": "string",
         "Name": "string"
      },
      "ContactEvaluations": { 
         "string" : { 
            "DeleteTimestamp": number,
            "EndTimestamp": number,
            "EvaluationArn": "string",
            "ExportLocation": "string",
            "FormId": "string",
            "StartTimestamp": number,
            "Status": "string"
         }
      },
      "Customer": { 
         "Capabilities": { 
            "ScreenShare": "string",
            "Video": "string"
         },
         "DeviceInfo": { 
            "OperatingSystem": "string",
            "PlatformName": "string",
            "PlatformVersion": "string"
         }
      },
      "CustomerEndpoint": { 
         "Address": "string",
         "DisplayName": "string",
         "Type": "string"
      },
      "CustomerId": "string",
      "CustomerVoiceActivity": { 
         "GreetingEndTimestamp": number,
         "GreetingStartTimestamp": number
      },
      "Description": "string",
      "DisconnectDetails": { 
         "PotentialDisconnectIssue": "string"
      },
      "DisconnectReason": "string",
      "DisconnectTimestamp": number,
      "GlobalResiliencyMetadata": { 
         "ActiveRegion": "string",
         "OriginRegion": "string",
         "TrafficDistributionGroupId": "string"
      },
      "Id": "string",
      "InitialContactId": "string",
      "InitiationMethod": "string",
      "InitiationTimestamp": number,
      "LastPausedTimestamp": number,
      "LastResumedTimestamp": number,
      "LastUpdateTimestamp": number,
      "Name": "string",
      "NextContacts": [ 
         { 
            "NextContactMetadata": { ... },
            "Type": "string"
         }
      ],
      "OutboundStrategy": { 
         "Config": { 
            "AgentFirst": { 
               "Preview": { 
                  "AllowedUserActions": [ "string" ],
                  "PostAcceptTimeoutConfig": { 
                     "DurationInSeconds": number
                  }
               }
            }
         },
         "Type": "string"
      },
      "PreviousContactId": "string",
      "QualityMetrics": { 
         "Agent": { 
            "Audio": { 
               "PotentialQualityIssues": [ "string" ],
               "QualityScore": number
            }
         },
         "Customer": { 
            "Audio": { 
               "PotentialQualityIssues": [ "string" ],
               "QualityScore": number
            }
         }
      },
      "QueueInfo": { 
         "EnqueueTimestamp": number,
         "Id": "string"
      },
      "QueuePriority": number,
      "QueueTimeAdjustmentSeconds": number,
      "Recordings": [ 
         { 
            "DeletionReason": "string",
            "FragmentStartNumber": "string",
            "FragmentStopNumber": "string",
            "Location": "string",
            "MediaStreamType": "string",
            "ParticipantType": "string",
            "StartTimestamp": number,
            "Status": "string",
            "StopTimestamp": number,
            "StorageType": "string",
            "UnprocessedTranscriptLocation": "string"
         }
      ],
      "RelatedContactId": "string",
      "RingStartTimestamp": number,
      "RoutingCriteria": { 
         "ActivationTimestamp": number,
         "Index": number,
         "Steps": [ 
            { 
               "Expiry": { 
                  "DurationInSeconds": number,
                  "ExpiryTimestamp": number
               },
               "Expression": { 
                  "AndExpression": [ 
                     "Expression"
                  ],
                  "AttributeCondition": { 
                     "ComparisonOperator": "string",
                     "MatchCriteria": { 
                        "AgentsCriteria": { 
                           "AgentIds": [ "string" ]
                        }
                     },
                     "Name": "string",
                     "ProficiencyLevel": number,
                     "Range": { 
                        "MaxProficiencyLevel": number,
                        "MinProficiencyLevel": number
                     },
                     "Value": "string"
                  },
                  "NotAttributeCondition": { 
                     "ComparisonOperator": "string",
                     "MatchCriteria": { 
                        "AgentsCriteria": { 
                           "AgentIds": [ "string" ]
                        }
                     },
                     "Name": "string",
                     "ProficiencyLevel": number,
                     "Range": { 
                        "MaxProficiencyLevel": number,
                        "MinProficiencyLevel": number
                     },
                     "Value": "string"
                  },
                  "OrExpression": [ 
                     "Expression"
                  ]
               },
               "Status": "string"
            }
         ]
      },
      "ScheduledTimestamp": number,
      "SegmentAttributes": { 
         "string" : { 
            "ValueArn": "string",
            "ValueInteger": number,
            "ValueList": [ 
               "SegmentAttributeValue"
            ],
            "ValueMap": { 
               "string" : "SegmentAttributeValue"
            },
            "ValueString": "string"
         }
      },
      "SystemEndpoint": { 
         "Address": "string",
         "DisplayName": "string",
         "Type": "string"
      },
      "Tags": { 
         "string" : "string" 
      },
      "TaskTemplateInfo": { 
         "Arn": "string",
         "Name": "string"
      },
      "TotalPauseCount": number,
      "TotalPauseDurationInSeconds": number,
      "WisdomInfo": { 
         "AiAgents": [ 
            { 
               "AiAgentEscalated": boolean,
               "AiAgentVersionId": "string",
               "AiUseCase": "string"
            }
         ],
         "SessionArn": "string"
      }
   }
}
```

## Response Elements
<a name="API_DescribeContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Contact](#API_DescribeContact_ResponseSyntax) **   <a name="connect-DescribeContact-response-Contact"></a>
Information about the contact.  
Type: [Contact](API_Contact.md) object

## Errors
<a name="API_DescribeContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeContact) 

# DescribeContactEvaluation
<a name="API_DescribeContactEvaluation"></a>

Describes a contact evaluation in the specified Amazon Connect instance.

## Request Syntax
<a name="API_DescribeContactEvaluation_RequestSyntax"></a>

```
GET /contact-evaluations/InstanceId/EvaluationId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeContactEvaluation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [EvaluationId](#API_DescribeContactEvaluation_RequestSyntax) **   <a name="connect-DescribeContactEvaluation-request-uri-EvaluationId"></a>
A unique identifier for the contact evaluation.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [InstanceId](#API_DescribeContactEvaluation_RequestSyntax) **   <a name="connect-DescribeContactEvaluation-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DescribeContactEvaluation_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeContactEvaluation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Evaluation": { 
      "Answers": { 
         "string" : { 
            "SuggestedAnswers": [ 
               { 
                  "AnalysisDetails": { ... },
                  "AnalysisType": "string",
                  "Input": { 
                     "TranscriptType": "string"
                  },
                  "Status": "string",
                  "Value": { ... }
               }
            ],
            "SystemSuggestedValue": { ... },
            "Value": { ... }
         }
      },
      "CreatedTime": number,
      "EvaluationArn": "string",
      "EvaluationId": "string",
      "EvaluationType": "string",
      "LastModifiedTime": number,
      "Metadata": { 
         "Acknowledgement": { 
            "AcknowledgedBy": "string",
            "AcknowledgedTime": number,
            "AcknowledgerComment": "string"
         },
         "AutoEvaluation": { 
            "AutoEvaluationEnabled": boolean,
            "AutoEvaluationStatus": "string"
         },
         "CalibrationSessionId": "string",
         "ContactAgentId": "string",
         "ContactId": "string",
         "ContactParticipant": { 
            "ContactParticipantId": "string",
            "ContactParticipantRole": "string"
         },
         "EvaluatorArn": "string",
         "Review": { 
            "CreatedBy": "string",
            "CreatedTime": number,
            "RequestedBy": "string",
            "RequestedTime": number,
            "ReviewId": "string",
            "ReviewRequestComments": [ 
               { 
                  "Comment": "string",
                  "CreatedBy": "string",
                  "CreatedTime": number
               }
            ]
         },
         "SamplingJobId": "string",
         "Score": { 
            "AppliedWeight": number,
            "AutomaticFail": boolean,
            "NotApplicable": boolean,
            "Percentage": number
         }
      },
      "Notes": { 
         "string" : { 
            "Value": "string"
         }
      },
      "Scores": { 
         "string" : { 
            "AppliedWeight": number,
            "AutomaticFail": boolean,
            "NotApplicable": boolean,
            "Percentage": number
         }
      },
      "Status": "string",
      "Tags": { 
         "string" : "string" 
      }
   },
   "EvaluationForm": { 
      "AutoEvaluationConfiguration": { 
         "Enabled": boolean
      },
      "Description": "string",
      "EvaluationFormArn": "string",
      "EvaluationFormId": "string",
      "EvaluationFormVersion": number,
      "Items": [ 
         { ... }
      ],
      "LanguageConfiguration": { 
         "FormLanguage": "string"
      },
      "ReviewConfiguration": { 
         "EligibilityDays": number,
         "ReviewNotificationRecipients": [ 
            { 
               "Type": "string",
               "Value": { 
                  "UserId": "string"
               }
            }
         ]
      },
      "ScoringStrategy": { 
         "Mode": "string",
         "Status": "string"
      },
      "TargetConfiguration": { 
         "ContactInteractionType": "string"
      },
      "Title": "string"
   }
}
```

## Response Elements
<a name="API_DescribeContactEvaluation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Evaluation](#API_DescribeContactEvaluation_ResponseSyntax) **   <a name="connect-DescribeContactEvaluation-response-Evaluation"></a>
Information about the evaluation form completed for a specific contact.  
Type: [Evaluation](API_Evaluation.md) object

 ** [EvaluationForm](#API_DescribeContactEvaluation_ResponseSyntax) **   <a name="connect-DescribeContactEvaluation-response-EvaluationForm"></a>
Information about the evaluation form.  
Type: [EvaluationFormContent](API_EvaluationFormContent.md) object

## Errors
<a name="API_DescribeContactEvaluation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_DescribeContactEvaluation_Examples"></a>

### Example
<a name="API_DescribeContactEvaluation_Example_1"></a>

The following example describes a contact evaluation.

#### Sample Request
<a name="API_DescribeContactEvaluation_Example_1_Request"></a>

```
{
   "InstanceId": "[instance_id]",
   "EvaluationId": "[evaluation_id]"
}
```

#### Sample Response
<a name="API_DescribeContactEvaluation_Example_1_Response"></a>

```
{
   "Evaluation": {
      "EvaluationId": "[evaluation_id]",
      "EvaluationArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/contact-evaluation/[evaluation_id]",
      "Metadata": {
         "ContactId": "[contact_id]",
         "EvaluatorArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/agent/arn:aws:sts::[account_id]:assumed-role/Admin/username",
         "ContactAgentId": "[contact_agent_id]"
      },
      "Answers": {},
      "Notes": {},
      "Status": "DRAFT",
      "CreatedTime": "2023-05-04T01:16:29.693000-07:00",
      "LastModifiedTime": "2023-05-04T01:16:29.693000-07:00",
      "Tags": {}
   },
   "EvaluationForm": {
      "EvaluationFormVersion": 1,
      "EvaluationFormId": "[evaluation_form_id]",
      "EvaluationFormArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/evaluation-form/[evaluation_form_id]",
      "Title": "form-title",
      "Description": "form-description",
      "Items": [
         {
            "Section": {
               "Title": "section-title-1",
               "RefId": "section-1",
               "Instructions": "section-instruction-1",
               "Items": [
                  {
                     "Question": {
                        "Title": "question-title-11",
                        "Instructions": "question-instructions",
                        "RefId": "question-1-111",
                        "NotApplicableEnabled": false,
                        "QuestionType": "TEXT"
                     }
                  },
                  {
                     "Question": {
                        "Title": "question-title-12",
                        "RefId": "question-1-222",
                        "NotApplicableEnabled": false,
                        "QuestionType": "SINGLESELECT",
                        "QuestionTypeProperties": {
                           "SingleSelect": {
                              "Options": [
                                 {
                                    "RefId": "option-1-2-1",
                                    "Text": "first-option",
                                    "Score": 1,
                                    "AutomaticFail": true
                                 },
                                 {
                                    "RefId": "option-1-2-2",
                                    "Text": "second-option",
                                    "Score": 1,
                                    "AutomaticFail": false
                                 },
                                 {
                                    "RefId": "option-1-2-3",
                                    "Text": "third-option",
                                    "Score": 1,
                                    "AutomaticFail": true
                                 }
                              ],
                              "DisplayAs": "DROPDOWN",
                              "Automation": {
                                 "Options": [
                                    {
                                       "RuleCategory": {
                                          "Category": "CATEGORY_LABEL",
                                          "Condition": "PRESENT",
                                          "OptionRefId": "option-1-2-2"
                                       }
                                    }
                                 ],
                                 "DefaultOptionRefId": "option-1-2-1"
                              }
                           }
                        }
                     }
                  }
               ],
               "Weight": 50
            }
         },
         {
            "Section": {
               "Title": "section-title-2",
               "RefId": "section-2",
               "Instructions": "section-instruction-2",
               "Items": [
                  {
                     "Question": {
                        "Title": "question-title-21",
                        "RefId": "question-2-1",
                        "NotApplicableEnabled": true,
                        "QuestionType": "TEXT"
                     }
                  },
                  {
                     "Question": {
                        "Title": "question-title-2-2",
                        "RefId": "question-2-222",
                        "QuestionType": "NUMERIC",
                        "QuestionTypeProperties": {
                           "Numeric": {
                              "MinValue": 0,
                              "MaxValue": 28800,
                              "Options": [
                                 {
                                    "MinValue": 0,
                                    "MaxValue": 28800,
                                    "Score": 1,
                                    "AutomaticFail": false
                                 }
                              ],
                              "Automation": {
                                 "PropertyValue": {
                                    "Label": "AGENT_INTERACTION_DURATION"
                                 }
                              }
                           }
                        }
                     }
                  }
               ],
               "Weight": 50
            }
         }
      ],
      "ScoringStrategy": {
         "Mode": "SECTION_ONLY",
         "Status": "ENABLED"
      }
   }
}
```

## See Also
<a name="API_DescribeContactEvaluation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeContactEvaluation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeContactEvaluation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeContactEvaluation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeContactEvaluation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeContactEvaluation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeContactEvaluation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeContactEvaluation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeContactEvaluation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeContactEvaluation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeContactEvaluation) 

# DescribeContactFlow
<a name="API_DescribeContactFlow"></a>

Describes the specified flow.

You can also create and update flows using the [Amazon Connect Flow language](https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html).

Use the `$SAVED` alias in the request to describe the `SAVED` content of a Flow. For example, `arn:aws:.../contact-flow/{id}:$SAVED`. After a flow is published, `$SAVED` needs to be supplied to view saved content that has not been published.

Use `arn:aws:.../contact-flow/{id}:{version}` to retrieve the content of a specific flow version.

In the response, **Status** indicates the flow status as either `SAVED` or `PUBLISHED`. The `PUBLISHED` status will initiate validation on the content. `SAVED` does not initiate validation of the content. `SAVED` \$1 `PUBLISHED` 

## Request Syntax
<a name="API_DescribeContactFlow_RequestSyntax"></a>

```
GET /contact-flows/InstanceId/ContactFlowId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeContactFlow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactFlowId](#API_DescribeContactFlow_RequestSyntax) **   <a name="connect-DescribeContactFlow-request-uri-ContactFlowId"></a>
The identifier of the flow.  
Length Constraints: Maximum length of 500.  
Required: Yes

 ** [InstanceId](#API_DescribeContactFlow_RequestSyntax) **   <a name="connect-DescribeContactFlow-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DescribeContactFlow_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeContactFlow_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactFlow": { 
      "Arn": "string",
      "Content": "string",
      "Description": "string",
      "FlowContentSha256": "string",
      "Id": "string",
      "LastModifiedRegion": "string",
      "LastModifiedTime": number,
      "Name": "string",
      "State": "string",
      "Status": "string",
      "Tags": { 
         "string" : "string" 
      },
      "Type": "string",
      "Version": number,
      "VersionDescription": "string"
   }
}
```

## Response Elements
<a name="API_DescribeContactFlow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContactFlow](#API_DescribeContactFlow_ResponseSyntax) **   <a name="connect-DescribeContactFlow-response-ContactFlow"></a>
Information about the flow.  
Type: [ContactFlow](API_ContactFlow.md) object

## Errors
<a name="API_DescribeContactFlow_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** ContactFlowNotPublishedException **   
The flow has not been published.  
HTTP Status Code: 404

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeContactFlow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeContactFlow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeContactFlow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeContactFlow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeContactFlow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeContactFlow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeContactFlow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeContactFlow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeContactFlow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeContactFlow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeContactFlow) 

# DescribeContactFlowModule
<a name="API_DescribeContactFlowModule"></a>

Describes the specified flow module.

Use the `$SAVED` alias in the request to describe the `SAVED` content of a Flow. For example, `arn:aws:.../contact-flow/{id}:$SAVED`. After a flow is published, `$SAVED` needs to be supplied to view saved content that has not been published.

## Request Syntax
<a name="API_DescribeContactFlowModule_RequestSyntax"></a>

```
GET /contact-flow-modules/InstanceId/ContactFlowModuleId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeContactFlowModule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactFlowModuleId](#API_DescribeContactFlowModule_RequestSyntax) **   <a name="connect-DescribeContactFlowModule-request-uri-ContactFlowModuleId"></a>
The identifier of the flow module.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_DescribeContactFlowModule_RequestSyntax) **   <a name="connect-DescribeContactFlowModule-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DescribeContactFlowModule_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeContactFlowModule_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactFlowModule": { 
      "Arn": "string",
      "Content": "string",
      "Description": "string",
      "ExternalInvocationConfiguration": { 
         "Enabled": boolean
      },
      "FlowModuleContentSha256": "string",
      "Id": "string",
      "Name": "string",
      "Settings": "string",
      "State": "string",
      "Status": "string",
      "Tags": { 
         "string" : "string" 
      },
      "Version": number,
      "VersionDescription": "string"
   }
}
```

## Response Elements
<a name="API_DescribeContactFlowModule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContactFlowModule](#API_DescribeContactFlowModule_ResponseSyntax) **   <a name="connect-DescribeContactFlowModule-response-ContactFlowModule"></a>
Information about the flow module.  
Type: [ContactFlowModule](API_ContactFlowModule.md) object

## Errors
<a name="API_DescribeContactFlowModule_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeContactFlowModule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeContactFlowModule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeContactFlowModule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeContactFlowModule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeContactFlowModule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeContactFlowModule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeContactFlowModule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeContactFlowModule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeContactFlowModule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeContactFlowModule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeContactFlowModule) 

# DescribeContactFlowModuleAlias
<a name="API_DescribeContactFlowModuleAlias"></a>

Retrieves detailed information about a specific alias, including which version it currently points to and its metadata.

## Request Syntax
<a name="API_DescribeContactFlowModuleAlias_RequestSyntax"></a>

```
GET /contact-flow-modules/InstanceId/ContactFlowModuleId/alias/AliasId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeContactFlowModuleAlias_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AliasId](#API_DescribeContactFlowModuleAlias_RequestSyntax) **   <a name="connect-DescribeContactFlowModuleAlias-request-uri-AliasId"></a>
The identifier of the alias.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [ContactFlowModuleId](#API_DescribeContactFlowModuleAlias_RequestSyntax) **   <a name="connect-DescribeContactFlowModuleAlias-request-uri-ContactFlowModuleId"></a>
The identifier of the flow module.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_DescribeContactFlowModuleAlias_RequestSyntax) **   <a name="connect-DescribeContactFlowModuleAlias-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

## Request Body
<a name="API_DescribeContactFlowModuleAlias_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeContactFlowModuleAlias_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactFlowModuleAlias": { 
      "AliasId": "string",
      "ContactFlowModuleArn": "string",
      "ContactFlowModuleId": "string",
      "Description": "string",
      "LastModifiedRegion": "string",
      "LastModifiedTime": number,
      "Name": "string",
      "Version": number
   }
}
```

## Response Elements
<a name="API_DescribeContactFlowModuleAlias_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContactFlowModuleAlias](#API_DescribeContactFlowModuleAlias_ResponseSyntax) **   <a name="connect-DescribeContactFlowModuleAlias-response-ContactFlowModuleAlias"></a>
Information about the flow module alias.  
Type: [ContactFlowModuleAliasInfo](API_ContactFlowModuleAliasInfo.md) object

## Errors
<a name="API_DescribeContactFlowModuleAlias_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_DescribeContactFlowModuleAlias_Examples"></a>

### Sample Response
<a name="API_DescribeContactFlowModuleAlias_Example_1"></a>

This example illustrates one usage of DescribeContactFlowModuleAlias.

```
{
  "ContactFlowModuleAlias": {
    "ContactFlowModuleId": "abcdefgh-1234-5678-9012-abcdefghijkl",
    "ContactFlowModuleArn": "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-1234-1234-123456789012/flow-module/abcdefgh-1234-5678-9012-abcdefghijkl",
    "AliasId": "production",
    "Version": 2,
    "Name": "production",
    "Description": "Production version of the customer service module",
    "LastModifiedRegion": "us-west-2",
    "LastModifiedTime": "2024-01-15T10:30:00.000Z"
  }
}
```

## See Also
<a name="API_DescribeContactFlowModuleAlias_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeContactFlowModuleAlias) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeContactFlowModuleAlias) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeContactFlowModuleAlias) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeContactFlowModuleAlias) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeContactFlowModuleAlias) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeContactFlowModuleAlias) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeContactFlowModuleAlias) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeContactFlowModuleAlias) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeContactFlowModuleAlias) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeContactFlowModuleAlias) 

# DescribeDataTable
<a name="API_DescribeDataTable"></a>

Returns all properties for a data table except for attributes and values. All properties from CreateDataTable are returned as well as properties for region replication, versioning, and system tables. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.

## Request Syntax
<a name="API_DescribeDataTable_RequestSyntax"></a>

```
GET /data-tables/InstanceId/DataTableId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeDataTable_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DataTableId](#API_DescribeDataTable_RequestSyntax) **   <a name="connect-DescribeDataTable-request-uri-DataTableId"></a>
The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If no alias is provided, the default behavior is identical to providing the \$1LATEST alias.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_DescribeDataTable_RequestSyntax) **   <a name="connect-DescribeDataTable-request-uri-InstanceId"></a>
The unique identifier for the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DescribeDataTable_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeDataTable_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DataTable": { 
      "Arn": "string",
      "CreatedTime": number,
      "Description": "string",
      "Id": "string",
      "LastModifiedRegion": "string",
      "LastModifiedTime": number,
      "LockVersion": { 
         "Attribute": "string",
         "DataTable": "string",
         "PrimaryValues": "string",
         "Value": "string"
      },
      "Name": "string",
      "Status": "string",
      "Tags": { 
         "string" : "string" 
      },
      "TimeZone": "string",
      "ValueLockLevel": "string",
      "Version": "string",
      "VersionDescription": "string"
   }
}
```

## Response Elements
<a name="API_DescribeDataTable_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DataTable](#API_DescribeDataTable_ResponseSyntax) **   <a name="connect-DescribeDataTable-response-DataTable"></a>
The complete data table information including metadata, configuration, and versioning details.  
Type: [DataTable](API_DataTable.md) object

## Errors
<a name="API_DescribeDataTable_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeDataTable_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeDataTable) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeDataTable) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeDataTable) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeDataTable) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeDataTable) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeDataTable) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeDataTable) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeDataTable) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeDataTable) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeDataTable) 

# DescribeDataTableAttribute
<a name="API_DescribeDataTableAttribute"></a>

Returns detailed information for a specific data table attribute including its configuration, validation rules, and metadata. "Describe" is a deprecated term but is allowed to maintain consistency with existing operations.

## Request Syntax
<a name="API_DescribeDataTableAttribute_RequestSyntax"></a>

```
GET /data-tables/InstanceId/DataTableId/attributes/AttributeName HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeDataTableAttribute_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AttributeName](#API_DescribeDataTableAttribute_RequestSyntax) **   <a name="connect-DescribeDataTableAttribute-request-uri-AttributeName"></a>
The name of the attribute to retrieve detailed information for.  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `^[\p{L}\p{Z}\p{N}\-_.:=@'|]+$`   
Required: Yes

 ** [DataTableId](#API_DescribeDataTableAttribute_RequestSyntax) **   <a name="connect-DescribeDataTableAttribute-request-uri-DataTableId"></a>
The unique identifier for the data table. Must also accept the table ARN with or without a version alias.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_DescribeDataTableAttribute_RequestSyntax) **   <a name="connect-DescribeDataTableAttribute-request-uri-InstanceId"></a>
The unique identifier for the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DescribeDataTableAttribute_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeDataTableAttribute_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Attribute": { 
      "AttributeId": "string",
      "DataTableArn": "string",
      "DataTableId": "string",
      "Description": "string",
      "LastModifiedRegion": "string",
      "LastModifiedTime": number,
      "LockVersion": { 
         "Attribute": "string",
         "DataTable": "string",
         "PrimaryValues": "string",
         "Value": "string"
      },
      "Name": "string",
      "Primary": boolean,
      "Validation": { 
         "Enum": { 
            "Strict": boolean,
            "Values": [ "string" ]
         },
         "ExclusiveMaximum": number,
         "ExclusiveMinimum": number,
         "IgnoreCase": boolean,
         "Maximum": number,
         "MaxLength": number,
         "MaxValues": number,
         "Minimum": number,
         "MinLength": number,
         "MinValues": number,
         "MultipleOf": number
      },
      "ValueType": "string",
      "Version": "string"
   }
}
```

## Response Elements
<a name="API_DescribeDataTableAttribute_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Attribute](#API_DescribeDataTableAttribute_ResponseSyntax) **   <a name="connect-DescribeDataTableAttribute-response-Attribute"></a>
The complete attribute information including configuration, validation rules, lock version, and metadata.  
Type: [DataTableAttribute](API_DataTableAttribute.md) object

## Errors
<a name="API_DescribeDataTableAttribute_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeDataTableAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeDataTableAttribute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeDataTableAttribute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeDataTableAttribute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeDataTableAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeDataTableAttribute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeDataTableAttribute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeDataTableAttribute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeDataTableAttribute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeDataTableAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeDataTableAttribute) 

# DescribeEmailAddress
<a name="API_DescribeEmailAddress"></a>

Describe email address form the specified Amazon Connect instance.

## Request Syntax
<a name="API_DescribeEmailAddress_RequestSyntax"></a>

```
GET /email-addresses/InstanceId/EmailAddressId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeEmailAddress_RequestParameters"></a>

The request uses the following URI parameters.

 ** [EmailAddressId](#API_DescribeEmailAddress_RequestSyntax) **   <a name="connect-DescribeEmailAddress-request-uri-EmailAddressId"></a>
The identifier of the email address.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [InstanceId](#API_DescribeEmailAddress_RequestSyntax) **   <a name="connect-DescribeEmailAddress-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DescribeEmailAddress_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeEmailAddress_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AliasConfigurations": [ 
      { 
         "EmailAddressId": "string"
      }
   ],
   "CreateTimestamp": "string",
   "Description": "string",
   "DisplayName": "string",
   "EmailAddress": "string",
   "EmailAddressArn": "string",
   "EmailAddressId": "string",
   "ModifiedTimestamp": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_DescribeEmailAddress_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AliasConfigurations](#API_DescribeEmailAddress_ResponseSyntax) **   <a name="connect-DescribeEmailAddress-response-AliasConfigurations"></a>
A list of alias configurations associated with this email address. Contains details about email addresses that forward to this primary email address. The list can contain at most one alias configuration per email address.  
Type: Array of [AliasConfiguration](API_AliasConfiguration.md) objects  
Array Members: Maximum number of 1 item.

 ** [CreateTimestamp](#API_DescribeEmailAddress_ResponseSyntax) **   <a name="connect-DescribeEmailAddress-response-CreateTimestamp"></a>
The email address creation timestamp in ISO 8601 Datetime.  
Type: String

 ** [Description](#API_DescribeEmailAddress_ResponseSyntax) **   <a name="connect-DescribeEmailAddress-response-Description"></a>
The description of the email address.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.

 ** [DisplayName](#API_DescribeEmailAddress_ResponseSyntax) **   <a name="connect-DescribeEmailAddress-response-DisplayName"></a>
The display name of email address  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.

 ** [EmailAddress](#API_DescribeEmailAddress_ResponseSyntax) **   <a name="connect-DescribeEmailAddress-response-EmailAddress"></a>
The email address, including the domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[^\s@]+@[^\s@]+\.[^\s@]+` 

 ** [EmailAddressArn](#API_DescribeEmailAddress_ResponseSyntax) **   <a name="connect-DescribeEmailAddress-response-EmailAddressArn"></a>
The Amazon Resource Name (ARN) of the email address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [EmailAddressId](#API_DescribeEmailAddress_ResponseSyntax) **   <a name="connect-DescribeEmailAddress-response-EmailAddressId"></a>
The identifier of the email address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [ModifiedTimestamp](#API_DescribeEmailAddress_ResponseSyntax) **   <a name="connect-DescribeEmailAddress-response-ModifiedTimestamp"></a>
The email address last modification timestamp in ISO 8601 Datetime.  
Type: String

 ** [Tags](#API_DescribeEmailAddress_ResponseSyntax) **   <a name="connect-DescribeEmailAddress-response-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_DescribeEmailAddress_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeEmailAddress_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeEmailAddress) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeEmailAddress) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeEmailAddress) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeEmailAddress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeEmailAddress) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeEmailAddress) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeEmailAddress) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeEmailAddress) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeEmailAddress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeEmailAddress) 

# DescribeEvaluationForm
<a name="API_DescribeEvaluationForm"></a>

Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.

## Request Syntax
<a name="API_DescribeEvaluationForm_RequestSyntax"></a>

```
GET /evaluation-forms/InstanceId/EvaluationFormId?version=EvaluationFormVersion HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeEvaluationForm_RequestParameters"></a>

The request uses the following URI parameters.

 ** [EvaluationFormId](#API_DescribeEvaluationForm_RequestSyntax) **   <a name="connect-DescribeEvaluationForm-request-uri-EvaluationFormId"></a>
A unique identifier for the contact evaluation.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [EvaluationFormVersion](#API_DescribeEvaluationForm_RequestSyntax) **   <a name="connect-DescribeEvaluationForm-request-uri-EvaluationFormVersion"></a>
A version of the evaluation form.

 ** [InstanceId](#API_DescribeEvaluationForm_RequestSyntax) **   <a name="connect-DescribeEvaluationForm-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DescribeEvaluationForm_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeEvaluationForm_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EvaluationForm": { 
      "AutoEvaluationConfiguration": { 
         "Enabled": boolean
      },
      "CreatedBy": "string",
      "CreatedTime": number,
      "Description": "string",
      "EvaluationFormArn": "string",
      "EvaluationFormId": "string",
      "EvaluationFormVersion": number,
      "Items": [ 
         { ... }
      ],
      "LanguageConfiguration": { 
         "FormLanguage": "string"
      },
      "LastModifiedBy": "string",
      "LastModifiedTime": number,
      "Locked": boolean,
      "ReviewConfiguration": { 
         "EligibilityDays": number,
         "ReviewNotificationRecipients": [ 
            { 
               "Type": "string",
               "Value": { 
                  "UserId": "string"
               }
            }
         ]
      },
      "ScoringStrategy": { 
         "Mode": "string",
         "Status": "string"
      },
      "Status": "string",
      "Tags": { 
         "string" : "string" 
      },
      "TargetConfiguration": { 
         "ContactInteractionType": "string"
      },
      "Title": "string"
   }
}
```

## Response Elements
<a name="API_DescribeEvaluationForm_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EvaluationForm](#API_DescribeEvaluationForm_ResponseSyntax) **   <a name="connect-DescribeEvaluationForm-response-EvaluationForm"></a>
Information about the evaluation form.  
Type: [EvaluationForm](API_EvaluationForm.md) object

## Errors
<a name="API_DescribeEvaluationForm_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_DescribeEvaluationForm_Examples"></a>

### Example
<a name="API_DescribeEvaluationForm_Example_1"></a>

The following example describes version 1 of an evaluation form.

#### Sample Request
<a name="API_DescribeEvaluationForm_Example_1_Request"></a>

```
{
   "InstanceId": "[instance_id]",
   "EvaluationFormId": "[evaluation_form_id]",
   "EvaluationFormVersion": 1
}
```

#### Sample Response
<a name="API_DescribeEvaluationForm_Example_1_Response"></a>

```
{
   "EvaluationForm": {
      "EvaluationFormId": "[evaluation_form_id]",
      "EvaluationFormVersion": 1,
      "Locked": false,
      "EvaluationFormArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/evaluation-form/[evaluation_form_id]",
      "Title": "form-title",
      "Description": "form-description",
      "Status": "DRAFT",
      "Items": [
         {
            "Section": {
               "Title": "section-title-1",
               "RefId": "section-1",
               "Instructions": "section-instruction-1",
               "Items": [
                  {
                     "Question": {
                        "Title": "question-title-11",
                        "Instructions": "question-instructions",
                        "RefId": "question-1-111",
                        "NotApplicableEnabled": false,
                        "QuestionType": "TEXT"
                     }
                  },
                  {
                     "Question": {
                        "Title": "question-title-12",
                        "RefId": "question-1-222",
                        "NotApplicableEnabled": false,
                        "QuestionType": "SINGLESELECT",
                        "QuestionTypeProperties": {
                           "SingleSelect": {
                              "Options": [
                                 {
                                    "RefId": "option-1-2-1",
                                    "Text": "first-option",
                                    "Score": 1,
                                    "AutomaticFail": true
                                 },
                                 {
                                    "RefId": "option-1-2-2",
                                    "Text": "second-option",
                                    "Score": 1,
                                    "AutomaticFail": false
                                 },
                                 {
                                    "RefId": "option-1-2-3",
                                    "Text": "third-option",
                                    "Score": 1,
                                    "AutomaticFail": true
                                 }
                              ],
                              "DisplayAs": "DROPDOWN",
                              "Automation": {
                                 "Options": [
                                    {
                                       "RuleCategory": {
                                          "Category": "CATEGORY_LABEL",
                                          "Condition": "PRESENT",
                                          "OptionRefId": "option-1-2-2"
                                       }
                                    }
                                 ],
                                 "DefaultOptionRefId": "option-1-2-1"
                              }
                           }
                        }
                     }
                  }
               ],
               "Weight": 50
            }
         },
         {
            "Section": {
               "Title": "section-title-2",
               "RefId": "section-2",
               "Instructions": "section-instruction-2",
               "Items": [
                  {
                     "Question": {
                        "Title": "question-title-21",
                        "RefId": "question-2-1",
                        "NotApplicableEnabled": true,
                        "QuestionType": "TEXT"
                     }
                  },
                  {
                     "Question": {
                        "Title": "question-title-2-2",
                        "RefId": "question-2-222",
                        "QuestionType": "NUMERIC",
                        "QuestionTypeProperties": {
                           "Numeric": {
                              "MinValue": 0,
                              "MaxValue": 28800,
                              "Options": [
                                 {
                                    "MinValue": 0,
                                    "MaxValue": 28800,
                                    "Score": 1,
                                    "AutomaticFail": false
                                 }
                              ],
                              "Automation": {
                                 "PropertyValue": {
                                    "Label": "AGENT_INTERACTION_DURATION"
                                 }
                              }
                           }
                        }
                     }
                  }
               ],
               "Weight": 50
            }
         }
      ],
      "ScoringStrategy": {
         "Mode": "SECTION_ONLY",
         "Status": "ENABLED"
      },
      "CreatedTime": "2023-05-04T00:24:01.490000-07:00",
      "CreatedBy": "arn:aws:sts::[account_id]:assumed-role/Admin/username",
      "LastModifiedTime": "2023-05-04T00:24:01.490000-07:00",
      "LastModifiedBy": "arn:aws:sts::[account_id]:assumed-role/Admin/username",
      "Tags": {}
   }
}
```

## See Also
<a name="API_DescribeEvaluationForm_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeEvaluationForm) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeEvaluationForm) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeEvaluationForm) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeEvaluationForm) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeEvaluationForm) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeEvaluationForm) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeEvaluationForm) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeEvaluationForm) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeEvaluationForm) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeEvaluationForm) 

# DescribeHoursOfOperation
<a name="API_DescribeHoursOfOperation"></a>

Describes the hours of operation.

## Request Syntax
<a name="API_DescribeHoursOfOperation_RequestSyntax"></a>

```
GET /hours-of-operations/InstanceId/HoursOfOperationId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeHoursOfOperation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [HoursOfOperationId](#API_DescribeHoursOfOperation_RequestSyntax) **   <a name="connect-DescribeHoursOfOperation-request-uri-HoursOfOperationId"></a>
The identifier for the hours of operation.  
Required: Yes

 ** [InstanceId](#API_DescribeHoursOfOperation_RequestSyntax) **   <a name="connect-DescribeHoursOfOperation-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DescribeHoursOfOperation_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeHoursOfOperation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "HoursOfOperation": { 
      "Config": [ 
         { 
            "Day": "string",
            "EndTime": { 
               "Hours": number,
               "Minutes": number
            },
            "StartTime": { 
               "Hours": number,
               "Minutes": number
            }
         }
      ],
      "Description": "string",
      "HoursOfOperationArn": "string",
      "HoursOfOperationId": "string",
      "LastModifiedRegion": "string",
      "LastModifiedTime": number,
      "Name": "string",
      "ParentHoursOfOperations": [ 
         { 
            "Arn": "string",
            "Id": "string",
            "Name": "string"
         }
      ],
      "Tags": { 
         "string" : "string" 
      },
      "TimeZone": "string"
   }
}
```

## Response Elements
<a name="API_DescribeHoursOfOperation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [HoursOfOperation](#API_DescribeHoursOfOperation_ResponseSyntax) **   <a name="connect-DescribeHoursOfOperation-response-HoursOfOperation"></a>
The hours of operation.  
Type: [HoursOfOperation](API_HoursOfOperation.md) object

## Errors
<a name="API_DescribeHoursOfOperation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeHoursOfOperation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeHoursOfOperation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeHoursOfOperation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeHoursOfOperation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeHoursOfOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeHoursOfOperation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeHoursOfOperation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeHoursOfOperation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeHoursOfOperation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeHoursOfOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeHoursOfOperation) 

# DescribeHoursOfOperationOverride
<a name="API_DescribeHoursOfOperationOverride"></a>

Describes the hours of operation override.

## Request Syntax
<a name="API_DescribeHoursOfOperationOverride_RequestSyntax"></a>

```
GET /hours-of-operations/InstanceId/HoursOfOperationId/overrides/HoursOfOperationOverrideId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeHoursOfOperationOverride_RequestParameters"></a>

The request uses the following URI parameters.

 ** [HoursOfOperationId](#API_DescribeHoursOfOperationOverride_RequestSyntax) **   <a name="connect-DescribeHoursOfOperationOverride-request-uri-HoursOfOperationId"></a>
The identifier for the hours of operation.  
Required: Yes

 ** [HoursOfOperationOverrideId](#API_DescribeHoursOfOperationOverride_RequestSyntax) **   <a name="connect-DescribeHoursOfOperationOverride-request-uri-HoursOfOperationOverrideId"></a>
The identifier for the hours of operation override.  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Required: Yes

 ** [InstanceId](#API_DescribeHoursOfOperationOverride_RequestSyntax) **   <a name="connect-DescribeHoursOfOperationOverride-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DescribeHoursOfOperationOverride_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeHoursOfOperationOverride_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "HoursOfOperationOverride": { 
      "Config": [ 
         { 
            "Day": "string",
            "EndTime": { 
               "Hours": number,
               "Minutes": number
            },
            "StartTime": { 
               "Hours": number,
               "Minutes": number
            }
         }
      ],
      "Description": "string",
      "EffectiveFrom": "string",
      "EffectiveTill": "string",
      "HoursOfOperationArn": "string",
      "HoursOfOperationId": "string",
      "HoursOfOperationOverrideId": "string",
      "Name": "string",
      "OverrideType": "string",
      "RecurrenceConfig": { 
         "RecurrencePattern": { 
            "ByMonth": [ number ],
            "ByMonthDay": [ number ],
            "ByWeekdayOccurrence": [ number ],
            "Frequency": "string",
            "Interval": number
         }
      }
   }
}
```

## Response Elements
<a name="API_DescribeHoursOfOperationOverride_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [HoursOfOperationOverride](#API_DescribeHoursOfOperationOverride_ResponseSyntax) **   <a name="connect-DescribeHoursOfOperationOverride-response-HoursOfOperationOverride"></a>
Information about the hours of operations override.   
Type: [HoursOfOperationOverride](API_HoursOfOperationOverride.md) object

## Errors
<a name="API_DescribeHoursOfOperationOverride_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeHoursOfOperationOverride_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeHoursOfOperationOverride) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeHoursOfOperationOverride) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeHoursOfOperationOverride) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeHoursOfOperationOverride) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeHoursOfOperationOverride) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeHoursOfOperationOverride) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeHoursOfOperationOverride) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeHoursOfOperationOverride) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeHoursOfOperationOverride) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeHoursOfOperationOverride) 

# DescribeInstance
<a name="API_DescribeInstance"></a>

This API is in preview release for Amazon Connect and is subject to change.

Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable. 

If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked.

## Request Syntax
<a name="API_DescribeInstance_RequestSyntax"></a>

```
GET /instance/InstanceId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeInstance_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DescribeInstance_RequestSyntax) **   <a name="connect-DescribeInstance-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DescribeInstance_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeInstance_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Instance": { 
      "Arn": "string",
      "CreatedTime": number,
      "Id": "string",
      "IdentityManagementType": "string",
      "InboundCallsEnabled": boolean,
      "InstanceAccessUrl": "string",
      "InstanceAlias": "string",
      "InstanceStatus": "string",
      "OutboundCallsEnabled": boolean,
      "ServiceRole": "string",
      "StatusReason": { 
         "Message": "string"
      },
      "Tags": { 
         "string" : "string" 
      }
   },
   "ReplicationConfiguration": { 
      "GlobalSignInEndpoint": "string",
      "ReplicationStatusSummaryList": [ 
         { 
            "Region": "string",
            "ReplicationStatus": "string",
            "ReplicationStatusReason": "string"
         }
      ],
      "SourceRegion": "string"
   }
}
```

## Response Elements
<a name="API_DescribeInstance_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Instance](#API_DescribeInstance_ResponseSyntax) **   <a name="connect-DescribeInstance-response-Instance"></a>
The name of the instance.  
Type: [Instance](API_Instance.md) object

 ** [ReplicationConfiguration](#API_DescribeInstance_ResponseSyntax) **   <a name="connect-DescribeInstance-response-ReplicationConfiguration"></a>
Status information about the replication process. This field is included only when you are using the [ReplicateInstance](https://docs.aws.amazon.com/connect/latest/APIReference/API_ReplicateInstance.html) API to replicate an Amazon Connect instance across AWS Regions. For information about replicating Amazon Connect instances, see [Create a replica of your existing Amazon Connect instance](https://docs.aws.amazon.com/connect/latest/adminguide/create-replica-connect-instance.html) in the *Amazon Connect Administrator Guide*.  
Type: [ReplicationConfiguration](API_ReplicationConfiguration.md) object

## Errors
<a name="API_DescribeInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

## See Also
<a name="API_DescribeInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeInstance) 

# DescribeInstanceAttribute
<a name="API_DescribeInstanceAttribute"></a>

This API is in preview release for Amazon Connect and is subject to change.

Describes the specified instance attribute.

## Request Syntax
<a name="API_DescribeInstanceAttribute_RequestSyntax"></a>

```
GET /instance/InstanceId/attribute/AttributeType HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeInstanceAttribute_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AttributeType](#API_DescribeInstanceAttribute_RequestSyntax) **   <a name="connect-DescribeInstanceAttribute-request-uri-AttributeType"></a>
The type of attribute.  
Valid Values: `INBOUND_CALLS | OUTBOUND_CALLS | CONTACTFLOW_LOGS | CONTACT_LENS | AUTO_RESOLVE_BEST_VOICES | USE_CUSTOM_TTS_VOICES | EARLY_MEDIA | MULTI_PARTY_CONFERENCE | HIGH_VOLUME_OUTBOUND | ENHANCED_CONTACT_MONITORING | ENHANCED_CHAT_MONITORING | MULTI_PARTY_CHAT_CONFERENCE | MESSAGE_STREAMING`   
Required: Yes

 ** [InstanceId](#API_DescribeInstanceAttribute_RequestSyntax) **   <a name="connect-DescribeInstanceAttribute-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DescribeInstanceAttribute_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeInstanceAttribute_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Attribute": { 
      "AttributeType": "string",
      "Value": "string"
   }
}
```

## Response Elements
<a name="API_DescribeInstanceAttribute_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Attribute](#API_DescribeInstanceAttribute_ResponseSyntax) **   <a name="connect-DescribeInstanceAttribute-response-Attribute"></a>
The type of attribute.  
Type: [Attribute](API_Attribute.md) object

## Errors
<a name="API_DescribeInstanceAttribute_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeInstanceAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeInstanceAttribute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeInstanceAttribute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeInstanceAttribute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeInstanceAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeInstanceAttribute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeInstanceAttribute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeInstanceAttribute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeInstanceAttribute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeInstanceAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeInstanceAttribute) 

# DescribeInstanceStorageConfig
<a name="API_DescribeInstanceStorageConfig"></a>

This API is in preview release for Amazon Connect and is subject to change.

Retrieves the current storage configurations for the specified resource type, association ID, and instance ID.

## Request Syntax
<a name="API_DescribeInstanceStorageConfig_RequestSyntax"></a>

```
GET /instance/InstanceId/storage-config/AssociationId?resourceType=ResourceType HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeInstanceStorageConfig_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AssociationId](#API_DescribeInstanceStorageConfig_RequestSyntax) **   <a name="connect-DescribeInstanceStorageConfig-request-uri-AssociationId"></a>
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [InstanceId](#API_DescribeInstanceStorageConfig_RequestSyntax) **   <a name="connect-DescribeInstanceStorageConfig-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [ResourceType](#API_DescribeInstanceStorageConfig_RequestSyntax) **   <a name="connect-DescribeInstanceStorageConfig-request-uri-ResourceType"></a>
A valid resource type.  
Valid Values: `CHAT_TRANSCRIPTS | CALL_RECORDINGS | SCHEDULED_REPORTS | MEDIA_STREAMS | CONTACT_TRACE_RECORDS | AGENT_EVENTS | REAL_TIME_CONTACT_ANALYSIS_SEGMENTS | ATTACHMENTS | CONTACT_EVALUATIONS | SCREEN_RECORDINGS | REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS | REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS | EMAIL_MESSAGES`   
Required: Yes

## Request Body
<a name="API_DescribeInstanceStorageConfig_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeInstanceStorageConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "StorageConfig": { 
      "AssociationId": "string",
      "KinesisFirehoseConfig": { 
         "FirehoseArn": "string"
      },
      "KinesisStreamConfig": { 
         "StreamArn": "string"
      },
      "KinesisVideoStreamConfig": { 
         "EncryptionConfig": { 
            "EncryptionType": "string",
            "KeyId": "string"
         },
         "Prefix": "string",
         "RetentionPeriodHours": number
      },
      "S3Config": { 
         "BucketName": "string",
         "BucketPrefix": "string",
         "EncryptionConfig": { 
            "EncryptionType": "string",
            "KeyId": "string"
         }
      },
      "StorageType": "string"
   }
}
```

## Response Elements
<a name="API_DescribeInstanceStorageConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [StorageConfig](#API_DescribeInstanceStorageConfig_ResponseSyntax) **   <a name="connect-DescribeInstanceStorageConfig-response-StorageConfig"></a>
A valid storage type.  
Type: [InstanceStorageConfig](API_InstanceStorageConfig.md) object

## Errors
<a name="API_DescribeInstanceStorageConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeInstanceStorageConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeInstanceStorageConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeInstanceStorageConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeInstanceStorageConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeInstanceStorageConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeInstanceStorageConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeInstanceStorageConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeInstanceStorageConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeInstanceStorageConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeInstanceStorageConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeInstanceStorageConfig) 

# DescribeNotification
<a name="API_DescribeNotification"></a>

Retrieves detailed information about a specific notification, including its content, priority, recipients, and metadata.

## Request Syntax
<a name="API_DescribeNotification_RequestSyntax"></a>

```
GET /notifications/InstanceId/NotificationId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeNotification_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DescribeNotification_RequestSyntax) **   <a name="connect-DescribeNotification-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [NotificationId](#API_DescribeNotification_RequestSyntax) **   <a name="connect-DescribeNotification-request-uri-NotificationId"></a>
The unique identifier for the notification.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_DescribeNotification_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeNotification_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Notification": { 
      "Arn": "string",
      "Content": { 
         "string" : "string" 
      },
      "CreatedAt": number,
      "ExpiresAt": number,
      "Id": "string",
      "LastModifiedRegion": "string",
      "LastModifiedTime": number,
      "Priority": "string",
      "Recipients": [ "string" ],
      "Tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_DescribeNotification_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Notification](#API_DescribeNotification_ResponseSyntax) **   <a name="connect-DescribeNotification-response-Notification"></a>
The complete notification information including content, priority, recipients, and metadata.  
Type: [Notification](API_Notification.md) object

## Errors
<a name="API_DescribeNotification_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeNotification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeNotification) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeNotification) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeNotification) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeNotification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeNotification) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeNotification) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeNotification) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeNotification) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeNotification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeNotification) 

# DescribePhoneNumber
<a name="API_DescribePhoneNumber"></a>

Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.

**Important**  
If the number is claimed to a traffic distribution group, and you are calling in the AWS Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the `PhoneNumberId` URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate AWS Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you receive a `ResourceNotFoundException`.

## Request Syntax
<a name="API_DescribePhoneNumber_RequestSyntax"></a>

```
GET /phone-number/PhoneNumberId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribePhoneNumber_RequestParameters"></a>

The request uses the following URI parameters.

 ** [PhoneNumberId](#API_DescribePhoneNumber_RequestSyntax) **   <a name="connect-DescribePhoneNumber-request-uri-PhoneNumberId"></a>
A unique identifier for the phone number.  
Required: Yes

## Request Body
<a name="API_DescribePhoneNumber_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribePhoneNumber_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ClaimedPhoneNumberSummary": { 
      "InstanceId": "string",
      "PhoneNumber": "string",
      "PhoneNumberArn": "string",
      "PhoneNumberCountryCode": "string",
      "PhoneNumberDescription": "string",
      "PhoneNumberId": "string",
      "PhoneNumberStatus": { 
         "Message": "string",
         "Status": "string"
      },
      "PhoneNumberType": "string",
      "SourcePhoneNumberArn": "string",
      "Tags": { 
         "string" : "string" 
      },
      "TargetArn": "string"
   }
}
```

## Response Elements
<a name="API_DescribePhoneNumber_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ClaimedPhoneNumberSummary](#API_DescribePhoneNumber_ResponseSyntax) **   <a name="connect-DescribePhoneNumber-response-ClaimedPhoneNumberSummary"></a>
Information about a phone number that's been claimed to your Amazon Connect instance or traffic distribution group.  
Type: [ClaimedPhoneNumberSummary](API_ClaimedPhoneNumberSummary.md) object

## Errors
<a name="API_DescribePhoneNumber_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribePhoneNumber_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribePhoneNumber) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribePhoneNumber) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribePhoneNumber) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribePhoneNumber) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribePhoneNumber) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribePhoneNumber) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribePhoneNumber) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribePhoneNumber) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribePhoneNumber) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribePhoneNumber) 

# DescribePredefinedAttribute
<a name="API_DescribePredefinedAttribute"></a>

Describes a predefined attribute for the specified Amazon Connect instance. A *predefined attribute* is made up of a name and a value. You can use predefined attributes for:
+ Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see [Create predefined attributes for routing contacts to agents](https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html).
+ Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see [Use contact segment attributes](https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html).

For the predefined attributes per instance quota, see [Amazon Connect quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas).

 **Endpoints**: See [Amazon Connect endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/connect_region.html).

## Request Syntax
<a name="API_DescribePredefinedAttribute_RequestSyntax"></a>

```
GET /predefined-attributes/InstanceId/Name HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribePredefinedAttribute_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DescribePredefinedAttribute_RequestSyntax) **   <a name="connect-DescribePredefinedAttribute-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [Name](#API_DescribePredefinedAttribute_RequestSyntax) **   <a name="connect-DescribePredefinedAttribute-request-uri-Name"></a>
The name of the predefined attribute.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DescribePredefinedAttribute_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribePredefinedAttribute_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "PredefinedAttribute": { 
      "AttributeConfiguration": { 
         "EnableValueValidationOnAssociation": boolean,
         "IsReadOnly": boolean
      },
      "LastModifiedRegion": "string",
      "LastModifiedTime": number,
      "Name": "string",
      "Purposes": [ "string" ],
      "Values": { ... }
   }
}
```

## Response Elements
<a name="API_DescribePredefinedAttribute_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PredefinedAttribute](#API_DescribePredefinedAttribute_ResponseSyntax) **   <a name="connect-DescribePredefinedAttribute-response-PredefinedAttribute"></a>
Information about the predefined attribute.  
Type: [PredefinedAttribute](API_PredefinedAttribute.md) object

## Errors
<a name="API_DescribePredefinedAttribute_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_DescribePredefinedAttribute_Examples"></a>

### Example
<a name="API_DescribePredefinedAttribute_Example_1"></a>

The following example shows a request and response.

```
GET https://connect.us-west-2.amazonaws.com/predefined-attributes/InstanceId/Name HTTP/1.1

Response:
{
    "PredefinedAttribute": {
        "AttributeConfiguration": {
            "EnableValueValidationOnAssociation": false,
            "IsReadOnly": false
        },
        "LastModifiedRegion": "us-west-2",
        "LastModifiedTime": 1.756932542054E9,
        "Name": "Custom",
        "Purposes": [
            "proficiency"
        ],
        "Values": {
            "StringList": [
                "value1",
                "value2"
            ]
        }
    }
}
```

## See Also
<a name="API_DescribePredefinedAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribePredefinedAttribute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribePredefinedAttribute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribePredefinedAttribute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribePredefinedAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribePredefinedAttribute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribePredefinedAttribute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribePredefinedAttribute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribePredefinedAttribute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribePredefinedAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribePredefinedAttribute) 

# DescribePrompt
<a name="API_DescribePrompt"></a>

Describes the prompt.

## Request Syntax
<a name="API_DescribePrompt_RequestSyntax"></a>

```
GET /prompts/InstanceId/PromptId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribePrompt_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DescribePrompt_RequestSyntax) **   <a name="connect-DescribePrompt-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [PromptId](#API_DescribePrompt_RequestSyntax) **   <a name="connect-DescribePrompt-request-uri-PromptId"></a>
A unique identifier for the prompt.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_DescribePrompt_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribePrompt_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Prompt": { 
      "Description": "string",
      "LastModifiedRegion": "string",
      "LastModifiedTime": number,
      "Name": "string",
      "PromptARN": "string",
      "PromptId": "string",
      "Tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_DescribePrompt_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Prompt](#API_DescribePrompt_ResponseSyntax) **   <a name="connect-DescribePrompt-response-Prompt"></a>
Information about the prompt.  
Type: [Prompt](API_Prompt.md) object

## Errors
<a name="API_DescribePrompt_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribePrompt_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribePrompt) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribePrompt) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribePrompt) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribePrompt) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribePrompt) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribePrompt) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribePrompt) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribePrompt) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribePrompt) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribePrompt) 

# DescribeQueue
<a name="API_DescribeQueue"></a>

Describes the specified queue.

## Request Syntax
<a name="API_DescribeQueue_RequestSyntax"></a>

```
GET /queues/InstanceId/QueueId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeQueue_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DescribeQueue_RequestSyntax) **   <a name="connect-DescribeQueue-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [QueueId](#API_DescribeQueue_RequestSyntax) **   <a name="connect-DescribeQueue-request-uri-QueueId"></a>
The identifier for the queue.  
Required: Yes

## Request Body
<a name="API_DescribeQueue_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeQueue_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Queue": { 
      "Description": "string",
      "HoursOfOperationId": "string",
      "LastModifiedRegion": "string",
      "LastModifiedTime": number,
      "MaxContacts": number,
      "Name": "string",
      "OutboundCallerConfig": { 
         "OutboundCallerIdName": "string",
         "OutboundCallerIdNumberId": "string",
         "OutboundFlowId": "string"
      },
      "OutboundEmailConfig": { 
         "OutboundEmailAddressId": "string"
      },
      "QueueArn": "string",
      "QueueId": "string",
      "Status": "string",
      "Tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_DescribeQueue_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Queue](#API_DescribeQueue_ResponseSyntax) **   <a name="connect-DescribeQueue-response-Queue"></a>
The name of the queue.  
Type: [Queue](API_Queue.md) object

## Errors
<a name="API_DescribeQueue_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeQueue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeQueue) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeQueue) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeQueue) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeQueue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeQueue) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeQueue) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeQueue) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeQueue) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeQueue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeQueue) 

# DescribeQuickConnect
<a name="API_DescribeQuickConnect"></a>

Describes the quick connect.

## Request Syntax
<a name="API_DescribeQuickConnect_RequestSyntax"></a>

```
GET /quick-connects/InstanceId/QuickConnectId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeQuickConnect_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DescribeQuickConnect_RequestSyntax) **   <a name="connect-DescribeQuickConnect-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [QuickConnectId](#API_DescribeQuickConnect_RequestSyntax) **   <a name="connect-DescribeQuickConnect-request-uri-QuickConnectId"></a>
The identifier for the quick connect.  
Required: Yes

## Request Body
<a name="API_DescribeQuickConnect_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeQuickConnect_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "QuickConnect": { 
      "Description": "string",
      "LastModifiedRegion": "string",
      "LastModifiedTime": number,
      "Name": "string",
      "QuickConnectARN": "string",
      "QuickConnectConfig": { 
         "FlowConfig": { 
            "ContactFlowId": "string"
         },
         "PhoneConfig": { 
            "PhoneNumber": "string"
         },
         "QueueConfig": { 
            "ContactFlowId": "string",
            "QueueId": "string"
         },
         "QuickConnectType": "string",
         "UserConfig": { 
            "ContactFlowId": "string",
            "UserId": "string"
         }
      },
      "QuickConnectId": "string",
      "Tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_DescribeQuickConnect_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [QuickConnect](#API_DescribeQuickConnect_ResponseSyntax) **   <a name="connect-DescribeQuickConnect-response-QuickConnect"></a>
Information about the quick connect.  
Type: [QuickConnect](API_QuickConnect.md) object

## Errors
<a name="API_DescribeQuickConnect_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeQuickConnect_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeQuickConnect) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeQuickConnect) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeQuickConnect) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeQuickConnect) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeQuickConnect) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeQuickConnect) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeQuickConnect) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeQuickConnect) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeQuickConnect) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeQuickConnect) 

# DescribeRoutingProfile
<a name="API_DescribeRoutingProfile"></a>

Describes the specified routing profile.

**Note**  
 `DescribeRoutingProfile` does not populate AssociatedQueueIds in its response. The example Response Syntax shown on this page is incorrect; we are working to update it. [SearchRoutingProfiles](https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html) does include AssociatedQueueIds.

## Request Syntax
<a name="API_DescribeRoutingProfile_RequestSyntax"></a>

```
GET /routing-profiles/InstanceId/RoutingProfileId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeRoutingProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DescribeRoutingProfile_RequestSyntax) **   <a name="connect-DescribeRoutingProfile-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [RoutingProfileId](#API_DescribeRoutingProfile_RequestSyntax) **   <a name="connect-DescribeRoutingProfile-request-uri-RoutingProfileId"></a>
The identifier of the routing profile.  
Required: Yes

## Request Body
<a name="API_DescribeRoutingProfile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeRoutingProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "RoutingProfile": { 
      "AgentAvailabilityTimer": "string",
      "AssociatedManualAssignmentQueueIds": [ "string" ],
      "AssociatedQueueIds": [ "string" ],
      "DefaultOutboundQueueId": "string",
      "Description": "string",
      "InstanceId": "string",
      "IsDefault": boolean,
      "LastModifiedRegion": "string",
      "LastModifiedTime": number,
      "MediaConcurrencies": [ 
         { 
            "Channel": "string",
            "Concurrency": number,
            "CrossChannelBehavior": { 
               "BehaviorType": "string"
            }
         }
      ],
      "Name": "string",
      "NumberOfAssociatedManualAssignmentQueues": number,
      "NumberOfAssociatedQueues": number,
      "NumberOfAssociatedUsers": number,
      "RoutingProfileArn": "string",
      "RoutingProfileId": "string",
      "Tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_DescribeRoutingProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [RoutingProfile](#API_DescribeRoutingProfile_ResponseSyntax) **   <a name="connect-DescribeRoutingProfile-response-RoutingProfile"></a>
The routing profile.  
Type: [RoutingProfile](API_RoutingProfile.md) object

## Errors
<a name="API_DescribeRoutingProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeRoutingProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeRoutingProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeRoutingProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeRoutingProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeRoutingProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeRoutingProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeRoutingProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeRoutingProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeRoutingProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeRoutingProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeRoutingProfile) 

# DescribeRule
<a name="API_DescribeRule"></a>

Describes a rule for the specified Amazon Connect instance.

## Request Syntax
<a name="API_DescribeRule_RequestSyntax"></a>

```
GET /rules/InstanceId/RuleId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeRule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DescribeRule_RequestSyntax) **   <a name="connect-DescribeRule-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [RuleId](#API_DescribeRule_RequestSyntax) **   <a name="connect-DescribeRule-request-uri-RuleId"></a>
A unique identifier for the rule.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_DescribeRule_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeRule_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Rule": { 
      "Actions": [ 
         { 
            "ActionType": "string",
            "AssignContactCategoryAction": { 
            },
            "AssignSlaAction": { 
               "CaseSlaConfiguration": { 
                  "FieldId": "string",
                  "Name": "string",
                  "TargetFieldValues": [ 
                     { 
                        "BooleanValue": boolean,
                        "DoubleValue": number,
                        "EmptyValue": { 
                        },
                        "StringValue": "string"
                     }
                  ],
                  "TargetSlaMinutes": number,
                  "Type": "string"
               },
               "SlaAssignmentType": "string"
            },
            "CreateCaseAction": { 
               "Fields": [ 
                  { 
                     "Id": "string",
                     "Value": { 
                        "BooleanValue": boolean,
                        "DoubleValue": number,
                        "EmptyValue": { 
                        },
                        "StringValue": "string"
                     }
                  }
               ],
               "TemplateId": "string"
            },
            "EndAssociatedTasksAction": { 
            },
            "EventBridgeAction": { 
               "Name": "string"
            },
            "SendNotificationAction": { 
               "Content": "string",
               "ContentType": "string",
               "DeliveryMethod": "string",
               "Exclusion": { 
                  "UserIds": [ "string" ],
                  "UserTags": { 
                     "string" : "string" 
                  }
               },
               "Recipient": { 
                  "UserIds": [ "string" ],
                  "UserTags": { 
                     "string" : "string" 
                  }
               },
               "Subject": "string"
            },
            "SubmitAutoEvaluationAction": { 
               "EvaluationFormId": "string"
            },
            "TaskAction": { 
               "ContactFlowId": "string",
               "Description": "string",
               "Name": "string",
               "References": { 
                  "string" : { 
                     "Arn": "string",
                     "Status": "string",
                     "StatusReason": "string",
                     "Type": "string",
                     "Value": "string"
                  }
               }
            },
            "UpdateCaseAction": { 
               "Fields": [ 
                  { 
                     "Id": "string",
                     "Value": { 
                        "BooleanValue": boolean,
                        "DoubleValue": number,
                        "EmptyValue": { 
                        },
                        "StringValue": "string"
                     }
                  }
               ]
            }
         }
      ],
      "CreatedTime": number,
      "Function": "string",
      "LastUpdatedBy": "string",
      "LastUpdatedTime": number,
      "Name": "string",
      "PublishStatus": "string",
      "RuleArn": "string",
      "RuleId": "string",
      "Tags": { 
         "string" : "string" 
      },
      "TriggerEventSource": { 
         "EventSourceName": "string",
         "IntegrationAssociationId": "string"
      }
   }
}
```

## Response Elements
<a name="API_DescribeRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Rule](#API_DescribeRule_ResponseSyntax) **   <a name="connect-DescribeRule-response-Rule"></a>
Information about the rule.  
Type: [Rule](API_Rule.md) object

## Errors
<a name="API_DescribeRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeRule) 

# DescribeSecurityProfile
<a name="API_DescribeSecurityProfile"></a>

Gets basic information about the security profile.

For information about security profiles, see [Security Profiles](https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html) in the *Amazon Connect Administrator Guide*. For a mapping of the API name and user interface name of the security profile permissions, see [List of security profile permissions](https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html). 

## Request Syntax
<a name="API_DescribeSecurityProfile_RequestSyntax"></a>

```
GET /security-profiles/InstanceId/SecurityProfileId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeSecurityProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DescribeSecurityProfile_RequestSyntax) **   <a name="connect-DescribeSecurityProfile-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [SecurityProfileId](#API_DescribeSecurityProfile_RequestSyntax) **   <a name="connect-DescribeSecurityProfile-request-uri-SecurityProfileId"></a>
The identifier for the security profle.  
Required: Yes

## Request Body
<a name="API_DescribeSecurityProfile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeSecurityProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "SecurityProfile": { 
      "AllowedAccessControlHierarchyGroupId": "string",
      "AllowedAccessControlTags": { 
         "string" : "string" 
      },
      "Arn": "string",
      "Description": "string",
      "GranularAccessControlConfiguration": { 
         "DataTableAccessControlConfiguration": { 
            "PrimaryAttributeAccessControlConfiguration": { 
               "PrimaryAttributeValues": [ 
                  { 
                     "AccessType": "string",
                     "AttributeName": "string",
                     "Values": [ "string" ]
                  }
               ]
            }
         }
      },
      "HierarchyRestrictedResources": [ "string" ],
      "Id": "string",
      "LastModifiedRegion": "string",
      "LastModifiedTime": number,
      "OrganizationResourceId": "string",
      "SecurityProfileName": "string",
      "TagRestrictedResources": [ "string" ],
      "Tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_DescribeSecurityProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [SecurityProfile](#API_DescribeSecurityProfile_ResponseSyntax) **   <a name="connect-DescribeSecurityProfile-response-SecurityProfile"></a>
The security profile.  
Type: [SecurityProfile](API_SecurityProfile.md) object

## Errors
<a name="API_DescribeSecurityProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeSecurityProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeSecurityProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeSecurityProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeSecurityProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeSecurityProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeSecurityProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeSecurityProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeSecurityProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeSecurityProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeSecurityProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeSecurityProfile) 

# DescribeTestCase
<a name="API_DescribeTestCase"></a>

Describes the specified test case and allows you to get the content and metadata of the test case for the specified Amazon Connect instance.

## Request Syntax
<a name="API_DescribeTestCase_RequestSyntax"></a>

```
GET /test-cases/InstanceId/TestCaseId?status=Status HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeTestCase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DescribeTestCase_RequestSyntax) **   <a name="connect-DescribeTestCase-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

 ** [Status](#API_DescribeTestCase_RequestSyntax) **   <a name="connect-DescribeTestCase-request-uri-Status"></a>
The status of the test case version to retrieve. If not specified, returns the published version if available, otherwise returns the saved version.  
Valid Values: `PUBLISHED | SAVED` 

 ** [TestCaseId](#API_DescribeTestCase_RequestSyntax) **   <a name="connect-DescribeTestCase-request-uri-TestCaseId"></a>
The identifier of the test case.  
Length Constraints: Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_DescribeTestCase_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeTestCase_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "TestCase": { 
      "Arn": "string",
      "Content": "string",
      "Description": "string",
      "EntryPoint": { 
         "ChatEntryPointParameters": { 
            "FlowId": "string"
         },
         "Type": "string",
         "VoiceCallEntryPointParameters": { 
            "DestinationPhoneNumber": "string",
            "FlowId": "string",
            "SourcePhoneNumber": "string"
         }
      },
      "Id": "string",
      "InitializationData": "string",
      "LastModifiedRegion": "string",
      "LastModifiedTime": number,
      "Name": "string",
      "Status": "string",
      "Tags": { 
         "string" : "string" 
      },
      "TestCaseSha256": "string"
   }
}
```

## Response Elements
<a name="API_DescribeTestCase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TestCase](#API_DescribeTestCase_ResponseSyntax) **   <a name="connect-DescribeTestCase-response-TestCase"></a>
The test case object containing all test case information.  
Type: [TestCase](API_TestCase.md) object

## Errors
<a name="API_DescribeTestCase_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeTestCase_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeTestCase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeTestCase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeTestCase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeTestCase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeTestCase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeTestCase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeTestCase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeTestCase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeTestCase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeTestCase) 

# DescribeTrafficDistributionGroup
<a name="API_DescribeTrafficDistributionGroup"></a>

Gets details and status of a traffic distribution group.

## Request Syntax
<a name="API_DescribeTrafficDistributionGroup_RequestSyntax"></a>

```
GET /traffic-distribution-group/TrafficDistributionGroupId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeTrafficDistributionGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [TrafficDistributionGroupId](#API_DescribeTrafficDistributionGroup_RequestSyntax) **   <a name="connect-DescribeTrafficDistributionGroup-request-uri-TrafficDistributionGroupId"></a>
The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z-]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

## Request Body
<a name="API_DescribeTrafficDistributionGroup_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeTrafficDistributionGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "TrafficDistributionGroup": { 
      "Arn": "string",
      "Description": "string",
      "Id": "string",
      "InstanceArn": "string",
      "IsDefault": boolean,
      "Name": "string",
      "Status": "string",
      "Tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_DescribeTrafficDistributionGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [TrafficDistributionGroup](#API_DescribeTrafficDistributionGroup_ResponseSyntax) **   <a name="connect-DescribeTrafficDistributionGroup-response-TrafficDistributionGroup"></a>
Information about the traffic distribution group.  
Type: [TrafficDistributionGroup](API_TrafficDistributionGroup.md) object

## Errors
<a name="API_DescribeTrafficDistributionGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeTrafficDistributionGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeTrafficDistributionGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeTrafficDistributionGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeTrafficDistributionGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeTrafficDistributionGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeTrafficDistributionGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeTrafficDistributionGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeTrafficDistributionGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeTrafficDistributionGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeTrafficDistributionGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeTrafficDistributionGroup) 

# DescribeUser
<a name="API_DescribeUser"></a>

Describes the specified user. You can [find the instance ID in the Amazon Connect console](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

## Request Syntax
<a name="API_DescribeUser_RequestSyntax"></a>

```
GET /users/InstanceId/UserId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeUser_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DescribeUser_RequestSyntax) **   <a name="connect-DescribeUser-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [UserId](#API_DescribeUser_RequestSyntax) **   <a name="connect-DescribeUser-request-uri-UserId"></a>
The identifier of the user account.  
Required: Yes

## Request Body
<a name="API_DescribeUser_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeUser_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "User": { 
      "AfterContactWorkConfigs": [ 
         { 
            "AfterContactWorkConfig": { 
               "AfterContactWorkTimeLimit": number
            },
            "AgentFirstCallbackAfterContactWorkConfig": { 
               "AfterContactWorkTimeLimit": number
            },
            "Channel": "string"
         }
      ],
      "Arn": "string",
      "AutoAcceptConfigs": [ 
         { 
            "AgentFirstCallbackAutoAccept": boolean,
            "AutoAccept": boolean,
            "Channel": "string"
         }
      ],
      "DirectoryUserId": "string",
      "HierarchyGroupId": "string",
      "Id": "string",
      "IdentityInfo": { 
         "Email": "string",
         "FirstName": "string",
         "LastName": "string",
         "Mobile": "string",
         "SecondaryEmail": "string"
      },
      "LastModifiedRegion": "string",
      "LastModifiedTime": number,
      "PersistentConnectionConfigs": [ 
         { 
            "Channel": "string",
            "PersistentConnection": boolean
         }
      ],
      "PhoneConfig": { 
         "AfterContactWorkTimeLimit": number,
         "AutoAccept": boolean,
         "DeskPhoneNumber": "string",
         "PersistentConnection": boolean,
         "PhoneType": "string"
      },
      "PhoneNumberConfigs": [ 
         { 
            "Channel": "string",
            "PhoneNumber": "string",
            "PhoneType": "string"
         }
      ],
      "RoutingProfileId": "string",
      "SecurityProfileIds": [ "string" ],
      "Tags": { 
         "string" : "string" 
      },
      "Username": "string",
      "VoiceEnhancementConfigs": [ 
         { 
            "Channel": "string",
            "VoiceEnhancementMode": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_DescribeUser_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [User](#API_DescribeUser_ResponseSyntax) **   <a name="connect-DescribeUser-response-User"></a>
Information about the user account and configuration settings.  
Type: [User](API_User.md) object

## Errors
<a name="API_DescribeUser_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeUser_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeUser) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeUser) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeUser) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeUser) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeUser) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeUser) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeUser) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeUser) 

# DescribeUserHierarchyGroup
<a name="API_DescribeUserHierarchyGroup"></a>

Describes the specified hierarchy group.

## Request Syntax
<a name="API_DescribeUserHierarchyGroup_RequestSyntax"></a>

```
GET /user-hierarchy-groups/InstanceId/HierarchyGroupId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeUserHierarchyGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [HierarchyGroupId](#API_DescribeUserHierarchyGroup_RequestSyntax) **   <a name="connect-DescribeUserHierarchyGroup-request-uri-HierarchyGroupId"></a>
The identifier of the hierarchy group.  
Required: Yes

 ** [InstanceId](#API_DescribeUserHierarchyGroup_RequestSyntax) **   <a name="connect-DescribeUserHierarchyGroup-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DescribeUserHierarchyGroup_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeUserHierarchyGroup_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "HierarchyGroup": { 
      "Arn": "string",
      "HierarchyPath": { 
         "LevelFive": { 
            "Arn": "string",
            "Id": "string",
            "LastModifiedRegion": "string",
            "LastModifiedTime": number,
            "Name": "string"
         },
         "LevelFour": { 
            "Arn": "string",
            "Id": "string",
            "LastModifiedRegion": "string",
            "LastModifiedTime": number,
            "Name": "string"
         },
         "LevelOne": { 
            "Arn": "string",
            "Id": "string",
            "LastModifiedRegion": "string",
            "LastModifiedTime": number,
            "Name": "string"
         },
         "LevelThree": { 
            "Arn": "string",
            "Id": "string",
            "LastModifiedRegion": "string",
            "LastModifiedTime": number,
            "Name": "string"
         },
         "LevelTwo": { 
            "Arn": "string",
            "Id": "string",
            "LastModifiedRegion": "string",
            "LastModifiedTime": number,
            "Name": "string"
         }
      },
      "Id": "string",
      "LastModifiedRegion": "string",
      "LastModifiedTime": number,
      "LevelId": "string",
      "Name": "string",
      "Tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_DescribeUserHierarchyGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [HierarchyGroup](#API_DescribeUserHierarchyGroup_ResponseSyntax) **   <a name="connect-DescribeUserHierarchyGroup-response-HierarchyGroup"></a>
Information about the hierarchy group.  
Type: [HierarchyGroup](API_HierarchyGroup.md) object

## Errors
<a name="API_DescribeUserHierarchyGroup_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeUserHierarchyGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeUserHierarchyGroup) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeUserHierarchyGroup) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeUserHierarchyGroup) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeUserHierarchyGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeUserHierarchyGroup) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeUserHierarchyGroup) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeUserHierarchyGroup) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeUserHierarchyGroup) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeUserHierarchyGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeUserHierarchyGroup) 

# DescribeUserHierarchyStructure
<a name="API_DescribeUserHierarchyStructure"></a>

Describes the hierarchy structure of the specified Amazon Connect instance.

## Request Syntax
<a name="API_DescribeUserHierarchyStructure_RequestSyntax"></a>

```
GET /user-hierarchy-structure/InstanceId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeUserHierarchyStructure_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DescribeUserHierarchyStructure_RequestSyntax) **   <a name="connect-DescribeUserHierarchyStructure-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DescribeUserHierarchyStructure_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeUserHierarchyStructure_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "HierarchyStructure": { 
      "LevelFive": { 
         "Arn": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string"
      },
      "LevelFour": { 
         "Arn": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string"
      },
      "LevelOne": { 
         "Arn": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string"
      },
      "LevelThree": { 
         "Arn": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string"
      },
      "LevelTwo": { 
         "Arn": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string"
      }
   }
}
```

## Response Elements
<a name="API_DescribeUserHierarchyStructure_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [HierarchyStructure](#API_DescribeUserHierarchyStructure_ResponseSyntax) **   <a name="connect-DescribeUserHierarchyStructure-response-HierarchyStructure"></a>
Information about the hierarchy structure.  
Type: [HierarchyStructure](API_HierarchyStructure.md) object

## Errors
<a name="API_DescribeUserHierarchyStructure_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeUserHierarchyStructure_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeUserHierarchyStructure) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeUserHierarchyStructure) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeUserHierarchyStructure) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeUserHierarchyStructure) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeUserHierarchyStructure) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeUserHierarchyStructure) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeUserHierarchyStructure) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeUserHierarchyStructure) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeUserHierarchyStructure) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeUserHierarchyStructure) 

# DescribeView
<a name="API_DescribeView"></a>

Retrieves the view for the specified Amazon Connect instance and view identifier.

The view identifier can be supplied as a ViewId or ARN.

 `$SAVED` needs to be supplied if a view is unpublished.

The view identifier can contain an optional qualifier, for example, `<view-id>:$SAVED`, which is either an actual version number or an Amazon Connect managed qualifier `$SAVED | $LATEST`. If it is not supplied, then `$LATEST` is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for AWS managed views.

## Request Syntax
<a name="API_DescribeView_RequestSyntax"></a>

```
GET /views/InstanceId/ViewId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeView_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DescribeView_RequestSyntax) **   <a name="connect-DescribeView-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9\_\-:\/]+$`   
Required: Yes

 ** [ViewId](#API_DescribeView_RequestSyntax) **   <a name="connect-DescribeView-request-uri-ViewId"></a>
The ViewId of the view. This must be an ARN for AWS managed views.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Pattern: `^[a-zA-Z0-9\_\-:\/$]+$`   
Required: Yes

## Request Body
<a name="API_DescribeView_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeView_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "View": { 
      "Arn": "string",
      "Content": { 
         "Actions": [ "string" ],
         "InputSchema": "string",
         "Template": "string"
      },
      "CreatedTime": number,
      "Description": "string",
      "Id": "string",
      "LastModifiedTime": number,
      "Name": "string",
      "Status": "string",
      "Tags": { 
         "string" : "string" 
      },
      "Type": "string",
      "Version": number,
      "VersionDescription": "string",
      "ViewContentSha256": "string"
   }
}
```

## Response Elements
<a name="API_DescribeView_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [View](#API_DescribeView_ResponseSyntax) **   <a name="connect-DescribeView-response-View"></a>
All view data is contained within the View object.  
Type: [View](API_View.md) object

## Errors
<a name="API_DescribeView_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** TooManyRequestsException **   
Displayed when rate-related API limits are exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeView_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeView) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeView) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeView) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeView) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeView) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeView) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeView) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeView) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeView) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeView) 

# DescribeVocabulary
<a name="API_DescribeVocabulary"></a>

Describes the specified vocabulary.

## Request Syntax
<a name="API_DescribeVocabulary_RequestSyntax"></a>

```
GET /vocabulary/InstanceId/VocabularyId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeVocabulary_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DescribeVocabulary_RequestSyntax) **   <a name="connect-DescribeVocabulary-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [VocabularyId](#API_DescribeVocabulary_RequestSyntax) **   <a name="connect-DescribeVocabulary-request-uri-VocabularyId"></a>
The identifier of the custom vocabulary.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_DescribeVocabulary_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeVocabulary_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Vocabulary": { 
      "Arn": "string",
      "Content": "string",
      "FailureReason": "string",
      "Id": "string",
      "LanguageCode": "string",
      "LastModifiedTime": number,
      "Name": "string",
      "State": "string",
      "Tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_DescribeVocabulary_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Vocabulary](#API_DescribeVocabulary_ResponseSyntax) **   <a name="connect-DescribeVocabulary-response-Vocabulary"></a>
A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They are generally domain-specific words and phrases, words that Contact Lens is not recognizing, or proper nouns.  
Type: [Vocabulary](API_Vocabulary.md) object

## Errors
<a name="API_DescribeVocabulary_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeVocabulary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeVocabulary) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeVocabulary) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeVocabulary) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeVocabulary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeVocabulary) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeVocabulary) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeVocabulary) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeVocabulary) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeVocabulary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeVocabulary) 

# DescribeWorkspace
<a name="API_DescribeWorkspace"></a>

Retrieves details about a workspace, including its configuration and metadata.

## Request Syntax
<a name="API_DescribeWorkspace_RequestSyntax"></a>

```
GET /workspaces/InstanceId/WorkspaceId HTTP/1.1
```

## URI Request Parameters
<a name="API_DescribeWorkspace_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DescribeWorkspace_RequestSyntax) **   <a name="connect-DescribeWorkspace-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [WorkspaceId](#API_DescribeWorkspace_RequestSyntax) **   <a name="connect-DescribeWorkspace-request-uri-WorkspaceId"></a>
The identifier of the workspace.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_DescribeWorkspace_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DescribeWorkspace_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Workspace": { 
      "Arn": "string",
      "Description": "string",
      "Id": "string",
      "LastModifiedRegion": "string",
      "LastModifiedTime": number,
      "Name": "string",
      "Tags": { 
         "string" : "string" 
      },
      "Theme": { 
         "Dark": { 
            "Images": { 
               "Logo": { 
                  "Default": "string",
                  "Favicon": "string"
               }
            },
            "Palette": { 
               "Canvas": { 
                  "ActiveBackground": "string",
                  "ContainerBackground": "string",
                  "PageBackground": "string"
               },
               "Header": { 
                  "Background": "string",
                  "InvertActionsColors": boolean,
                  "Text": "string",
                  "TextHover": "string"
               },
               "Navigation": { 
                  "Background": "string",
                  "InvertActionsColors": boolean,
                  "Text": "string",
                  "TextActive": "string",
                  "TextBackgroundActive": "string",
                  "TextBackgroundHover": "string",
                  "TextHover": "string"
               },
               "Primary": { 
                  "Active": "string",
                  "ContrastText": "string",
                  "Default": "string"
               }
            },
            "Typography": { 
               "FontFamily": { 
                  "Default": "string"
               }
            }
         },
         "Light": { 
            "Images": { 
               "Logo": { 
                  "Default": "string",
                  "Favicon": "string"
               }
            },
            "Palette": { 
               "Canvas": { 
                  "ActiveBackground": "string",
                  "ContainerBackground": "string",
                  "PageBackground": "string"
               },
               "Header": { 
                  "Background": "string",
                  "InvertActionsColors": boolean,
                  "Text": "string",
                  "TextHover": "string"
               },
               "Navigation": { 
                  "Background": "string",
                  "InvertActionsColors": boolean,
                  "Text": "string",
                  "TextActive": "string",
                  "TextBackgroundActive": "string",
                  "TextBackgroundHover": "string",
                  "TextHover": "string"
               },
               "Primary": { 
                  "Active": "string",
                  "ContrastText": "string",
                  "Default": "string"
               }
            },
            "Typography": { 
               "FontFamily": { 
                  "Default": "string"
               }
            }
         }
      },
      "Title": "string",
      "Visibility": "string"
   }
}
```

## Response Elements
<a name="API_DescribeWorkspace_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Workspace](#API_DescribeWorkspace_ResponseSyntax) **   <a name="connect-DescribeWorkspace-response-Workspace"></a>
Information about the workspace.  
Type: [Workspace](API_Workspace.md) object

## Errors
<a name="API_DescribeWorkspace_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DescribeWorkspace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DescribeWorkspace) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DescribeWorkspace) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DescribeWorkspace) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DescribeWorkspace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DescribeWorkspace) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DescribeWorkspace) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DescribeWorkspace) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DescribeWorkspace) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DescribeWorkspace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DescribeWorkspace) 

# DisassociateAnalyticsDataSet
<a name="API_DisassociateAnalyticsDataSet"></a>

Removes the dataset ID associated with a given Amazon Connect instance.

## Request Syntax
<a name="API_DisassociateAnalyticsDataSet_RequestSyntax"></a>

```
POST /analytics-data/instance/InstanceId/association HTTP/1.1
Content-type: application/json

{
   "DataSetId": "string",
   "TargetAccountId": "string"
}
```

## URI Request Parameters
<a name="API_DisassociateAnalyticsDataSet_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DisassociateAnalyticsDataSet_RequestSyntax) **   <a name="connect-DisassociateAnalyticsDataSet-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DisassociateAnalyticsDataSet_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [DataSetId](#API_DisassociateAnalyticsDataSet_RequestSyntax) **   <a name="connect-DisassociateAnalyticsDataSet-request-DataSetId"></a>
The identifier of the dataset to remove.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** [TargetAccountId](#API_DisassociateAnalyticsDataSet_RequestSyntax) **   <a name="connect-DisassociateAnalyticsDataSet-request-TargetAccountId"></a>
The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the AWS account that has the Amazon Connect instance.  
Type: String  
Required: No

## Response Syntax
<a name="API_DisassociateAnalyticsDataSet_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DisassociateAnalyticsDataSet_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateAnalyticsDataSet_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DisassociateAnalyticsDataSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DisassociateAnalyticsDataSet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DisassociateAnalyticsDataSet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DisassociateAnalyticsDataSet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DisassociateAnalyticsDataSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DisassociateAnalyticsDataSet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DisassociateAnalyticsDataSet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DisassociateAnalyticsDataSet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DisassociateAnalyticsDataSet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DisassociateAnalyticsDataSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DisassociateAnalyticsDataSet) 

# DisassociateApprovedOrigin
<a name="API_DisassociateApprovedOrigin"></a>

This API is in preview release for Amazon Connect and is subject to change.

Revokes access to integrated applications from Amazon Connect.

## Request Syntax
<a name="API_DisassociateApprovedOrigin_RequestSyntax"></a>

```
DELETE /instance/InstanceId/approved-origin?clientToken=ClientToken&origin=Origin HTTP/1.1
```

## URI Request Parameters
<a name="API_DisassociateApprovedOrigin_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ClientToken](#API_DisassociateApprovedOrigin_RequestSyntax) **   <a name="connect-DisassociateApprovedOrigin-request-uri-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Length Constraints: Maximum length of 500.

 ** [InstanceId](#API_DisassociateApprovedOrigin_RequestSyntax) **   <a name="connect-DisassociateApprovedOrigin-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [Origin](#API_DisassociateApprovedOrigin_RequestSyntax) **   <a name="connect-DisassociateApprovedOrigin-request-uri-Origin"></a>
The domain URL of the integrated application.  
Length Constraints: Maximum length of 267.  
Required: Yes

## Request Body
<a name="API_DisassociateApprovedOrigin_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DisassociateApprovedOrigin_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DisassociateApprovedOrigin_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateApprovedOrigin_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DisassociateApprovedOrigin_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DisassociateApprovedOrigin) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DisassociateApprovedOrigin) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DisassociateApprovedOrigin) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DisassociateApprovedOrigin) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DisassociateApprovedOrigin) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DisassociateApprovedOrigin) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DisassociateApprovedOrigin) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DisassociateApprovedOrigin) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DisassociateApprovedOrigin) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DisassociateApprovedOrigin) 

# DisassociateBot
<a name="API_DisassociateBot"></a>

This API is in preview release for Amazon Connect and is subject to change.

Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot. 

## Request Syntax
<a name="API_DisassociateBot_RequestSyntax"></a>

```
POST /instance/InstanceId/bot HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "LexBot": { 
      "LexRegion": "string",
      "Name": "string"
   },
   "LexV2Bot": { 
      "AliasArn": "string"
   }
}
```

## URI Request Parameters
<a name="API_DisassociateBot_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DisassociateBot_RequestSyntax) **   <a name="connect-DisassociateBot-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DisassociateBot_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_DisassociateBot_RequestSyntax) **   <a name="connect-DisassociateBot-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [LexBot](#API_DisassociateBot_RequestSyntax) **   <a name="connect-DisassociateBot-request-LexBot"></a>
Configuration information of an Amazon Lex bot.  
Type: [LexBot](API_LexBot.md) object  
Required: No

 ** [LexV2Bot](#API_DisassociateBot_RequestSyntax) **   <a name="connect-DisassociateBot-request-LexV2Bot"></a>
The Amazon Lex V2 bot to disassociate from the instance.  
Type: [LexV2Bot](API_LexV2Bot.md) object  
Required: No

## Response Syntax
<a name="API_DisassociateBot_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DisassociateBot_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateBot_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DisassociateBot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DisassociateBot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DisassociateBot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DisassociateBot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DisassociateBot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DisassociateBot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DisassociateBot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DisassociateBot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DisassociateBot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DisassociateBot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DisassociateBot) 

# DisassociateEmailAddressAlias
<a name="API_DisassociateEmailAddressAlias"></a>

Removes the alias association between two email addresses in an Amazon Connect instance. After disassociation, emails sent to the former alias email address are no longer forwarded to the primary email address. Both email addresses continue to exist independently and can receive emails directly.

 **Use cases** 

Following are common uses cases for this API:
+  **Department separation**: Remove alias relationships when splitting a consolidated support queue back into separate department-specific queues.
+  **Email address retirement**: Cleanly remove forwarding relationships before decommissioning old email addresses.
+  **Organizational restructuring**: Reconfigure email routing when business processes change and aliases are no longer needed.

 **Important things to know** 
+ Concurrent operations: This API uses distributed locking, so concurrent operations on the same email addresses may be temporarily blocked.
+ Emails sent to the former alias address are still delivered directly to that address if it exists.
+ You do not need to delete the email addresses after disassociation. Both addresses remain active independently.
+ After a successful disassociation, you can immediately create a new alias relationship with the same addresses.
+ 200 status means alias was successfully disassociated.

 `DisassociateEmailAddressAlias` does not return the following information:
+ Details in the response about the email that was disassociated. The response returns an empty body.
+ The timestamp of when the disassociation occurred.

 **Endpoints**: See [Amazon Connect endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/connect_region.html).

 **Related operations** 
+  [AssociateEmailAddressAlias](https://docs.aws.amazon.com/connect/latest/APIReference/API_AssociateEmailAddressAlias.html): Associates an email address alias with an existing email address in an Amazon Connect instance.
+  [DescribeEmailAddress](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeEmailAddress.html): View current alias configurations for an email address.
+  [SearchEmailAddresses](https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchEmailAddresses.html): Find email addresses and their alias relationships across an instance.
+  [CreateEmailAddress](https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateEmailAddress.html): Create new email addresses that can participate in alias relationships.
+  [DeleteEmailAddress](https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteEmailAddress.html): Remove email addresses (automatically removes any alias relationships).
+  [UpdateEmailAddressMetadata](https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateEmailAddressMetadata.html): Modify email address properties (does not affect alias relationships).

## Request Syntax
<a name="API_DisassociateEmailAddressAlias_RequestSyntax"></a>

```
POST /email-addresses/InstanceId/EmailAddressId/disassociate-alias HTTP/1.1
Content-type: application/json

{
   "AliasConfiguration": { 
      "EmailAddressId": "string"
   },
   "ClientToken": "string"
}
```

## URI Request Parameters
<a name="API_DisassociateEmailAddressAlias_RequestParameters"></a>

The request uses the following URI parameters.

 ** [EmailAddressId](#API_DisassociateEmailAddressAlias_RequestSyntax) **   <a name="connect-DisassociateEmailAddressAlias-request-uri-EmailAddressId"></a>
The identifier of the email address.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [InstanceId](#API_DisassociateEmailAddressAlias_RequestSyntax) **   <a name="connect-DisassociateEmailAddressAlias-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DisassociateEmailAddressAlias_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AliasConfiguration](#API_DisassociateEmailAddressAlias_RequestSyntax) **   <a name="connect-DisassociateEmailAddressAlias-request-AliasConfiguration"></a>
Configuration object that specifies which alias relationship to remove. The alias association must currently exist between the primary email address and the specified alias email address.  
Type: [AliasConfiguration](API_AliasConfiguration.md) object  
Required: Yes

 ** [ClientToken](#API_DisassociateEmailAddressAlias_RequestSyntax) **   <a name="connect-DisassociateEmailAddressAlias-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

## Response Syntax
<a name="API_DisassociateEmailAddressAlias_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DisassociateEmailAddressAlias_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateEmailAddressAlias_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_DisassociateEmailAddressAlias_Examples"></a>

### Example 1: Basic alias removal
<a name="API_DisassociateEmailAddressAlias_Example_1"></a>

The following example removes the forwarding relationship between two email addresses. 

```
POST / HTTP/1.1
Host: connect.us-east-1.amazonaws.com
Content-Length: 156
X-Amz-Target: AmazonConnectService.DisassociateEmailAddressAlias
X-Amz-Date: 20170705T211529Z
Authorization: AWS4-HMAC-SHA256\
 Credential=AKIAI44QH8DHBEXAMPLE/20170705/us-east-1/connect/aws4_request,\
 SignedHeaders=content-type;host;x-amz-date;x-amz-target,\
 Signature=6bcb6a5ef9ee7585d83955e8a5c3f6d47cf581596208fc0e436fa1de26ef3f6a
Content-Type: application/x-amz-json-1.1
{
    "InstanceId": "12345678-1234-1234-1234-123456789012",
    "EmailAddressId": "87654321-4321-4321-4321-210987654321",
    "AliasConfiguration": {
        "EmailAddressId": "11111111-2222-3333-4444-555555555555"
    }
}
```

### Example 2: Alias removal with error handling
<a name="API_DisassociateEmailAddressAlias_Example_2"></a>

The following example response shows a safely removed alias with proper error handling for non-existent relationships.

```
HTTP/1.1 200 OK
Date: Wed, 05 Jul 2017 21:15:29 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 2
Connection: keep-alive
x-amzn-RequestId: 12345678-1234-1234-1234-123456789012
{}
```

## See Also
<a name="API_DisassociateEmailAddressAlias_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DisassociateEmailAddressAlias) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DisassociateEmailAddressAlias) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DisassociateEmailAddressAlias) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DisassociateEmailAddressAlias) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DisassociateEmailAddressAlias) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DisassociateEmailAddressAlias) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DisassociateEmailAddressAlias) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DisassociateEmailAddressAlias) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DisassociateEmailAddressAlias) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DisassociateEmailAddressAlias) 

# DisassociateFlow
<a name="API_DisassociateFlow"></a>

Disassociates a connect resource from a flow.

## Request Syntax
<a name="API_DisassociateFlow_RequestSyntax"></a>

```
DELETE /flow-associations/InstanceId/ResourceId/ResourceType HTTP/1.1
```

## URI Request Parameters
<a name="API_DisassociateFlow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DisassociateFlow_RequestSyntax) **   <a name="connect-DisassociateFlow-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [ResourceId](#API_DisassociateFlow_RequestSyntax) **   <a name="connect-DisassociateFlow-request-uri-ResourceId"></a>
The identifier of the resource.  
+  AWS End User Messaging SMS phone number ARN when using `SMS_PHONE_NUMBER` 
+  AWS End User Messaging Social phone number ARN when using `WHATSAPP_MESSAGING_PHONE_NUMBER` 
Required: Yes

 ** [ResourceType](#API_DisassociateFlow_RequestSyntax) **   <a name="connect-DisassociateFlow-request-uri-ResourceType"></a>
A valid resource type.  
Valid Values: `SMS_PHONE_NUMBER | INBOUND_EMAIL | OUTBOUND_EMAIL | ANALYTICS_CONNECTOR | WHATSAPP_MESSAGING_PHONE_NUMBER`   
Required: Yes

## Request Body
<a name="API_DisassociateFlow_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DisassociateFlow_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DisassociateFlow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateFlow_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DisassociateFlow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DisassociateFlow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DisassociateFlow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DisassociateFlow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DisassociateFlow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DisassociateFlow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DisassociateFlow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DisassociateFlow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DisassociateFlow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DisassociateFlow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DisassociateFlow) 

# DisassociateHoursOfOperations
<a name="API_DisassociateHoursOfOperations"></a>

Disassociates a set of hours of operations with another hours of operation. Refer to Administrator Guide [ here ](https://docs.aws.amazon.com/connect/latest/adminguide/hours-of-operation-overrides.html) for more information on inheriting overrides from parent hours of operation(s).

## Request Syntax
<a name="API_DisassociateHoursOfOperations_RequestSyntax"></a>

```
POST /hours-of-operations/InstanceId/HoursOfOperationId/disassociate-hours HTTP/1.1
Content-type: application/json

{
   "ParentHoursOfOperationIds": [ "string" ]
}
```

## URI Request Parameters
<a name="API_DisassociateHoursOfOperations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [HoursOfOperationId](#API_DisassociateHoursOfOperations_RequestSyntax) **   <a name="connect-DisassociateHoursOfOperations-request-uri-HoursOfOperationId"></a>
The identifier of the child hours of operation.  
Required: Yes

 ** [InstanceId](#API_DisassociateHoursOfOperations_RequestSyntax) **   <a name="connect-DisassociateHoursOfOperations-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DisassociateHoursOfOperations_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ParentHoursOfOperationIds](#API_DisassociateHoursOfOperations_RequestSyntax) **   <a name="connect-DisassociateHoursOfOperations-request-ParentHoursOfOperationIds"></a>
The Amazon Resource Names (ARNs) of the parent hours of operation resources to disassociate with the child hours of operation resource.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 3 items.  
Required: Yes

## Response Syntax
<a name="API_DisassociateHoursOfOperations_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DisassociateHoursOfOperations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateHoursOfOperations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** ConditionalOperationFailedException **   
Request processing failed because dependent condition failed.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DisassociateHoursOfOperations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DisassociateHoursOfOperations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DisassociateHoursOfOperations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DisassociateHoursOfOperations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DisassociateHoursOfOperations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DisassociateHoursOfOperations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DisassociateHoursOfOperations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DisassociateHoursOfOperations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DisassociateHoursOfOperations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DisassociateHoursOfOperations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DisassociateHoursOfOperations) 

# DisassociateInstanceStorageConfig
<a name="API_DisassociateInstanceStorageConfig"></a>

This API is in preview release for Amazon Connect and is subject to change.

Removes the storage type configurations for the specified resource type and association ID.

## Request Syntax
<a name="API_DisassociateInstanceStorageConfig_RequestSyntax"></a>

```
DELETE /instance/InstanceId/storage-config/AssociationId?clientToken=ClientToken&resourceType=ResourceType HTTP/1.1
```

## URI Request Parameters
<a name="API_DisassociateInstanceStorageConfig_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AssociationId](#API_DisassociateInstanceStorageConfig_RequestSyntax) **   <a name="connect-DisassociateInstanceStorageConfig-request-uri-AssociationId"></a>
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [ClientToken](#API_DisassociateInstanceStorageConfig_RequestSyntax) **   <a name="connect-DisassociateInstanceStorageConfig-request-uri-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Length Constraints: Maximum length of 500.

 ** [InstanceId](#API_DisassociateInstanceStorageConfig_RequestSyntax) **   <a name="connect-DisassociateInstanceStorageConfig-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [ResourceType](#API_DisassociateInstanceStorageConfig_RequestSyntax) **   <a name="connect-DisassociateInstanceStorageConfig-request-uri-ResourceType"></a>
A valid resource type.  
Valid Values: `CHAT_TRANSCRIPTS | CALL_RECORDINGS | SCHEDULED_REPORTS | MEDIA_STREAMS | CONTACT_TRACE_RECORDS | AGENT_EVENTS | REAL_TIME_CONTACT_ANALYSIS_SEGMENTS | ATTACHMENTS | CONTACT_EVALUATIONS | SCREEN_RECORDINGS | REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS | REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS | EMAIL_MESSAGES`   
Required: Yes

## Request Body
<a name="API_DisassociateInstanceStorageConfig_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DisassociateInstanceStorageConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DisassociateInstanceStorageConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateInstanceStorageConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DisassociateInstanceStorageConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DisassociateInstanceStorageConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DisassociateInstanceStorageConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DisassociateInstanceStorageConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DisassociateInstanceStorageConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DisassociateInstanceStorageConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DisassociateInstanceStorageConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DisassociateInstanceStorageConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DisassociateInstanceStorageConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DisassociateInstanceStorageConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DisassociateInstanceStorageConfig) 

# DisassociateLambdaFunction
<a name="API_DisassociateLambdaFunction"></a>

This API is in preview release for Amazon Connect and is subject to change.

Remove the Lambda function from the dropdown options available in the relevant flow blocks.

## Request Syntax
<a name="API_DisassociateLambdaFunction_RequestSyntax"></a>

```
DELETE /instance/InstanceId/lambda-function?clientToken=ClientToken&functionArn=FunctionArn HTTP/1.1
```

## URI Request Parameters
<a name="API_DisassociateLambdaFunction_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ClientToken](#API_DisassociateLambdaFunction_RequestSyntax) **   <a name="connect-DisassociateLambdaFunction-request-uri-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Length Constraints: Maximum length of 500.

 ** [FunctionArn](#API_DisassociateLambdaFunction_RequestSyntax) **   <a name="connect-DisassociateLambdaFunction-request-uri-FunctionArn"></a>
The Amazon Resource Name (ARN) of the Lambda function being disassociated.  
Length Constraints: Minimum length of 1. Maximum length of 140.  
Required: Yes

 ** [InstanceId](#API_DisassociateLambdaFunction_RequestSyntax) **   <a name="connect-DisassociateLambdaFunction-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance..  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DisassociateLambdaFunction_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DisassociateLambdaFunction_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DisassociateLambdaFunction_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateLambdaFunction_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DisassociateLambdaFunction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DisassociateLambdaFunction) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DisassociateLambdaFunction) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DisassociateLambdaFunction) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DisassociateLambdaFunction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DisassociateLambdaFunction) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DisassociateLambdaFunction) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DisassociateLambdaFunction) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DisassociateLambdaFunction) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DisassociateLambdaFunction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DisassociateLambdaFunction) 

# DisassociateLexBot
<a name="API_DisassociateLexBot"></a>

This API is in preview release for Amazon Connect and is subject to change.

Revokes authorization from the specified instance to access the specified Amazon Lex bot.

## Request Syntax
<a name="API_DisassociateLexBot_RequestSyntax"></a>

```
DELETE /instance/InstanceId/lex-bot?botName=BotName&clientToken=ClientToken&lexRegion=LexRegion HTTP/1.1
```

## URI Request Parameters
<a name="API_DisassociateLexBot_RequestParameters"></a>

The request uses the following URI parameters.

 ** [BotName](#API_DisassociateLexBot_RequestSyntax) **   <a name="connect-DisassociateLexBot-request-uri-BotName"></a>
The name of the Amazon Lex bot. Maximum character limit of 50.  
Length Constraints: Maximum length of 50.  
Required: Yes

 ** [ClientToken](#API_DisassociateLexBot_RequestSyntax) **   <a name="connect-DisassociateLexBot-request-uri-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Length Constraints: Maximum length of 500.

 ** [InstanceId](#API_DisassociateLexBot_RequestSyntax) **   <a name="connect-DisassociateLexBot-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [LexRegion](#API_DisassociateLexBot_RequestSyntax) **   <a name="connect-DisassociateLexBot-request-uri-LexRegion"></a>
The AWS Region in which the Amazon Lex bot has been created.  
Length Constraints: Maximum length of 60.  
Required: Yes

## Request Body
<a name="API_DisassociateLexBot_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DisassociateLexBot_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DisassociateLexBot_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateLexBot_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DisassociateLexBot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DisassociateLexBot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DisassociateLexBot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DisassociateLexBot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DisassociateLexBot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DisassociateLexBot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DisassociateLexBot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DisassociateLexBot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DisassociateLexBot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DisassociateLexBot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DisassociateLexBot) 

# DisassociatePhoneNumberContactFlow
<a name="API_DisassociatePhoneNumberContactFlow"></a>

Removes the flow association from a phone number claimed to your Amazon Connect instance.

**Important**  
If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the AWS Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the `PhoneNumberId` URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate AWS Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a `ResourceNotFoundException`.

## Request Syntax
<a name="API_DisassociatePhoneNumberContactFlow_RequestSyntax"></a>

```
DELETE /phone-number/PhoneNumberId/contact-flow?instanceId=InstanceId HTTP/1.1
```

## URI Request Parameters
<a name="API_DisassociatePhoneNumberContactFlow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DisassociatePhoneNumberContactFlow_RequestSyntax) **   <a name="connect-DisassociatePhoneNumberContactFlow-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [PhoneNumberId](#API_DisassociatePhoneNumberContactFlow_RequestSyntax) **   <a name="connect-DisassociatePhoneNumberContactFlow-request-uri-PhoneNumberId"></a>
A unique identifier for the phone number.  
Required: Yes

## Request Body
<a name="API_DisassociatePhoneNumberContactFlow_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DisassociatePhoneNumberContactFlow_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DisassociatePhoneNumberContactFlow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociatePhoneNumberContactFlow_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DisassociatePhoneNumberContactFlow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DisassociatePhoneNumberContactFlow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DisassociatePhoneNumberContactFlow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DisassociatePhoneNumberContactFlow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DisassociatePhoneNumberContactFlow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DisassociatePhoneNumberContactFlow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DisassociatePhoneNumberContactFlow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DisassociatePhoneNumberContactFlow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DisassociatePhoneNumberContactFlow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DisassociatePhoneNumberContactFlow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DisassociatePhoneNumberContactFlow) 

# DisassociateQueueEmailAddresses
<a name="API_DisassociateQueueEmailAddresses"></a>

Removes the association between a set of email addresses and a queue. After disassociation, agents will no longer be able to select these email addresses as "From" addresses when replying to inbound email contacts or initiating outbound email contacts in this queue.

 **Important things to know** 
+ Agents will no longer see these email addresses in their "From" address selection options for this queue.
+ The email addresses themselves are not deleted from the instance, only their availability for agent selection in this queue is removed.
+ Changes take effect immediately and will affect the agent experience in the Contact Control Panel (CCP).

## Request Syntax
<a name="API_DisassociateQueueEmailAddresses_RequestSyntax"></a>

```
POST /queues/InstanceId/QueueId/disassociate-email-addresses HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "EmailAddressesId": [ "string" ]
}
```

## URI Request Parameters
<a name="API_DisassociateQueueEmailAddresses_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DisassociateQueueEmailAddresses_RequestSyntax) **   <a name="connect-DisassociateQueueEmailAddresses-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [QueueId](#API_DisassociateQueueEmailAddresses_RequestSyntax) **   <a name="connect-DisassociateQueueEmailAddresses-request-uri-QueueId"></a>
The identifier for the queue.  
Required: Yes

## Request Body
<a name="API_DisassociateQueueEmailAddresses_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_DisassociateQueueEmailAddresses_RequestSyntax) **   <a name="connect-DisassociateQueueEmailAddresses-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [EmailAddressesId](#API_DisassociateQueueEmailAddresses_RequestSyntax) **   <a name="connect-DisassociateQueueEmailAddresses-request-EmailAddressesId"></a>
List of email address identifiers to disassociate from the queue. These are the unique identifiers of email addresses that should no longer be routed to this queue.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_DisassociateQueueEmailAddresses_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DisassociateQueueEmailAddresses_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateQueueEmailAddresses_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DisassociateQueueEmailAddresses_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DisassociateQueueEmailAddresses) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DisassociateQueueEmailAddresses) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DisassociateQueueEmailAddresses) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DisassociateQueueEmailAddresses) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DisassociateQueueEmailAddresses) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DisassociateQueueEmailAddresses) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DisassociateQueueEmailAddresses) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DisassociateQueueEmailAddresses) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DisassociateQueueEmailAddresses) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DisassociateQueueEmailAddresses) 

# DisassociateQueueQuickConnects
<a name="API_DisassociateQueueQuickConnects"></a>

Disassociates a set of quick connects from a queue.

## Request Syntax
<a name="API_DisassociateQueueQuickConnects_RequestSyntax"></a>

```
POST /queues/InstanceId/QueueId/disassociate-quick-connects HTTP/1.1
Content-type: application/json

{
   "QuickConnectIds": [ "string" ]
}
```

## URI Request Parameters
<a name="API_DisassociateQueueQuickConnects_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DisassociateQueueQuickConnects_RequestSyntax) **   <a name="connect-DisassociateQueueQuickConnects-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [QueueId](#API_DisassociateQueueQuickConnects_RequestSyntax) **   <a name="connect-DisassociateQueueQuickConnects-request-uri-QueueId"></a>
The identifier for the queue.  
Required: Yes

## Request Body
<a name="API_DisassociateQueueQuickConnects_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [QuickConnectIds](#API_DisassociateQueueQuickConnects_RequestSyntax) **   <a name="connect-DisassociateQueueQuickConnects-request-QuickConnectIds"></a>
The quick connects to disassociate from the queue.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: Yes

## Response Syntax
<a name="API_DisassociateQueueQuickConnects_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DisassociateQueueQuickConnects_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateQueueQuickConnects_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DisassociateQueueQuickConnects_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DisassociateQueueQuickConnects) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DisassociateQueueQuickConnects) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DisassociateQueueQuickConnects) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DisassociateQueueQuickConnects) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DisassociateQueueQuickConnects) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DisassociateQueueQuickConnects) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DisassociateQueueQuickConnects) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DisassociateQueueQuickConnects) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DisassociateQueueQuickConnects) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DisassociateQueueQuickConnects) 

# DisassociateRoutingProfileQueues
<a name="API_DisassociateRoutingProfileQueues"></a>

Disassociates a set of queues from a routing profile.

Up to 10 queue references can be disassociated in a single API call. More than 10 queue references results in a single call results in an InvalidParameterException.

## Request Syntax
<a name="API_DisassociateRoutingProfileQueues_RequestSyntax"></a>

```
POST /routing-profiles/InstanceId/RoutingProfileId/disassociate-queues HTTP/1.1
Content-type: application/json

{
   "ManualAssignmentQueueReferences": [ 
      { 
         "Channel": "string",
         "QueueId": "string"
      }
   ],
   "QueueReferences": [ 
      { 
         "Channel": "string",
         "QueueId": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_DisassociateRoutingProfileQueues_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DisassociateRoutingProfileQueues_RequestSyntax) **   <a name="connect-DisassociateRoutingProfileQueues-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [RoutingProfileId](#API_DisassociateRoutingProfileQueues_RequestSyntax) **   <a name="connect-DisassociateRoutingProfileQueues-request-uri-RoutingProfileId"></a>
The identifier of the routing profile.  
Required: Yes

## Request Body
<a name="API_DisassociateRoutingProfileQueues_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ManualAssignmentQueueReferences](#API_DisassociateRoutingProfileQueues_RequestSyntax) **   <a name="connect-DisassociateRoutingProfileQueues-request-ManualAssignmentQueueReferences"></a>
The manual assignment queues to disassociate with this routing profile.  
Type: Array of [RoutingProfileQueueReference](API_RoutingProfileQueueReference.md) objects  
Required: No

 ** [QueueReferences](#API_DisassociateRoutingProfileQueues_RequestSyntax) **   <a name="connect-DisassociateRoutingProfileQueues-request-QueueReferences"></a>
The queues to disassociate from this routing profile.  
Type: Array of [RoutingProfileQueueReference](API_RoutingProfileQueueReference.md) objects  
Required: No

## Response Syntax
<a name="API_DisassociateRoutingProfileQueues_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DisassociateRoutingProfileQueues_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateRoutingProfileQueues_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DisassociateRoutingProfileQueues_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DisassociateRoutingProfileQueues) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DisassociateRoutingProfileQueues) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DisassociateRoutingProfileQueues) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DisassociateRoutingProfileQueues) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DisassociateRoutingProfileQueues) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DisassociateRoutingProfileQueues) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DisassociateRoutingProfileQueues) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DisassociateRoutingProfileQueues) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DisassociateRoutingProfileQueues) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DisassociateRoutingProfileQueues) 

# DisassociateSecurityKey
<a name="API_DisassociateSecurityKey"></a>

This API is in preview release for Amazon Connect and is subject to change.

Deletes the specified security key.

## Request Syntax
<a name="API_DisassociateSecurityKey_RequestSyntax"></a>

```
DELETE /instance/InstanceId/security-key/AssociationId?clientToken=ClientToken HTTP/1.1
```

## URI Request Parameters
<a name="API_DisassociateSecurityKey_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AssociationId](#API_DisassociateSecurityKey_RequestSyntax) **   <a name="connect-DisassociateSecurityKey-request-uri-AssociationId"></a>
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [ClientToken](#API_DisassociateSecurityKey_RequestSyntax) **   <a name="connect-DisassociateSecurityKey-request-uri-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Length Constraints: Maximum length of 500.

 ** [InstanceId](#API_DisassociateSecurityKey_RequestSyntax) **   <a name="connect-DisassociateSecurityKey-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DisassociateSecurityKey_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DisassociateSecurityKey_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DisassociateSecurityKey_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateSecurityKey_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DisassociateSecurityKey_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DisassociateSecurityKey) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DisassociateSecurityKey) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DisassociateSecurityKey) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DisassociateSecurityKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DisassociateSecurityKey) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DisassociateSecurityKey) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DisassociateSecurityKey) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DisassociateSecurityKey) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DisassociateSecurityKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DisassociateSecurityKey) 

# DisassociateSecurityProfiles
<a name="API_DisassociateSecurityProfiles"></a>

 Disassociates a security profile attached to a Q in Connect AI Agent Entity in an Amazon Connect instance. 

## Request Syntax
<a name="API_DisassociateSecurityProfiles_RequestSyntax"></a>

```
POST /disassociate-security-profiles/InstanceId HTTP/1.1
Content-type: application/json

{
   "EntityArn": "string",
   "EntityType": "string",
   "SecurityProfiles": [ 
      { 
         "Id": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_DisassociateSecurityProfiles_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DisassociateSecurityProfiles_RequestSyntax) **   <a name="connect-DisassociateSecurityProfiles-request-uri-InstanceId"></a>
 The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.   
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_DisassociateSecurityProfiles_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [EntityArn](#API_DisassociateSecurityProfiles_RequestSyntax) **   <a name="connect-DisassociateSecurityProfiles-request-EntityArn"></a>
 ARN of a Q in Connect AI Agent.   
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

 ** [EntityType](#API_DisassociateSecurityProfiles_RequestSyntax) **   <a name="connect-DisassociateSecurityProfiles-request-EntityType"></a>
 Only supported type is AI\$1AGENT.   
Type: String  
Valid Values: `USER | AI_AGENT`   
Required: Yes

 ** [SecurityProfiles](#API_DisassociateSecurityProfiles_RequestSyntax) **   <a name="connect-DisassociateSecurityProfiles-request-SecurityProfiles"></a>
 List of Security Profile Object.   
Type: Array of [SecurityProfileItem](API_SecurityProfileItem.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: Yes

## Response Syntax
<a name="API_DisassociateSecurityProfiles_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DisassociateSecurityProfiles_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateSecurityProfiles_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** ConditionalOperationFailedException **   
Request processing failed because dependent condition failed.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

## See Also
<a name="API_DisassociateSecurityProfiles_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DisassociateSecurityProfiles) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DisassociateSecurityProfiles) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DisassociateSecurityProfiles) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DisassociateSecurityProfiles) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DisassociateSecurityProfiles) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DisassociateSecurityProfiles) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DisassociateSecurityProfiles) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DisassociateSecurityProfiles) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DisassociateSecurityProfiles) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DisassociateSecurityProfiles) 

# DisassociateTrafficDistributionGroupUser
<a name="API_DisassociateTrafficDistributionGroupUser"></a>

Disassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.

## Request Syntax
<a name="API_DisassociateTrafficDistributionGroupUser_RequestSyntax"></a>

```
DELETE /traffic-distribution-group/TrafficDistributionGroupId/user?InstanceId=InstanceId&UserId=UserId HTTP/1.1
```

## URI Request Parameters
<a name="API_DisassociateTrafficDistributionGroupUser_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DisassociateTrafficDistributionGroupUser_RequestSyntax) **   <a name="connect-DisassociateTrafficDistributionGroupUser-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [TrafficDistributionGroupId](#API_DisassociateTrafficDistributionGroupUser_RequestSyntax) **   <a name="connect-DisassociateTrafficDistributionGroupUser-request-uri-TrafficDistributionGroupId"></a>
The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z-]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

 ** [UserId](#API_DisassociateTrafficDistributionGroupUser_RequestSyntax) **   <a name="connect-DisassociateTrafficDistributionGroupUser-request-uri-UserId"></a>
The identifier for the user. This can be the ID or the ARN of the user.  
Required: Yes

## Request Body
<a name="API_DisassociateTrafficDistributionGroupUser_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DisassociateTrafficDistributionGroupUser_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DisassociateTrafficDistributionGroupUser_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateTrafficDistributionGroupUser_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_DisassociateTrafficDistributionGroupUser_Examples"></a>

### Example
<a name="API_DisassociateTrafficDistributionGroupUser_Example_1"></a>

The following example disassociates an agent from a traffic distribution group.

#### Sample Request
<a name="API_DisassociateTrafficDistributionGroupUser_Example_1_Request"></a>

```
DELETE connect.[region].amazonaws.com/traffic-distribution-group/[traffic_distribution_group_id]/user?instanceId=[instance_id]&userId=[user_id]
{
}
```

#### Sample Response
<a name="API_DisassociateTrafficDistributionGroupUser_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_DisassociateTrafficDistributionGroupUser_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DisassociateTrafficDistributionGroupUser) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DisassociateTrafficDistributionGroupUser) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DisassociateTrafficDistributionGroupUser) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DisassociateTrafficDistributionGroupUser) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DisassociateTrafficDistributionGroupUser) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DisassociateTrafficDistributionGroupUser) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DisassociateTrafficDistributionGroupUser) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DisassociateTrafficDistributionGroupUser) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DisassociateTrafficDistributionGroupUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DisassociateTrafficDistributionGroupUser) 

# DisassociateUserProficiencies
<a name="API_DisassociateUserProficiencies"></a>

Disassociates a set of proficiencies from a user.

## Request Syntax
<a name="API_DisassociateUserProficiencies_RequestSyntax"></a>

```
POST /users/InstanceId/UserId/disassociate-proficiencies HTTP/1.1
Content-type: application/json

{
   "UserProficiencies": [ 
      { 
         "AttributeName": "string",
         "AttributeValue": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_DisassociateUserProficiencies_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DisassociateUserProficiencies_RequestSyntax) **   <a name="connect-DisassociateUserProficiencies-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [UserId](#API_DisassociateUserProficiencies_RequestSyntax) **   <a name="connect-DisassociateUserProficiencies-request-uri-UserId"></a>
The identifier of the user account.  
Required: Yes

## Request Body
<a name="API_DisassociateUserProficiencies_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [UserProficiencies](#API_DisassociateUserProficiencies_RequestSyntax) **   <a name="connect-DisassociateUserProficiencies-request-UserProficiencies"></a>
The proficiencies to disassociate from the user.  
Type: Array of [UserProficiencyDisassociate](API_UserProficiencyDisassociate.md) objects  
Required: Yes

## Response Syntax
<a name="API_DisassociateUserProficiencies_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DisassociateUserProficiencies_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisassociateUserProficiencies_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DisassociateUserProficiencies_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DisassociateUserProficiencies) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DisassociateUserProficiencies) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DisassociateUserProficiencies) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DisassociateUserProficiencies) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DisassociateUserProficiencies) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DisassociateUserProficiencies) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DisassociateUserProficiencies) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DisassociateUserProficiencies) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DisassociateUserProficiencies) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DisassociateUserProficiencies) 

# DisassociateWorkspace
<a name="API_DisassociateWorkspace"></a>

Removes the association between a workspace and one or more users or routing profiles.

## Request Syntax
<a name="API_DisassociateWorkspace_RequestSyntax"></a>

```
POST /workspaces/InstanceId/WorkspaceId/disassociate HTTP/1.1
Content-type: application/json

{
   "ResourceArns": [ "string" ]
}
```

## URI Request Parameters
<a name="API_DisassociateWorkspace_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DisassociateWorkspace_RequestSyntax) **   <a name="connect-DisassociateWorkspace-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [WorkspaceId](#API_DisassociateWorkspace_RequestSyntax) **   <a name="connect-DisassociateWorkspace-request-uri-WorkspaceId"></a>
The identifier of the workspace.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_DisassociateWorkspace_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ResourceArns](#API_DisassociateWorkspace_RequestSyntax) **   <a name="connect-DisassociateWorkspace-request-ResourceArns"></a>
The Amazon Resource Names (ARNs) of the resources to disassociate from the workspace.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 25 items.  
Required: Yes

## Response Syntax
<a name="API_DisassociateWorkspace_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "FailedList": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "ResourceArn": "string"
      }
   ],
   "SuccessfulList": [ 
      { 
         "ResourceArn": "string"
      }
   ]
}
```

## Response Elements
<a name="API_DisassociateWorkspace_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FailedList](#API_DisassociateWorkspace_ResponseSyntax) **   <a name="connect-DisassociateWorkspace-response-FailedList"></a>
A list of resources that failed to be disassociated from the workspace, including error details.  
Type: Array of [FailedBatchAssociationSummary](API_FailedBatchAssociationSummary.md) objects

 ** [SuccessfulList](#API_DisassociateWorkspace_ResponseSyntax) **   <a name="connect-DisassociateWorkspace-response-SuccessfulList"></a>
A list of resources that were successfully disassociated from the workspace.  
Type: Array of [SuccessfulBatchAssociationSummary](API_SuccessfulBatchAssociationSummary.md) objects

## Errors
<a name="API_DisassociateWorkspace_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DisassociateWorkspace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DisassociateWorkspace) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DisassociateWorkspace) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DisassociateWorkspace) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DisassociateWorkspace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DisassociateWorkspace) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DisassociateWorkspace) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DisassociateWorkspace) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DisassociateWorkspace) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DisassociateWorkspace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DisassociateWorkspace) 

# DismissUserContact
<a name="API_DismissUserContact"></a>

Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a `MISSED`, `ERROR`, `ENDED`, or `REJECTED` state in the [Agent Event Stream](https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html).

## Request Syntax
<a name="API_DismissUserContact_RequestSyntax"></a>

```
POST /users/InstanceId/UserId/contact HTTP/1.1
Content-type: application/json

{
   "ContactId": "string"
}
```

## URI Request Parameters
<a name="API_DismissUserContact_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_DismissUserContact_RequestSyntax) **   <a name="connect-DismissUserContact-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [UserId](#API_DismissUserContact_RequestSyntax) **   <a name="connect-DismissUserContact-request-uri-UserId"></a>
The identifier of the user account.  
Required: Yes

## Request Body
<a name="API_DismissUserContact_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ContactId](#API_DismissUserContact_RequestSyntax) **   <a name="connect-DismissUserContact-request-ContactId"></a>
The identifier of the contact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Response Syntax
<a name="API_DismissUserContact_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DismissUserContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DismissUserContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_DismissUserContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/DismissUserContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/DismissUserContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/DismissUserContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/DismissUserContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/DismissUserContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/DismissUserContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/DismissUserContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/DismissUserContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/DismissUserContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/DismissUserContact) 

# EvaluateDataTableValues
<a name="API_EvaluateDataTableValues"></a>

Evaluates values at the time of the request and returns them. It considers the request's timezone or the table's timezone, in that order, when accessing time based tables. When a value is accessed, the accessor's identity and the time of access are saved alongside the value to help identify values that are actively in use. The term "Batch" is not included in the operation name since it does not meet all the criteria for a batch operation as specified in Batch Operations: AWS API Standards.

## Request Syntax
<a name="API_EvaluateDataTableValues_RequestSyntax"></a>

```
POST /data-tables/InstanceId/DataTableId/values/evaluate?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
Content-type: application/json

{
   "TimeZone": "string",
   "Values": [ 
      { 
         "AttributeNames": [ "string" ],
         "PrimaryValues": [ 
            { 
               "AttributeName": "string",
               "Value": "string"
            }
         ]
      }
   ]
}
```

## URI Request Parameters
<a name="API_EvaluateDataTableValues_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DataTableId](#API_EvaluateDataTableValues_RequestSyntax) **   <a name="connect-EvaluateDataTableValues-request-uri-DataTableId"></a>
The unique identifier for the data table. Must also accept the table ARN with or without a version alias.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_EvaluateDataTableValues_RequestSyntax) **   <a name="connect-EvaluateDataTableValues-request-uri-InstanceId"></a>
The unique identifier for the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_EvaluateDataTableValues_RequestSyntax) **   <a name="connect-EvaluateDataTableValues-request-uri-MaxResults"></a>
The maximum number of data table values to return in one page of results.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_EvaluateDataTableValues_RequestSyntax) **   <a name="connect-EvaluateDataTableValues-request-uri-NextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.

## Request Body
<a name="API_EvaluateDataTableValues_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [TimeZone](#API_EvaluateDataTableValues_RequestSyntax) **   <a name="connect-EvaluateDataTableValues-request-TimeZone"></a>
Optional IANA timezone identifier to use when resolving time based dynamic values. Defaults to the data table time zone if not provided.  
Type: String  
Required: No

 ** [Values](#API_EvaluateDataTableValues_RequestSyntax) **   <a name="connect-EvaluateDataTableValues-request-Values"></a>
A list of value evaluation sets specifying which primary values and attributes to evaluate.  
Type: Array of [DataTableValueEvaluationSet](API_DataTableValueEvaluationSet.md) objects  
Required: Yes

## Response Syntax
<a name="API_EvaluateDataTableValues_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Values": [ 
      { 
         "AttributeName": "string",
         "Error": boolean,
         "EvaluatedValue": "string",
         "Found": boolean,
         "PrimaryValues": [ 
            { 
               "AttributeName": "string",
               "Value": "string"
            }
         ],
         "RecordId": "string",
         "ValueType": "string"
      }
   ]
}
```

## Response Elements
<a name="API_EvaluateDataTableValues_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_EvaluateDataTableValues_ResponseSyntax) **   <a name="connect-EvaluateDataTableValues-response-NextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Type: String

 ** [Values](#API_EvaluateDataTableValues_ResponseSyntax) **   <a name="connect-EvaluateDataTableValues-response-Values"></a>
A list of evaluated values with their computed results, error information, and metadata.  
Type: Array of [DataTableEvaluatedValue](API_DataTableEvaluatedValue.md) objects

## Errors
<a name="API_EvaluateDataTableValues_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_EvaluateDataTableValues_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/EvaluateDataTableValues) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/EvaluateDataTableValues) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/EvaluateDataTableValues) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/EvaluateDataTableValues) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/EvaluateDataTableValues) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/EvaluateDataTableValues) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/EvaluateDataTableValues) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/EvaluateDataTableValues) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/EvaluateDataTableValues) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/EvaluateDataTableValues) 

# GetAttachedFile
<a name="API_GetAttachedFile"></a>

Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is `APPROVED`.

## Request Syntax
<a name="API_GetAttachedFile_RequestSyntax"></a>

```
GET /attached-files/InstanceId/FileId?associatedResourceArn=AssociatedResourceArn&urlExpiryInSeconds=UrlExpiryInSeconds HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAttachedFile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AssociatedResourceArn](#API_GetAttachedFile_RequestSyntax) **   <a name="connect-GetAttachedFile-request-uri-AssociatedResourceArn"></a>
The resource to which the attached file is (being) uploaded to. The supported resources are [Cases](https://docs.aws.amazon.com/connect/latest/adminguide/cases.html) and [Email](https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html).  
This value must be a valid ARN.
Required: Yes

 ** [FileId](#API_GetAttachedFile_RequestSyntax) **   <a name="connect-GetAttachedFile-request-uri-FileId"></a>
The unique identifier of the attached file resource.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_GetAttachedFile_RequestSyntax) **   <a name="connect-GetAttachedFile-request-uri-InstanceId"></a>
The unique identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [UrlExpiryInSeconds](#API_GetAttachedFile_RequestSyntax) **   <a name="connect-GetAttachedFile-request-uri-UrlExpiryInSeconds"></a>
Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.  
Valid Range: Minimum value of 5. Maximum value of 300.

## Request Body
<a name="API_GetAttachedFile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAttachedFile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AssociatedResourceArn": "string",
   "CreatedBy": { ... },
   "CreationTime": "string",
   "DownloadUrlMetadata": { 
      "Url": "string",
      "UrlExpiry": "string"
   },
   "FileArn": "string",
   "FileId": "string",
   "FileName": "string",
   "FileSizeInBytes": number,
   "FileStatus": "string",
   "FileUseCaseType": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_GetAttachedFile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AssociatedResourceArn](#API_GetAttachedFile_ResponseSyntax) **   <a name="connect-GetAttachedFile-response-AssociatedResourceArn"></a>
The resource to which the attached file is (being) uploaded to. [Cases](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html) are the only current supported resource.  
Type: String

 ** [CreatedBy](#API_GetAttachedFile_ResponseSyntax) **   <a name="connect-GetAttachedFile-response-CreatedBy"></a>
Represents the identity that created the file.  
Type: [CreatedByInfo](API_CreatedByInfo.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [CreationTime](#API_GetAttachedFile_ResponseSyntax) **   <a name="connect-GetAttachedFile-response-CreationTime"></a>
The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: `yyyy-MM-ddThh:mm:ss.SSSZ`. For example, `2024-05-03T02:41:28.172Z`.  
Type: String

 ** [DownloadUrlMetadata](#API_GetAttachedFile_ResponseSyntax) **   <a name="connect-GetAttachedFile-response-DownloadUrlMetadata"></a>
URL and expiry to be used when downloading the attached file.   
Type: [DownloadUrlMetadata](API_DownloadUrlMetadata.md) object

 ** [FileArn](#API_GetAttachedFile_ResponseSyntax) **   <a name="connect-GetAttachedFile-response-FileArn"></a>
The unique identifier of the attached file resource (ARN).  
Type: String

 ** [FileId](#API_GetAttachedFile_ResponseSyntax) **   <a name="connect-GetAttachedFile-response-FileId"></a>
The unique identifier of the attached file resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [FileName](#API_GetAttachedFile_ResponseSyntax) **   <a name="connect-GetAttachedFile-response-FileName"></a>
A case-sensitive name of the attached file being uploaded.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^\P{C}*$` 

 ** [FileSizeInBytes](#API_GetAttachedFile_ResponseSyntax) **   <a name="connect-GetAttachedFile-response-FileSizeInBytes"></a>
The size of the attached file in bytes.  
Type: Long  
Valid Range: Minimum value of 1.

 ** [FileStatus](#API_GetAttachedFile_ResponseSyntax) **   <a name="connect-GetAttachedFile-response-FileStatus"></a>
The current status of the attached file.  
Type: String  
Valid Values: `APPROVED | REJECTED | PROCESSING | FAILED` 

 ** [FileUseCaseType](#API_GetAttachedFile_ResponseSyntax) **   <a name="connect-GetAttachedFile-response-FileUseCaseType"></a>
The use case for the file.  
Type: String  
Valid Values: `EMAIL_MESSAGE | ATTACHMENT` 

 ** [Tags](#API_GetAttachedFile_ResponseSyntax) **   <a name="connect-GetAttachedFile-response-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, `{ "Tags": {"key1":"value1", "key2":"value2"} }`.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_GetAttachedFile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_GetAttachedFile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/GetAttachedFile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/GetAttachedFile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/GetAttachedFile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/GetAttachedFile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/GetAttachedFile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/GetAttachedFile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/GetAttachedFile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/GetAttachedFile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/GetAttachedFile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/GetAttachedFile) 

# GetContactAttributes
<a name="API_GetContactAttributes"></a>

Retrieves the contact attributes for the specified contact.

## Request Syntax
<a name="API_GetContactAttributes_RequestSyntax"></a>

```
GET /contact/attributes/InstanceId/InitialContactId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetContactAttributes_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InitialContactId](#API_GetContactAttributes_RequestSyntax) **   <a name="connect-GetContactAttributes-request-uri-InitialContactId"></a>
The identifier of the initial contact.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_GetContactAttributes_RequestSyntax) **   <a name="connect-GetContactAttributes-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_GetContactAttributes_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetContactAttributes_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Attributes": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_GetContactAttributes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Attributes](#API_GetContactAttributes_ResponseSyntax) **   <a name="connect-GetContactAttributes-response-Attributes"></a>
Information about the attributes.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 32767.  
Value Length Constraints: Minimum length of 0. Maximum length of 32767.

## Errors
<a name="API_GetContactAttributes_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

## See Also
<a name="API_GetContactAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/GetContactAttributes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/GetContactAttributes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/GetContactAttributes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/GetContactAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/GetContactAttributes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/GetContactAttributes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/GetContactAttributes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/GetContactAttributes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/GetContactAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/GetContactAttributes) 

# GetContactMetrics
<a name="API_GetContactMetrics"></a>

Retrieves contact metric data for a specified contact.

 **Use cases** 

Following are common use cases for position in queue and estimated wait time:
+ Customer-Facing Wait Time Announcements - Display or announce the estimated wait time and position in queue to customers before or during their queue experience. 
+ Callback Offerings - Offer customers a callback option when the estimated wait time or position in queue exceeds a defined threshold. 
+ Queue Routing Decisions - Route incoming contacts to less congested queues by comparing estimated wait time and position in queue across multiple queues. 
+ Self-Service Deflection - Redirect customers to self-service options like chatbots or FAQs when estimated wait time is high or position in queue is unfavorable. 

 **Important things to know** 
+ Metrics are only available while the contact is actively in queue.
+ For more information, see the [Position in queue](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html) metric in the *Amazon Connect Administrator Guide*. 

 **Endpoints**: See [Amazon Connect endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/connect_region.html).

## Request Syntax
<a name="API_GetContactMetrics_RequestSyntax"></a>

```
POST /metrics/contact HTTP/1.1
Content-type: application/json

{
   "ContactId": "string",
   "InstanceId": "string",
   "Metrics": [ 
      { 
         "Name": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_GetContactMetrics_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetContactMetrics_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ContactId](#API_GetContactMetrics_RequestSyntax) **   <a name="connect-GetContactMetrics-request-ContactId"></a>
The identifier of the contact in this instance of Amazon Connect.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

 ** [InstanceId](#API_GetContactMetrics_RequestSyntax) **   <a name="connect-GetContactMetrics-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

 ** [Metrics](#API_GetContactMetrics_RequestSyntax) **   <a name="connect-GetContactMetrics-request-Metrics"></a>
A list of contact level metrics to retrieve.Supported metrics include POSITION\$1IN\$1QUEUE (the contact's current position in the queue) and ESTIMATED\$1WAIT\$1TIME (the predicted time in seconds until the contact is connected to an agent)  
Type: Array of [ContactMetricInfo](API_ContactMetricInfo.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## Response Syntax
<a name="API_GetContactMetrics_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Id": "string",
   "MetricResults": [ 
      { 
         "Name": "string",
         "Value": { ... }
      }
   ]
}
```

## Response Elements
<a name="API_GetContactMetrics_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_GetContactMetrics_ResponseSyntax) **   <a name="connect-GetContactMetrics-response-Arn"></a>
The ARN of the contact for which metrics were retrieved.  
Type: String

 ** [Id](#API_GetContactMetrics_ResponseSyntax) **   <a name="connect-GetContactMetrics-response-Id"></a>
The unique identifier of the contact for which metrics were retrieved. This matches the ContactId provided in the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [MetricResults](#API_GetContactMetrics_ResponseSyntax) **   <a name="connect-GetContactMetrics-response-MetricResults"></a>
A list of metric results containing the calculated values for each requested metric. Each result includes the metric name and its corresponding value. For example, POSITION\$1IN\$1QUEUE returns a numeric value representing the contact's position in queue, and ESTIMATED\$1WAIT\$1TIME returns the predicted wait time in seconds.  
Type: Array of [ContactMetricResult](API_ContactMetricResult.md) objects

## Errors
<a name="API_GetContactMetrics_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_GetContactMetrics_Examples"></a>

### Example request to retrieve position in queue and estimated wait time
<a name="API_GetContactMetrics_Example_1"></a>

Following is an example of retrieving the position in queue and estimated wait time for a contact.

```
{
     "InstanceId":"12345678-1234-5678-aabb-123456abcdef",
     "ContactId":"12345678-1234-5678-aabb-123456abcdef",
     "Metrics":[ { "Name": "POSITION_IN_QUEUE"}, { "Name": "ESTIMATED_WAIT_TIME"} ]
     }
```

### Example response with the position in queue and estimated wait time
<a name="API_GetContactMetrics_Example_2"></a>

Following is an example response. In this case, the contact is number 3 in the queue with an estimated wait time of 120 seconds.

```
{
     "Id":"12345678-1234-5678-aabb-123456abcdef",
     "Arn":"arn:aws:connect:us-east-1:123456789012:instance/12345678-1234-5678-aabb-123456abcdef/contact/12345678-1234-5678-aabb-123456abcdef",
     "MetricResults":[ { "Name": "POSITION_IN_QUEUE","Value":{"Number":3.00}}, { "Name": "ESTIMATED_WAIT_TIME","Value":{"Number":120.00}}]
     }
```

## See Also
<a name="API_GetContactMetrics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/GetContactMetrics) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/GetContactMetrics) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/GetContactMetrics) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/GetContactMetrics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/GetContactMetrics) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/GetContactMetrics) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/GetContactMetrics) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/GetContactMetrics) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/GetContactMetrics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/GetContactMetrics) 

# GetCurrentMetricData
<a name="API_GetCurrentMetricData"></a>

Gets the real-time metric data from the specified Amazon Connect instance.

For a description of each metric, see [Metrics definitions](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html) in the *Amazon Connect Administrator Guide*.

**Note**  
When you make a successful API request, you can expect the following metric values in the response:  
 **Metric value is null**: The calculation cannot be performed due to divide by zero or insufficient data
 **Metric value is a number (including 0) of defined type**: The number provided is the calculation result
 **MetricResult list is empty**: The request cannot find any data in the system
The following guidelines can help you work with the API:  
Each dimension in the metric response must contain a value
Each item in MetricResult must include all requested metrics
If the response is slow due to large result sets, try these approaches:  
Add filters to reduce the amount of data returned

## Request Syntax
<a name="API_GetCurrentMetricData_RequestSyntax"></a>

```
POST /metrics/current/InstanceId HTTP/1.1
Content-type: application/json

{
   "CurrentMetrics": [ 
      { 
         "MetricId": "string",
         "Name": "string",
         "Unit": "string"
      }
   ],
   "Filters": { 
      "AgentStatuses": [ "string" ],
      "Channels": [ "string" ],
      "Queues": [ "string" ],
      "RoutingProfiles": [ "string" ],
      "RoutingStepExpressions": [ "string" ],
      "Subtypes": [ "string" ],
      "ValidationTestTypes": [ "string" ]
   },
   "Groupings": [ "string" ],
   "MaxResults": number,
   "NextToken": "string",
   "SortCriteria": [ 
      { 
         "SortByMetric": "string",
         "SortOrder": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_GetCurrentMetricData_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_GetCurrentMetricData_RequestSyntax) **   <a name="connect-GetCurrentMetricData-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_GetCurrentMetricData_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [CurrentMetrics](#API_GetCurrentMetricData_RequestSyntax) **   <a name="connect-GetCurrentMetricData-request-CurrentMetrics"></a>
The metrics to retrieve. Specify the name or metricId, and unit for each metric. The following metrics are available. For a description of all the metrics, see [Metrics definitions](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html) in the *Amazon Connect Administrator Guide*.  
 MetricId should be used to reference custom metrics or out of the box metrics as Arn. If using MetricId, the limit is 10 MetricId per request.  
AGENTS\$1AFTER\$1CONTACT\$1WORK  
Unit: COUNT  
Name in real-time metrics report: [ACW](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#aftercallwork-real-time)   
AGENTS\$1AVAILABLE  
Unit: COUNT  
Name in real-time metrics report: [Available](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#available-real-time)   
AGENTS\$1ERROR  
Unit: COUNT  
Name in real-time metrics report: [Error](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#error-real-time)   
AGENTS\$1NON\$1PRODUCTIVE  
Unit: COUNT  
Name in real-time metrics report: [NPT (Non-Productive Time)](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#non-productive-time-real-time)   
AGENTS\$1ON\$1CALL  
Unit: COUNT  
Name in real-time metrics report: [On contact](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#on-call-real-time)   
AGENTS\$1ON\$1CONTACT  
Unit: COUNT  
Name in real-time metrics report: [On contact](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#on-call-real-time)   
AGENTS\$1ONLINE  
Unit: COUNT  
Name in real-time metrics report: [Online](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#online-real-time)   
AGENTS\$1STAFFED  
Unit: COUNT  
Name in real-time metrics report: [Staffed](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#staffed-real-time)   
CONTACTS\$1IN\$1QUEUE  
Unit: COUNT  
Name in real-time metrics report: [In queue](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#in-queue-real-time)   
CONTACTS\$1SCHEDULED  
Unit: COUNT  
Name in real-time metrics report: [Scheduled](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#scheduled-real-time)   
ESTIMATED\$1WAIT\$1TIME  
Unit: SECONDS  
This metric supports filter and grouping combination only used for core routing purpose. Valid filter and grouping use cases:   
+ Filter by a list of [Queues] and a list of [Channels], group by [“QUEUE”, “CHANNEL”]
+ Filter by a singleton list of [Queue], a singleton list of [Channel], a list of [RoutingStepExpression], group by [“ROUTING\$1STEP\$1EXPRESSION”].  
OLDEST\$1CONTACT\$1AGE  
Unit: SECONDS  
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.   
When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:  
 `{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0 `\$1  
The actual OLDEST\$1CONTACT\$1AGE is 24 seconds.  
When the filter `RoutingStepExpression` is used, this metric is still calculated from enqueue time. For example, if a contact that has been queued under `<Expression 1>` for 10 seconds has expired and `<Expression 2>` becomes active, then `OLDEST_CONTACT_AGE` for this queue will be counted starting from 10, not 0.  
Name in real-time metrics report: [Oldest](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#oldest-real-time)   
SLOTS\$1ACTIVE  
Unit: COUNT  
Name in real-time metrics report: [Active](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#active-real-time)   
SLOTS\$1AVAILABLE  
Unit: COUNT  
Name in real-time metrics report: [Availability](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#availability-real-time) 
Type: Array of [CurrentMetric](API_CurrentMetric.md) objects  
Required: Yes

 ** [Filters](#API_GetCurrentMetricData_RequestSyntax) **   <a name="connect-GetCurrentMetricData-request-Filters"></a>
The filters to apply to returned metrics. You can filter up to the following limits:  
+ Queues: 100
+ Routing profiles: 100
+ Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
+ RoutingStepExpressions: 50
+ AgentStatuses: 50
+ Subtypes: 10
+ ValidationTestTypes: 10
Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.  
When using `AgentStatuses` as filter make sure Queues is added as primary filter.  
When using `Subtypes` as filter make sure Queues is added as primary filter.  
When using `ValidationTestTypes` as filter make sure Queues is added as primary filter.  
When using the `RoutingStepExpression` filter, you need to pass exactly one `QueueId`. The filter is also case sensitive so when using the `RoutingStepExpression` filter, grouping by `ROUTING_STEP_EXPRESSION` is required.  
Currently tagging is only supported on the resources that are passed in the filter.  
Type: [Filters](API_Filters.md) object  
Required: Yes

 ** [Groupings](#API_GetCurrentMetricData_RequestSyntax) **   <a name="connect-GetCurrentMetricData-request-Groupings"></a>
Defines the level of aggregation for metrics data by a dimension(s). Its similar to sorting items into buckets based on a common characteristic, then counting or calculating something for each bucket. For example, when grouped by `QUEUE`, the metrics returned apply to each queue rather than aggregated for all queues.   
The grouping list is an ordered list, with the first item in the list defined as the primary grouping. If no grouping is included in the request, the aggregation happens at the instance-level.  
+ If you group by `CHANNEL`, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.
+ If you group by `AGENT_STATUS`, you must include the `QUEUE` as the primary grouping and use queue filter. When you group by `AGENT_STATUS`, the only metric available is the `AGENTS_ONLINE` metric.
+ If you group by `SUBTYPE` or `VALIDATION_TEST_TYPE` as secondary grouping then you must include `QUEUE` as primary grouping and use Queue as filter
+ If you group by `ROUTING_PROFILE`, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metrics `CONTACTS_SCHEDULED`, `CONTACTS_IN_QUEUE`, and ` OLDEST_CONTACT_AGE`.
+ When using the `RoutingStepExpression` filter, group by `ROUTING_STEP_EXPRESSION` is required.
Type: Array of strings  
Array Members: Maximum number of 2 items.  
Valid Values: `QUEUE | CHANNEL | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION | AGENT_STATUS | SUBTYPE | VALIDATION_TEST_TYPE`   
Required: No

 ** [MaxResults](#API_GetCurrentMetricData_RequestSyntax) **   <a name="connect-GetCurrentMetricData-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_GetCurrentMetricData_RequestSyntax) **   <a name="connect-GetCurrentMetricData-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.  
Type: String  
Required: No

 ** [SortCriteria](#API_GetCurrentMetricData_RequestSyntax) **   <a name="connect-GetCurrentMetricData-request-SortCriteria"></a>
The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources are sorted based on `AGENTS_ONLINE`, `DESCENDING`. The metric collection is sorted based on the input metrics.  
Note the following:  
+ Sorting on `SLOTS_ACTIVE` and `SLOTS_AVAILABLE` is not supported.
Type: Array of [CurrentMetricSortCriteria](API_CurrentMetricSortCriteria.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Required: No

## Response Syntax
<a name="API_GetCurrentMetricData_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "DataSnapshotTime": number,
   "MetricResults": [ 
      { 
         "Collections": [ 
            { 
               "Metric": { 
                  "MetricId": "string",
                  "Name": "string",
                  "Unit": "string"
               },
               "Value": number
            }
         ],
         "Dimensions": { 
            "AgentStatus": { 
               "Arn": "string",
               "Id": "string"
            },
            "Channel": "string",
            "Queue": { 
               "Arn": "string",
               "Id": "string"
            },
            "RoutingProfile": { 
               "Arn": "string",
               "Id": "string"
            },
            "RoutingStepExpression": "string",
            "Subtype": "string",
            "ValidationTestType": "string"
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_GetCurrentMetricData_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_GetCurrentMetricData_ResponseSyntax) **   <a name="connect-GetCurrentMetricData-response-ApproximateTotalCount"></a>
The total count of the result, regardless of the current page size.   
Type: Long

 ** [DataSnapshotTime](#API_GetCurrentMetricData_ResponseSyntax) **   <a name="connect-GetCurrentMetricData-response-DataSnapshotTime"></a>
The time at which the metrics were retrieved and cached for pagination.  
Type: Timestamp

 ** [MetricResults](#API_GetCurrentMetricData_ResponseSyntax) **   <a name="connect-GetCurrentMetricData-response-MetricResults"></a>
Information about the real-time metrics.  
Type: Array of [CurrentMetricResult](API_CurrentMetricResult.md) objects

 ** [NextToken](#API_GetCurrentMetricData_ResponseSyntax) **   <a name="connect-GetCurrentMetricData-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.  
Type: String

## Errors
<a name="API_GetCurrentMetricData_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_GetCurrentMetricData_Examples"></a>

### Example
<a name="API_GetCurrentMetricData_Example_1"></a>

The following example retrieves the specified real-time metrics.

#### Sample Request
<a name="API_GetCurrentMetricData_Example_1_Request"></a>

```
{{
  "InstanceId": "12345678-1234-5678-aabb-123456abcdef",
  "Filters": {
    "Queues": [
      "11111111-2222-fcfc-abab-333333333333",
      "arn:aws:connect:us-east-1:123456789012:instance/12345678-1234-5678-aabb-123456abcdef/queue/11111111-2222-fcfc-abab-333333333333"
    ],
    "Channels": ["VOICE"]
  },
  "Groupings": ["CHANNEL", "QUEUE"],
  "CurrentMetrics": [
    {
      "Name": "AGENTS_ONLINE",
      "Unit": "COUNT"
    },
    {
      "Name": "AGENTS_AVAILABLE",
      "Unit": "COUNT"
    },
    {
      "Name": "OLDEST_CONTACT_AGE",
      "Unit": "SECONDS"
    },
    {
      "Name": "AGENTS_ERROR",
      "Unit": "COUNT"
    },
    {
    "Name": "ESTIMATED_WAIT_TIME",
    "Unit": "SECONDS"
    }
  ],
  "SortCriteria": {
    "SortByMetric": "OLDEST_CONTACT_AGE",
    "SortOrder": "ASCENDING"
  }
}
```

#### Sample Response
<a name="API_GetCurrentMetricData_Example_1_Response"></a>

```
{
  "DataSnapshotTime": 1671222098.739,
  "ApproximateTotalCount": 1,
  "MetricResults": [
    {
      "Collections": [
        {
          "Metric": {
            "Name": "AGENTS_ONLINE",
            "Unit": "COUNT"
          },
          "Value": 1
        },
        {
          "Metric": {
            "Name": "AGENTS_AVAILABLE",
            "Unit": "COUNT"
          },
          "Value": 1
        },
        {
          "Metric": {
            "Name": "OLDEST_CONTACT_AGE",
            "Unit": "SECONDS"
          },
          "Value": 0
        },
        {
          "Metric": {
            "Name": "AGENTS_ERROR",
            "Unit": "COUNT"
          },
          "Value": 0
        },
        {
            "Metric": {
                "Name": "ESTIMATED_WAIT_TIME",
                "Unit": "SECONDS"
            },
            "Value": 1.00
        }
      ],
      "Dimensions": {
        "Channel": "VOICE",
        "Queue": {
          "Arn": "arn:aws:connect:us-east-1:123456789012:instance/12345678-1234-5678-aabb-123456abcdef/queue/11111111-2222-fcfc-abab-333333333333",
          "Id": "11111111-2222-fcfc-abab-333333333333"
        }
      }
    }
  ]
}
```

### Sample GetCurrentMetricData Request Using RoutingStepExpression
<a name="API_GetCurrentMetricData_Example_2"></a>

This example illustrates one usage of GetCurrentMetricData.

```
{
     "InstanceId": "12345678-1234-5678-aabb-123456abcdef",
    "CurrentMetrics": [
        {
            "Name": "OLDEST_CONTACT_AGE",
            "Unit": "SECONDS"
        },
        {
            "Name": "CONTACTS_IN_QUEUE",
            "Unit": "COUNT"
        }
    ],
    "Filters": {
        "Queues": [
            "11111111-2222-fcfc-abab-333333333333"
        ],
        "RoutingStepExpressions": [
            "{\"attributeCondition\":{\"proficiencyLevel\":1.0,\"comparisonOperator\":\"NumberGreaterOrEqualTo\",\"name\":\"Location\",\"value\":\"Earth\"}}"
        ]
    },
    "Groupings": [
        "ROUTING_STEP_EXPRESSION"
    ],
    "MaxResults": 10
}
```

## See Also
<a name="API_GetCurrentMetricData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/GetCurrentMetricData) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/GetCurrentMetricData) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/GetCurrentMetricData) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/GetCurrentMetricData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/GetCurrentMetricData) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/GetCurrentMetricData) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/GetCurrentMetricData) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/GetCurrentMetricData) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/GetCurrentMetricData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/GetCurrentMetricData) 

# GetCurrentUserData
<a name="API_GetCurrentUserData"></a>

Gets the real-time active user data from the specified Amazon Connect instance. 

## Request Syntax
<a name="API_GetCurrentUserData_RequestSyntax"></a>

```
POST /metrics/userdata/InstanceId HTTP/1.1
Content-type: application/json

{
   "Filters": { 
      "Agents": [ "string" ],
      "ContactFilter": { 
         "ContactStates": [ "string" ]
      },
      "Queues": [ "string" ],
      "RoutingProfiles": [ "string" ],
      "UserHierarchyGroups": [ "string" ]
   },
   "MaxResults": number,
   "NextToken": "string"
}
```

## URI Request Parameters
<a name="API_GetCurrentUserData_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_GetCurrentUserData_RequestSyntax) **   <a name="connect-GetCurrentUserData-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_GetCurrentUserData_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Filters](#API_GetCurrentUserData_RequestSyntax) **   <a name="connect-GetCurrentUserData-request-Filters"></a>
The filters to apply to returned user data. You can filter up to the following limits:  
+ Queues: 100
+ Routing profiles: 100
+ Agents: 100
+ Contact states: 9
+ User hierarchy groups: 1
 The user data is retrieved for only the specified values/resources in the filter. A maximum of one filter can be passed from queues, routing profiles, agents, and user hierarchy groups.   
Currently tagging is only supported on the resources that are passed in the filter.  
Type: [UserDataFilters](API_UserDataFilters.md) object  
Required: Yes

 ** [MaxResults](#API_GetCurrentUserData_RequestSyntax) **   <a name="connect-GetCurrentUserData-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_GetCurrentUserData_RequestSyntax) **   <a name="connect-GetCurrentUserData-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Required: No

## Response Syntax
<a name="API_GetCurrentUserData_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "NextToken": "string",
   "UserDataList": [ 
      { 
         "ActiveSlotsByChannel": { 
            "string" : number 
         },
         "AvailableSlotsByChannel": { 
            "string" : number 
         },
         "Contacts": [ 
            { 
               "AgentContactState": "string",
               "Channel": "string",
               "ConnectedToAgentTimestamp": number,
               "ContactId": "string",
               "InitiationMethod": "string",
               "Queue": { 
                  "Arn": "string",
                  "Id": "string"
               },
               "StateStartTimestamp": number
            }
         ],
         "HierarchyPath": { 
            "LevelFive": { 
               "Arn": "string",
               "Id": "string"
            },
            "LevelFour": { 
               "Arn": "string",
               "Id": "string"
            },
            "LevelOne": { 
               "Arn": "string",
               "Id": "string"
            },
            "LevelThree": { 
               "Arn": "string",
               "Id": "string"
            },
            "LevelTwo": { 
               "Arn": "string",
               "Id": "string"
            }
         },
         "MaxSlotsByChannel": { 
            "string" : number 
         },
         "NextStatus": "string",
         "RoutingProfile": { 
            "Arn": "string",
            "Id": "string"
         },
         "Status": { 
            "StatusArn": "string",
            "StatusName": "string",
            "StatusStartTimestamp": number
         },
         "User": { 
            "Arn": "string",
            "Id": "string"
         }
      }
   ]
}
```

## Response Elements
<a name="API_GetCurrentUserData_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_GetCurrentUserData_ResponseSyntax) **   <a name="connect-GetCurrentUserData-response-ApproximateTotalCount"></a>
The total count of the result, regardless of the current page size.  
Type: Long

 ** [NextToken](#API_GetCurrentUserData_ResponseSyntax) **   <a name="connect-GetCurrentUserData-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [UserDataList](#API_GetCurrentUserData_ResponseSyntax) **   <a name="connect-GetCurrentUserData-response-UserDataList"></a>
A list of the user data that is returned.  
Type: Array of [UserData](API_UserData.md) objects

## Errors
<a name="API_GetCurrentUserData_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_GetCurrentUserData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/GetCurrentUserData) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/GetCurrentUserData) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/GetCurrentUserData) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/GetCurrentUserData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/GetCurrentUserData) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/GetCurrentUserData) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/GetCurrentUserData) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/GetCurrentUserData) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/GetCurrentUserData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/GetCurrentUserData) 

# GetEffectiveHoursOfOperations
<a name="API_GetEffectiveHoursOfOperations"></a>

Get the hours of operations with the effective override applied.

## Request Syntax
<a name="API_GetEffectiveHoursOfOperations_RequestSyntax"></a>

```
GET /effective-hours-of-operations/InstanceId/HoursOfOperationId?fromDate=FromDate&toDate=ToDate HTTP/1.1
```

## URI Request Parameters
<a name="API_GetEffectiveHoursOfOperations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [FromDate](#API_GetEffectiveHoursOfOperations_RequestSyntax) **   <a name="connect-GetEffectiveHoursOfOperations-request-uri-FromDate"></a>
The date from when the hours of operation are listed.  
Pattern: `^\d{4}-\d{2}-\d{2}$`   
Required: Yes

 ** [HoursOfOperationId](#API_GetEffectiveHoursOfOperations_RequestSyntax) **   <a name="connect-GetEffectiveHoursOfOperations-request-uri-HoursOfOperationId"></a>
The identifier for the hours of operation.  
Required: Yes

 ** [InstanceId](#API_GetEffectiveHoursOfOperations_RequestSyntax) **   <a name="connect-GetEffectiveHoursOfOperations-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [ToDate](#API_GetEffectiveHoursOfOperations_RequestSyntax) **   <a name="connect-GetEffectiveHoursOfOperations-request-uri-ToDate"></a>
The date until when the hours of operation are listed.  
Pattern: `^\d{4}-\d{2}-\d{2}$`   
Required: Yes

## Request Body
<a name="API_GetEffectiveHoursOfOperations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetEffectiveHoursOfOperations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EffectiveHoursOfOperationList": [ 
      { 
         "Date": "string",
         "OperationalHours": [ 
            { 
               "End": { 
                  "Hours": number,
                  "Minutes": number
               },
               "Start": { 
                  "Hours": number,
                  "Minutes": number
               }
            }
         ]
      }
   ],
   "EffectiveOverrideHoursList": [ 
      { 
         "Date": "string",
         "OverrideHours": [ 
            { 
               "End": { 
                  "Hours": number,
                  "Minutes": number
               },
               "OperationalStatus": "string",
               "OverrideName": "string",
               "Start": { 
                  "Hours": number,
                  "Minutes": number
               }
            }
         ]
      }
   ],
   "TimeZone": "string"
}
```

## Response Elements
<a name="API_GetEffectiveHoursOfOperations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EffectiveHoursOfOperationList](#API_GetEffectiveHoursOfOperations_ResponseSyntax) **   <a name="connect-GetEffectiveHoursOfOperations-response-EffectiveHoursOfOperationList"></a>
Information about the effective hours of operations.  
Type: Array of [EffectiveHoursOfOperations](API_EffectiveHoursOfOperations.md) objects

 ** [EffectiveOverrideHoursList](#API_GetEffectiveHoursOfOperations_ResponseSyntax) **   <a name="connect-GetEffectiveHoursOfOperations-response-EffectiveOverrideHoursList"></a>
Information about override configurations applied to the base hours of operation to calculate the effective hours.  
For more information about how override types are applied, see [Build your list of overrides](https://docs.aws.amazon.com/https:/docs.aws.amazon.com/connect/latest/adminguide/hours-of-operation-overrides.html) in the * Administrator Guide*.  
Type: Array of [EffectiveOverrideHours](API_EffectiveOverrideHours.md) objects

 ** [TimeZone](#API_GetEffectiveHoursOfOperations_ResponseSyntax) **   <a name="connect-GetEffectiveHoursOfOperations-response-TimeZone"></a>
The time zone for the hours of operation.  
Type: String

## Errors
<a name="API_GetEffectiveHoursOfOperations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_GetEffectiveHoursOfOperations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/GetEffectiveHoursOfOperations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/GetEffectiveHoursOfOperations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/GetEffectiveHoursOfOperations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/GetEffectiveHoursOfOperations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/GetEffectiveHoursOfOperations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/GetEffectiveHoursOfOperations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/GetEffectiveHoursOfOperations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/GetEffectiveHoursOfOperations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/GetEffectiveHoursOfOperations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/GetEffectiveHoursOfOperations) 

# GetFederationToken
<a name="API_GetFederationToken"></a>

Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action. 

For more information about how SAML sign-in works in Amazon Connect, see [Configure SAML with IAM for Amazon Connect in the *Amazon Connect Administrator Guide*.](https://docs.aws.amazon.com/connect/latest/adminguide/configure-saml.html ) 

**Note**  
This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears:   
 `Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect` 

## Request Syntax
<a name="API_GetFederationToken_RequestSyntax"></a>

```
GET /user/federate/InstanceId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetFederationToken_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_GetFederationToken_RequestSyntax) **   <a name="connect-GetFederationToken-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_GetFederationToken_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetFederationToken_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Credentials": { 
      "AccessToken": "string",
      "AccessTokenExpiration": number,
      "RefreshToken": "string",
      "RefreshTokenExpiration": number
   },
   "SignInUrl": "string",
   "UserArn": "string",
   "UserId": "string"
}
```

## Response Elements
<a name="API_GetFederationToken_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Credentials](#API_GetFederationToken_ResponseSyntax) **   <a name="connect-GetFederationToken-response-Credentials"></a>
The credentials to use for federation.  
Type: [Credentials](API_Credentials.md) object

 ** [SignInUrl](#API_GetFederationToken_ResponseSyntax) **   <a name="connect-GetFederationToken-response-SignInUrl"></a>
The URL to sign into the user's instance.   
Type: String

 ** [UserArn](#API_GetFederationToken_ResponseSyntax) **   <a name="connect-GetFederationToken-response-UserArn"></a>
The Amazon Resource Name (ARN) of the user.  
Type: String

 ** [UserId](#API_GetFederationToken_ResponseSyntax) **   <a name="connect-GetFederationToken-response-UserId"></a>
The identifier for the user. This can be the ID or the ARN of the user.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_GetFederationToken_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** UserNotFoundException **   
No user with the specified credentials was found in the Amazon Connect instance.  
HTTP Status Code: 404

## See Also
<a name="API_GetFederationToken_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/GetFederationToken) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/GetFederationToken) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/GetFederationToken) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/GetFederationToken) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/GetFederationToken) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/GetFederationToken) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/GetFederationToken) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/GetFederationToken) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/GetFederationToken) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/GetFederationToken) 

# GetFlowAssociation
<a name="API_GetFlowAssociation"></a>

Retrieves the flow associated for a given resource.

## Request Syntax
<a name="API_GetFlowAssociation_RequestSyntax"></a>

```
GET /flow-associations/InstanceId/ResourceId/ResourceType HTTP/1.1
```

## URI Request Parameters
<a name="API_GetFlowAssociation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_GetFlowAssociation_RequestSyntax) **   <a name="connect-GetFlowAssociation-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [ResourceId](#API_GetFlowAssociation_RequestSyntax) **   <a name="connect-GetFlowAssociation-request-uri-ResourceId"></a>
The identifier of the resource.  
+  AWS End User Messaging SMS phone number ARN when using `SMS_PHONE_NUMBER` 
+  AWS End User Messaging Social phone number ARN when using `WHATSAPP_MESSAGING_PHONE_NUMBER` 
Required: Yes

 ** [ResourceType](#API_GetFlowAssociation_RequestSyntax) **   <a name="connect-GetFlowAssociation-request-uri-ResourceType"></a>
A valid resource type.  
Valid Values: `SMS_PHONE_NUMBER | INBOUND_EMAIL | OUTBOUND_EMAIL | ANALYTICS_CONNECTOR | WHATSAPP_MESSAGING_PHONE_NUMBER`   
Required: Yes

## Request Body
<a name="API_GetFlowAssociation_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetFlowAssociation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "FlowId": "string",
   "ResourceId": "string",
   "ResourceType": "string"
}
```

## Response Elements
<a name="API_GetFlowAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FlowId](#API_GetFlowAssociation_ResponseSyntax) **   <a name="connect-GetFlowAssociation-response-FlowId"></a>
The identifier of the flow.  
Type: String

 ** [ResourceId](#API_GetFlowAssociation_ResponseSyntax) **   <a name="connect-GetFlowAssociation-response-ResourceId"></a>
The identifier of the resource.  
Type: String

 ** [ResourceType](#API_GetFlowAssociation_ResponseSyntax) **   <a name="connect-GetFlowAssociation-response-ResourceType"></a>
A valid resource type.  
Type: String  
Valid Values: `SMS_PHONE_NUMBER | INBOUND_EMAIL | OUTBOUND_EMAIL | ANALYTICS_CONNECTOR | WHATSAPP_MESSAGING_PHONE_NUMBER` 

## Errors
<a name="API_GetFlowAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_GetFlowAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/GetFlowAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/GetFlowAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/GetFlowAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/GetFlowAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/GetFlowAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/GetFlowAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/GetFlowAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/GetFlowAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/GetFlowAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/GetFlowAssociation) 

# GetMetricData
<a name="API_GetMetricData"></a>

Gets historical metric data from the specified Amazon Connect instance.

For a description of each historical metric, see [Metrics definitions](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html) in the *Amazon Connect Administrator Guide*.

**Note**  
We recommend using the [GetMetricDataV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html) API. It provides more flexibility, features, and the ability to query longer time ranges than `GetMetricData`. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.

## Request Syntax
<a name="API_GetMetricData_RequestSyntax"></a>

```
POST /metrics/historical/InstanceId HTTP/1.1
Content-type: application/json

{
   "EndTime": number,
   "Filters": { 
      "AgentStatuses": [ "string" ],
      "Channels": [ "string" ],
      "Queues": [ "string" ],
      "RoutingProfiles": [ "string" ],
      "RoutingStepExpressions": [ "string" ],
      "Subtypes": [ "string" ],
      "ValidationTestTypes": [ "string" ]
   },
   "Groupings": [ "string" ],
   "HistoricalMetrics": [ 
      { 
         "Name": "string",
         "Statistic": "string",
         "Threshold": { 
            "Comparison": "string",
            "ThresholdValue": number
         },
         "Unit": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string",
   "StartTime": number
}
```

## URI Request Parameters
<a name="API_GetMetricData_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_GetMetricData_RequestSyntax) **   <a name="connect-GetMetricData-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_GetMetricData_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [EndTime](#API_GetMetricData_RequestSyntax) **   <a name="connect-GetMetricData-request-EndTime"></a>
The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.  
The time range between the start and end time must be less than 24 hours.  
Type: Timestamp  
Required: Yes

 ** [Filters](#API_GetMetricData_RequestSyntax) **   <a name="connect-GetMetricData-request-Filters"></a>
The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.  
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.  
To filter by `Queues`, enter the queue ID/ARN, not the name of the queue.
Type: [Filters](API_Filters.md) object  
Required: Yes

 ** [Groupings](#API_GetMetricData_RequestSyntax) **   <a name="connect-GetMetricData-request-Groupings"></a>
The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.  
If no grouping is specified, a summary of metrics for all queues is returned.  
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.  
Type: Array of strings  
Array Members: Maximum number of 2 items.  
Valid Values: `QUEUE | CHANNEL | ROUTING_PROFILE | ROUTING_STEP_EXPRESSION | AGENT_STATUS | SUBTYPE | VALIDATION_TEST_TYPE`   
Required: No

 ** [HistoricalMetrics](#API_GetMetricData_RequestSyntax) **   <a name="connect-GetMetricData-request-HistoricalMetrics"></a>
The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see [Metrics definition](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html) in the *Amazon Connect Administrator Guide*.  
This API does not support a contacts incoming metric (there's no CONTACTS\$1INCOMING metric missing from the documented list).   
ABANDON\$1TIME  
Unit: SECONDS  
Statistic: AVG  
UI name: [Average queue abandon time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time)   
AFTER\$1CONTACT\$1WORK\$1TIME  
Unit: SECONDS  
Statistic: AVG  
UI name: [After contact work time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time)   
API\$1CONTACTS\$1HANDLED  
Unit: COUNT  
Statistic: SUM  
UI name: [API contacts handled](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#api-contacts-handled)   
AVG\$1HOLD\$1TIME  
Unit: SECONDS  
Statistic: AVG  
UI name: [Average customer hold time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time)   
CALLBACK\$1CONTACTS\$1HANDLED  
Unit: COUNT  
Statistic: SUM  
UI name: [Callback contacts handled](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#callback-contacts-handled)   
CONTACTS\$1ABANDONED  
Unit: COUNT  
Statistic: SUM  
UI name: [Contacts abandoned](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned)   
CONTACTS\$1AGENT\$1HUNG\$1UP\$1FIRST  
Unit: COUNT  
Statistic: SUM  
UI name: [Contacts agent hung up first](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-agent-hung-up-first)   
CONTACTS\$1CONSULTED  
Unit: COUNT  
Statistic: SUM  
UI name: [Contacts consulted](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-consulted)   
CONTACTS\$1HANDLED  
Unit: COUNT  
Statistic: SUM  
UI name: [Contacts handled](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled)   
CONTACTS\$1HANDLED\$1INCOMING  
Unit: COUNT  
Statistic: SUM  
UI name: [Contacts handled incoming](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-incoming)   
CONTACTS\$1HANDLED\$1OUTBOUND  
Unit: COUNT  
Statistic: SUM  
UI name: [Contacts handled outbound](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-outbound)   
CONTACTS\$1HOLD\$1ABANDONS  
Unit: COUNT  
Statistic: SUM  
UI name: [Contacts hold disconnect](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-disconnect)   
CONTACTS\$1MISSED  
Unit: COUNT  
Statistic: SUM  
UI name: [AGENT\$1NON\$1RESPONSE](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response)   
CONTACTS\$1QUEUED  
Unit: COUNT  
Statistic: SUM  
UI name: [Contacts queued](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued)   
CONTACTS\$1TRANSFERRED\$1IN  
Unit: COUNT  
Statistic: SUM  
UI name: [Contacts transferred in](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-in)   
CONTACTS\$1TRANSFERRED\$1IN\$1FROM\$1QUEUE  
Unit: COUNT  
Statistic: SUM  
UI name: [Contacts transferred out queue](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue)   
CONTACTS\$1TRANSFERRED\$1OUT  
Unit: COUNT  
Statistic: SUM  
UI name: [Contacts transferred out](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out)   
CONTACTS\$1TRANSFERRED\$1OUT\$1FROM\$1QUEUE  
Unit: COUNT  
Statistic: SUM  
UI name: [Contacts transferred out queue](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue)   
HANDLE\$1TIME  
Unit: SECONDS  
Statistic: AVG  
UI name: [Average handle time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-handle-time)   
INTERACTION\$1AND\$1HOLD\$1TIME  
Unit: SECONDS  
Statistic: AVG  
UI name: [Average agent interaction and customer hold time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interaction-and-customer-hold-time)   
INTERACTION\$1TIME  
Unit: SECONDS  
Statistic: AVG  
UI name: [Average agent interaction time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#aaverage-agent-interaction-time)   
OCCUPANCY  
Unit: PERCENT  
Statistic: AVG  
UI name: [Occupancy](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#occupancy)   
QUEUE\$1ANSWER\$1TIME  
Unit: SECONDS  
Statistic: AVG  
UI name: [Average queue answer time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html##average-queue-answer-time)   
QUEUED\$1TIME  
Unit: SECONDS  
Statistic: MAX  
UI name: [Minimum flow time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#minimum-flow-time)   
SERVICE\$1LEVEL  
You can include up to 20 SERVICE\$1LEVEL metrics in a request.  
Unit: PERCENT  
Statistic: AVG  
Threshold: For `ThresholdValue`, enter any whole number from 1 to 604800 (inclusive), in seconds. For `Comparison`, you must enter `LT` (for "Less than").   
UI name: [Average queue abandon time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time) 
Type: Array of [HistoricalMetric](API_HistoricalMetric.md) objects  
Required: Yes

 ** [MaxResults](#API_GetMetricData_RequestSyntax) **   <a name="connect-GetMetricData-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_GetMetricData_RequestSyntax) **   <a name="connect-GetMetricData-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Required: No

 ** [StartTime](#API_GetMetricData_RequestSyntax) **   <a name="connect-GetMetricData-request-StartTime"></a>
The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.  
The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.  
Type: Timestamp  
Required: Yes

## Response Syntax
<a name="API_GetMetricData_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "MetricResults": [ 
      { 
         "Collections": [ 
            { 
               "Metric": { 
                  "Name": "string",
                  "Statistic": "string",
                  "Threshold": { 
                     "Comparison": "string",
                     "ThresholdValue": number
                  },
                  "Unit": "string"
               },
               "Value": number
            }
         ],
         "Dimensions": { 
            "AgentStatus": { 
               "Arn": "string",
               "Id": "string"
            },
            "Channel": "string",
            "Queue": { 
               "Arn": "string",
               "Id": "string"
            },
            "RoutingProfile": { 
               "Arn": "string",
               "Id": "string"
            },
            "RoutingStepExpression": "string",
            "Subtype": "string",
            "ValidationTestType": "string"
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_GetMetricData_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [MetricResults](#API_GetMetricData_ResponseSyntax) **   <a name="connect-GetMetricData-response-MetricResults"></a>
Information about the historical metrics.  
If no grouping is specified, a summary of metric data is returned.  
Type: Array of [HistoricalMetricResult](API_HistoricalMetricResult.md) objects

 ** [NextToken](#API_GetMetricData_ResponseSyntax) **   <a name="connect-GetMetricData-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.  
Type: String

## Errors
<a name="API_GetMetricData_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_GetMetricData_Examples"></a>

### Example
<a name="API_GetMetricData_Example_1"></a>

The following example retrieves the specified historical metrics.

#### Sample Request
<a name="API_GetMetricData_Example_1_Request"></a>

```
{
   "InstanceId" : "12345678-1234-5678-aabb-123456abcdef",
   "StartTime": 1548979200,
   "EndTime": 1549051200,
   "Filters" : {
      "Queues" : [
         "11111111-2222-fcfc-abab-333333333333"
      ],
      "Channels" : ["VOICE"]
   },
   "Groupings" : [
      "QUEUE",
      "CHANNEL"
   ],
   "HistoricalMetrics" : [
      {
         "Name" : "AFTER_CONTACT_WORK_TIME",
         "Unit" : "SECONDS",
         "Statistic" : "AVG"
      },
      {
         "Name" : "CONTACTS_QUEUED",
         "Unit" : "COUNT",
         "Statistic" : "SUM"
      },
      {
         "Name" : "CONTACTS_HANDLED",
         "Unit" : "COUNT",
         "Statistic" : "SUM"
      },
      {
         "Name" : "HANDLE_TIME",
         "Unit" : "SECONDS",
         "Statistic" : "AVG"
      },
      {
         "Name" : "CONTACTS_TRANSFERRED_OUT",
         "Unit" : "COUNT",
         "Statistic" : "SUM"
      },
      {
         "Name" : "CONTACTS_MISSED",
         "Unit" : "COUNT",
         "Statistic" : "SUM"
      },
      {
         "Name" : "OCCUPANCY",
         "Unit" : "PERCENT",
         "Statistic" : "AVG"
      },
      {
         "Name" : "QUEUED_TIME",
         "Unit" : "SECONDS",
         "Statistic" : "MAX"
      },
      {
         "Name" : "HOLD_TIME",
         "Unit" : "SECONDS",
         "Statistic" : "AVG"
      },
      {
         "Name" : "SERVICE_LEVEL",
         "Threshold" : {
            "Comparison" : "LT",
            "ThresholdValue" : 60.0
         },
         "Unit" : "PERCENT",
         "Statistic" : "AVG"
      },
      {
         "Name" : "SERVICE_LEVEL",
         "Threshold" : {
            "Comparison" : "LT",
            "ThresholdValue" : 120.0
         },
         "Unit" : "PERCENT",
         "Statistic" : "AVG"
      },
      {
         "Name" : "SERVICE_LEVEL",
         "Threshold" : {
            "Comparison" : "LT",
            "ThresholdValue" : 30.0
         },
         "Unit" : "PERCENT",
         "Statistic" : "AVG"
      }
   ]
}
```

#### Sample Response
<a name="API_GetMetricData_Example_1_Response"></a>

```
{
   "MetricResults": [
      {
         "Collections": [
            {
               "Metric": {
                  "Name": "OCCUPANCY",
                  "Statistic": "AVG",
                  "Threshold": null,
                  "Unit": "PERCENT"
               },
               "Value": 0
            },
            {
               "Metric": {
                  "Name": "CONTACTS_MISSED",
                  "Statistic": "SUM",
                  "Threshold": null,
                  "Unit": "COUNT"
               },
               "Value": 0
            }
         ],
         "Dimensions": {
            "Channel": "VOICE",
            "Queue": {
               "Arn": "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-5678-aabb-123456abcdef/queue/11111111-2222-fcfc-abab-333333333333",
               "Id": "11111111-2222-fcfc-abab-333333333333"
            }
         }
      }
   ]
}
```

## See Also
<a name="API_GetMetricData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/GetMetricData) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/GetMetricData) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/GetMetricData) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/GetMetricData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/GetMetricData) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/GetMetricData) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/GetMetricData) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/GetMetricData) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/GetMetricData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/GetMetricData) 

# GetMetricDataV2
<a name="API_GetMetricDataV2"></a>

Gets metric data from the specified Amazon Connect instance. 

 `GetMetricDataV2` offers more features than [GetMetricData](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricData.html), the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It does not support agent queues.

For a description of the historical metrics that are supported by `GetMetricDataV2` and `GetMetricData`, see [Metrics definitions](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html) in the *Amazon Connect Administrator Guide*.

**Note**  
When you make a successful API request, you can expect the following metric values in the response:  
 **Metric value is null**: The calculation cannot be performed due to divide by zero or insufficient data
 **Metric value is a number (including 0) of defined type**: The number provided is the calculation result
 **MetricResult list is empty**: The request cannot find any data in the system
The following guidelines can help you work with the API:  
Each dimension in the metric response must contain a value
Each item in MetricResult must include all requested metrics
If the response is slow due to large result sets, try these approaches:  
Narrow the time range of your request
Add filters to reduce the amount of data returned

## Request Syntax
<a name="API_GetMetricDataV2_RequestSyntax"></a>

```
POST /metrics/data HTTP/1.1
Content-type: application/json

{
   "EndTime": number,
   "Filters": [ 
      { 
         "FilterKey": "string",
         "FilterValues": [ "string" ],
         "StringCondition": { 
            "Comparison": "string"
         }
      }
   ],
   "Groupings": [ "string" ],
   "Interval": { 
      "IntervalPeriod": "string",
      "TimeZone": "string"
   },
   "MaxResults": number,
   "Metrics": [ 
      { 
         "MetricFilters": [ 
            { 
               "MetricFilterKey": "string",
               "MetricFilterValues": [ "string" ],
               "Negate": boolean
            }
         ],
         "MetricId": "string",
         "Name": "string",
         "Threshold": [ 
            { 
               "Comparison": "string",
               "ThresholdValue": number
            }
         ]
      }
   ],
   "NextToken": "string",
   "ResourceArn": "string",
   "StartTime": number
}
```

## URI Request Parameters
<a name="API_GetMetricDataV2_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetMetricDataV2_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [EndTime](#API_GetMetricDataV2_RequestSyntax) **   <a name="connect-GetMetricDataV2-request-EndTime"></a>
The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be later than the start time timestamp. It cannot be later than the current timestamp.  
Type: Timestamp  
Required: Yes

 ** [Filters](#API_GetMetricDataV2_RequestSyntax) **   <a name="connect-GetMetricDataV2-request-Filters"></a>
Filtering is an operation that selects records that match a set of specified criteria. By narrowing the dataset before aggregation, filters ensure that only relevant records are included in the computation.  
 **Filter keys**   
The following are valid filter keys for a `GetMetricDataV2` request:  
 `AGENT` \$1 `AGENT_HIERARCHY_LEVEL_ONE` \$1 `AGENT_HIERARCHY_LEVEL_TWO` \$1 `AGENT_HIERARCHY_LEVEL_THREE` \$1 `AGENT_HIERARCHY_LEVEL_FOUR` \$1 `AGENT_HIERARCHY_LEVEL_FIVE` \$1 `ANSWERING_MACHINE_DETECTION_STATUS` \$1 `BOT_ALIAS` \$1 `BOT_ID` \$1 `BOT_INTENT_NAME` \$1 `BOT_LOCALE` \$1 `BOT_VERSION` \$1 `CAMPAIGN` \$1 `CAMPAIGN_DELIVERY_EVENT_TYPE` \$1 `CAMPAIGN_EXCLUDED_EVENT_TYPE` \$1 `CASE_STATUS` \$1 `CASE_TEMPLATE_ARN` \$1 `CHANNEL` \$1 `contact/segmentAttributes/connect:Subtype` \$1 `contact/segmentAttributes/connect:ValidationTestType` \$1 `DISCONNECT_REASON` \$1 `EVALUATION_FORM` \$1 `EVALUATION_QUESTION` \$1 `EVALUATION_SECTION` \$1 `EVALUATION_SOURCE` \$1 `EVALUATOR_ID` \$1 `FEATURE` \$1 `FLOW_ACTION_ID` \$1 `FLOW_TYPE` \$1 `FLOWS_MODULE_RESOURCE_ID` \$1 `FLOWS_NEXT_RESOURCE_ID` \$1 `FLOWS_NEXT_RESOURCE_QUEUE_ID` \$1 `FLOWS_OUTCOME_TYPE` \$1 `FLOWS_RESOURCE_ID` \$1 `FORM_VERSION` \$1 `INITIATING_FLOW` \$1 `INITIATION_METHOD` \$1 `INVOKING_RESOURCE_PUBLISHED_TIMESTAMP` \$1 `INVOKING_RESOURCE_TYPE` \$1 `PARENT_FLOWS_RESOURCE_ID` \$1 `Q_CONNECT_ENABLED` \$1 `QUEUE` \$1 `RESOURCE_PUBLISHED_TIMESTAMP` \$1 `ROUTING_PROFILE` \$1 `ROUTING_STEP_EXPRESSION` \$1 `TEST_CASE` \$1 `TEST_CASE_EXECUTION_FAILURE_REASON` \$1 `TEST_CASE_EXECUTION_RESULT` \$1 `TEST_CASE_EXECUTION_STATE`   
The following filter keys correspond to Amazon Connect resources and are used for authorizing requests. A `GetMetricDataV2` request requires at least one of these filters:  
 `QUEUE`, `ROUTING_PROFILE`, `AGENT`, `AGENT_HIERARCHY_LEVEL_ONE`, `AGENT_HIERARCHY_LEVEL_TWO`, `AGENT_HIERARCHY_LEVEL_THREE`, `AGENT_HIERARCHY_LEVEL_FOUR`, `AGENT_HIERARCHY_LEVEL_FIVE`, `CAMPAIGN`, `EVALUATION_FORM`, `EVALUATOR_ID`   
You can use up to 5 filter keys in a single request, and up to 100 filter values across all filter keys.
 **Filter values**   
+ VOICE, CHAT, TASK, and EMAIL are valid filter values for the `CHANNEL` filter key. They do not count towards the limit of 100 filter values. For example, a `GetMetricDataV2` request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 4 channel filters.
+  `contact_lens_conversational_analytics` is a valid filter value for the `FEATURE` filter key. It is available only for contacts analyzed by Contact Lens conversational analytics.
+  `connect:Chat`, `connect:SMS`, `connect:Telephony`, and `connect:WebRTC` are valid filter value examples (not exhaustive) for the `contact/segmentAttributes/connect:Subtype` filter key.
+  `ROUTING_STEP_EXPRESSION` accepts a filter value up to 3,000 characters in length. This filter is case-sensitive and order-sensitive. JSON string fields must be sorted in ascending order, and JSON array order must be preserved.
+ TRUE and FALSE are the only valid filter values for the `Q_CONNECT_ENABLED` filter key.
  + TRUE includes all contacts that had Connect AI Agents enabled as part of the flow.
  + FALSE includes all contacts that did not have Connect AI Agents enabled as part of the flow.
+  `EXPERIENCE_VALIDATION` and `FLOW_VALIDATION` are the only valid filter values for the `contact/segmentAttributes/connect:ValidationTestType` filter key. This filter is available only for contact record-driven metrics.
+  [Campaign](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-outbound-campaigns_Campaign.html) ARNs are valid filter values for the `CAMPAIGN` filter key.
+ To filter by phone number, see [Create a historical metrics report](https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html) in the *Amazon Connect Administrator Guide*.
Type: Array of [FilterV2](API_FilterV2.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Required: Yes

 ** [Groupings](#API_GetMetricDataV2_RequestSyntax) **   <a name="connect-GetMetricDataV2-request-Groupings"></a>
The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.  
If no grouping is specified, a summary of all metrics is returned.  
Valid grouping keys: `AGENT` \$1 `AGENT_HIERARCHY_LEVEL_ONE` \$1 `AGENT_HIERARCHY_LEVEL_TWO` \$1 `AGENT_HIERARCHY_LEVEL_THREE` \$1 `AGENT_HIERARCHY_LEVEL_FOUR` \$1 `AGENT_HIERARCHY_LEVEL_FIVE` \$1 `ANSWERING_MACHINE_DETECTION_STATUS` \$1 `BOT_ID` \$1 `BOT_ALIAS` \$1 `BOT_VERSION` \$1 `BOT_LOCALE` \$1 `BOT_INTENT_NAME` \$1 `CAMPAIGN` \$1 `CAMPAIGN_DELIVERY_EVENT_TYPE` \$1 `CAMPAIGN_EXCLUDED_EVENT_TYPE` \$1 `CAMPAIGN_EXECUTION_TIMESTAMP` \$1 `CASE_TEMPLATE_ARN` \$1 `CASE_STATUS` \$1 `CHANNEL` \$1 `contact/segmentAttributes/connect:Subtype` \$1 `DISCONNECT_REASON` \$1 `EVALUATION_FORM` \$1 `EVALUATION_SECTION` \$1 `EVALUATION_QUESTION` \$1 `EVALUATION_SOURCE` \$1 `EVALUATOR_ID` \$1 `FLOWS_RESOURCE_ID` \$1 `FLOWS_MODULE_RESOURCE_ID` \$1 `FLOW_ACTION_ID` \$1 `FLOW_TYPE` \$1 `FLOWS_OUTCOME_TYPE` \$1 `FORM_VERSION` \$1 `INITIATION_METHOD` \$1 `INVOKING_RESOURCE_PUBLISHED_TIMESTAMP` \$1 `INVOKING_RESOURCE_TYPE` \$1 `PARENT_FLOWS_RESOURCE_ID` \$1 `Q_CONNECT_ENABLED` \$1 `QUEUE` \$1 `RESOURCE_PUBLISHED_TIMESTAMP` \$1 `ROUTING_PROFILE` \$1 `ROUTING_STEP_EXPRESSION` \$1 `TEST_CASE` \$1 `TEST_CASE_EXECUTION_FAILURE_REASON` \$1 `TEST_CASE_INVOCATION_METHOD`   
API, SCHEDULE, and EVENT are the only valid filterValues for TEST\$1CASE\$1INVOCATION\$1METHOD.  
OBSERVE\$1EVENT, SEND\$1INSTRUCTION, ASSERT\$1DATA, and OVERRIDE\$1SYSTEM\$1BEHAVIOR are the only valid filterValues for TEST\$1CASE\$1EXECUTION\$1FAILURE\$1REASON  
Type: Array of strings  
Array Members: Maximum number of 4 items  
Required: No  
Type: Array of strings  
Array Members: Maximum number of 4 items.  
Required: No

 ** [Interval](#API_GetMetricDataV2_RequestSyntax) **   <a name="connect-GetMetricDataV2-request-Interval"></a>
The interval period and timezone to apply to returned metrics.  
+  `IntervalPeriod`: An aggregated grouping applied to request metrics. Valid `IntervalPeriod` values are: `FIFTEEN_MIN` \$1 `THIRTY_MIN` \$1 `HOUR` \$1 `DAY` \$1 `WEEK` \$1 `TOTAL`. 

  For example, if `IntervalPeriod` is selected `THIRTY_MIN`, `StartTime` and `EndTime` differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY\$1MIN period. By default Amazon Connect aggregates results based on the `TOTAL` interval period. 

  The following list describes restrictions on `StartTime` and `EndTime` based on which `IntervalPeriod` is requested. 
  +  `FIFTEEN_MIN`: The difference between `StartTime` and `EndTime` must be less than 3 days.
  +  `THIRTY_MIN`: The difference between `StartTime` and `EndTime` must be less than 3 days.
  +  `HOUR`: The difference between `StartTime` and `EndTime` must be less than 3 days.
  +  `DAY`: The difference between `StartTime` and `EndTime` must be less than 35 days.
  +  `WEEK`: The difference between `StartTime` and `EndTime` must be less than 35 days.
  +  `TOTAL`: The difference between `StartTime` and `EndTime` must be less than 35 days.
+  `TimeZone`: The timezone applied to requested metrics.
Type: [IntervalDetails](API_IntervalDetails.md) object  
Required: No

 ** [MaxResults](#API_GetMetricDataV2_RequestSyntax) **   <a name="connect-GetMetricDataV2-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [Metrics](#API_GetMetricDataV2_RequestSyntax) **   <a name="connect-GetMetricDataV2-request-Metrics"></a>
The metrics to retrieve. Specify the name or metricId, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see [Metrics definition](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html) in the *Amazon Connect Administrator Guide*.  
MetricId should be used to reference custom metrics or out of the box metrics as Arn. If using MetricId, the limit is 20 MetricId per request.  
ABANDONMENT\$1RATE  
Unit: Percent  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Abandonment rate](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#abandonment-rate)   
AGENT\$1ADHERENT\$1TIME  
This metric is available only in AWS Regions where [Forecasting, capacity planning, and scheduling](https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region) is available.  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy   
UI name: [Adherent time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#adherent-time)   
AGENT\$1ANSWER\$1RATE  
Unit: Percent  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy  
UI name: [Agent answer rate](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-answer-rate)   
AGENT\$1NON\$1ADHERENT\$1TIME  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy  
UI name: [Non-adherent time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#non-adherent-time)   
AGENT\$1NON\$1RESPONSE  
Unit: Count  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy   
UI name: [Agent non-response](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response)   
AGENT\$1NON\$1RESPONSE\$1WITHOUT\$1CUSTOMER\$1ABANDONS  
Unit: Count  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy  
Data for this metric is available starting from October 1, 2023 0:00:00 GMT.  
UI name: [Agent non-response without customer abandons](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response-without-customer-abandons)   
AGENT\$1OCCUPANCY  
Unit: Percentage  
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy   
UI name: [Occupancy](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#occupancy)   
AGENT\$1SCHEDULE\$1ADHERENCE  
This metric is available only in AWS Regions where [Forecasting, capacity planning, and scheduling](https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region) is available.  
Unit: Percent  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy  
UI name: [Adherence](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#adherence)   
AGENT\$1SCHEDULED\$1TIME  
This metric is available only in AWS Regions where [Forecasting, capacity planning, and scheduling](https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region) is available.  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy  
UI name: [Scheduled time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#scheduled-time)   
AVG\$1ABANDON\$1TIME  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect  
Valid metric filter key: `INITIATION_METHOD`   
UI name: [Average queue abandon time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time)   
AVG\$1ACTIVE\$1TIME  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect  
UI name: [Average active time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-active-time)   
AVG\$1AFTER\$1CONTACT\$1WORK\$1TIME  
Unit: Seconds  
Valid metric filter key: `INITIATION_METHOD`   
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Average after contact work time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time)   
Feature is a valid filter but not a valid grouping.  
AVG\$1AGENT\$1CONCURRENCY  
Unit: Count  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect  
UI name: [Average agent concurrency](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-concurrency)   
AVG\$1AGENT\$1CONNECTING\$1TIME  
Unit: Seconds  
Valid metric filter key: `INITIATION_METHOD`. For now, this metric only supports the following as `INITIATION_METHOD`: `INBOUND` \$1 `OUTBOUND` \$1 `CALLBACK` \$1 `API`   
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy  
UI name: [Average agent API connecting time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-api-connecting-time)   
The `Negate` key in metric-level filters is not applicable for this metric.  
AVG\$1AGENT\$1PAUSE\$1TIME  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect  
UI name: [Average agent pause time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-pause-time)   
AVG\$1BOT\$1CONVERSATION\$1TIME  
Unit: Seconds  
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID  
UI name: [Average bot conversation time](https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#average-bot-conversation-time)   
AVG\$1BOT\$1CONVERSATION\$1TURNS  
Unit: Count  
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID  
UI name: [Average bot conversation turns](https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#average-bot-conversation-turns)   
AVG\$1CASE\$1RELATED\$1CONTACTS  
Unit: Count  
Required filter key: CASE\$1TEMPLATE\$1ARN  
Valid groupings and filters: CASE\$1TEMPLATE\$1ARN, CASE\$1STATUS  
UI name: [Average contacts per case](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-contacts-per-case)   
AVG\$1CASE\$1RESOLUTION\$1TIME  
Unit: Seconds  
Required filter key: CASE\$1TEMPLATE\$1ARN  
Valid groupings and filters: CASE\$1TEMPLATE\$1ARN, CASE\$1STATUS  
UI name: [Average case resolution time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-case-resolution-time)   
AVG\$1CONTACT\$1DURATION  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Average contact duration](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-contact-duration)   
Feature is a valid filter but not a valid grouping.  
AVG\$1CONTACT\$1FIRST\$1RESPONSE\$1TIME\$1AGENT  
Unit: Seconds  
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect  
UI name: [Agent average contact first response wait time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-average-contact-first-response-wait-time)   
AVG\$1CONVERSATION\$1CLOSE\$1TIME  
Unit: Seconds  
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect  
UI name: [Average conversation close time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-conversation-close-time)   
AVG\$1CONVERSATION\$1DURATION  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Average conversation duration](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-conversation-duration)   
AVG\$1DIALS\$1PER\$1MINUTE  
This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.  
Unit: Count  
Valid groupings and filters: Agent, Campaign, Queue, Routing Profile  
UI name: [Average dials per minute](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-dials-per-minute)   
AVG\$1EVALUATION\$1SCORE  
Unit: Percent  
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile  
UI name: [Average evaluation score](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-evaluation-score)   
AVG\$1FIRST\$1RESPONSE\$1TIME\$1AGENT  
Unit: Seconds  
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect  
UI name: [Average agent first response time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-first-response-time)   
AVG\$1FLOW\$1TIME  
Unit: Seconds  
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp  
UI name: [Average flow time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-flow-time)   
AVG\$1GREETING\$1TIME\$1AGENT  
This metric is available only for contacts analyzed by Contact Lens conversational analytics.  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Average agent greeting time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-greeting-time)   
AVG\$1HANDLE\$1TIME  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression  
UI name: [Average handle time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-handle-time)   
Feature is a valid filter but not a valid grouping.  
ACTIVE\$1AI\$1AGENTS  
Unit: Count  
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile  
UI name: [Active AI Agents](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#active-ai-agents)   
AI\$1HANDOFF\$1RATE  
Unit: Percent  
Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile  
UI name: [AI Handoff Rate](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-handoff-rate)   
AI\$1HANDOFFS  
Unit: Count  
Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile  
UI name: [AI Handoffs](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-handoffs)   
AI\$1AGENT\$1INVOCATION\$1SUCCESS  
Unit: Count  
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile  
UI name: [AI Agent Invocation Success](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-agent-invocation-success)   
AI Agent Name Version is not a valid filter but a valid grouping.  
AI\$1AGENT\$1INVOCATION\$1SUCCESS\$1RATE  
Unit: Percent  
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile  
UI name: [AI Agent Invocation Success Rate](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-agent-invocation-success-rate)   
AI Agent Name Version is not a valid filter but a valid grouping.  
AI\$1AGENT\$1INVOCATIONS  
Unit: Count  
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Type, AI Agent Name Version, AI Use Case, Channel, Queue, Routing Profile  
UI name: [AI Agent Invocations](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-agent-invocations)   
AI Agent Name Version is not a valid filter but a valid grouping.  
AI\$1RESPONSE\$1COMPLETION\$1RATE  
Unit: Percent  
Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile  
UI name: [AI Response Completion Rate](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-response-completion-rate)   
AI\$1INVOLVED\$1CONTACTS  
Unit: Count  
Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile  
UI name: [AI Involved Contacts](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-involved-contacts)   
AI\$1PROMPT\$1INVOCATION\$1SUCCESS  
Unit: Count  
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Prompt, AI Prompt ID, AI Prompt Name, AI Prompt Type, AI Use Case, Channel, Queue, Routing Profile  
UI name: [AI Prompt Invocation Success](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-prompt-invocation-success)   
AI Agent Name Version is not a valid filter but a valid grouping.  
AI\$1PROMPT\$1INVOCATION\$1SUCCESS\$1RATE  
Unit: Percent  
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Prompt, AI Prompt ID, AI Prompt Name, AI Prompt Type, AI Use Case, Channel, Queue, Routing Profile  
UI name: [AI Prompt Invocation Success Rate](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-prompt-invocation-success-rate)   
AI Agent Name Version is not a valid filter but a valid grouping.  
AI\$1PROMPT\$1INVOCATIONS  
Unit: Count  
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Prompt, AI Prompt ID, AI Prompt Name, AI Prompt Type, AI Use Case, Channel, Queue, Routing Profile  
UI name: [AI Prompt Invocations](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-prompt-invocations)   
AI Agent Name Version is not a valid filter but a valid grouping.  
AI\$1TOOL\$1INVOCATION\$1SUCCESS  
Unit: Count  
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Tool ID, AI Tool Name, AI Tool Type, AI Use Case, Channel, Queue, Routing Profile  
UI name: [AI Tool Invocation Success](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-tool-invocation-success)   
AI Agent Name Version is not a valid filter but a valid grouping.  
AI\$1TOOL\$1INVOCATION\$1SUCCESS\$1RATE  
Unit: Percent  
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Tool ID, AI Tool Name, AI Tool Type, AI Use Case, Channel, Queue, Routing Profile  
UI name: [AI Tool Invocation Success Rate](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-tool-invocation-success-rate)   
AI Agent Name Version is not a valid filter but a valid grouping.  
AI\$1TOOL\$1INVOCATIONS  
Unit: Count  
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Tool ID, AI Tool Name, AI Tool Type, AI Use Case, Channel, Queue, Routing Profile  
UI name: [AI Tool Invocations](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#ai-tool-invocations)   
AI Agent Name Version is not a valid filter but a valid grouping.  
AVG\$1AI\$1AGENT\$1CONVERSATION\$1TURNS  
Unit: Count  
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Use Case, Channel, Queue, Routing Profile   
UI name: [Average AI Agent Conversation Turns](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-ai-agent-conversation-turns)   
AI Agent Name Version is not a valid filter but a valid grouping.  
AVG\$1AI\$1CONVERSATION\$1TURNS  
Unit: Count  
Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile  
UI name: [Average AI Conversation Turns](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-ai-conversation-turns)   
AVG\$1AI\$1PROMPT\$1INVOCATION\$1LATENCY  
Unit: Milliseconds  
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Prompt, AI Prompt ID, AI Prompt Name, AI Prompt Type, AI Use Case, Channel, Queue, Routing Profile  
UI name: [Average AI Prompt Invocation Latency](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-ai-prompt-invocation-latency)   
AI Agent Name Version is not a valid filter but a valid grouping.  
AVG\$1AI\$1TOOL\$1INVOCATION\$1LATENCY  
Unit: Milliseconds  
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Name Version, AI Agent Type, AI Tool ID, AI Tool Name, AI Tool Type, AI Use Case, Channel, Queue, Routing Profile  
UI name: [Average AI Tool Invocation Latency](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-ai-tool-invocation-latency)   
AI Agent Name Version is not a valid filter but a valid grouping.  
KNOWLEDGE\$1CONTENT\$1REFERENCES  
Unit: Count  
Valid groupings and filters: AI Agent, AI Agent Name, AI Agent Type, AI Use Case, Channel, Knowledge Base Name, Queue, Routing Profile  
UI name: [Knowledge Content References](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#knowledge-content-references)   
PROACTIVE\$1INTENT\$1ENGAGEMENT\$1RATE  
Unit: Percent  
Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile  
UI name: [Proactive Intent Engagement Rate](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#proactive-intents-engagement-rate)   
PROACTIVE\$1INTENT\$1RESPONSE\$1RATE  
Unit: Percent  
Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile   
UI name: [Proactive Intent Response Rate](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#proactive-intents-response-rate)   
PROACTIVE\$1INTENTS\$1ANSWERED  
Unit: Count  
Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile  
UI name: [Proactive Intents Answered](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#proactive-intents-answered)   
PROACTIVE\$1INTENTS\$1DETECTED  
Unit: Count  
Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile  
UI name: [Proactive Intents Detected](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#proactive-intents-detected)   
PROACTIVE\$1INTENTS\$1ENGAGED  
Unit: Count  
Valid groupings and filters: AI Use Case, Channel, Queue, Routing Profile  
UI name: [Proactive Intents Engaged](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#proactive-intents-engaged)   
AVG\$1HOLD\$1TIME  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Average customer hold time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time)   
Feature is a valid filter but not a valid grouping.  
AVG\$1HOLD\$1TIME\$1ALL\$1CONTACTS  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Average customer hold time all contacts](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time-all-contacts)   
AVG\$1HOLDS  
Unit: Count  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Average holds](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-holds)   
Feature is a valid filter but not a valid grouping.  
AVG\$1INTERACTION\$1AND\$1HOLD\$1TIME  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Average agent interaction and customer hold time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interaction-and-customer-hold-time)   
AVG\$1INTERACTION\$1TIME  
Unit: Seconds  
Valid metric filter key: `INITIATION_METHOD`   
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Average agent interaction time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interaction-time)   
Feature is a valid filter but not a valid grouping.  
AVG\$1INTERRUPTIONS\$1AGENT  
This metric is available only for contacts analyzed by Contact Lens conversational analytics.  
Unit: Count  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Average agent interruptions](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interruptions)   
AVG\$1INTERRUPTION\$1TIME\$1AGENT  
This metric is available only for contacts analyzed by Contact Lens conversational analytics.  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Average agent interruption time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interruption-time)   
AVG\$1MESSAGE\$1LENGTH\$1AGENT  
Unit: Count  
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect  
UI name: [Average agent message length](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-message-length)   
AVG\$1MESSAGE\$1LENGTH\$1CUSTOMER  
Unit: Count  
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect  
UI name: [Average customer message length](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-message-length)   
AVG\$1MESSAGES  
Unit: Count  
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect  
UI name: [Average messages](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-messages)   
AVG\$1MESSAGES\$1AGENT  
Unit: Count  
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect  
UI name: [Average agent messages](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-messages)   
AVG\$1MESSAGES\$1BOT  
Unit: Count  
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect  
UI name: [Average bot messages](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-bot-messages)   
AVG\$1MESSAGES\$1CUSTOMER  
Unit: Count  
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect  
UI name: [Average customer messages](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-messages)   
AVG\$1NON\$1TALK\$1TIME  
This metric is available only for contacts analyzed by Contact Lens conversational analytics.  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Average non-talk time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-non-talk-time)   
AVG\$1QUEUE\$1ANSWER\$1TIME  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Average queue answer time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-answer-time)   
Valid metric level filters: `INITIATION_METHOD`, `FEATURE`, `DISCONNECT_REASON`   
Feature is a valid filter but not a valid grouping.  
AVG\$1QUEUE\$1ANSWER\$1TIME\$1CUSTOMER\$1FIRST\$1CALLBACK  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect, Agent Hierarchy  
UI name: [Avg. queue answer time - customer first callback](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-answer-time-customer-first-callback)   
AVG\$1RESPONSE\$1TIME\$1AGENT  
Unit: Seconds  
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect  
UI name: [Average agent response time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-response-time-agent)   
AVG\$1RESPONSE\$1TIME\$1CUSTOMER  
Unit: Seconds  
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect  
UI name: [Average customer response time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-time-agent)   
AVG\$1RESOLUTION\$1TIME  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Average resolution time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-resolution-time)   
AVG\$1TALK\$1TIME  
This metric is available only for contacts analyzed by Contact Lens conversational analytics.  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Average talk time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-talk-time)   
AVG\$1TALK\$1TIME\$1AGENT  
This metric is available only for contacts analyzed by Contact Lens conversational analytics.  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Average agent talk time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-talk-time)   
AVG\$1TALK\$1TIME\$1CUSTOMER  
This metric is available only for contacts analyzed by Contact Lens conversational analytics.  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Average customer talk time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-talk-time)   
AVG\$1WAIT\$1TIME\$1AFTER\$1CUSTOMER\$1CONNECTION  
This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.  
Unit: Seconds  
Valid groupings and filters: Campaign  
UI name: [Average wait time after customer connection](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-wait-time-after-customer-connection)   
AVG\$1WAIT\$1TIME\$1AFTER\$1CUSTOMER\$1FIRST\$1CALLBACK\$1CONNECTION  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect, Agent Hierarchy  
UI name: [Avg. wait time after customer connection - customer first callback](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-wait-time-after-customer-connection-customer-first-callback)   
AVG\$1WEIGHTED\$1EVALUATION\$1SCORE  
Unit: Percent  
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID, Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile  
UI name: [Average weighted evaluation score](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-weighted-evaluation-score)   
BOT\$1CONVERSATIONS\$1COMPLETED  
Unit: Count  
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID  
UI name: [Bot conversations completed](https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-conversations-completed)   
BOT\$1INTENTS\$1COMPLETED  
Unit: Count  
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID  
UI name: [Bot intents completed](https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-intents-completed)   
CAMPAIGN\$1CONTACTS\$1ABANDONED\$1AFTER\$1X  
This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.  
Unit: Count  
Valid groupings and filters: Agent, Campaign  
Threshold: For `ThresholdValue`, enter any whole number from 1 to 604800 (inclusive), in seconds. For `Comparison`, you must enter `GT` (for *Greater than*).  
UI name: [Campaign contacts abandoned after X](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-contacts-abandoned-after-x)   
CAMPAIGN\$1CONTACTS\$1ABANDONED\$1AFTER\$1X\$1RATE  
This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.  
Unit: Percent  
Valid groupings and filters: Agent, Campaign  
Threshold: For `ThresholdValue`, enter any whole number from 1 to 604800 (inclusive), in seconds. For `Comparison`, you must enter `GT` (for *Greater than*).  
UI name: [Campaign contacts abandoned after X rate](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-contacts-abandoned-after-x-rate)   
CAMPAIGN\$1INTERACTIONS  
This metric is available only for outbound campaigns using the email delivery mode.   
Unit: Count  
Valid metric filter key: CAMPAIGN\$1INTERACTION\$1EVENT\$1TYPE  
Valid groupings and filters: Campaign  
UI name: [Campaign interactions](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-interactions)   
CAMPAIGN\$1PROGRESS\$1RATE  
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.  
Unit: Percent  
Valid groupings and filters: Campaign, Campaign Execution Timestamp  
UI name: [Campaign progress rate](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-progress-rate)   
CAMPAIGN\$1SEND\$1ATTEMPTS  
This metric is available only for outbound campaigns.  
Unit: Count  
Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype   
UI name: [Campaign send attempts](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-send-attempts)   
CAMPAIGN\$1SEND\$1EXCLUSIONS  
This metric is available only for outbound campaigns.  
Valid metric filter key: CAMPAIGN\$1EXCLUDED\$1EVENT\$1TYPE  
Unit: Count  
Valid groupings and filters: Campaign, Campaign Excluded Event Type, Campaign Execution Timestamp  
UI name: [Campaign send exclusions](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-send-exclusions)   
CASES\$1CREATED  
Unit: Count  
Required filter key: CASE\$1TEMPLATE\$1ARN  
Valid groupings and filters: CASE\$1TEMPLATE\$1ARN, CASE\$1STATUS  
UI name: [Cases created](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#cases-created)   
CONTACTS\$1CREATED  
Unit: Count  
Valid metric filter key: `INITIATION_METHOD`   
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Contacts created](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-created)   
Feature is a valid filter but not a valid grouping.  
CONTACTS\$1HANDLED  
Unit: Count  
Valid metric filter key: `INITIATION_METHOD`, `DISCONNECT_REASON`   
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect  
UI name: [Contacts handled](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled)   
Feature is a valid filter but not a valid grouping.  
CONTACTS\$1HANDLED\$1BY\$1CONNECTED\$1TO\$1AGENT  
Unit: Count  
Valid metric filter key: `INITIATION_METHOD`   
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Contacts handled (connected to agent timestamp)](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-by-connected-to-agent-timestamp)   
CONTACTS\$1HOLD\$1ABANDONS  
Unit: Count  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Contacts hold disconnect](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-disconnect)   
CONTACTS\$1ON\$1HOLD\$1AGENT\$1DISCONNECT  
Unit: Count  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect  
UI name: [Contacts hold agent disconnect](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-agent-disconnect)   
CONTACTS\$1ON\$1HOLD\$1CUSTOMER\$1DISCONNECT  
Unit: Count  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect  
UI name: [Contacts hold customer disconnect](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-customer-disconnect)   
CONTACTS\$1PUT\$1ON\$1HOLD  
Unit: Count  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect  
UI name: [Contacts put on hold](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-put-on-hold)   
CONTACTS\$1TRANSFERRED\$1OUT\$1EXTERNAL  
Unit: Count  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect  
UI name: [Contacts transferred out external](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-external)   
CONTACTS\$1TRANSFERRED\$1OUT\$1INTERNAL  
Unit: Percent  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect  
UI name: [Contacts transferred out internal](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-internal)   
CONTACTS\$1QUEUED  
Unit: Count  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Contacts queued](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued)   
CONTACTS\$1QUEUED\$1BY\$1ENQUEUE  
Unit: Count  
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype  
UI name: [Contacts queued (enqueue timestamp)](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued-by-enqueue)   
CONTACTS\$1REMOVED\$1FROM\$1QUEUE\$1IN\$1X  
Unit: Count  
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect  
Threshold: For `ThresholdValue`, enter any whole number from 1 to 604800 (inclusive), in seconds. For `Comparison`, you can use `LT` (for "Less than") or `LTE` (for "Less than equal").  
UI name: [Contacts removed from queue in X seconds](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-removed-from-queue)   
CONTACTS\$1RESOLVED\$1IN\$1X  
Unit: Count  
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect  
Threshold: For `ThresholdValue`, enter any whole number from 1 to 604800 (inclusive), in seconds. For `Comparison`, you can use `LT` (for "Less than") or `LTE` (for "Less than equal").  
UI name: [Contacts resolved in X](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-resolved)   
CONTACTS\$1TRANSFERRED\$1OUT  
Unit: Count  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Contacts transferred out](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out)   
Feature is a valid filter but not a valid grouping.  
CONTACTS\$1TRANSFERRED\$1OUT\$1BY\$1AGENT  
Unit: Count  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Contacts transferred out by agent](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-by-agent)   
CONTACTS\$1TRANSFERRED\$1OUT\$1FROM\$1QUEUE  
Unit: Count  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Contacts transferred out queue](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue)   
CURRENT\$1CASES  
Unit: Count  
Required filter key: CASE\$1TEMPLATE\$1ARN  
Valid groupings and filters: CASE\$1TEMPLATE\$1ARN, CASE\$1STATUS  
UI name: [Current cases](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#current-cases)   
CONVERSATIONS\$1ABANDONED  
Unit: Count  
Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue, Q in Connect  
UI name: [Conversations abandoned](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#conversations-abandoned)   
DELIVERY\$1ATTEMPTS  
This metric is available only for outbound campaigns.  
Unit: Count  
Valid metric filter key: `ANSWERING_MACHINE_DETECTION_STATUS`, `CAMPAIGN_DELIVERY_EVENT_TYPE`, `DISCONNECT_REASON`   
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile  
UI name: [Delivery attempts](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#delivery-attempts)   
Campaign Delivery EventType filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.   
DELIVERY\$1ATTEMPT\$1DISPOSITION\$1RATE  
This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.  
Unit: Percent  
Valid metric filter key: `ANSWERING_MACHINE_DETECTION_STATUS`, `CAMPAIGN_DELIVERY_EVENT_TYPE`, `DISCONNECT_REASON`   
Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile  
UI name: [Delivery attempt disposition rate](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#delivery-attempt-disposition-rate)   
Campaign Delivery Event Type filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes.   
EVALUATIONS\$1PERFORMED  
Unit: Count  
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile  
UI name: [Evaluations performed](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#evaluations-performed)   
FLOWS\$1OUTCOME  
Unit: Count  
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp  
UI name: [Flows outcome](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#flows-outcome)   
FLOWS\$1STARTED  
Unit: Count  
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp  
UI name: [Flows started](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#flows-started)   
HUMAN\$1ANSWERED\$1CALLS  
This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.   
Unit: Count  
Valid groupings and filters: Agent, Campaign  
UI name: [Human answered](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#human-answered)   
MAX\$1FLOW\$1TIME  
Unit: Seconds  
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp  
UI name: [Maximum flow time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#maximum-flow-time)   
MAX\$1QUEUED\$1TIME  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Maximum queued time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#maximum-queued-time)   
MIN\$1FLOW\$1TIME  
Unit: Seconds  
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp  
UI name: [Minimum flow time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#minimum-flow-time)   
PERCENT\$1AUTOMATIC\$1FAILS  
Unit: Percent  
Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing Profile  
UI name: [Automatic fails percent](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#automatic-fails-percent)   
PERCENT\$1BOT\$1CONVERSATIONS\$1OUTCOME  
Unit: Percent  
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID  
UI name: [Percent bot conversations outcome](https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#percent-bot-conversations-outcome)   
PERCENT\$1BOT\$1INTENTS\$1OUTCOME  
Unit: Percent  
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID  
UI name: [Percent bot intents outcome](https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#percent-bot-intents-outcome)   
PERCENT\$1CASES\$1FIRST\$1CONTACT\$1RESOLVED  
Unit: Percent  
Required filter key: CASE\$1TEMPLATE\$1ARN  
Valid groupings and filters: CASE\$1TEMPLATE\$1ARN, CASE\$1STATUS  
UI name: [Cases resolved on first contact](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#cases-resolved-on-first-contact)   
PERCENT\$1CONTACTS\$1STEP\$1EXPIRED  
Unit: Percent  
Valid groupings and filters: Queue, RoutingStepExpression  
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.  
PERCENT\$1CONTACTS\$1STEP\$1JOINED  
Unit: Percent  
Valid groupings and filters: Queue, RoutingStepExpression  
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.  
PERCENT\$1FLOWS\$1OUTCOME  
Unit: Percent  
Valid metric filter key: `FLOWS_OUTCOME_TYPE`   
Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp  
UI name: [Flows outcome percentage](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#flows-outcome-percentage).  
The `FLOWS_OUTCOME_TYPE` is not a valid grouping.  
PERCENT\$1NON\$1TALK\$1TIME  
This metric is available only for contacts analyzed by Contact Lens conversational analytics.  
Unit: Percentage  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Non-talk time percent](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#non-talk-time-percent)   
PERCENT\$1TALK\$1TIME  
This metric is available only for contacts analyzed by Contact Lens conversational analytics.  
Unit: Percentage  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Talk time percent](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#talk-time-percent)   
PERCENT\$1TALK\$1TIME\$1AGENT  
This metric is available only for contacts analyzed by Contact Lens conversational analytics.  
Unit: Percentage  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Agent talk time percent](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-talk-time-percent)   
PERCENT\$1TALK\$1TIME\$1CUSTOMER  
This metric is available only for contacts analyzed by Contact Lens conversational analytics.  
Unit: Percentage  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Customer talk time percent](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#customer-talk-time-percent)   
RECIPIENTS\$1ATTEMPTED  
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.  
Unit: Count  
Valid groupings and filters: Campaign, Campaign Execution Timestamp  
UI name: [Recipients attempted](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#recipients-attempted)   
RECIPIENTS\$1INTERACTED  
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.  
Valid metric filter key: CAMPAIGN\$1INTERACTION\$1EVENT\$1TYPE  
Unit: Count  
Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype, Campaign Execution Timestamp  
UI name: [Recipients interacted](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#recipients-interacted)   
RECIPIENTS\$1TARGETED  
This metric is only available for outbound campaigns initiated using a customer segment. It is not available for event triggered campaigns.  
Unit: Count  
Valid groupings and filters: Campaign, Campaign Execution Timestamp  
UI name: [Recipients targeted](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#recipients-targeted)   
REOPENED\$1CASE\$1ACTIONS  
Unit: Count  
Required filter key: CASE\$1TEMPLATE\$1ARN  
Valid groupings and filters: CASE\$1TEMPLATE\$1ARN, CASE\$1STATUS  
UI name: [Cases reopened](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#cases-reopened)   
RESOLVED\$1CASE\$1ACTIONS  
Unit: Count  
Required filter key: CASE\$1TEMPLATE\$1ARN  
Valid groupings and filters: CASE\$1TEMPLATE\$1ARN, CASE\$1STATUS  
UI name: [Cases resolved](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#cases-resolved)   
SERVICE\$1LEVEL  
You can include up to 20 SERVICE\$1LEVEL metrics in a request.  
Unit: Percent  
Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect  
Threshold: For `ThresholdValue`, enter any whole number from 1 to 604800 (inclusive), in seconds. For `Comparison`, you can use `LT` (for "Less than") or `LTE` (for "Less than equal").  
UI name: [Service level X](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#service-level)   
STEP\$1CONTACTS\$1QUEUED  
Unit: Count  
Valid groupings and filters: Queue, RoutingStepExpression  
UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.  
SUM\$1AFTER\$1CONTACT\$1WORK\$1TIME  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect  
UI name: [After contact work time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time)   
SUM\$1CONNECTING\$1TIME\$1AGENT  
Unit: Seconds  
Valid metric filter key: `INITIATION_METHOD`. This metric only supports the following filter keys as `INITIATION_METHOD`: `INBOUND` \$1 `OUTBOUND` \$1 `CALLBACK` \$1 `API` \$1 `CALLBACK_CUSTOMER_FIRST_DIALED`   
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy  
UI name: [Agent API connecting time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-api-connecting-time)   
The `Negate` key in metric-level filters is not applicable for this metric.  
CONTACTS\$1ABANDONED  
Unit: Count  
Metric filter:   
+ Valid values: `API`\$1 `INCOMING` \$1 `OUTBOUND` \$1 `TRANSFER` \$1 `CALLBACK` \$1 `QUEUE_TRANSFER`\$1 `Disconnect` \$1 `CALLBACK_CUSTOMER_FIRST_DIALED` 
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect  
UI name: [Contact abandoned](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned)   
SUM\$1CONTACTS\$1ABANDONED\$1IN\$1X  
Unit: Count  
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect  
Threshold: For `ThresholdValue`, enter any whole number from 1 to 604800 (inclusive), in seconds. For `Comparison`, you can use `LT` (for "Less than") or `LTE` (for "Less than equal").  
UI name: [Contacts abandoned in X seconds](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned-in-x-seconds)   
SUM\$1CONTACTS\$1ANSWERED\$1IN\$1X  
Unit: Count  
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect  
Threshold: For `ThresholdValue`, enter any whole number from 1 to 604800 (inclusive), in seconds. For `Comparison`, you can use `LT` (for "Less than") or `LTE` (for "Less than equal").  
UI name: [Contacts answered in X seconds](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-answered-in-x-seconds)   
SUM\$1CONTACT\$1FLOW\$1TIME  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect  
UI name: [Contact flow time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contact-flow-time)   
SUM\$1CONTACT\$1TIME\$1AGENT  
Unit: Seconds  
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy  
UI name: [Agent on contact time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-on-contact-time)   
SUM\$1CONTACTS\$1DISCONNECTED   
Valid metric filter key: `DISCONNECT_REASON`   
Unit: Count  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Contact disconnected](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contact-disconnected)   
SUM\$1ERROR\$1STATUS\$1TIME\$1AGENT  
Unit: Seconds  
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy  
UI name: [Error status time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#error-status-time)   
SUM\$1HANDLE\$1TIME  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect  
UI name: [Contact handle time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contact-handle-time)   
SUM\$1HOLD\$1TIME  
Unit: Count  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect  
UI name: [Customer hold time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#customer-hold-time)   
SUM\$1IDLE\$1TIME\$1AGENT  
Unit: Seconds  
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy  
UI name: [Agent idle time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-idle-time)   
SUM\$1INTERACTION\$1AND\$1HOLD\$1TIME  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect  
UI name: [Agent interaction and hold time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-interaction-and-hold-time)   
SUM\$1INTERACTION\$1TIME  
Unit: Seconds  
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy  
UI name: [Agent interaction time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-interaction-time)   
SUM\$1NON\$1PRODUCTIVE\$1TIME\$1AGENT  
Unit: Seconds  
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy  
UI name: [Agent non-productive time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-productive-time)   
SUM\$1ONLINE\$1TIME\$1AGENT  
Unit: Seconds  
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy  
UI name: [Online time](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#online-time)   
SUM\$1RETRY\$1CALLBACK\$1ATTEMPTS  
Unit: Count  
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect  
UI name: [Callback attempts](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#callback-attempts) 
Type: Array of [MetricV2](API_MetricV2.md) objects  
Required: Yes

 ** [NextToken](#API_GetMetricDataV2_RequestSyntax) **   <a name="connect-GetMetricDataV2-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

 ** [ResourceArn](#API_GetMetricDataV2_RequestSyntax) **   <a name="connect-GetMetricDataV2-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the resource. This includes the `instanceId` an Amazon Connect instance.  
Type: String  
Required: Yes

 ** [StartTime](#API_GetMetricDataV2_RequestSyntax) **   <a name="connect-GetMetricDataV2-request-StartTime"></a>
The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be before the end time timestamp. The start and end time depends on the `IntervalPeriod` selected. By default the time range between start and end time is 35 days. Historical metrics are available for 3 months.  
Type: Timestamp  
Required: Yes

## Response Syntax
<a name="API_GetMetricDataV2_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "MetricResults": [ 
      { 
         "Collections": [ 
            { 
               "Metric": { 
                  "MetricFilters": [ 
                     { 
                        "MetricFilterKey": "string",
                        "MetricFilterValues": [ "string" ],
                        "Negate": boolean
                     }
                  ],
                  "MetricId": "string",
                  "Name": "string",
                  "Threshold": [ 
                     { 
                        "Comparison": "string",
                        "ThresholdValue": number
                     }
                  ]
               },
               "Value": number
            }
         ],
         "Dimensions": { 
            "string" : "string" 
         },
         "MetricInterval": { 
            "EndTime": number,
            "Interval": "string",
            "StartTime": number
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_GetMetricDataV2_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [MetricResults](#API_GetMetricDataV2_ResponseSyntax) **   <a name="connect-GetMetricDataV2-response-MetricResults"></a>
Information about the metrics requested in the API request If no grouping is specified, a summary of metric data is returned.   
Type: Array of [MetricResultV2](API_MetricResultV2.md) objects

 ** [NextToken](#API_GetMetricDataV2_ResponseSyntax) **   <a name="connect-GetMetricDataV2-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.

## Errors
<a name="API_GetMetricDataV2_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_GetMetricDataV2_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/GetMetricDataV2) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/GetMetricDataV2) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/GetMetricDataV2) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/GetMetricDataV2) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/GetMetricDataV2) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/GetMetricDataV2) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/GetMetricDataV2) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/GetMetricDataV2) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/GetMetricDataV2) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/GetMetricDataV2) 

# GetPromptFile
<a name="API_GetPromptFile"></a>

Gets the prompt file.

## Request Syntax
<a name="API_GetPromptFile_RequestSyntax"></a>

```
GET /prompts/InstanceId/PromptId/file HTTP/1.1
```

## URI Request Parameters
<a name="API_GetPromptFile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_GetPromptFile_RequestSyntax) **   <a name="connect-GetPromptFile-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [PromptId](#API_GetPromptFile_RequestSyntax) **   <a name="connect-GetPromptFile-request-uri-PromptId"></a>
A unique identifier for the prompt.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_GetPromptFile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetPromptFile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "LastModifiedRegion": "string",
   "LastModifiedTime": number,
   "PromptPresignedUrl": "string"
}
```

## Response Elements
<a name="API_GetPromptFile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LastModifiedRegion](#API_GetPromptFile_ResponseSyntax) **   <a name="connect-GetPromptFile-response-LastModifiedRegion"></a>
The AWS Region where this resource was last modified.  
Type: String  
Pattern: `[a-z]{2}(-[a-z]+){1,2}(-[0-9])?` 

 ** [LastModifiedTime](#API_GetPromptFile_ResponseSyntax) **   <a name="connect-GetPromptFile-response-LastModifiedTime"></a>
The timestamp when this resource was last modified.  
Type: Timestamp

 ** [PromptPresignedUrl](#API_GetPromptFile_ResponseSyntax) **   <a name="connect-GetPromptFile-response-PromptPresignedUrl"></a>
A generated URL to the prompt that can be given to an unauthorized user so they can access the prompt in S3.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.

## Errors
<a name="API_GetPromptFile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_GetPromptFile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/GetPromptFile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/GetPromptFile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/GetPromptFile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/GetPromptFile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/GetPromptFile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/GetPromptFile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/GetPromptFile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/GetPromptFile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/GetPromptFile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/GetPromptFile) 

# GetTaskTemplate
<a name="API_GetTaskTemplate"></a>

Gets details about a specific task template in the specified Amazon Connect instance.

## Request Syntax
<a name="API_GetTaskTemplate_RequestSyntax"></a>

```
GET /instance/InstanceId/task/template/TaskTemplateId?snapshotVersion=SnapshotVersion HTTP/1.1
```

## URI Request Parameters
<a name="API_GetTaskTemplate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_GetTaskTemplate_RequestSyntax) **   <a name="connect-GetTaskTemplate-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [SnapshotVersion](#API_GetTaskTemplate_RequestSyntax) **   <a name="connect-GetTaskTemplate-request-uri-SnapshotVersion"></a>
The system generated version of a task template that is associated with a task, when the task is created.

 ** [TaskTemplateId](#API_GetTaskTemplate_RequestSyntax) **   <a name="connect-GetTaskTemplate-request-uri-TaskTemplateId"></a>
A unique identifier for the task template.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_GetTaskTemplate_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetTaskTemplate_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Constraints": { 
      "InvisibleFields": [ 
         { 
            "Id": { 
               "Name": "string"
            }
         }
      ],
      "ReadOnlyFields": [ 
         { 
            "Id": { 
               "Name": "string"
            }
         }
      ],
      "RequiredFields": [ 
         { 
            "Id": { 
               "Name": "string"
            }
         }
      ]
   },
   "ContactFlowId": "string",
   "CreatedTime": number,
   "Defaults": { 
      "DefaultFieldValues": [ 
         { 
            "DefaultValue": "string",
            "Id": { 
               "Name": "string"
            }
         }
      ]
   },
   "Description": "string",
   "Fields": [ 
      { 
         "Description": "string",
         "Id": { 
            "Name": "string"
         },
         "SingleSelectOptions": [ "string" ],
         "Type": "string"
      }
   ],
   "Id": "string",
   "InstanceId": "string",
   "LastModifiedTime": number,
   "Name": "string",
   "SelfAssignFlowId": "string",
   "Status": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_GetTaskTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_GetTaskTemplate_ResponseSyntax) **   <a name="connect-GetTaskTemplate-response-Arn"></a>
The Amazon Resource Name (ARN).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [Constraints](#API_GetTaskTemplate_ResponseSyntax) **   <a name="connect-GetTaskTemplate-response-Constraints"></a>
Constraints that are applicable to the fields listed.  
Type: [TaskTemplateConstraints](API_TaskTemplateConstraints.md) object

 ** [ContactFlowId](#API_GetTaskTemplate_ResponseSyntax) **   <a name="connect-GetTaskTemplate-response-ContactFlowId"></a>
The identifier of the flow that runs by default when a task is created by referencing this template.  
Type: String  
Length Constraints: Maximum length of 500.

 ** [CreatedTime](#API_GetTaskTemplate_ResponseSyntax) **   <a name="connect-GetTaskTemplate-response-CreatedTime"></a>
The timestamp when the task template was created.  
Type: Timestamp

 ** [Defaults](#API_GetTaskTemplate_ResponseSyntax) **   <a name="connect-GetTaskTemplate-response-Defaults"></a>
The default values for fields when a task is created by referencing this template.  
Type: [TaskTemplateDefaults](API_TaskTemplateDefaults.md) object

 ** [Description](#API_GetTaskTemplate_ResponseSyntax) **   <a name="connect-GetTaskTemplate-response-Description"></a>
The description of the task template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [Fields](#API_GetTaskTemplate_ResponseSyntax) **   <a name="connect-GetTaskTemplate-response-Fields"></a>
Fields that are part of the template.  
Type: Array of [TaskTemplateField](API_TaskTemplateField.md) objects

 ** [Id](#API_GetTaskTemplate_ResponseSyntax) **   <a name="connect-GetTaskTemplate-response-Id"></a>
A unique identifier for the task template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [InstanceId](#API_GetTaskTemplate_ResponseSyntax) **   <a name="connect-GetTaskTemplate-response-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** [LastModifiedTime](#API_GetTaskTemplate_ResponseSyntax) **   <a name="connect-GetTaskTemplate-response-LastModifiedTime"></a>
The timestamp when the task template was last modified.  
Type: Timestamp

 ** [Name](#API_GetTaskTemplate_ResponseSyntax) **   <a name="connect-GetTaskTemplate-response-Name"></a>
The name of the task template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** [SelfAssignFlowId](#API_GetTaskTemplate_ResponseSyntax) **   <a name="connect-GetTaskTemplate-response-SelfAssignFlowId"></a>
The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.  
Type: String  
Length Constraints: Maximum length of 500.

 ** [Status](#API_GetTaskTemplate_ResponseSyntax) **   <a name="connect-GetTaskTemplate-response-Status"></a>
Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to it. Tasks can only be created from `ACTIVE` templates. If a template is marked as `INACTIVE`, then a task that refers to this template cannot be created.  
Type: String  
Valid Values: `ACTIVE | INACTIVE` 

 ** [Tags](#API_GetTaskTemplate_ResponseSyntax) **   <a name="connect-GetTaskTemplate-response-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_GetTaskTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_GetTaskTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/GetTaskTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/GetTaskTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/GetTaskTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/GetTaskTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/GetTaskTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/GetTaskTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/GetTaskTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/GetTaskTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/GetTaskTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/GetTaskTemplate) 

# GetTestCaseExecutionSummary
<a name="API_GetTestCaseExecutionSummary"></a>

Retrieves an overview of a test execution that includes the status of the execution, start and end time, and observation summary.

## Request Syntax
<a name="API_GetTestCaseExecutionSummary_RequestSyntax"></a>

```
GET /test-cases/InstanceId/TestCaseId/TestCaseExecutionId/summary HTTP/1.1
```

## URI Request Parameters
<a name="API_GetTestCaseExecutionSummary_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_GetTestCaseExecutionSummary_RequestSyntax) **   <a name="connect-GetTestCaseExecutionSummary-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [TestCaseExecutionId](#API_GetTestCaseExecutionSummary_RequestSyntax) **   <a name="connect-GetTestCaseExecutionSummary-request-uri-TestCaseExecutionId"></a>
The identifier of the test case execution.  
Length Constraints: Maximum length of 500.  
Required: Yes

 ** [TestCaseId](#API_GetTestCaseExecutionSummary_RequestSyntax) **   <a name="connect-GetTestCaseExecutionSummary-request-uri-TestCaseId"></a>
The identifier of the test case.  
Length Constraints: Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_GetTestCaseExecutionSummary_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetTestCaseExecutionSummary_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EndTime": number,
   "ObservationSummary": { 
      "ObservationsFailed": number,
      "ObservationsPassed": number,
      "TotalObservations": number
   },
   "StartTime": number,
   "Status": "string"
}
```

## Response Elements
<a name="API_GetTestCaseExecutionSummary_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EndTime](#API_GetTestCaseExecutionSummary_ResponseSyntax) **   <a name="connect-GetTestCaseExecutionSummary-response-EndTime"></a>
The timestamp when the test case execution ended.  
Type: Timestamp

 ** [ObservationSummary](#API_GetTestCaseExecutionSummary_ResponseSyntax) **   <a name="connect-GetTestCaseExecutionSummary-response-ObservationSummary"></a>
Summary statistics for the test case execution.  
Type: [ObservationSummary](API_ObservationSummary.md) object

 ** [StartTime](#API_GetTestCaseExecutionSummary_ResponseSyntax) **   <a name="connect-GetTestCaseExecutionSummary-response-StartTime"></a>
The timestamp when the test case execution started.  
Type: Timestamp

 ** [Status](#API_GetTestCaseExecutionSummary_ResponseSyntax) **   <a name="connect-GetTestCaseExecutionSummary-response-Status"></a>
The status of the test case execution.  
Type: String  
Valid Values: `INITIATED | PASSED | FAILED | IN_PROGRESS | STOPPED` 

## Errors
<a name="API_GetTestCaseExecutionSummary_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_GetTestCaseExecutionSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/GetTestCaseExecutionSummary) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/GetTestCaseExecutionSummary) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/GetTestCaseExecutionSummary) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/GetTestCaseExecutionSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/GetTestCaseExecutionSummary) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/GetTestCaseExecutionSummary) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/GetTestCaseExecutionSummary) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/GetTestCaseExecutionSummary) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/GetTestCaseExecutionSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/GetTestCaseExecutionSummary) 

# GetTrafficDistribution
<a name="API_GetTrafficDistribution"></a>

Retrieves the current traffic distribution for a given traffic distribution group.

## Request Syntax
<a name="API_GetTrafficDistribution_RequestSyntax"></a>

```
GET /traffic-distribution/Id HTTP/1.1
```

## URI Request Parameters
<a name="API_GetTrafficDistribution_RequestParameters"></a>

The request uses the following URI parameters.

 ** [Id](#API_GetTrafficDistribution_RequestSyntax) **   <a name="connect-GetTrafficDistribution-request-uri-Id"></a>
The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z-]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

## Request Body
<a name="API_GetTrafficDistribution_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetTrafficDistribution_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AgentConfig": { 
      "Distributions": [ 
         { 
            "Percentage": number,
            "Region": "string"
         }
      ]
   },
   "Arn": "string",
   "Id": "string",
   "SignInConfig": { 
      "Distributions": [ 
         { 
            "Enabled": boolean,
            "Region": "string"
         }
      ]
   },
   "TelephonyConfig": { 
      "Distributions": [ 
         { 
            "Percentage": number,
            "Region": "string"
         }
      ]
   }
}
```

## Response Elements
<a name="API_GetTrafficDistribution_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AgentConfig](#API_GetTrafficDistribution_ResponseSyntax) **   <a name="connect-GetTrafficDistribution-response-AgentConfig"></a>
The distribution of agents between the instance and its replica(s).  
Type: [AgentConfig](API_AgentConfig.md) object

 ** [Arn](#API_GetTrafficDistribution_ResponseSyntax) **   <a name="connect-GetTrafficDistribution-response-Arn"></a>
The Amazon Resource Name (ARN) of the traffic distribution group.  
Type: String  
Pattern: `^arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` 

 ** [Id](#API_GetTrafficDistribution_ResponseSyntax) **   <a name="connect-GetTrafficDistribution-response-Id"></a>
The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.  
Type: String  
Pattern: `^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` 

 ** [SignInConfig](#API_GetTrafficDistribution_ResponseSyntax) **   <a name="connect-GetTrafficDistribution-response-SignInConfig"></a>
The distribution that determines which AWS Regions should be used to sign in agents in to both the instance and its replica(s).  
Type: [SignInConfig](API_SignInConfig.md) object

 ** [TelephonyConfig](#API_GetTrafficDistribution_ResponseSyntax) **   <a name="connect-GetTrafficDistribution-response-TelephonyConfig"></a>
The distribution of traffic between the instance and its replicas.  
Type: [TelephonyConfig](API_TelephonyConfig.md) object

## Errors
<a name="API_GetTrafficDistribution_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_GetTrafficDistribution_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/GetTrafficDistribution) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/GetTrafficDistribution) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/GetTrafficDistribution) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/GetTrafficDistribution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/GetTrafficDistribution) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/GetTrafficDistribution) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/GetTrafficDistribution) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/GetTrafficDistribution) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/GetTrafficDistribution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/GetTrafficDistribution) 

# ImportPhoneNumber
<a name="API_ImportPhoneNumber"></a>

Imports a claimed phone number from an external service, such as AWS End User Messaging, into an Amazon Connect instance. You can call this API only in the same AWS Region where the Amazon Connect instance was created.

**Important**  
Call the [DescribePhoneNumber](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html) API to verify the status of a previous `ImportPhoneNumber` operation. 

If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. 

 By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired. 

For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Support ticket. 

## Request Syntax
<a name="API_ImportPhoneNumber_RequestSyntax"></a>

```
POST /phone-number/import HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "InstanceId": "string",
   "PhoneNumberDescription": "string",
   "SourcePhoneNumberArn": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_ImportPhoneNumber_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ImportPhoneNumber_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_ImportPhoneNumber_RequestSyntax) **   <a name="connect-ImportPhoneNumber-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [InstanceId](#API_ImportPhoneNumber_RequestSyntax) **   <a name="connect-ImportPhoneNumber-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [PhoneNumberDescription](#API_ImportPhoneNumber_RequestSyntax) **   <a name="connect-ImportPhoneNumber-request-PhoneNumberDescription"></a>
The description of the phone number.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Pattern: `^[\W\S_]*`   
Required: No

 ** [SourcePhoneNumberArn](#API_ImportPhoneNumber_RequestSyntax) **   <a name="connect-ImportPhoneNumber-request-SourcePhoneNumberArn"></a>
The claimed phone number ARN being imported from the external service, such as AWS End User Messaging. If it is from AWS End User Messaging, it looks like the ARN of the phone number to import from AWS End User Messaging.  
Type: String  
Required: Yes

 ** [Tags](#API_ImportPhoneNumber_RequestSyntax) **   <a name="connect-ImportPhoneNumber-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_ImportPhoneNumber_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "PhoneNumberArn": "string",
   "PhoneNumberId": "string"
}
```

## Response Elements
<a name="API_ImportPhoneNumber_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PhoneNumberArn](#API_ImportPhoneNumber_ResponseSyntax) **   <a name="connect-ImportPhoneNumber-response-PhoneNumberArn"></a>
The Amazon Resource Name (ARN) of the phone number.  
Type: String

 ** [PhoneNumberId](#API_ImportPhoneNumber_ResponseSyntax) **   <a name="connect-ImportPhoneNumber-response-PhoneNumberId"></a>
A unique identifier for the phone number.  
Type: String

## Errors
<a name="API_ImportPhoneNumber_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** IdempotencyException **   
An entity with the same name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ImportPhoneNumber_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ImportPhoneNumber) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ImportPhoneNumber) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ImportPhoneNumber) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ImportPhoneNumber) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ImportPhoneNumber) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ImportPhoneNumber) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ImportPhoneNumber) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ImportPhoneNumber) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ImportPhoneNumber) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ImportPhoneNumber) 

# ImportWorkspaceMedia
<a name="API_ImportWorkspaceMedia"></a>

Imports a media asset (such as a logo) for use in a workspace.

## Request Syntax
<a name="API_ImportWorkspaceMedia_RequestSyntax"></a>

```
POST /workspaces/InstanceId/WorkspaceId/media HTTP/1.1
Content-type: application/json

{
   "MediaSource": "string",
   "MediaType": "string"
}
```

## URI Request Parameters
<a name="API_ImportWorkspaceMedia_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ImportWorkspaceMedia_RequestSyntax) **   <a name="connect-ImportWorkspaceMedia-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [WorkspaceId](#API_ImportWorkspaceMedia_RequestSyntax) **   <a name="connect-ImportWorkspaceMedia-request-uri-WorkspaceId"></a>
The identifier of the workspace.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_ImportWorkspaceMedia_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [MediaSource](#API_ImportWorkspaceMedia_RequestSyntax) **   <a name="connect-ImportWorkspaceMedia-request-MediaSource"></a>
The media source. Can be an S3 presigned URL or a base64-encoded string.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 533333.  
Pattern: `.*\\S.*`   
Required: Yes

 ** [MediaType](#API_ImportWorkspaceMedia_RequestSyntax) **   <a name="connect-ImportWorkspaceMedia-request-MediaType"></a>
The type of media. Valid values are: `IMAGE_LOGO_FAVICON` and `IMAGE_LOGO_HORIZONTAL`.  
Type: String  
Valid Values: `IMAGE_LOGO_LIGHT_FAVICON | IMAGE_LOGO_DARK_FAVICON | IMAGE_LOGO_LIGHT_HORIZONTAL | IMAGE_LOGO_DARK_HORIZONTAL`   
Required: Yes

## Response Syntax
<a name="API_ImportWorkspaceMedia_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_ImportWorkspaceMedia_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_ImportWorkspaceMedia_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ImportWorkspaceMedia_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ImportWorkspaceMedia) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ImportWorkspaceMedia) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ImportWorkspaceMedia) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ImportWorkspaceMedia) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ImportWorkspaceMedia) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ImportWorkspaceMedia) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ImportWorkspaceMedia) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ImportWorkspaceMedia) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ImportWorkspaceMedia) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ImportWorkspaceMedia) 

# ListAgentStatuses
<a name="API_ListAgentStatuses"></a>

Lists agent statuses.

## Request Syntax
<a name="API_ListAgentStatuses_RequestSyntax"></a>

```
GET /agent-status/InstanceId?AgentStatusTypes=AgentStatusTypes&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAgentStatuses_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AgentStatusTypes](#API_ListAgentStatuses_RequestSyntax) **   <a name="connect-ListAgentStatuses-request-uri-AgentStatusTypes"></a>
Available agent status types.  
Array Members: Maximum number of 3 items.  
Valid Values: `ROUTABLE | CUSTOM | OFFLINE` 

 ** [InstanceId](#API_ListAgentStatuses_RequestSyntax) **   <a name="connect-ListAgentStatuses-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListAgentStatuses_RequestSyntax) **   <a name="connect-ListAgentStatuses-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListAgentStatuses_RequestSyntax) **   <a name="connect-ListAgentStatuses-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListAgentStatuses_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAgentStatuses_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AgentStatusSummaryList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string",
         "Type": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListAgentStatuses_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AgentStatusSummaryList](#API_ListAgentStatuses_ResponseSyntax) **   <a name="connect-ListAgentStatuses-response-AgentStatusSummaryList"></a>
A summary of agent statuses.  
Type: Array of [AgentStatusSummary](API_AgentStatusSummary.md) objects

 ** [NextToken](#API_ListAgentStatuses_ResponseSyntax) **   <a name="connect-ListAgentStatuses-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_ListAgentStatuses_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListAgentStatuses_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListAgentStatuses) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListAgentStatuses) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListAgentStatuses) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListAgentStatuses) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListAgentStatuses) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListAgentStatuses) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListAgentStatuses) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListAgentStatuses) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListAgentStatuses) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListAgentStatuses) 

# ListAnalyticsDataAssociations
<a name="API_ListAnalyticsDataAssociations"></a>

Lists the association status of requested dataset ID for a given Amazon Connect instance.

## Request Syntax
<a name="API_ListAnalyticsDataAssociations_RequestSyntax"></a>

```
GET /analytics-data/instance/InstanceId/association?DataSetId=DataSetId&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAnalyticsDataAssociations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DataSetId](#API_ListAnalyticsDataAssociations_RequestSyntax) **   <a name="connect-ListAnalyticsDataAssociations-request-uri-DataSetId"></a>
The identifier of the dataset to get the association status.  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [InstanceId](#API_ListAnalyticsDataAssociations_RequestSyntax) **   <a name="connect-ListAnalyticsDataAssociations-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListAnalyticsDataAssociations_RequestSyntax) **   <a name="connect-ListAnalyticsDataAssociations-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListAnalyticsDataAssociations_RequestSyntax) **   <a name="connect-ListAnalyticsDataAssociations-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListAnalyticsDataAssociations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAnalyticsDataAssociations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Results": [ 
      { 
         "DataSetId": "string",
         "ResourceShareArn": "string",
         "ResourceShareId": "string",
         "ResourceShareStatus": "string",
         "TargetAccountId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListAnalyticsDataAssociations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListAnalyticsDataAssociations_ResponseSyntax) **   <a name="connect-ListAnalyticsDataAssociations-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [Results](#API_ListAnalyticsDataAssociations_ResponseSyntax) **   <a name="connect-ListAnalyticsDataAssociations-response-Results"></a>
An array of successful results: `DataSetId`, `TargetAccountId`, `ResourceShareId`, `ResourceShareArn`. This is a paginated API, so `nextToken` is given if there are more results to be returned.  
Type: Array of [AnalyticsDataAssociationResult](API_AnalyticsDataAssociationResult.md) objects

## Errors
<a name="API_ListAnalyticsDataAssociations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListAnalyticsDataAssociations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListAnalyticsDataAssociations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListAnalyticsDataAssociations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListAnalyticsDataAssociations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListAnalyticsDataAssociations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListAnalyticsDataAssociations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListAnalyticsDataAssociations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListAnalyticsDataAssociations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListAnalyticsDataAssociations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListAnalyticsDataAssociations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListAnalyticsDataAssociations) 

# ListAnalyticsDataLakeDataSets
<a name="API_ListAnalyticsDataLakeDataSets"></a>

Lists the data lake datasets available to associate with for a given Amazon Connect instance.

## Request Syntax
<a name="API_ListAnalyticsDataLakeDataSets_RequestSyntax"></a>

```
GET /analytics-data/instance/InstanceId/datasets?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAnalyticsDataLakeDataSets_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListAnalyticsDataLakeDataSets_RequestSyntax) **   <a name="connect-ListAnalyticsDataLakeDataSets-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListAnalyticsDataLakeDataSets_RequestSyntax) **   <a name="connect-ListAnalyticsDataLakeDataSets-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListAnalyticsDataLakeDataSets_RequestSyntax) **   <a name="connect-ListAnalyticsDataLakeDataSets-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListAnalyticsDataLakeDataSets_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAnalyticsDataLakeDataSets_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Results": [ 
      { 
         "DataSetId": "string",
         "DataSetName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListAnalyticsDataLakeDataSets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListAnalyticsDataLakeDataSets_ResponseSyntax) **   <a name="connect-ListAnalyticsDataLakeDataSets-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [Results](#API_ListAnalyticsDataLakeDataSets_ResponseSyntax) **   <a name="connect-ListAnalyticsDataLakeDataSets-response-Results"></a>
An array of successful results: `DataSetId`, `DataSetName`. This is a paginated API, so `nextToken` is given if there are more results to be returned.  
Type: Array of [AnalyticsDataSetsResult](API_AnalyticsDataSetsResult.md) objects

## Errors
<a name="API_ListAnalyticsDataLakeDataSets_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListAnalyticsDataLakeDataSets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListAnalyticsDataLakeDataSets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListAnalyticsDataLakeDataSets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListAnalyticsDataLakeDataSets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListAnalyticsDataLakeDataSets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListAnalyticsDataLakeDataSets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListAnalyticsDataLakeDataSets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListAnalyticsDataLakeDataSets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListAnalyticsDataLakeDataSets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListAnalyticsDataLakeDataSets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListAnalyticsDataLakeDataSets) 

# ListApprovedOrigins
<a name="API_ListApprovedOrigins"></a>

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all approved origins associated with the instance.

## Request Syntax
<a name="API_ListApprovedOrigins_RequestSyntax"></a>

```
GET /instance/InstanceId/approved-origins?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListApprovedOrigins_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListApprovedOrigins_RequestSyntax) **   <a name="connect-ListApprovedOrigins-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListApprovedOrigins_RequestSyntax) **   <a name="connect-ListApprovedOrigins-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 25.

 ** [NextToken](#API_ListApprovedOrigins_RequestSyntax) **   <a name="connect-ListApprovedOrigins-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListApprovedOrigins_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListApprovedOrigins_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Origins": [ "string" ]
}
```

## Response Elements
<a name="API_ListApprovedOrigins_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListApprovedOrigins_ResponseSyntax) **   <a name="connect-ListApprovedOrigins-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [Origins](#API_ListApprovedOrigins_ResponseSyntax) **   <a name="connect-ListApprovedOrigins-response-Origins"></a>
The approved origins.  
Type: Array of strings  
Length Constraints: Maximum length of 267.

## Errors
<a name="API_ListApprovedOrigins_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListApprovedOrigins_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListApprovedOrigins) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListApprovedOrigins) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListApprovedOrigins) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListApprovedOrigins) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListApprovedOrigins) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListApprovedOrigins) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListApprovedOrigins) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListApprovedOrigins) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListApprovedOrigins) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListApprovedOrigins) 

# ListAssociatedContacts
<a name="API_ListAssociatedContacts"></a>

Provides information about contact tree, a list of associated contacts with a unique identifier.

## Request Syntax
<a name="API_ListAssociatedContacts_RequestSyntax"></a>

```
GET /contact/associated/InstanceId?contactId=ContactId&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAssociatedContacts_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactId](#API_ListAssociatedContacts_RequestSyntax) **   <a name="connect-ListAssociatedContacts-request-uri-ContactId"></a>
The identifier of the contact in this instance of Amazon Connect.   
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_ListAssociatedContacts_RequestSyntax) **   <a name="connect-ListAssociatedContacts-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListAssociatedContacts_RequestSyntax) **   <a name="connect-ListAssociatedContacts-request-uri-MaxResults"></a>
The maximum number of results to return per page.   
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListAssociatedContacts_RequestSyntax) **   <a name="connect-ListAssociatedContacts-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListAssociatedContacts_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAssociatedContacts_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactSummaryList": [ 
      { 
         "Channel": "string",
         "ContactArn": "string",
         "ContactId": "string",
         "DisconnectTimestamp": number,
         "InitialContactId": "string",
         "InitiationMethod": "string",
         "InitiationTimestamp": number,
         "PreviousContactId": "string",
         "RelatedContactId": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListAssociatedContacts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContactSummaryList](#API_ListAssociatedContacts_ResponseSyntax) **   <a name="connect-ListAssociatedContacts-response-ContactSummaryList"></a>
List of the contact summary for all the contacts in contact tree associated with unique identifier.  
Type: Array of [AssociatedContactSummary](API_AssociatedContactSummary.md) objects

 ** [NextToken](#API_ListAssociatedContacts_ResponseSyntax) **   <a name="connect-ListAssociatedContacts-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_ListAssociatedContacts_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListAssociatedContacts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListAssociatedContacts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListAssociatedContacts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListAssociatedContacts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListAssociatedContacts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListAssociatedContacts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListAssociatedContacts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListAssociatedContacts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListAssociatedContacts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListAssociatedContacts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListAssociatedContacts) 

# ListAuthenticationProfiles
<a name="API_ListAuthenticationProfiles"></a>

This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Support.

Provides summary information about the authentication profiles in a specified Amazon Connect instance.

## Request Syntax
<a name="API_ListAuthenticationProfiles_RequestSyntax"></a>

```
GET /authentication-profiles-summary/InstanceId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAuthenticationProfiles_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListAuthenticationProfiles_RequestSyntax) **   <a name="connect-ListAuthenticationProfiles-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListAuthenticationProfiles_RequestSyntax) **   <a name="connect-ListAuthenticationProfiles-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListAuthenticationProfiles_RequestSyntax) **   <a name="connect-ListAuthenticationProfiles-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListAuthenticationProfiles_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAuthenticationProfiles_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AuthenticationProfileSummaryList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "IsDefault": boolean,
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListAuthenticationProfiles_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AuthenticationProfileSummaryList](#API_ListAuthenticationProfiles_ResponseSyntax) **   <a name="connect-ListAuthenticationProfiles-response-AuthenticationProfileSummaryList"></a>
A summary of a given authentication profile.  
Type: Array of [AuthenticationProfileSummary](API_AuthenticationProfileSummary.md) objects

 ** [NextToken](#API_ListAuthenticationProfiles_ResponseSyntax) **   <a name="connect-ListAuthenticationProfiles-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_ListAuthenticationProfiles_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListAuthenticationProfiles_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListAuthenticationProfiles) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListAuthenticationProfiles) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListAuthenticationProfiles) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListAuthenticationProfiles) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListAuthenticationProfiles) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListAuthenticationProfiles) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListAuthenticationProfiles) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListAuthenticationProfiles) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListAuthenticationProfiles) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListAuthenticationProfiles) 

# ListBots
<a name="API_ListBots"></a>

This API is in preview release for Amazon Connect and is subject to change.

For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to return both Amazon Lex V1 and V2 bots.

## Request Syntax
<a name="API_ListBots_RequestSyntax"></a>

```
GET /instance/InstanceId/bots?lexVersion=LexVersion&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListBots_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListBots_RequestSyntax) **   <a name="connect-ListBots-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [LexVersion](#API_ListBots_RequestSyntax) **   <a name="connect-ListBots-request-uri-LexVersion"></a>
The version of Amazon Lex or Amazon Lex V2.  
Valid Values: `V1 | V2`   
Required: Yes

 ** [MaxResults](#API_ListBots_RequestSyntax) **   <a name="connect-ListBots-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 25.

 ** [NextToken](#API_ListBots_RequestSyntax) **   <a name="connect-ListBots-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListBots_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListBots_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "LexBots": [ 
      { 
         "LexBot": { 
            "LexRegion": "string",
            "Name": "string"
         },
         "LexV2Bot": { 
            "AliasArn": "string"
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListBots_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LexBots](#API_ListBots_ResponseSyntax) **   <a name="connect-ListBots-response-LexBots"></a>
The names and AWS Regions of the Amazon Lex or Amazon Lex V2 bots associated with the specified instance.  
Type: Array of [LexBotConfig](API_LexBotConfig.md) objects

 ** [NextToken](#API_ListBots_ResponseSyntax) **   <a name="connect-ListBots-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_ListBots_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListBots_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListBots) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListBots) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListBots) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListBots) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListBots) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListBots) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListBots) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListBots) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListBots) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListBots) 

# ListChildHoursOfOperations
<a name="API_ListChildHoursOfOperations"></a>

Provides information about the child hours of operations for the specified parent hours of operation.

For more information about child hours of operations, see [Link overrides from different hours of operation](https://docs.aws.amazon.com/connect/latest/adminguide/) in the * Administrator Guide*.

## Request Syntax
<a name="API_ListChildHoursOfOperations_RequestSyntax"></a>

```
GET /hours-of-operations/InstanceId/HoursOfOperationId/hours?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListChildHoursOfOperations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [HoursOfOperationId](#API_ListChildHoursOfOperations_RequestSyntax) **   <a name="connect-ListChildHoursOfOperations-request-uri-HoursOfOperationId"></a>
The identifier of the parent hours of operation.  
Required: Yes

 ** [InstanceId](#API_ListChildHoursOfOperations_RequestSyntax) **   <a name="connect-ListChildHoursOfOperations-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListChildHoursOfOperations_RequestSyntax) **   <a name="connect-ListChildHoursOfOperations-request-uri-MaxResults"></a>
The maximum number of results to return per page. The default MaxResult size is 100.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListChildHoursOfOperations_RequestSyntax) **   <a name="connect-ListChildHoursOfOperations-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListChildHoursOfOperations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListChildHoursOfOperations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ChildHoursOfOperationsSummaryList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "Name": "string"
      }
   ],
   "LastModifiedRegion": "string",
   "LastModifiedTime": number,
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListChildHoursOfOperations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ChildHoursOfOperationsSummaryList](#API_ListChildHoursOfOperations_ResponseSyntax) **   <a name="connect-ListChildHoursOfOperations-response-ChildHoursOfOperationsSummaryList"></a>
Information about the hours of operation.  
Type: Array of [HoursOfOperationsIdentifier](API_HoursOfOperationsIdentifier.md) objects

 ** [LastModifiedRegion](#API_ListChildHoursOfOperations_ResponseSyntax) **   <a name="connect-ListChildHoursOfOperations-response-LastModifiedRegion"></a>
The AWS Region where this resource was last modified.  
Type: String  
Pattern: `[a-z]{2}(-[a-z]+){1,2}(-[0-9])?` 

 ** [LastModifiedTime](#API_ListChildHoursOfOperations_ResponseSyntax) **   <a name="connect-ListChildHoursOfOperations-response-LastModifiedTime"></a>
The timestamp when this resource was last modified.  
Type: Timestamp

 ** [NextToken](#API_ListChildHoursOfOperations_ResponseSyntax) **   <a name="connect-ListChildHoursOfOperations-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_ListChildHoursOfOperations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListChildHoursOfOperations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListChildHoursOfOperations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListChildHoursOfOperations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListChildHoursOfOperations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListChildHoursOfOperations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListChildHoursOfOperations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListChildHoursOfOperations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListChildHoursOfOperations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListChildHoursOfOperations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListChildHoursOfOperations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListChildHoursOfOperations) 

# ListContactEvaluations
<a name="API_ListContactEvaluations"></a>

Lists contact evaluations in the specified Amazon Connect instance.

## Request Syntax
<a name="API_ListContactEvaluations_RequestSyntax"></a>

```
GET /contact-evaluations/InstanceId?contactId=ContactId&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListContactEvaluations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactId](#API_ListContactEvaluations_RequestSyntax) **   <a name="connect-ListContactEvaluations-request-uri-ContactId"></a>
The identifier of the contact in this instance of Amazon Connect.   
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_ListContactEvaluations_RequestSyntax) **   <a name="connect-ListContactEvaluations-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [NextToken](#API_ListContactEvaluations_RequestSyntax) **   <a name="connect-ListContactEvaluations-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
This is not expected to be set because the value returned in the previous response is always null.

## Request Body
<a name="API_ListContactEvaluations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListContactEvaluations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EvaluationSummaryList": [ 
      { 
         "Acknowledgement": { 
            "AcknowledgedBy": "string",
            "AcknowledgedTime": number,
            "AcknowledgerComment": "string"
         },
         "AutoEvaluationEnabled": boolean,
         "AutoEvaluationStatus": "string",
         "CalibrationSessionId": "string",
         "ContactParticipant": { 
            "ContactParticipantId": "string",
            "ContactParticipantRole": "string"
         },
         "CreatedTime": number,
         "EvaluationArn": "string",
         "EvaluationFormId": "string",
         "EvaluationFormTitle": "string",
         "EvaluationId": "string",
         "EvaluationType": "string",
         "EvaluatorArn": "string",
         "LastModifiedTime": number,
         "Score": { 
            "AppliedWeight": number,
            "AutomaticFail": boolean,
            "NotApplicable": boolean,
            "Percentage": number
         },
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListContactEvaluations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EvaluationSummaryList](#API_ListContactEvaluations_ResponseSyntax) **   <a name="connect-ListContactEvaluations-response-EvaluationSummaryList"></a>
Provides details about a list of contact evaluations belonging to an instance.  
Type: Array of [EvaluationSummary](API_EvaluationSummary.md) objects

 ** [NextToken](#API_ListContactEvaluations_ResponseSyntax) **   <a name="connect-ListContactEvaluations-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
This is always returned as null in the response.
Type: String

## Errors
<a name="API_ListContactEvaluations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_ListContactEvaluations_Examples"></a>

### Example
<a name="API_ListContactEvaluations_Example_1"></a>

The following example lists the contact evaluations for a contact.

#### Sample Request
<a name="API_ListContactEvaluations_Example_1_Request"></a>

```
{
   "InstanceId": "[instance_id]",
   "ContactId": "[contact_id]"
}
```

#### Sample Response
<a name="API_ListContactEvaluations_Example_1_Response"></a>

```
{
   "EvaluationSummaryList": [
      {
         "EvaluationId": "[evaluation_id]",
         "EvaluationArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/contact-evaluation/[evaluation_id]",
         "EvaluationFormTitle": "form-title",
         "EvaluationFormId": "[evaluation_form_id]",
         "Status": "DRAFT",
         "EvaluatorArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/agent/arn:aws:sts::[account_id]:assumed-role/Admin/username",
         "CreatedTime": "2023-05-04T01:16:29.693000-07:00",
         "LastModifiedTime": "2023-05-04T01:16:29.693000-07:00"
      },
   ]
}
```

## See Also
<a name="API_ListContactEvaluations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListContactEvaluations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListContactEvaluations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListContactEvaluations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListContactEvaluations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListContactEvaluations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListContactEvaluations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListContactEvaluations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListContactEvaluations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListContactEvaluations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListContactEvaluations) 

# ListContactFlowModuleAliases
<a name="API_ListContactFlowModuleAliases"></a>

Lists all aliases associated with a contact flow module, showing their current version mappings and metadata.

## Request Syntax
<a name="API_ListContactFlowModuleAliases_RequestSyntax"></a>

```
GET /contact-flow-modules/InstanceId/ContactFlowModuleId/aliases?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListContactFlowModuleAliases_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactFlowModuleId](#API_ListContactFlowModuleAliases_RequestSyntax) **   <a name="connect-ListContactFlowModuleAliases-request-uri-ContactFlowModuleId"></a>
The identifier of the flow module.  
Required: Yes

 ** [InstanceId](#API_ListContactFlowModuleAliases_RequestSyntax) **   <a name="connect-ListContactFlowModuleAliases-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

 ** [MaxResults](#API_ListContactFlowModuleAliases_RequestSyntax) **   <a name="connect-ListContactFlowModuleAliases-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListContactFlowModuleAliases_RequestSyntax) **   <a name="connect-ListContactFlowModuleAliases-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListContactFlowModuleAliases_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListContactFlowModuleAliases_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactFlowModuleAliasSummaryList": [ 
      { 
         "AliasDescription": "string",
         "AliasId": "string",
         "AliasName": "string",
         "Arn": "string",
         "LastModifiedTime": number,
         "Version": number
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListContactFlowModuleAliases_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContactFlowModuleAliasSummaryList](#API_ListContactFlowModuleAliases_ResponseSyntax) **   <a name="connect-ListContactFlowModuleAliases-response-ContactFlowModuleAliasSummaryList"></a>
Information about the flow module aliases.  
Type: Array of [ContactFlowModuleAliasSummary](API_ContactFlowModuleAliasSummary.md) objects

 ** [NextToken](#API_ListContactFlowModuleAliases_ResponseSyntax) **   <a name="connect-ListContactFlowModuleAliases-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_ListContactFlowModuleAliases_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_ListContactFlowModuleAliases_Examples"></a>

### Sample Response
<a name="API_ListContactFlowModuleAliases_Example_1"></a>

This example illustrates one usage of ListContactFlowModuleAliases.

```
{
   "NextToken": "NextTokenId",
   "ContactFlowModuleAliasSummaryList": [ 
      { 
         "Arn": "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-1234-1234-123456789012/flow-module/abcdefgh-1234-5678-9012-abcdefghijkl",
         "AliasId": "alias-12345678",
         "Version": 2,
         "AliasName": "production",
         "AliasDescription": "Production version of the customer service module",
         "LastModifiedTime": "2024-01-15T10:30:00.000Z"
      },
      { 
         "Arn": "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-1234-1234-123456789012/flow-module/abcdefgh-1234-5678-9012-abcdefghijkl",
         "AliasId": "alias-87654321",
         "Version": 1,
         "AliasName": "staging",
         "AliasDescription": "Staging version for testing",
         "LastModifiedTime": "2024-01-10T14:20:00.000Z"
      }
   ]
}
```

## See Also
<a name="API_ListContactFlowModuleAliases_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListContactFlowModuleAliases) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListContactFlowModuleAliases) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListContactFlowModuleAliases) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListContactFlowModuleAliases) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListContactFlowModuleAliases) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListContactFlowModuleAliases) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListContactFlowModuleAliases) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListContactFlowModuleAliases) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListContactFlowModuleAliases) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListContactFlowModuleAliases) 

# ListContactFlowModules
<a name="API_ListContactFlowModules"></a>

Provides information about the flow modules for the specified Amazon Connect instance.

## Request Syntax
<a name="API_ListContactFlowModules_RequestSyntax"></a>

```
GET /contact-flow-modules-summary/InstanceId?maxResults=MaxResults&nextToken=NextToken&state=ContactFlowModuleState HTTP/1.1
```

## URI Request Parameters
<a name="API_ListContactFlowModules_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactFlowModuleState](#API_ListContactFlowModules_RequestSyntax) **   <a name="connect-ListContactFlowModules-request-uri-ContactFlowModuleState"></a>
The state of the flow module.  
Valid Values: `ACTIVE | ARCHIVED` 

 ** [InstanceId](#API_ListContactFlowModules_RequestSyntax) **   <a name="connect-ListContactFlowModules-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListContactFlowModules_RequestSyntax) **   <a name="connect-ListContactFlowModules-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListContactFlowModules_RequestSyntax) **   <a name="connect-ListContactFlowModules-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListContactFlowModules_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListContactFlowModules_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactFlowModulesSummaryList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "Name": "string",
         "State": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListContactFlowModules_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContactFlowModulesSummaryList](#API_ListContactFlowModules_ResponseSyntax) **   <a name="connect-ListContactFlowModules-response-ContactFlowModulesSummaryList"></a>
Information about the flow module.  
Type: Array of [ContactFlowModuleSummary](API_ContactFlowModuleSummary.md) objects

 ** [NextToken](#API_ListContactFlowModules_ResponseSyntax) **   <a name="connect-ListContactFlowModules-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_ListContactFlowModules_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListContactFlowModules_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListContactFlowModules) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListContactFlowModules) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListContactFlowModules) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListContactFlowModules) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListContactFlowModules) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListContactFlowModules) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListContactFlowModules) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListContactFlowModules) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListContactFlowModules) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListContactFlowModules) 

# ListContactFlowModuleVersions
<a name="API_ListContactFlowModuleVersions"></a>

Retrieves a paginated list of all versions for a specific contact flow module.

## Request Syntax
<a name="API_ListContactFlowModuleVersions_RequestSyntax"></a>

```
GET /contact-flow-modules/InstanceId/ContactFlowModuleId/versions?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListContactFlowModuleVersions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactFlowModuleId](#API_ListContactFlowModuleVersions_RequestSyntax) **   <a name="connect-ListContactFlowModuleVersions-request-uri-ContactFlowModuleId"></a>
The identifier of the flow module.  
Required: Yes

 ** [InstanceId](#API_ListContactFlowModuleVersions_RequestSyntax) **   <a name="connect-ListContactFlowModuleVersions-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListContactFlowModuleVersions_RequestSyntax) **   <a name="connect-ListContactFlowModuleVersions-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListContactFlowModuleVersions_RequestSyntax) **   <a name="connect-ListContactFlowModuleVersions-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListContactFlowModuleVersions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListContactFlowModuleVersions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactFlowModuleVersionSummaryList": [ 
      { 
         "Arn": "string",
         "Version": number,
         "VersionDescription": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListContactFlowModuleVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContactFlowModuleVersionSummaryList](#API_ListContactFlowModuleVersions_ResponseSyntax) **   <a name="connect-ListContactFlowModuleVersions-response-ContactFlowModuleVersionSummaryList"></a>
Information about the flow module versions.  
Type: Array of [ContactFlowModuleVersionSummary](API_ContactFlowModuleVersionSummary.md) objects

 ** [NextToken](#API_ListContactFlowModuleVersions_ResponseSyntax) **   <a name="connect-ListContactFlowModuleVersions-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_ListContactFlowModuleVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_ListContactFlowModuleVersions_Examples"></a>

### Sample Response
<a name="API_ListContactFlowModuleVersions_Example_1"></a>

This example illustrates one usage of ListContactFlowModuleVersions.

```
{
   "NextToken": "NextTokenId",
   "ContactFlowModuleVersionSummaryList": [ 
      { 
         "Arn": "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-1234-1234-123456789012/flow-module/abcdefgh-1234-5678-9012-abcdefghijkl",
         "Version": 2,
         "VersionDescription": "Updated customer service module with bug fixes"
      },
      { 
         "Arn": "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-1234-1234-123456789012/flow-module/abcdefgh-1234-5678-9012-abcdefghijkl",
         "Version": 1,
         "VersionDescription": "Initial version of the customer service module"
      }
   ]
}
```

## See Also
<a name="API_ListContactFlowModuleVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListContactFlowModuleVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListContactFlowModuleVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListContactFlowModuleVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListContactFlowModuleVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListContactFlowModuleVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListContactFlowModuleVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListContactFlowModuleVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListContactFlowModuleVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListContactFlowModuleVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListContactFlowModuleVersions) 

# ListContactFlows
<a name="API_ListContactFlows"></a>

Provides information about the flows for the specified Amazon Connect instance.

You can also create and update flows using the [Amazon Connect Flow language](https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html).

For more information about flows, see [Flows](https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html) in the *Amazon Connect Administrator Guide*.

## Request Syntax
<a name="API_ListContactFlows_RequestSyntax"></a>

```
GET /contact-flows-summary/InstanceId?contactFlowTypes=ContactFlowTypes&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListContactFlows_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactFlowTypes](#API_ListContactFlows_RequestSyntax) **   <a name="connect-ListContactFlows-request-uri-ContactFlowTypes"></a>
The type of flow.  
Array Members: Maximum number of 10 items.  
Valid Values: `CONTACT_FLOW | CUSTOMER_QUEUE | CUSTOMER_HOLD | CUSTOMER_WHISPER | AGENT_HOLD | AGENT_WHISPER | OUTBOUND_WHISPER | AGENT_TRANSFER | QUEUE_TRANSFER | CAMPAIGN` 

 ** [InstanceId](#API_ListContactFlows_RequestSyntax) **   <a name="connect-ListContactFlows-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListContactFlows_RequestSyntax) **   <a name="connect-ListContactFlows-request-uri-MaxResults"></a>
The maximum number of results to return per page. The default MaxResult size is 100.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListContactFlows_RequestSyntax) **   <a name="connect-ListContactFlows-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListContactFlows_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListContactFlows_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactFlowSummaryList": [ 
      { 
         "Arn": "string",
         "ContactFlowState": "string",
         "ContactFlowStatus": "string",
         "ContactFlowType": "string",
         "Id": "string",
         "Name": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListContactFlows_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContactFlowSummaryList](#API_ListContactFlows_ResponseSyntax) **   <a name="connect-ListContactFlows-response-ContactFlowSummaryList"></a>
Information about the flows.  
Type: Array of [ContactFlowSummary](API_ContactFlowSummary.md) objects

 ** [NextToken](#API_ListContactFlows_ResponseSyntax) **   <a name="connect-ListContactFlows-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_ListContactFlows_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListContactFlows_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListContactFlows) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListContactFlows) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListContactFlows) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListContactFlows) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListContactFlows) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListContactFlows) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListContactFlows) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListContactFlows) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListContactFlows) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListContactFlows) 

# ListContactFlowVersions
<a name="API_ListContactFlowVersions"></a>

Returns all the available versions for the specified Amazon Connect instance and flow identifier.

## Request Syntax
<a name="API_ListContactFlowVersions_RequestSyntax"></a>

```
GET /contact-flows/InstanceId/ContactFlowId/versions?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListContactFlowVersions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactFlowId](#API_ListContactFlowVersions_RequestSyntax) **   <a name="connect-ListContactFlowVersions-request-uri-ContactFlowId"></a>
The identifier of the flow.  
Required: Yes

 ** [InstanceId](#API_ListContactFlowVersions_RequestSyntax) **   <a name="connect-ListContactFlowVersions-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListContactFlowVersions_RequestSyntax) **   <a name="connect-ListContactFlowVersions-request-uri-MaxResults"></a>
The maximum number of results to return per page. The default MaxResult size is 100.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListContactFlowVersions_RequestSyntax) **   <a name="connect-ListContactFlowVersions-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListContactFlowVersions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListContactFlowVersions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactFlowVersionSummaryList": [ 
      { 
         "Arn": "string",
         "Version": number,
         "VersionDescription": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListContactFlowVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContactFlowVersionSummaryList](#API_ListContactFlowVersions_ResponseSyntax) **   <a name="connect-ListContactFlowVersions-response-ContactFlowVersionSummaryList"></a>
A list of flow version summaries.  
Type: Array of [ContactFlowVersionSummary](API_ContactFlowVersionSummary.md) objects

 ** [NextToken](#API_ListContactFlowVersions_ResponseSyntax) **   <a name="connect-ListContactFlowVersions-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_ListContactFlowVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_ListContactFlowVersions_Examples"></a>

### Sample Response
<a name="API_ListContactFlowVersions_Example_1"></a>

This example illustrates one usage of ListContactFlowVersions.

```
{
   "NextToken": "NextTokenId",
   "ContactFlowVersionSummaryList": [ 
      { 
         "Arn": "[contact_flow_arn]",
         "Version": 1,
         "VersionDescription": "description of the flow version"
      }
   ]
}
```

## See Also
<a name="API_ListContactFlowVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListContactFlowVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListContactFlowVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListContactFlowVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListContactFlowVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListContactFlowVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListContactFlowVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListContactFlowVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListContactFlowVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListContactFlowVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListContactFlowVersions) 

# ListContactReferences
<a name="API_ListContactReferences"></a>

This API is in preview release for Amazon Connect and is subject to change.

For the specified `referenceTypes`, returns a list of references associated with the contact. *References* are links to documents that are related to a contact, such as emails, attachments, or URLs.

## Request Syntax
<a name="API_ListContactReferences_RequestSyntax"></a>

```
GET /contact/references/InstanceId/ContactId?nextToken=NextToken&referenceTypes=ReferenceTypes HTTP/1.1
```

## URI Request Parameters
<a name="API_ListContactReferences_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactId](#API_ListContactReferences_RequestSyntax) **   <a name="connect-ListContactReferences-request-uri-ContactId"></a>
The identifier of the initial contact.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_ListContactReferences_RequestSyntax) **   <a name="connect-ListContactReferences-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [NextToken](#API_ListContactReferences_RequestSyntax) **   <a name="connect-ListContactReferences-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
This is not expected to be set, because the value returned in the previous response is always null.

 ** [ReferenceTypes](#API_ListContactReferences_RequestSyntax) **   <a name="connect-ListContactReferences-request-uri-ReferenceTypes"></a>
The type of reference.  
Array Members: Maximum number of 6 items.  
Valid Values: `URL | ATTACHMENT | CONTACT_ANALYSIS | NUMBER | STRING | DATE | EMAIL | EMAIL_MESSAGE | EMAIL_MESSAGE_PLAIN_TEXT`   
Required: Yes

## Request Body
<a name="API_ListContactReferences_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListContactReferences_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ReferenceSummaryList": [ 
      { ... }
   ]
}
```

## Response Elements
<a name="API_ListContactReferences_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListContactReferences_ResponseSyntax) **   <a name="connect-ListContactReferences-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
This is always returned as null in the response.
Type: String

 ** [ReferenceSummaryList](#API_ListContactReferences_ResponseSyntax) **   <a name="connect-ListContactReferences-response-ReferenceSummaryList"></a>
Information about the flows.  
Type: Array of [ReferenceSummary](API_ReferenceSummary.md) objects

## Errors
<a name="API_ListContactReferences_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListContactReferences_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListContactReferences) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListContactReferences) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListContactReferences) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListContactReferences) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListContactReferences) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListContactReferences) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListContactReferences) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListContactReferences) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListContactReferences) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListContactReferences) 

# ListDataTableAttributes
<a name="API_ListDataTableAttributes"></a>

Returns all attributes for a specified data table. A maximum of 100 attributes per data table is allowed. Customers can request an increase by using AWS Service Quotas. The response can be filtered by specific attribute IDs for CloudFormation integration.

## Request Syntax
<a name="API_ListDataTableAttributes_RequestSyntax"></a>

```
POST /data-tables/InstanceId/DataTableId/attributes?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
Content-type: application/json

{
   "AttributeIds": [ "string" ]
}
```

## URI Request Parameters
<a name="API_ListDataTableAttributes_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DataTableId](#API_ListDataTableAttributes_RequestSyntax) **   <a name="connect-ListDataTableAttributes-request-uri-DataTableId"></a>
The unique identifier for the data table whose attributes should be listed.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_ListDataTableAttributes_RequestSyntax) **   <a name="connect-ListDataTableAttributes-request-uri-InstanceId"></a>
The unique identifier for the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListDataTableAttributes_RequestSyntax) **   <a name="connect-ListDataTableAttributes-request-uri-MaxResults"></a>
The maximum number of data table attributes to return in one page of results.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListDataTableAttributes_RequestSyntax) **   <a name="connect-ListDataTableAttributes-request-uri-NextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.

## Request Body
<a name="API_ListDataTableAttributes_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AttributeIds](#API_ListDataTableAttributes_RequestSyntax) **   <a name="connect-ListDataTableAttributes-request-AttributeIds"></a>
Optional list of specific attribute IDs to retrieve. Used for CloudFormation to effectively describe attributes by ID. If NextToken is provided, this parameter is ignored.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_ListDataTableAttributes_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Attributes": [ 
      { 
         "AttributeId": "string",
         "DataTableArn": "string",
         "DataTableId": "string",
         "Description": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "LockVersion": { 
            "Attribute": "string",
            "DataTable": "string",
            "PrimaryValues": "string",
            "Value": "string"
         },
         "Name": "string",
         "Primary": boolean,
         "Validation": { 
            "Enum": { 
               "Strict": boolean,
               "Values": [ "string" ]
            },
            "ExclusiveMaximum": number,
            "ExclusiveMinimum": number,
            "IgnoreCase": boolean,
            "Maximum": number,
            "MaxLength": number,
            "MaxValues": number,
            "Minimum": number,
            "MinLength": number,
            "MinValues": number,
            "MultipleOf": number
         },
         "ValueType": "string",
         "Version": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListDataTableAttributes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Attributes](#API_ListDataTableAttributes_ResponseSyntax) **   <a name="connect-ListDataTableAttributes-response-Attributes"></a>
A list of data table attributes with their complete configuration and metadata.  
Type: Array of [DataTableAttribute](API_DataTableAttribute.md) objects

 ** [NextToken](#API_ListDataTableAttributes_ResponseSyntax) **   <a name="connect-ListDataTableAttributes-response-NextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Type: String

## Errors
<a name="API_ListDataTableAttributes_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListDataTableAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListDataTableAttributes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListDataTableAttributes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListDataTableAttributes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListDataTableAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListDataTableAttributes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListDataTableAttributes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListDataTableAttributes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListDataTableAttributes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListDataTableAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListDataTableAttributes) 

# ListDataTablePrimaryValues
<a name="API_ListDataTablePrimaryValues"></a>

Lists all primary value combinations for a given data table. Returns the unique combinations of primary attribute values that identify records in the table. Up to 100 records are returned per request.

## Request Syntax
<a name="API_ListDataTablePrimaryValues_RequestSyntax"></a>

```
POST /data-tables/InstanceId/DataTableId/values/list-primary?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
Content-type: application/json

{
   "PrimaryAttributeValues": [ 
      { 
         "AttributeName": "string",
         "Values": [ "string" ]
      }
   ],
   "RecordIds": [ "string" ]
}
```

## URI Request Parameters
<a name="API_ListDataTablePrimaryValues_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DataTableId](#API_ListDataTablePrimaryValues_RequestSyntax) **   <a name="connect-ListDataTablePrimaryValues-request-uri-DataTableId"></a>
The unique identifier for the data table whose primary values should be listed.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_ListDataTablePrimaryValues_RequestSyntax) **   <a name="connect-ListDataTablePrimaryValues-request-uri-InstanceId"></a>
The unique identifier for the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListDataTablePrimaryValues_RequestSyntax) **   <a name="connect-ListDataTablePrimaryValues-request-uri-MaxResults"></a>
The maximum number of data table primary values to return in one page of results.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListDataTablePrimaryValues_RequestSyntax) **   <a name="connect-ListDataTablePrimaryValues-request-uri-NextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.

## Request Body
<a name="API_ListDataTablePrimaryValues_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [PrimaryAttributeValues](#API_ListDataTablePrimaryValues_RequestSyntax) **   <a name="connect-ListDataTablePrimaryValues-request-PrimaryAttributeValues"></a>
Optional filter to retrieve primary values matching specific criteria.  
Type: Array of [PrimaryAttributeValueFilter](API_PrimaryAttributeValueFilter.md) objects  
Required: No

 ** [RecordIds](#API_ListDataTablePrimaryValues_RequestSyntax) **   <a name="connect-ListDataTablePrimaryValues-request-RecordIds"></a>
Optional list of specific record IDs to retrieve. Used for CloudFormation to effectively describe records by ID. If NextToken is provided, this parameter is ignored.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_ListDataTablePrimaryValues_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "PrimaryValuesList": [ 
      { 
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "PrimaryValues": [ 
            { 
               "AttributeId": "string",
               "AttributeName": "string",
               "Value": "string"
            }
         ],
         "RecordId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListDataTablePrimaryValues_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListDataTablePrimaryValues_ResponseSyntax) **   <a name="connect-ListDataTablePrimaryValues-response-NextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Type: String

 ** [PrimaryValuesList](#API_ListDataTablePrimaryValues_ResponseSyntax) **   <a name="connect-ListDataTablePrimaryValues-response-PrimaryValuesList"></a>
A list of primary value combinations with their record IDs and modification metadata.  
Type: Array of [RecordPrimaryValue](API_RecordPrimaryValue.md) objects

## Errors
<a name="API_ListDataTablePrimaryValues_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListDataTablePrimaryValues_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListDataTablePrimaryValues) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListDataTablePrimaryValues) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListDataTablePrimaryValues) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListDataTablePrimaryValues) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListDataTablePrimaryValues) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListDataTablePrimaryValues) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListDataTablePrimaryValues) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListDataTablePrimaryValues) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListDataTablePrimaryValues) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListDataTablePrimaryValues) 

# ListDataTables
<a name="API_ListDataTables"></a>

Lists all data tables for the specified Amazon Connect instance. Returns summary information for each table including basic metadata and modification details.

## Request Syntax
<a name="API_ListDataTables_RequestSyntax"></a>

```
GET /data-tables/InstanceId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListDataTables_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListDataTables_RequestSyntax) **   <a name="connect-ListDataTables-request-uri-InstanceId"></a>
The unique identifier for the Amazon Connect instance whose data tables should be listed.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListDataTables_RequestSyntax) **   <a name="connect-ListDataTables-request-uri-MaxResults"></a>
The maximum number of data tables to return in one page of results.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListDataTables_RequestSyntax) **   <a name="connect-ListDataTables-request-uri-NextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.

## Request Body
<a name="API_ListDataTables_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListDataTables_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DataTableSummaryList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListDataTables_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DataTableSummaryList](#API_ListDataTables_ResponseSyntax) **   <a name="connect-ListDataTables-response-DataTableSummaryList"></a>
A list of data table summaries containing basic information about each table including ID, ARN, name, and modification details.  
Type: Array of [DataTableSummary](API_DataTableSummary.md) objects

 ** [NextToken](#API_ListDataTables_ResponseSyntax) **   <a name="connect-ListDataTables-response-NextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Type: String

## Errors
<a name="API_ListDataTables_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListDataTables_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListDataTables) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListDataTables) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListDataTables) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListDataTables) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListDataTables) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListDataTables) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListDataTables) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListDataTables) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListDataTables) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListDataTables) 

# ListDataTableValues
<a name="API_ListDataTableValues"></a>

Lists values stored in a data table with optional filtering by record IDs or primary attribute values. Returns the raw stored values along with metadata such as lock versions and modification timestamps.

## Request Syntax
<a name="API_ListDataTableValues_RequestSyntax"></a>

```
POST /data-tables/InstanceId/DataTableId/values/list?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
Content-type: application/json

{
   "PrimaryAttributeValues": [ 
      { 
         "AttributeName": "string",
         "Values": [ "string" ]
      }
   ],
   "RecordIds": [ "string" ]
}
```

## URI Request Parameters
<a name="API_ListDataTableValues_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DataTableId](#API_ListDataTableValues_RequestSyntax) **   <a name="connect-ListDataTableValues-request-uri-DataTableId"></a>
The unique identifier for the data table whose values should be listed.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_ListDataTableValues_RequestSyntax) **   <a name="connect-ListDataTableValues-request-uri-InstanceId"></a>
The unique identifier for the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListDataTableValues_RequestSyntax) **   <a name="connect-ListDataTableValues-request-uri-MaxResults"></a>
The maximum number of data table values to return in one page of results.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListDataTableValues_RequestSyntax) **   <a name="connect-ListDataTableValues-request-uri-NextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.

## Request Body
<a name="API_ListDataTableValues_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [PrimaryAttributeValues](#API_ListDataTableValues_RequestSyntax) **   <a name="connect-ListDataTableValues-request-PrimaryAttributeValues"></a>
Optional filter to retrieve values for records matching specific primary attribute criteria.  
Type: Array of [PrimaryAttributeValueFilter](API_PrimaryAttributeValueFilter.md) objects  
Required: No

 ** [RecordIds](#API_ListDataTableValues_RequestSyntax) **   <a name="connect-ListDataTableValues-request-RecordIds"></a>
Optional list of specific record IDs to retrieve values for.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_ListDataTableValues_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Values": [ 
      { 
         "AttributeId": "string",
         "AttributeName": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "LockVersion": { 
            "Attribute": "string",
            "DataTable": "string",
            "PrimaryValues": "string",
            "Value": "string"
         },
         "PrimaryValues": [ 
            { 
               "AttributeId": "string",
               "AttributeName": "string",
               "Value": "string"
            }
         ],
         "RecordId": "string",
         "Value": "string",
         "ValueType": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListDataTableValues_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListDataTableValues_ResponseSyntax) **   <a name="connect-ListDataTableValues-response-NextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Type: String

 ** [Values](#API_ListDataTableValues_ResponseSyntax) **   <a name="connect-ListDataTableValues-response-Values"></a>
A list of data table values with their associated metadata, lock versions, and modification details.  
Type: Array of [DataTableValueSummary](API_DataTableValueSummary.md) objects

## Errors
<a name="API_ListDataTableValues_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListDataTableValues_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListDataTableValues) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListDataTableValues) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListDataTableValues) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListDataTableValues) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListDataTableValues) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListDataTableValues) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListDataTableValues) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListDataTableValues) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListDataTableValues) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListDataTableValues) 

# ListDefaultVocabularies
<a name="API_ListDefaultVocabularies"></a>

Lists the default vocabularies for the specified Amazon Connect instance.

## Request Syntax
<a name="API_ListDefaultVocabularies_RequestSyntax"></a>

```
POST /default-vocabulary-summary/InstanceId HTTP/1.1
Content-type: application/json

{
   "LanguageCode": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## URI Request Parameters
<a name="API_ListDefaultVocabularies_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListDefaultVocabularies_RequestSyntax) **   <a name="connect-ListDefaultVocabularies-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_ListDefaultVocabularies_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [LanguageCode](#API_ListDefaultVocabularies_RequestSyntax) **   <a name="connect-ListDefaultVocabularies-request-LanguageCode"></a>
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see [What is Amazon Transcribe?](https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html)   
Type: String  
Valid Values: `ar-AE | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fr-CA | fr-FR | hi-IN | it-IT | ja-JP | ko-KR | pt-BR | pt-PT | zh-CN | en-NZ | en-ZA | ca-ES | da-DK | fi-FI | id-ID | ms-MY | nl-NL | no-NO | pl-PL | sv-SE | tl-PH`   
Required: No

 ** [MaxResults](#API_ListDefaultVocabularies_RequestSyntax) **   <a name="connect-ListDefaultVocabularies-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListDefaultVocabularies_RequestSyntax) **   <a name="connect-ListDefaultVocabularies-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 131070.  
Pattern: `.*\S.*`   
Required: No

## Response Syntax
<a name="API_ListDefaultVocabularies_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DefaultVocabularyList": [ 
      { 
         "InstanceId": "string",
         "LanguageCode": "string",
         "VocabularyId": "string",
         "VocabularyName": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListDefaultVocabularies_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DefaultVocabularyList](#API_ListDefaultVocabularies_ResponseSyntax) **   <a name="connect-ListDefaultVocabularies-response-DefaultVocabularyList"></a>
A list of default vocabularies.  
Type: Array of [DefaultVocabulary](API_DefaultVocabulary.md) objects

 ** [NextToken](#API_ListDefaultVocabularies_ResponseSyntax) **   <a name="connect-ListDefaultVocabularies-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 131070.  
Pattern: `.*\S.*` 

## Errors
<a name="API_ListDefaultVocabularies_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListDefaultVocabularies_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListDefaultVocabularies) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListDefaultVocabularies) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListDefaultVocabularies) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListDefaultVocabularies) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListDefaultVocabularies) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListDefaultVocabularies) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListDefaultVocabularies) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListDefaultVocabularies) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListDefaultVocabularies) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListDefaultVocabularies) 

# ListEntitySecurityProfiles
<a name="API_ListEntitySecurityProfiles"></a>

 Lists all security profiles attached to a Q in Connect AIAgent Entity in an Amazon Connect instance. 

## Request Syntax
<a name="API_ListEntitySecurityProfiles_RequestSyntax"></a>

```
POST /entity-security-profiles-summary/InstanceId HTTP/1.1
Content-type: application/json

{
   "EntityArn": "string",
   "EntityType": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## URI Request Parameters
<a name="API_ListEntitySecurityProfiles_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListEntitySecurityProfiles_RequestSyntax) **   <a name="connect-ListEntitySecurityProfiles-request-uri-InstanceId"></a>
 The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.   
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_ListEntitySecurityProfiles_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [EntityArn](#API_ListEntitySecurityProfiles_RequestSyntax) **   <a name="connect-ListEntitySecurityProfiles-request-EntityArn"></a>
 ARN of a Q in Connect AI Agent.   
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

 ** [EntityType](#API_ListEntitySecurityProfiles_RequestSyntax) **   <a name="connect-ListEntitySecurityProfiles-request-EntityType"></a>
 Only supported type is AI\$1AGENT.   
Type: String  
Valid Values: `USER | AI_AGENT`   
Required: Yes

 ** [MaxResults](#API_ListEntitySecurityProfiles_RequestSyntax) **   <a name="connect-ListEntitySecurityProfiles-request-MaxResults"></a>
 The maximum number of results to return per page. The default MaxResult size is 100.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListEntitySecurityProfiles_RequestSyntax) **   <a name="connect-ListEntitySecurityProfiles-request-NextToken"></a>
 The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

## Response Syntax
<a name="API_ListEntitySecurityProfiles_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "SecurityProfiles": [ 
      { 
         "Id": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListEntitySecurityProfiles_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListEntitySecurityProfiles_ResponseSyntax) **   <a name="connect-ListEntitySecurityProfiles-response-NextToken"></a>
 The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.

 ** [SecurityProfiles](#API_ListEntitySecurityProfiles_ResponseSyntax) **   <a name="connect-ListEntitySecurityProfiles-response-SecurityProfiles"></a>
 List of Security Profile Object.   
Type: Array of [SecurityProfileItem](API_SecurityProfileItem.md) objects  
Array Members: Maximum number of 100 items.

## Errors
<a name="API_ListEntitySecurityProfiles_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListEntitySecurityProfiles_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListEntitySecurityProfiles) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListEntitySecurityProfiles) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListEntitySecurityProfiles) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListEntitySecurityProfiles) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListEntitySecurityProfiles) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListEntitySecurityProfiles) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListEntitySecurityProfiles) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListEntitySecurityProfiles) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListEntitySecurityProfiles) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListEntitySecurityProfiles) 

# ListEvaluationForms
<a name="API_ListEvaluationForms"></a>

Lists evaluation forms in the specified Amazon Connect instance.

## Request Syntax
<a name="API_ListEvaluationForms_RequestSyntax"></a>

```
GET /evaluation-forms/InstanceId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListEvaluationForms_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListEvaluationForms_RequestSyntax) **   <a name="connect-ListEvaluationForms-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListEvaluationForms_RequestSyntax) **   <a name="connect-ListEvaluationForms-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListEvaluationForms_RequestSyntax) **   <a name="connect-ListEvaluationForms-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListEvaluationForms_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListEvaluationForms_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EvaluationFormSummaryList": [ 
      { 
         "ActiveVersion": number,
         "CreatedBy": "string",
         "CreatedTime": number,
         "EvaluationFormArn": "string",
         "EvaluationFormId": "string",
         "LastActivatedBy": "string",
         "LastActivatedTime": number,
         "LastModifiedBy": "string",
         "LastModifiedTime": number,
         "LatestVersion": number,
         "Title": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListEvaluationForms_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EvaluationFormSummaryList](#API_ListEvaluationForms_ResponseSyntax) **   <a name="connect-ListEvaluationForms-response-EvaluationFormSummaryList"></a>
Provides details about a list of evaluation forms belonging to an instance.  
Type: Array of [EvaluationFormSummary](API_EvaluationFormSummary.md) objects

 ** [NextToken](#API_ListEvaluationForms_ResponseSyntax) **   <a name="connect-ListEvaluationForms-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_ListEvaluationForms_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_ListEvaluationForms_Examples"></a>

### Example
<a name="API_ListEvaluationForms_Example_1"></a>

The following example lists all the evaluation forms in an instance. It returns up to 2 results.

#### Sample Request
<a name="API_ListEvaluationForms_Example_1_Request"></a>

```
{
   "InstanceId": "[instance_id]",
   "MaxResults": 2
}
```

#### Sample Response
<a name="API_ListEvaluationForms_Example_1_Response"></a>

```
{
   "EvaluationFormSummaryList": [
      {
         "EvaluationFormId": "[evaluation_form_id]",
         "EvaluationFormArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/evaluation-form/[evaluation_form_id]",
         "Title": "form-title",
         "CreatedTime": "2023-05-04T00:24:01.490000-07:00",
         "CreatedBy": "arn:aws:sts::[account_id]:assumed-role/Admin/username",
         "LastModifiedTime": "2023-05-04T00:24:01.490000-07:00",
         "LastModifiedBy": "arn:aws:sts::[account_id]:assumed-role/Admin/username",
         "LatestVersion": 1
      },
      {
         "EvaluationFormId": "[evaluation_form_id]",
         "EvaluationFormArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/evaluation-form/[evaluation_form_id]",
         "Title": "form-title",
         "CreatedTime": "2023-05-04T00:23:55.047000-07:00",
         "CreatedBy": "arn:aws:sts::[account_id]:assumed-role/Admin/username",
         "LastModifiedTime": "2023-05-04T00:23:55.047000-07:00",
         "LastModifiedBy": "arn:aws:sts::[account_id]:assumed-role/Admin/username",
         "LatestVersion": 1
      }
   ],
   "NextToken": "QH7ftooIJZMpObgG6DlPwu/AAABGTCCARUGCSqGSIb"
}
```

## See Also
<a name="API_ListEvaluationForms_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListEvaluationForms) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListEvaluationForms) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListEvaluationForms) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListEvaluationForms) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListEvaluationForms) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListEvaluationForms) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListEvaluationForms) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListEvaluationForms) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListEvaluationForms) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListEvaluationForms) 

# ListEvaluationFormVersions
<a name="API_ListEvaluationFormVersions"></a>

Lists versions of an evaluation form in the specified Amazon Connect instance.

## Request Syntax
<a name="API_ListEvaluationFormVersions_RequestSyntax"></a>

```
GET /evaluation-forms/InstanceId/EvaluationFormId/versions?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListEvaluationFormVersions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [EvaluationFormId](#API_ListEvaluationFormVersions_RequestSyntax) **   <a name="connect-ListEvaluationFormVersions-request-uri-EvaluationFormId"></a>
The unique identifier for the evaluation form.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [InstanceId](#API_ListEvaluationFormVersions_RequestSyntax) **   <a name="connect-ListEvaluationFormVersions-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListEvaluationFormVersions_RequestSyntax) **   <a name="connect-ListEvaluationFormVersions-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListEvaluationFormVersions_RequestSyntax) **   <a name="connect-ListEvaluationFormVersions-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListEvaluationFormVersions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListEvaluationFormVersions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EvaluationFormVersionSummaryList": [ 
      { 
         "CreatedBy": "string",
         "CreatedTime": number,
         "EvaluationFormArn": "string",
         "EvaluationFormId": "string",
         "EvaluationFormVersion": number,
         "LastModifiedBy": "string",
         "LastModifiedTime": number,
         "Locked": boolean,
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListEvaluationFormVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EvaluationFormVersionSummaryList](#API_ListEvaluationFormVersions_ResponseSyntax) **   <a name="connect-ListEvaluationFormVersions-response-EvaluationFormVersionSummaryList"></a>
Provides details about a list of evaluation forms belonging to an instance.  
Type: Array of [EvaluationFormVersionSummary](API_EvaluationFormVersionSummary.md) objects

 ** [NextToken](#API_ListEvaluationFormVersions_ResponseSyntax) **   <a name="connect-ListEvaluationFormVersions-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_ListEvaluationFormVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_ListEvaluationFormVersions_Examples"></a>

### Example
<a name="API_ListEvaluationFormVersions_Example_1"></a>

The following example lists the versions of an evaluation form. It returns up to 2 results.

#### Sample Request
<a name="API_ListEvaluationFormVersions_Example_1_Request"></a>

```
{
   "InstanceId": "[instance_id]",
   "EvaluationFormId": "[evaluation_form_id]",
   "MaxResults": 2
}
```

#### Sample Response
<a name="API_ListEvaluationFormVersions_Example_1_Response"></a>

```
{
   "EvaluationFormVersionSummaryList": [
      {
         "EvaluationFormArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/evaluation-form/[evaluation_form_id]",
         "EvaluationFormId": "[evaluation_form_id]",
         "EvaluationFormVersion": 1,
         "Locked": true,
         "Status": "DRAFT",
         "CreatedTime": "2023-05-04T00:24:01.490000-07:00",
         "CreatedBy": "arn:aws:sts::[account_id]:assumed-role/Admin/username",
         "LastModifiedTime": "2023-05-04T00:24:01.490000-07:00",
         "LastModifiedBy": "arn:aws:sts::[account_id]:assumed-role/Admin/username"
      },
      {
         "EvaluationFormArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/evaluation-form/[evaluation_form_id]",
         "EvaluationFormId": "[evaluation_form_id]",
         "EvaluationFormVersion": 2,
         "Locked": true,
         "Status": "DRAFT",
         "CreatedTime": "2023-05-04T00:31:11.923000-07:00",
         "CreatedBy": "arn:aws:sts::[account_id]:assumed-role/Admin/username",
         "LastModifiedTime": "2023-05-04T00:31:11.923000-07:00",
         "LastModifiedBy": "arn:aws:sts::[account_id]:assumed-role/Admin/username"
      }
   ],
   "NextToken": "ki3y3ZDTAKfGXYllAAAAqjCBpwYJKoZIhvcNAQcGoIGZ"
}
```

## See Also
<a name="API_ListEvaluationFormVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListEvaluationFormVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListEvaluationFormVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListEvaluationFormVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListEvaluationFormVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListEvaluationFormVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListEvaluationFormVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListEvaluationFormVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListEvaluationFormVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListEvaluationFormVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListEvaluationFormVersions) 

# ListFlowAssociations
<a name="API_ListFlowAssociations"></a>

List the flow association based on the filters.

## Request Syntax
<a name="API_ListFlowAssociations_RequestSyntax"></a>

```
GET /flow-associations-summary/InstanceId?maxResults=MaxResults&nextToken=NextToken&ResourceType=ResourceType HTTP/1.1
```

## URI Request Parameters
<a name="API_ListFlowAssociations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListFlowAssociations_RequestSyntax) **   <a name="connect-ListFlowAssociations-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListFlowAssociations_RequestSyntax) **   <a name="connect-ListFlowAssociations-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListFlowAssociations_RequestSyntax) **   <a name="connect-ListFlowAssociations-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

 ** [ResourceType](#API_ListFlowAssociations_RequestSyntax) **   <a name="connect-ListFlowAssociations-request-uri-ResourceType"></a>
A valid resource type.  
Valid Values: `WHATSAPP_MESSAGING_PHONE_NUMBER | VOICE_PHONE_NUMBER | INBOUND_EMAIL | OUTBOUND_EMAIL | ANALYTICS_CONNECTOR` 

## Request Body
<a name="API_ListFlowAssociations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListFlowAssociations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "FlowAssociationSummaryList": [ 
      { 
         "FlowId": "string",
         "ResourceId": "string",
         "ResourceType": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListFlowAssociations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FlowAssociationSummaryList](#API_ListFlowAssociations_ResponseSyntax) **   <a name="connect-ListFlowAssociations-response-FlowAssociationSummaryList"></a>
Summary of flow associations.  
Type: Array of [FlowAssociationSummary](API_FlowAssociationSummary.md) objects

 ** [NextToken](#API_ListFlowAssociations_ResponseSyntax) **   <a name="connect-ListFlowAssociations-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_ListFlowAssociations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListFlowAssociations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListFlowAssociations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListFlowAssociations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListFlowAssociations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListFlowAssociations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListFlowAssociations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListFlowAssociations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListFlowAssociations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListFlowAssociations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListFlowAssociations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListFlowAssociations) 

# ListHoursOfOperationOverrides
<a name="API_ListHoursOfOperationOverrides"></a>

List the hours of operation overrides.

## Request Syntax
<a name="API_ListHoursOfOperationOverrides_RequestSyntax"></a>

```
GET /hours-of-operations/InstanceId/HoursOfOperationId/overrides?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListHoursOfOperationOverrides_RequestParameters"></a>

The request uses the following URI parameters.

 ** [HoursOfOperationId](#API_ListHoursOfOperationOverrides_RequestSyntax) **   <a name="connect-ListHoursOfOperationOverrides-request-uri-HoursOfOperationId"></a>
The identifier for the hours of operation.  
Required: Yes

 ** [InstanceId](#API_ListHoursOfOperationOverrides_RequestSyntax) **   <a name="connect-ListHoursOfOperationOverrides-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListHoursOfOperationOverrides_RequestSyntax) **   <a name="connect-ListHoursOfOperationOverrides-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListHoursOfOperationOverrides_RequestSyntax) **   <a name="connect-ListHoursOfOperationOverrides-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListHoursOfOperationOverrides_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListHoursOfOperationOverrides_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "HoursOfOperationOverrideList": [ 
      { 
         "Config": [ 
            { 
               "Day": "string",
               "EndTime": { 
                  "Hours": number,
                  "Minutes": number
               },
               "StartTime": { 
                  "Hours": number,
                  "Minutes": number
               }
            }
         ],
         "Description": "string",
         "EffectiveFrom": "string",
         "EffectiveTill": "string",
         "HoursOfOperationArn": "string",
         "HoursOfOperationId": "string",
         "HoursOfOperationOverrideId": "string",
         "Name": "string",
         "OverrideType": "string",
         "RecurrenceConfig": { 
            "RecurrencePattern": { 
               "ByMonth": [ number ],
               "ByMonthDay": [ number ],
               "ByWeekdayOccurrence": [ number ],
               "Frequency": "string",
               "Interval": number
            }
         }
      }
   ],
   "LastModifiedRegion": "string",
   "LastModifiedTime": number,
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListHoursOfOperationOverrides_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [HoursOfOperationOverrideList](#API_ListHoursOfOperationOverrides_ResponseSyntax) **   <a name="connect-ListHoursOfOperationOverrides-response-HoursOfOperationOverrideList"></a>
Information about the hours of operation override.  
Type: Array of [HoursOfOperationOverride](API_HoursOfOperationOverride.md) objects

 ** [LastModifiedRegion](#API_ListHoursOfOperationOverrides_ResponseSyntax) **   <a name="connect-ListHoursOfOperationOverrides-response-LastModifiedRegion"></a>
The AWS Region where this resource was last modified.  
Type: String  
Pattern: `[a-z]{2}(-[a-z]+){1,2}(-[0-9])?` 

 ** [LastModifiedTime](#API_ListHoursOfOperationOverrides_ResponseSyntax) **   <a name="connect-ListHoursOfOperationOverrides-response-LastModifiedTime"></a>
The timestamp when this resource was last modified.  
Type: Timestamp

 ** [NextToken](#API_ListHoursOfOperationOverrides_ResponseSyntax) **   <a name="connect-ListHoursOfOperationOverrides-response-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String

## Errors
<a name="API_ListHoursOfOperationOverrides_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListHoursOfOperationOverrides_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListHoursOfOperationOverrides) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListHoursOfOperationOverrides) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListHoursOfOperationOverrides) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListHoursOfOperationOverrides) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListHoursOfOperationOverrides) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListHoursOfOperationOverrides) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListHoursOfOperationOverrides) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListHoursOfOperationOverrides) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListHoursOfOperationOverrides) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListHoursOfOperationOverrides) 

# ListHoursOfOperations
<a name="API_ListHoursOfOperations"></a>

Provides information about the hours of operation for the specified Amazon Connect instance.

For more information about hours of operation, see [Set the Hours of Operation for a Queue](https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html) in the *Amazon Connect Administrator Guide*.

## Request Syntax
<a name="API_ListHoursOfOperations_RequestSyntax"></a>

```
GET /hours-of-operations-summary/InstanceId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListHoursOfOperations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListHoursOfOperations_RequestSyntax) **   <a name="connect-ListHoursOfOperations-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListHoursOfOperations_RequestSyntax) **   <a name="connect-ListHoursOfOperations-request-uri-MaxResults"></a>
The maximum number of results to return per page. The default MaxResult size is 100.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListHoursOfOperations_RequestSyntax) **   <a name="connect-ListHoursOfOperations-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListHoursOfOperations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListHoursOfOperations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "HoursOfOperationSummaryList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListHoursOfOperations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [HoursOfOperationSummaryList](#API_ListHoursOfOperations_ResponseSyntax) **   <a name="connect-ListHoursOfOperations-response-HoursOfOperationSummaryList"></a>
Information about the hours of operation.  
Type: Array of [HoursOfOperationSummary](API_HoursOfOperationSummary.md) objects

 ** [NextToken](#API_ListHoursOfOperations_ResponseSyntax) **   <a name="connect-ListHoursOfOperations-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_ListHoursOfOperations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListHoursOfOperations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListHoursOfOperations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListHoursOfOperations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListHoursOfOperations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListHoursOfOperations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListHoursOfOperations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListHoursOfOperations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListHoursOfOperations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListHoursOfOperations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListHoursOfOperations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListHoursOfOperations) 

# ListInstanceAttributes
<a name="API_ListInstanceAttributes"></a>

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all attribute types for the given instance.

## Request Syntax
<a name="API_ListInstanceAttributes_RequestSyntax"></a>

```
GET /instance/InstanceId/attributes?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListInstanceAttributes_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListInstanceAttributes_RequestSyntax) **   <a name="connect-ListInstanceAttributes-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListInstanceAttributes_RequestSyntax) **   <a name="connect-ListInstanceAttributes-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 7.

 ** [NextToken](#API_ListInstanceAttributes_RequestSyntax) **   <a name="connect-ListInstanceAttributes-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListInstanceAttributes_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListInstanceAttributes_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Attributes": [ 
      { 
         "AttributeType": "string",
         "Value": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListInstanceAttributes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Attributes](#API_ListInstanceAttributes_ResponseSyntax) **   <a name="connect-ListInstanceAttributes-response-Attributes"></a>
The attribute types.  
Type: Array of [Attribute](API_Attribute.md) objects

 ** [NextToken](#API_ListInstanceAttributes_ResponseSyntax) **   <a name="connect-ListInstanceAttributes-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_ListInstanceAttributes_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListInstanceAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListInstanceAttributes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListInstanceAttributes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListInstanceAttributes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListInstanceAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListInstanceAttributes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListInstanceAttributes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListInstanceAttributes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListInstanceAttributes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListInstanceAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListInstanceAttributes) 

# ListInstances
<a name="API_ListInstances"></a>

This API is in preview release for Amazon Connect and is subject to change.

Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.

## Request Syntax
<a name="API_ListInstances_RequestSyntax"></a>

```
GET /instance?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListInstances_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListInstances_RequestSyntax) **   <a name="connect-ListInstances-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 10.

 ** [NextToken](#API_ListInstances_RequestSyntax) **   <a name="connect-ListInstances-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListInstances_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListInstances_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "InstanceSummaryList": [ 
      { 
         "Arn": "string",
         "CreatedTime": number,
         "Id": "string",
         "IdentityManagementType": "string",
         "InboundCallsEnabled": boolean,
         "InstanceAccessUrl": "string",
         "InstanceAlias": "string",
         "InstanceStatus": "string",
         "OutboundCallsEnabled": boolean,
         "ServiceRole": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListInstances_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InstanceSummaryList](#API_ListInstances_ResponseSyntax) **   <a name="connect-ListInstances-response-InstanceSummaryList"></a>
Information about the instances.  
Type: Array of [InstanceSummary](API_InstanceSummary.md) objects

 ** [NextToken](#API_ListInstances_ResponseSyntax) **   <a name="connect-ListInstances-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_ListInstances_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

## See Also
<a name="API_ListInstances_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListInstances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListInstances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListInstances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListInstances) 

# ListInstanceStorageConfigs
<a name="API_ListInstanceStorageConfigs"></a>

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of storage configs for the identified instance and resource type.

## Request Syntax
<a name="API_ListInstanceStorageConfigs_RequestSyntax"></a>

```
GET /instance/InstanceId/storage-configs?maxResults=MaxResults&nextToken=NextToken&resourceType=ResourceType HTTP/1.1
```

## URI Request Parameters
<a name="API_ListInstanceStorageConfigs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListInstanceStorageConfigs_RequestSyntax) **   <a name="connect-ListInstanceStorageConfigs-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListInstanceStorageConfigs_RequestSyntax) **   <a name="connect-ListInstanceStorageConfigs-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 10.

 ** [NextToken](#API_ListInstanceStorageConfigs_RequestSyntax) **   <a name="connect-ListInstanceStorageConfigs-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

 ** [ResourceType](#API_ListInstanceStorageConfigs_RequestSyntax) **   <a name="connect-ListInstanceStorageConfigs-request-uri-ResourceType"></a>
A valid resource type.  
Valid Values: `CHAT_TRANSCRIPTS | CALL_RECORDINGS | SCHEDULED_REPORTS | MEDIA_STREAMS | CONTACT_TRACE_RECORDS | AGENT_EVENTS | REAL_TIME_CONTACT_ANALYSIS_SEGMENTS | ATTACHMENTS | CONTACT_EVALUATIONS | SCREEN_RECORDINGS | REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS | REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS | EMAIL_MESSAGES`   
Required: Yes

## Request Body
<a name="API_ListInstanceStorageConfigs_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListInstanceStorageConfigs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "StorageConfigs": [ 
      { 
         "AssociationId": "string",
         "KinesisFirehoseConfig": { 
            "FirehoseArn": "string"
         },
         "KinesisStreamConfig": { 
            "StreamArn": "string"
         },
         "KinesisVideoStreamConfig": { 
            "EncryptionConfig": { 
               "EncryptionType": "string",
               "KeyId": "string"
            },
            "Prefix": "string",
            "RetentionPeriodHours": number
         },
         "S3Config": { 
            "BucketName": "string",
            "BucketPrefix": "string",
            "EncryptionConfig": { 
               "EncryptionType": "string",
               "KeyId": "string"
            }
         },
         "StorageType": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListInstanceStorageConfigs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListInstanceStorageConfigs_ResponseSyntax) **   <a name="connect-ListInstanceStorageConfigs-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [StorageConfigs](#API_ListInstanceStorageConfigs_ResponseSyntax) **   <a name="connect-ListInstanceStorageConfigs-response-StorageConfigs"></a>
A valid storage type.  
Type: Array of [InstanceStorageConfig](API_InstanceStorageConfig.md) objects

## Errors
<a name="API_ListInstanceStorageConfigs_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListInstanceStorageConfigs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListInstanceStorageConfigs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListInstanceStorageConfigs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListInstanceStorageConfigs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListInstanceStorageConfigs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListInstanceStorageConfigs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListInstanceStorageConfigs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListInstanceStorageConfigs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListInstanceStorageConfigs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListInstanceStorageConfigs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListInstanceStorageConfigs) 

# ListIntegrationAssociations
<a name="API_ListIntegrationAssociations"></a>

Provides summary information about the AWS resource associations for the specified Amazon Connect instance.

## Request Syntax
<a name="API_ListIntegrationAssociations_RequestSyntax"></a>

```
GET /instance/InstanceId/integration-associations?integrationArn=IntegrationArn&integrationType=IntegrationType&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListIntegrationAssociations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListIntegrationAssociations_RequestSyntax) **   <a name="connect-ListIntegrationAssociations-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [IntegrationArn](#API_ListIntegrationAssociations_RequestSyntax) **   <a name="connect-ListIntegrationAssociations-request-uri-IntegrationArn"></a>
The Amazon Resource Name (ARN) of the integration.

 ** [IntegrationType](#API_ListIntegrationAssociations_RequestSyntax) **   <a name="connect-ListIntegrationAssociations-request-uri-IntegrationType"></a>
The integration type.  
Valid Values: `EVENT | VOICE_ID | PINPOINT_APP | WISDOM_ASSISTANT | WISDOM_KNOWLEDGE_BASE | WISDOM_QUICK_RESPONSES | Q_MESSAGE_TEMPLATES | CASES_DOMAIN | APPLICATION | FILE_SCANNER | SES_IDENTITY | ANALYTICS_CONNECTOR | CALL_TRANSFER_CONNECTOR | COGNITO_USER_POOL | MESSAGE_PROCESSOR` 

 ** [MaxResults](#API_ListIntegrationAssociations_RequestSyntax) **   <a name="connect-ListIntegrationAssociations-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListIntegrationAssociations_RequestSyntax) **   <a name="connect-ListIntegrationAssociations-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListIntegrationAssociations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListIntegrationAssociations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "IntegrationAssociationSummaryList": [ 
      { 
         "InstanceId": "string",
         "IntegrationArn": "string",
         "IntegrationAssociationArn": "string",
         "IntegrationAssociationId": "string",
         "IntegrationType": "string",
         "SourceApplicationName": "string",
         "SourceApplicationUrl": "string",
         "SourceType": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListIntegrationAssociations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [IntegrationAssociationSummaryList](#API_ListIntegrationAssociations_ResponseSyntax) **   <a name="connect-ListIntegrationAssociations-response-IntegrationAssociationSummaryList"></a>
The associations.  
Type: Array of [IntegrationAssociationSummary](API_IntegrationAssociationSummary.md) objects

 ** [NextToken](#API_ListIntegrationAssociations_ResponseSyntax) **   <a name="connect-ListIntegrationAssociations-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_ListIntegrationAssociations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListIntegrationAssociations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListIntegrationAssociations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListIntegrationAssociations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListIntegrationAssociations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListIntegrationAssociations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListIntegrationAssociations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListIntegrationAssociations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListIntegrationAssociations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListIntegrationAssociations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListIntegrationAssociations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListIntegrationAssociations) 

# ListLambdaFunctions
<a name="API_ListLambdaFunctions"></a>

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks.

## Request Syntax
<a name="API_ListLambdaFunctions_RequestSyntax"></a>

```
GET /instance/InstanceId/lambda-functions?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListLambdaFunctions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListLambdaFunctions_RequestSyntax) **   <a name="connect-ListLambdaFunctions-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListLambdaFunctions_RequestSyntax) **   <a name="connect-ListLambdaFunctions-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 25.

 ** [NextToken](#API_ListLambdaFunctions_RequestSyntax) **   <a name="connect-ListLambdaFunctions-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListLambdaFunctions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListLambdaFunctions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "LambdaFunctions": [ "string" ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListLambdaFunctions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LambdaFunctions](#API_ListLambdaFunctions_ResponseSyntax) **   <a name="connect-ListLambdaFunctions-response-LambdaFunctions"></a>
The Lambdafunction ARNs associated with the specified instance.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 140.

 ** [NextToken](#API_ListLambdaFunctions_ResponseSyntax) **   <a name="connect-ListLambdaFunctions-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_ListLambdaFunctions_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListLambdaFunctions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListLambdaFunctions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListLambdaFunctions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListLambdaFunctions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListLambdaFunctions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListLambdaFunctions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListLambdaFunctions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListLambdaFunctions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListLambdaFunctions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListLambdaFunctions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListLambdaFunctions) 

# ListLexBots
<a name="API_ListLexBots"></a>

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the [ListBots](https://docs.aws.amazon.com/connect/latest/APIReference/API_ListBots.html) API. 

## Request Syntax
<a name="API_ListLexBots_RequestSyntax"></a>

```
GET /instance/InstanceId/lex-bots?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListLexBots_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListLexBots_RequestSyntax) **   <a name="connect-ListLexBots-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListLexBots_RequestSyntax) **   <a name="connect-ListLexBots-request-uri-MaxResults"></a>
The maximum number of results to return per page. If no value is specified, the default is 10.   
Valid Range: Minimum value of 1. Maximum value of 25.

 ** [NextToken](#API_ListLexBots_RequestSyntax) **   <a name="connect-ListLexBots-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListLexBots_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListLexBots_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "LexBots": [ 
      { 
         "LexRegion": "string",
         "Name": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListLexBots_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LexBots](#API_ListLexBots_ResponseSyntax) **   <a name="connect-ListLexBots-response-LexBots"></a>
The names and AWS Regions of the Amazon Lex bots associated with the specified instance.  
Type: Array of [LexBot](API_LexBot.md) objects

 ** [NextToken](#API_ListLexBots_ResponseSyntax) **   <a name="connect-ListLexBots-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_ListLexBots_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListLexBots_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListLexBots) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListLexBots) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListLexBots) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListLexBots) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListLexBots) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListLexBots) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListLexBots) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListLexBots) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListLexBots) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListLexBots) 

# ListNotifications
<a name="API_ListNotifications"></a>

Retrieves a paginated list of all notifications in the Amazon Connect instance.

## Request Syntax
<a name="API_ListNotifications_RequestSyntax"></a>

```
GET /notifications/InstanceId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListNotifications_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListNotifications_RequestSyntax) **   <a name="connect-ListNotifications-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListNotifications_RequestSyntax) **   <a name="connect-ListNotifications-request-uri-MaxResults"></a>
The maximum number of results to return per page. Valid range is 1-100.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListNotifications_RequestSyntax) **   <a name="connect-ListNotifications-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response to retrieve the next page of results.

## Request Body
<a name="API_ListNotifications_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListNotifications_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "NotificationSummaryList": [ 
      { 
         "Arn": "string",
         "Content": { 
            "string" : "string" 
         },
         "CreatedAt": number,
         "ExpiresAt": number,
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Priority": "string",
         "Recipients": [ "string" ],
         "Tags": { 
            "string" : "string" 
         }
      }
   ]
}
```

## Response Elements
<a name="API_ListNotifications_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListNotifications_ResponseSyntax) **   <a name="connect-ListNotifications-response-NextToken"></a>
The token for the next set of results. If present, there are more results available.  
Type: String

 ** [NotificationSummaryList](#API_ListNotifications_ResponseSyntax) **   <a name="connect-ListNotifications-response-NotificationSummaryList"></a>
A list of notification summaries.  
Type: Array of [Notification](API_Notification.md) objects

## Errors
<a name="API_ListNotifications_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListNotifications_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListNotifications) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListNotifications) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListNotifications) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListNotifications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListNotifications) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListNotifications) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListNotifications) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListNotifications) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListNotifications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListNotifications) 

# ListPhoneNumbers
<a name="API_ListPhoneNumbers"></a>

Provides information about the phone numbers for the specified Amazon Connect instance. 

For more information about phone numbers, see [Set Up Phone Numbers for Your Contact Center](https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html) in the *Amazon Connect Administrator Guide*.

**Important**  
We recommend using [ListPhoneNumbersV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html) to return phone number types. ListPhoneNumbers doesn't support number types `UIFN`, `SHARED`, `THIRD_PARTY_TF`, and `THIRD_PARTY_DID`. While it returns numbers of those types, it incorrectly lists them as `TOLL_FREE` or `DID`. 
The phone number `Arn` value that is returned from each of the items in the [PhoneNumberSummaryList](https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbers.html#connect-ListPhoneNumbers-response-PhoneNumberSummaryList) cannot be used to tag phone number resources. It will fail with a `ResourceNotFoundException`. Instead, use the [ListPhoneNumbersV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html) API. It returns the new phone number ARN that can be used to tag phone number resources.

## Request Syntax
<a name="API_ListPhoneNumbers_RequestSyntax"></a>

```
GET /phone-numbers-summary/InstanceId?maxResults=MaxResults&nextToken=NextToken&phoneNumberCountryCodes=PhoneNumberCountryCodes&phoneNumberTypes=PhoneNumberTypes HTTP/1.1
```

## URI Request Parameters
<a name="API_ListPhoneNumbers_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListPhoneNumbers_RequestSyntax) **   <a name="connect-ListPhoneNumbers-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListPhoneNumbers_RequestSyntax) **   <a name="connect-ListPhoneNumbers-request-uri-MaxResults"></a>
The maximum number of results to return per page. The default MaxResult size is 100.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListPhoneNumbers_RequestSyntax) **   <a name="connect-ListPhoneNumbers-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

 ** [PhoneNumberCountryCodes](#API_ListPhoneNumbers_RequestSyntax) **   <a name="connect-ListPhoneNumbers-request-uri-PhoneNumberCountryCodes"></a>
The ISO country code.  
Array Members: Maximum number of 10 items.  
Valid Values: `AF | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU | AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BA | BW | BR | IO | VG | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL | CN | CX | CC | CO | KM | CK | CR | HR | CU | CW | CY | CZ | CD | DK | DJ | DM | DO | TL | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR | PF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GU | GT | GG | GN | GW | GY | HT | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | CI | JM | JP | JE | JO | KZ | KE | KI | KW | KG | LA | LV | LB | LS | LR | LY | LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MR | MU | YT | MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | AN | NC | NZ | NI | NE | NG | NU | KP | MP | NO | OM | PK | PW | PA | PG | PY | PE | PH | PN | PL | PT | PR | QA | CG | RE | RO | RU | RW | BL | SH | KN | LC | MF | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SX | SK | SI | SB | SO | ZA | KR | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TW | TJ | TZ | TH | TG | TK | TO | TT | TN | TR | TM | TC | TV | VI | UG | UA | AE | GB | US | UY | UZ | VU | VA | VE | VN | WF | EH | YE | ZM | ZW` 

 ** [PhoneNumberTypes](#API_ListPhoneNumbers_RequestSyntax) **   <a name="connect-ListPhoneNumbers-request-uri-PhoneNumberTypes"></a>
The type of phone number.  
We recommend using [ListPhoneNumbersV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html) to return phone number types. While ListPhoneNumbers returns number types `UIFN`, `SHARED`, `THIRD_PARTY_TF`, and `THIRD_PARTY_DID`, it incorrectly lists them as `TOLL_FREE` or `DID`. 
Array Members: Maximum number of 6 items.  
Valid Values: `TOLL_FREE | DID | UIFN | SHARED | THIRD_PARTY_TF | THIRD_PARTY_DID | SHORT_CODE` 

## Request Body
<a name="API_ListPhoneNumbers_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListPhoneNumbers_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "PhoneNumberSummaryList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "PhoneNumber": "string",
         "PhoneNumberCountryCode": "string",
         "PhoneNumberType": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListPhoneNumbers_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListPhoneNumbers_ResponseSyntax) **   <a name="connect-ListPhoneNumbers-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [PhoneNumberSummaryList](#API_ListPhoneNumbers_ResponseSyntax) **   <a name="connect-ListPhoneNumbers-response-PhoneNumberSummaryList"></a>
Information about the phone numbers.  
Type: Array of [PhoneNumberSummary](API_PhoneNumberSummary.md) objects

## Errors
<a name="API_ListPhoneNumbers_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListPhoneNumbers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListPhoneNumbers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListPhoneNumbers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListPhoneNumbers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListPhoneNumbers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListPhoneNumbers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListPhoneNumbers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListPhoneNumbers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListPhoneNumbers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListPhoneNumbers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListPhoneNumbers) 

# ListPhoneNumbersV2
<a name="API_ListPhoneNumbersV2"></a>

Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided `TargetArn` is a traffic distribution group, you can call this API in both AWS Regions associated with traffic distribution group.

For more information about phone numbers, see [Set Up Phone Numbers for Your Contact Center](https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html) in the *Amazon Connect Administrator Guide*.

**Note**  
When given an instance ARN, `ListPhoneNumbersV2` returns only the phone numbers claimed to the instance.
When given a traffic distribution group ARN `ListPhoneNumbersV2` returns only the phone numbers claimed to the traffic distribution group.

## Request Syntax
<a name="API_ListPhoneNumbersV2_RequestSyntax"></a>

```
POST /phone-number/list HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "PhoneNumberCountryCodes": [ "string" ],
   "PhoneNumberPrefix": "string",
   "PhoneNumberTypes": [ "string" ],
   "TargetArn": "string"
}
```

## URI Request Parameters
<a name="API_ListPhoneNumbersV2_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ListPhoneNumbersV2_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_ListPhoneNumbersV2_RequestSyntax) **   <a name="connect-ListPhoneNumbersV2-request-InstanceId"></a>
The identifier of the Amazon Connect instance that phone numbers are claimed to. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance. If both `TargetArn` and `InstanceId` are not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same AWS Region as the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [MaxResults](#API_ListPhoneNumbersV2_RequestSyntax) **   <a name="connect-ListPhoneNumbersV2-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [NextToken](#API_ListPhoneNumbersV2_RequestSyntax) **   <a name="connect-ListPhoneNumbersV2-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100000.  
Required: No

 ** [PhoneNumberCountryCodes](#API_ListPhoneNumbersV2_RequestSyntax) **   <a name="connect-ListPhoneNumbersV2-request-PhoneNumberCountryCodes"></a>
The ISO country code.  
Type: Array of strings  
Array Members: Maximum number of 10 items.  
Valid Values: `AF | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU | AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BA | BW | BR | IO | VG | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL | CN | CX | CC | CO | KM | CK | CR | HR | CU | CW | CY | CZ | CD | DK | DJ | DM | DO | TL | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR | PF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GU | GT | GG | GN | GW | GY | HT | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | CI | JM | JP | JE | JO | KZ | KE | KI | KW | KG | LA | LV | LB | LS | LR | LY | LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MR | MU | YT | MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | AN | NC | NZ | NI | NE | NG | NU | KP | MP | NO | OM | PK | PW | PA | PG | PY | PE | PH | PN | PL | PT | PR | QA | CG | RE | RO | RU | RW | BL | SH | KN | LC | MF | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SX | SK | SI | SB | SO | ZA | KR | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TW | TJ | TZ | TH | TG | TK | TO | TT | TN | TR | TM | TC | TV | VI | UG | UA | AE | GB | US | UY | UZ | VU | VA | VE | VN | WF | EH | YE | ZM | ZW`   
Required: No

 ** [PhoneNumberPrefix](#API_ListPhoneNumbersV2_RequestSyntax) **   <a name="connect-ListPhoneNumbersV2-request-PhoneNumberPrefix"></a>
The prefix of the phone number. If provided, it must contain `+` as part of the country code.  
Type: String  
Pattern: `\\+?[0-9]{1,11}`   
Required: No

 ** [PhoneNumberTypes](#API_ListPhoneNumbersV2_RequestSyntax) **   <a name="connect-ListPhoneNumbersV2-request-PhoneNumberTypes"></a>
The type of phone number.  
Type: Array of strings  
Array Members: Maximum number of 6 items.  
Valid Values: `TOLL_FREE | DID | UIFN | SHARED | THIRD_PARTY_TF | THIRD_PARTY_DID | SHORT_CODE`   
Required: No

 ** [TargetArn](#API_ListPhoneNumbersV2_RequestSyntax) **   <a name="connect-ListPhoneNumbersV2-request-TargetArn"></a>
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. If both `TargetArn` and `InstanceId` input are not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same AWS Region as the request.  
Type: String  
Required: No

## Response Syntax
<a name="API_ListPhoneNumbersV2_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ListPhoneNumbersSummaryList": [ 
      { 
         "InstanceId": "string",
         "PhoneNumber": "string",
         "PhoneNumberArn": "string",
         "PhoneNumberCountryCode": "string",
         "PhoneNumberDescription": "string",
         "PhoneNumberId": "string",
         "PhoneNumberType": "string",
         "SourcePhoneNumberArn": "string",
         "TargetArn": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListPhoneNumbersV2_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ListPhoneNumbersSummaryList](#API_ListPhoneNumbersV2_ResponseSyntax) **   <a name="connect-ListPhoneNumbersV2-response-ListPhoneNumbersSummaryList"></a>
Information about phone numbers that have been claimed to your Amazon Connect instances or traffic distribution groups.  
Type: Array of [ListPhoneNumbersSummary](API_ListPhoneNumbersSummary.md) objects

 ** [NextToken](#API_ListPhoneNumbersV2_ResponseSyntax) **   <a name="connect-ListPhoneNumbersV2-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100000.

## Errors
<a name="API_ListPhoneNumbersV2_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListPhoneNumbersV2_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListPhoneNumbersV2) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListPhoneNumbersV2) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListPhoneNumbersV2) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListPhoneNumbersV2) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListPhoneNumbersV2) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListPhoneNumbersV2) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListPhoneNumbersV2) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListPhoneNumbersV2) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListPhoneNumbersV2) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListPhoneNumbersV2) 

# ListPredefinedAttributes
<a name="API_ListPredefinedAttributes"></a>

Lists predefined attributes for the specified Amazon Connect instance. A *predefined attribute* is made up of a name and a value. You can use predefined attributes for:
+ Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see [Create predefined attributes for routing contacts to agents](https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html).
+ Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see [Use contact segment attributes](https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html).

For the predefined attributes per instance quota, see [Amazon Connect quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas).

 **Endpoints**: See [Amazon Connect endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/connect_region.html).

## Request Syntax
<a name="API_ListPredefinedAttributes_RequestSyntax"></a>

```
GET /predefined-attributes/InstanceId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListPredefinedAttributes_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListPredefinedAttributes_RequestSyntax) **   <a name="connect-ListPredefinedAttributes-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListPredefinedAttributes_RequestSyntax) **   <a name="connect-ListPredefinedAttributes-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListPredefinedAttributes_RequestSyntax) **   <a name="connect-ListPredefinedAttributes-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListPredefinedAttributes_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListPredefinedAttributes_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "PredefinedAttributeSummaryList": [ 
      { 
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListPredefinedAttributes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListPredefinedAttributes_ResponseSyntax) **   <a name="connect-ListPredefinedAttributes-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [PredefinedAttributeSummaryList](#API_ListPredefinedAttributes_ResponseSyntax) **   <a name="connect-ListPredefinedAttributes-response-PredefinedAttributeSummaryList"></a>
Summary of the predefined attributes.  
Type: Array of [PredefinedAttributeSummary](API_PredefinedAttributeSummary.md) objects

## Errors
<a name="API_ListPredefinedAttributes_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_ListPredefinedAttributes_Examples"></a>

### Example
<a name="API_ListPredefinedAttributes_Example_1"></a>

The following example shows a request and response.

```
GET https://connect.us-west-2.amazonaws.com/predefined-attributes/InstanceId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

Response:
{
    "NextToken": null,
    "PredefinedAttributeSummaryList": [
        {
            "LastModifiedRegion": "us-west-2",
            "LastModifiedTime": 1.75691948693E9,
            "Name": "Name1"
        },
        {
            "LastModifiedRegion": "us-west-2",
            "LastModifiedTime": 1.756919487004E9,
            "Name": "Name2
    ]
}
```

## See Also
<a name="API_ListPredefinedAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListPredefinedAttributes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListPredefinedAttributes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListPredefinedAttributes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListPredefinedAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListPredefinedAttributes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListPredefinedAttributes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListPredefinedAttributes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListPredefinedAttributes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListPredefinedAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListPredefinedAttributes) 

# ListPrompts
<a name="API_ListPrompts"></a>

Provides information about the prompts for the specified Amazon Connect instance.

## Request Syntax
<a name="API_ListPrompts_RequestSyntax"></a>

```
GET /prompts-summary/InstanceId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListPrompts_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListPrompts_RequestSyntax) **   <a name="connect-ListPrompts-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListPrompts_RequestSyntax) **   <a name="connect-ListPrompts-request-uri-MaxResults"></a>
The maximum number of results to return per page. The default MaxResult size is 100.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListPrompts_RequestSyntax) **   <a name="connect-ListPrompts-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListPrompts_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListPrompts_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "PromptSummaryList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListPrompts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListPrompts_ResponseSyntax) **   <a name="connect-ListPrompts-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [PromptSummaryList](#API_ListPrompts_ResponseSyntax) **   <a name="connect-ListPrompts-response-PromptSummaryList"></a>
Information about the prompts.  
Type: Array of [PromptSummary](API_PromptSummary.md) objects

## Errors
<a name="API_ListPrompts_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListPrompts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListPrompts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListPrompts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListPrompts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListPrompts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListPrompts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListPrompts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListPrompts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListPrompts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListPrompts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListPrompts) 

# ListQueueEmailAddresses
<a name="API_ListQueueEmailAddresses"></a>

Lists all email addresses that are currently associated with a specific queue, providing details about which "From" email addresses agents can select when handling email contacts. This helps administrators manage agent email address options and understand the available choices for different brands and business units.

 **Important things to know** 
+ The response includes metadata about each email address available for agent selection, including whether it's configured as the default outbound email.
+ Agents can select from these email addresses when replying to inbound contacts or initiating outbound contacts in this queue.
+ The list includes both explicitly associated email addresses and any default outbound email address configured for the queue.
+ Results are paginated to handle queues with many associated email addresses (up to 50 per queue).

## Request Syntax
<a name="API_ListQueueEmailAddresses_RequestSyntax"></a>

```
GET /queues/InstanceId/QueueId/email-addresses?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListQueueEmailAddresses_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListQueueEmailAddresses_RequestSyntax) **   <a name="connect-ListQueueEmailAddresses-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListQueueEmailAddresses_RequestSyntax) **   <a name="connect-ListQueueEmailAddresses-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListQueueEmailAddresses_RequestSyntax) **   <a name="connect-ListQueueEmailAddresses-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

 ** [QueueId](#API_ListQueueEmailAddresses_RequestSyntax) **   <a name="connect-ListQueueEmailAddresses-request-uri-QueueId"></a>
The identifier for the queue.  
Required: Yes

## Request Body
<a name="API_ListQueueEmailAddresses_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListQueueEmailAddresses_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EmailAddressMetadataList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "IsDefaultOutboundEmail": boolean
      }
   ],
   "LastModifiedRegion": "string",
   "LastModifiedTime": number,
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListQueueEmailAddresses_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EmailAddressMetadataList](#API_ListQueueEmailAddresses_ResponseSyntax) **   <a name="connect-ListQueueEmailAddresses-response-EmailAddressMetadataList"></a>
List of email address summary information for all email addresses associated with the queue. Each item contains the email address identifier, ARN, and configuration details.  
Type: Array of [EmailAddressSummary](API_EmailAddressSummary.md) objects

 ** [LastModifiedRegion](#API_ListQueueEmailAddresses_ResponseSyntax) **   <a name="connect-ListQueueEmailAddresses-response-LastModifiedRegion"></a>
The AWS Region where this resource was last modified.  
Type: String  
Pattern: `[a-z]{2}(-[a-z]+){1,2}(-[0-9])?` 

 ** [LastModifiedTime](#API_ListQueueEmailAddresses_ResponseSyntax) **   <a name="connect-ListQueueEmailAddresses-response-LastModifiedTime"></a>
The timestamp when this resource was last modified.  
Type: Timestamp

 ** [NextToken](#API_ListQueueEmailAddresses_ResponseSyntax) **   <a name="connect-ListQueueEmailAddresses-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_ListQueueEmailAddresses_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListQueueEmailAddresses_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListQueueEmailAddresses) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListQueueEmailAddresses) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListQueueEmailAddresses) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListQueueEmailAddresses) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListQueueEmailAddresses) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListQueueEmailAddresses) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListQueueEmailAddresses) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListQueueEmailAddresses) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListQueueEmailAddresses) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListQueueEmailAddresses) 

# ListQueueQuickConnects
<a name="API_ListQueueQuickConnects"></a>

Lists the quick connects associated with a queue.

## Request Syntax
<a name="API_ListQueueQuickConnects_RequestSyntax"></a>

```
GET /queues/InstanceId/QueueId/quick-connects?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListQueueQuickConnects_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListQueueQuickConnects_RequestSyntax) **   <a name="connect-ListQueueQuickConnects-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListQueueQuickConnects_RequestSyntax) **   <a name="connect-ListQueueQuickConnects-request-uri-MaxResults"></a>
The maximum number of results to return per page. The default MaxResult size is 100.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListQueueQuickConnects_RequestSyntax) **   <a name="connect-ListQueueQuickConnects-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

 ** [QueueId](#API_ListQueueQuickConnects_RequestSyntax) **   <a name="connect-ListQueueQuickConnects-request-uri-QueueId"></a>
The identifier for the queue.  
Required: Yes

## Request Body
<a name="API_ListQueueQuickConnects_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListQueueQuickConnects_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "LastModifiedRegion": "string",
   "LastModifiedTime": number,
   "NextToken": "string",
   "QuickConnectSummaryList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string",
         "QuickConnectType": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListQueueQuickConnects_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LastModifiedRegion](#API_ListQueueQuickConnects_ResponseSyntax) **   <a name="connect-ListQueueQuickConnects-response-LastModifiedRegion"></a>
The AWS Region where this resource was last modified.  
Type: String  
Pattern: `[a-z]{2}(-[a-z]+){1,2}(-[0-9])?` 

 ** [LastModifiedTime](#API_ListQueueQuickConnects_ResponseSyntax) **   <a name="connect-ListQueueQuickConnects-response-LastModifiedTime"></a>
The timestamp when this resource was last modified.  
Type: Timestamp

 ** [NextToken](#API_ListQueueQuickConnects_ResponseSyntax) **   <a name="connect-ListQueueQuickConnects-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [QuickConnectSummaryList](#API_ListQueueQuickConnects_ResponseSyntax) **   <a name="connect-ListQueueQuickConnects-response-QuickConnectSummaryList"></a>
Information about the quick connects.  
Type: Array of [QuickConnectSummary](API_QuickConnectSummary.md) objects

## Errors
<a name="API_ListQueueQuickConnects_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListQueueQuickConnects_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListQueueQuickConnects) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListQueueQuickConnects) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListQueueQuickConnects) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListQueueQuickConnects) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListQueueQuickConnects) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListQueueQuickConnects) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListQueueQuickConnects) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListQueueQuickConnects) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListQueueQuickConnects) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListQueueQuickConnects) 

# ListQueues
<a name="API_ListQueues"></a>

Provides information about the queues for the specified Amazon Connect instance.

If you do not specify a `QueueTypes` parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.

For more information about queues, see [Queues: Standard and Agent](https://docs.aws.amazon.com/connect/latest/adminguide/concepts-queues-standard-and-agent.html) in the *Amazon Connect Administrator Guide*.

## Request Syntax
<a name="API_ListQueues_RequestSyntax"></a>

```
GET /queues-summary/InstanceId?maxResults=MaxResults&nextToken=NextToken&queueTypes=QueueTypes HTTP/1.1
```

## URI Request Parameters
<a name="API_ListQueues_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListQueues_RequestSyntax) **   <a name="connect-ListQueues-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListQueues_RequestSyntax) **   <a name="connect-ListQueues-request-uri-MaxResults"></a>
The maximum number of results to return per page. The default MaxResult size is 100.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListQueues_RequestSyntax) **   <a name="connect-ListQueues-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

 ** [QueueTypes](#API_ListQueues_RequestSyntax) **   <a name="connect-ListQueues-request-uri-QueueTypes"></a>
The type of queue.  
Array Members: Maximum number of 2 items.  
Valid Values: `STANDARD | AGENT` 

## Request Body
<a name="API_ListQueues_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListQueues_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "QueueSummaryList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string",
         "QueueType": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListQueues_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListQueues_ResponseSyntax) **   <a name="connect-ListQueues-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [QueueSummaryList](#API_ListQueues_ResponseSyntax) **   <a name="connect-ListQueues-response-QueueSummaryList"></a>
Information about the queues.  
Type: Array of [QueueSummary](API_QueueSummary.md) objects

## Errors
<a name="API_ListQueues_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListQueues_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListQueues) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListQueues) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListQueues) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListQueues) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListQueues) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListQueues) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListQueues) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListQueues) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListQueues) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListQueues) 

# ListQuickConnects
<a name="API_ListQuickConnects"></a>

Provides information about the quick connects for the specified Amazon Connect instance. 

## Request Syntax
<a name="API_ListQuickConnects_RequestSyntax"></a>

```
GET /quick-connects/InstanceId?maxResults=MaxResults&nextToken=NextToken&QuickConnectTypes=QuickConnectTypes HTTP/1.1
```

## URI Request Parameters
<a name="API_ListQuickConnects_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListQuickConnects_RequestSyntax) **   <a name="connect-ListQuickConnects-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance. Both Instance ID and Instance ARN are supported input formats.   
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListQuickConnects_RequestSyntax) **   <a name="connect-ListQuickConnects-request-uri-MaxResults"></a>
The maximum number of results to return per page. The default MaxResult size is 100.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListQuickConnects_RequestSyntax) **   <a name="connect-ListQuickConnects-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

 ** [QuickConnectTypes](#API_ListQuickConnects_RequestSyntax) **   <a name="connect-ListQuickConnects-request-uri-QuickConnectTypes"></a>
The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE\$1NUMBER), or Queue (QUEUE).  
Array Members: Maximum number of 4 items.  
Valid Values: `USER | QUEUE | PHONE_NUMBER | FLOW` 

## Request Body
<a name="API_ListQuickConnects_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListQuickConnects_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "QuickConnectSummaryList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string",
         "QuickConnectType": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListQuickConnects_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListQuickConnects_ResponseSyntax) **   <a name="connect-ListQuickConnects-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [QuickConnectSummaryList](#API_ListQuickConnects_ResponseSyntax) **   <a name="connect-ListQuickConnects-response-QuickConnectSummaryList"></a>
Information about the quick connects.  
Type: Array of [QuickConnectSummary](API_QuickConnectSummary.md) objects

## Errors
<a name="API_ListQuickConnects_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListQuickConnects_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListQuickConnects) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListQuickConnects) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListQuickConnects) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListQuickConnects) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListQuickConnects) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListQuickConnects) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListQuickConnects) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListQuickConnects) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListQuickConnects) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListQuickConnects) 

# ListRealtimeContactAnalysisSegmentsV2
<a name="API_ListRealtimeContactAnalysisSegmentsV2"></a>

Provides a list of analysis segments for a real-time chat analysis session. This API supports CHAT channels only. 

**Important**  
This API does not support VOICE. If you attempt to use it for VOICE, an `InvalidRequestException` occurs.

## Request Syntax
<a name="API_ListRealtimeContactAnalysisSegmentsV2_RequestSyntax"></a>

```
POST /contact/list-real-time-analysis-segments-v2/InstanceId/ContactId HTTP/1.1
Content-type: application/json

{
   "MaxResults": number,
   "NextToken": "string",
   "OutputType": "string",
   "SegmentTypes": [ "string" ]
}
```

## URI Request Parameters
<a name="API_ListRealtimeContactAnalysisSegmentsV2_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactId](#API_ListRealtimeContactAnalysisSegmentsV2_RequestSyntax) **   <a name="connect-ListRealtimeContactAnalysisSegmentsV2-request-uri-ContactId"></a>
The identifier of the contact in this instance of Amazon Connect.   
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_ListRealtimeContactAnalysisSegmentsV2_RequestSyntax) **   <a name="connect-ListRealtimeContactAnalysisSegmentsV2-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_ListRealtimeContactAnalysisSegmentsV2_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [MaxResults](#API_ListRealtimeContactAnalysisSegmentsV2_RequestSyntax) **   <a name="connect-ListRealtimeContactAnalysisSegmentsV2-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListRealtimeContactAnalysisSegmentsV2_RequestSyntax) **   <a name="connect-ListRealtimeContactAnalysisSegmentsV2-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100000.  
Required: No

 ** [OutputType](#API_ListRealtimeContactAnalysisSegmentsV2_RequestSyntax) **   <a name="connect-ListRealtimeContactAnalysisSegmentsV2-request-OutputType"></a>
The Contact Lens output type to be returned.  
Type: String  
Valid Values: `Raw | Redacted`   
Required: Yes

 ** [SegmentTypes](#API_ListRealtimeContactAnalysisSegmentsV2_RequestSyntax) **   <a name="connect-ListRealtimeContactAnalysisSegmentsV2-request-SegmentTypes"></a>
Enum with segment types . Each value corresponds to a segment type returned in the segments list of the API. Each segment type has its own structure. Different channels may have different sets of supported segment types.  
Type: Array of strings  
Array Members: Maximum number of 6 items.  
Valid Values: `Transcript | Categories | Issues | Event | Attachments | PostContactSummary`   
Required: Yes

## Response Syntax
<a name="API_ListRealtimeContactAnalysisSegmentsV2_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Channel": "string",
   "NextToken": "string",
   "Segments": [ 
      { ... }
   ],
   "Status": "string"
}
```

## Response Elements
<a name="API_ListRealtimeContactAnalysisSegmentsV2_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Channel](#API_ListRealtimeContactAnalysisSegmentsV2_ResponseSyntax) **   <a name="connect-ListRealtimeContactAnalysisSegmentsV2-response-Channel"></a>
The channel of the contact.   
Only `CHAT` is supported. This API does not support `VOICE`. If you attempt to use it for the VOICE channel, an `InvalidRequestException` error occurs.
Type: String  
Valid Values: `VOICE | CHAT` 

 ** [NextToken](#API_ListRealtimeContactAnalysisSegmentsV2_ResponseSyntax) **   <a name="connect-ListRealtimeContactAnalysisSegmentsV2-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100000.

 ** [Segments](#API_ListRealtimeContactAnalysisSegmentsV2_ResponseSyntax) **   <a name="connect-ListRealtimeContactAnalysisSegmentsV2-response-Segments"></a>
An analyzed transcript or category.  
Type: Array of [RealtimeContactAnalysisSegment](API_RealtimeContactAnalysisSegment.md) objects

 ** [Status](#API_ListRealtimeContactAnalysisSegmentsV2_ResponseSyntax) **   <a name="connect-ListRealtimeContactAnalysisSegmentsV2-response-Status"></a>
Status of real-time contact analysis.  
Type: String  
Valid Values: `IN_PROGRESS | FAILED | COMPLETED` 

## Errors
<a name="API_ListRealtimeContactAnalysisSegmentsV2_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** OutputTypeNotFoundException **   
Thrown for analyzed content when requested OutputType was not enabled for a given contact. For example, if an OutputType.Raw was requested for a contact that had `RedactedOnly` Redaction policy set in the flow.  
HTTP Status Code: 404

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListRealtimeContactAnalysisSegmentsV2_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListRealtimeContactAnalysisSegmentsV2) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListRealtimeContactAnalysisSegmentsV2) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListRealtimeContactAnalysisSegmentsV2) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListRealtimeContactAnalysisSegmentsV2) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListRealtimeContactAnalysisSegmentsV2) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListRealtimeContactAnalysisSegmentsV2) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListRealtimeContactAnalysisSegmentsV2) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListRealtimeContactAnalysisSegmentsV2) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListRealtimeContactAnalysisSegmentsV2) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListRealtimeContactAnalysisSegmentsV2) 

# ListRoutingProfileManualAssignmentQueues
<a name="API_ListRoutingProfileManualAssignmentQueues"></a>

Lists the manual assignment queues associated with a routing profile.

 **Use cases** 

Following are common uses cases for this API:
+ This API returns list of queues where contacts can be manually assigned or picked by an agent who has access to the Worklist app. The user can additionally filter on queues, if they have access to those queues (otherwise a invalid request exception will be thrown).

  For information about how manual contact assignment works in the agent workspace, see the [Access the Worklist app in the Amazon Connect agent workspace](https://docs.aws.amazon.com/connect/latest/adminguide/worklist-app.html) in the *Amazon Connect Administrator Guide*. 

 **Important things to know** 
+ This API only returns the manual assignment queues associated with a routing profile. Use the ListRoutingProfileQueues API to list the auto assignment queues for the routing profile.

 **Endpoints**: See [Amazon Connect endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/connect_region.html).

## Request Syntax
<a name="API_ListRoutingProfileManualAssignmentQueues_RequestSyntax"></a>

```
GET /routing-profiles/InstanceId/RoutingProfileId/manual-assignment-queues?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListRoutingProfileManualAssignmentQueues_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListRoutingProfileManualAssignmentQueues_RequestSyntax) **   <a name="connect-ListRoutingProfileManualAssignmentQueues-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListRoutingProfileManualAssignmentQueues_RequestSyntax) **   <a name="connect-ListRoutingProfileManualAssignmentQueues-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListRoutingProfileManualAssignmentQueues_RequestSyntax) **   <a name="connect-ListRoutingProfileManualAssignmentQueues-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

 ** [RoutingProfileId](#API_ListRoutingProfileManualAssignmentQueues_RequestSyntax) **   <a name="connect-ListRoutingProfileManualAssignmentQueues-request-uri-RoutingProfileId"></a>
The identifier of the routing profile.  
Required: Yes

## Request Body
<a name="API_ListRoutingProfileManualAssignmentQueues_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListRoutingProfileManualAssignmentQueues_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "LastModifiedRegion": "string",
   "LastModifiedTime": number,
   "NextToken": "string",
   "RoutingProfileManualAssignmentQueueConfigSummaryList": [ 
      { 
         "Channel": "string",
         "QueueArn": "string",
         "QueueId": "string",
         "QueueName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListRoutingProfileManualAssignmentQueues_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LastModifiedRegion](#API_ListRoutingProfileManualAssignmentQueues_ResponseSyntax) **   <a name="connect-ListRoutingProfileManualAssignmentQueues-response-LastModifiedRegion"></a>
The AWS Region where this resource was last modified.  
Type: String  
Pattern: `[a-z]{2}(-[a-z]+){1,2}(-[0-9])?` 

 ** [LastModifiedTime](#API_ListRoutingProfileManualAssignmentQueues_ResponseSyntax) **   <a name="connect-ListRoutingProfileManualAssignmentQueues-response-LastModifiedTime"></a>
The timestamp when this resource was last modified.  
Type: Timestamp

 ** [NextToken](#API_ListRoutingProfileManualAssignmentQueues_ResponseSyntax) **   <a name="connect-ListRoutingProfileManualAssignmentQueues-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [RoutingProfileManualAssignmentQueueConfigSummaryList](#API_ListRoutingProfileManualAssignmentQueues_ResponseSyntax) **   <a name="connect-ListRoutingProfileManualAssignmentQueues-response-RoutingProfileManualAssignmentQueueConfigSummaryList"></a>
Information about the manual assignment queues associated with the routing profile.  
Type: Array of [RoutingProfileManualAssignmentQueueConfigSummary](API_RoutingProfileManualAssignmentQueueConfigSummary.md) objects

## Errors
<a name="API_ListRoutingProfileManualAssignmentQueues_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_ListRoutingProfileManualAssignmentQueues_Examples"></a>

### Example request to retrieve the manual assignment queues
<a name="API_ListRoutingProfileManualAssignmentQueues_Example_1"></a>

Provide instanceId and routingProfileId for which you want to retrieve the manual assignment queues. You can optionally provide MaxResults parameter. 

```
PUT https://connect.us-west-2.amazonaws.com/routing-profiles/{{instance_id}}/{{routingProfileId}}/manual-assignment-queues HTTP/1.1 Content-type: application/json
{
     "MaxResults": 1
}
```

### Example response to list the manual assignment queues
<a name="API_ListRoutingProfileManualAssignmentQueues_Example_2"></a>

 Lists the manual assignment queues associated with the `routingProfileId`. Includes only one result since MaxResults parameter was 1. Also includes a NextToken, which can be used as input to fetch the remaining results. 

```
{
    "LastModifiedRegion": "us-west-2",
    "LastModifiedTime": 1.75735455979E9,
    "NextToken": "AQICAHjfUasjUykoODDhNKl2HebKOGiYdLPRfLHRCAwv4m2pxQFto9/8mR5l9ttjq9pNVQmNAAAByzCCAccGCSqGSIb3DQEHBqCCAbgwggG0AgEAMIIBrQYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAzA10RtjnfHtBRMGfECARCAggF+PluTA4SojLX+eTvUKdEPCmi7jYLeUmMxLLKWWY2Q853Q0Mqd7rnPo1RKs/cILump20rk2lWa0cX894lTJDxNECkZnOh0EaD4MEd4hZ0eDvDOGzDc7IqHX29U9gtEjFc0Z6AZiBhRDqEHOMQB0egAN9m0HibtmcDzn00TPzBME6MWnBoZBCNiwCZEOpxLoFwc/U2/2oXixa3NFogkJAgRrVWcK5IKYx3DPN5e2rsk0mDylOZGneTNILeSt+zQ95m6bJj5Nm+wFbxr+mpxs8ZPTpwRVTjz/vThFmdmlLv42/uZCkXvq4IULyq2le98cq/nwTXnYtr3e3qQdQ4EHOi+Iettbv+p6TT3UxZIG/CETvGf0CP3uu9F64vG+iOWyDPtamaQjPRvZS+Wtb8awprNBVl9h8jkHZsM5C9+PbZoU7U9qqX67w96BSyxIXzsvs+8Oq5myvifbG+c1QxCnQWzlyXyHmKuRdRgE6rttiqOdw9J4DtwBlmFrC40V7FwCA==",
    "RoutingProfileManualAssignmentQueueConfigSummaryList": [
        {
            "Channel": "VOICE",
            "QueueArn": "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-5678-aabb-123456abcdef/queue/12345678-1234-5678-aabb-123456abcdef",
            "QueueId": "12345678-1234-5678-aabb-123456abcdef",
            "QueueName": "Q_NAME_1"
        }
    ]
}
```

### Example request to fetch the remaining manual assignment queues associated with a routing profile
<a name="API_ListRoutingProfileManualAssignmentQueues_Example_3"></a>

Use NextToken from previous response to fetch the remaining manual assignment queues associated with a routing profile.

```
PUT https://connect.us-west-2.amazonaws.com/routing-profiles/{{instance_id}}/{{routingProfileId}}/manual-assignment-queues HTTP/1.1 Content-type: application/json
{
    "MaxResults": 1,
    "NextToken": "AQICAHjfUasjUykoODDhNKl2HebKOGiYdLPRfLHRCAwv4m2pxQFto9/8mR5l9ttjq9pNVQmNAAAByzCCAccGCSqGSIb3DQEHBqCCAbgwggG0AgEAMIIBrQYJKoZIhvcNAQcBMB4GCWCGSAFlAwQBLjARBAzA10RtjnfHtBRMGfECARCAggF+PluTA4SojLX+eTvUKdEPCmi7jYLeUmMxLLKWWY2Q853Q0Mqd7rnPo1RKs/cILump20rk2lWa0cX894lTJDxNECkZnOh0EaD4MEd4hZ0eDvDOGzDc7IqHX29U9gtEjFc0Z6AZiBhRDqEHOMQB0egAN9m0HibtmcDzn00TPzBME6MWnBoZBCNiwCZEOpxLoFwc/U2/2oXixa3NFogkJAgRrVWcK5IKYx3DPN5e2rsk0mDylOZGneTNILeSt+zQ95m6bJj5Nm+wFbxr+mpxs8ZPTpwRVTjz/vThFmdmlLv42/uZCkXvq4IULyq2le98cq/nwTXnYtr3e3qQdQ4EHOi+Iettbv+p6TT3UxZIG/CETvGf0CP3uu9F64vG+iOWyDPtamaQjPRvZS+Wtb8awprNBVl9h8jkHZsM5C9+PbZoU7U9qqX67w96BSyxIXzsvs+8Oq5myvifbG+c1QxCnQWzlyXyHmKuRdRgE6rttiqOdw9J4DtwBlmFrC40V7FwCA==“
}
```

### Example response to list the remaining manual assignment queues
<a name="API_ListRoutingProfileManualAssignmentQueues_Example_4"></a>

Excludes the manual assignment queues retrieved by previous request.

```
{
    "LastModifiedRegion": "us-west-2",
    "LastModifiedTime": 1.75735455979E9,
    "NextToken": null,
    "RoutingProfileManualAssignmentQueueConfigSummaryList": [
        {
            "Channel": "TASK",
            "QueueArn": "arn:aws:connect:us-west-2:123456789012:instance/12345678-1234-5678-aabb-123456abcdef/queue/12345678-1234-5678-aabb-123456abcdef",
            "QueueId": "12345678-1234-5678-aabb-123456abcdef",
            "QueueName": "Q_NAME_2"
        }
    ]
}
```

## See Also
<a name="API_ListRoutingProfileManualAssignmentQueues_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListRoutingProfileManualAssignmentQueues) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListRoutingProfileManualAssignmentQueues) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListRoutingProfileManualAssignmentQueues) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListRoutingProfileManualAssignmentQueues) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListRoutingProfileManualAssignmentQueues) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListRoutingProfileManualAssignmentQueues) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListRoutingProfileManualAssignmentQueues) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListRoutingProfileManualAssignmentQueues) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListRoutingProfileManualAssignmentQueues) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListRoutingProfileManualAssignmentQueues) 

# ListRoutingProfileQueues
<a name="API_ListRoutingProfileQueues"></a>

Lists the queues associated with a routing profile.

## Request Syntax
<a name="API_ListRoutingProfileQueues_RequestSyntax"></a>

```
GET /routing-profiles/InstanceId/RoutingProfileId/queues?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListRoutingProfileQueues_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListRoutingProfileQueues_RequestSyntax) **   <a name="connect-ListRoutingProfileQueues-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListRoutingProfileQueues_RequestSyntax) **   <a name="connect-ListRoutingProfileQueues-request-uri-MaxResults"></a>
The maximum number of results to return per page. The default MaxResult size is 100.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListRoutingProfileQueues_RequestSyntax) **   <a name="connect-ListRoutingProfileQueues-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

 ** [RoutingProfileId](#API_ListRoutingProfileQueues_RequestSyntax) **   <a name="connect-ListRoutingProfileQueues-request-uri-RoutingProfileId"></a>
The identifier of the routing profile.  
Required: Yes

## Request Body
<a name="API_ListRoutingProfileQueues_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListRoutingProfileQueues_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "LastModifiedRegion": "string",
   "LastModifiedTime": number,
   "NextToken": "string",
   "RoutingProfileQueueConfigSummaryList": [ 
      { 
         "Channel": "string",
         "Delay": number,
         "Priority": number,
         "QueueArn": "string",
         "QueueId": "string",
         "QueueName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListRoutingProfileQueues_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LastModifiedRegion](#API_ListRoutingProfileQueues_ResponseSyntax) **   <a name="connect-ListRoutingProfileQueues-response-LastModifiedRegion"></a>
The AWS Region where this resource was last modified.  
Type: String  
Pattern: `[a-z]{2}(-[a-z]+){1,2}(-[0-9])?` 

 ** [LastModifiedTime](#API_ListRoutingProfileQueues_ResponseSyntax) **   <a name="connect-ListRoutingProfileQueues-response-LastModifiedTime"></a>
The timestamp when this resource was last modified.  
Type: Timestamp

 ** [NextToken](#API_ListRoutingProfileQueues_ResponseSyntax) **   <a name="connect-ListRoutingProfileQueues-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [RoutingProfileQueueConfigSummaryList](#API_ListRoutingProfileQueues_ResponseSyntax) **   <a name="connect-ListRoutingProfileQueues-response-RoutingProfileQueueConfigSummaryList"></a>
Information about the routing profiles.  
Type: Array of [RoutingProfileQueueConfigSummary](API_RoutingProfileQueueConfigSummary.md) objects

## Errors
<a name="API_ListRoutingProfileQueues_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListRoutingProfileQueues_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListRoutingProfileQueues) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListRoutingProfileQueues) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListRoutingProfileQueues) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListRoutingProfileQueues) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListRoutingProfileQueues) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListRoutingProfileQueues) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListRoutingProfileQueues) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListRoutingProfileQueues) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListRoutingProfileQueues) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListRoutingProfileQueues) 

# ListRoutingProfiles
<a name="API_ListRoutingProfiles"></a>

Provides summary information about the routing profiles for the specified Amazon Connect instance.

For more information about routing profiles, see [Routing Profiles](https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing.html) and [Create a Routing Profile](https://docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html) in the *Amazon Connect Administrator Guide*.

## Request Syntax
<a name="API_ListRoutingProfiles_RequestSyntax"></a>

```
GET /routing-profiles-summary/InstanceId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListRoutingProfiles_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListRoutingProfiles_RequestSyntax) **   <a name="connect-ListRoutingProfiles-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListRoutingProfiles_RequestSyntax) **   <a name="connect-ListRoutingProfiles-request-uri-MaxResults"></a>
The maximum number of results to return per page. The default MaxResult size is 100.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListRoutingProfiles_RequestSyntax) **   <a name="connect-ListRoutingProfiles-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListRoutingProfiles_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListRoutingProfiles_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "RoutingProfileSummaryList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListRoutingProfiles_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListRoutingProfiles_ResponseSyntax) **   <a name="connect-ListRoutingProfiles-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [RoutingProfileSummaryList](#API_ListRoutingProfiles_ResponseSyntax) **   <a name="connect-ListRoutingProfiles-response-RoutingProfileSummaryList"></a>
Information about the routing profiles.  
Type: Array of [RoutingProfileSummary](API_RoutingProfileSummary.md) objects

## Errors
<a name="API_ListRoutingProfiles_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListRoutingProfiles_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListRoutingProfiles) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListRoutingProfiles) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListRoutingProfiles) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListRoutingProfiles) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListRoutingProfiles) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListRoutingProfiles) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListRoutingProfiles) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListRoutingProfiles) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListRoutingProfiles) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListRoutingProfiles) 

# ListRules
<a name="API_ListRules"></a>

List all rules for the specified Amazon Connect instance.

## Request Syntax
<a name="API_ListRules_RequestSyntax"></a>

```
GET /rules/InstanceId?eventSourceName=EventSourceName&maxResults=MaxResults&nextToken=NextToken&publishStatus=PublishStatus HTTP/1.1
```

## URI Request Parameters
<a name="API_ListRules_RequestParameters"></a>

The request uses the following URI parameters.

 ** [EventSourceName](#API_ListRules_RequestSyntax) **   <a name="connect-ListRules-request-uri-EventSourceName"></a>
The name of the event source.  
Valid Values: `OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate | OnContactEvaluationSubmit | OnMetricDataUpdate | OnCaseCreate | OnCaseUpdate | OnSlaBreach` 

 ** [InstanceId](#API_ListRules_RequestSyntax) **   <a name="connect-ListRules-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListRules_RequestSyntax) **   <a name="connect-ListRules-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 200.

 ** [NextToken](#API_ListRules_RequestSyntax) **   <a name="connect-ListRules-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

 ** [PublishStatus](#API_ListRules_RequestSyntax) **   <a name="connect-ListRules-request-uri-PublishStatus"></a>
The publish status of the rule.  
Valid Values: `DRAFT | PUBLISHED` 

## Request Body
<a name="API_ListRules_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListRules_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "RuleSummaryList": [ 
      { 
         "ActionSummaries": [ 
            { 
               "ActionType": "string"
            }
         ],
         "CreatedTime": number,
         "EventSourceName": "string",
         "LastUpdatedTime": number,
         "Name": "string",
         "PublishStatus": "string",
         "RuleArn": "string",
         "RuleId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListRules_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListRules_ResponseSyntax) **   <a name="connect-ListRules-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [RuleSummaryList](#API_ListRules_ResponseSyntax) **   <a name="connect-ListRules-response-RuleSummaryList"></a>
Summary information about a rule.  
Type: Array of [RuleSummary](API_RuleSummary.md) objects

## Errors
<a name="API_ListRules_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListRules_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListRules) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListRules) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListRules) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListRules) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListRules) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListRules) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListRules) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListRules) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListRules) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListRules) 

# ListSecurityKeys
<a name="API_ListSecurityKeys"></a>

This API is in preview release for Amazon Connect and is subject to change.

Returns a paginated list of all security keys associated with the instance.

## Request Syntax
<a name="API_ListSecurityKeys_RequestSyntax"></a>

```
GET /instance/InstanceId/security-keys?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListSecurityKeys_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListSecurityKeys_RequestSyntax) **   <a name="connect-ListSecurityKeys-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListSecurityKeys_RequestSyntax) **   <a name="connect-ListSecurityKeys-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 2.

 ** [NextToken](#API_ListSecurityKeys_RequestSyntax) **   <a name="connect-ListSecurityKeys-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListSecurityKeys_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListSecurityKeys_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "SecurityKeys": [ 
      { 
         "AssociationId": "string",
         "CreationTime": number,
         "Key": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListSecurityKeys_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListSecurityKeys_ResponseSyntax) **   <a name="connect-ListSecurityKeys-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [SecurityKeys](#API_ListSecurityKeys_ResponseSyntax) **   <a name="connect-ListSecurityKeys-response-SecurityKeys"></a>
The security keys.  
Type: Array of [SecurityKey](API_SecurityKey.md) objects

## Errors
<a name="API_ListSecurityKeys_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListSecurityKeys_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListSecurityKeys) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListSecurityKeys) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListSecurityKeys) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListSecurityKeys) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListSecurityKeys) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListSecurityKeys) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListSecurityKeys) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListSecurityKeys) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListSecurityKeys) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListSecurityKeys) 

# ListSecurityProfileApplications
<a name="API_ListSecurityProfileApplications"></a>

Returns a list of third-party applications or MCP Servers in a specific security profile.

## Request Syntax
<a name="API_ListSecurityProfileApplications_RequestSyntax"></a>

```
GET /security-profiles-applications/InstanceId/SecurityProfileId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListSecurityProfileApplications_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListSecurityProfileApplications_RequestSyntax) **   <a name="connect-ListSecurityProfileApplications-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListSecurityProfileApplications_RequestSyntax) **   <a name="connect-ListSecurityProfileApplications-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListSecurityProfileApplications_RequestSyntax) **   <a name="connect-ListSecurityProfileApplications-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

 ** [SecurityProfileId](#API_ListSecurityProfileApplications_RequestSyntax) **   <a name="connect-ListSecurityProfileApplications-request-uri-SecurityProfileId"></a>
The identifier for the security profle.  
Required: Yes

## Request Body
<a name="API_ListSecurityProfileApplications_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListSecurityProfileApplications_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Applications": [ 
      { 
         "ApplicationPermissions": [ "string" ],
         "Namespace": "string",
         "Type": "string"
      }
   ],
   "LastModifiedRegion": "string",
   "LastModifiedTime": number,
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListSecurityProfileApplications_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Applications](#API_ListSecurityProfileApplications_ResponseSyntax) **   <a name="connect-ListSecurityProfileApplications-response-Applications"></a>
A list of the third-party application's metadata.  
Type: Array of [Application](API_Application.md) objects  
Array Members: Maximum number of 10 items.

 ** [LastModifiedRegion](#API_ListSecurityProfileApplications_ResponseSyntax) **   <a name="connect-ListSecurityProfileApplications-response-LastModifiedRegion"></a>
The AWS Region where this resource was last modified.  
Type: String  
Pattern: `[a-z]{2}(-[a-z]+){1,2}(-[0-9])?` 

 ** [LastModifiedTime](#API_ListSecurityProfileApplications_ResponseSyntax) **   <a name="connect-ListSecurityProfileApplications-response-LastModifiedTime"></a>
The timestamp when this resource was last modified.  
Type: Timestamp

 ** [NextToken](#API_ListSecurityProfileApplications_ResponseSyntax) **   <a name="connect-ListSecurityProfileApplications-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_ListSecurityProfileApplications_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListSecurityProfileApplications_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListSecurityProfileApplications) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListSecurityProfileApplications) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListSecurityProfileApplications) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListSecurityProfileApplications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListSecurityProfileApplications) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListSecurityProfileApplications) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListSecurityProfileApplications) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListSecurityProfileApplications) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListSecurityProfileApplications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListSecurityProfileApplications) 

# ListSecurityProfileFlowModules
<a name="API_ListSecurityProfileFlowModules"></a>

 A list of Flow Modules an AI Agent can invoke as a tool 

## Request Syntax
<a name="API_ListSecurityProfileFlowModules_RequestSyntax"></a>

```
GET /security-profiles-flow-modules/InstanceId/SecurityProfileId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListSecurityProfileFlowModules_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListSecurityProfileFlowModules_RequestSyntax) **   <a name="connect-ListSecurityProfileFlowModules-request-uri-InstanceId"></a>
 The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListSecurityProfileFlowModules_RequestSyntax) **   <a name="connect-ListSecurityProfileFlowModules-request-uri-MaxResults"></a>
 The maximum number of results to return per page. The default MaxResult size is 100.   
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListSecurityProfileFlowModules_RequestSyntax) **   <a name="connect-ListSecurityProfileFlowModules-request-uri-NextToken"></a>
 The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results. 

 ** [SecurityProfileId](#API_ListSecurityProfileFlowModules_RequestSyntax) **   <a name="connect-ListSecurityProfileFlowModules-request-uri-SecurityProfileId"></a>
 The identifier for the security profile.   
Required: Yes

## Request Body
<a name="API_ListSecurityProfileFlowModules_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListSecurityProfileFlowModules_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AllowedFlowModules": [ 
      { 
         "FlowModuleId": "string",
         "Type": "string"
      }
   ],
   "LastModifiedRegion": "string",
   "LastModifiedTime": number,
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListSecurityProfileFlowModules_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AllowedFlowModules](#API_ListSecurityProfileFlowModules_ResponseSyntax) **   <a name="connect-ListSecurityProfileFlowModules-response-AllowedFlowModules"></a>
 A list of Flow Modules an AI Agent can invoke as a tool.   
Type: Array of [FlowModule](API_FlowModule.md) objects  
Array Members: Maximum number of 10 items.

 ** [LastModifiedRegion](#API_ListSecurityProfileFlowModules_ResponseSyntax) **   <a name="connect-ListSecurityProfileFlowModules-response-LastModifiedRegion"></a>
 The Region that flow module was last modified in.   
Type: String  
Pattern: `[a-z]{2}(-[a-z]+){1,2}(-[0-9])?` 

 ** [LastModifiedTime](#API_ListSecurityProfileFlowModules_ResponseSyntax) **   <a name="connect-ListSecurityProfileFlowModules-response-LastModifiedTime"></a>
 The time the flow module was last modified.   
Type: Timestamp

 ** [NextToken](#API_ListSecurityProfileFlowModules_ResponseSyntax) **   <a name="connect-ListSecurityProfileFlowModules-response-NextToken"></a>
 The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.   
Type: String

## Errors
<a name="API_ListSecurityProfileFlowModules_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListSecurityProfileFlowModules_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListSecurityProfileFlowModules) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListSecurityProfileFlowModules) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListSecurityProfileFlowModules) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListSecurityProfileFlowModules) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListSecurityProfileFlowModules) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListSecurityProfileFlowModules) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListSecurityProfileFlowModules) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListSecurityProfileFlowModules) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListSecurityProfileFlowModules) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListSecurityProfileFlowModules) 

# ListSecurityProfilePermissions
<a name="API_ListSecurityProfilePermissions"></a>

Lists the permissions granted to a security profile.

For information about security profiles, see [Security Profiles](https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html) in the *Amazon Connect Administrator Guide*. For a mapping of the API name and user interface name of the security profile permissions, see [List of security profile permissions](https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html). 

## Request Syntax
<a name="API_ListSecurityProfilePermissions_RequestSyntax"></a>

```
GET /security-profiles-permissions/InstanceId/SecurityProfileId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListSecurityProfilePermissions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListSecurityProfilePermissions_RequestSyntax) **   <a name="connect-ListSecurityProfilePermissions-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListSecurityProfilePermissions_RequestSyntax) **   <a name="connect-ListSecurityProfilePermissions-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListSecurityProfilePermissions_RequestSyntax) **   <a name="connect-ListSecurityProfilePermissions-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

 ** [SecurityProfileId](#API_ListSecurityProfilePermissions_RequestSyntax) **   <a name="connect-ListSecurityProfilePermissions-request-uri-SecurityProfileId"></a>
The identifier for the security profle.  
Required: Yes

## Request Body
<a name="API_ListSecurityProfilePermissions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListSecurityProfilePermissions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "LastModifiedRegion": "string",
   "LastModifiedTime": number,
   "NextToken": "string",
   "Permissions": [ "string" ]
}
```

## Response Elements
<a name="API_ListSecurityProfilePermissions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LastModifiedRegion](#API_ListSecurityProfilePermissions_ResponseSyntax) **   <a name="connect-ListSecurityProfilePermissions-response-LastModifiedRegion"></a>
The AWS Region where this resource was last modified.  
Type: String  
Pattern: `[a-z]{2}(-[a-z]+){1,2}(-[0-9])?` 

 ** [LastModifiedTime](#API_ListSecurityProfilePermissions_ResponseSyntax) **   <a name="connect-ListSecurityProfilePermissions-response-LastModifiedTime"></a>
The timestamp when this resource was last modified.  
Type: Timestamp

 ** [NextToken](#API_ListSecurityProfilePermissions_ResponseSyntax) **   <a name="connect-ListSecurityProfilePermissions-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [Permissions](#API_ListSecurityProfilePermissions_ResponseSyntax) **   <a name="connect-ListSecurityProfilePermissions-response-Permissions"></a>
The permissions granted to the security profile. For a complete list of valid permissions, see [List of security profile permissions](https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html).  
Type: Array of strings  
Array Members: Maximum number of 500 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.

## Errors
<a name="API_ListSecurityProfilePermissions_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListSecurityProfilePermissions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListSecurityProfilePermissions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListSecurityProfilePermissions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListSecurityProfilePermissions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListSecurityProfilePermissions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListSecurityProfilePermissions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListSecurityProfilePermissions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListSecurityProfilePermissions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListSecurityProfilePermissions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListSecurityProfilePermissions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListSecurityProfilePermissions) 

# ListSecurityProfiles
<a name="API_ListSecurityProfiles"></a>

Provides summary information about the security profiles for the specified Amazon Connect instance.

For more information about security profiles, see [Security Profiles](https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html) in the *Amazon Connect Administrator Guide*. For a mapping of the API name and user interface name of the security profile permissions, see [List of security profile permissions](https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html). 

## Request Syntax
<a name="API_ListSecurityProfiles_RequestSyntax"></a>

```
GET /security-profiles-summary/InstanceId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListSecurityProfiles_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListSecurityProfiles_RequestSyntax) **   <a name="connect-ListSecurityProfiles-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListSecurityProfiles_RequestSyntax) **   <a name="connect-ListSecurityProfiles-request-uri-MaxResults"></a>
The maximum number of results to return per page. The default MaxResult size is 100.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListSecurityProfiles_RequestSyntax) **   <a name="connect-ListSecurityProfiles-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListSecurityProfiles_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListSecurityProfiles_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "SecurityProfileSummaryList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListSecurityProfiles_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListSecurityProfiles_ResponseSyntax) **   <a name="connect-ListSecurityProfiles-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [SecurityProfileSummaryList](#API_ListSecurityProfiles_ResponseSyntax) **   <a name="connect-ListSecurityProfiles-response-SecurityProfileSummaryList"></a>
Information about the security profiles.  
Type: Array of [SecurityProfileSummary](API_SecurityProfileSummary.md) objects

## Errors
<a name="API_ListSecurityProfiles_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListSecurityProfiles_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListSecurityProfiles) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListSecurityProfiles) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListSecurityProfiles) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListSecurityProfiles) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListSecurityProfiles) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListSecurityProfiles) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListSecurityProfiles) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListSecurityProfiles) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListSecurityProfiles) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListSecurityProfiles) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Lists the tags for the specified resource.

For sample policies that use tags, see [Amazon Connect Identity-Based Policy Examples](https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html) in the *Amazon Connect Administrator Guide*.

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/resourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="connect-ListTagsForResource-request-uri-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource. All Amazon Connect resources (instances, queues, flows, routing profiles, etc) have an ARN. To locate the ARN for an instance, for example, see [Find your Amazon Connect instance ID/ARN](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html).   
Required: Yes

## Request Body
<a name="API_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="connect-ListTagsForResource-response-tags"></a>
Information about the tags.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListTagsForResource) 

# ListTaskTemplates
<a name="API_ListTaskTemplates"></a>

Lists task templates for the specified Amazon Connect instance.

## Request Syntax
<a name="API_ListTaskTemplates_RequestSyntax"></a>

```
GET /instance/InstanceId/task/template?maxResults=MaxResults&name=Name&nextToken=NextToken&status=Status HTTP/1.1
```

## URI Request Parameters
<a name="API_ListTaskTemplates_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListTaskTemplates_RequestSyntax) **   <a name="connect-ListTaskTemplates-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListTaskTemplates_RequestSyntax) **   <a name="connect-ListTaskTemplates-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
It is not expected that you set this.
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [Name](#API_ListTaskTemplates_RequestSyntax) **   <a name="connect-ListTaskTemplates-request-uri-Name"></a>
The name of the task template.  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** [NextToken](#API_ListTaskTemplates_RequestSyntax) **   <a name="connect-ListTaskTemplates-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
It is not expected that you set this because the value returned in the previous response is always null.

 ** [Status](#API_ListTaskTemplates_RequestSyntax) **   <a name="connect-ListTaskTemplates-request-uri-Status"></a>
Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to it. Tasks can only be created from `ACTIVE` templates. If a template is marked as `INACTIVE`, then a task that refers to this template cannot be created.  
Valid Values: `ACTIVE | INACTIVE` 

## Request Body
<a name="API_ListTaskTemplates_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListTaskTemplates_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "TaskTemplates": [ 
      { 
         "Arn": "string",
         "CreatedTime": number,
         "Description": "string",
         "Id": "string",
         "LastModifiedTime": number,
         "Name": "string",
         "Status": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTaskTemplates_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListTaskTemplates_ResponseSyntax) **   <a name="connect-ListTaskTemplates-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
This is always returned as a null in the response.
Type: String

 ** [TaskTemplates](#API_ListTaskTemplates_ResponseSyntax) **   <a name="connect-ListTaskTemplates-response-TaskTemplates"></a>
Provides details about a list of task templates belonging to an instance.  
Type: Array of [TaskTemplateMetadata](API_TaskTemplateMetadata.md) objects

## Errors
<a name="API_ListTaskTemplates_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListTaskTemplates_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListTaskTemplates) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListTaskTemplates) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListTaskTemplates) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListTaskTemplates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListTaskTemplates) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListTaskTemplates) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListTaskTemplates) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListTaskTemplates) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListTaskTemplates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListTaskTemplates) 

# ListTestCaseExecutionRecords
<a name="API_ListTestCaseExecutionRecords"></a>

Lists detailed steps of test case execution that includes all observations along with actions taken and data associated in the specified Amazon Connect instance.

## Request Syntax
<a name="API_ListTestCaseExecutionRecords_RequestSyntax"></a>

```
GET /test-cases/InstanceId/TestCaseId/TestCaseExecutionId/records?maxResults=MaxResults&nextToken=NextToken&status=Status HTTP/1.1
```

## URI Request Parameters
<a name="API_ListTestCaseExecutionRecords_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListTestCaseExecutionRecords_RequestSyntax) **   <a name="connect-ListTestCaseExecutionRecords-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListTestCaseExecutionRecords_RequestSyntax) **   <a name="connect-ListTestCaseExecutionRecords-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListTestCaseExecutionRecords_RequestSyntax) **   <a name="connect-ListTestCaseExecutionRecords-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

 ** [Status](#API_ListTestCaseExecutionRecords_RequestSyntax) **   <a name="connect-ListTestCaseExecutionRecords-request-uri-Status"></a>
Filter execution records by status.  
Valid Values: `INITIATED | PASSED | FAILED | IN_PROGRESS | STOPPED` 

 ** [TestCaseExecutionId](#API_ListTestCaseExecutionRecords_RequestSyntax) **   <a name="connect-ListTestCaseExecutionRecords-request-uri-TestCaseExecutionId"></a>
The identifier of the test case execution.  
Length Constraints: Maximum length of 500.  
Required: Yes

 ** [TestCaseId](#API_ListTestCaseExecutionRecords_RequestSyntax) **   <a name="connect-ListTestCaseExecutionRecords-request-uri-TestCaseId"></a>
The identifier of the test case.  
Length Constraints: Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_ListTestCaseExecutionRecords_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListTestCaseExecutionRecords_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ExecutionRecords": [ 
      { 
         "ObservationId": "string",
         "Record": "string",
         "Status": "string",
         "Timestamp": number
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListTestCaseExecutionRecords_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ExecutionRecords](#API_ListTestCaseExecutionRecords_ResponseSyntax) **   <a name="connect-ListTestCaseExecutionRecords-response-ExecutionRecords"></a>
An array of test case execution record objects.  
Type: Array of [ExecutionRecord](API_ExecutionRecord.md) objects

 ** [NextToken](#API_ListTestCaseExecutionRecords_ResponseSyntax) **   <a name="connect-ListTestCaseExecutionRecords-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100000.

## Errors
<a name="API_ListTestCaseExecutionRecords_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListTestCaseExecutionRecords_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListTestCaseExecutionRecords) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListTestCaseExecutionRecords) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListTestCaseExecutionRecords) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListTestCaseExecutionRecords) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListTestCaseExecutionRecords) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListTestCaseExecutionRecords) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListTestCaseExecutionRecords) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListTestCaseExecutionRecords) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListTestCaseExecutionRecords) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListTestCaseExecutionRecords) 

# ListTestCaseExecutions
<a name="API_ListTestCaseExecutions"></a>

Lists all test case executions and allows filtering by test case id, test case name, start time, end time or status of the execution for the specified Amazon Connect instance.

## Request Syntax
<a name="API_ListTestCaseExecutions_RequestSyntax"></a>

```
GET /test-case-executions/InstanceId?endTime=EndTime&maxResults=MaxResults&nextToken=NextToken&startTime=StartTime&status=Status&testCaseId=TestCaseId&testCaseName=TestCaseName HTTP/1.1
```

## URI Request Parameters
<a name="API_ListTestCaseExecutions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [EndTime](#API_ListTestCaseExecutions_RequestSyntax) **   <a name="connect-ListTestCaseExecutions-request-uri-EndTime"></a>
Filter executions that started before this time.

 ** [InstanceId](#API_ListTestCaseExecutions_RequestSyntax) **   <a name="connect-ListTestCaseExecutions-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListTestCaseExecutions_RequestSyntax) **   <a name="connect-ListTestCaseExecutions-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListTestCaseExecutions_RequestSyntax) **   <a name="connect-ListTestCaseExecutions-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

 ** [StartTime](#API_ListTestCaseExecutions_RequestSyntax) **   <a name="connect-ListTestCaseExecutions-request-uri-StartTime"></a>
Filter executions that started after this time.

 ** [Status](#API_ListTestCaseExecutions_RequestSyntax) **   <a name="connect-ListTestCaseExecutions-request-uri-Status"></a>
Filter executions by status.  
Valid Values: `INITIATED | PASSED | FAILED | IN_PROGRESS | STOPPED` 

 ** [TestCaseId](#API_ListTestCaseExecutions_RequestSyntax) **   <a name="connect-ListTestCaseExecutions-request-uri-TestCaseId"></a>
Filter executions by test case identifier.  
Length Constraints: Maximum length of 500.

 ** [TestCaseName](#API_ListTestCaseExecutions_RequestSyntax) **   <a name="connect-ListTestCaseExecutions-request-uri-TestCaseName"></a>
Filter executions by test case name.  
Length Constraints: Minimum length of 1.

## Request Body
<a name="API_ListTestCaseExecutions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListTestCaseExecutions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "TestCaseExecutions": [ 
      { 
         "EndTime": number,
         "StartTime": number,
         "Tags": { 
            "string" : "string" 
         },
         "TestCaseExecutionId": "string",
         "TestCaseExecutionStatus": "string",
         "TestCaseId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTestCaseExecutions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListTestCaseExecutions_ResponseSyntax) **   <a name="connect-ListTestCaseExecutions-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [TestCaseExecutions](#API_ListTestCaseExecutions_ResponseSyntax) **   <a name="connect-ListTestCaseExecutions-response-TestCaseExecutions"></a>
An array of test case execution summary objects.  
Type: Array of [TestCaseExecution](API_TestCaseExecution.md) objects

## Errors
<a name="API_ListTestCaseExecutions_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListTestCaseExecutions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListTestCaseExecutions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListTestCaseExecutions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListTestCaseExecutions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListTestCaseExecutions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListTestCaseExecutions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListTestCaseExecutions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListTestCaseExecutions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListTestCaseExecutions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListTestCaseExecutions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListTestCaseExecutions) 

# ListTestCases
<a name="API_ListTestCases"></a>

Lists the test cases present in the specific Amazon Connect instance.

## Request Syntax
<a name="API_ListTestCases_RequestSyntax"></a>

```
GET /test-cases-summary/InstanceId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListTestCases_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListTestCases_RequestSyntax) **   <a name="connect-ListTestCases-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListTestCases_RequestSyntax) **   <a name="connect-ListTestCases-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListTestCases_RequestSyntax) **   <a name="connect-ListTestCases-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListTestCases_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListTestCases_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "TestCaseSummaryList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string",
         "Status": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTestCases_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListTestCases_ResponseSyntax) **   <a name="connect-ListTestCases-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [TestCaseSummaryList](#API_ListTestCases_ResponseSyntax) **   <a name="connect-ListTestCases-response-TestCaseSummaryList"></a>
Information about the tests.  
Type: Array of [TestCaseSummary](API_TestCaseSummary.md) objects

## Errors
<a name="API_ListTestCases_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListTestCases_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListTestCases) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListTestCases) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListTestCases) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListTestCases) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListTestCases) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListTestCases) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListTestCases) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListTestCases) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListTestCases) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListTestCases) 

# ListTrafficDistributionGroups
<a name="API_ListTrafficDistributionGroups"></a>

Lists traffic distribution groups.

## Request Syntax
<a name="API_ListTrafficDistributionGroups_RequestSyntax"></a>

```
GET /traffic-distribution-groups?instanceId=InstanceId&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListTrafficDistributionGroups_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListTrafficDistributionGroups_RequestSyntax) **   <a name="connect-ListTrafficDistributionGroups-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$` 

 ** [MaxResults](#API_ListTrafficDistributionGroups_RequestSyntax) **   <a name="connect-ListTrafficDistributionGroups-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 10.

 ** [NextToken](#API_ListTrafficDistributionGroups_RequestSyntax) **   <a name="connect-ListTrafficDistributionGroups-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListTrafficDistributionGroups_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListTrafficDistributionGroups_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "TrafficDistributionGroupSummaryList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "InstanceArn": "string",
         "IsDefault": boolean,
         "Name": "string",
         "Status": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTrafficDistributionGroups_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListTrafficDistributionGroups_ResponseSyntax) **   <a name="connect-ListTrafficDistributionGroups-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [TrafficDistributionGroupSummaryList](#API_ListTrafficDistributionGroups_ResponseSyntax) **   <a name="connect-ListTrafficDistributionGroups-response-TrafficDistributionGroupSummaryList"></a>
A list of traffic distribution groups.  
Type: Array of [TrafficDistributionGroupSummary](API_TrafficDistributionGroupSummary.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

## Errors
<a name="API_ListTrafficDistributionGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListTrafficDistributionGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListTrafficDistributionGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListTrafficDistributionGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListTrafficDistributionGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListTrafficDistributionGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListTrafficDistributionGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListTrafficDistributionGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListTrafficDistributionGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListTrafficDistributionGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListTrafficDistributionGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListTrafficDistributionGroups) 

# ListTrafficDistributionGroupUsers
<a name="API_ListTrafficDistributionGroupUsers"></a>

Lists traffic distribution group users.

## Request Syntax
<a name="API_ListTrafficDistributionGroupUsers_RequestSyntax"></a>

```
GET /traffic-distribution-group/TrafficDistributionGroupId/user?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListTrafficDistributionGroupUsers_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_ListTrafficDistributionGroupUsers_RequestSyntax) **   <a name="connect-ListTrafficDistributionGroupUsers-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 10.

 ** [NextToken](#API_ListTrafficDistributionGroupUsers_RequestSyntax) **   <a name="connect-ListTrafficDistributionGroupUsers-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

 ** [TrafficDistributionGroupId](#API_ListTrafficDistributionGroupUsers_RequestSyntax) **   <a name="connect-ListTrafficDistributionGroupUsers-request-uri-TrafficDistributionGroupId"></a>
The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z-]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

## Request Body
<a name="API_ListTrafficDistributionGroupUsers_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListTrafficDistributionGroupUsers_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "TrafficDistributionGroupUserSummaryList": [ 
      { 
         "UserId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTrafficDistributionGroupUsers_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListTrafficDistributionGroupUsers_ResponseSyntax) **   <a name="connect-ListTrafficDistributionGroupUsers-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [TrafficDistributionGroupUserSummaryList](#API_ListTrafficDistributionGroupUsers_ResponseSyntax) **   <a name="connect-ListTrafficDistributionGroupUsers-response-TrafficDistributionGroupUserSummaryList"></a>
A list of traffic distribution group users.  
Type: Array of [TrafficDistributionGroupUserSummary](API_TrafficDistributionGroupUserSummary.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

## Errors
<a name="API_ListTrafficDistributionGroupUsers_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_ListTrafficDistributionGroupUsers_Examples"></a>

### Example
<a name="API_ListTrafficDistributionGroupUsers_Example_1"></a>

The following example lists traffic distribution group users.

#### Sample Request
<a name="API_ListTrafficDistributionGroupUsers_Example_1_Request"></a>

```
GET connect.[region].amazonaws.com/traffic-distribution-group/[traffic_distribution_group_id]/user 
```

#### Sample Response
<a name="API_ListTrafficDistributionGroupUsers_Example_1_Response"></a>

```
{
   "TrafficDistributionGroupUserSummaryList": [
      {
         "UserId": "[user_id]"
      }
   ]
}
```

## See Also
<a name="API_ListTrafficDistributionGroupUsers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListTrafficDistributionGroupUsers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListTrafficDistributionGroupUsers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListTrafficDistributionGroupUsers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListTrafficDistributionGroupUsers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListTrafficDistributionGroupUsers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListTrafficDistributionGroupUsers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListTrafficDistributionGroupUsers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListTrafficDistributionGroupUsers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListTrafficDistributionGroupUsers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListTrafficDistributionGroupUsers) 

# ListUseCases
<a name="API_ListUseCases"></a>

Lists the use cases for the integration association. 

## Request Syntax
<a name="API_ListUseCases_RequestSyntax"></a>

```
GET /instance/InstanceId/integration-associations/IntegrationAssociationId/use-cases?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListUseCases_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListUseCases_RequestSyntax) **   <a name="connect-ListUseCases-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [IntegrationAssociationId](#API_ListUseCases_RequestSyntax) **   <a name="connect-ListUseCases-request-uri-IntegrationAssociationId"></a>
The identifier for the integration association.  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: Yes

 ** [MaxResults](#API_ListUseCases_RequestSyntax) **   <a name="connect-ListUseCases-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListUseCases_RequestSyntax) **   <a name="connect-ListUseCases-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListUseCases_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListUseCases_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "UseCaseSummaryList": [ 
      { 
         "UseCaseArn": "string",
         "UseCaseId": "string",
         "UseCaseType": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListUseCases_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListUseCases_ResponseSyntax) **   <a name="connect-ListUseCases-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [UseCaseSummaryList](#API_ListUseCases_ResponseSyntax) **   <a name="connect-ListUseCases-response-UseCaseSummaryList"></a>
The use cases.  
Type: Array of [UseCase](API_UseCase.md) objects

## Errors
<a name="API_ListUseCases_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListUseCases_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListUseCases) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListUseCases) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListUseCases) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListUseCases) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListUseCases) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListUseCases) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListUseCases) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListUseCases) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListUseCases) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListUseCases) 

# ListUserHierarchyGroups
<a name="API_ListUserHierarchyGroups"></a>

Provides summary information about the hierarchy groups for the specified Amazon Connect instance.

For more information about agent hierarchies, see [Set Up Agent Hierarchies](https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html) in the *Amazon Connect Administrator Guide*.

## Request Syntax
<a name="API_ListUserHierarchyGroups_RequestSyntax"></a>

```
GET /user-hierarchy-groups-summary/InstanceId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListUserHierarchyGroups_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListUserHierarchyGroups_RequestSyntax) **   <a name="connect-ListUserHierarchyGroups-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListUserHierarchyGroups_RequestSyntax) **   <a name="connect-ListUserHierarchyGroups-request-uri-MaxResults"></a>
The maximum number of results to return per page. The default MaxResult size is 100.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListUserHierarchyGroups_RequestSyntax) **   <a name="connect-ListUserHierarchyGroups-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListUserHierarchyGroups_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListUserHierarchyGroups_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "UserHierarchyGroupSummaryList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListUserHierarchyGroups_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListUserHierarchyGroups_ResponseSyntax) **   <a name="connect-ListUserHierarchyGroups-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [UserHierarchyGroupSummaryList](#API_ListUserHierarchyGroups_ResponseSyntax) **   <a name="connect-ListUserHierarchyGroups-response-UserHierarchyGroupSummaryList"></a>
Information about the hierarchy groups.  
Type: Array of [HierarchyGroupSummary](API_HierarchyGroupSummary.md) objects

## Errors
<a name="API_ListUserHierarchyGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListUserHierarchyGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListUserHierarchyGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListUserHierarchyGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListUserHierarchyGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListUserHierarchyGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListUserHierarchyGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListUserHierarchyGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListUserHierarchyGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListUserHierarchyGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListUserHierarchyGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListUserHierarchyGroups) 

# ListUserNotifications
<a name="API_ListUserNotifications"></a>

Retrieves a paginated list of notifications for a specific user, including the notification status for that user.

## Request Syntax
<a name="API_ListUserNotifications_RequestSyntax"></a>

```
GET /users/InstanceId/UserId/notifications?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListUserNotifications_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListUserNotifications_RequestSyntax) **   <a name="connect-ListUserNotifications-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListUserNotifications_RequestSyntax) **   <a name="connect-ListUserNotifications-request-uri-MaxResults"></a>
The maximum number of results to return per page. Valid range is 1-1000.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListUserNotifications_RequestSyntax) **   <a name="connect-ListUserNotifications-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response to retrieve the next page of results.

 ** [UserId](#API_ListUserNotifications_RequestSyntax) **   <a name="connect-ListUserNotifications-request-uri-UserId"></a>
The identifier of the user.  
Required: Yes

## Request Body
<a name="API_ListUserNotifications_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListUserNotifications_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "UserNotifications": [ 
      { 
         "Content": { 
            "string" : "string" 
         },
         "CreatedAt": number,
         "ExpiresAt": number,
         "InstanceId": "string",
         "NotificationId": "string",
         "NotificationStatus": "string",
         "Priority": "string",
         "RecipientId": "string",
         "Source": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListUserNotifications_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListUserNotifications_ResponseSyntax) **   <a name="connect-ListUserNotifications-response-NextToken"></a>
The token for the next set of results. If present, there are more results available.  
Type: String

 ** [UserNotifications](#API_ListUserNotifications_ResponseSyntax) **   <a name="connect-ListUserNotifications-response-UserNotifications"></a>
A list of notifications sent to the specified user.  
Type: Array of [UserNotificationSummary](API_UserNotificationSummary.md) objects

## Errors
<a name="API_ListUserNotifications_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListUserNotifications_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListUserNotifications) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListUserNotifications) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListUserNotifications) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListUserNotifications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListUserNotifications) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListUserNotifications) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListUserNotifications) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListUserNotifications) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListUserNotifications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListUserNotifications) 

# ListUserProficiencies
<a name="API_ListUserProficiencies"></a>

Lists proficiencies associated with a user.

## Request Syntax
<a name="API_ListUserProficiencies_RequestSyntax"></a>

```
GET /users/InstanceId/UserId/proficiencies?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListUserProficiencies_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListUserProficiencies_RequestSyntax) **   <a name="connect-ListUserProficiencies-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListUserProficiencies_RequestSyntax) **   <a name="connect-ListUserProficiencies-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListUserProficiencies_RequestSyntax) **   <a name="connect-ListUserProficiencies-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

 ** [UserId](#API_ListUserProficiencies_RequestSyntax) **   <a name="connect-ListUserProficiencies-request-uri-UserId"></a>
The identifier of the user account.  
Required: Yes

## Request Body
<a name="API_ListUserProficiencies_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListUserProficiencies_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "LastModifiedRegion": "string",
   "LastModifiedTime": number,
   "NextToken": "string",
   "UserProficiencyList": [ 
      { 
         "AttributeName": "string",
         "AttributeValue": "string",
         "Level": number
      }
   ]
}
```

## Response Elements
<a name="API_ListUserProficiencies_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LastModifiedRegion](#API_ListUserProficiencies_ResponseSyntax) **   <a name="connect-ListUserProficiencies-response-LastModifiedRegion"></a>
The region in which a user's proficiencies were last modified.  
Type: String  
Pattern: `[a-z]{2}(-[a-z]+){1,2}(-[0-9])?` 

 ** [LastModifiedTime](#API_ListUserProficiencies_ResponseSyntax) **   <a name="connect-ListUserProficiencies-response-LastModifiedTime"></a>
The last time that the user's proficiencies are were modified.  
Type: Timestamp

 ** [NextToken](#API_ListUserProficiencies_ResponseSyntax) **   <a name="connect-ListUserProficiencies-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [UserProficiencyList](#API_ListUserProficiencies_ResponseSyntax) **   <a name="connect-ListUserProficiencies-response-UserProficiencyList"></a>
Information about the user proficiencies.  
Type: Array of [UserProficiency](API_UserProficiency.md) objects

## Errors
<a name="API_ListUserProficiencies_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListUserProficiencies_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListUserProficiencies) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListUserProficiencies) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListUserProficiencies) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListUserProficiencies) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListUserProficiencies) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListUserProficiencies) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListUserProficiencies) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListUserProficiencies) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListUserProficiencies) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListUserProficiencies) 

# ListUsers
<a name="API_ListUsers"></a>

Provides summary information about the users for the specified Amazon Connect instance.

## Request Syntax
<a name="API_ListUsers_RequestSyntax"></a>

```
GET /users-summary/InstanceId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListUsers_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListUsers_RequestSyntax) **   <a name="connect-ListUsers-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListUsers_RequestSyntax) **   <a name="connect-ListUsers-request-uri-MaxResults"></a>
The maximum number of results to return per page. The default MaxResult size is 100.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [NextToken](#API_ListUsers_RequestSyntax) **   <a name="connect-ListUsers-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListUsers_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListUsers_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "UserSummaryList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Username": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListUsers_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListUsers_ResponseSyntax) **   <a name="connect-ListUsers-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [UserSummaryList](#API_ListUsers_ResponseSyntax) **   <a name="connect-ListUsers-response-UserSummaryList"></a>
Information about the users.  
Type: Array of [UserSummary](API_UserSummary.md) objects

## Errors
<a name="API_ListUsers_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListUsers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListUsers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListUsers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListUsers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListUsers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListUsers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListUsers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListUsers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListUsers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListUsers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListUsers) 

# ListViews
<a name="API_ListViews"></a>

Returns views in the given instance.

Results are sorted primarily by type, and secondarily by name.

## Request Syntax
<a name="API_ListViews_RequestSyntax"></a>

```
GET /views/InstanceId?maxResults=MaxResults&nextToken=NextToken&type=Type HTTP/1.1
```

## URI Request Parameters
<a name="API_ListViews_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListViews_RequestSyntax) **   <a name="connect-ListViews-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9\_\-:\/]+$`   
Required: Yes

 ** [MaxResults](#API_ListViews_RequestSyntax) **   <a name="connect-ListViews-request-uri-MaxResults"></a>
The maximum number of results to return per page. The default MaxResult size is 100.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListViews_RequestSyntax) **   <a name="connect-ListViews-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `^[a-zA-Z0-9=\/+_.-]+$` 

 ** [Type](#API_ListViews_RequestSyntax) **   <a name="connect-ListViews-request-uri-Type"></a>
The type of the view.  
Valid Values: `CUSTOMER_MANAGED | AWS_MANAGED` 

## Request Body
<a name="API_ListViews_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListViews_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ViewsSummaryList": [ 
      { 
         "Arn": "string",
         "Description": "string",
         "Id": "string",
         "Name": "string",
         "Status": "string",
         "Type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListViews_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListViews_ResponseSyntax) **   <a name="connect-ListViews-response-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `^[a-zA-Z0-9=\/+_.-]+$` 

 ** [ViewsSummaryList](#API_ListViews_ResponseSyntax) **   <a name="connect-ListViews-response-ViewsSummaryList"></a>
A list of view summaries.  
Type: Array of [ViewSummary](API_ViewSummary.md) objects

## Errors
<a name="API_ListViews_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** TooManyRequestsException **   
Displayed when rate-related API limits are exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListViews_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListViews) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListViews) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListViews) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListViews) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListViews) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListViews) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListViews) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListViews) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListViews) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListViews) 

# ListViewVersions
<a name="API_ListViewVersions"></a>

Returns all the available versions for the specified Amazon Connect instance and view identifier.

Results will be sorted from highest to lowest.

## Request Syntax
<a name="API_ListViewVersions_RequestSyntax"></a>

```
GET /views/InstanceId/ViewId/versions?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListViewVersions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListViewVersions_RequestSyntax) **   <a name="connect-ListViewVersions-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9\_\-:\/]+$`   
Required: Yes

 ** [MaxResults](#API_ListViewVersions_RequestSyntax) **   <a name="connect-ListViewVersions-request-uri-MaxResults"></a>
The maximum number of results to return per page. The default MaxResult size is 100.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListViewVersions_RequestSyntax) **   <a name="connect-ListViewVersions-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `^[a-zA-Z0-9=\/+_.-]+$` 

 ** [ViewId](#API_ListViewVersions_RequestSyntax) **   <a name="connect-ListViewVersions-request-uri-ViewId"></a>
The identifier of the view. Both `ViewArn` and `ViewId` can be used.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Pattern: `^[a-zA-Z0-9\_\-:\/$]+$`   
Required: Yes

## Request Body
<a name="API_ListViewVersions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListViewVersions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ViewVersionSummaryList": [ 
      { 
         "Arn": "string",
         "Description": "string",
         "Id": "string",
         "Name": "string",
         "Type": "string",
         "Version": number,
         "VersionDescription": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListViewVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListViewVersions_ResponseSyntax) **   <a name="connect-ListViewVersions-response-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `^[a-zA-Z0-9=\/+_.-]+$` 

 ** [ViewVersionSummaryList](#API_ListViewVersions_ResponseSyntax) **   <a name="connect-ListViewVersions-response-ViewVersionSummaryList"></a>
A list of view version summaries.  
Type: Array of [ViewVersionSummary](API_ViewVersionSummary.md) objects

## Errors
<a name="API_ListViewVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** TooManyRequestsException **   
Displayed when rate-related API limits are exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListViewVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListViewVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListViewVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListViewVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListViewVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListViewVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListViewVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListViewVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListViewVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListViewVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListViewVersions) 

# ListWorkspaceMedia
<a name="API_ListWorkspaceMedia"></a>

Lists media assets (such as logos) associated with a workspace.

## Request Syntax
<a name="API_ListWorkspaceMedia_RequestSyntax"></a>

```
GET /workspaces/InstanceId/WorkspaceId/media HTTP/1.1
```

## URI Request Parameters
<a name="API_ListWorkspaceMedia_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListWorkspaceMedia_RequestSyntax) **   <a name="connect-ListWorkspaceMedia-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [WorkspaceId](#API_ListWorkspaceMedia_RequestSyntax) **   <a name="connect-ListWorkspaceMedia-request-uri-WorkspaceId"></a>
The identifier of the workspace.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_ListWorkspaceMedia_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListWorkspaceMedia_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Media": [ 
      { 
         "Source": "string",
         "Type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListWorkspaceMedia_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Media](#API_ListWorkspaceMedia_ResponseSyntax) **   <a name="connect-ListWorkspaceMedia-response-Media"></a>
A list of media assets for the workspace.  
Type: Array of [MediaItem](API_MediaItem.md) objects

## Errors
<a name="API_ListWorkspaceMedia_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListWorkspaceMedia_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListWorkspaceMedia) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListWorkspaceMedia) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListWorkspaceMedia) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListWorkspaceMedia) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListWorkspaceMedia) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListWorkspaceMedia) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListWorkspaceMedia) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListWorkspaceMedia) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListWorkspaceMedia) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListWorkspaceMedia) 

# ListWorkspacePages
<a name="API_ListWorkspacePages"></a>

Lists the page configurations in a workspace, including the views assigned to each page.

## Request Syntax
<a name="API_ListWorkspacePages_RequestSyntax"></a>

```
GET /workspaces/InstanceId/WorkspaceId/pages?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListWorkspacePages_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListWorkspacePages_RequestSyntax) **   <a name="connect-ListWorkspacePages-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListWorkspacePages_RequestSyntax) **   <a name="connect-ListWorkspacePages-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListWorkspacePages_RequestSyntax) **   <a name="connect-ListWorkspacePages-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

 ** [WorkspaceId](#API_ListWorkspacePages_RequestSyntax) **   <a name="connect-ListWorkspacePages-request-uri-WorkspaceId"></a>
The identifier of the workspace.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_ListWorkspacePages_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListWorkspacePages_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "WorkspacePageList": [ 
      { 
         "InputData": "string",
         "Page": "string",
         "ResourceArn": "string",
         "Slug": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListWorkspacePages_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListWorkspacePages_ResponseSyntax) **   <a name="connect-ListWorkspacePages-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [WorkspacePageList](#API_ListWorkspacePages_ResponseSyntax) **   <a name="connect-ListWorkspacePages-response-WorkspacePageList"></a>
A list of page configurations in the workspace.  
Type: Array of [WorkspacePage](API_WorkspacePage.md) objects

## Errors
<a name="API_ListWorkspacePages_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListWorkspacePages_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListWorkspacePages) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListWorkspacePages) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListWorkspacePages) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListWorkspacePages) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListWorkspacePages) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListWorkspacePages) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListWorkspacePages) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListWorkspacePages) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListWorkspacePages) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListWorkspacePages) 

# ListWorkspaces
<a name="API_ListWorkspaces"></a>

Lists the workspaces in an Amazon Connect instance.

## Request Syntax
<a name="API_ListWorkspaces_RequestSyntax"></a>

```
GET /workspaces/InstanceId?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListWorkspaces_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ListWorkspaces_RequestSyntax) **   <a name="connect-ListWorkspaces-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_ListWorkspaces_RequestSyntax) **   <a name="connect-ListWorkspaces-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_ListWorkspaces_RequestSyntax) **   <a name="connect-ListWorkspaces-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

## Request Body
<a name="API_ListWorkspaces_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListWorkspaces_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "WorkspaceSummaryList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListWorkspaces_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListWorkspaces_ResponseSyntax) **   <a name="connect-ListWorkspaces-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [WorkspaceSummaryList](#API_ListWorkspaces_ResponseSyntax) **   <a name="connect-ListWorkspaces-response-WorkspaceSummaryList"></a>
A summary list of workspaces.  
Type: Array of [WorkspaceSummary](API_WorkspaceSummary.md) objects

## Errors
<a name="API_ListWorkspaces_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ListWorkspaces_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ListWorkspaces) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ListWorkspaces) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ListWorkspaces) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ListWorkspaces) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ListWorkspaces) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ListWorkspaces) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ListWorkspaces) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ListWorkspaces) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ListWorkspaces) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ListWorkspaces) 

# MonitorContact
<a name="API_MonitorContact"></a>

Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by *userId* will be set to silent monitoring mode on the contact.

## Request Syntax
<a name="API_MonitorContact_RequestSyntax"></a>

```
POST /contact/monitor HTTP/1.1
Content-type: application/json

{
   "AllowedMonitorCapabilities": [ "string" ],
   "ClientToken": "string",
   "ContactId": "string",
   "InstanceId": "string",
   "UserId": "string"
}
```

## URI Request Parameters
<a name="API_MonitorContact_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_MonitorContact_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AllowedMonitorCapabilities](#API_MonitorContact_RequestSyntax) **   <a name="connect-MonitorContact-request-AllowedMonitorCapabilities"></a>
Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge. AllowedMonitorCapabilities is required if barge is enabled.  
Type: Array of strings  
Array Members: Maximum number of 2 items.  
Valid Values: `SILENT_MONITOR | BARGE`   
Required: No

 ** [ClientToken](#API_MonitorContact_RequestSyntax) **   <a name="connect-MonitorContact-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [ContactId](#API_MonitorContact_RequestSyntax) **   <a name="connect-MonitorContact-request-ContactId"></a>
The identifier of the contact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_MonitorContact_RequestSyntax) **   <a name="connect-MonitorContact-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [UserId](#API_MonitorContact_RequestSyntax) **   <a name="connect-MonitorContact-request-UserId"></a>
The identifier of the user account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Response Syntax
<a name="API_MonitorContact_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactArn": "string",
   "ContactId": "string"
}
```

## Response Elements
<a name="API_MonitorContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContactArn](#API_MonitorContact_ResponseSyntax) **   <a name="connect-MonitorContact-response-ContactArn"></a>
The ARN of the contact.  
Type: String

 ** [ContactId](#API_MonitorContact_ResponseSyntax) **   <a name="connect-MonitorContact-response-ContactId"></a>
The identifier of the contact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_MonitorContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** IdempotencyException **   
An entity with the same name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_MonitorContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/MonitorContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/MonitorContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/MonitorContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/MonitorContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/MonitorContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/MonitorContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/MonitorContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/MonitorContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/MonitorContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/MonitorContact) 

# PauseContact
<a name="API_PauseContact"></a>

Allows pausing an ongoing task contact.

## Request Syntax
<a name="API_PauseContact_RequestSyntax"></a>

```
POST /contact/pause HTTP/1.1
Content-type: application/json

{
   "ContactFlowId": "string",
   "ContactId": "string",
   "InstanceId": "string"
}
```

## URI Request Parameters
<a name="API_PauseContact_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_PauseContact_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ContactFlowId](#API_PauseContact_RequestSyntax) **   <a name="connect-PauseContact-request-ContactFlowId"></a>
The identifier of the flow.  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [ContactId](#API_PauseContact_RequestSyntax) **   <a name="connect-PauseContact-request-ContactId"></a>
The identifier of the contact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_PauseContact_RequestSyntax) **   <a name="connect-PauseContact-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the `instanceId` in the ARN of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Syntax
<a name="API_PauseContact_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_PauseContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_PauseContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
Operation cannot be performed at this time as there is a conflict with another operation or contact state.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_PauseContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/PauseContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/PauseContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/PauseContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/PauseContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/PauseContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/PauseContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/PauseContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/PauseContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/PauseContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/PauseContact) 

# PutUserStatus
<a name="API_PutUserStatus"></a>

Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status.

For more information, see [Agent status](https://docs.aws.amazon.com/connect/latest/adminguide/metrics-agent-status.html) and [Set your next status](https://docs.aws.amazon.com/connect/latest/adminguide/set-next-status.html) in the *Amazon Connect Administrator Guide*.

## Request Syntax
<a name="API_PutUserStatus_RequestSyntax"></a>

```
PUT /users/InstanceId/UserId/status HTTP/1.1
Content-type: application/json

{
   "AgentStatusId": "string"
}
```

## URI Request Parameters
<a name="API_PutUserStatus_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_PutUserStatus_RequestSyntax) **   <a name="connect-PutUserStatus-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [UserId](#API_PutUserStatus_RequestSyntax) **   <a name="connect-PutUserStatus-request-uri-UserId"></a>
The identifier of the user.  
Required: Yes

## Request Body
<a name="API_PutUserStatus_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AgentStatusId](#API_PutUserStatus_RequestSyntax) **   <a name="connect-PutUserStatus-request-AgentStatusId"></a>
The identifier of the agent status.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_PutUserStatus_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_PutUserStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_PutUserStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_PutUserStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/PutUserStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/PutUserStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/PutUserStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/PutUserStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/PutUserStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/PutUserStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/PutUserStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/PutUserStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/PutUserStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/PutUserStatus) 

# ReleasePhoneNumber
<a name="API_ReleasePhoneNumber"></a>

Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the AWS Region where the number was claimed.

**Important**  
To release phone numbers from a traffic distribution group, use the `ReleasePhoneNumber` API, not the Amazon Connect admin website.  
After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Support.

If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired.

By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired. 

For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an AWS support ticket.

## Request Syntax
<a name="API_ReleasePhoneNumber_RequestSyntax"></a>

```
DELETE /phone-number/PhoneNumberId?clientToken=ClientToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ReleasePhoneNumber_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ClientToken](#API_ReleasePhoneNumber_RequestSyntax) **   <a name="connect-ReleasePhoneNumber-request-uri-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Length Constraints: Maximum length of 500.

 ** [PhoneNumberId](#API_ReleasePhoneNumber_RequestSyntax) **   <a name="connect-ReleasePhoneNumber-request-uri-PhoneNumberId"></a>
A unique identifier for the phone number.  
Required: Yes

## Request Body
<a name="API_ReleasePhoneNumber_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ReleasePhoneNumber_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_ReleasePhoneNumber_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_ReleasePhoneNumber_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** IdempotencyException **   
An entity with the same name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceInUseException **   
That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.    
 ** ResourceId **   
The identifier for the resource.  
 ** ResourceType **   
The type of resource.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ReleasePhoneNumber_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ReleasePhoneNumber) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ReleasePhoneNumber) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ReleasePhoneNumber) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ReleasePhoneNumber) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ReleasePhoneNumber) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ReleasePhoneNumber) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ReleasePhoneNumber) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ReleasePhoneNumber) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ReleasePhoneNumber) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ReleasePhoneNumber) 

# ReplicateInstance
<a name="API_ReplicateInstance"></a>

Replicates an Amazon Connect instance in the specified AWS Region and copies configuration information for Amazon Connect resources across AWS Regions. 

For more information about replicating an Amazon Connect instance, see [Create a replica of your existing Amazon Connect instance](https://docs.aws.amazon.com/connect/latest/adminguide/create-replica-connect-instance.html) in the *Amazon Connect Administrator Guide*.

## Request Syntax
<a name="API_ReplicateInstance_RequestSyntax"></a>

```
POST /instance/InstanceId/replicate HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "ReplicaAlias": "string",
   "ReplicaRegion": "string"
}
```

## URI Request Parameters
<a name="API_ReplicateInstance_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_ReplicateInstance_RequestSyntax) **   <a name="connect-ReplicateInstance-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance. You can provide the `InstanceId`, or the entire ARN.  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

## Request Body
<a name="API_ReplicateInstance_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_ReplicateInstance_RequestSyntax) **   <a name="connect-ReplicateInstance-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [ReplicaAlias](#API_ReplicateInstance_RequestSyntax) **   <a name="connect-ReplicateInstance-request-ReplicaAlias"></a>
The alias for the replicated instance. The `ReplicaAlias` must be unique.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 45.  
Pattern: `^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*$`   
Required: Yes

 ** [ReplicaRegion](#API_ReplicateInstance_RequestSyntax) **   <a name="connect-ReplicateInstance-request-ReplicaRegion"></a>
The AWS Region where to replicate the Amazon Connect instance.  
Type: String  
Length Constraints: Minimum length of 8. Maximum length of 31.  
Pattern: `[a-z]{2}(-[a-z]+){1,2}(-[0-9])?`   
Required: Yes

## Response Syntax
<a name="API_ReplicateInstance_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Id": "string"
}
```

## Response Elements
<a name="API_ReplicateInstance_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_ReplicateInstance_ResponseSyntax) **   <a name="connect-ReplicateInstance-response-Arn"></a>
The Amazon Resource Name (ARN) of the replicated instance.  
Type: String

 ** [Id](#API_ReplicateInstance_ResponseSyntax) **   <a name="connect-ReplicateInstance-response-Id"></a>
The identifier of the replicated instance. You can find the `instanceId` in the ARN of the instance. The replicated instance has the same identifier as the instance it was replicated from.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

## Errors
<a name="API_ReplicateInstance_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ResourceNotReadyException **   
The resource is not ready.  
HTTP Status Code: 409

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ReplicateInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ReplicateInstance) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ReplicateInstance) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ReplicateInstance) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ReplicateInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ReplicateInstance) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ReplicateInstance) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ReplicateInstance) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ReplicateInstance) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ReplicateInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ReplicateInstance) 

# ResumeContact
<a name="API_ResumeContact"></a>

Allows resuming a task contact in a paused state.

## Request Syntax
<a name="API_ResumeContact_RequestSyntax"></a>

```
POST /contact/resume HTTP/1.1
Content-type: application/json

{
   "ContactFlowId": "string",
   "ContactId": "string",
   "InstanceId": "string"
}
```

## URI Request Parameters
<a name="API_ResumeContact_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ResumeContact_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ContactFlowId](#API_ResumeContact_RequestSyntax) **   <a name="connect-ResumeContact-request-ContactFlowId"></a>
The identifier of the flow.  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [ContactId](#API_ResumeContact_RequestSyntax) **   <a name="connect-ResumeContact-request-ContactId"></a>
The identifier of the contact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_ResumeContact_RequestSyntax) **   <a name="connect-ResumeContact-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the `instanceId` in the ARN of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Syntax
<a name="API_ResumeContact_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_ResumeContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_ResumeContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
Operation cannot be performed at this time as there is a conflict with another operation or contact state.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_ResumeContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ResumeContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ResumeContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ResumeContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ResumeContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ResumeContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ResumeContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ResumeContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ResumeContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ResumeContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ResumeContact) 

# ResumeContactRecording
<a name="API_ResumeContactRecording"></a>

When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.

Voice and screen recordings are supported.

## Request Syntax
<a name="API_ResumeContactRecording_RequestSyntax"></a>

```
POST /contact/resume-recording HTTP/1.1
Content-type: application/json

{
   "ContactId": "string",
   "ContactRecordingType": "string",
   "InitialContactId": "string",
   "InstanceId": "string"
}
```

## URI Request Parameters
<a name="API_ResumeContactRecording_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ResumeContactRecording_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ContactId](#API_ResumeContactRecording_RequestSyntax) **   <a name="connect-ResumeContactRecording-request-ContactId"></a>
The identifier of the contact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [ContactRecordingType](#API_ResumeContactRecording_RequestSyntax) **   <a name="connect-ResumeContactRecording-request-ContactRecordingType"></a>
The type of recording being operated on.  
Type: String  
Valid Values: `AGENT | IVR | SCREEN`   
Required: No

 ** [InitialContactId](#API_ResumeContactRecording_RequestSyntax) **   <a name="connect-ResumeContactRecording-request-InitialContactId"></a>
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_ResumeContactRecording_RequestSyntax) **   <a name="connect-ResumeContactRecording-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Syntax
<a name="API_ResumeContactRecording_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_ResumeContactRecording_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_ResumeContactRecording_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidActiveRegionException **   
This exception occurs when an API request is made to a non-active region in an Amazon Connect instance configured with Amazon Connect Global Resiliency. For example, if the active region is US West (Oregon) and a request is made to US East (N. Virginia), the exception will be returned.  
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

## See Also
<a name="API_ResumeContactRecording_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/ResumeContactRecording) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/ResumeContactRecording) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/ResumeContactRecording) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/ResumeContactRecording) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/ResumeContactRecording) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/ResumeContactRecording) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/ResumeContactRecording) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/ResumeContactRecording) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/ResumeContactRecording) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/ResumeContactRecording) 

# SearchAgentStatuses
<a name="API_SearchAgentStatuses"></a>

Searches AgentStatuses in an Amazon Connect instance, with optional filtering.

## Request Syntax
<a name="API_SearchAgentStatuses_RequestSyntax"></a>

```
POST /search-agent-statuses HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "AgentStatusSearchCriteria"
      ],
      "OrConditions": [ 
         "AgentStatusSearchCriteria"
      ],
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   },
   "SearchFilter": { 
      "AttributeFilter": { 
         "AndCondition": { 
            "TagConditions": [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         },
         "OrConditions": [ 
            { 
               "TagConditions": [ 
                  { 
                     "TagKey": "string",
                     "TagValue": "string"
                  }
               ]
            }
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchAgentStatuses_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchAgentStatuses_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchAgentStatuses_RequestSyntax) **   <a name="connect-SearchAgentStatuses-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_SearchAgentStatuses_RequestSyntax) **   <a name="connect-SearchAgentStatuses-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_SearchAgentStatuses_RequestSyntax) **   <a name="connect-SearchAgentStatuses-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

 ** [SearchCriteria](#API_SearchAgentStatuses_RequestSyntax) **   <a name="connect-SearchAgentStatuses-request-SearchCriteria"></a>
The search criteria to be used to return agent statuses.  
Type: [AgentStatusSearchCriteria](API_AgentStatusSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchAgentStatuses_RequestSyntax) **   <a name="connect-SearchAgentStatuses-request-SearchFilter"></a>
Filters to be applied to search results.  
Type: [AgentStatusSearchFilter](API_AgentStatusSearchFilter.md) object  
Required: No

## Response Syntax
<a name="API_SearchAgentStatuses_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AgentStatuses": [ 
      { 
         "AgentStatusARN": "string",
         "AgentStatusId": "string",
         "Description": "string",
         "DisplayOrder": number,
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string",
         "State": "string",
         "Tags": { 
            "string" : "string" 
         },
         "Type": "string"
      }
   ],
   "ApproximateTotalCount": number,
   "NextToken": "string"
}
```

## Response Elements
<a name="API_SearchAgentStatuses_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AgentStatuses](#API_SearchAgentStatuses_ResponseSyntax) **   <a name="connect-SearchAgentStatuses-response-AgentStatuses"></a>
The search criteria to be used to return agent statuses.  
Type: Array of [AgentStatus](API_AgentStatus.md) objects

 ** [ApproximateTotalCount](#API_SearchAgentStatuses_ResponseSyntax) **   <a name="connect-SearchAgentStatuses-response-ApproximateTotalCount"></a>
The total number of agent statuses which matched your search query.  
Type: Long

 ** [NextToken](#API_SearchAgentStatuses_ResponseSyntax) **   <a name="connect-SearchAgentStatuses-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.

## Errors
<a name="API_SearchAgentStatuses_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchAgentStatuses_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchAgentStatuses) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchAgentStatuses) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchAgentStatuses) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchAgentStatuses) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchAgentStatuses) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchAgentStatuses) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchAgentStatuses) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchAgentStatuses) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchAgentStatuses) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchAgentStatuses) 

# SearchAvailablePhoneNumbers
<a name="API_SearchAvailablePhoneNumbers"></a>

Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided `TargetArn` is a traffic distribution group, you can call this API in both AWS Regions associated with the traffic distribution group.

## Request Syntax
<a name="API_SearchAvailablePhoneNumbers_RequestSyntax"></a>

```
POST /phone-number/search-available HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "PhoneNumberCountryCode": "string",
   "PhoneNumberPrefix": "string",
   "PhoneNumberType": "string",
   "TargetArn": "string"
}
```

## URI Request Parameters
<a name="API_SearchAvailablePhoneNumbers_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchAvailablePhoneNumbers_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchAvailablePhoneNumbers_RequestSyntax) **   <a name="connect-SearchAvailablePhoneNumbers-request-InstanceId"></a>
The identifier of the Amazon Connect instance that phone numbers are claimed to. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance. You must enter `InstanceId` or `TargetArn`.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [MaxResults](#API_SearchAvailablePhoneNumbers_RequestSyntax) **   <a name="connect-SearchAvailablePhoneNumbers-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 10.  
Required: No

 ** [NextToken](#API_SearchAvailablePhoneNumbers_RequestSyntax) **   <a name="connect-SearchAvailablePhoneNumbers-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100000.  
Required: No

 ** [PhoneNumberCountryCode](#API_SearchAvailablePhoneNumbers_RequestSyntax) **   <a name="connect-SearchAvailablePhoneNumbers-request-PhoneNumberCountryCode"></a>
The ISO country code.  
Type: String  
Valid Values: `AF | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU | AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BA | BW | BR | IO | VG | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL | CN | CX | CC | CO | KM | CK | CR | HR | CU | CW | CY | CZ | CD | DK | DJ | DM | DO | TL | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR | PF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GU | GT | GG | GN | GW | GY | HT | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | CI | JM | JP | JE | JO | KZ | KE | KI | KW | KG | LA | LV | LB | LS | LR | LY | LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MR | MU | YT | MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | AN | NC | NZ | NI | NE | NG | NU | KP | MP | NO | OM | PK | PW | PA | PG | PY | PE | PH | PN | PL | PT | PR | QA | CG | RE | RO | RU | RW | BL | SH | KN | LC | MF | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SX | SK | SI | SB | SO | ZA | KR | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TW | TJ | TZ | TH | TG | TK | TO | TT | TN | TR | TM | TC | TV | VI | UG | UA | AE | GB | US | UY | UZ | VU | VA | VE | VN | WF | EH | YE | ZM | ZW`   
Required: Yes

 ** [PhoneNumberPrefix](#API_SearchAvailablePhoneNumbers_RequestSyntax) **   <a name="connect-SearchAvailablePhoneNumbers-request-PhoneNumberPrefix"></a>
The prefix of the phone number. If provided, it must contain `+` as part of the country code.  
Type: String  
Pattern: `\\+?[0-9]{1,11}`   
Required: No

 ** [PhoneNumberType](#API_SearchAvailablePhoneNumbers_RequestSyntax) **   <a name="connect-SearchAvailablePhoneNumbers-request-PhoneNumberType"></a>
The type of phone number.  
Type: String  
Valid Values: `TOLL_FREE | DID | UIFN | SHARED | THIRD_PARTY_TF | THIRD_PARTY_DID | SHORT_CODE`   
Required: Yes

 ** [TargetArn](#API_SearchAvailablePhoneNumbers_RequestSyntax) **   <a name="connect-SearchAvailablePhoneNumbers-request-TargetArn"></a>
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter `InstanceId` or `TargetArn`.   
Type: String  
Required: No

## Response Syntax
<a name="API_SearchAvailablePhoneNumbers_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AvailableNumbersList": [ 
      { 
         "PhoneNumber": "string",
         "PhoneNumberCountryCode": "string",
         "PhoneNumberType": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_SearchAvailablePhoneNumbers_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AvailableNumbersList](#API_SearchAvailablePhoneNumbers_ResponseSyntax) **   <a name="connect-SearchAvailablePhoneNumbers-response-AvailableNumbersList"></a>
A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.  
Type: Array of [AvailableNumberSummary](API_AvailableNumberSummary.md) objects

 ** [NextToken](#API_SearchAvailablePhoneNumbers_ResponseSyntax) **   <a name="connect-SearchAvailablePhoneNumbers-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100000.

## Errors
<a name="API_SearchAvailablePhoneNumbers_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchAvailablePhoneNumbers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchAvailablePhoneNumbers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchAvailablePhoneNumbers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchAvailablePhoneNumbers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchAvailablePhoneNumbers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchAvailablePhoneNumbers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchAvailablePhoneNumbers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchAvailablePhoneNumbers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchAvailablePhoneNumbers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchAvailablePhoneNumbers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchAvailablePhoneNumbers) 

# SearchContactEvaluations
<a name="API_SearchContactEvaluations"></a>

Searches contact evaluations in an Amazon Connect instance, with optional filtering. 

 **Use cases** 

Following are common uses cases for this API:
+ Find contact evaluations by using specific search criteria.
+ Find contact evaluations that are tagged with a specific set of tags.

 **Important things to know** 
+ A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don't see updated information for recently changed contact evaluations, try calling the API again in a few seconds.

 **Endpoints**: See [Amazon Connect endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/connect_region.html).

## Request Syntax
<a name="API_SearchContactEvaluations_RequestSyntax"></a>

```
POST /search-contact-evaluations HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "EvaluationSearchCriteria"
      ],
      "BooleanCondition": { 
         "ComparisonType": "string",
         "FieldName": "string"
      },
      "DateTimeCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "MaxValue": "string",
         "MinValue": "string"
      },
      "DecimalCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "MaxValue": number,
         "MinValue": number
      },
      "NumberCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "MaxValue": number,
         "MinValue": number
      },
      "OrConditions": [ 
         "EvaluationSearchCriteria"
      ],
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   },
   "SearchFilter": { 
      "AttributeFilter": { 
         "AndCondition": { 
            "TagConditions": [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         },
         "OrConditions": [ 
            { 
               "TagConditions": [ 
                  { 
                     "TagKey": "string",
                     "TagValue": "string"
                  }
               ]
            }
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchContactEvaluations_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchContactEvaluations_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchContactEvaluations_RequestSyntax) **   <a name="connect-SearchContactEvaluations-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_SearchContactEvaluations_RequestSyntax) **   <a name="connect-SearchContactEvaluations-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_SearchContactEvaluations_RequestSyntax) **   <a name="connect-SearchContactEvaluations-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Required: No

 ** [SearchCriteria](#API_SearchContactEvaluations_RequestSyntax) **   <a name="connect-SearchContactEvaluations-request-SearchCriteria"></a>
The search criteria to be used to return contact evaluations.  
Type: [EvaluationSearchCriteria](API_EvaluationSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchContactEvaluations_RequestSyntax) **   <a name="connect-SearchContactEvaluations-request-SearchFilter"></a>
Filters to be applied to search results.  
Type: [EvaluationSearchFilter](API_EvaluationSearchFilter.md) object  
Required: No

## Response Syntax
<a name="API_SearchContactEvaluations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "EvaluationSearchSummaryList": [ 
      { 
         "CreatedTime": number,
         "EvaluationArn": "string",
         "EvaluationFormId": "string",
         "EvaluationFormTitle": "string",
         "EvaluationFormVersion": number,
         "EvaluationId": "string",
         "EvaluationType": "string",
         "LastModifiedTime": number,
         "Metadata": { 
            "AcknowledgedBy": "string",
            "AcknowledgedTime": number,
            "AcknowledgerComment": "string",
            "AutoEvaluationEnabled": boolean,
            "AutoEvaluationStatus": "string",
            "CalibrationSessionId": "string",
            "ContactAgentId": "string",
            "ContactId": "string",
            "ContactParticipantId": "string",
            "ContactParticipantRole": "string",
            "EvaluatorArn": "string",
            "ReviewId": "string",
            "SamplingJobId": "string",
            "ScoreAutomaticFail": boolean,
            "ScoreNotApplicable": boolean,
            "ScorePercentage": number
         },
         "Status": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_SearchContactEvaluations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_SearchContactEvaluations_ResponseSyntax) **   <a name="connect-SearchContactEvaluations-response-ApproximateTotalCount"></a>
The total number of contact evaluations that matched your search query.  
Type: Long

 ** [EvaluationSearchSummaryList](#API_SearchContactEvaluations_ResponseSyntax) **   <a name="connect-SearchContactEvaluations-response-EvaluationSearchSummaryList"></a>
Contains information about contact evaluations.  
Type: Array of [EvaluationSearchSummary](API_EvaluationSearchSummary.md) objects

 ** [NextToken](#API_SearchContactEvaluations_ResponseSyntax) **   <a name="connect-SearchContactEvaluations-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_SearchContactEvaluations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_SearchContactEvaluations_Examples"></a>

### Example request to retrieve evaluations in instance
<a name="API_SearchContactEvaluations_Example_1"></a>

This example illustrates one usage of SearchContactEvaluations.

```
{
  "InstanceId": "12345678-1234-5678-aabb-123456abcdef"
}
```

### Example request to retrieve an evaluation with a specific ID in instance
<a name="API_SearchContactEvaluations_Example_2"></a>

This example illustrates one usage of SearchContactEvaluations.

```
{
  "InstanceId": "12345678-1234-5678-aabb-123456abcdef",
  "SearchCriteria": {
    "StringCondition": {
      "ComparisonType": "EXACT",
      "FieldName": "EvaluationId", 
      "Value": "87654321-4321-8765-bbaa-abcdef123456"
    }
  }
}
```

### Example request to retrieve evaluations by using multiple search criteria
<a name="API_SearchContactEvaluations_Example_3"></a>

This example illustrates one usage of SearchContactEvaluations.

```
{
  "InstanceId": "12345678-1234-5678-aabb-123456abcdef",
  "SearchCriteria": {
    "OrConditions": [
      {
        "AndConditions": [
          {
            "DateTimeCondition": {
              "ComparisonType": "GREATER_THAN", 
              "FieldName": "LastModifiedTime",
              "MinValue": "2020-01-01T00:00:00Z"
            }
          },
          {
            "NumberCondition": {
              "ComparisonType": "EQUAL",
              "FieldName": "EvaluationFormVersion", 
              "MinValue": 1
            }
          },
          {
            "BooleanCondition": {
              "ComparisonType": "IS_FALSE",
              "FieldName": "AutoEvaluationEnabled"
            }
          }
        ]
      }
    ]
  }
}
```

## See Also
<a name="API_SearchContactEvaluations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchContactEvaluations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchContactEvaluations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchContactEvaluations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchContactEvaluations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchContactEvaluations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchContactEvaluations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchContactEvaluations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchContactEvaluations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchContactEvaluations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchContactEvaluations) 

# SearchContactFlowModules
<a name="API_SearchContactFlowModules"></a>

Searches the flow modules in an Amazon Connect instance, with optional filtering.

## Request Syntax
<a name="API_SearchContactFlowModules_RequestSyntax"></a>

```
POST /search-contact-flow-modules HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "ContactFlowModuleSearchCriteria"
      ],
      "OrConditions": [ 
         "ContactFlowModuleSearchCriteria"
      ],
      "StateCondition": "string",
      "StatusCondition": "string",
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   },
   "SearchFilter": { 
      "TagFilter": { 
         "AndConditions": [ 
            { 
               "TagKey": "string",
               "TagValue": "string"
            }
         ],
         "OrConditions": [ 
            [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchContactFlowModules_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchContactFlowModules_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchContactFlowModules_RequestSyntax) **   <a name="connect-SearchContactFlowModules-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_SearchContactFlowModules_RequestSyntax) **   <a name="connect-SearchContactFlowModules-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_SearchContactFlowModules_RequestSyntax) **   <a name="connect-SearchContactFlowModules-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

 ** [SearchCriteria](#API_SearchContactFlowModules_RequestSyntax) **   <a name="connect-SearchContactFlowModules-request-SearchCriteria"></a>
The search criteria to be used to return flow modules.  
The `name` and `description` fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.
Type: [ContactFlowModuleSearchCriteria](API_ContactFlowModuleSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchContactFlowModules_RequestSyntax) **   <a name="connect-SearchContactFlowModules-request-SearchFilter"></a>
Filters to be applied to search results.  
Type: [ContactFlowModuleSearchFilter](API_ContactFlowModuleSearchFilter.md) object  
Required: No

## Response Syntax
<a name="API_SearchContactFlowModules_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "ContactFlowModules": [ 
      { 
         "Arn": "string",
         "Content": "string",
         "Description": "string",
         "ExternalInvocationConfiguration": { 
            "Enabled": boolean
         },
         "FlowModuleContentSha256": "string",
         "Id": "string",
         "Name": "string",
         "Settings": "string",
         "State": "string",
         "Status": "string",
         "Tags": { 
            "string" : "string" 
         },
         "Version": number,
         "VersionDescription": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_SearchContactFlowModules_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_SearchContactFlowModules_ResponseSyntax) **   <a name="connect-SearchContactFlowModules-response-ApproximateTotalCount"></a>
The total number of flows which matched your search query.  
Type: Long

 ** [ContactFlowModules](#API_SearchContactFlowModules_ResponseSyntax) **   <a name="connect-SearchContactFlowModules-response-ContactFlowModules"></a>
The search criteria to be used to return flow modules.  
Type: Array of [ContactFlowModule](API_ContactFlowModule.md) objects

 ** [NextToken](#API_SearchContactFlowModules_ResponseSyntax) **   <a name="connect-SearchContactFlowModules-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.

## Errors
<a name="API_SearchContactFlowModules_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchContactFlowModules_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchContactFlowModules) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchContactFlowModules) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchContactFlowModules) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchContactFlowModules) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchContactFlowModules) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchContactFlowModules) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchContactFlowModules) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchContactFlowModules) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchContactFlowModules) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchContactFlowModules) 

# SearchContactFlows
<a name="API_SearchContactFlows"></a>

Searches the flows in an Amazon Connect instance, with optional filtering.

## Request Syntax
<a name="API_SearchContactFlows_RequestSyntax"></a>

```
POST /search-contact-flows HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "ContactFlowSearchCriteria"
      ],
      "OrConditions": [ 
         "ContactFlowSearchCriteria"
      ],
      "StateCondition": "string",
      "StatusCondition": "string",
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      },
      "TypeCondition": "string"
   },
   "SearchFilter": { 
      "FlowAttributeFilter": { 
         "AndCondition": { 
            "ContactFlowTypeCondition": { 
               "ContactFlowType": "string"
            },
            "TagConditions": [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         },
         "ContactFlowTypeCondition": { 
            "ContactFlowType": "string"
         },
         "OrConditions": [ 
            { 
               "ContactFlowTypeCondition": { 
                  "ContactFlowType": "string"
               },
               "TagConditions": [ 
                  { 
                     "TagKey": "string",
                     "TagValue": "string"
                  }
               ]
            }
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      },
      "TagFilter": { 
         "AndConditions": [ 
            { 
               "TagKey": "string",
               "TagValue": "string"
            }
         ],
         "OrConditions": [ 
            [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchContactFlows_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchContactFlows_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchContactFlows_RequestSyntax) **   <a name="connect-SearchContactFlows-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_SearchContactFlows_RequestSyntax) **   <a name="connect-SearchContactFlows-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_SearchContactFlows_RequestSyntax) **   <a name="connect-SearchContactFlows-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

 ** [SearchCriteria](#API_SearchContactFlows_RequestSyntax) **   <a name="connect-SearchContactFlows-request-SearchCriteria"></a>
The search criteria to be used to return flows.  
The `name` and `description` fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will result in invalid results.
Type: [ContactFlowSearchCriteria](API_ContactFlowSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchContactFlows_RequestSyntax) **   <a name="connect-SearchContactFlows-request-SearchFilter"></a>
Filters to be applied to search results.  
Type: [ContactFlowSearchFilter](API_ContactFlowSearchFilter.md) object  
Required: No

## Response Syntax
<a name="API_SearchContactFlows_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "ContactFlows": [ 
      { 
         "Arn": "string",
         "Content": "string",
         "Description": "string",
         "FlowContentSha256": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string",
         "State": "string",
         "Status": "string",
         "Tags": { 
            "string" : "string" 
         },
         "Type": "string",
         "Version": number,
         "VersionDescription": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_SearchContactFlows_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_SearchContactFlows_ResponseSyntax) **   <a name="connect-SearchContactFlows-response-ApproximateTotalCount"></a>
The total number of flows which matched your search query.  
Type: Long

 ** [ContactFlows](#API_SearchContactFlows_ResponseSyntax) **   <a name="connect-SearchContactFlows-response-ContactFlows"></a>
Information about the flows.  
Type: Array of [ContactFlow](API_ContactFlow.md) objects

 ** [NextToken](#API_SearchContactFlows_ResponseSyntax) **   <a name="connect-SearchContactFlows-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.

## Errors
<a name="API_SearchContactFlows_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchContactFlows_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchContactFlows) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchContactFlows) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchContactFlows) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchContactFlows) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchContactFlows) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchContactFlows) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchContactFlows) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchContactFlows) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchContactFlows) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchContactFlows) 

# SearchContacts
<a name="API_SearchContacts"></a>

Searches contacts in an Amazon Connect instance.

## Request Syntax
<a name="API_SearchContacts_RequestSyntax"></a>

```
POST /search-contacts HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "ActiveRegions": [ "string" ],
      "AdditionalTimeRange": { 
         "Criteria": [ 
            { 
               "TimeRange": { 
                  "EndTime": number,
                  "StartTime": number,
                  "Type": "string"
               },
               "TimestampCondition": { 
                  "ConditionType": "string",
                  "Type": "string"
               }
            }
         ],
         "MatchType": "string"
      },
      "AgentHierarchyGroups": { 
         "L1Ids": [ "string" ],
         "L2Ids": [ "string" ],
         "L3Ids": [ "string" ],
         "L4Ids": [ "string" ],
         "L5Ids": [ "string" ]
      },
      "AgentIds": [ "string" ],
      "Channels": [ "string" ],
      "ContactAnalysis": { 
         "Transcript": { 
            "Criteria": [ 
               { 
                  "MatchType": "string",
                  "ParticipantRole": "string",
                  "SearchText": [ "string" ]
               }
            ],
            "MatchType": "string"
         }
      },
      "ContactTags": { 
         "AndConditions": [ 
            { 
               "TagKey": "string",
               "TagValue": "string"
            }
         ],
         "OrConditions": [ 
            [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      },
      "InitiationMethods": [ "string" ],
      "Name": { 
         "MatchType": "string",
         "SearchText": [ "string" ]
      },
      "QueueIds": [ "string" ],
      "RoutingCriteria": { 
         "Steps": [ 
            { 
               "AgentCriteria": { 
                  "AgentIds": [ "string" ],
                  "MatchType": "string"
               }
            }
         ]
      },
      "SearchableContactAttributes": { 
         "Criteria": [ 
            { 
               "Key": "string",
               "Values": [ "string" ]
            }
         ],
         "MatchType": "string"
      },
      "SearchableSegmentAttributes": { 
         "Criteria": [ 
            { 
               "Key": "string",
               "Values": [ "string" ]
            }
         ],
         "MatchType": "string"
      }
   },
   "Sort": { 
      "FieldName": "string",
      "Order": "string"
   },
   "TimeRange": { 
      "EndTime": number,
      "StartTime": number,
      "Type": "string"
   }
}
```

## URI Request Parameters
<a name="API_SearchContacts_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchContacts_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchContacts_RequestSyntax) **   <a name="connect-SearchContacts-request-InstanceId"></a>
The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_SearchContacts_RequestSyntax) **   <a name="connect-SearchContacts-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_SearchContacts_RequestSyntax) **   <a name="connect-SearchContacts-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100000.  
Required: No

 ** [SearchCriteria](#API_SearchContacts_RequestSyntax) **   <a name="connect-SearchContacts-request-SearchCriteria"></a>
The search criteria to be used to return contacts.  
Type: [SearchCriteria](API_SearchCriteria.md) object  
Required: No

 ** [Sort](#API_SearchContacts_RequestSyntax) **   <a name="connect-SearchContacts-request-Sort"></a>
Specifies a field to sort by and a sort order.  
Type: [Sort](API_Sort.md) object  
Required: No

 ** [TimeRange](#API_SearchContacts_RequestSyntax) **   <a name="connect-SearchContacts-request-TimeRange"></a>
Time range that you want to search results.  
Type: [SearchContactsTimeRange](API_SearchContactsTimeRange.md) object  
Required: Yes

## Response Syntax
<a name="API_SearchContacts_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Contacts": [ 
      { 
         "AgentInfo": { 
            "ConnectedToAgentTimestamp": number,
            "Id": "string"
         },
         "Arn": "string",
         "Channel": "string",
         "DisconnectTimestamp": number,
         "GlobalResiliencyMetadata": { 
            "ActiveRegion": "string",
            "OriginRegion": "string",
            "TrafficDistributionGroupId": "string"
         },
         "Id": "string",
         "InitialContactId": "string",
         "InitiationMethod": "string",
         "InitiationTimestamp": number,
         "Name": "string",
         "PreviousContactId": "string",
         "QueueInfo": { 
            "EnqueueTimestamp": number,
            "Id": "string"
         },
         "RoutingCriteria": { 
            "ActivationTimestamp": number,
            "Index": number,
            "Steps": [ 
               { 
                  "Expiry": { 
                     "DurationInSeconds": number,
                     "ExpiryTimestamp": number
                  },
                  "Expression": { 
                     "AndExpression": [ 
                        "Expression"
                     ],
                     "AttributeCondition": { 
                        "ComparisonOperator": "string",
                        "MatchCriteria": { 
                           "AgentsCriteria": { 
                              "AgentIds": [ "string" ]
                           }
                        },
                        "Name": "string",
                        "ProficiencyLevel": number,
                        "Range": { 
                           "MaxProficiencyLevel": number,
                           "MinProficiencyLevel": number
                        },
                        "Value": "string"
                     },
                     "NotAttributeCondition": { 
                        "ComparisonOperator": "string",
                        "MatchCriteria": { 
                           "AgentsCriteria": { 
                              "AgentIds": [ "string" ]
                           }
                        },
                        "Name": "string",
                        "ProficiencyLevel": number,
                        "Range": { 
                           "MaxProficiencyLevel": number,
                           "MinProficiencyLevel": number
                        },
                        "Value": "string"
                     },
                     "OrExpression": [ 
                        "Expression"
                     ]
                  },
                  "Status": "string"
               }
            ]
         },
         "ScheduledTimestamp": number,
         "SegmentAttributes": { 
            "string" : { 
               "ValueMap": { 
                  "string" : { 
                     "ValueArn": "string",
                     "ValueInteger": number,
                     "ValueList": [ 
                        "SegmentAttributeValue"
                     ],
                     "ValueMap": { 
                        "string" : "SegmentAttributeValue"
                     },
                     "ValueString": "string"
                  }
               },
               "ValueString": "string"
            }
         },
         "Tags": { 
            "string" : "string" 
         }
      }
   ],
   "NextToken": "string",
   "TotalCount": number
}
```

## Response Elements
<a name="API_SearchContacts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Contacts](#API_SearchContacts_ResponseSyntax) **   <a name="connect-SearchContacts-response-Contacts"></a>
Information about the contacts.  
Type: Array of [ContactSearchSummary](API_ContactSearchSummary.md) objects

 ** [NextToken](#API_SearchContacts_ResponseSyntax) **   <a name="connect-SearchContacts-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100000.

 ** [TotalCount](#API_SearchContacts_ResponseSyntax) **   <a name="connect-SearchContacts-response-TotalCount"></a>
The total number of contacts which matched your search query.  
Type: Long

## Errors
<a name="API_SearchContacts_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchContacts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchContacts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchContacts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchContacts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchContacts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchContacts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchContacts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchContacts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchContacts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchContacts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchContacts) 

# SearchDataTables
<a name="API_SearchDataTables"></a>

Searches for data tables based on the table's ID, name, and description. In the future, this operation can support searching on attribute names and possibly primary values. Follows other search operations closely and supports both search criteria and filters.

## Request Syntax
<a name="API_SearchDataTables_RequestSyntax"></a>

```
POST /search-data-tables HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "DataTableSearchCriteria"
      ],
      "OrConditions": [ 
         "DataTableSearchCriteria"
      ],
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   },
   "SearchFilter": { 
      "AttributeFilter": { 
         "AndCondition": { 
            "TagConditions": [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         },
         "OrConditions": [ 
            { 
               "TagConditions": [ 
                  { 
                     "TagKey": "string",
                     "TagValue": "string"
                  }
               ]
            }
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchDataTables_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchDataTables_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchDataTables_RequestSyntax) **   <a name="connect-SearchDataTables-request-InstanceId"></a>
The unique identifier for the Amazon Connect instance to search within.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_SearchDataTables_RequestSyntax) **   <a name="connect-SearchDataTables-request-MaxResults"></a>
The maximum number of data tables to return in one page of results.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1000.  
Required: No

 ** [NextToken](#API_SearchDataTables_RequestSyntax) **   <a name="connect-SearchDataTables-request-NextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Type: String  
Required: No

 ** [SearchCriteria](#API_SearchDataTables_RequestSyntax) **   <a name="connect-SearchDataTables-request-SearchCriteria"></a>
Search criteria including string conditions for matching table names, descriptions, or resource IDs. Supports STARTS\$1WITH, CONTAINS, and EXACT comparison types.  
Type: [DataTableSearchCriteria](API_DataTableSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchDataTables_RequestSyntax) **   <a name="connect-SearchDataTables-request-SearchFilter"></a>
Optional filters to apply to the search results, such as tag-based filtering for attribute-based access control.  
Type: [DataTableSearchFilter](API_DataTableSearchFilter.md) object  
Required: No

## Response Syntax
<a name="API_SearchDataTables_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "DataTables": [ 
      { 
         "Arn": "string",
         "CreatedTime": number,
         "Description": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "LockVersion": { 
            "Attribute": "string",
            "DataTable": "string",
            "PrimaryValues": "string",
            "Value": "string"
         },
         "Name": "string",
         "Status": "string",
         "Tags": { 
            "string" : "string" 
         },
         "TimeZone": "string",
         "ValueLockLevel": "string",
         "Version": "string",
         "VersionDescription": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_SearchDataTables_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_SearchDataTables_ResponseSyntax) **   <a name="connect-SearchDataTables-response-ApproximateTotalCount"></a>
The approximate number of data tables that matched the search criteria.  
Type: Long

 ** [DataTables](#API_SearchDataTables_ResponseSyntax) **   <a name="connect-SearchDataTables-response-DataTables"></a>
An array of data tables matching the search criteria with the same structure as DescribeTable except Version, VersionDescription, and LockVersion are omitted.  
Type: Array of [DataTable](API_DataTable.md) objects

 ** [NextToken](#API_SearchDataTables_ResponseSyntax) **   <a name="connect-SearchDataTables-response-NextToken"></a>
Specify the pagination token from a previous request to retrieve the next page of results.  
Type: String

## Errors
<a name="API_SearchDataTables_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchDataTables_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchDataTables) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchDataTables) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchDataTables) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchDataTables) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchDataTables) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchDataTables) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchDataTables) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchDataTables) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchDataTables) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchDataTables) 

# SearchEmailAddresses
<a name="API_SearchEmailAddresses"></a>

Searches email address in an instance, with optional filtering.

## Request Syntax
<a name="API_SearchEmailAddresses_RequestSyntax"></a>

```
POST /search-email-addresses HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "EmailAddressSearchCriteria"
      ],
      "OrConditions": [ 
         "EmailAddressSearchCriteria"
      ],
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   },
   "SearchFilter": { 
      "TagFilter": { 
         "AndConditions": [ 
            { 
               "TagKey": "string",
               "TagValue": "string"
            }
         ],
         "OrConditions": [ 
            [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchEmailAddresses_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchEmailAddresses_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchEmailAddresses_RequestSyntax) **   <a name="connect-SearchEmailAddresses-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_SearchEmailAddresses_RequestSyntax) **   <a name="connect-SearchEmailAddresses-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_SearchEmailAddresses_RequestSyntax) **   <a name="connect-SearchEmailAddresses-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

 ** [SearchCriteria](#API_SearchEmailAddresses_RequestSyntax) **   <a name="connect-SearchEmailAddresses-request-SearchCriteria"></a>
The search criteria to be used to return email addresses.  
Type: [EmailAddressSearchCriteria](API_EmailAddressSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchEmailAddresses_RequestSyntax) **   <a name="connect-SearchEmailAddresses-request-SearchFilter"></a>
Filters to be applied to search results.  
Type: [EmailAddressSearchFilter](API_EmailAddressSearchFilter.md) object  
Required: No

## Response Syntax
<a name="API_SearchEmailAddresses_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "EmailAddresses": [ 
      { 
         "AliasConfigurations": [ 
            { 
               "EmailAddressId": "string"
            }
         ],
         "Description": "string",
         "DisplayName": "string",
         "EmailAddress": "string",
         "EmailAddressArn": "string",
         "EmailAddressId": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_SearchEmailAddresses_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_SearchEmailAddresses_ResponseSyntax) **   <a name="connect-SearchEmailAddresses-response-ApproximateTotalCount"></a>
The total number of email addresses which matched your search query.  
Type: Long

 ** [EmailAddresses](#API_SearchEmailAddresses_ResponseSyntax) **   <a name="connect-SearchEmailAddresses-response-EmailAddresses"></a>
List of email addresses matching SearchFilter and SearchCriteria   
Type: Array of [EmailAddressMetadata](API_EmailAddressMetadata.md) objects

 ** [NextToken](#API_SearchEmailAddresses_ResponseSyntax) **   <a name="connect-SearchEmailAddresses-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_SearchEmailAddresses_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchEmailAddresses_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchEmailAddresses) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchEmailAddresses) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchEmailAddresses) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchEmailAddresses) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchEmailAddresses) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchEmailAddresses) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchEmailAddresses) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchEmailAddresses) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchEmailAddresses) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchEmailAddresses) 

# SearchEvaluationForms
<a name="API_SearchEvaluationForms"></a>

Searches evaluation forms in an Amazon Connect instance, with optional filtering.

 **Use cases** 

Following are common uses cases for this API:
+ List all evaluation forms in an instance.
+ Find all evaluation forms that meet specific criteria, such as Title, Description, Status, and more.
+ Find all evaluation forms that are tagged with a specific set of tags.

 **Important things to know** 
+ A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don't see updated information for recently changed contact evaluations, try calling the API again in a few seconds.

 **Endpoints**: See [Amazon Connect endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/connect_region.html).

## Request Syntax
<a name="API_SearchEvaluationForms_RequestSyntax"></a>

```
POST /search-evaluation-forms HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "EvaluationFormSearchCriteria"
      ],
      "BooleanCondition": { 
         "ComparisonType": "string",
         "FieldName": "string"
      },
      "DateTimeCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "MaxValue": "string",
         "MinValue": "string"
      },
      "NumberCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "MaxValue": number,
         "MinValue": number
      },
      "OrConditions": [ 
         "EvaluationFormSearchCriteria"
      ],
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   },
   "SearchFilter": { 
      "AttributeFilter": { 
         "AndCondition": { 
            "TagConditions": [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         },
         "OrConditions": [ 
            { 
               "TagConditions": [ 
                  { 
                     "TagKey": "string",
                     "TagValue": "string"
                  }
               ]
            }
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchEvaluationForms_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchEvaluationForms_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchEvaluationForms_RequestSyntax) **   <a name="connect-SearchEvaluationForms-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_SearchEvaluationForms_RequestSyntax) **   <a name="connect-SearchEvaluationForms-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_SearchEvaluationForms_RequestSyntax) **   <a name="connect-SearchEvaluationForms-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Required: No

 ** [SearchCriteria](#API_SearchEvaluationForms_RequestSyntax) **   <a name="connect-SearchEvaluationForms-request-SearchCriteria"></a>
The search criteria to be used to return evaluation forms.  
Type: [EvaluationFormSearchCriteria](API_EvaluationFormSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchEvaluationForms_RequestSyntax) **   <a name="connect-SearchEvaluationForms-request-SearchFilter"></a>
Filters to be applied to search results.  
Type: [EvaluationFormSearchFilter](API_EvaluationFormSearchFilter.md) object  
Required: No

## Response Syntax
<a name="API_SearchEvaluationForms_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "EvaluationFormSearchSummaryList": [ 
      { 
         "ActiveVersion": number,
         "AutoEvaluationEnabled": boolean,
         "ContactInteractionType": "string",
         "CreatedBy": "string",
         "CreatedTime": number,
         "Description": "string",
         "EvaluationFormArn": "string",
         "EvaluationFormId": "string",
         "EvaluationFormLanguage": "string",
         "LastActivatedBy": "string",
         "LastActivatedTime": number,
         "LastModifiedBy": "string",
         "LastModifiedTime": number,
         "LatestVersion": number,
         "Status": "string",
         "Tags": { 
            "string" : "string" 
         },
         "Title": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_SearchEvaluationForms_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_SearchEvaluationForms_ResponseSyntax) **   <a name="connect-SearchEvaluationForms-response-ApproximateTotalCount"></a>
The total number of evaluation forms that matched your search query.  
Type: Long

 ** [EvaluationFormSearchSummaryList](#API_SearchEvaluationForms_ResponseSyntax) **   <a name="connect-SearchEvaluationForms-response-EvaluationFormSearchSummaryList"></a>
Information about the returned evaluation forms.  
Type: Array of [EvaluationFormSearchSummary](API_EvaluationFormSearchSummary.md) objects

 ** [NextToken](#API_SearchEvaluationForms_ResponseSyntax) **   <a name="connect-SearchEvaluationForms-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

## Errors
<a name="API_SearchEvaluationForms_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_SearchEvaluationForms_Examples"></a>

### Example request to retrieve all evaluation forms in an instance
<a name="API_SearchEvaluationForms_Example_1"></a>

This example illustrates one usage of SearchEvaluationForms.

```
{
"InstanceId": "12345678-1234-5678-aabb-123456abcdef"
}
```

### Example request to retrieve an evaluation form with a specific ID in an instance
<a name="API_SearchEvaluationForms_Example_2"></a>

This example illustrates one usage of SearchEvaluationForms.

```
{
  "InstanceId": "12345678-1234-5678-aabb-123456abcdef",
  "SearchCriteria": {
    "StringCondition": {
      "ComparisonType": "EXACT",
      "FieldName": "EvaluationFormId",
      "Value": "87654321-4321-8765-bbaa-abcdef123456"
    }
  }
}
```

### Example request to retrieve evaluation forms by using multiple search criteria in an instance
<a name="API_SearchEvaluationForms_Example_3"></a>

This example illustrates one usage of SearchEvaluationForms.

```
{
  "InstanceId": "12345678-1234-5678-aabb-123456abcdef",
  "SearchCriteria": {
    "OrConditions": [
      {
        "AndConditions": [
          {
            "DateTimeCondition": {
              "ComparisonType": "GREATER_THAN",
              "FieldName": "LastModifiedTime",
              "MinValue": "2020-01-01T00:00:00Z"
            }
          },
          {
            "NumberCondition": {
              "ComparisonType": "EQUAL",
              "FieldName": "LatestVersion",
              "MinValue": 1
            }
          },
          {
            "BooleanCondition": {
              "ComparisonType": "IS_FALSE",
              "FieldName": "AutoEvaluationEnabled"
            }
          }
        ]
      }
    ]
  }
}
```

## See Also
<a name="API_SearchEvaluationForms_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchEvaluationForms) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchEvaluationForms) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchEvaluationForms) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchEvaluationForms) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchEvaluationForms) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchEvaluationForms) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchEvaluationForms) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchEvaluationForms) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchEvaluationForms) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchEvaluationForms) 

# SearchHoursOfOperationOverrides
<a name="API_SearchHoursOfOperationOverrides"></a>

Searches the hours of operation overrides.

## Request Syntax
<a name="API_SearchHoursOfOperationOverrides_RequestSyntax"></a>

```
POST /search-hours-of-operation-overrides HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "HoursOfOperationOverrideSearchCriteria"
      ],
      "DateCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      },
      "OrConditions": [ 
         "HoursOfOperationOverrideSearchCriteria"
      ],
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   },
   "SearchFilter": { 
      "TagFilter": { 
         "AndConditions": [ 
            { 
               "TagKey": "string",
               "TagValue": "string"
            }
         ],
         "OrConditions": [ 
            [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchHoursOfOperationOverrides_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchHoursOfOperationOverrides_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchHoursOfOperationOverrides_RequestSyntax) **   <a name="connect-SearchHoursOfOperationOverrides-request-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_SearchHoursOfOperationOverrides_RequestSyntax) **   <a name="connect-SearchHoursOfOperationOverrides-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_SearchHoursOfOperationOverrides_RequestSyntax) **   <a name="connect-SearchHoursOfOperationOverrides-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

 ** [SearchCriteria](#API_SearchHoursOfOperationOverrides_RequestSyntax) **   <a name="connect-SearchHoursOfOperationOverrides-request-SearchCriteria"></a>
The search criteria to be used to return hours of operations overrides.  
Type: [HoursOfOperationOverrideSearchCriteria](API_HoursOfOperationOverrideSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchHoursOfOperationOverrides_RequestSyntax) **   <a name="connect-SearchHoursOfOperationOverrides-request-SearchFilter"></a>
Filters to be applied to search results.  
Type: [HoursOfOperationSearchFilter](API_HoursOfOperationSearchFilter.md) object  
Required: No

## Response Syntax
<a name="API_SearchHoursOfOperationOverrides_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "HoursOfOperationOverrides": [ 
      { 
         "Config": [ 
            { 
               "Day": "string",
               "EndTime": { 
                  "Hours": number,
                  "Minutes": number
               },
               "StartTime": { 
                  "Hours": number,
                  "Minutes": number
               }
            }
         ],
         "Description": "string",
         "EffectiveFrom": "string",
         "EffectiveTill": "string",
         "HoursOfOperationArn": "string",
         "HoursOfOperationId": "string",
         "HoursOfOperationOverrideId": "string",
         "Name": "string",
         "OverrideType": "string",
         "RecurrenceConfig": { 
            "RecurrencePattern": { 
               "ByMonth": [ number ],
               "ByMonthDay": [ number ],
               "ByWeekdayOccurrence": [ number ],
               "Frequency": "string",
               "Interval": number
            }
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_SearchHoursOfOperationOverrides_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_SearchHoursOfOperationOverrides_ResponseSyntax) **   <a name="connect-SearchHoursOfOperationOverrides-response-ApproximateTotalCount"></a>
The total number of hours of operations which matched your search query.  
Type: Long

 ** [HoursOfOperationOverrides](#API_SearchHoursOfOperationOverrides_ResponseSyntax) **   <a name="connect-SearchHoursOfOperationOverrides-response-HoursOfOperationOverrides"></a>
Information about the hours of operations overrides.  
Type: Array of [HoursOfOperationOverride](API_HoursOfOperationOverride.md) objects

 ** [NextToken](#API_SearchHoursOfOperationOverrides_ResponseSyntax) **   <a name="connect-SearchHoursOfOperationOverrides-response-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.

## Errors
<a name="API_SearchHoursOfOperationOverrides_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchHoursOfOperationOverrides_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchHoursOfOperationOverrides) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchHoursOfOperationOverrides) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchHoursOfOperationOverrides) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchHoursOfOperationOverrides) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchHoursOfOperationOverrides) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchHoursOfOperationOverrides) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchHoursOfOperationOverrides) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchHoursOfOperationOverrides) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchHoursOfOperationOverrides) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchHoursOfOperationOverrides) 

# SearchHoursOfOperations
<a name="API_SearchHoursOfOperations"></a>

Searches the hours of operation in an Amazon Connect instance, with optional filtering.

## Request Syntax
<a name="API_SearchHoursOfOperations_RequestSyntax"></a>

```
POST /search-hours-of-operations HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "HoursOfOperationSearchCriteria"
      ],
      "OrConditions": [ 
         "HoursOfOperationSearchCriteria"
      ],
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   },
   "SearchFilter": { 
      "TagFilter": { 
         "AndConditions": [ 
            { 
               "TagKey": "string",
               "TagValue": "string"
            }
         ],
         "OrConditions": [ 
            [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchHoursOfOperations_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchHoursOfOperations_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchHoursOfOperations_RequestSyntax) **   <a name="connect-SearchHoursOfOperations-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_SearchHoursOfOperations_RequestSyntax) **   <a name="connect-SearchHoursOfOperations-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_SearchHoursOfOperations_RequestSyntax) **   <a name="connect-SearchHoursOfOperations-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

 ** [SearchCriteria](#API_SearchHoursOfOperations_RequestSyntax) **   <a name="connect-SearchHoursOfOperations-request-SearchCriteria"></a>
The search criteria to be used to return hours of operations.  
Type: [HoursOfOperationSearchCriteria](API_HoursOfOperationSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchHoursOfOperations_RequestSyntax) **   <a name="connect-SearchHoursOfOperations-request-SearchFilter"></a>
Filters to be applied to search results.  
Type: [HoursOfOperationSearchFilter](API_HoursOfOperationSearchFilter.md) object  
Required: No

## Response Syntax
<a name="API_SearchHoursOfOperations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "HoursOfOperations": [ 
      { 
         "Config": [ 
            { 
               "Day": "string",
               "EndTime": { 
                  "Hours": number,
                  "Minutes": number
               },
               "StartTime": { 
                  "Hours": number,
                  "Minutes": number
               }
            }
         ],
         "Description": "string",
         "HoursOfOperationArn": "string",
         "HoursOfOperationId": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string",
         "ParentHoursOfOperations": [ 
            { 
               "Arn": "string",
               "Id": "string",
               "Name": "string"
            }
         ],
         "Tags": { 
            "string" : "string" 
         },
         "TimeZone": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_SearchHoursOfOperations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_SearchHoursOfOperations_ResponseSyntax) **   <a name="connect-SearchHoursOfOperations-response-ApproximateTotalCount"></a>
The total number of hours of operations which matched your search query.  
Type: Long

 ** [HoursOfOperations](#API_SearchHoursOfOperations_ResponseSyntax) **   <a name="connect-SearchHoursOfOperations-response-HoursOfOperations"></a>
Information about the hours of operations.  
Type: Array of [HoursOfOperation](API_HoursOfOperation.md) objects

 ** [NextToken](#API_SearchHoursOfOperations_ResponseSyntax) **   <a name="connect-SearchHoursOfOperations-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.

## Errors
<a name="API_SearchHoursOfOperations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchHoursOfOperations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchHoursOfOperations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchHoursOfOperations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchHoursOfOperations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchHoursOfOperations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchHoursOfOperations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchHoursOfOperations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchHoursOfOperations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchHoursOfOperations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchHoursOfOperations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchHoursOfOperations) 

# SearchNotifications
<a name="API_SearchNotifications"></a>

Searches for notifications based on specified criteria and filters. Returns a paginated list of notifications matching the search parameters, ordered by descending creation time. Supports filtering by content and tags.

## Request Syntax
<a name="API_SearchNotifications_RequestSyntax"></a>

```
POST /search-notifications HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "NotificationSearchCriteria"
      ],
      "OrConditions": [ 
         "NotificationSearchCriteria"
      ],
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   },
   "SearchFilter": { 
      "AttributeFilter": { 
         "AndCondition": { 
            "TagConditions": [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         },
         "OrConditions": [ 
            { 
               "TagConditions": [ 
                  { 
                     "TagKey": "string",
                     "TagValue": "string"
                  }
               ]
            }
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchNotifications_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchNotifications_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchNotifications_RequestSyntax) **   <a name="connect-SearchNotifications-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_SearchNotifications_RequestSyntax) **   <a name="connect-SearchNotifications-request-MaxResults"></a>
The maximum number of results to return per page. Valid range is 1-100.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_SearchNotifications_RequestSyntax) **   <a name="connect-SearchNotifications-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response to retrieve the next page of results.  
Type: String  
Required: No

 ** [SearchCriteria](#API_SearchNotifications_RequestSyntax) **   <a name="connect-SearchNotifications-request-SearchCriteria"></a>
The search criteria to apply when searching for notifications. Supports filtering by notification ID and message content using comparison types such as STARTS\$1WITH, CONTAINS, and EXACT.  
Type: [NotificationSearchCriteria](API_NotificationSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchNotifications_RequestSyntax) **   <a name="connect-SearchNotifications-request-SearchFilter"></a>
Filters to apply to the search results, such as tag-based filters.  
Type: [NotificationSearchFilter](API_NotificationSearchFilter.md) object  
Required: No

## Response Syntax
<a name="API_SearchNotifications_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "NextToken": "string",
   "Notifications": [ 
      { 
         "Arn": "string",
         "Content": { 
            "string" : "string" 
         },
         "CreatedAt": number,
         "ExpiresAt": number,
         "Id": "string",
         "InstanceId": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Priority": "string",
         "Recipients": [ "string" ],
         "Tags": { 
            "string" : "string" 
         }
      }
   ]
}
```

## Response Elements
<a name="API_SearchNotifications_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_SearchNotifications_ResponseSyntax) **   <a name="connect-SearchNotifications-response-ApproximateTotalCount"></a>
The approximate total number of notifications matching the search criteria.  
Type: Long

 ** [NextToken](#API_SearchNotifications_ResponseSyntax) **   <a name="connect-SearchNotifications-response-NextToken"></a>
The token for the next set of results. If present, there are more results available.  
Type: String

 ** [Notifications](#API_SearchNotifications_ResponseSyntax) **   <a name="connect-SearchNotifications-response-Notifications"></a>
A list of notifications matching the search criteria.  
Type: Array of [NotificationSearchSummary](API_NotificationSearchSummary.md) objects

## Errors
<a name="API_SearchNotifications_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchNotifications_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchNotifications) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchNotifications) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchNotifications) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchNotifications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchNotifications) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchNotifications) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchNotifications) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchNotifications) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchNotifications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchNotifications) 

# SearchPredefinedAttributes
<a name="API_SearchPredefinedAttributes"></a>

Searches predefined attributes that meet certain criteria. A *predefined attribute* is made up of a name and a value. You can use predefined attributes for:
+ Routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see [Create predefined attributes for routing contacts to agents](https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html).
+ Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see [Use contact segment attributes](https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html).

For the predefined attributes per instance quota, see [Amazon Connect quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas).

 **Endpoints**: See [Amazon Connect endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/connect_region.html).

## Request Syntax
<a name="API_SearchPredefinedAttributes_RequestSyntax"></a>

```
POST /search-predefined-attributes HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "PredefinedAttributeSearchCriteria"
      ],
      "OrConditions": [ 
         "PredefinedAttributeSearchCriteria"
      ],
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchPredefinedAttributes_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchPredefinedAttributes_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchPredefinedAttributes_RequestSyntax) **   <a name="connect-SearchPredefinedAttributes-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_SearchPredefinedAttributes_RequestSyntax) **   <a name="connect-SearchPredefinedAttributes-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_SearchPredefinedAttributes_RequestSyntax) **   <a name="connect-SearchPredefinedAttributes-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

 ** [SearchCriteria](#API_SearchPredefinedAttributes_RequestSyntax) **   <a name="connect-SearchPredefinedAttributes-request-SearchCriteria"></a>
The search criteria to be used to return predefined attributes.  
Type: [PredefinedAttributeSearchCriteria](API_PredefinedAttributeSearchCriteria.md) object  
Required: No

## Response Syntax
<a name="API_SearchPredefinedAttributes_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "NextToken": "string",
   "PredefinedAttributes": [ 
      { 
         "AttributeConfiguration": { 
            "EnableValueValidationOnAssociation": boolean,
            "IsReadOnly": boolean
         },
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string",
         "Purposes": [ "string" ],
         "Values": { ... }
      }
   ]
}
```

## Response Elements
<a name="API_SearchPredefinedAttributes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_SearchPredefinedAttributes_ResponseSyntax) **   <a name="connect-SearchPredefinedAttributes-response-ApproximateTotalCount"></a>
The approximate number of predefined attributes which matched your search query.  
Type: Long

 ** [NextToken](#API_SearchPredefinedAttributes_ResponseSyntax) **   <a name="connect-SearchPredefinedAttributes-response-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.

 ** [PredefinedAttributes](#API_SearchPredefinedAttributes_ResponseSyntax) **   <a name="connect-SearchPredefinedAttributes-response-PredefinedAttributes"></a>
Predefined attributes matched by the search criteria.  
Type: Array of [PredefinedAttribute](API_PredefinedAttribute.md) objects

## Errors
<a name="API_SearchPredefinedAttributes_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_SearchPredefinedAttributes_Examples"></a>

### Example
<a name="API_SearchPredefinedAttributes_Example_1"></a>

The following example shows a request and response.

```
POST https://connect.us-west-2.amazonaws.com/search-predefined-attributes HTTP/1.1
Content-type: application/json
{
    "InstanceId": "InstanceId",
    "MaxResults": 5,
    "SearchCriteria": {
        "StringCondition": {
            "ComparisonType": "EXACT",
            "FieldName": "purposes",
            "Value": "proficiency"
        }
    }
}

Response:
{
    "ApproximateTotalCount": 20,
    "NextToken": "nextToken,
    "PredefinedAttributes": [
        {
            "AttributeConfiguration": {
                "EnableValueValidationOnAssociation": false,
                "IsReadOnly": false
            },
            "LastModifiedRegion": null,
            "LastModifiedTime": null,
            "Name": "Name1",
            "Purposes": [
                "proficiency"
            ],
            "Values": {
                "StringList": [
                    "value1",
                    "value2"
                ]
            }
        },
        {
            "AttributeConfiguration": {
                "EnableValueValidationOnAssociation": false,
                "IsReadOnly": false
            },
            "LastModifiedRegion": null,
            "LastModifiedTime": null,
            "Name": "Name2",
            "Purposes": [
                "contact-attributes-search",
                "proficiency"
            ],
            "Values": {
                "StringList": [
                    "value1",
                    "value2"
                ]
            }
        }
    ]
}
```

## See Also
<a name="API_SearchPredefinedAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchPredefinedAttributes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchPredefinedAttributes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchPredefinedAttributes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchPredefinedAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchPredefinedAttributes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchPredefinedAttributes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchPredefinedAttributes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchPredefinedAttributes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchPredefinedAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchPredefinedAttributes) 

# SearchPrompts
<a name="API_SearchPrompts"></a>

Searches prompts in an Amazon Connect instance, with optional filtering.

## Request Syntax
<a name="API_SearchPrompts_RequestSyntax"></a>

```
POST /search-prompts HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "PromptSearchCriteria"
      ],
      "OrConditions": [ 
         "PromptSearchCriteria"
      ],
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   },
   "SearchFilter": { 
      "TagFilter": { 
         "AndConditions": [ 
            { 
               "TagKey": "string",
               "TagValue": "string"
            }
         ],
         "OrConditions": [ 
            [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchPrompts_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchPrompts_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchPrompts_RequestSyntax) **   <a name="connect-SearchPrompts-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_SearchPrompts_RequestSyntax) **   <a name="connect-SearchPrompts-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_SearchPrompts_RequestSyntax) **   <a name="connect-SearchPrompts-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

 ** [SearchCriteria](#API_SearchPrompts_RequestSyntax) **   <a name="connect-SearchPrompts-request-SearchCriteria"></a>
The search criteria to be used to return prompts.  
Type: [PromptSearchCriteria](API_PromptSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchPrompts_RequestSyntax) **   <a name="connect-SearchPrompts-request-SearchFilter"></a>
Filters to be applied to search results.  
Type: [PromptSearchFilter](API_PromptSearchFilter.md) object  
Required: No

## Response Syntax
<a name="API_SearchPrompts_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "NextToken": "string",
   "Prompts": [ 
      { 
         "Description": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string",
         "PromptARN": "string",
         "PromptId": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ]
}
```

## Response Elements
<a name="API_SearchPrompts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_SearchPrompts_ResponseSyntax) **   <a name="connect-SearchPrompts-response-ApproximateTotalCount"></a>
The total number of quick connects which matched your search query.  
Type: Long

 ** [NextToken](#API_SearchPrompts_ResponseSyntax) **   <a name="connect-SearchPrompts-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.

 ** [Prompts](#API_SearchPrompts_ResponseSyntax) **   <a name="connect-SearchPrompts-response-Prompts"></a>
Information about the prompts.  
Type: Array of [Prompt](API_Prompt.md) objects

## Errors
<a name="API_SearchPrompts_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchPrompts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchPrompts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchPrompts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchPrompts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchPrompts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchPrompts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchPrompts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchPrompts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchPrompts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchPrompts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchPrompts) 

# SearchQueues
<a name="API_SearchQueues"></a>

Searches queues in an Amazon Connect instance, with optional filtering.

## Request Syntax
<a name="API_SearchQueues_RequestSyntax"></a>

```
POST /search-queues HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "QueueSearchCriteria"
      ],
      "OrConditions": [ 
         "QueueSearchCriteria"
      ],
      "QueueTypeCondition": "string",
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   },
   "SearchFilter": { 
      "TagFilter": { 
         "AndConditions": [ 
            { 
               "TagKey": "string",
               "TagValue": "string"
            }
         ],
         "OrConditions": [ 
            [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchQueues_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchQueues_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchQueues_RequestSyntax) **   <a name="connect-SearchQueues-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_SearchQueues_RequestSyntax) **   <a name="connect-SearchQueues-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 500.  
Required: No

 ** [NextToken](#API_SearchQueues_RequestSyntax) **   <a name="connect-SearchQueues-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

 ** [SearchCriteria](#API_SearchQueues_RequestSyntax) **   <a name="connect-SearchQueues-request-SearchCriteria"></a>
The search criteria to be used to return queues.  
The `name` and `description` fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. 
Type: [QueueSearchCriteria](API_QueueSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchQueues_RequestSyntax) **   <a name="connect-SearchQueues-request-SearchFilter"></a>
Filters to be applied to search results.  
Type: [QueueSearchFilter](API_QueueSearchFilter.md) object  
Required: No

## Response Syntax
<a name="API_SearchQueues_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "NextToken": "string",
   "Queues": [ 
      { 
         "Description": "string",
         "HoursOfOperationId": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "MaxContacts": number,
         "Name": "string",
         "OutboundCallerConfig": { 
            "OutboundCallerIdName": "string",
            "OutboundCallerIdNumberId": "string",
            "OutboundFlowId": "string"
         },
         "OutboundEmailConfig": { 
            "OutboundEmailAddressId": "string"
         },
         "QueueArn": "string",
         "QueueId": "string",
         "Status": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ]
}
```

## Response Elements
<a name="API_SearchQueues_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_SearchQueues_ResponseSyntax) **   <a name="connect-SearchQueues-response-ApproximateTotalCount"></a>
The total number of queues which matched your search query.  
Type: Long

 ** [NextToken](#API_SearchQueues_ResponseSyntax) **   <a name="connect-SearchQueues-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.

 ** [Queues](#API_SearchQueues_ResponseSyntax) **   <a name="connect-SearchQueues-response-Queues"></a>
Information about the queues.  
Type: Array of [Queue](API_Queue.md) objects

## Errors
<a name="API_SearchQueues_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchQueues_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchQueues) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchQueues) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchQueues) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchQueues) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchQueues) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchQueues) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchQueues) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchQueues) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchQueues) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchQueues) 

# SearchQuickConnects
<a name="API_SearchQuickConnects"></a>

Searches quick connects in an Amazon Connect instance, with optional filtering.

## Request Syntax
<a name="API_SearchQuickConnects_RequestSyntax"></a>

```
POST /search-quick-connects HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "QuickConnectSearchCriteria"
      ],
      "OrConditions": [ 
         "QuickConnectSearchCriteria"
      ],
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   },
   "SearchFilter": { 
      "TagFilter": { 
         "AndConditions": [ 
            { 
               "TagKey": "string",
               "TagValue": "string"
            }
         ],
         "OrConditions": [ 
            [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchQuickConnects_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchQuickConnects_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchQuickConnects_RequestSyntax) **   <a name="connect-SearchQuickConnects-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_SearchQuickConnects_RequestSyntax) **   <a name="connect-SearchQuickConnects-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_SearchQuickConnects_RequestSyntax) **   <a name="connect-SearchQuickConnects-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

 ** [SearchCriteria](#API_SearchQuickConnects_RequestSyntax) **   <a name="connect-SearchQuickConnects-request-SearchCriteria"></a>
The search criteria to be used to return quick connects.  
Type: [QuickConnectSearchCriteria](API_QuickConnectSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchQuickConnects_RequestSyntax) **   <a name="connect-SearchQuickConnects-request-SearchFilter"></a>
Filters to be applied to search results.  
Type: [QuickConnectSearchFilter](API_QuickConnectSearchFilter.md) object  
Required: No

## Response Syntax
<a name="API_SearchQuickConnects_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "NextToken": "string",
   "QuickConnects": [ 
      { 
         "Description": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string",
         "QuickConnectARN": "string",
         "QuickConnectConfig": { 
            "FlowConfig": { 
               "ContactFlowId": "string"
            },
            "PhoneConfig": { 
               "PhoneNumber": "string"
            },
            "QueueConfig": { 
               "ContactFlowId": "string",
               "QueueId": "string"
            },
            "QuickConnectType": "string",
            "UserConfig": { 
               "ContactFlowId": "string",
               "UserId": "string"
            }
         },
         "QuickConnectId": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ]
}
```

## Response Elements
<a name="API_SearchQuickConnects_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_SearchQuickConnects_ResponseSyntax) **   <a name="connect-SearchQuickConnects-response-ApproximateTotalCount"></a>
The total number of quick connects which matched your search query.  
Type: Long

 ** [NextToken](#API_SearchQuickConnects_ResponseSyntax) **   <a name="connect-SearchQuickConnects-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.

 ** [QuickConnects](#API_SearchQuickConnects_ResponseSyntax) **   <a name="connect-SearchQuickConnects-response-QuickConnects"></a>
Information about the quick connects.  
Type: Array of [QuickConnect](API_QuickConnect.md) objects

## Errors
<a name="API_SearchQuickConnects_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchQuickConnects_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchQuickConnects) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchQuickConnects) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchQuickConnects) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchQuickConnects) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchQuickConnects) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchQuickConnects) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchQuickConnects) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchQuickConnects) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchQuickConnects) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchQuickConnects) 

# SearchResourceTags
<a name="API_SearchResourceTags"></a>

Searches tags used in an Amazon Connect instance using optional search criteria.

## Request Syntax
<a name="API_SearchResourceTags_RequestSyntax"></a>

```
POST /search-resource-tags HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "ResourceTypes": [ "string" ],
   "SearchCriteria": { 
      "TagSearchCondition": { 
         "tagKey": "string",
         "tagKeyComparisonType": "string",
         "tagValue": "string",
         "tagValueComparisonType": "string"
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchResourceTags_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchResourceTags_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchResourceTags_RequestSyntax) **   <a name="connect-SearchResourceTags-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instanceId in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

 ** [MaxResults](#API_SearchResourceTags_RequestSyntax) **   <a name="connect-SearchResourceTags-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_SearchResourceTags_RequestSyntax) **   <a name="connect-SearchResourceTags-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

 ** [ResourceTypes](#API_SearchResourceTags_RequestSyntax) **   <a name="connect-SearchResourceTags-request-ResourceTypes"></a>
The list of resource types to be used to search tags from. If not provided or if any empty list is provided, this API will search from all supported resource types. Note that lowercase and - are required.  

**Supported resource types**
+ agent
+ agent-state
+ routing-profile
+ standard-queue
+ security-profile
+ operating-hours
+ prompt
+ contact-flow
+ flow- module
+ transfer-destination (also known as quick connect)
Type: Array of strings  
Required: No

 ** [SearchCriteria](#API_SearchResourceTags_RequestSyntax) **   <a name="connect-SearchResourceTags-request-SearchCriteria"></a>
The search criteria to be used to return tags.  
Type: [ResourceTagsSearchCriteria](API_ResourceTagsSearchCriteria.md) object  
Required: No

## Response Syntax
<a name="API_SearchResourceTags_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_SearchResourceTags_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_SearchResourceTags_ResponseSyntax) **   <a name="connect-SearchResourceTags-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.

 ** [Tags](#API_SearchResourceTags_ResponseSyntax) **   <a name="connect-SearchResourceTags-response-Tags"></a>
A list of tags used in the Amazon Connect instance.  
Type: Array of [TagSet](API_TagSet.md) objects

## Errors
<a name="API_SearchResourceTags_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** MaximumResultReturnedException **   
Maximum number (1000) of tags have been returned with current request. Consider changing request parameters to get more tags.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchResourceTags_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchResourceTags) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchResourceTags) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchResourceTags) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchResourceTags) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchResourceTags) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchResourceTags) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchResourceTags) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchResourceTags) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchResourceTags) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchResourceTags) 

# SearchRoutingProfiles
<a name="API_SearchRoutingProfiles"></a>

Searches routing profiles in an Amazon Connect instance, with optional filtering.

**Note**  
 `SearchRoutingProfiles` does not populate LastModifiedRegion, LastModifiedTime, MediaConcurrencies.CrossChannelBehavior, and AgentAvailabilityTimer in its response, but [DescribeRoutingProfile](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html) does.

## Request Syntax
<a name="API_SearchRoutingProfiles_RequestSyntax"></a>

```
POST /search-routing-profiles HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "RoutingProfileSearchCriteria"
      ],
      "OrConditions": [ 
         "RoutingProfileSearchCriteria"
      ],
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   },
   "SearchFilter": { 
      "TagFilter": { 
         "AndConditions": [ 
            { 
               "TagKey": "string",
               "TagValue": "string"
            }
         ],
         "OrConditions": [ 
            [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchRoutingProfiles_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchRoutingProfiles_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchRoutingProfiles_RequestSyntax) **   <a name="connect-SearchRoutingProfiles-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_SearchRoutingProfiles_RequestSyntax) **   <a name="connect-SearchRoutingProfiles-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 500.  
Required: No

 ** [NextToken](#API_SearchRoutingProfiles_RequestSyntax) **   <a name="connect-SearchRoutingProfiles-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

 ** [SearchCriteria](#API_SearchRoutingProfiles_RequestSyntax) **   <a name="connect-SearchRoutingProfiles-request-SearchCriteria"></a>
The search criteria to be used to return routing profiles.  
The `name` and `description` fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. 
Type: [RoutingProfileSearchCriteria](API_RoutingProfileSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchRoutingProfiles_RequestSyntax) **   <a name="connect-SearchRoutingProfiles-request-SearchFilter"></a>
Filters to be applied to search results.  
Type: [RoutingProfileSearchFilter](API_RoutingProfileSearchFilter.md) object  
Required: No

## Response Syntax
<a name="API_SearchRoutingProfiles_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "NextToken": "string",
   "RoutingProfiles": [ 
      { 
         "AgentAvailabilityTimer": "string",
         "AssociatedManualAssignmentQueueIds": [ "string" ],
         "AssociatedQueueIds": [ "string" ],
         "DefaultOutboundQueueId": "string",
         "Description": "string",
         "InstanceId": "string",
         "IsDefault": boolean,
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "MediaConcurrencies": [ 
            { 
               "Channel": "string",
               "Concurrency": number,
               "CrossChannelBehavior": { 
                  "BehaviorType": "string"
               }
            }
         ],
         "Name": "string",
         "NumberOfAssociatedManualAssignmentQueues": number,
         "NumberOfAssociatedQueues": number,
         "NumberOfAssociatedUsers": number,
         "RoutingProfileArn": "string",
         "RoutingProfileId": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ]
}
```

## Response Elements
<a name="API_SearchRoutingProfiles_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_SearchRoutingProfiles_ResponseSyntax) **   <a name="connect-SearchRoutingProfiles-response-ApproximateTotalCount"></a>
The total number of routing profiles which matched your search query.  
Type: Long

 ** [NextToken](#API_SearchRoutingProfiles_ResponseSyntax) **   <a name="connect-SearchRoutingProfiles-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.

 ** [RoutingProfiles](#API_SearchRoutingProfiles_ResponseSyntax) **   <a name="connect-SearchRoutingProfiles-response-RoutingProfiles"></a>
Information about the routing profiles.  
Type: Array of [RoutingProfile](API_RoutingProfile.md) objects

## Errors
<a name="API_SearchRoutingProfiles_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchRoutingProfiles_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchRoutingProfiles) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchRoutingProfiles) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchRoutingProfiles) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchRoutingProfiles) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchRoutingProfiles) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchRoutingProfiles) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchRoutingProfiles) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchRoutingProfiles) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchRoutingProfiles) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchRoutingProfiles) 

# SearchSecurityProfiles
<a name="API_SearchSecurityProfiles"></a>

Searches security profiles in an Amazon Connect instance, with optional filtering.

For information about security profiles, see [Security Profiles](https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html) in the *Amazon Connect Administrator Guide*. For a mapping of the API name and user interface name of the security profile permissions, see [List of security profile permissions](https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html). 

## Request Syntax
<a name="API_SearchSecurityProfiles_RequestSyntax"></a>

```
POST /search-security-profiles HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "SecurityProfileSearchCriteria"
      ],
      "OrConditions": [ 
         "SecurityProfileSearchCriteria"
      ],
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   },
   "SearchFilter": { 
      "TagFilter": { 
         "AndConditions": [ 
            { 
               "TagKey": "string",
               "TagValue": "string"
            }
         ],
         "OrConditions": [ 
            [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchSecurityProfiles_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchSecurityProfiles_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchSecurityProfiles_RequestSyntax) **   <a name="connect-SearchSecurityProfiles-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_SearchSecurityProfiles_RequestSyntax) **   <a name="connect-SearchSecurityProfiles-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_SearchSecurityProfiles_RequestSyntax) **   <a name="connect-SearchSecurityProfiles-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

 ** [SearchCriteria](#API_SearchSecurityProfiles_RequestSyntax) **   <a name="connect-SearchSecurityProfiles-request-SearchCriteria"></a>
The search criteria to be used to return security profiles.   
The `name` field support "contains" queries with a minimum of 2 characters and maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
The currently supported value for `FieldName`: `name` 
Type: [SecurityProfileSearchCriteria](API_SecurityProfileSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchSecurityProfiles_RequestSyntax) **   <a name="connect-SearchSecurityProfiles-request-SearchFilter"></a>
Filters to be applied to search results.  
Type: [SecurityProfilesSearchFilter](API_SecurityProfilesSearchFilter.md) object  
Required: No

## Response Syntax
<a name="API_SearchSecurityProfiles_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "NextToken": "string",
   "SecurityProfiles": [ 
      { 
         "Arn": "string",
         "Description": "string",
         "Id": "string",
         "OrganizationResourceId": "string",
         "SecurityProfileName": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ]
}
```

## Response Elements
<a name="API_SearchSecurityProfiles_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_SearchSecurityProfiles_ResponseSyntax) **   <a name="connect-SearchSecurityProfiles-response-ApproximateTotalCount"></a>
The total number of security profiles which matched your search query.  
Type: Long

 ** [NextToken](#API_SearchSecurityProfiles_ResponseSyntax) **   <a name="connect-SearchSecurityProfiles-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.

 ** [SecurityProfiles](#API_SearchSecurityProfiles_ResponseSyntax) **   <a name="connect-SearchSecurityProfiles-response-SecurityProfiles"></a>
Information about the security profiles.  
Type: Array of [SecurityProfileSearchSummary](API_SecurityProfileSearchSummary.md) objects

## Errors
<a name="API_SearchSecurityProfiles_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchSecurityProfiles_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchSecurityProfiles) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchSecurityProfiles) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchSecurityProfiles) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchSecurityProfiles) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchSecurityProfiles) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchSecurityProfiles) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchSecurityProfiles) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchSecurityProfiles) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchSecurityProfiles) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchSecurityProfiles) 

# SearchTestCases
<a name="API_SearchTestCases"></a>

Searches for test cases in the specified Amazon Connect instance, with optional filtering.

## Request Syntax
<a name="API_SearchTestCases_RequestSyntax"></a>

```
POST /search-test-cases HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "TestCaseSearchCriteria"
      ],
      "OrConditions": [ 
         "TestCaseSearchCriteria"
      ],
      "StatusCondition": "string",
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   },
   "SearchFilter": { 
      "TagFilter": { 
         "AndConditions": [ 
            { 
               "TagKey": "string",
               "TagValue": "string"
            }
         ],
         "OrConditions": [ 
            [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchTestCases_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchTestCases_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchTestCases_RequestSyntax) **   <a name="connect-SearchTestCases-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

 ** [MaxResults](#API_SearchTestCases_RequestSyntax) **   <a name="connect-SearchTestCases-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_SearchTestCases_RequestSyntax) **   <a name="connect-SearchTestCases-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

 ** [SearchCriteria](#API_SearchTestCases_RequestSyntax) **   <a name="connect-SearchTestCases-request-SearchCriteria"></a>
The search criteria to be used to return test cases.  
Type: [TestCaseSearchCriteria](API_TestCaseSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchTestCases_RequestSyntax) **   <a name="connect-SearchTestCases-request-SearchFilter"></a>
Filters to be applied to search results.  
Type: [TestCaseSearchFilter](API_TestCaseSearchFilter.md) object  
Required: No

## Response Syntax
<a name="API_SearchTestCases_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "NextToken": "string",
   "TestCases": [ 
      { 
         "Arn": "string",
         "Content": "string",
         "Description": "string",
         "EntryPoint": { 
            "ChatEntryPointParameters": { 
               "FlowId": "string"
            },
            "Type": "string",
            "VoiceCallEntryPointParameters": { 
               "DestinationPhoneNumber": "string",
               "FlowId": "string",
               "SourcePhoneNumber": "string"
            }
         },
         "Id": "string",
         "InitializationData": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string",
         "Status": "string",
         "Tags": { 
            "string" : "string" 
         },
         "TestCaseSha256": "string"
      }
   ]
}
```

## Response Elements
<a name="API_SearchTestCases_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_SearchTestCases_ResponseSyntax) **   <a name="connect-SearchTestCases-response-ApproximateTotalCount"></a>
The total number of test cases which matched your search query.  
Type: Long

 ** [NextToken](#API_SearchTestCases_ResponseSyntax) **   <a name="connect-SearchTestCases-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.

 ** [TestCases](#API_SearchTestCases_ResponseSyntax) **   <a name="connect-SearchTestCases-response-TestCases"></a>
Information about the test cases.  
Type: Array of [TestCase](API_TestCase.md) objects

## Errors
<a name="API_SearchTestCases_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchTestCases_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchTestCases) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchTestCases) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchTestCases) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchTestCases) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchTestCases) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchTestCases) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchTestCases) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchTestCases) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchTestCases) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchTestCases) 

# SearchUserHierarchyGroups
<a name="API_SearchUserHierarchyGroups"></a>

Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.

**Important**  
The UserHierarchyGroup with `"LevelId": "0"` is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI.

## Request Syntax
<a name="API_SearchUserHierarchyGroups_RequestSyntax"></a>

```
POST /search-user-hierarchy-groups HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "UserHierarchyGroupSearchCriteria"
      ],
      "OrConditions": [ 
         "UserHierarchyGroupSearchCriteria"
      ],
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   },
   "SearchFilter": { 
      "AttributeFilter": { 
         "AndCondition": { 
            "TagConditions": [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         },
         "OrConditions": [ 
            { 
               "TagConditions": [ 
                  { 
                     "TagKey": "string",
                     "TagValue": "string"
                  }
               ]
            }
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchUserHierarchyGroups_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchUserHierarchyGroups_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchUserHierarchyGroups_RequestSyntax) **   <a name="connect-SearchUserHierarchyGroups-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_SearchUserHierarchyGroups_RequestSyntax) **   <a name="connect-SearchUserHierarchyGroups-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_SearchUserHierarchyGroups_RequestSyntax) **   <a name="connect-SearchUserHierarchyGroups-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

 ** [SearchCriteria](#API_SearchUserHierarchyGroups_RequestSyntax) **   <a name="connect-SearchUserHierarchyGroups-request-SearchCriteria"></a>
The search criteria to be used to return UserHierarchyGroups.  
Type: [UserHierarchyGroupSearchCriteria](API_UserHierarchyGroupSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchUserHierarchyGroups_RequestSyntax) **   <a name="connect-SearchUserHierarchyGroups-request-SearchFilter"></a>
Filters to be applied to search results.  
Type: [UserHierarchyGroupSearchFilter](API_UserHierarchyGroupSearchFilter.md) object  
Required: No

## Response Syntax
<a name="API_SearchUserHierarchyGroups_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "NextToken": "string",
   "UserHierarchyGroups": [ 
      { 
         "Arn": "string",
         "HierarchyPath": { 
            "LevelFive": { 
               "Arn": "string",
               "Id": "string",
               "LastModifiedRegion": "string",
               "LastModifiedTime": number,
               "Name": "string"
            },
            "LevelFour": { 
               "Arn": "string",
               "Id": "string",
               "LastModifiedRegion": "string",
               "LastModifiedTime": number,
               "Name": "string"
            },
            "LevelOne": { 
               "Arn": "string",
               "Id": "string",
               "LastModifiedRegion": "string",
               "LastModifiedTime": number,
               "Name": "string"
            },
            "LevelThree": { 
               "Arn": "string",
               "Id": "string",
               "LastModifiedRegion": "string",
               "LastModifiedTime": number,
               "Name": "string"
            },
            "LevelTwo": { 
               "Arn": "string",
               "Id": "string",
               "LastModifiedRegion": "string",
               "LastModifiedTime": number,
               "Name": "string"
            }
         },
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "LevelId": "string",
         "Name": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ]
}
```

## Response Elements
<a name="API_SearchUserHierarchyGroups_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_SearchUserHierarchyGroups_ResponseSyntax) **   <a name="connect-SearchUserHierarchyGroups-response-ApproximateTotalCount"></a>
The total number of userHierarchyGroups which matched your search query.  
Type: Long

 ** [NextToken](#API_SearchUserHierarchyGroups_ResponseSyntax) **   <a name="connect-SearchUserHierarchyGroups-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.

 ** [UserHierarchyGroups](#API_SearchUserHierarchyGroups_ResponseSyntax) **   <a name="connect-SearchUserHierarchyGroups-response-UserHierarchyGroups"></a>
Information about the userHierarchyGroups.  
Type: Array of [HierarchyGroup](API_HierarchyGroup.md) objects

## Errors
<a name="API_SearchUserHierarchyGroups_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchUserHierarchyGroups_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchUserHierarchyGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchUserHierarchyGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchUserHierarchyGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchUserHierarchyGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchUserHierarchyGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchUserHierarchyGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchUserHierarchyGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchUserHierarchyGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchUserHierarchyGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchUserHierarchyGroups) 

# SearchUsers
<a name="API_SearchUsers"></a>

Searches users in an Amazon Connect instance, with optional filtering. 

**Note**  
 `AfterContactWorkTimeLimit` is returned in milliseconds. 

## Request Syntax
<a name="API_SearchUsers_RequestSyntax"></a>

```
POST /search-users HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "UserSearchCriteria"
      ],
      "HierarchyGroupCondition": { 
         "HierarchyGroupMatchType": "string",
         "Value": "string"
      },
      "ListCondition": { 
         "Conditions": [ 
            { 
               "NumberCondition": { 
                  "ComparisonType": "string",
                  "FieldName": "string",
                  "MaxValue": number,
                  "MinValue": number
               },
               "StringCondition": { 
                  "ComparisonType": "string",
                  "FieldName": "string",
                  "Value": "string"
               }
            }
         ],
         "TargetListType": "string"
      },
      "OrConditions": [ 
         "UserSearchCriteria"
      ],
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   },
   "SearchFilter": { 
      "TagFilter": { 
         "AndConditions": [ 
            { 
               "TagKey": "string",
               "TagValue": "string"
            }
         ],
         "OrConditions": [ 
            [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      },
      "UserAttributeFilter": { 
         "AndCondition": { 
            "HierarchyGroupCondition": { 
               "HierarchyGroupMatchType": "string",
               "Value": "string"
            },
            "TagConditions": [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         },
         "HierarchyGroupCondition": { 
            "HierarchyGroupMatchType": "string",
            "Value": "string"
         },
         "OrConditions": [ 
            { 
               "HierarchyGroupCondition": { 
                  "HierarchyGroupMatchType": "string",
                  "Value": "string"
               },
               "TagConditions": [ 
                  { 
                     "TagKey": "string",
                     "TagValue": "string"
                  }
               ]
            }
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchUsers_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchUsers_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchUsers_RequestSyntax) **   <a name="connect-SearchUsers-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_SearchUsers_RequestSyntax) **   <a name="connect-SearchUsers-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 500.  
Required: No

 ** [NextToken](#API_SearchUsers_RequestSyntax) **   <a name="connect-SearchUsers-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

 ** [SearchCriteria](#API_SearchUsers_RequestSyntax) **   <a name="connect-SearchUsers-request-SearchCriteria"></a>
The search criteria to be used to return users.  
The `name` and `description` fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results. 
Type: [UserSearchCriteria](API_UserSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchUsers_RequestSyntax) **   <a name="connect-SearchUsers-request-SearchFilter"></a>
Filters to be applied to search results.  
Type: [UserSearchFilter](API_UserSearchFilter.md) object  
Required: No

## Response Syntax
<a name="API_SearchUsers_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "NextToken": "string",
   "Users": [ 
      { 
         "AfterContactWorkConfigs": [ 
            { 
               "AfterContactWorkConfig": { 
                  "AfterContactWorkTimeLimit": number
               },
               "AgentFirstCallbackAfterContactWorkConfig": { 
                  "AfterContactWorkTimeLimit": number
               },
               "Channel": "string"
            }
         ],
         "Arn": "string",
         "AutoAcceptConfigs": [ 
            { 
               "AgentFirstCallbackAutoAccept": boolean,
               "AutoAccept": boolean,
               "Channel": "string"
            }
         ],
         "DirectoryUserId": "string",
         "HierarchyGroupId": "string",
         "Id": "string",
         "IdentityInfo": { 
            "FirstName": "string",
            "LastName": "string"
         },
         "PersistentConnectionConfigs": [ 
            { 
               "Channel": "string",
               "PersistentConnection": boolean
            }
         ],
         "PhoneConfig": { 
            "AfterContactWorkTimeLimit": number,
            "AutoAccept": boolean,
            "DeskPhoneNumber": "string",
            "PersistentConnection": boolean,
            "PhoneType": "string"
         },
         "PhoneNumberConfigs": [ 
            { 
               "Channel": "string",
               "PhoneNumber": "string",
               "PhoneType": "string"
            }
         ],
         "RoutingProfileId": "string",
         "SecurityProfileIds": [ "string" ],
         "Tags": { 
            "string" : "string" 
         },
         "Username": "string",
         "VoiceEnhancementConfigs": [ 
            { 
               "Channel": "string",
               "VoiceEnhancementMode": "string"
            }
         ]
      }
   ]
}
```

## Response Elements
<a name="API_SearchUsers_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_SearchUsers_ResponseSyntax) **   <a name="connect-SearchUsers-response-ApproximateTotalCount"></a>
The total number of users who matched your search query.  
Type: Long

 ** [NextToken](#API_SearchUsers_ResponseSyntax) **   <a name="connect-SearchUsers-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.

 ** [Users](#API_SearchUsers_ResponseSyntax) **   <a name="connect-SearchUsers-response-Users"></a>
Information about the users.  
Type: Array of [UserSearchSummary](API_UserSearchSummary.md) objects

## Errors
<a name="API_SearchUsers_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchUsers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchUsers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchUsers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchUsers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchUsers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchUsers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchUsers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchUsers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchUsers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchUsers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchUsers) 

# SearchViews
<a name="API_SearchViews"></a>

Searches views based on name, description, or tags.

## Request Syntax
<a name="API_SearchViews_RequestSyntax"></a>

```
POST /search-views HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "ViewSearchCriteria"
      ],
      "OrConditions": [ 
         "ViewSearchCriteria"
      ],
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      },
      "ViewStatusCondition": "string",
      "ViewTypeCondition": "string"
   },
   "SearchFilter": { 
      "AttributeFilter": { 
         "AndCondition": { 
            "TagConditions": [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         },
         "OrConditions": [ 
            { 
               "TagConditions": [ 
                  { 
                     "TagKey": "string",
                     "TagValue": "string"
                  }
               ]
            }
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchViews_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchViews_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchViews_RequestSyntax) **   <a name="connect-SearchViews-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

 ** [MaxResults](#API_SearchViews_RequestSyntax) **   <a name="connect-SearchViews-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_SearchViews_RequestSyntax) **   <a name="connect-SearchViews-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

 ** [SearchCriteria](#API_SearchViews_RequestSyntax) **   <a name="connect-SearchViews-request-SearchCriteria"></a>
The search criteria, including field names and comparison types.  
Type: [ViewSearchCriteria](API_ViewSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchViews_RequestSyntax) **   <a name="connect-SearchViews-request-SearchFilter"></a>
Filters to apply to the search, such as tag-based filters.  
Type: [ViewSearchFilter](API_ViewSearchFilter.md) object  
Required: No

## Response Syntax
<a name="API_SearchViews_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "NextToken": "string",
   "Views": [ 
      { 
         "Arn": "string",
         "Content": { 
            "Actions": [ "string" ],
            "InputSchema": "string",
            "Template": "string"
         },
         "CreatedTime": number,
         "Description": "string",
         "Id": "string",
         "LastModifiedTime": number,
         "Name": "string",
         "Status": "string",
         "Tags": { 
            "string" : "string" 
         },
         "Type": "string",
         "Version": number,
         "VersionDescription": "string",
         "ViewContentSha256": "string"
      }
   ]
}
```

## Response Elements
<a name="API_SearchViews_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_SearchViews_ResponseSyntax) **   <a name="connect-SearchViews-response-ApproximateTotalCount"></a>
The approximate total number of views that match the search criteria.  
Type: Long

 ** [NextToken](#API_SearchViews_ResponseSyntax) **   <a name="connect-SearchViews-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.

 ** [Views](#API_SearchViews_ResponseSyntax) **   <a name="connect-SearchViews-response-Views"></a>
A list of views that match the search criteria.  
Type: Array of [View](API_View.md) objects

## Errors
<a name="API_SearchViews_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchViews_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchViews) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchViews) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchViews) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchViews) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchViews) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchViews) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchViews) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchViews) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchViews) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchViews) 

# SearchVocabularies
<a name="API_SearchVocabularies"></a>

Searches for vocabularies within a specific Amazon Connect instance using `State`, `NameStartsWith`, and `LanguageCode`.

## Request Syntax
<a name="API_SearchVocabularies_RequestSyntax"></a>

```
POST /vocabulary-summary/InstanceId HTTP/1.1
Content-type: application/json

{
   "LanguageCode": "string",
   "MaxResults": number,
   "NameStartsWith": "string",
   "NextToken": "string",
   "State": "string"
}
```

## URI Request Parameters
<a name="API_SearchVocabularies_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_SearchVocabularies_RequestSyntax) **   <a name="connect-SearchVocabularies-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_SearchVocabularies_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [LanguageCode](#API_SearchVocabularies_RequestSyntax) **   <a name="connect-SearchVocabularies-request-LanguageCode"></a>
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see [What is Amazon Transcribe?](https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html)   
Type: String  
Valid Values: `ar-AE | de-CH | de-DE | en-AB | en-AU | en-GB | en-IE | en-IN | en-US | en-WL | es-ES | es-US | fr-CA | fr-FR | hi-IN | it-IT | ja-JP | ko-KR | pt-BR | pt-PT | zh-CN | en-NZ | en-ZA | ca-ES | da-DK | fi-FI | id-ID | ms-MY | nl-NL | no-NO | pl-PL | sv-SE | tl-PH`   
Required: No

 ** [MaxResults](#API_SearchVocabularies_RequestSyntax) **   <a name="connect-SearchVocabularies-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NameStartsWith](#API_SearchVocabularies_RequestSyntax) **   <a name="connect-SearchVocabularies-request-NameStartsWith"></a>
The starting pattern of the name of the vocabulary.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 140.  
Pattern: `^[0-9a-zA-Z._-]+`   
Required: No

 ** [NextToken](#API_SearchVocabularies_RequestSyntax) **   <a name="connect-SearchVocabularies-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 131070.  
Pattern: `.*\S.*`   
Required: No

 ** [State](#API_SearchVocabularies_RequestSyntax) **   <a name="connect-SearchVocabularies-request-State"></a>
The current state of the custom vocabulary.  
Type: String  
Valid Values: `CREATION_IN_PROGRESS | ACTIVE | CREATION_FAILED | DELETE_IN_PROGRESS`   
Required: No

## Response Syntax
<a name="API_SearchVocabularies_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "VocabularySummaryList": [ 
      { 
         "Arn": "string",
         "FailureReason": "string",
         "Id": "string",
         "LanguageCode": "string",
         "LastModifiedTime": number,
         "Name": "string",
         "State": "string"
      }
   ]
}
```

## Response Elements
<a name="API_SearchVocabularies_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_SearchVocabularies_ResponseSyntax) **   <a name="connect-SearchVocabularies-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 131070.  
Pattern: `.*\S.*` 

 ** [VocabularySummaryList](#API_SearchVocabularies_ResponseSyntax) **   <a name="connect-SearchVocabularies-response-VocabularySummaryList"></a>
The list of the available custom vocabularies.  
Type: Array of [VocabularySummary](API_VocabularySummary.md) objects

## Errors
<a name="API_SearchVocabularies_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchVocabularies_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchVocabularies) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchVocabularies) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchVocabularies) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchVocabularies) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchVocabularies) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchVocabularies) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchVocabularies) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchVocabularies) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchVocabularies) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchVocabularies) 

# SearchWorkspaceAssociations
<a name="API_SearchWorkspaceAssociations"></a>

Searches for workspace associations with users or routing profiles based on various criteria.

## Request Syntax
<a name="API_SearchWorkspaceAssociations_RequestSyntax"></a>

```
POST /search-workspace-associations HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "WorkspaceAssociationSearchCriteria"
      ],
      "OrConditions": [ 
         "WorkspaceAssociationSearchCriteria"
      ],
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   },
   "SearchFilter": { 
      "AttributeFilter": { 
         "AndCondition": { 
            "TagConditions": [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         },
         "OrConditions": [ 
            { 
               "TagConditions": [ 
                  { 
                     "TagKey": "string",
                     "TagValue": "string"
                  }
               ]
            }
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchWorkspaceAssociations_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchWorkspaceAssociations_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchWorkspaceAssociations_RequestSyntax) **   <a name="connect-SearchWorkspaceAssociations-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_SearchWorkspaceAssociations_RequestSyntax) **   <a name="connect-SearchWorkspaceAssociations-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 500.  
Required: No

 ** [NextToken](#API_SearchWorkspaceAssociations_RequestSyntax) **   <a name="connect-SearchWorkspaceAssociations-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

 ** [SearchCriteria](#API_SearchWorkspaceAssociations_RequestSyntax) **   <a name="connect-SearchWorkspaceAssociations-request-SearchCriteria"></a>
The search criteria, including workspace ID, resource ID, or resource type.  
Type: [WorkspaceAssociationSearchCriteria](API_WorkspaceAssociationSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchWorkspaceAssociations_RequestSyntax) **   <a name="connect-SearchWorkspaceAssociations-request-SearchFilter"></a>
Filters to apply to the search, such as tag-based filters.  
Type: [WorkspaceAssociationSearchFilter](API_WorkspaceAssociationSearchFilter.md) object  
Required: No

## Response Syntax
<a name="API_SearchWorkspaceAssociations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "NextToken": "string",
   "WorkspaceAssociations": [ 
      { 
         "ResourceArn": "string",
         "ResourceId": "string",
         "ResourceName": "string",
         "ResourceType": "string",
         "WorkspaceArn": "string",
         "WorkspaceId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_SearchWorkspaceAssociations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_SearchWorkspaceAssociations_ResponseSyntax) **   <a name="connect-SearchWorkspaceAssociations-response-ApproximateTotalCount"></a>
The approximate total number of workspace associations that match the search criteria.  
Type: Long

 ** [NextToken](#API_SearchWorkspaceAssociations_ResponseSyntax) **   <a name="connect-SearchWorkspaceAssociations-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [WorkspaceAssociations](#API_SearchWorkspaceAssociations_ResponseSyntax) **   <a name="connect-SearchWorkspaceAssociations-response-WorkspaceAssociations"></a>
A list of workspace associations that match the search criteria.  
Type: Array of [WorkspaceAssociationSearchSummary](API_WorkspaceAssociationSearchSummary.md) objects

## Errors
<a name="API_SearchWorkspaceAssociations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchWorkspaceAssociations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchWorkspaceAssociations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchWorkspaceAssociations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchWorkspaceAssociations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchWorkspaceAssociations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchWorkspaceAssociations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchWorkspaceAssociations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchWorkspaceAssociations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchWorkspaceAssociations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchWorkspaceAssociations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchWorkspaceAssociations) 

# SearchWorkspaces
<a name="API_SearchWorkspaces"></a>

Searches workspaces based on name, description, visibility, or tags.

## Request Syntax
<a name="API_SearchWorkspaces_RequestSyntax"></a>

```
POST /search-workspaces HTTP/1.1
Content-type: application/json

{
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SearchCriteria": { 
      "AndConditions": [ 
         "WorkspaceSearchCriteria"
      ],
      "OrConditions": [ 
         "WorkspaceSearchCriteria"
      ],
      "StringCondition": { 
         "ComparisonType": "string",
         "FieldName": "string",
         "Value": "string"
      }
   },
   "SearchFilter": { 
      "AttributeFilter": { 
         "AndCondition": { 
            "TagConditions": [ 
               { 
                  "TagKey": "string",
                  "TagValue": "string"
               }
            ]
         },
         "OrConditions": [ 
            { 
               "TagConditions": [ 
                  { 
                     "TagKey": "string",
                     "TagValue": "string"
                  }
               ]
            }
         ],
         "TagCondition": { 
            "TagKey": "string",
            "TagValue": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_SearchWorkspaces_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SearchWorkspaces_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InstanceId](#API_SearchWorkspaces_RequestSyntax) **   <a name="connect-SearchWorkspaces-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [MaxResults](#API_SearchWorkspaces_RequestSyntax) **   <a name="connect-SearchWorkspaces-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 500.  
Required: No

 ** [NextToken](#API_SearchWorkspaces_RequestSyntax) **   <a name="connect-SearchWorkspaces-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2500.  
Required: No

 ** [SearchCriteria](#API_SearchWorkspaces_RequestSyntax) **   <a name="connect-SearchWorkspaces-request-SearchCriteria"></a>
The search criteria, including field names and comparison types.  
Type: [WorkspaceSearchCriteria](API_WorkspaceSearchCriteria.md) object  
Required: No

 ** [SearchFilter](#API_SearchWorkspaces_RequestSyntax) **   <a name="connect-SearchWorkspaces-request-SearchFilter"></a>
Filters to apply to the search, such as tag-based filters.  
Type: [WorkspaceSearchFilter](API_WorkspaceSearchFilter.md) object  
Required: No

## Response Syntax
<a name="API_SearchWorkspaces_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApproximateTotalCount": number,
   "NextToken": "string",
   "Workspaces": [ 
      { 
         "Arn": "string",
         "CreatedAt": number,
         "Description": "string",
         "Id": "string",
         "Name": "string",
         "Tags": { 
            "string" : "string" 
         },
         "Title": "string",
         "Visibility": "string"
      }
   ]
}
```

## Response Elements
<a name="API_SearchWorkspaces_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApproximateTotalCount](#API_SearchWorkspaces_ResponseSyntax) **   <a name="connect-SearchWorkspaces-response-ApproximateTotalCount"></a>
The approximate total number of workspaces that match the search criteria.  
Type: Long

 ** [NextToken](#API_SearchWorkspaces_ResponseSyntax) **   <a name="connect-SearchWorkspaces-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String

 ** [Workspaces](#API_SearchWorkspaces_ResponseSyntax) **   <a name="connect-SearchWorkspaces-response-Workspaces"></a>
A list of workspaces that match the search criteria.  
Type: Array of [WorkspaceSearchSummary](API_WorkspaceSearchSummary.md) objects

## Errors
<a name="API_SearchWorkspaces_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SearchWorkspaces_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SearchWorkspaces) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SearchWorkspaces) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SearchWorkspaces) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SearchWorkspaces) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SearchWorkspaces) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SearchWorkspaces) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SearchWorkspaces) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SearchWorkspaces) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SearchWorkspaces) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SearchWorkspaces) 

# SendChatIntegrationEvent
<a name="API_SendChatIntegrationEvent"></a>

Processes chat integration events from AWS or external integrations to Amazon Connect. A chat integration event includes:
+ SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat
+  ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat

When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action. 

Access to this API is currently restricted to AWS End User Messaging for supporting SMS integration. 

## Request Syntax
<a name="API_SendChatIntegrationEvent_RequestSyntax"></a>

```
POST /chat-integration-event HTTP/1.1
Content-type: application/json

{
   "DestinationId": "string",
   "Event": { 
      "Content": "string",
      "ContentType": "string",
      "Type": "string"
   },
   "NewSessionDetails": { 
      "Attributes": { 
         "string" : "string" 
      },
      "ParticipantDetails": { 
         "DisplayName": "string"
      },
      "StreamingConfiguration": { 
         "StreamingEndpointArn": "string"
      },
      "SupportedMessagingContentTypes": [ "string" ]
   },
   "SourceId": "string",
   "Subtype": "string"
}
```

## URI Request Parameters
<a name="API_SendChatIntegrationEvent_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SendChatIntegrationEvent_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [DestinationId](#API_SendChatIntegrationEvent_RequestSyntax) **   <a name="connect-SendChatIntegrationEvent-request-DestinationId"></a>
Chat system identifier, used in part to uniquely identify chat. This is associated with the Amazon Connect instance and flow to be used to start chats. For AWS SMS, this is the phone number destination of inbound AWS SMS messages represented by an AWS End User Messaging phone number ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** [Event](#API_SendChatIntegrationEvent_RequestSyntax) **   <a name="connect-SendChatIntegrationEvent-request-Event"></a>
Chat integration event payload  
Type: [ChatEvent](API_ChatEvent.md) object  
Required: Yes

 ** [NewSessionDetails](#API_SendChatIntegrationEvent_RequestSyntax) **   <a name="connect-SendChatIntegrationEvent-request-NewSessionDetails"></a>
Contact properties to apply when starting a new chat. If the integration event is handled with an existing chat, this is ignored.  
Type: [NewSessionDetails](API_NewSessionDetails.md) object  
Required: No

 ** [SourceId](#API_SendChatIntegrationEvent_RequestSyntax) **   <a name="connect-SendChatIntegrationEvent-request-SourceId"></a>
External identifier of chat customer participant, used in part to uniquely identify a chat. For SMS, this is the E164 phone number of the chat customer participant.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** [Subtype](#API_SendChatIntegrationEvent_RequestSyntax) **   <a name="connect-SendChatIntegrationEvent-request-Subtype"></a>
Classification of a channel. This is used in part to uniquely identify chat.   
Valid value: `["connect:sms", connect:"WhatsApp"]`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

## Response Syntax
<a name="API_SendChatIntegrationEvent_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "InitialContactId": "string",
   "NewChatCreated": boolean
}
```

## Response Elements
<a name="API_SendChatIntegrationEvent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InitialContactId](#API_SendChatIntegrationEvent_ResponseSyntax) **   <a name="connect-SendChatIntegrationEvent-response-InitialContactId"></a>
Identifier of chat contact used to handle integration event. This may be null if the integration event is not valid without an already existing chat contact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [NewChatCreated](#API_SendChatIntegrationEvent_ResponseSyntax) **   <a name="connect-SendChatIntegrationEvent-response-NewChatCreated"></a>
Whether handling the integration event resulted in creating a new chat or acting on existing chat.  
Type: Boolean

## Errors
<a name="API_SendChatIntegrationEvent_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SendChatIntegrationEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SendChatIntegrationEvent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SendChatIntegrationEvent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SendChatIntegrationEvent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SendChatIntegrationEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SendChatIntegrationEvent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SendChatIntegrationEvent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SendChatIntegrationEvent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SendChatIntegrationEvent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SendChatIntegrationEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SendChatIntegrationEvent) 

# SendOutboundEmail
<a name="API_SendOutboundEmail"></a>

Send outbound email for outbound campaigns. For more information about outbound campaigns, see [Set up Amazon Connect outbound campaigns](https://docs.aws.amazon.com/connect/latest/adminguide/enable-outbound-campaigns.html).

**Note**  
Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.

## Request Syntax
<a name="API_SendOutboundEmail_RequestSyntax"></a>

```
PUT /instance/InstanceId/outbound-email HTTP/1.1
Content-type: application/json

{
   "AdditionalRecipients": { 
      "CcEmailAddresses": [ 
         { 
            "DisplayName": "string",
            "EmailAddress": "string"
         }
      ]
   },
   "ClientToken": "string",
   "DestinationEmailAddress": { 
      "DisplayName": "string",
      "EmailAddress": "string"
   },
   "EmailMessage": { 
      "MessageSourceType": "string",
      "RawMessage": { 
         "Body": "string",
         "ContentType": "string",
         "Subject": "string"
      },
      "TemplatedMessageConfig": { 
         "KnowledgeBaseId": "string",
         "MessageTemplateId": "string",
         "TemplateAttributes": { 
            "CustomAttributes": { 
               "string" : "string" 
            },
            "CustomerProfileAttributes": "string"
         }
      }
   },
   "FromEmailAddress": { 
      "DisplayName": "string",
      "EmailAddress": "string"
   },
   "SourceCampaign": { 
      "CampaignId": "string",
      "OutboundRequestId": "string"
   },
   "TrafficType": "string"
}
```

## URI Request Parameters
<a name="API_SendOutboundEmail_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_SendOutboundEmail_RequestSyntax) **   <a name="connect-SendOutboundEmail-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_SendOutboundEmail_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AdditionalRecipients](#API_SendOutboundEmail_RequestSyntax) **   <a name="connect-SendOutboundEmail-request-AdditionalRecipients"></a>
The additional recipients address of the email in CC.  
Type: [OutboundAdditionalRecipients](API_OutboundAdditionalRecipients.md) object  
Required: No

 ** [ClientToken](#API_SendOutboundEmail_RequestSyntax) **   <a name="connect-SendOutboundEmail-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [DestinationEmailAddress](#API_SendOutboundEmail_RequestSyntax) **   <a name="connect-SendOutboundEmail-request-DestinationEmailAddress"></a>
The email address to send the email to.  
Type: [EmailAddressInfo](API_EmailAddressInfo.md) object  
Required: Yes

 ** [EmailMessage](#API_SendOutboundEmail_RequestSyntax) **   <a name="connect-SendOutboundEmail-request-EmailMessage"></a>
The email message body to be sent to the newly created email.  
Type: [OutboundEmailContent](API_OutboundEmailContent.md) object  
Required: Yes

 ** [FromEmailAddress](#API_SendOutboundEmail_RequestSyntax) **   <a name="connect-SendOutboundEmail-request-FromEmailAddress"></a>
The email address to be used for sending email.  
Type: [EmailAddressInfo](API_EmailAddressInfo.md) object  
Required: Yes

 ** [SourceCampaign](#API_SendOutboundEmail_RequestSyntax) **   <a name="connect-SendOutboundEmail-request-SourceCampaign"></a>
A Campaign object need for Campaign traffic type.  
Type: [SourceCampaign](API_SourceCampaign.md) object  
Required: No

 ** [TrafficType](#API_SendOutboundEmail_RequestSyntax) **   <a name="connect-SendOutboundEmail-request-TrafficType"></a>
Denotes the class of traffic.  
Only the CAMPAIGN traffic type is supported.
Type: String  
Valid Values: `GENERAL | CAMPAIGN`   
Required: Yes

## Response Syntax
<a name="API_SendOutboundEmail_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_SendOutboundEmail_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_SendOutboundEmail_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** IdempotencyException **   
An entity with the same name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_SendOutboundEmail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SendOutboundEmail) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SendOutboundEmail) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SendOutboundEmail) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SendOutboundEmail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SendOutboundEmail) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SendOutboundEmail) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SendOutboundEmail) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SendOutboundEmail) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SendOutboundEmail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SendOutboundEmail) 

# StartAttachedFileUpload
<a name="API_StartAttachedFileUpload"></a>

Provides a pre-signed Amazon S3 URL in response for uploading your content.

**Important**  
You may only use this API to upload attachments to an [Amazon Connect Case](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html) or [Amazon Connect Email](https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html). 

## Request Syntax
<a name="API_StartAttachedFileUpload_RequestSyntax"></a>

```
PUT /attached-files/InstanceId?associatedResourceArn=AssociatedResourceArn HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "CreatedBy": { ... },
   "FileName": "string",
   "FileSizeInBytes": number,
   "FileUseCaseType": "string",
   "Tags": { 
      "string" : "string" 
   },
   "UrlExpiryInSeconds": number
}
```

## URI Request Parameters
<a name="API_StartAttachedFileUpload_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AssociatedResourceArn](#API_StartAttachedFileUpload_RequestSyntax) **   <a name="connect-StartAttachedFileUpload-request-uri-AssociatedResourceArn"></a>
The resource to which the attached file is (being) uploaded to. The supported resources are [Cases](https://docs.aws.amazon.com/connect/latest/adminguide/cases.html) and [Email](https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html).  
This value must be a valid ARN.
Required: Yes

 ** [InstanceId](#API_StartAttachedFileUpload_RequestSyntax) **   <a name="connect-StartAttachedFileUpload-request-uri-InstanceId"></a>
The unique identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_StartAttachedFileUpload_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_StartAttachedFileUpload_RequestSyntax) **   <a name="connect-StartAttachedFileUpload-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [CreatedBy](#API_StartAttachedFileUpload_RequestSyntax) **   <a name="connect-StartAttachedFileUpload-request-CreatedBy"></a>
Represents the identity that created the file.  
Type: [CreatedByInfo](API_CreatedByInfo.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [FileName](#API_StartAttachedFileUpload_RequestSyntax) **   <a name="connect-StartAttachedFileUpload-request-FileName"></a>
A case-sensitive name of the attached file being uploaded.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^\P{C}*$`   
Required: Yes

 ** [FileSizeInBytes](#API_StartAttachedFileUpload_RequestSyntax) **   <a name="connect-StartAttachedFileUpload-request-FileSizeInBytes"></a>
The size of the attached file in bytes.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: Yes

 ** [FileUseCaseType](#API_StartAttachedFileUpload_RequestSyntax) **   <a name="connect-StartAttachedFileUpload-request-FileUseCaseType"></a>
The use case for the file.  
 Only `ATTACHMENTS` are supported.
Type: String  
Valid Values: `EMAIL_MESSAGE | ATTACHMENT`   
Required: Yes

 ** [Tags](#API_StartAttachedFileUpload_RequestSyntax) **   <a name="connect-StartAttachedFileUpload-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, `{ "Tags": {"key1":"value1", "key2":"value2"} }`.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

 ** [UrlExpiryInSeconds](#API_StartAttachedFileUpload_RequestSyntax) **   <a name="connect-StartAttachedFileUpload-request-UrlExpiryInSeconds"></a>
Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.  
Type: Integer  
Valid Range: Minimum value of 5. Maximum value of 300.  
Required: No

## Response Syntax
<a name="API_StartAttachedFileUpload_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreatedBy": { ... },
   "CreationTime": "string",
   "FileArn": "string",
   "FileId": "string",
   "FileStatus": "string",
   "UploadUrlMetadata": { 
      "HeadersToInclude": { 
         "string" : "string" 
      },
      "Url": "string",
      "UrlExpiry": "string"
   }
}
```

## Response Elements
<a name="API_StartAttachedFileUpload_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreatedBy](#API_StartAttachedFileUpload_ResponseSyntax) **   <a name="connect-StartAttachedFileUpload-response-CreatedBy"></a>
Represents the identity that created the file.  
Type: [CreatedByInfo](API_CreatedByInfo.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [CreationTime](#API_StartAttachedFileUpload_ResponseSyntax) **   <a name="connect-StartAttachedFileUpload-response-CreationTime"></a>
The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: `yyyy-MM-ddThh:mm:ss.SSSZ`. For example, `2024-05-03T02:41:28.172Z`.  
Type: String

 ** [FileArn](#API_StartAttachedFileUpload_ResponseSyntax) **   <a name="connect-StartAttachedFileUpload-response-FileArn"></a>
The unique identifier of the attached file resource (ARN).  
Type: String

 ** [FileId](#API_StartAttachedFileUpload_ResponseSyntax) **   <a name="connect-StartAttachedFileUpload-response-FileId"></a>
The unique identifier of the attached file resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [FileStatus](#API_StartAttachedFileUpload_ResponseSyntax) **   <a name="connect-StartAttachedFileUpload-response-FileStatus"></a>
The current status of the attached file.  
Type: String  
Valid Values: `APPROVED | REJECTED | PROCESSING | FAILED` 

 ** [UploadUrlMetadata](#API_StartAttachedFileUpload_ResponseSyntax) **   <a name="connect-StartAttachedFileUpload-response-UploadUrlMetadata"></a>
The headers to be provided while uploading the file to the URL.  
Type: [UploadUrlMetadata](API_UploadUrlMetadata.md) object

## Errors
<a name="API_StartAttachedFileUpload_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_StartAttachedFileUpload_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/StartAttachedFileUpload) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/StartAttachedFileUpload) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StartAttachedFileUpload) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/StartAttachedFileUpload) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/StartAttachedFileUpload) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/StartAttachedFileUpload) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/StartAttachedFileUpload) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StartAttachedFileUpload) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StartAttachedFileUpload) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StartAttachedFileUpload) 

# StartChatContact
<a name="API_StartChatContact"></a>

Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the [CreateParticipantConnection](https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html) API in the Amazon Connect Participant Service.

When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking [CreateParticipantConnection](https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html) with WEBSOCKET and CONNECTION\$1CREDENTIALS. 

A 429 error occurs in the following situations:
+ API rate limit is exceeded. API TPS throttling returns a `TooManyRequests` exception.
+ The [quota for concurrent active chats](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) is exceeded. Active chat throttling returns a `LimitExceededException`.

If you use the `ChatDurationInMinutes` parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Support. 

For more information about chat, see the following topics in the *Amazon Connect Administrator Guide*: 
+  [Concepts: Web and mobile messaging capabilities in Amazon Connect](https://docs.aws.amazon.com/connect/latest/adminguide/web-and-mobile-chat.html) 
+  [Amazon Connect Chat security best practices](https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat) 

## Request Syntax
<a name="API_StartChatContact_RequestSyntax"></a>

```
PUT /contact/chat HTTP/1.1
Content-type: application/json

{
   "Attributes": { 
      "string" : "string" 
   },
   "ChatDurationInMinutes": number,
   "ClientToken": "string",
   "ContactFlowId": "string",
   "CustomerId": "string",
   "DisconnectOnCustomerExit": [ "string" ],
   "InitialMessage": { 
      "Content": "string",
      "ContentType": "string"
   },
   "InstanceId": "string",
   "ParticipantConfiguration": { 
      "ResponseMode": "string"
   },
   "ParticipantDetails": { 
      "DisplayName": "string"
   },
   "PersistentChat": { 
      "RehydrationType": "string",
      "SourceContactId": "string"
   },
   "RelatedContactId": "string",
   "SegmentAttributes": { 
      "string" : { 
         "ValueArn": "string",
         "ValueInteger": number,
         "ValueList": [ 
            "SegmentAttributeValue"
         ],
         "ValueMap": { 
            "string" : "SegmentAttributeValue"
         },
         "ValueString": "string"
      }
   },
   "SupportedMessagingContentTypes": [ "string" ]
}
```

## URI Request Parameters
<a name="API_StartChatContact_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StartChatContact_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Attributes](#API_StartChatContact_RequestSyntax) **   <a name="connect-StartChatContact-request-Attributes"></a>
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes.   
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 32767.  
Value Length Constraints: Minimum length of 0. Maximum length of 32767.  
Required: No

 ** [ChatDurationInMinutes](#API_StartChatContact_RequestSyntax) **   <a name="connect-StartChatContact-request-ChatDurationInMinutes"></a>
The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).  
Type: Integer  
Valid Range: Minimum value of 60. Maximum value of 10080.  
Required: No

 ** [ClientToken](#API_StartChatContact_RequestSyntax) **   <a name="connect-StartChatContact-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [ContactFlowId](#API_StartChatContact_RequestSyntax) **   <a name="connect-StartChatContact-request-ContactFlowId"></a>
The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to **Routing**, **Flows**. Choose the flow. On the flow page, under the name of the flow, choose **Show additional flow information**. The ContactFlowId is the last part of the ARN, shown here in bold:   
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**   
Type: String  
Length Constraints: Maximum length of 500.  
Required: Yes

 ** [CustomerId](#API_StartChatContact_RequestSyntax) **   <a name="connect-StartChatContact-request-CustomerId"></a>
The customer's identification number. For example, the `CustomerId` may be a customer number from your CRM.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [DisconnectOnCustomerExit](#API_StartChatContact_RequestSyntax) **   <a name="connect-StartChatContact-request-DisconnectOnCustomerExit"></a>
A list of participant types to automatically disconnect when the end customer ends the chat session, allowing them to continue through disconnect flows such as surveys or feedback forms.  
Type: Array of strings  
Array Members: Fixed number of 1 item.  
Valid Values: `AGENT`   
Required: No

 ** [InitialMessage](#API_StartChatContact_RequestSyntax) **   <a name="connect-StartChatContact-request-InitialMessage"></a>
The initial message to be sent to the newly created chat.  
Type: [ChatMessage](API_ChatMessage.md) object  
Required: No

 ** [InstanceId](#API_StartChatContact_RequestSyntax) **   <a name="connect-StartChatContact-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [ParticipantConfiguration](#API_StartChatContact_RequestSyntax) **   <a name="connect-StartChatContact-request-ParticipantConfiguration"></a>
 The configuration of the participant.   
Type: [ParticipantConfiguration](API_ParticipantConfiguration.md) object  
Required: No

 ** [ParticipantDetails](#API_StartChatContact_RequestSyntax) **   <a name="connect-StartChatContact-request-ParticipantDetails"></a>
Information identifying the participant.  
Type: [ParticipantDetails](API_ParticipantDetails.md) object  
Required: Yes

 ** [PersistentChat](#API_StartChatContact_RequestSyntax) **   <a name="connect-StartChatContact-request-PersistentChat"></a>
Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see [Enable persistent chat](https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html).  
Type: [PersistentChat](API_PersistentChat.md) object  
Required: No

 ** [RelatedContactId](#API_StartChatContact_RequestSyntax) **   <a name="connect-StartChatContact-request-RelatedContactId"></a>
The unique identifier for an Amazon Connect contact. This identifier is related to the chat starting.  
You cannot provide data for both RelatedContactId and PersistentChat. 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [SegmentAttributes](#API_StartChatContact_RequestSyntax) **   <a name="connect-StartChatContact-request-SegmentAttributes"></a>
A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.  
Attribute keys can include only alphanumeric, -, and \$1.  
This field can be used to show channel subtype, such as `connect:Guide`.  
The types `application/vnd.amazonaws.connect.message.interactive` and `application/vnd.amazonaws.connect.message.interactive.response` must be present in the SupportedMessagingContentTypes field of this API in order to set `SegmentAttributes` as \$1` "connect:Subtype": {"valueString" : "connect:Guide" }}`.
Type: String to [SegmentAttributeValue](API_SegmentAttributeValue.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [SupportedMessagingContentTypes](#API_StartChatContact_RequestSyntax) **   <a name="connect-StartChatContact-request-SupportedMessagingContentTypes"></a>
The supported chat message content types. Supported types are `text/plain`, `text/markdown`, `application/json`, `application/vnd.amazonaws.connect.message.interactive`, and `application/vnd.amazonaws.connect.message.interactive.response`.   
Content types must always contain `text/plain`. You can then put any other supported type in the list. For example, all the following lists are valid because they contain `text/plain`: `[text/plain, text/markdown, application/json]`, `[text/markdown, text/plain]`, `[text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response]`.   
The type `application/vnd.amazonaws.connect.message.interactive` is required to use the [Show view](https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html) flow block.
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

## Response Syntax
<a name="API_StartChatContact_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactId": "string",
   "ContinuedFromContactId": "string",
   "ParticipantId": "string",
   "ParticipantToken": "string"
}
```

## Response Elements
<a name="API_StartChatContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContactId](#API_StartChatContact_ResponseSyntax) **   <a name="connect-StartChatContact-response-ContactId"></a>
The identifier of this contact within the Amazon Connect instance.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [ContinuedFromContactId](#API_StartChatContact_ResponseSyntax) **   <a name="connect-StartChatContact-response-ContinuedFromContactId"></a>
The contactId from which a persistent chat session is started. This field is populated only for persistent chats.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [ParticipantId](#API_StartChatContact_ResponseSyntax) **   <a name="connect-StartChatContact-response-ParticipantId"></a>
The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [ParticipantToken](#API_StartChatContact_ResponseSyntax) **   <a name="connect-StartChatContact-response-ParticipantToken"></a>
The token used by the chat participant to call [CreateParticipantConnection](https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html). The participant token is valid for the lifetime of a chat participant.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.

## Errors
<a name="API_StartChatContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

## See Also
<a name="API_StartChatContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/StartChatContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/StartChatContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StartChatContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/StartChatContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/StartChatContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/StartChatContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/StartChatContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StartChatContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StartChatContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StartChatContact) 

# StartContactEvaluation
<a name="API_StartContactEvaluation"></a>

Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started. 

**Note**  
Evaluations created through the public API do not contain answer values suggested from automation.

## Request Syntax
<a name="API_StartContactEvaluation_RequestSyntax"></a>

```
PUT /contact-evaluations/InstanceId HTTP/1.1
Content-type: application/json

{
   "AutoEvaluationConfiguration": { 
      "Enabled": boolean
   },
   "ClientToken": "string",
   "ContactId": "string",
   "EvaluationFormId": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_StartContactEvaluation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_StartContactEvaluation_RequestSyntax) **   <a name="connect-StartContactEvaluation-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_StartContactEvaluation_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AutoEvaluationConfiguration](#API_StartContactEvaluation_RequestSyntax) **   <a name="connect-StartContactEvaluation-request-AutoEvaluationConfiguration"></a>
Whether automated evaluations are enabled.  
Type: [AutoEvaluationConfiguration](API_AutoEvaluationConfiguration.md) object  
Required: No

 ** [ClientToken](#API_StartContactEvaluation_RequestSyntax) **   <a name="connect-StartContactEvaluation-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [ContactId](#API_StartContactEvaluation_RequestSyntax) **   <a name="connect-StartContactEvaluation-request-ContactId"></a>
The identifier of the contact in this instance of Amazon Connect.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [EvaluationFormId](#API_StartContactEvaluation_RequestSyntax) **   <a name="connect-StartContactEvaluation-request-EvaluationFormId"></a>
The unique identifier for the evaluation form.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [Tags](#API_StartContactEvaluation_RequestSyntax) **   <a name="connect-StartContactEvaluation-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_StartContactEvaluation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EvaluationArn": "string",
   "EvaluationId": "string"
}
```

## Response Elements
<a name="API_StartContactEvaluation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EvaluationArn](#API_StartContactEvaluation_ResponseSyntax) **   <a name="connect-StartContactEvaluation-response-EvaluationArn"></a>
The Amazon Resource Name (ARN) for the contact evaluation resource.  
Type: String

 ** [EvaluationId](#API_StartContactEvaluation_ResponseSyntax) **   <a name="connect-StartContactEvaluation-response-EvaluationId"></a>
A unique identifier for the contact evaluation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_StartContactEvaluation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_StartContactEvaluation_Examples"></a>

### Example
<a name="API_StartContactEvaluation_Example_1"></a>

The following example starts a contact evaluation for a contact.

#### Sample Request
<a name="API_StartContactEvaluation_Example_1_Request"></a>

```
{
   "InstanceId": "[instance_id]",
   "EvaluationFormId": "[evaluation_form_id]",
   "ContactId": "[contact_id]"
}
```

#### Sample Response
<a name="API_StartContactEvaluation_Example_1_Response"></a>

```
{
   "EvaluationId": "[evaluation_id]",
   "EvaluationArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/contact-evaluation/[evaluation_id]"
}
```

## See Also
<a name="API_StartContactEvaluation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/StartContactEvaluation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/StartContactEvaluation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StartContactEvaluation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/StartContactEvaluation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/StartContactEvaluation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/StartContactEvaluation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/StartContactEvaluation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StartContactEvaluation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StartContactEvaluation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StartContactEvaluation) 

# StartContactMediaProcessing
<a name="API_StartContactMediaProcessing"></a>

 Enables in-flight message processing for an ongoing chat session. Message processing will stay active for the rest of the chat, even if an individual contact segment ends. 

## Request Syntax
<a name="API_StartContactMediaProcessing_RequestSyntax"></a>

```
POST /contact/start-contact-media-processing HTTP/1.1
Content-type: application/json

{
   "ContactId": "string",
   "FailureMode": "string",
   "InstanceId": "string",
   "ProcessorArn": "string"
}
```

## URI Request Parameters
<a name="API_StartContactMediaProcessing_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StartContactMediaProcessing_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ContactId](#API_StartContactMediaProcessing_RequestSyntax) **   <a name="connect-StartContactMediaProcessing-request-ContactId"></a>
The identifier of the contact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [FailureMode](#API_StartContactMediaProcessing_RequestSyntax) **   <a name="connect-StartContactMediaProcessing-request-FailureMode"></a>
 The desired behavior for failed message processing.   
Type: String  
Valid Values: `DELIVER_UNPROCESSED_MESSAGE | DO_NOT_DELIVER_UNPROCESSED_MESSAGE`   
Required: No

 ** [InstanceId](#API_StartContactMediaProcessing_RequestSyntax) **   <a name="connect-StartContactMediaProcessing-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [ProcessorArn](#API_StartContactMediaProcessing_RequestSyntax) **   <a name="connect-StartContactMediaProcessing-request-ProcessorArn"></a>
 The Amazon Resource Name (ARN) of the Lambda processor. You can find the Amazon Resource Name of the lambda in the lambda console.   
Type: String  
Required: No

## Response Syntax
<a name="API_StartContactMediaProcessing_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_StartContactMediaProcessing_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_StartContactMediaProcessing_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

## See Also
<a name="API_StartContactMediaProcessing_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/StartContactMediaProcessing) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/StartContactMediaProcessing) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StartContactMediaProcessing) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/StartContactMediaProcessing) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/StartContactMediaProcessing) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/StartContactMediaProcessing) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/StartContactMediaProcessing) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StartContactMediaProcessing) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StartContactMediaProcessing) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StartContactMediaProcessing) 

# StartContactRecording
<a name="API_StartContactRecording"></a>

Starts recording the contact: 
+ If the API is called *before* the agent joins the call, recording starts when the agent joins the call.
+ If the API is called *after* the agent joins the call, recording starts at the time of the API call.

StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

You can use this API to override the recording behavior configured in the [Set recording behavior](https://docs.aws.amazon.com/connect/latest/adminguide/set-recording-behavior.html) block.

Only voice recordings are supported at this time.

## Request Syntax
<a name="API_StartContactRecording_RequestSyntax"></a>

```
POST /contact/start-recording HTTP/1.1
Content-type: application/json

{
   "ContactId": "string",
   "InitialContactId": "string",
   "InstanceId": "string",
   "VoiceRecordingConfiguration": { 
      "IvrRecordingTrack": "string",
      "VoiceRecordingTrack": "string"
   }
}
```

## URI Request Parameters
<a name="API_StartContactRecording_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StartContactRecording_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ContactId](#API_StartContactRecording_RequestSyntax) **   <a name="connect-StartContactRecording-request-ContactId"></a>
The identifier of the contact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InitialContactId](#API_StartContactRecording_RequestSyntax) **   <a name="connect-StartContactRecording-request-InitialContactId"></a>
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_StartContactRecording_RequestSyntax) **   <a name="connect-StartContactRecording-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [VoiceRecordingConfiguration](#API_StartContactRecording_RequestSyntax) **   <a name="connect-StartContactRecording-request-VoiceRecordingConfiguration"></a>
The person being recorded.  
Type: [VoiceRecordingConfiguration](API_VoiceRecordingConfiguration.md) object  
Required: Yes

## Response Syntax
<a name="API_StartContactRecording_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_StartContactRecording_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_StartContactRecording_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidActiveRegionException **   
This exception occurs when an API request is made to a non-active region in an Amazon Connect instance configured with Amazon Connect Global Resiliency. For example, if the active region is US West (Oregon) and a request is made to US East (N. Virginia), the exception will be returned.  
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

## See Also
<a name="API_StartContactRecording_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/StartContactRecording) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/StartContactRecording) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StartContactRecording) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/StartContactRecording) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/StartContactRecording) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/StartContactRecording) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/StartContactRecording) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StartContactRecording) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StartContactRecording) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StartContactRecording) 

# StartContactStreaming
<a name="API_StartContactStreaming"></a>

 Initiates real-time message streaming for a new chat contact.

 For more information about message streaming, see [Enable real-time chat message streaming](https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html) in the *Amazon Connect Administrator Guide*.

For more information about chat, see the following topics in the *Amazon Connect Administrator Guide*: 
+  [Concepts: Web and mobile messaging capabilities in Amazon Connect](https://docs.aws.amazon.com/connect/latest/adminguide/web-and-mobile-chat.html) 
+  [Amazon Connect Chat security best practices](https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat) 

## Request Syntax
<a name="API_StartContactStreaming_RequestSyntax"></a>

```
POST /contact/start-streaming HTTP/1.1
Content-type: application/json

{
   "ChatStreamingConfiguration": { 
      "StreamingEndpointArn": "string"
   },
   "ClientToken": "string",
   "ContactId": "string",
   "InstanceId": "string"
}
```

## URI Request Parameters
<a name="API_StartContactStreaming_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StartContactStreaming_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ChatStreamingConfiguration](#API_StartContactStreaming_RequestSyntax) **   <a name="connect-StartContactStreaming-request-ChatStreamingConfiguration"></a>
The streaming configuration, such as the Amazon SNS streaming endpoint.  
Type: [ChatStreamingConfiguration](API_ChatStreamingConfiguration.md) object  
Required: Yes

 ** [ClientToken](#API_StartContactStreaming_RequestSyntax) **   <a name="connect-StartContactStreaming-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: Yes

 ** [ContactId](#API_StartContactStreaming_RequestSyntax) **   <a name="connect-StartContactStreaming-request-ContactId"></a>
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_StartContactStreaming_RequestSyntax) **   <a name="connect-StartContactStreaming-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Syntax
<a name="API_StartContactStreaming_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "StreamingId": "string"
}
```

## Response Elements
<a name="API_StartContactStreaming_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [StreamingId](#API_StartContactStreaming_ResponseSyntax) **   <a name="connect-StartContactStreaming-response-StreamingId"></a>
The identifier of the streaming configuration enabled.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

## Errors
<a name="API_StartContactStreaming_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

## See Also
<a name="API_StartContactStreaming_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/StartContactStreaming) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/StartContactStreaming) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StartContactStreaming) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/StartContactStreaming) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/StartContactStreaming) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/StartContactStreaming) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/StartContactStreaming) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StartContactStreaming) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StartContactStreaming) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StartContactStreaming) 

# StartEmailContact
<a name="API_StartEmailContact"></a>

Creates an inbound email contact and initiates a flow to start the email contact for the customer. Response of this API provides the ContactId of the email contact created.

## Request Syntax
<a name="API_StartEmailContact_RequestSyntax"></a>

```
PUT /contact/email HTTP/1.1
Content-type: application/json

{
   "AdditionalRecipients": { 
      "CcAddresses": [ 
         { 
            "DisplayName": "string",
            "EmailAddress": "string"
         }
      ],
      "ToAddresses": [ 
         { 
            "DisplayName": "string",
            "EmailAddress": "string"
         }
      ]
   },
   "Attachments": [ 
      { 
         "FileName": "string",
         "S3Url": "string"
      }
   ],
   "Attributes": { 
      "string" : "string" 
   },
   "ClientToken": "string",
   "ContactFlowId": "string",
   "Description": "string",
   "DestinationEmailAddress": "string",
   "EmailMessage": { 
      "MessageSourceType": "string",
      "RawMessage": { 
         "Body": "string",
         "ContentType": "string",
         "Headers": { 
            "string" : "string" 
         },
         "Subject": "string"
      }
   },
   "FromEmailAddress": { 
      "DisplayName": "string",
      "EmailAddress": "string"
   },
   "InstanceId": "string",
   "Name": "string",
   "References": { 
      "string" : { 
         "Arn": "string",
         "Status": "string",
         "StatusReason": "string",
         "Type": "string",
         "Value": "string"
      }
   },
   "RelatedContactId": "string",
   "SegmentAttributes": { 
      "string" : { 
         "ValueArn": "string",
         "ValueInteger": number,
         "ValueList": [ 
            "SegmentAttributeValue"
         ],
         "ValueMap": { 
            "string" : "SegmentAttributeValue"
         },
         "ValueString": "string"
      }
   }
}
```

## URI Request Parameters
<a name="API_StartEmailContact_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StartEmailContact_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AdditionalRecipients](#API_StartEmailContact_RequestSyntax) **   <a name="connect-StartEmailContact-request-AdditionalRecipients"></a>
The additional recipients address of the email.  
Type: [InboundAdditionalRecipients](API_InboundAdditionalRecipients.md) object  
Required: No

 ** [Attachments](#API_StartEmailContact_RequestSyntax) **   <a name="connect-StartEmailContact-request-Attachments"></a>
List of S3 presigned URLs of email attachments and their file name.   
Type: Array of [EmailAttachment](API_EmailAttachment.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: No

 ** [Attributes](#API_StartEmailContact_RequestSyntax) **   <a name="connect-StartEmailContact-request-Attributes"></a>
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.  
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 32767.  
Value Length Constraints: Minimum length of 0. Maximum length of 32767.  
Required: No

 ** [ClientToken](#API_StartEmailContact_RequestSyntax) **   <a name="connect-StartEmailContact-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [ContactFlowId](#API_StartEmailContact_RequestSyntax) **   <a name="connect-StartEmailContact-request-ContactFlowId"></a>
The identifier of the flow for initiating the emails. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to **Routing**, **Flows**. Choose the flow. On the flow page, under the name of the flow, choose **Show additional flow information**. The ContactFlowId is the last part of the ARN, shown here in bold:   
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**   
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [Description](#API_StartEmailContact_RequestSyntax) **   <a name="connect-StartEmailContact-request-Description"></a>
A description of the email contact.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.  
Required: No

 ** [DestinationEmailAddress](#API_StartEmailContact_RequestSyntax) **   <a name="connect-StartEmailContact-request-DestinationEmailAddress"></a>
The email address associated with the Amazon Connect instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[^\s@]+@[^\s@]+\.[^\s@]+`   
Required: Yes

 ** [EmailMessage](#API_StartEmailContact_RequestSyntax) **   <a name="connect-StartEmailContact-request-EmailMessage"></a>
The email message body to be sent to the newly created email.  
Type: [InboundEmailContent](API_InboundEmailContent.md) object  
Required: Yes

 ** [FromEmailAddress](#API_StartEmailContact_RequestSyntax) **   <a name="connect-StartEmailContact-request-FromEmailAddress"></a>
The email address of the customer.  
Type: [EmailAddressInfo](API_EmailAddressInfo.md) object  
Required: Yes

 ** [InstanceId](#API_StartEmailContact_RequestSyntax) **   <a name="connect-StartEmailContact-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [Name](#API_StartEmailContact_RequestSyntax) **   <a name="connect-StartEmailContact-request-Name"></a>
The name of a email that is shown to an agent in the Contact Control Panel (CCP).  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [References](#API_StartEmailContact_RequestSyntax) **   <a name="connect-StartEmailContact-request-References"></a>
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can have the following reference types at the time of creation: `URL` \$1 `NUMBER` \$1 `STRING` \$1 `DATE`. `EMAIL` \$1 `EMAIL_MESSAGE` \$1`ATTACHMENT` are not a supported reference type during email creation.  
Type: String to [Reference](API_Reference.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [RelatedContactId](#API_StartEmailContact_RequestSyntax) **   <a name="connect-StartEmailContact-request-RelatedContactId"></a>
The contactId that is related to this contact. Linking emails together by using `RelatedContactID` copies over contact attributes from the related email contact to the new email contact. All updates to user-defined attributes in the new email contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using `RelatedContactId`.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [SegmentAttributes](#API_StartEmailContact_RequestSyntax) **   <a name="connect-StartEmailContact-request-SegmentAttributes"></a>
A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.  
Attribute keys can include only alphanumeric, -, and \$1.  
This field can be used to show channel subtype, such as `connect:Guide`.  
To set contact expiry, a `ValueMap` must be specified containing the integer number of minutes the contact will be active for before expiring, with `SegmentAttributes` like \$1 ` "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger":135}}}}`.
Type: String to [SegmentAttributeValue](API_SegmentAttributeValue.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

## Response Syntax
<a name="API_StartEmailContact_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactId": "string"
}
```

## Response Elements
<a name="API_StartEmailContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContactId](#API_StartEmailContact_ResponseSyntax) **   <a name="connect-StartEmailContact-response-ContactId"></a>
The identifier of this contact within the Amazon Connect instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_StartEmailContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** IdempotencyException **   
An entity with the same name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_StartEmailContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/StartEmailContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/StartEmailContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StartEmailContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/StartEmailContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/StartEmailContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/StartEmailContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/StartEmailContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StartEmailContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StartEmailContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StartEmailContact) 

# StartOutboundChatContact
<a name="API_StartOutboundChatContact"></a>

Initiates a new outbound SMS or WhatsApp contact to a customer. Response of this API provides the `ContactId` of the outbound SMS or WhatsApp contact created.

 **SourceEndpoint** only supports Endpoints with `CONNECT_PHONENUMBER_ARN` as Type and **DestinationEndpoint** only supports Endpoints with `TELEPHONE_NUMBER` as Type. **ContactFlowId** initiates the flow to manage the new contact created.

This API can be used to initiate outbound SMS or WhatsApp contacts for an agent, or it can also deflect an ongoing contact to an outbound SMS or WhatsApp contact by using the [StartOutboundChatContact](https://docs.aws.amazon.com/connect/latest/APIReference/API_StartOutboundChatContact.html) Flow Action.

For more information about using SMS or WhatsApp in Amazon Connect, see the following topics in the *Amazon Connect Administrator Guide*:
+  [Set up SMS messaging](https://docs.aws.amazon.com/connect/latest/adminguide/setup-sms-messaging.html) 
+  [Request an SMS-enabled phone number through AWS End User Messaging SMS](https://docs.aws.amazon.com/connect/latest/adminguide/sms-number.html) 
+  [Set up WhatsApp Business messaging](https://docs.aws.amazon.com/connect/latest/adminguide/whatsapp-integration.html) 

## Request Syntax
<a name="API_StartOutboundChatContact_RequestSyntax"></a>

```
PUT /contact/outbound-chat HTTP/1.1
Content-type: application/json

{
   "Attributes": { 
      "string" : "string" 
   },
   "ChatDurationInMinutes": number,
   "ClientToken": "string",
   "ContactFlowId": "string",
   "DestinationEndpoint": { 
      "Address": "string",
      "Type": "string"
   },
   "InitialSystemMessage": { 
      "Content": "string",
      "ContentType": "string"
   },
   "InitialTemplatedSystemMessage": { 
      "KnowledgeBaseId": "string",
      "MessageTemplateId": "string",
      "TemplateAttributes": { 
         "CustomAttributes": { 
            "string" : "string" 
         },
         "CustomerProfileAttributes": "string"
      }
   },
   "InstanceId": "string",
   "ParticipantDetails": { 
      "DisplayName": "string"
   },
   "RelatedContactId": "string",
   "SegmentAttributes": { 
      "string" : { 
         "ValueArn": "string",
         "ValueInteger": number,
         "ValueList": [ 
            "SegmentAttributeValue"
         ],
         "ValueMap": { 
            "string" : "SegmentAttributeValue"
         },
         "ValueString": "string"
      }
   },
   "SourceEndpoint": { 
      "Address": "string",
      "Type": "string"
   },
   "SupportedMessagingContentTypes": [ "string" ]
}
```

## URI Request Parameters
<a name="API_StartOutboundChatContact_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StartOutboundChatContact_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Attributes](#API_StartOutboundChatContact_RequestSyntax) **   <a name="connect-StartOutboundChatContact-request-Attributes"></a>
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 32767.  
Value Length Constraints: Minimum length of 0. Maximum length of 32767.  
Required: No

 ** [ChatDurationInMinutes](#API_StartOutboundChatContact_RequestSyntax) **   <a name="connect-StartOutboundChatContact-request-ChatDurationInMinutes"></a>
The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).  
Type: Integer  
Valid Range: Minimum value of 60. Maximum value of 10080.  
Required: No

 ** [ClientToken](#API_StartOutboundChatContact_RequestSyntax) **   <a name="connect-StartOutboundChatContact-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [ContactFlowId](#API_StartOutboundChatContact_RequestSyntax) **   <a name="connect-StartOutboundChatContact-request-ContactFlowId"></a>
The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to **Routing, Contact Flows**. Choose the flow. On the flow page, under the name of the flow, choose **Show additional flow information**. The ContactFlowId is the last part of the ARN, shown here in bold:  
+ arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**123ec456-a007-89c0-1234-xxxxxxxxxxxx** 
Type: String  
Length Constraints: Maximum length of 500.  
Required: Yes

 ** [DestinationEndpoint](#API_StartOutboundChatContact_RequestSyntax) **   <a name="connect-StartOutboundChatContact-request-DestinationEndpoint"></a>
Information about the endpoint.  
Type: [Endpoint](API_Endpoint.md) object  
Required: Yes

 ** [InitialSystemMessage](#API_StartOutboundChatContact_RequestSyntax) **   <a name="connect-StartOutboundChatContact-request-InitialSystemMessage"></a>
A chat message.  
Type: [ChatMessage](API_ChatMessage.md) object  
Required: No

 ** [InitialTemplatedSystemMessage](#API_StartOutboundChatContact_RequestSyntax) **   <a name="connect-StartOutboundChatContact-request-InitialTemplatedSystemMessage"></a>
Information about template message configuration.  
Type: [TemplatedMessageConfig](API_TemplatedMessageConfig.md) object  
Required: No

 ** [InstanceId](#API_StartOutboundChatContact_RequestSyntax) **   <a name="connect-StartOutboundChatContact-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [ParticipantDetails](#API_StartOutboundChatContact_RequestSyntax) **   <a name="connect-StartOutboundChatContact-request-ParticipantDetails"></a>
The customer's details.  
Type: [ParticipantDetails](API_ParticipantDetails.md) object  
Required: No

 ** [RelatedContactId](#API_StartOutboundChatContact_RequestSyntax) **   <a name="connect-StartOutboundChatContact-request-RelatedContactId"></a>
The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [SegmentAttributes](#API_StartOutboundChatContact_RequestSyntax) **   <a name="connect-StartOutboundChatContact-request-SegmentAttributes"></a>
A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.  
+ Attribute keys can include only alphanumeric, `-`, and `_`.
+ This field can be used to show channel subtype, such as `connect:SMS` and `connect:WhatsApp`.
Type: String to [SegmentAttributeValue](API_SegmentAttributeValue.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

 ** [SourceEndpoint](#API_StartOutboundChatContact_RequestSyntax) **   <a name="connect-StartOutboundChatContact-request-SourceEndpoint"></a>
Information about the endpoint.  
Type: [Endpoint](API_Endpoint.md) object  
Required: Yes

 ** [SupportedMessagingContentTypes](#API_StartOutboundChatContact_RequestSyntax) **   <a name="connect-StartOutboundChatContact-request-SupportedMessagingContentTypes"></a>
The supported chat message content types. Supported types are:  
+  `text/plain` 
+  `text/markdown` 
+  `application/json, application/vnd.amazonaws.connect.message.interactive` 
+  `application/vnd.amazonaws.connect.message.interactive.response` 
Content types must always contain `text/plain`. You can then put any other supported type in the list. For example, all the following lists are valid because they contain `text/plain`:  
+  `[text/plain, text/markdown, application/json]` 
+  `[text/markdown, text/plain]` 
+  `[text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response]` 
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

## Response Syntax
<a name="API_StartOutboundChatContact_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactId": "string"
}
```

## Response Elements
<a name="API_StartOutboundChatContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContactId](#API_StartOutboundChatContact_ResponseSyntax) **   <a name="connect-StartOutboundChatContact-response-ContactId"></a>
The identifier of this contact within the Amazon Connect instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_StartOutboundChatContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
Operation cannot be performed at this time as there is a conflict with another operation or contact state.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_StartOutboundChatContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/StartOutboundChatContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/StartOutboundChatContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StartOutboundChatContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/StartOutboundChatContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/StartOutboundChatContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/StartOutboundChatContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/StartOutboundChatContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StartOutboundChatContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StartOutboundChatContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StartOutboundChatContact) 

# StartOutboundEmailContact
<a name="API_StartOutboundEmailContact"></a>

Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer.

## Request Syntax
<a name="API_StartOutboundEmailContact_RequestSyntax"></a>

```
PUT /contact/outbound-email HTTP/1.1
Content-type: application/json

{
   "AdditionalRecipients": { 
      "CcEmailAddresses": [ 
         { 
            "DisplayName": "string",
            "EmailAddress": "string"
         }
      ]
   },
   "ClientToken": "string",
   "ContactId": "string",
   "DestinationEmailAddress": { 
      "DisplayName": "string",
      "EmailAddress": "string"
   },
   "EmailMessage": { 
      "MessageSourceType": "string",
      "RawMessage": { 
         "Body": "string",
         "ContentType": "string",
         "Subject": "string"
      },
      "TemplatedMessageConfig": { 
         "KnowledgeBaseId": "string",
         "MessageTemplateId": "string",
         "TemplateAttributes": { 
            "CustomAttributes": { 
               "string" : "string" 
            },
            "CustomerProfileAttributes": "string"
         }
      }
   },
   "FromEmailAddress": { 
      "DisplayName": "string",
      "EmailAddress": "string"
   },
   "InstanceId": "string"
}
```

## URI Request Parameters
<a name="API_StartOutboundEmailContact_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StartOutboundEmailContact_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AdditionalRecipients](#API_StartOutboundEmailContact_RequestSyntax) **   <a name="connect-StartOutboundEmailContact-request-AdditionalRecipients"></a>
The additional recipients address of email in CC.  
Type: [OutboundAdditionalRecipients](API_OutboundAdditionalRecipients.md) object  
Required: No

 ** [ClientToken](#API_StartOutboundEmailContact_RequestSyntax) **   <a name="connect-StartOutboundEmailContact-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [ContactId](#API_StartOutboundEmailContact_RequestSyntax) **   <a name="connect-StartOutboundEmailContact-request-ContactId"></a>
The identifier of the contact in this instance of Amazon Connect.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [DestinationEmailAddress](#API_StartOutboundEmailContact_RequestSyntax) **   <a name="connect-StartOutboundEmailContact-request-DestinationEmailAddress"></a>
The email address of the customer.  
Type: [EmailAddressInfo](API_EmailAddressInfo.md) object  
Required: Yes

 ** [EmailMessage](#API_StartOutboundEmailContact_RequestSyntax) **   <a name="connect-StartOutboundEmailContact-request-EmailMessage"></a>
The email message body to be sent to the newly created email.  
Type: [OutboundEmailContent](API_OutboundEmailContent.md) object  
Required: Yes

 ** [FromEmailAddress](#API_StartOutboundEmailContact_RequestSyntax) **   <a name="connect-StartOutboundEmailContact-request-FromEmailAddress"></a>
The email address associated with the Amazon Connect instance.  
Type: [EmailAddressInfo](API_EmailAddressInfo.md) object  
Required: No

 ** [InstanceId](#API_StartOutboundEmailContact_RequestSyntax) **   <a name="connect-StartOutboundEmailContact-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Syntax
<a name="API_StartOutboundEmailContact_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactId": "string"
}
```

## Response Elements
<a name="API_StartOutboundEmailContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContactId](#API_StartOutboundEmailContact_ResponseSyntax) **   <a name="connect-StartOutboundEmailContact-response-ContactId"></a>
The identifier of the contact in this instance of Amazon Connect.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_StartOutboundEmailContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** IdempotencyException **   
An entity with the same name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_StartOutboundEmailContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/StartOutboundEmailContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/StartOutboundEmailContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StartOutboundEmailContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/StartOutboundEmailContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/StartOutboundEmailContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/StartOutboundEmailContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/StartOutboundEmailContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StartOutboundEmailContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StartOutboundEmailContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StartOutboundEmailContact) 

# StartOutboundVoiceContact
<a name="API_StartOutboundVoiceContact"></a>

Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in `ContactFlowId`).

Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.

Dialing timeout for this operation can be configured with the “RingTimeoutInSeconds” parameter. If not specified, the default dialing timeout will be 60 seconds which means if the call is not connected within 60 seconds, it fails.

**Note**  
UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*. 

**Note**  
Campaign calls are not allowed by default. Before you can make a call with `TrafficType` = `CAMPAIGN`, you must submit a service quota increase request to the quota [Amazon Connect campaigns](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#outbound-communications-quotas). 

**Note**  
For Preview dialing mode, only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API with OutboundStrategy. 

## Request Syntax
<a name="API_StartOutboundVoiceContact_RequestSyntax"></a>

```
PUT /contact/outbound-voice HTTP/1.1
Content-type: application/json

{
   "AnswerMachineDetectionConfig": { 
      "AwaitAnswerMachinePrompt": boolean,
      "EnableAnswerMachineDetection": boolean
   },
   "Attributes": { 
      "string" : "string" 
   },
   "CampaignId": "string",
   "ClientToken": "string",
   "ContactFlowId": "string",
   "Description": "string",
   "DestinationPhoneNumber": "string",
   "InstanceId": "string",
   "Name": "string",
   "OutboundStrategy": { 
      "Config": { 
         "AgentFirst": { 
            "Preview": { 
               "AllowedUserActions": [ "string" ],
               "PostAcceptTimeoutConfig": { 
                  "DurationInSeconds": number
               }
            }
         }
      },
      "Type": "string"
   },
   "QueueId": "string",
   "References": { 
      "string" : { 
         "Arn": "string",
         "Status": "string",
         "StatusReason": "string",
         "Type": "string",
         "Value": "string"
      }
   },
   "RelatedContactId": "string",
   "RingTimeoutInSeconds": number,
   "SourcePhoneNumber": "string",
   "TrafficType": "string"
}
```

## URI Request Parameters
<a name="API_StartOutboundVoiceContact_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StartOutboundVoiceContact_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AnswerMachineDetectionConfig](#API_StartOutboundVoiceContact_RequestSyntax) **   <a name="connect-StartOutboundVoiceContact-request-AnswerMachineDetectionConfig"></a>
Configuration of the answering machine detection for this outbound call.   
Type: [AnswerMachineDetectionConfig](API_AnswerMachineDetectionConfig.md) object  
Required: No

 ** [Attributes](#API_StartOutboundVoiceContact_RequestSyntax) **   <a name="connect-StartOutboundVoiceContact-request-Attributes"></a>
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.  
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 32767.  
Value Length Constraints: Minimum length of 0. Maximum length of 32767.  
Required: No

 ** [CampaignId](#API_StartOutboundVoiceContact_RequestSyntax) **   <a name="connect-StartOutboundVoiceContact-request-CampaignId"></a>
The campaign identifier of the outbound communication.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [ClientToken](#API_StartOutboundVoiceContact_RequestSyntax) **   <a name="connect-StartOutboundVoiceContact-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/). The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.   
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [ContactFlowId](#API_StartOutboundVoiceContact_RequestSyntax) **   <a name="connect-StartOutboundVoiceContact-request-ContactFlowId"></a>
The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to **Routing**, **Contact Flows**. Choose the flow. On the flow page, under the name of the flow, choose **Show additional flow information**. The ContactFlowId is the last part of the ARN, shown here in bold:   
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**   
Type: String  
Length Constraints: Maximum length of 500.  
Required: Yes

 ** [Description](#API_StartOutboundVoiceContact_RequestSyntax) **   <a name="connect-StartOutboundVoiceContact-request-Description"></a>
A description of the voice contact that appears in the agent's snapshot in the CCP logs. For more information about CCP logs, see [Download and review CCP logs](https://docs.aws.amazon.com/connect/latest/adminguide/download-ccp-logs.html) in the *Amazon Connect Administrator Guide*.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.  
Required: No

 ** [DestinationPhoneNumber](#API_StartOutboundVoiceContact_RequestSyntax) **   <a name="connect-StartOutboundVoiceContact-request-DestinationPhoneNumber"></a>
The phone number of the customer, in E.164 format.  
Type: String  
Pattern: `\\+[1-9]\\d{1,14}$`   
Required: Yes

 ** [InstanceId](#API_StartOutboundVoiceContact_RequestSyntax) **   <a name="connect-StartOutboundVoiceContact-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [Name](#API_StartOutboundVoiceContact_RequestSyntax) **   <a name="connect-StartOutboundVoiceContact-request-Name"></a>
The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [OutboundStrategy](#API_StartOutboundVoiceContact_RequestSyntax) **   <a name="connect-StartOutboundVoiceContact-request-OutboundStrategy"></a>
Information about the outbound strategy.  
Type: [OutboundStrategy](API_OutboundStrategy.md) object  
Required: No

 ** [QueueId](#API_StartOutboundVoiceContact_RequestSyntax) **   <a name="connect-StartOutboundVoiceContact-request-QueueId"></a>
The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the flow is used. If you do not specify a queue, you must specify a source phone number.  
Type: String  
Required: No

 ** [References](#API_StartOutboundVoiceContact_RequestSyntax) **   <a name="connect-StartOutboundVoiceContact-request-References"></a>
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the following reference types at the time of creation: `URL` \$1 `NUMBER` \$1 `STRING` \$1 `DATE` \$1 `EMAIL`. `ATTACHMENT` is not a supported reference type during voice contact creation.  
Type: String to [Reference](API_Reference.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [RelatedContactId](#API_StartOutboundVoiceContact_RequestSyntax) **   <a name="connect-StartOutboundVoiceContact-request-RelatedContactId"></a>
The `contactId` that is related to this contact. Linking voice, task, or chat by using `RelatedContactID` copies over contact attributes from the related contact to the new contact. All updates to user-defined attributes in the new contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using `RelatedContactId`.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [RingTimeoutInSeconds](#API_StartOutboundVoiceContact_RequestSyntax) **   <a name="connect-StartOutboundVoiceContact-request-RingTimeoutInSeconds"></a>
The maximum time the outbound call will wait for the destination to answer the call, in seconds   
Type: Integer  
Valid Range: Minimum value of 15. Maximum value of 60.  
Required: No

 ** [SourcePhoneNumber](#API_StartOutboundVoiceContact_RequestSyntax) **   <a name="connect-StartOutboundVoiceContact-request-SourcePhoneNumber"></a>
The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.  
Type: String  
Pattern: `\\+[1-9]\\d{1,14}$`   
Required: No

 ** [TrafficType](#API_StartOutboundVoiceContact_RequestSyntax) **   <a name="connect-StartOutboundVoiceContact-request-TrafficType"></a>
Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is `GENERAL`. Use `CAMPAIGN` if `EnableAnswerMachineDetection` is set to `true`. For all other cases, use `GENERAL`.   
Type: String  
Valid Values: `GENERAL | CAMPAIGN`   
Required: No

## Response Syntax
<a name="API_StartOutboundVoiceContact_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactId": "string"
}
```

## Response Elements
<a name="API_StartOutboundVoiceContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContactId](#API_StartOutboundVoiceContact_ResponseSyntax) **   <a name="connect-StartOutboundVoiceContact-response-ContactId"></a>
The identifier of this contact within the Amazon Connect instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_StartOutboundVoiceContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DestinationNotAllowedException **   
Outbound calls to the destination number are not allowed.    
 ** Message **   
The message about the outbound calls.
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** OutboundContactNotPermittedException **   
The contact is not permitted.    
 ** Message **   
The message about the contact.
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

## See Also
<a name="API_StartOutboundVoiceContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/StartOutboundVoiceContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/StartOutboundVoiceContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StartOutboundVoiceContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/StartOutboundVoiceContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/StartOutboundVoiceContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/StartOutboundVoiceContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/StartOutboundVoiceContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StartOutboundVoiceContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StartOutboundVoiceContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StartOutboundVoiceContact) 

# StartScreenSharing
<a name="API_StartScreenSharing"></a>

Starts screen sharing for a contact. For more information about screen sharing, see [Set up in-app, web, video calling, and screen sharing capabilities](https://docs.aws.amazon.com/connect/latest/adminguide/inapp-calling.html) in the *Amazon Connect Administrator Guide*. 

## Request Syntax
<a name="API_StartScreenSharing_RequestSyntax"></a>

```
PUT /contact/screen-sharing HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "ContactId": "string",
   "InstanceId": "string"
}
```

## URI Request Parameters
<a name="API_StartScreenSharing_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StartScreenSharing_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_StartScreenSharing_RequestSyntax) **   <a name="connect-StartScreenSharing-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [ContactId](#API_StartScreenSharing_RequestSyntax) **   <a name="connect-StartScreenSharing-request-ContactId"></a>
The identifier of the contact in this instance of Amazon Connect.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_StartScreenSharing_RequestSyntax) **   <a name="connect-StartScreenSharing-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Syntax
<a name="API_StartScreenSharing_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_StartScreenSharing_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_StartScreenSharing_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_StartScreenSharing_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/StartScreenSharing) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/StartScreenSharing) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StartScreenSharing) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/StartScreenSharing) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/StartScreenSharing) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/StartScreenSharing) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/StartScreenSharing) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StartScreenSharing) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StartScreenSharing) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StartScreenSharing) 

# StartTaskContact
<a name="API_StartTaskContact"></a>

Initiates a flow to start a new task contact. For more information about task contacts, see [Concepts: Tasks in Amazon Connect](https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html) in the *Amazon Connect Administrator Guide*. 

When using `PreviousContactId` and `RelatedContactId` input parameters, note the following:
+  `PreviousContactId` 
  + Any updates to user-defined task contact attributes on any contact linked through the same `PreviousContactId` will affect every contact in the chain.
  + There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same `PreviousContactId`.
+  `RelatedContactId` 
  + Copies contact attributes from the related task contact to the new contact.
  + Any update on attributes in a new task contact does not update attributes on previous contact.
  + There’s no limit on the number of task contacts that can be created that use the same `RelatedContactId`.

In addition, when calling StartTaskContact include only one of these parameters: `ContactFlowID`, `QuickConnectID`, or `TaskTemplateID`. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the `TaskTemplateID` is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created.

A `ServiceQuotaExceededException` occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same `PreviousContactId`. For more information about service quotas for task contacts, see [Amazon Connect service quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*. 

## Request Syntax
<a name="API_StartTaskContact_RequestSyntax"></a>

```
PUT /contact/task HTTP/1.1
Content-type: application/json

{
   "Attachments": [ 
      { 
         "FileName": "string",
         "S3Url": "string"
      }
   ],
   "Attributes": { 
      "string" : "string" 
   },
   "ClientToken": "string",
   "ContactFlowId": "string",
   "Description": "string",
   "InstanceId": "string",
   "Name": "string",
   "PreviousContactId": "string",
   "QuickConnectId": "string",
   "References": { 
      "string" : { 
         "Arn": "string",
         "Status": "string",
         "StatusReason": "string",
         "Type": "string",
         "Value": "string"
      }
   },
   "RelatedContactId": "string",
   "ScheduledTime": number,
   "SegmentAttributes": { 
      "string" : { 
         "ValueArn": "string",
         "ValueInteger": number,
         "ValueList": [ 
            "SegmentAttributeValue"
         ],
         "ValueMap": { 
            "string" : "SegmentAttributeValue"
         },
         "ValueString": "string"
      }
   },
   "TaskTemplateId": "string"
}
```

## URI Request Parameters
<a name="API_StartTaskContact_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StartTaskContact_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Attachments](#API_StartTaskContact_RequestSyntax) **   <a name="connect-StartTaskContact-request-Attachments"></a>
List of S3 presigned URLs of task attachments and their file name. You can have a maximum of 5 attachments per task.  
Type: Array of [TaskAttachment](API_TaskAttachment.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Required: No

 ** [Attributes](#API_StartTaskContact_RequestSyntax) **   <a name="connect-StartTaskContact-request-Attributes"></a>
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.  
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 32767.  
Value Length Constraints: Minimum length of 0. Maximum length of 32767.  
Required: No

 ** [ClientToken](#API_StartTaskContact_RequestSyntax) **   <a name="connect-StartTaskContact-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [ContactFlowId](#API_StartTaskContact_RequestSyntax) **   <a name="connect-StartTaskContact-request-ContactFlowId"></a>
The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to **Routing**, **Flows**. Choose the flow. On the flow page, under the name of the flow, choose **Show additional flow information**. The ContactFlowId is the last part of the ARN, shown here in bold:   
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**   
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [Description](#API_StartTaskContact_RequestSyntax) **   <a name="connect-StartTaskContact-request-Description"></a>
A description of the task that is shown to an agent in the Contact Control Panel (CCP).  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.  
Required: No

 ** [InstanceId](#API_StartTaskContact_RequestSyntax) **   <a name="connect-StartTaskContact-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [Name](#API_StartTaskContact_RequestSyntax) **   <a name="connect-StartTaskContact-request-Name"></a>
The name of a task that is shown to an agent in the Contact Control Panel (CCP).  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: Yes

 ** [PreviousContactId](#API_StartTaskContact_RequestSyntax) **   <a name="connect-StartTaskContact-request-PreviousContactId"></a>
The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task contacts linked using the same `PreviousContactID` will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [QuickConnectId](#API_StartTaskContact_RequestSyntax) **   <a name="connect-StartTaskContact-request-QuickConnectId"></a>
The identifier for the quick connect. Tasks that are created by using `QuickConnectId` will use the flow that is defined on agent or queue quick connect. For more information about quick connects, see [Create quick connects](https://docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html).  
Type: String  
Required: No

 ** [References](#API_StartTaskContact_RequestSyntax) **   <a name="connect-StartTaskContact-request-References"></a>
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: `URL` \$1 `NUMBER` \$1 `STRING` \$1 `DATE` \$1 `EMAIL`. `ATTACHMENT` is not a supported reference type during task creation.  
Type: String to [Reference](API_Reference.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [RelatedContactId](#API_StartTaskContact_RequestSyntax) **   <a name="connect-StartTaskContact-request-RelatedContactId"></a>
The contactId that is [related](https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks) to this contact. Linking tasks together by using `RelatedContactID` copies over contact attributes from the related task contact to the new task contact. All updates to user-defined attributes in the new task contact are limited to the individual contact ID, unlike what happens when tasks are linked by using `PreviousContactID`. There are no limits to the number of contacts that can be linked by using `RelatedContactId`.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [ScheduledTime](#API_StartTaskContact_RequestSyntax) **   <a name="connect-StartTaskContact-request-ScheduledTime"></a>
The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.   
Type: Timestamp  
Required: No

 ** [SegmentAttributes](#API_StartTaskContact_RequestSyntax) **   <a name="connect-StartTaskContact-request-SegmentAttributes"></a>
A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.  
Attribute keys can include only alphanumeric, -, and \$1.  
This field can be used to set Contact Expiry as a duration in minutes and set a UserId for the User who created a task.  
To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with `SegmentAttributes` like \$1 ` "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger": 135}}}}`.   
To set the created by user, a valid AgentResourceId must be supplied, with `SegmentAttributes` like \$1 `"connect:CreatedByUser" { "ValueString": "arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/agent/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}}}`. 
Type: String to [SegmentAttributeValue](API_SegmentAttributeValue.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [TaskTemplateId](#API_StartTaskContact_RequestSyntax) **   <a name="connect-StartTaskContact-request-TaskTemplateId"></a>
A unique identifier for the task template. For more information about task templates, see [Create task templates](https://docs.aws.amazon.com/connect/latest/adminguide/task-templates.html) in the *Amazon Connect Administrator Guide*.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: No

## Response Syntax
<a name="API_StartTaskContact_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactId": "string"
}
```

## Response Elements
<a name="API_StartTaskContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContactId](#API_StartTaskContact_ResponseSyntax) **   <a name="connect-StartTaskContact-response-ContactId"></a>
The identifier of this contact within the Amazon Connect instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_StartTaskContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_StartTaskContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/StartTaskContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/StartTaskContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StartTaskContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/StartTaskContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/StartTaskContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/StartTaskContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/StartTaskContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StartTaskContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StartTaskContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StartTaskContact) 

# StartTestCaseExecution
<a name="API_StartTestCaseExecution"></a>

Starts executing a published test case.

## Request Syntax
<a name="API_StartTestCaseExecution_RequestSyntax"></a>

```
PUT /test-cases/InstanceId/TestCaseId/start-execution HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string"
}
```

## URI Request Parameters
<a name="API_StartTestCaseExecution_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_StartTestCaseExecution_RequestSyntax) **   <a name="connect-StartTestCaseExecution-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [TestCaseId](#API_StartTestCaseExecution_RequestSyntax) **   <a name="connect-StartTestCaseExecution-request-uri-TestCaseId"></a>
The identifier of the test case to execute.  
Length Constraints: Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_StartTestCaseExecution_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_StartTestCaseExecution_RequestSyntax) **   <a name="connect-StartTestCaseExecution-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

## Response Syntax
<a name="API_StartTestCaseExecution_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Status": "string",
   "TestCaseExecutionId": "string",
   "TestCaseId": "string"
}
```

## Response Elements
<a name="API_StartTestCaseExecution_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Status](#API_StartTestCaseExecution_ResponseSyntax) **   <a name="connect-StartTestCaseExecution-response-Status"></a>
The status of a test case execution.  
Type: String  
Valid Values: `INITIATED | PASSED | FAILED | IN_PROGRESS | STOPPED` 

 ** [TestCaseExecutionId](#API_StartTestCaseExecution_ResponseSyntax) **   <a name="connect-StartTestCaseExecution-response-TestCaseExecutionId"></a>
The identifier of the test case execution.  
Type: String  
Length Constraints: Maximum length of 500.

 ** [TestCaseId](#API_StartTestCaseExecution_ResponseSyntax) **   <a name="connect-StartTestCaseExecution-response-TestCaseId"></a>
The identifier of the test case resource that was executed.  
Type: String  
Length Constraints: Maximum length of 500.

## Errors
<a name="API_StartTestCaseExecution_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_StartTestCaseExecution_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/StartTestCaseExecution) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/StartTestCaseExecution) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StartTestCaseExecution) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/StartTestCaseExecution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/StartTestCaseExecution) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/StartTestCaseExecution) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/StartTestCaseExecution) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StartTestCaseExecution) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StartTestCaseExecution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StartTestCaseExecution) 

# StartWebRTCContact
<a name="API_StartWebRTCContact"></a>

Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).

## Request Syntax
<a name="API_StartWebRTCContact_RequestSyntax"></a>

```
PUT /contact/webrtc HTTP/1.1
Content-type: application/json

{
   "AllowedCapabilities": { 
      "Agent": { 
         "ScreenShare": "string",
         "Video": "string"
      },
      "Customer": { 
         "ScreenShare": "string",
         "Video": "string"
      }
   },
   "Attributes": { 
      "string" : "string" 
   },
   "ClientToken": "string",
   "ContactFlowId": "string",
   "Description": "string",
   "InstanceId": "string",
   "ParticipantDetails": { 
      "DisplayName": "string"
   },
   "References": { 
      "string" : { 
         "Arn": "string",
         "Status": "string",
         "StatusReason": "string",
         "Type": "string",
         "Value": "string"
      }
   },
   "RelatedContactId": "string"
}
```

## URI Request Parameters
<a name="API_StartWebRTCContact_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StartWebRTCContact_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AllowedCapabilities](#API_StartWebRTCContact_RequestSyntax) **   <a name="connect-StartWebRTCContact-request-AllowedCapabilities"></a>
Information about the video sharing capabilities of the participants (customer, agent).  
Type: [AllowedCapabilities](API_AllowedCapabilities.md) object  
Required: No

 ** [Attributes](#API_StartWebRTCContact_RequestSyntax) **   <a name="connect-StartWebRTCContact-request-Attributes"></a>
A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.  
There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, -, and \$1 characters.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 32767.  
Value Length Constraints: Minimum length of 0. Maximum length of 32767.  
Required: No

 ** [ClientToken](#API_StartWebRTCContact_RequestSyntax) **   <a name="connect-StartWebRTCContact-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [ContactFlowId](#API_StartWebRTCContact_RequestSyntax) **   <a name="connect-StartWebRTCContact-request-ContactFlowId"></a>
The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to **Routing**, **Flows**. Choose the flow. On the flow page, under the name of the flow, choose **Show additional flow information**. The ContactFlowId is the last part of the ARN, shown here in bold:   
arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**   
Type: String  
Length Constraints: Maximum length of 500.  
Required: Yes

 ** [Description](#API_StartWebRTCContact_RequestSyntax) **   <a name="connect-StartWebRTCContact-request-Description"></a>
A description of the task that is shown to an agent in the Contact Control Panel (CCP).  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.  
Required: No

 ** [InstanceId](#API_StartWebRTCContact_RequestSyntax) **   <a name="connect-StartWebRTCContact-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [ParticipantDetails](#API_StartWebRTCContact_RequestSyntax) **   <a name="connect-StartWebRTCContact-request-ParticipantDetails"></a>
The customer's details.  
Type: [ParticipantDetails](API_ParticipantDetails.md) object  
Required: Yes

 ** [References](#API_StartWebRTCContact_RequestSyntax) **   <a name="connect-StartWebRTCContact-request-References"></a>
A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: `URL` \$1 `NUMBER` \$1 `STRING` \$1 `DATE` \$1 `EMAIL`. `ATTACHMENT` is not a supported reference type during task creation.  
Type: String to [Reference](API_Reference.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [RelatedContactId](#API_StartWebRTCContact_RequestSyntax) **   <a name="connect-StartWebRTCContact-request-RelatedContactId"></a>
The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_StartWebRTCContact_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ConnectionData": { 
      "Attendee": { 
         "AttendeeId": "string",
         "JoinToken": "string"
      },
      "Meeting": { 
         "MediaPlacement": { 
            "AudioFallbackUrl": "string",
            "AudioHostUrl": "string",
            "EventIngestionUrl": "string",
            "SignalingUrl": "string",
            "TurnControlUrl": "string"
         },
         "MediaRegion": "string",
         "MeetingFeatures": { 
            "Audio": { 
               "EchoReduction": "string"
            }
         },
         "MeetingId": "string"
      }
   },
   "ContactId": "string",
   "ParticipantId": "string",
   "ParticipantToken": "string"
}
```

## Response Elements
<a name="API_StartWebRTCContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ConnectionData](#API_StartWebRTCContact_ResponseSyntax) **   <a name="connect-StartWebRTCContact-response-ConnectionData"></a>
Information required for the client application (mobile application or website) to connect to the call.  
Type: [ConnectionData](API_ConnectionData.md) object

 ** [ContactId](#API_StartWebRTCContact_ResponseSyntax) **   <a name="connect-StartWebRTCContact-response-ContactId"></a>
The identifier of the contact in this instance of Amazon Connect.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [ParticipantId](#API_StartWebRTCContact_ResponseSyntax) **   <a name="connect-StartWebRTCContact-response-ParticipantId"></a>
The identifier for a contact participant. The `ParticipantId` for a contact participant is the same throughout the contact lifecycle.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [ParticipantToken](#API_StartWebRTCContact_ResponseSyntax) **   <a name="connect-StartWebRTCContact-response-ParticipantToken"></a>
The token used by the contact participant to call the [CreateParticipantConnection](https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html) API. The participant token is valid for the lifetime of a contact participant.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.

## Errors
<a name="API_StartWebRTCContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

## See Also
<a name="API_StartWebRTCContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/StartWebRTCContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/StartWebRTCContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StartWebRTCContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/StartWebRTCContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/StartWebRTCContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/StartWebRTCContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/StartWebRTCContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StartWebRTCContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StartWebRTCContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StartWebRTCContact) 

# StopContact
<a name="API_StopContact"></a>

Ends the specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods:
+ DISCONNECT
+ TRANSFER
+ QUEUE\$1TRANSFER
+ EXTERNAL\$1OUTBOUND
+ MONITOR

Chat and task contacts can be terminated in any state, regardless of initiation method.

## Request Syntax
<a name="API_StopContact_RequestSyntax"></a>

```
POST /contact/stop HTTP/1.1
Content-type: application/json

{
   "ContactId": "string",
   "DisconnectReason": { 
      "Code": "string"
   },
   "InstanceId": "string"
}
```

## URI Request Parameters
<a name="API_StopContact_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StopContact_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ContactId](#API_StopContact_RequestSyntax) **   <a name="connect-StopContact-request-ContactId"></a>
The ID of the contact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [DisconnectReason](#API_StopContact_RequestSyntax) **   <a name="connect-StopContact-request-DisconnectReason"></a>
The reason a contact can be disconnected. Only Amazon Connect outbound campaigns can provide this field. For a list and description of all the possible disconnect reasons by channel (including outbound campaign voice contacts) see DisconnectReason under [ContactTraceRecord](https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord) in the *Amazon Connect Administrator Guide*.   
Type: [DisconnectReason](API_DisconnectReason.md) object  
Required: No

 ** [InstanceId](#API_StopContact_RequestSyntax) **   <a name="connect-StopContact-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Syntax
<a name="API_StopContact_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_StopContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_StopContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** ContactNotFoundException **   
The contact with the specified ID does not exist.    
 ** Message **   
The message.
HTTP Status Code: 410

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidActiveRegionException **   
This exception occurs when an API request is made to a non-active region in an Amazon Connect instance configured with Amazon Connect Global Resiliency. For example, if the active region is US West (Oregon) and a request is made to US East (N. Virginia), the exception will be returned.  
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

## See Also
<a name="API_StopContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/StopContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/StopContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StopContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/StopContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/StopContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/StopContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/StopContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StopContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StopContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StopContact) 

# StopContactMediaProcessing
<a name="API_StopContactMediaProcessing"></a>

 Stops in-flight message processing for an ongoing chat session. 

## Request Syntax
<a name="API_StopContactMediaProcessing_RequestSyntax"></a>

```
POST /contact/stop-contact-media-processing HTTP/1.1
Content-type: application/json

{
   "ContactId": "string",
   "InstanceId": "string"
}
```

## URI Request Parameters
<a name="API_StopContactMediaProcessing_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StopContactMediaProcessing_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ContactId](#API_StopContactMediaProcessing_RequestSyntax) **   <a name="connect-StopContactMediaProcessing-request-ContactId"></a>
 The identifier of the contact.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [InstanceId](#API_StopContactMediaProcessing_RequestSyntax) **   <a name="connect-StopContactMediaProcessing-request-InstanceId"></a>
 The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

## Response Syntax
<a name="API_StopContactMediaProcessing_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_StopContactMediaProcessing_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_StopContactMediaProcessing_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

## See Also
<a name="API_StopContactMediaProcessing_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/StopContactMediaProcessing) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/StopContactMediaProcessing) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StopContactMediaProcessing) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/StopContactMediaProcessing) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/StopContactMediaProcessing) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/StopContactMediaProcessing) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/StopContactMediaProcessing) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StopContactMediaProcessing) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StopContactMediaProcessing) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StopContactMediaProcessing) 

# StopContactRecording
<a name="API_StopContactRecording"></a>

Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.

Only voice recordings are supported at this time.

## Request Syntax
<a name="API_StopContactRecording_RequestSyntax"></a>

```
POST /contact/stop-recording HTTP/1.1
Content-type: application/json

{
   "ContactId": "string",
   "ContactRecordingType": "string",
   "InitialContactId": "string",
   "InstanceId": "string"
}
```

## URI Request Parameters
<a name="API_StopContactRecording_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StopContactRecording_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ContactId](#API_StopContactRecording_RequestSyntax) **   <a name="connect-StopContactRecording-request-ContactId"></a>
The identifier of the contact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [ContactRecordingType](#API_StopContactRecording_RequestSyntax) **   <a name="connect-StopContactRecording-request-ContactRecordingType"></a>
The type of recording being operated on.  
Type: String  
Valid Values: `AGENT | IVR | SCREEN`   
Required: No

 ** [InitialContactId](#API_StopContactRecording_RequestSyntax) **   <a name="connect-StopContactRecording-request-InitialContactId"></a>
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_StopContactRecording_RequestSyntax) **   <a name="connect-StopContactRecording-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Syntax
<a name="API_StopContactRecording_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_StopContactRecording_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_StopContactRecording_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidActiveRegionException **   
This exception occurs when an API request is made to a non-active region in an Amazon Connect instance configured with Amazon Connect Global Resiliency. For example, if the active region is US West (Oregon) and a request is made to US East (N. Virginia), the exception will be returned.  
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

## See Also
<a name="API_StopContactRecording_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/StopContactRecording) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/StopContactRecording) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StopContactRecording) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/StopContactRecording) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/StopContactRecording) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/StopContactRecording) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/StopContactRecording) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StopContactRecording) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StopContactRecording) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StopContactRecording) 

# StopContactStreaming
<a name="API_StopContactStreaming"></a>

 Ends message streaming on a specified contact. To restart message streaming on that contact, call the [StartContactStreaming](https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html) API. 

## Request Syntax
<a name="API_StopContactStreaming_RequestSyntax"></a>

```
POST /contact/stop-streaming HTTP/1.1
Content-type: application/json

{
   "ContactId": "string",
   "InstanceId": "string",
   "StreamingId": "string"
}
```

## URI Request Parameters
<a name="API_StopContactStreaming_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_StopContactStreaming_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ContactId](#API_StopContactStreaming_RequestSyntax) **   <a name="connect-StopContactStreaming-request-ContactId"></a>
The identifier of the contact. This is the identifier of the contact that is associated with the first interaction with the contact center.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_StopContactStreaming_RequestSyntax) **   <a name="connect-StopContactStreaming-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [StreamingId](#API_StopContactStreaming_RequestSyntax) **   <a name="connect-StopContactStreaming-request-StreamingId"></a>
The identifier of the streaming configuration enabled.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Syntax
<a name="API_StopContactStreaming_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_StopContactStreaming_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_StopContactStreaming_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

## See Also
<a name="API_StopContactStreaming_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/StopContactStreaming) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/StopContactStreaming) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StopContactStreaming) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/StopContactStreaming) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/StopContactStreaming) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/StopContactStreaming) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/StopContactStreaming) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StopContactStreaming) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StopContactStreaming) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StopContactStreaming) 

# StopTestCaseExecution
<a name="API_StopTestCaseExecution"></a>

Stops a running test execution.

## Request Syntax
<a name="API_StopTestCaseExecution_RequestSyntax"></a>

```
POST /test-cases/InstanceId/TestCaseId/TestCaseExecutionId/stop-execution HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string"
}
```

## URI Request Parameters
<a name="API_StopTestCaseExecution_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_StopTestCaseExecution_RequestSyntax) **   <a name="connect-StopTestCaseExecution-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [TestCaseExecutionId](#API_StopTestCaseExecution_RequestSyntax) **   <a name="connect-StopTestCaseExecution-request-uri-TestCaseExecutionId"></a>
The identifier of the test case execution to stop.  
Length Constraints: Maximum length of 500.  
Required: Yes

 ** [TestCaseId](#API_StopTestCaseExecution_RequestSyntax) **   <a name="connect-StopTestCaseExecution-request-uri-TestCaseId"></a>
The identifier of the test case.  
Length Constraints: Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_StopTestCaseExecution_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_StopTestCaseExecution_RequestSyntax) **   <a name="connect-StopTestCaseExecution-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

## Response Syntax
<a name="API_StopTestCaseExecution_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_StopTestCaseExecution_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_StopTestCaseExecution_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_StopTestCaseExecution_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/StopTestCaseExecution) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/StopTestCaseExecution) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/StopTestCaseExecution) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/StopTestCaseExecution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/StopTestCaseExecution) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/StopTestCaseExecution) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/StopTestCaseExecution) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/StopTestCaseExecution) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/StopTestCaseExecution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/StopTestCaseExecution) 

# SubmitContactEvaluation
<a name="API_SubmitContactEvaluation"></a>

Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object (`{}`) to the question identifier. 

If a contact evaluation is already in submitted state, this operation will trigger a resubmission.

## Request Syntax
<a name="API_SubmitContactEvaluation_RequestSyntax"></a>

```
POST /contact-evaluations/InstanceId/EvaluationId/submit HTTP/1.1
Content-type: application/json

{
   "Answers": { 
      "string" : { 
         "Value": { ... }
      }
   },
   "Notes": { 
      "string" : { 
         "Value": "string"
      }
   },
   "SubmittedBy": { ... }
}
```

## URI Request Parameters
<a name="API_SubmitContactEvaluation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [EvaluationId](#API_SubmitContactEvaluation_RequestSyntax) **   <a name="connect-SubmitContactEvaluation-request-uri-EvaluationId"></a>
A unique identifier for the contact evaluation.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [InstanceId](#API_SubmitContactEvaluation_RequestSyntax) **   <a name="connect-SubmitContactEvaluation-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_SubmitContactEvaluation_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Answers](#API_SubmitContactEvaluation_RequestSyntax) **   <a name="connect-SubmitContactEvaluation-request-Answers"></a>
A map of question identifiers to answer value.  
Type: String to [EvaluationAnswerInput](API_EvaluationAnswerInput.md) object map  
Map Entries: Maximum number of 100 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: No

 ** [Notes](#API_SubmitContactEvaluation_RequestSyntax) **   <a name="connect-SubmitContactEvaluation-request-Notes"></a>
A map of question identifiers to note value.  
Type: String to [EvaluationNote](API_EvaluationNote.md) object map  
Map Entries: Maximum number of 100 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: No

 ** [SubmittedBy](#API_SubmitContactEvaluation_RequestSyntax) **   <a name="connect-SubmitContactEvaluation-request-SubmittedBy"></a>
The ID of the user who submitted the contact evaluation.  
Type: [EvaluatorUserUnion](API_EvaluatorUserUnion.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## Response Syntax
<a name="API_SubmitContactEvaluation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EvaluationArn": "string",
   "EvaluationId": "string"
}
```

## Response Elements
<a name="API_SubmitContactEvaluation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EvaluationArn](#API_SubmitContactEvaluation_ResponseSyntax) **   <a name="connect-SubmitContactEvaluation-response-EvaluationArn"></a>
The Amazon Resource Name (ARN) for the contact evaluation resource.  
Type: String

 ** [EvaluationId](#API_SubmitContactEvaluation_ResponseSyntax) **   <a name="connect-SubmitContactEvaluation-response-EvaluationId"></a>
A unique identifier for the contact evaluation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_SubmitContactEvaluation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_SubmitContactEvaluation_Examples"></a>

### Example
<a name="API_SubmitContactEvaluation_Example_1"></a>

The following example submits a previously started contact evaluation.

#### Sample Request
<a name="API_SubmitContactEvaluation_Example_1_Request"></a>

```
{
   "InstanceId": "[instance_id]",
   "EvaluationId": "[evaluation_id]"
}
```

#### Sample Response
<a name="API_SubmitContactEvaluation_Example_1_Response"></a>

```
{
   "EvaluationId": "[evaluation_id]",
   "EvaluationArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/contact-evaluation/[evaluation_id]"
}
```

## See Also
<a name="API_SubmitContactEvaluation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SubmitContactEvaluation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SubmitContactEvaluation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SubmitContactEvaluation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SubmitContactEvaluation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SubmitContactEvaluation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SubmitContactEvaluation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SubmitContactEvaluation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SubmitContactEvaluation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SubmitContactEvaluation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SubmitContactEvaluation) 

# SuspendContactRecording
<a name="API_SuspendContactRecording"></a>

When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call (IVR or agent), screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use [ResumeContactRecording](https://docs.aws.amazon.com/connect/latest/APIReference/API_ResumeContactRecording.html) to restart recording the screen.

The period of time that the recording is suspended is filled with silence in the final recording. 

 Voice (IVR, agent) and screen recordings are supported.

## Request Syntax
<a name="API_SuspendContactRecording_RequestSyntax"></a>

```
POST /contact/suspend-recording HTTP/1.1
Content-type: application/json

{
   "ContactId": "string",
   "ContactRecordingType": "string",
   "InitialContactId": "string",
   "InstanceId": "string"
}
```

## URI Request Parameters
<a name="API_SuspendContactRecording_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_SuspendContactRecording_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ContactId](#API_SuspendContactRecording_RequestSyntax) **   <a name="connect-SuspendContactRecording-request-ContactId"></a>
The identifier of the contact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [ContactRecordingType](#API_SuspendContactRecording_RequestSyntax) **   <a name="connect-SuspendContactRecording-request-ContactRecordingType"></a>
The type of recording being operated on.  
Type: String  
Valid Values: `AGENT | IVR | SCREEN`   
Required: No

 ** [InitialContactId](#API_SuspendContactRecording_RequestSyntax) **   <a name="connect-SuspendContactRecording-request-InitialContactId"></a>
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_SuspendContactRecording_RequestSyntax) **   <a name="connect-SuspendContactRecording-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Syntax
<a name="API_SuspendContactRecording_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_SuspendContactRecording_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_SuspendContactRecording_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidActiveRegionException **   
This exception occurs when an API request is made to a non-active region in an Amazon Connect instance configured with Amazon Connect Global Resiliency. For example, if the active region is US West (Oregon) and a request is made to US East (N. Virginia), the exception will be returned.  
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

## See Also
<a name="API_SuspendContactRecording_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/SuspendContactRecording) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/SuspendContactRecording) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/SuspendContactRecording) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/SuspendContactRecording) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/SuspendContactRecording) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/SuspendContactRecording) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/SuspendContactRecording) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/SuspendContactRecording) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/SuspendContactRecording) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/SuspendContactRecording) 

# TagContact
<a name="API_TagContact"></a>

Adds the specified tags to the contact resource. For more information about this API is used, see [Set up granular billing for a detailed view of your Amazon Connect usage](https://docs.aws.amazon.com/connect/latest/adminguide/granular-billing.html). 

## Request Syntax
<a name="API_TagContact_RequestSyntax"></a>

```
POST /contact/tags HTTP/1.1
Content-type: application/json

{
   "ContactId": "string",
   "InstanceId": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_TagContact_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_TagContact_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ContactId](#API_TagContact_RequestSyntax) **   <a name="connect-TagContact-request-ContactId"></a>
The identifier of the contact in this instance of Amazon Connect.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_TagContact_RequestSyntax) **   <a name="connect-TagContact-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [Tags](#API_TagContact_RequestSyntax) **   <a name="connect-TagContact-request-Tags"></a>
The tags to be assigned to the contact resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Authorization is not supported by this tag.
Type: String to string map  
Map Entries: Maximum number of 6 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Required: Yes

## Response Syntax
<a name="API_TagContact_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_TagContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_TagContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidActiveRegionException **   
This exception occurs when an API request is made to a non-active region in an Amazon Connect instance configured with Amazon Connect Global Resiliency. For example, if the active region is US West (Oregon) and a request is made to US East (N. Virginia), the exception will be returned.  
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_TagContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/TagContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/TagContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/TagContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/TagContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/TagContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/TagContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/TagContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/TagContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/TagContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/TagContact) 

# TagResource
<a name="API_TagResource"></a>

Adds the specified tags to the specified resource.

Some of the supported resource types are agents, routing profiles, queues, quick connects, flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see [Tagging resources in Amazon Connect](https://docs.aws.amazon.com/connect/latest/adminguide/tagging.html).

For sample policies that use tags, see [Amazon Connect Identity-Based Policy Examples](https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html) in the *Amazon Connect Administrator Guide*.

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_TagResource_RequestSyntax) **   <a name="connect-TagResource-request-uri-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource.  
Required: Yes

## Request Body
<a name="API_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [tags](#API_TagResource_RequestSyntax) **   <a name="connect-TagResource-request-tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "Tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Value Length Constraints: Maximum length of 256.  
Required: Yes

## Response Syntax
<a name="API_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/TagResource) 

# TransferContact
<a name="API_TransferContact"></a>

Transfers `TASK` or `EMAIL` contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers.

Note the following requirements:
+ Transfer is only supported for `TASK` and `EMAIL` contacts.
+ Do not use both `QueueId` and `UserId` in the same call.
+ The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow.
+ The `TransferContact` API can be called only on active contacts.
+ A contact cannot be transferred more than 11 times.

## Request Syntax
<a name="API_TransferContact_RequestSyntax"></a>

```
POST /contact/transfer HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "ContactFlowId": "string",
   "ContactId": "string",
   "InstanceId": "string",
   "QueueId": "string",
   "UserId": "string"
}
```

## URI Request Parameters
<a name="API_TransferContact_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_TransferContact_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_TransferContact_RequestSyntax) **   <a name="connect-TransferContact-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [ContactFlowId](#API_TransferContact_RequestSyntax) **   <a name="connect-TransferContact-request-ContactFlowId"></a>
The identifier of the flow.  
Type: String  
Length Constraints: Maximum length of 500.  
Required: Yes

 ** [ContactId](#API_TransferContact_RequestSyntax) **   <a name="connect-TransferContact-request-ContactId"></a>
The identifier of the contact in this instance of Amazon Connect.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_TransferContact_RequestSyntax) **   <a name="connect-TransferContact-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [QueueId](#API_TransferContact_RequestSyntax) **   <a name="connect-TransferContact-request-QueueId"></a>
The identifier for the queue.  
Type: String  
Required: No

 ** [UserId](#API_TransferContact_RequestSyntax) **   <a name="connect-TransferContact-request-UserId"></a>
The identifier for the user. This can be the ID or the ARN of the user.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_TransferContact_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ContactArn": "string",
   "ContactId": "string"
}
```

## Response Elements
<a name="API_TransferContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ContactArn](#API_TransferContact_ResponseSyntax) **   <a name="connect-TransferContact-response-ContactArn"></a>
The Amazon Resource Name (ARN) of the contact.  
Type: String

 ** [ContactId](#API_TransferContact_ResponseSyntax) **   <a name="connect-TransferContact-response-ContactId"></a>
The identifier of the contact in this instance of Amazon Connect.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_TransferContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** IdempotencyException **   
An entity with the same name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_TransferContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/TransferContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/TransferContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/TransferContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/TransferContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/TransferContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/TransferContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/TransferContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/TransferContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/TransferContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/TransferContact) 

# UntagContact
<a name="API_UntagContact"></a>

Removes the specified tags from the contact resource. For more information about this API is used, see [Set up granular billing for a detailed view of your Amazon Connect usage](https://docs.aws.amazon.com/connect/latest/adminguide/granular-billing.html).

## Request Syntax
<a name="API_UntagContact_RequestSyntax"></a>

```
DELETE /contact/tags/InstanceId/ContactId?TagKeys=TagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_UntagContact_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactId](#API_UntagContact_RequestSyntax) **   <a name="connect-UntagContact-request-uri-ContactId"></a>
The identifier of the contact in this instance of Amazon Connect.   
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_UntagContact_RequestSyntax) **   <a name="connect-UntagContact-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [TagKeys](#API_UntagContact_RequestSyntax) **   <a name="connect-UntagContact-request-uri-TagKeys"></a>
A list of tag keys. Existing tags on the contact whose keys are members of this list will be removed.  
Array Members: Minimum number of 1 item. Maximum number of 6 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Required: Yes

## Request Body
<a name="API_UntagContact_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_UntagContact_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UntagContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UntagContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidActiveRegionException **   
This exception occurs when an API request is made to a non-active region in an Amazon Connect instance configured with Amazon Connect Global Resiliency. For example, if the active region is US West (Oregon) and a request is made to US East (N. Virginia), the exception will be returned.  
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UntagContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UntagContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UntagContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UntagContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UntagContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UntagContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UntagContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UntagContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UntagContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UntagContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UntagContact) 

# UntagResource
<a name="API_UntagResource"></a>

Removes the specified tags from the specified resource.

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_UntagResource_RequestSyntax) **   <a name="connect-UntagResource-request-uri-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource.  
Required: Yes

 ** [tagKeys](#API_UntagResource_RequestSyntax) **   <a name="connect-UntagResource-request-uri-tagKeys"></a>
The tag keys.  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$`   
Required: Yes

## Request Body
<a name="API_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UntagResource) 

# UpdateAgentStatus
<a name="API_UpdateAgentStatus"></a>

Updates agent status.

## Request Syntax
<a name="API_UpdateAgentStatus_RequestSyntax"></a>

```
POST /agent-status/InstanceId/AgentStatusId HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "DisplayOrder": number,
   "Name": "string",
   "ResetOrderNumber": boolean,
   "State": "string"
}
```

## URI Request Parameters
<a name="API_UpdateAgentStatus_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AgentStatusId](#API_UpdateAgentStatus_RequestSyntax) **   <a name="connect-UpdateAgentStatus-request-uri-AgentStatusId"></a>
The identifier of the agent status.  
Required: Yes

 ** [InstanceId](#API_UpdateAgentStatus_RequestSyntax) **   <a name="connect-UpdateAgentStatus-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdateAgentStatus_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateAgentStatus_RequestSyntax) **   <a name="connect-UpdateAgentStatus-request-Description"></a>
The description of the agent status.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 250.  
Required: No

 ** [DisplayOrder](#API_UpdateAgentStatus_RequestSyntax) **   <a name="connect-UpdateAgentStatus-request-DisplayOrder"></a>
The display order of the agent status.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [Name](#API_UpdateAgentStatus_RequestSyntax) **   <a name="connect-UpdateAgentStatus-request-Name"></a>
The name of the agent status.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Required: No

 ** [ResetOrderNumber](#API_UpdateAgentStatus_RequestSyntax) **   <a name="connect-UpdateAgentStatus-request-ResetOrderNumber"></a>
A number indicating the reset order of the agent status.  
Type: Boolean  
Required: No

 ** [State](#API_UpdateAgentStatus_RequestSyntax) **   <a name="connect-UpdateAgentStatus-request-State"></a>
The state of the agent status.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

## Response Syntax
<a name="API_UpdateAgentStatus_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateAgentStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateAgentStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateAgentStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateAgentStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateAgentStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateAgentStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateAgentStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateAgentStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateAgentStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateAgentStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateAgentStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateAgentStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateAgentStatus) 

# UpdateAuthenticationProfile
<a name="API_UpdateAuthenticationProfile"></a>

This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Support.

Updates the selected authentication profile.

## Request Syntax
<a name="API_UpdateAuthenticationProfile_RequestSyntax"></a>

```
POST /authentication-profiles/InstanceId/AuthenticationProfileId HTTP/1.1
Content-type: application/json

{
   "AllowedIps": [ "string" ],
   "BlockedIps": [ "string" ],
   "Description": "string",
   "Name": "string",
   "PeriodicSessionDuration": number,
   "SessionInactivityDuration": number,
   "SessionInactivityHandlingEnabled": boolean
}
```

## URI Request Parameters
<a name="API_UpdateAuthenticationProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AuthenticationProfileId](#API_UpdateAuthenticationProfile_RequestSyntax) **   <a name="connect-UpdateAuthenticationProfile-request-uri-AuthenticationProfileId"></a>
A unique identifier for the authentication profile.   
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [InstanceId](#API_UpdateAuthenticationProfile_RequestSyntax) **   <a name="connect-UpdateAuthenticationProfile-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdateAuthenticationProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AllowedIps](#API_UpdateAuthenticationProfile_RequestSyntax) **   <a name="connect-UpdateAuthenticationProfile-request-AllowedIps"></a>
A list of IP address range strings that are allowed to access the instance. For more information on how to configure IP addresses, see[Configure session timeouts](https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts) in the *Amazon Connect Administrator Guide*.  
Type: Array of strings  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^[A-Za-z0-9:/]*$`   
Required: No

 ** [BlockedIps](#API_UpdateAuthenticationProfile_RequestSyntax) **   <a name="connect-UpdateAuthenticationProfile-request-BlockedIps"></a>
A list of IP address range strings that are blocked from accessing the instance. For more information on how to configure IP addresses, For more information on how to configure IP addresses, see [Configure IP-based access control](https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac) in the *Amazon Connect Administrator Guide*.   
Type: Array of strings  
Length Constraints: Minimum length of 2. Maximum length of 50.  
Pattern: `^[A-Za-z0-9:/]*$`   
Required: No

 ** [Description](#API_UpdateAuthenticationProfile_RequestSyntax) **   <a name="connect-UpdateAuthenticationProfile-request-Description"></a>
The description for the authentication profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Required: No

 ** [Name](#API_UpdateAuthenticationProfile_RequestSyntax) **   <a name="connect-UpdateAuthenticationProfile-request-Name"></a>
The name for the authentication profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [PeriodicSessionDuration](#API_UpdateAuthenticationProfile_RequestSyntax) **   <a name="connect-UpdateAuthenticationProfile-request-PeriodicSessionDuration"></a>
 *This parameter has been deprecated.*   
The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, For more information on how to configure IP addresses, see [Configure session timeouts](https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts) in the *Amazon Connect Administrator Guide*.   
Type: Integer  
Valid Range: Minimum value of 10. Maximum value of 60.  
Required: No

 ** [SessionInactivityDuration](#API_UpdateAuthenticationProfile_RequestSyntax) **   <a name="connect-UpdateAuthenticationProfile-request-SessionInactivityDuration"></a>
The period, in minutes, before an agent is automatically signed out of the contact center when they go inactive.  
Type: Integer  
Valid Range: Minimum value of 15. Maximum value of 720.  
Required: No

 ** [SessionInactivityHandlingEnabled](#API_UpdateAuthenticationProfile_RequestSyntax) **   <a name="connect-UpdateAuthenticationProfile-request-SessionInactivityHandlingEnabled"></a>
Determines if automatic logout on user inactivity is enabled.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_UpdateAuthenticationProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateAuthenticationProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateAuthenticationProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateAuthenticationProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateAuthenticationProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateAuthenticationProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateAuthenticationProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateAuthenticationProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateAuthenticationProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateAuthenticationProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateAuthenticationProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateAuthenticationProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateAuthenticationProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateAuthenticationProfile) 

# UpdateContact
<a name="API_UpdateContact"></a>

This API is in preview release for Amazon Connect and is subject to change.

Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.

**Important**  
You can add or update user-defined contact information for both ongoing and completed contacts.

## Request Syntax
<a name="API_UpdateContact_RequestSyntax"></a>

```
POST /contacts/InstanceId/ContactId HTTP/1.1
Content-type: application/json

{
   "CustomerEndpoint": { 
      "Address": "string",
      "Type": "string"
   },
   "Description": "string",
   "Name": "string",
   "QueueInfo": { 
      "Id": "string"
   },
   "References": { 
      "string" : { 
         "Arn": "string",
         "Status": "string",
         "StatusReason": "string",
         "Type": "string",
         "Value": "string"
      }
   },
   "SegmentAttributes": { 
      "string" : { 
         "ValueArn": "string",
         "ValueInteger": number,
         "ValueList": [ 
            "SegmentAttributeValue"
         ],
         "ValueMap": { 
            "string" : "SegmentAttributeValue"
         },
         "ValueString": "string"
      }
   },
   "SystemEndpoint": { 
      "Address": "string",
      "Type": "string"
   },
   "UserInfo": { 
      "UserId": "string"
   }
}
```

## URI Request Parameters
<a name="API_UpdateContact_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactId](#API_UpdateContact_RequestSyntax) **   <a name="connect-UpdateContact-request-uri-ContactId"></a>
The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_UpdateContact_RequestSyntax) **   <a name="connect-UpdateContact-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdateContact_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [CustomerEndpoint](#API_UpdateContact_RequestSyntax) **   <a name="connect-UpdateContact-request-CustomerEndpoint"></a>
The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually the end customer's phone number. This value can only be updated for external audio contacts. For more information, see [Amazon Connect Contact Lens integration](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html) in the *Amazon Connect Administrator Guide*.  
Type: [Endpoint](API_Endpoint.md) object  
Required: No

 ** [Description](#API_UpdateContact_RequestSyntax) **   <a name="connect-UpdateContact-request-Description"></a>
The description of the contact.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.  
Required: No

 ** [Name](#API_UpdateContact_RequestSyntax) **   <a name="connect-UpdateContact-request-Name"></a>
The name of the contact.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Required: No

 ** [QueueInfo](#API_UpdateContact_RequestSyntax) **   <a name="connect-UpdateContact-request-QueueInfo"></a>
 Information about the queue associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see [Amazon Connect Contact Lens integration](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html) in the * Amazon Connect Administrator Guide*.  
Type: [QueueInfoInput](API_QueueInfoInput.md) object  
Required: No

 ** [References](#API_UpdateContact_RequestSyntax) **   <a name="connect-UpdateContact-request-References"></a>
Well-formed data on contact, shown to agents on Contact Control Panel (CCP).  
Type: String to [Reference](API_Reference.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [SegmentAttributes](#API_UpdateContact_RequestSyntax) **   <a name="connect-UpdateContact-request-SegmentAttributes"></a>
A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.  
Attribute keys can include only alphanumeric, -, and \$1.  
This field can be used to show channel subtype, such as `connect:Guide`.  
Contact Expiry, and user-defined attributes (String - String) that are defined in predefined attributes, can be updated by using the UpdateContact API.  
Type: String to [SegmentAttributeValue](API_SegmentAttributeValue.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [SystemEndpoint](#API_UpdateContact_RequestSyntax) **   <a name="connect-UpdateContact-request-SystemEndpoint"></a>
External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of the external system such as the contact center. This value can only be updated for external audio contacts. For more information, see [Amazon Connect Contact Lens integration](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html) in the *Amazon Connect Administrator Guide*.  
Type: [Endpoint](API_Endpoint.md) object  
Required: No

 ** [UserInfo](#API_UpdateContact_RequestSyntax) **   <a name="connect-UpdateContact-request-UserInfo"></a>
Information about the agent associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see [Amazon Connect Contact Lens integration](https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html) in the * Amazon Connect Administrator Guide*.  
Type: [UserInfo](API_UserInfo.md) object  
Required: No

## Response Syntax
<a name="API_UpdateContact_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
Operation cannot be performed at this time as there is a conflict with another operation or contact state.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidActiveRegionException **   
This exception occurs when an API request is made to a non-active region in an Amazon Connect instance configured with Amazon Connect Global Resiliency. For example, if the active region is US West (Oregon) and a request is made to US East (N. Virginia), the exception will be returned.  
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateContact) 

# UpdateContactAttributes
<a name="API_UpdateContactAttributes"></a>

Creates or updates user-defined contact attributes associated with the specified contact.

You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or to identify abusive callers.

Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see [Feature specifications](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits) in the *Amazon Connect Administrator Guide*. 

## Request Syntax
<a name="API_UpdateContactAttributes_RequestSyntax"></a>

```
POST /contact/attributes HTTP/1.1
Content-type: application/json

{
   "Attributes": { 
      "string" : "string" 
   },
   "InitialContactId": "string",
   "InstanceId": "string"
}
```

## URI Request Parameters
<a name="API_UpdateContactAttributes_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_UpdateContactAttributes_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Attributes](#API_UpdateContactAttributes_RequestSyntax) **   <a name="connect-UpdateContactAttributes-request-Attributes"></a>
The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.  
You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.  
In the [Set contact attributes](https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html) block, when the attributes for a contact exceed 32 KB, the contact is routed down the Error branch of the flow. As a mitigation, consider the following options:  
+ Remove unnecessary attributes by setting their values to empty.
+ If the attributes are only used in one flow and don't need to be referred to outside of that flow (for example, by a Lambda or another flow), then use flow attributes. This way you aren't needlessly persisting the 32 KB of information from one flow to another. For more information, see [Flow block: Set contact attributes](https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html) in the *Amazon Connect Administrator Guide*. 
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 32767.  
Value Length Constraints: Minimum length of 0. Maximum length of 32767.  
Required: Yes

 ** [InitialContactId](#API_UpdateContactAttributes_RequestSyntax) **   <a name="connect-UpdateContactAttributes-request-InitialContactId"></a>
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_UpdateContactAttributes_RequestSyntax) **   <a name="connect-UpdateContactAttributes-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Syntax
<a name="API_UpdateContactAttributes_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateContactAttributes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateContactAttributes_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidActiveRegionException **   
This exception occurs when an API request is made to a non-active region in an Amazon Connect instance configured with Amazon Connect Global Resiliency. For example, if the active region is US West (Oregon) and a request is made to US East (N. Virginia), the exception will be returned.  
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

## See Also
<a name="API_UpdateContactAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateContactAttributes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateContactAttributes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateContactAttributes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateContactAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateContactAttributes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateContactAttributes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateContactAttributes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateContactAttributes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateContactAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateContactAttributes) 

# UpdateContactEvaluation
<a name="API_UpdateContactEvaluation"></a>

Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object (`{}`) to the question identifier. 

## Request Syntax
<a name="API_UpdateContactEvaluation_RequestSyntax"></a>

```
POST /contact-evaluations/InstanceId/EvaluationId HTTP/1.1
Content-type: application/json

{
   "Answers": { 
      "string" : { 
         "Value": { ... }
      }
   },
   "Notes": { 
      "string" : { 
         "Value": "string"
      }
   },
   "UpdatedBy": { ... }
}
```

## URI Request Parameters
<a name="API_UpdateContactEvaluation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [EvaluationId](#API_UpdateContactEvaluation_RequestSyntax) **   <a name="connect-UpdateContactEvaluation-request-uri-EvaluationId"></a>
A unique identifier for the contact evaluation.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [InstanceId](#API_UpdateContactEvaluation_RequestSyntax) **   <a name="connect-UpdateContactEvaluation-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdateContactEvaluation_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Answers](#API_UpdateContactEvaluation_RequestSyntax) **   <a name="connect-UpdateContactEvaluation-request-Answers"></a>
A map of question identifiers to answer value.  
Type: String to [EvaluationAnswerInput](API_EvaluationAnswerInput.md) object map  
Map Entries: Maximum number of 100 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: No

 ** [Notes](#API_UpdateContactEvaluation_RequestSyntax) **   <a name="connect-UpdateContactEvaluation-request-Notes"></a>
A map of question identifiers to note value.  
Type: String to [EvaluationNote](API_EvaluationNote.md) object map  
Map Entries: Maximum number of 100 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: No

 ** [UpdatedBy](#API_UpdateContactEvaluation_RequestSyntax) **   <a name="connect-UpdateContactEvaluation-request-UpdatedBy"></a>
The ID of the user who updated the contact evaluation.  
Type: [EvaluatorUserUnion](API_EvaluatorUserUnion.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## Response Syntax
<a name="API_UpdateContactEvaluation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EvaluationArn": "string",
   "EvaluationId": "string"
}
```

## Response Elements
<a name="API_UpdateContactEvaluation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EvaluationArn](#API_UpdateContactEvaluation_ResponseSyntax) **   <a name="connect-UpdateContactEvaluation-response-EvaluationArn"></a>
The Amazon Resource Name (ARN) for the contact evaluation resource.  
Type: String

 ** [EvaluationId](#API_UpdateContactEvaluation_ResponseSyntax) **   <a name="connect-UpdateContactEvaluation-response-EvaluationId"></a>
A unique identifier for the contact evaluation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_UpdateContactEvaluation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_UpdateContactEvaluation_Examples"></a>

### Example
<a name="API_UpdateContactEvaluation_Example_1"></a>

The following example updates a previously started contact evaluation.

#### Sample Request
<a name="API_UpdateContactEvaluation_Example_1_Request"></a>

```
{
   "InstanceId": "[instance_id]",
   "EvaluationId": "[evaluation_id]",
   "Answers": {
      "question-1-111": {
         "Value": {
            "StringValue": "question-answer-1-111"
         }
      },
      "question-1-222": {
         "Value": {
            "StringValue": "third-option"
         }
      },
      "question-2-1": {
         "Value": {
            "StringValue": "question-custom-answer-2-1"
         }
      },
      "question-2-222": {
         "Value": {
            "NumericValue": 12
         }
      }
   },
    "Notes": {
      "question-1-111": {
         "Value": "question-1-111 notes"
      },
      "question-2-222": {
         "Value": "question-2-222 notes"
      },
      "section-1": {
         "Value": "section-1 notes"
      },
      "section-2": {
         "Value": "section-2 notes"
      }
   }
}
```

#### Sample Response
<a name="API_UpdateContactEvaluation_Example_1_Response"></a>

```
{
   "EvaluationId": "[evaluation_id]",
   "EvaluationArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/contact-evaluation/[evaluation_id]"
}
```

## See Also
<a name="API_UpdateContactEvaluation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateContactEvaluation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateContactEvaluation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateContactEvaluation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateContactEvaluation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateContactEvaluation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateContactEvaluation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateContactEvaluation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateContactEvaluation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateContactEvaluation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateContactEvaluation) 

# UpdateContactFlowContent
<a name="API_UpdateContactFlowContent"></a>

Updates the specified flow.

You can also create and update flows using the [Amazon Connect Flow language](https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html).

Use the `$SAVED` alias in the request to describe the `SAVED` content of a Flow. For example, `arn:aws:.../contact-flow/{id}:$SAVED`. After a flow is published, `$SAVED` needs to be supplied to view saved content that has not been published.

## Request Syntax
<a name="API_UpdateContactFlowContent_RequestSyntax"></a>

```
POST /contact-flows/InstanceId/ContactFlowId/content HTTP/1.1
Content-type: application/json

{
   "Content": "string"
}
```

## URI Request Parameters
<a name="API_UpdateContactFlowContent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactFlowId](#API_UpdateContactFlowContent_RequestSyntax) **   <a name="connect-UpdateContactFlowContent-request-uri-ContactFlowId"></a>
The identifier of the flow.  
Length Constraints: Maximum length of 500.  
Required: Yes

 ** [InstanceId](#API_UpdateContactFlowContent_RequestSyntax) **   <a name="connect-UpdateContactFlowContent-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdateContactFlowContent_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Content](#API_UpdateContactFlowContent_RequestSyntax) **   <a name="connect-UpdateContactFlowContent-request-Content"></a>
The JSON string that represents the content of the flow. For an example, see [Example flow in Amazon Connect Flow language](https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html).   
Length Constraints: Minimum length of 1. Maximum length of 256000.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_UpdateContactFlowContent_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateContactFlowContent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateContactFlowContent_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidContactFlowException **   
The flow is not valid.    
 ** problems **   
The problems with the flow. Please fix before trying again.
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateContactFlowContent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateContactFlowContent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateContactFlowContent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateContactFlowContent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateContactFlowContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateContactFlowContent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateContactFlowContent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateContactFlowContent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateContactFlowContent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateContactFlowContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateContactFlowContent) 

# UpdateContactFlowMetadata
<a name="API_UpdateContactFlowMetadata"></a>

Updates metadata about specified flow.

## Request Syntax
<a name="API_UpdateContactFlowMetadata_RequestSyntax"></a>

```
POST /contact-flows/InstanceId/ContactFlowId/metadata HTTP/1.1
Content-type: application/json

{
   "ContactFlowState": "string",
   "Description": "string",
   "Name": "string"
}
```

## URI Request Parameters
<a name="API_UpdateContactFlowMetadata_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactFlowId](#API_UpdateContactFlowMetadata_RequestSyntax) **   <a name="connect-UpdateContactFlowMetadata-request-uri-ContactFlowId"></a>
The identifier of the flow.  
Length Constraints: Maximum length of 500.  
Required: Yes

 ** [InstanceId](#API_UpdateContactFlowMetadata_RequestSyntax) **   <a name="connect-UpdateContactFlowMetadata-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdateContactFlowMetadata_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ContactFlowState](#API_UpdateContactFlowMetadata_RequestSyntax) **   <a name="connect-UpdateContactFlowMetadata-request-ContactFlowState"></a>
The state of flow.  
Type: String  
Valid Values: `ACTIVE | ARCHIVED`   
Required: No

 ** [Description](#API_UpdateContactFlowMetadata_RequestSyntax) **   <a name="connect-UpdateContactFlowMetadata-request-Description"></a>
The description of the flow.  
Type: String  
Required: No

 ** [Name](#API_UpdateContactFlowMetadata_RequestSyntax) **   <a name="connect-UpdateContactFlowMetadata-request-Name"></a>
The name of the flow.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

## Response Syntax
<a name="API_UpdateContactFlowMetadata_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateContactFlowMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateContactFlowMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateContactFlowMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateContactFlowMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateContactFlowMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateContactFlowMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateContactFlowMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateContactFlowMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateContactFlowMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateContactFlowMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateContactFlowMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateContactFlowMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateContactFlowMetadata) 

# UpdateContactFlowModuleAlias
<a name="API_UpdateContactFlowModuleAlias"></a>

Updates a specific Aliases metadata, including the version it’s tied to, it’s name, and description.

## Request Syntax
<a name="API_UpdateContactFlowModuleAlias_RequestSyntax"></a>

```
POST /contact-flow-modules/InstanceId/ContactFlowModuleId/alias/AliasId HTTP/1.1
Content-type: application/json

{
   "ContactFlowModuleVersion": number,
   "Description": "string",
   "Name": "string"
}
```

## URI Request Parameters
<a name="API_UpdateContactFlowModuleAlias_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AliasId](#API_UpdateContactFlowModuleAlias_RequestSyntax) **   <a name="connect-UpdateContactFlowModuleAlias-request-uri-AliasId"></a>
The identifier of the alias.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [ContactFlowModuleId](#API_UpdateContactFlowModuleAlias_RequestSyntax) **   <a name="connect-UpdateContactFlowModuleAlias-request-uri-ContactFlowModuleId"></a>
The identifier of the flow module.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_UpdateContactFlowModuleAlias_RequestSyntax) **   <a name="connect-UpdateContactFlowModuleAlias-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

## Request Body
<a name="API_UpdateContactFlowModuleAlias_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ContactFlowModuleVersion](#API_UpdateContactFlowModuleAlias_RequestSyntax) **   <a name="connect-UpdateContactFlowModuleAlias-request-ContactFlowModuleVersion"></a>
The version of the flow module.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

 ** [Description](#API_UpdateContactFlowModuleAlias_RequestSyntax) **   <a name="connect-UpdateContactFlowModuleAlias-request-Description"></a>
The description of the alias.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Pattern: `.*\S.*`   
Required: No

 ** [Name](#API_UpdateContactFlowModuleAlias_RequestSyntax) **   <a name="connect-UpdateContactFlowModuleAlias-request-Name"></a>
The name of the alias.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `.*\S.*`   
Required: No

## Response Syntax
<a name="API_UpdateContactFlowModuleAlias_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateContactFlowModuleAlias_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateContactFlowModuleAlias_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** ConditionalOperationFailedException **   
Request processing failed because dependent condition failed.  
HTTP Status Code: 409

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_UpdateContactFlowModuleAlias_Examples"></a>

### Sample Request
<a name="API_UpdateContactFlowModuleAlias_Example_1"></a>

This example illustrates one usage of UpdateContactFlowModuleAlias.

```
{
  "Name": "production-v2",
  "Description": "Updated production version with new features",
  "ContactFlowModuleVersion": 3
}
```

### Sample Response
<a name="API_UpdateContactFlowModuleAlias_Example_2"></a>

This example illustrates one usage of UpdateContactFlowModuleAlias.

```
HTTP/1.1 200 OK
```

## See Also
<a name="API_UpdateContactFlowModuleAlias_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateContactFlowModuleAlias) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateContactFlowModuleAlias) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateContactFlowModuleAlias) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateContactFlowModuleAlias) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateContactFlowModuleAlias) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateContactFlowModuleAlias) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateContactFlowModuleAlias) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateContactFlowModuleAlias) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateContactFlowModuleAlias) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateContactFlowModuleAlias) 

# UpdateContactFlowModuleContent
<a name="API_UpdateContactFlowModuleContent"></a>

Updates specified flow module for the specified Amazon Connect instance. 

Use the `$SAVED` alias in the request to describe the `SAVED` content of a Flow. For example, `arn:aws:.../contact-flow/{id}:$SAVED`. After a flow is published, `$SAVED` needs to be supplied to view saved content that has not been published.

## Request Syntax
<a name="API_UpdateContactFlowModuleContent_RequestSyntax"></a>

```
POST /contact-flow-modules/InstanceId/ContactFlowModuleId/content HTTP/1.1
Content-type: application/json

{
   "Content": "string",
   "Settings": "string"
}
```

## URI Request Parameters
<a name="API_UpdateContactFlowModuleContent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactFlowModuleId](#API_UpdateContactFlowModuleContent_RequestSyntax) **   <a name="connect-UpdateContactFlowModuleContent-request-uri-ContactFlowModuleId"></a>
The identifier of the flow module.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_UpdateContactFlowModuleContent_RequestSyntax) **   <a name="connect-UpdateContactFlowModuleContent-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdateContactFlowModuleContent_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Content](#API_UpdateContactFlowModuleContent_RequestSyntax) **   <a name="connect-UpdateContactFlowModuleContent-request-Content"></a>
The JSON string that represents the content of the flow. For an example, see [Example flow in Amazon Connect Flow language](https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html).   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256000.  
Required: No

 ** [Settings](#API_UpdateContactFlowModuleContent_RequestSyntax) **   <a name="connect-UpdateContactFlowModuleContent-request-Settings"></a>
Serialized JSON string of the flow module Settings schema.  
Type: String  
Required: No

## Response Syntax
<a name="API_UpdateContactFlowModuleContent_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateContactFlowModuleContent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateContactFlowModuleContent_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidContactFlowModuleException **   
The problems with the module. Please fix before trying again.  
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateContactFlowModuleContent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateContactFlowModuleContent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateContactFlowModuleContent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateContactFlowModuleContent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateContactFlowModuleContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateContactFlowModuleContent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateContactFlowModuleContent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateContactFlowModuleContent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateContactFlowModuleContent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateContactFlowModuleContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateContactFlowModuleContent) 

# UpdateContactFlowModuleMetadata
<a name="API_UpdateContactFlowModuleMetadata"></a>

Updates metadata about specified flow module.

## Request Syntax
<a name="API_UpdateContactFlowModuleMetadata_RequestSyntax"></a>

```
POST /contact-flow-modules/InstanceId/ContactFlowModuleId/metadata HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "State": "string"
}
```

## URI Request Parameters
<a name="API_UpdateContactFlowModuleMetadata_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactFlowModuleId](#API_UpdateContactFlowModuleMetadata_RequestSyntax) **   <a name="connect-UpdateContactFlowModuleMetadata-request-uri-ContactFlowModuleId"></a>
The identifier of the flow module.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_UpdateContactFlowModuleMetadata_RequestSyntax) **   <a name="connect-UpdateContactFlowModuleMetadata-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdateContactFlowModuleMetadata_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateContactFlowModuleMetadata_RequestSyntax) **   <a name="connect-UpdateContactFlowModuleMetadata-request-Description"></a>
The description of the flow module.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Pattern: `.*\S.*`   
Required: No

 ** [Name](#API_UpdateContactFlowModuleMetadata_RequestSyntax) **   <a name="connect-UpdateContactFlowModuleMetadata-request-Name"></a>
The name of the flow module.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `.*\S.*`   
Required: No

 ** [State](#API_UpdateContactFlowModuleMetadata_RequestSyntax) **   <a name="connect-UpdateContactFlowModuleMetadata-request-State"></a>
The state of flow module.  
Type: String  
Valid Values: `ACTIVE | ARCHIVED`   
Required: No

## Response Syntax
<a name="API_UpdateContactFlowModuleMetadata_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateContactFlowModuleMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateContactFlowModuleMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateContactFlowModuleMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateContactFlowModuleMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateContactFlowModuleMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateContactFlowModuleMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateContactFlowModuleMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateContactFlowModuleMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateContactFlowModuleMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateContactFlowModuleMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateContactFlowModuleMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateContactFlowModuleMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateContactFlowModuleMetadata) 

# UpdateContactFlowName
<a name="API_UpdateContactFlowName"></a>

The name of the flow.

You can also create and update flows using the [Amazon Connect Flow language](https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html).

## Request Syntax
<a name="API_UpdateContactFlowName_RequestSyntax"></a>

```
POST /contact-flows/InstanceId/ContactFlowId/name HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string"
}
```

## URI Request Parameters
<a name="API_UpdateContactFlowName_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactFlowId](#API_UpdateContactFlowName_RequestSyntax) **   <a name="connect-UpdateContactFlowName-request-uri-ContactFlowId"></a>
The identifier of the flow.  
Length Constraints: Maximum length of 500.  
Required: Yes

 ** [InstanceId](#API_UpdateContactFlowName_RequestSyntax) **   <a name="connect-UpdateContactFlowName-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdateContactFlowName_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateContactFlowName_RequestSyntax) **   <a name="connect-UpdateContactFlowName-request-Description"></a>
The description of the flow.  
Type: String  
Required: No

 ** [Name](#API_UpdateContactFlowName_RequestSyntax) **   <a name="connect-UpdateContactFlowName-request-Name"></a>
The name of the flow.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

## Response Syntax
<a name="API_UpdateContactFlowName_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateContactFlowName_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateContactFlowName_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateContactFlowName_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateContactFlowName) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateContactFlowName) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateContactFlowName) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateContactFlowName) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateContactFlowName) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateContactFlowName) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateContactFlowName) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateContactFlowName) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateContactFlowName) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateContactFlowName) 

# UpdateContactRoutingData
<a name="API_UpdateContactRoutingData"></a>

Updates routing priority and age on the contact (**QueuePriority** and **QueueTimeAdjustmentInSeconds**). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using [the Set routing priority / age flow block](https://docs.aws.amazon.com/connect/latest/adminguide/change-routing-priority.html).

**Note**  
Either **QueuePriority** or **QueueTimeAdjustmentInSeconds** should be provided within the request body, but not both.

## Request Syntax
<a name="API_UpdateContactRoutingData_RequestSyntax"></a>

```
POST /contacts/InstanceId/ContactId/routing-data HTTP/1.1
Content-type: application/json

{
   "QueuePriority": number,
   "QueueTimeAdjustmentSeconds": number,
   "RoutingCriteria": { 
      "Steps": [ 
         { 
            "Expiry": { 
               "DurationInSeconds": number
            },
            "Expression": { 
               "AndExpression": [ 
                  "Expression"
               ],
               "AttributeCondition": { 
                  "ComparisonOperator": "string",
                  "MatchCriteria": { 
                     "AgentsCriteria": { 
                        "AgentIds": [ "string" ]
                     }
                  },
                  "Name": "string",
                  "ProficiencyLevel": number,
                  "Range": { 
                     "MaxProficiencyLevel": number,
                     "MinProficiencyLevel": number
                  },
                  "Value": "string"
               },
               "NotAttributeCondition": { 
                  "ComparisonOperator": "string",
                  "MatchCriteria": { 
                     "AgentsCriteria": { 
                        "AgentIds": [ "string" ]
                     }
                  },
                  "Name": "string",
                  "ProficiencyLevel": number,
                  "Range": { 
                     "MaxProficiencyLevel": number,
                     "MinProficiencyLevel": number
                  },
                  "Value": "string"
               },
               "OrExpression": [ 
                  "Expression"
               ]
            }
         }
      ]
   }
}
```

## URI Request Parameters
<a name="API_UpdateContactRoutingData_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactId](#API_UpdateContactRoutingData_RequestSyntax) **   <a name="connect-UpdateContactRoutingData-request-uri-ContactId"></a>
The identifier of the contact in this instance of Amazon Connect.   
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_UpdateContactRoutingData_RequestSyntax) **   <a name="connect-UpdateContactRoutingData-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdateContactRoutingData_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [QueuePriority](#API_UpdateContactRoutingData_RequestSyntax) **   <a name="connect-UpdateContactRoutingData-request-QueuePriority"></a>
Priority of the contact in the queue. The default priority for new contacts is 5. You can raise the priority of a contact compared to other contacts in the queue by assigning them a higher priority, such as 1 or 2.  
Type: Long  
Valid Range: Minimum value of 1. Maximum value of 9223372036854775807.  
Required: No

 ** [QueueTimeAdjustmentSeconds](#API_UpdateContactRoutingData_RequestSyntax) **   <a name="connect-UpdateContactRoutingData-request-QueueTimeAdjustmentSeconds"></a>
The number of seconds to add or subtract from the contact's routing age. Contacts are routed to agents on a first-come, first-serve basis. This means that changing their amount of time in queue compared to others also changes their position in queue.  
Type: Integer  
Required: No

 ** [RoutingCriteria](#API_UpdateContactRoutingData_RequestSyntax) **   <a name="connect-UpdateContactRoutingData-request-RoutingCriteria"></a>
Updates the routing criteria on the contact. These properties can be used to change how a contact is routed within the queue.  
Type: [RoutingCriteriaInput](API_RoutingCriteriaInput.md) object  
Required: No

## Response Syntax
<a name="API_UpdateContactRoutingData_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateContactRoutingData_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateContactRoutingData_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidActiveRegionException **   
This exception occurs when an API request is made to a non-active region in an Amazon Connect instance configured with Amazon Connect Global Resiliency. For example, if the active region is US West (Oregon) and a request is made to US East (N. Virginia), the exception will be returned.  
HTTP Status Code: 400

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_UpdateContactRoutingData_Examples"></a>

### Preferred Agent Routing, without Expiry timer
<a name="API_UpdateContactRoutingData_Example_1"></a>

In this example, we are setting a single-step routing criteria on a contact, to specify that this contact can be targeted only to this particular agent. Note that in order to route, the contact must still first be placed into a queue; in order to be offered the contact in their Contact Control Panel, the agent must have that queue in their routing profile and be in an available state for routing. 

Note that in this specific example, there is no expiration timer set for this step. This means that so long as this routing criteria is set on the contact, this contact will not be offered to any other agent. In most scenarios, we would recommend to set an Expiry timer, so that if the agent is not available within some amount of time, you can fallback the contact to any agent in queue, or any agent matching some other condition. See Example 3 for an example showing the Expiry timer.

```
{
    "InstanceId": "5d463351-d515-4241-b8f3-bf78da37770d",
    "ContactId": "44c84896-243d-43bc-ad8c-76fc8baadced",
    "QueueTimeAdjustmentSeconds": 60,
    "RoutingCriteria": {
        "Steps": [{
            "Expression": {
                "AttributeCondition": {
                    "ComparisonOperator": "Match",
                    "MatchCriteria": {
                        "AgentsCriteria": {
                            "AgentIds": ["39bc9666-4d3c-4558-b2ad-9bab4bd48568"]
                        }
                    }
                }
            }
        }
        ]
    }
}
```

### Route only to agents with a specific predefined attribute, without Expiry timer
<a name="API_UpdateContactRoutingData_Example_2"></a>

In this example, we are setting a single-step routing criteria on a contact, to specify that this contact can only be targeted to agents in this queue who have >= 1/5 proficiency level in `Technology:Cloudwatch`.

Note that in this specific example, there is no expiration timer set for this step. This means that so long as this routing criteria is set on the contact, this contact will not be offered to any agent in queue unless they have >= 1/5 proficiency level in `Technology:Cloudwatch`.

Additionally, in this specific example, QueueTimeAdjustmentSeconds was set to 60 for this contact, meaning that this contact will look 60 seconds older than its true age to the routing engine, which may put it closer to the head of the queue relative to other contacts.

```
{
    "InstanceId": "5d463351-d515-4241-b8f3-bf78da37770d",
    "ContactId": "90422764-7f29-4359-943d-d84be5e53642",
    "QueueTimeAdjustmentSeconds": 60,
    "RoutingCriteria": {
        "Steps": [
            {
                "Expression": {
                    "AndExpression": [
                        {
                            "AttributeCondition": {
                                "Name": "Technology",
                                "Value": "Cloudwatch",
                                "ProficiencyLevel": 1,
                                "ComparisonOperator": "NumberGreaterOrEqualTo"
                            }
                        }
                    ]
                }
            }
        ]
    }
}
```

### Route using an OrExpression, with Expiry timer
<a name="API_UpdateContactRoutingData_Example_3"></a>

In this example, we are setting a single-step routing criteria on a contact with an expiry timer and an OR condition. During this step, the contact can target only agents in queue who either have( >= 1/5 proficiency level in `Technology:Cloudwatch`), OR have both (>= 3/5 proficiency level in `Technology:S3` AND >= 1/5 proficiency level in `Technology:DynamoDB`).

Since in this example there is an Expiry set with a DurationInSeconds of 60, if no agents matching the expressions become available to take the contact within 60 seconds, then the step will expire off, and the contact could be offered to any longest available agent in queue.

Additionally, in this specific example, QueueTimeAdjustmentSeconds was set to 60 for this contact, meaning that this contact will look 60 seconds older than its true age to the routing engine, which may put it closer to the head of the queue relative to other contacts.

```
{
    "InstanceId": "5d463351-d515-4241-b8f3-bf78da37770d",
    "ContactId": "90422764-7f29-4359-943d-d84be5e53642",
    "QueueTimeAdjustmentSeconds": 60,
    "RoutingCriteria": {
        "Steps": [
            {   "Expiry" : {
                "DurationInSeconds": 60
            },
                "Expression": {
                    "OrExpression": [
                        {
                            "AndExpression": [
                                {
                                    "AttributeCondition": {
                                        "Name": "Technology",
                                        "Value": "Cloudwatch",
                                        "ProficiencyLevel": 1,
                                        "ComparisonOperator": "NumberGreaterOrEqualTo"
                                    }
                                }
                            ]
                        },
                        {
                            "AndExpression": [
                                {
                                    "AttributeCondition": {
                                        "Name": "Technology",
                                        "Value": "S3",
                                        "ProficiencyLevel": 3,
                                        "ComparisonOperator": "NumberGreaterOrEqualTo"
                                    }
                                },
                                {
                                    "AttributeCondition": {
                                        "Name": "Technology",
                                        "Value": "DynamoDB",
                                        "ProficiencyLevel": 1,
                                        "ComparisonOperator": "NumberGreaterOrEqualTo"
                                    }
                                }
                            ]
                        }
                    ]
                }
            }
        ]
    }
}
```

### Two-step routing criteria
<a name="API_UpdateContactRoutingData_Example_4"></a>

In this example, we are setting a two-step routing criteria. Step 1 restricts this contact so that only the agent matching the specified user ID can be offered the contact, with an expiry of 30 seconds. Note that this agent must be in Available status with the queue the contact is in their Routing Profile in order to be offered the contact. If this agent does not accept the contact within 30 seconds, then the contact will instead be offered to an agent within the queue with at least 5/5 proficiency level in language English.

```
{
    "InstanceId": "5d463351-d515-4241-b8f3-bf78da37770d",
    "ContactId": "90422764-7f29-4359-943d-d84be5e53642",
    "RoutingCriteria": {
        "Steps": [
            {
                "Expression": {
                    "AttributeCondition": {
                        "ComparisonOperator": "Match",
                        "MatchCriteria": {
                            "AgentsCriteria": {
                                "AgentIds": ["39bc9666-4d3c-4558-b2ad-9bab4bd48568"]
                            }
                        }
                    }
                },
                "Expiry": {
                    "DurationInSeconds": 30
                }
            },
            {
                "Expression": {
                    "AttributeCondition": {
                        "Name": "Language",
                        "Value": "English",
                        "ProficiencyLevel": 5,
                        "ComparisonOperator": "NumberGreaterOrEqualTo"
                    }
                }
            }
        ]
    }
}
```

## See Also
<a name="API_UpdateContactRoutingData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateContactRoutingData) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateContactRoutingData) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateContactRoutingData) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateContactRoutingData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateContactRoutingData) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateContactRoutingData) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateContactRoutingData) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateContactRoutingData) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateContactRoutingData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateContactRoutingData) 

# UpdateContactSchedule
<a name="API_UpdateContactSchedule"></a>

Updates the scheduled time of a task contact that is already scheduled.

## Request Syntax
<a name="API_UpdateContactSchedule_RequestSyntax"></a>

```
POST /contact/schedule HTTP/1.1
Content-type: application/json

{
   "ContactId": "string",
   "InstanceId": "string",
   "ScheduledTime": number
}
```

## URI Request Parameters
<a name="API_UpdateContactSchedule_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_UpdateContactSchedule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ContactId](#API_UpdateContactSchedule_RequestSyntax) **   <a name="connect-UpdateContactSchedule-request-ContactId"></a>
The identifier of the contact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_UpdateContactSchedule_RequestSyntax) **   <a name="connect-UpdateContactSchedule-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [ScheduledTime](#API_UpdateContactSchedule_RequestSyntax) **   <a name="connect-UpdateContactSchedule-request-ScheduledTime"></a>
The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future.   
Type: Timestamp  
Required: Yes

## Response Syntax
<a name="API_UpdateContactSchedule_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateContactSchedule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateContactSchedule_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateContactSchedule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateContactSchedule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateContactSchedule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateContactSchedule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateContactSchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateContactSchedule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateContactSchedule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateContactSchedule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateContactSchedule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateContactSchedule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateContactSchedule) 

# UpdateDataTableAttribute
<a name="API_UpdateDataTableAttribute"></a>

Updates all properties for an attribute using all properties from CreateDataTableAttribute. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided. System managed attributes are not mutable by customers. Changing an attribute's validation does not invalidate existing values since validation only runs when values are created or updated.

## Request Syntax
<a name="API_UpdateDataTableAttribute_RequestSyntax"></a>

```
POST /data-tables/InstanceId/DataTableId/attributes/AttributeName HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "Primary": boolean,
   "Validation": { 
      "Enum": { 
         "Strict": boolean,
         "Values": [ "string" ]
      },
      "ExclusiveMaximum": number,
      "ExclusiveMinimum": number,
      "IgnoreCase": boolean,
      "Maximum": number,
      "MaxLength": number,
      "MaxValues": number,
      "Minimum": number,
      "MinLength": number,
      "MinValues": number,
      "MultipleOf": number
   },
   "ValueType": "string"
}
```

## URI Request Parameters
<a name="API_UpdateDataTableAttribute_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AttributeName](#API_UpdateDataTableAttribute_RequestSyntax) **   <a name="connect-UpdateDataTableAttribute-request-uri-AttributeName"></a>
The current name of the attribute to update. Used as an identifier since attribute names can be changed.  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `^[\p{L}\p{Z}\p{N}\-_.:=@'|]+$`   
Required: Yes

 ** [DataTableId](#API_UpdateDataTableAttribute_RequestSyntax) **   <a name="connect-UpdateDataTableAttribute-request-uri-DataTableId"></a>
The unique identifier for the data table. Must also accept the table ARN with or without a version alias.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_UpdateDataTableAttribute_RequestSyntax) **   <a name="connect-UpdateDataTableAttribute-request-uri-InstanceId"></a>
The unique identifier for the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdateDataTableAttribute_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateDataTableAttribute_RequestSyntax) **   <a name="connect-UpdateDataTableAttribute-request-Description"></a>
The updated description for the attribute.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 250.  
Pattern: `^[\\P{C}\r\n\t]+$`   
Required: No

 ** [Name](#API_UpdateDataTableAttribute_RequestSyntax) **   <a name="connect-UpdateDataTableAttribute-request-Name"></a>
The new name for the attribute. Must conform to Connect human readable string specification and be unique within the data table.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `^[\p{L}\p{Z}\p{N}\-_.:=@'|]+$`   
Required: Yes

 ** [Primary](#API_UpdateDataTableAttribute_RequestSyntax) **   <a name="connect-UpdateDataTableAttribute-request-Primary"></a>
Whether the attribute should be treated as a primary key. Converting to primary attribute requires existing values to maintain uniqueness.  
Type: Boolean  
Required: No

 ** [Validation](#API_UpdateDataTableAttribute_RequestSyntax) **   <a name="connect-UpdateDataTableAttribute-request-Validation"></a>
The updated validation rules for the attribute. Changes do not affect existing values until they are modified.  
Type: [Validation](API_Validation.md) object  
Required: No

 ** [ValueType](#API_UpdateDataTableAttribute_RequestSyntax) **   <a name="connect-UpdateDataTableAttribute-request-ValueType"></a>
The updated value type for the attribute. When changing value types, existing values are not deleted but may return default values if incompatible.  
Type: String  
Valid Values: `TEXT | NUMBER | BOOLEAN | TEXT_LIST | NUMBER_LIST`   
Required: Yes

## Response Syntax
<a name="API_UpdateDataTableAttribute_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "LockVersion": { 
      "Attribute": "string",
      "DataTable": "string",
      "PrimaryValues": "string",
      "Value": "string"
   },
   "Name": "string"
}
```

## Response Elements
<a name="API_UpdateDataTableAttribute_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LockVersion](#API_UpdateDataTableAttribute_ResponseSyntax) **   <a name="connect-UpdateDataTableAttribute-response-LockVersion"></a>
The new lock version for the attribute after the update.  
Type: [DataTableLockVersion](API_DataTableLockVersion.md) object

 ** [Name](#API_UpdateDataTableAttribute_ResponseSyntax) **   <a name="connect-UpdateDataTableAttribute-response-Name"></a>
The trimmed name and identifier for the updated attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `^[\p{L}\p{Z}\p{N}\-_.:=@'|]+$` 

## Errors
<a name="API_UpdateDataTableAttribute_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
Operation cannot be performed at this time as there is a conflict with another operation or contact state.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** LimitExceededException **   
The allowed limit for the resource has been exceeded.    
 ** Message **   
The message about the limit.
HTTP Status Code: 429

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateDataTableAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateDataTableAttribute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateDataTableAttribute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateDataTableAttribute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateDataTableAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateDataTableAttribute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateDataTableAttribute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateDataTableAttribute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateDataTableAttribute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateDataTableAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateDataTableAttribute) 

# UpdateDataTableMetadata
<a name="API_UpdateDataTableMetadata"></a>

Updates the metadata properties of a data table. Accepts all fields similar to CreateDataTable, except for fields and tags. There are no other granular update endpoints. It does not act as a patch operation - all properties must be provided or defaults will be used. Fields follow the same requirements as CreateDataTable.

## Request Syntax
<a name="API_UpdateDataTableMetadata_RequestSyntax"></a>

```
POST /data-tables/InstanceId/DataTableId HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "TimeZone": "string",
   "ValueLockLevel": "string"
}
```

## URI Request Parameters
<a name="API_UpdateDataTableMetadata_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DataTableId](#API_UpdateDataTableMetadata_RequestSyntax) **   <a name="connect-UpdateDataTableMetadata-request-uri-DataTableId"></a>
The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If the version is provided as part of the identifier or ARN, the version must be \$1LATEST. Providing any other alias fails with an error.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_UpdateDataTableMetadata_RequestSyntax) **   <a name="connect-UpdateDataTableMetadata-request-uri-InstanceId"></a>
The unique identifier for the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdateDataTableMetadata_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateDataTableMetadata_RequestSyntax) **   <a name="connect-UpdateDataTableMetadata-request-Description"></a>
The updated description for the data table. Must conform to Connect human readable string specification and have 0-250 characters.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 250.  
Pattern: `^[\\P{C}\r\n\t]+$`   
Required: No

 ** [Name](#API_UpdateDataTableMetadata_RequestSyntax) **   <a name="connect-UpdateDataTableMetadata-request-Name"></a>
The updated name for the data table. Must conform to Connect human readable string specification and have 1-127 characters. Must be unique for the instance using case-insensitive comparison.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `^[\p{L}\p{Z}\p{N}\-_.:=@'|]+$`   
Required: Yes

 ** [TimeZone](#API_UpdateDataTableMetadata_RequestSyntax) **   <a name="connect-UpdateDataTableMetadata-request-TimeZone"></a>
The updated IANA timezone identifier to use when resolving time based dynamic values.  
Type: String  
Required: Yes

 ** [ValueLockLevel](#API_UpdateDataTableMetadata_RequestSyntax) **   <a name="connect-UpdateDataTableMetadata-request-ValueLockLevel"></a>
The updated value lock level for the data table. One of DATA\$1TABLE, PRIMARY\$1VALUE, ATTRIBUTE, VALUE, and NONE.  
Type: String  
Valid Values: `NONE | DATA_TABLE | PRIMARY_VALUE | ATTRIBUTE | VALUE`   
Required: Yes

## Response Syntax
<a name="API_UpdateDataTableMetadata_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "LockVersion": { 
      "Attribute": "string",
      "DataTable": "string",
      "PrimaryValues": "string",
      "Value": "string"
   }
}
```

## Response Elements
<a name="API_UpdateDataTableMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LockVersion](#API_UpdateDataTableMetadata_ResponseSyntax) **   <a name="connect-UpdateDataTableMetadata-response-LockVersion"></a>
The new lock version for the data table after the update.  
Type: [DataTableLockVersion](API_DataTableLockVersion.md) object

## Errors
<a name="API_UpdateDataTableMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
Operation cannot be performed at this time as there is a conflict with another operation or contact state.  
HTTP Status Code: 409

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateDataTableMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateDataTableMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateDataTableMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateDataTableMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateDataTableMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateDataTableMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateDataTableMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateDataTableMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateDataTableMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateDataTableMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateDataTableMetadata) 

# UpdateDataTablePrimaryValues
<a name="API_UpdateDataTablePrimaryValues"></a>

Updates the primary values for a record. This operation affects all existing values that are currently associated to the record and its primary values. Users that have restrictions on attributes and/or primary values are not authorized to use this endpoint. The combination of new primary values must be unique within the table.

## Request Syntax
<a name="API_UpdateDataTablePrimaryValues_RequestSyntax"></a>

```
POST /data-tables/InstanceId/DataTableId/values/update-primary HTTP/1.1
Content-type: application/json

{
   "LockVersion": { 
      "Attribute": "string",
      "DataTable": "string",
      "PrimaryValues": "string",
      "Value": "string"
   },
   "NewPrimaryValues": [ 
      { 
         "AttributeName": "string",
         "Value": "string"
      }
   ],
   "PrimaryValues": [ 
      { 
         "AttributeName": "string",
         "Value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateDataTablePrimaryValues_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DataTableId](#API_UpdateDataTablePrimaryValues_RequestSyntax) **   <a name="connect-UpdateDataTablePrimaryValues-request-uri-DataTableId"></a>
The unique identifier for the data table. Must also accept the table ARN with or without a version alias. If the version is provided as part of the identifier or ARN, the version must be one of the two available system managed aliases, \$1SAVED or \$1LATEST.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_UpdateDataTablePrimaryValues_RequestSyntax) **   <a name="connect-UpdateDataTablePrimaryValues-request-uri-InstanceId"></a>
The unique identifier for the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdateDataTablePrimaryValues_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [LockVersion](#API_UpdateDataTablePrimaryValues_RequestSyntax) **   <a name="connect-UpdateDataTablePrimaryValues-request-LockVersion"></a>
The lock version information required for optimistic locking to prevent concurrent modifications.  
Type: [DataTableLockVersion](API_DataTableLockVersion.md) object  
Required: Yes

 ** [NewPrimaryValues](#API_UpdateDataTablePrimaryValues_RequestSyntax) **   <a name="connect-UpdateDataTablePrimaryValues-request-NewPrimaryValues"></a>
The new primary values for the record. Required and must include values for all primary attributes. The combination must be unique within the table.  
Type: Array of [PrimaryValue](API_PrimaryValue.md) objects  
Required: Yes

 ** [PrimaryValues](#API_UpdateDataTablePrimaryValues_RequestSyntax) **   <a name="connect-UpdateDataTablePrimaryValues-request-PrimaryValues"></a>
The current primary values for the record. Required and must include values for all primary attributes. Fails if the table has primary attributes and some primary values are omitted.  
Type: Array of [PrimaryValue](API_PrimaryValue.md) objects  
Required: Yes

## Response Syntax
<a name="API_UpdateDataTablePrimaryValues_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "LockVersion": { 
      "Attribute": "string",
      "DataTable": "string",
      "PrimaryValues": "string",
      "Value": "string"
   }
}
```

## Response Elements
<a name="API_UpdateDataTablePrimaryValues_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [LockVersion](#API_UpdateDataTablePrimaryValues_ResponseSyntax) **   <a name="connect-UpdateDataTablePrimaryValues-response-LockVersion"></a>
The updated lock version information for the data table and affected components after the primary values change.  
Type: [DataTableLockVersion](API_DataTableLockVersion.md) object

## Errors
<a name="API_UpdateDataTablePrimaryValues_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
Operation cannot be performed at this time as there is a conflict with another operation or contact state.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateDataTablePrimaryValues_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateDataTablePrimaryValues) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateDataTablePrimaryValues) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateDataTablePrimaryValues) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateDataTablePrimaryValues) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateDataTablePrimaryValues) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateDataTablePrimaryValues) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateDataTablePrimaryValues) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateDataTablePrimaryValues) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateDataTablePrimaryValues) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateDataTablePrimaryValues) 

# UpdateEmailAddressMetadata
<a name="API_UpdateEmailAddressMetadata"></a>

Updates an email address metadata. For more information about email addresses, see [Create email addresses](https://docs.aws.amazon.com/connect/latest/adminguide/create-email-address1.html) in the Amazon Connect Administrator Guide.

## Request Syntax
<a name="API_UpdateEmailAddressMetadata_RequestSyntax"></a>

```
POST /email-addresses/InstanceId/EmailAddressId HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "Description": "string",
   "DisplayName": "string"
}
```

## URI Request Parameters
<a name="API_UpdateEmailAddressMetadata_RequestParameters"></a>

The request uses the following URI parameters.

 ** [EmailAddressId](#API_UpdateEmailAddressMetadata_RequestSyntax) **   <a name="connect-UpdateEmailAddressMetadata-request-uri-EmailAddressId"></a>
The identifier of the email address.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [InstanceId](#API_UpdateEmailAddressMetadata_RequestSyntax) **   <a name="connect-UpdateEmailAddressMetadata-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdateEmailAddressMetadata_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_UpdateEmailAddressMetadata_RequestSyntax) **   <a name="connect-UpdateEmailAddressMetadata-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [Description](#API_UpdateEmailAddressMetadata_RequestSyntax) **   <a name="connect-UpdateEmailAddressMetadata-request-Description"></a>
The description of the email address.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.  
Required: No

 ** [DisplayName](#API_UpdateEmailAddressMetadata_RequestSyntax) **   <a name="connect-UpdateEmailAddressMetadata-request-DisplayName"></a>
The display name of email address.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_UpdateEmailAddressMetadata_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EmailAddressArn": "string",
   "EmailAddressId": "string"
}
```

## Response Elements
<a name="API_UpdateEmailAddressMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EmailAddressArn](#API_UpdateEmailAddressMetadata_ResponseSyntax) **   <a name="connect-UpdateEmailAddressMetadata-response-EmailAddressArn"></a>
The Amazon Resource Name (ARN) of the email address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [EmailAddressId](#API_UpdateEmailAddressMetadata_ResponseSyntax) **   <a name="connect-UpdateEmailAddressMetadata-response-EmailAddressId"></a>
The identifier of the email address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_UpdateEmailAddressMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** IdempotencyException **   
An entity with the same name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateEmailAddressMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateEmailAddressMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateEmailAddressMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateEmailAddressMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateEmailAddressMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateEmailAddressMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateEmailAddressMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateEmailAddressMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateEmailAddressMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateEmailAddressMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateEmailAddressMetadata) 

# UpdateEvaluationForm
<a name="API_UpdateEvaluationForm"></a>

Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form.

This operation does not support partial updates. Instead it does a full update of evaluation form content.

## Request Syntax
<a name="API_UpdateEvaluationForm_RequestSyntax"></a>

```
PUT /evaluation-forms/InstanceId/EvaluationFormId HTTP/1.1
Content-type: application/json

{
   "AsDraft": boolean,
   "AutoEvaluationConfiguration": { 
      "Enabled": boolean
   },
   "ClientToken": "string",
   "CreateNewVersion": boolean,
   "Description": "string",
   "EvaluationFormVersion": number,
   "Items": [ 
      { ... }
   ],
   "LanguageConfiguration": { 
      "FormLanguage": "string"
   },
   "ReviewConfiguration": { 
      "EligibilityDays": number,
      "ReviewNotificationRecipients": [ 
         { 
            "Type": "string",
            "Value": { 
               "UserId": "string"
            }
         }
      ]
   },
   "ScoringStrategy": { 
      "Mode": "string",
      "Status": "string"
   },
   "TargetConfiguration": { 
      "ContactInteractionType": "string"
   },
   "Title": "string"
}
```

## URI Request Parameters
<a name="API_UpdateEvaluationForm_RequestParameters"></a>

The request uses the following URI parameters.

 ** [EvaluationFormId](#API_UpdateEvaluationForm_RequestSyntax) **   <a name="connect-UpdateEvaluationForm-request-uri-EvaluationFormId"></a>
The unique identifier for the evaluation form.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [InstanceId](#API_UpdateEvaluationForm_RequestSyntax) **   <a name="connect-UpdateEvaluationForm-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdateEvaluationForm_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AsDraft](#API_UpdateEvaluationForm_RequestSyntax) **   <a name="connect-UpdateEvaluationForm-request-AsDraft"></a>
A boolean flag indicating whether to update evaluation form to draft state.  
Type: Boolean  
Required: No

 ** [AutoEvaluationConfiguration](#API_UpdateEvaluationForm_RequestSyntax) **   <a name="connect-UpdateEvaluationForm-request-AutoEvaluationConfiguration"></a>
Whether automated evaluations are enabled.  
Type: [EvaluationFormAutoEvaluationConfiguration](API_EvaluationFormAutoEvaluationConfiguration.md) object  
Required: No

 ** [ClientToken](#API_UpdateEvaluationForm_RequestSyntax) **   <a name="connect-UpdateEvaluationForm-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [CreateNewVersion](#API_UpdateEvaluationForm_RequestSyntax) **   <a name="connect-UpdateEvaluationForm-request-CreateNewVersion"></a>
A flag indicating whether the operation must create a new version.  
Type: Boolean  
Required: No

 ** [Description](#API_UpdateEvaluationForm_RequestSyntax) **   <a name="connect-UpdateEvaluationForm-request-Description"></a>
The description of the evaluation form.  
Type: String  
Required: No

 ** [EvaluationFormVersion](#API_UpdateEvaluationForm_RequestSyntax) **   <a name="connect-UpdateEvaluationForm-request-EvaluationFormVersion"></a>
A version of the evaluation form to update.  
Type: Integer  
Required: Yes

 ** [Items](#API_UpdateEvaluationForm_RequestSyntax) **   <a name="connect-UpdateEvaluationForm-request-Items"></a>
Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.  
Type: Array of [EvaluationFormItem](API_EvaluationFormItem.md) objects  
Required: Yes

 ** [LanguageConfiguration](#API_UpdateEvaluationForm_RequestSyntax) **   <a name="connect-UpdateEvaluationForm-request-LanguageConfiguration"></a>
Configuration for language settings of the evaluation form.  
Type: [EvaluationFormLanguageConfiguration](API_EvaluationFormLanguageConfiguration.md) object  
Required: No

 ** [ReviewConfiguration](#API_UpdateEvaluationForm_RequestSyntax) **   <a name="connect-UpdateEvaluationForm-request-ReviewConfiguration"></a>
Configuration for evaluation review settings of the evaluation form.  
Type: [EvaluationReviewConfiguration](API_EvaluationReviewConfiguration.md) object  
Required: No

 ** [ScoringStrategy](#API_UpdateEvaluationForm_RequestSyntax) **   <a name="connect-UpdateEvaluationForm-request-ScoringStrategy"></a>
A scoring strategy of the evaluation form.  
Type: [EvaluationFormScoringStrategy](API_EvaluationFormScoringStrategy.md) object  
Required: No

 ** [TargetConfiguration](#API_UpdateEvaluationForm_RequestSyntax) **   <a name="connect-UpdateEvaluationForm-request-TargetConfiguration"></a>
Configuration that specifies the target for the evaluation form.  
Type: [EvaluationFormTargetConfiguration](API_EvaluationFormTargetConfiguration.md) object  
Required: No

 ** [Title](#API_UpdateEvaluationForm_RequestSyntax) **   <a name="connect-UpdateEvaluationForm-request-Title"></a>
A title of the evaluation form.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_UpdateEvaluationForm_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EvaluationFormArn": "string",
   "EvaluationFormId": "string",
   "EvaluationFormVersion": number
}
```

## Response Elements
<a name="API_UpdateEvaluationForm_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EvaluationFormArn](#API_UpdateEvaluationForm_ResponseSyntax) **   <a name="connect-UpdateEvaluationForm-response-EvaluationFormArn"></a>
The Amazon Resource Name (ARN) for the contact evaluation resource.  
Type: String

 ** [EvaluationFormId](#API_UpdateEvaluationForm_ResponseSyntax) **   <a name="connect-UpdateEvaluationForm-response-EvaluationFormId"></a>
The unique identifier for the evaluation form.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [EvaluationFormVersion](#API_UpdateEvaluationForm_ResponseSyntax) **   <a name="connect-UpdateEvaluationForm-response-EvaluationFormVersion"></a>
The version of the updated evaluation form resource.  
Type: Integer

## Errors
<a name="API_UpdateEvaluationForm_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_UpdateEvaluationForm_Examples"></a>

### Example
<a name="API_UpdateEvaluationForm_Example_1"></a>

The following example updates version 2 of an evaluation form. This results in another, new version.

#### Sample Request
<a name="API_UpdateEvaluationForm_Example_1_Request"></a>

```
{
   "InstanceId": "[instance_id]",
   "EvaluationFormId": "[evaluation_form_id]",
   "EvaluationFormVersion": 2,
   "CreateNewVersion": true,
   "Title": "form-title",
   "Description": "form-description",
   "ScoringStrategy": {
      "Mode": "SECTION_ONLY",
      "Status": "ENABLED"
   },
   "Items": [
      {
         "Section": {
            "Title": "section-title-1",
            "RefId": "section-1",
            "Instructions": "section-instruction-1",
            "Weight": 50,
            "Items": [
               {
                  "Question": {
                     "Title": "question-title-11",
                     "RefId": "question-1-111",
                     "Instructions": "question-instructions",
                     "NotApplicableEnabled": false,
                     "QuestionType": "TEXT"
                  }
               },
               {
                  "Question": {
                     "Title": "question-title-12",
                     "RefId": "question-1-222",
                     "QuestionType": "SINGLESELECT",
                     "NotApplicableEnabled": false,
                     "QuestionTypeProperties": {
                        "SingleSelect": {
                           "Options": [
                              {
                                 "RefId": "option-1-2-1",
                                 "Text": "first-option",
                                 "Score": 1,
                                 "AutomaticFail": true
                              },
                              {
                                 "RefId": "option-1-2-2",
                                 "Text": "second-option",
                                 "Score": 1,
                                 "AutomaticFail": false
                              },
                              {
                                 "RefId": "option-1-2-3",
                                 "Text": "third-option",
                                 "Score": 1,
                                 "AutomaticFail": true
                              }
                           ],
                           "DisplayAs": "DROPDOWN",
                           "Automation": {
                              "Options": [
                                 {
                                    "RuleCategory": {
                                       "Category": "CATEGORY_LABEL",
                                       "Condition": "PRESENT",
                                       "OptionRefId": "option-1-2-2"
                                    }
                                 }
                              ],
                              "DefaultOptionRefId": "option-1-2-1"
                           }
                        }
                     }
                  }
               }
            ]
         }
      },
      {
         "Section": {
            "Title": "section-title-2",
            "RefId": "section-2",
            "Instructions": "section-instruction-2",
            "Weight": 50,
            "Items": [
               {
                  "Question": {
                     "Title": "question-title-21",
                     "RefId": "question-2-1",
                     "QuestionType": "TEXT",
                     "NotApplicableEnabled": true
                  }
               },
               {
                  "Question": {
                     "Title": "question-title-2-2",
                     "RefId": "question-2-222",
                     "QuestionType": "NUMERIC",
                     "QuestionTypeProperties": {
                        "Numeric": {
                           "MinValue": 0,
                           "MaxValue": 28800,
                           "Options": [
                              {
                                 "MinValue": 0,
                                 "MaxValue": 28800,
                                 "Score": 1,
                                 "AutomaticFail": false
                              }
                           ],
                           "Automation": {
                              "PropertyValue": {
                                 "Label": "AGENT_INTERACTION_DURATION"
                              }
                           }
                        }
                     }
                  }
               }
            ]
         }
      }
   ]
}
```

#### Sample Response
<a name="API_UpdateEvaluationForm_Example_1_Response"></a>

```
{
   "EvaluationFormId": "[evaluation_form_id]",
   "EvaluationFormArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/evaluation-form/[evaluation_form_id]",
   "EvaluationFormVersion": 2
}
```

## See Also
<a name="API_UpdateEvaluationForm_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateEvaluationForm) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateEvaluationForm) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateEvaluationForm) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateEvaluationForm) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateEvaluationForm) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateEvaluationForm) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateEvaluationForm) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateEvaluationForm) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateEvaluationForm) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateEvaluationForm) 

# UpdateHoursOfOperation
<a name="API_UpdateHoursOfOperation"></a>

Updates the hours of operation.

## Request Syntax
<a name="API_UpdateHoursOfOperation_RequestSyntax"></a>

```
POST /hours-of-operations/InstanceId/HoursOfOperationId HTTP/1.1
Content-type: application/json

{
   "Config": [ 
      { 
         "Day": "string",
         "EndTime": { 
            "Hours": number,
            "Minutes": number
         },
         "StartTime": { 
            "Hours": number,
            "Minutes": number
         }
      }
   ],
   "Description": "string",
   "Name": "string",
   "TimeZone": "string"
}
```

## URI Request Parameters
<a name="API_UpdateHoursOfOperation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [HoursOfOperationId](#API_UpdateHoursOfOperation_RequestSyntax) **   <a name="connect-UpdateHoursOfOperation-request-uri-HoursOfOperationId"></a>
The identifier of the hours of operation.  
Required: Yes

 ** [InstanceId](#API_UpdateHoursOfOperation_RequestSyntax) **   <a name="connect-UpdateHoursOfOperation-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdateHoursOfOperation_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Config](#API_UpdateHoursOfOperation_RequestSyntax) **   <a name="connect-UpdateHoursOfOperation-request-Config"></a>
Configuration information of the hours of operation.  
Type: Array of [HoursOfOperationConfig](API_HoursOfOperationConfig.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Required: No

 ** [Description](#API_UpdateHoursOfOperation_RequestSyntax) **   <a name="connect-UpdateHoursOfOperation-request-Description"></a>
The description of the hours of operation.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 250.  
Required: No

 ** [Name](#API_UpdateHoursOfOperation_RequestSyntax) **   <a name="connect-UpdateHoursOfOperation-request-Name"></a>
The name of the hours of operation.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Required: No

 ** [TimeZone](#API_UpdateHoursOfOperation_RequestSyntax) **   <a name="connect-UpdateHoursOfOperation-request-TimeZone"></a>
The time zone of the hours of operation.  
Type: String  
Required: No

## Response Syntax
<a name="API_UpdateHoursOfOperation_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateHoursOfOperation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateHoursOfOperation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateHoursOfOperation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateHoursOfOperation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateHoursOfOperation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateHoursOfOperation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateHoursOfOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateHoursOfOperation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateHoursOfOperation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateHoursOfOperation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateHoursOfOperation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateHoursOfOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateHoursOfOperation) 

# UpdateHoursOfOperationOverride
<a name="API_UpdateHoursOfOperationOverride"></a>

Update the hours of operation override.

## Request Syntax
<a name="API_UpdateHoursOfOperationOverride_RequestSyntax"></a>

```
POST /hours-of-operations/InstanceId/HoursOfOperationId/overrides/HoursOfOperationOverrideId HTTP/1.1
Content-type: application/json

{
   "Config": [ 
      { 
         "Day": "string",
         "EndTime": { 
            "Hours": number,
            "Minutes": number
         },
         "StartTime": { 
            "Hours": number,
            "Minutes": number
         }
      }
   ],
   "Description": "string",
   "EffectiveFrom": "string",
   "EffectiveTill": "string",
   "Name": "string",
   "OverrideType": "string",
   "RecurrenceConfig": { 
      "RecurrencePattern": { 
         "ByMonth": [ number ],
         "ByMonthDay": [ number ],
         "ByWeekdayOccurrence": [ number ],
         "Frequency": "string",
         "Interval": number
      }
   }
}
```

## URI Request Parameters
<a name="API_UpdateHoursOfOperationOverride_RequestParameters"></a>

The request uses the following URI parameters.

 ** [HoursOfOperationId](#API_UpdateHoursOfOperationOverride_RequestSyntax) **   <a name="connect-UpdateHoursOfOperationOverride-request-uri-HoursOfOperationId"></a>
The identifier for the hours of operation.  
Required: Yes

 ** [HoursOfOperationOverrideId](#API_UpdateHoursOfOperationOverride_RequestSyntax) **   <a name="connect-UpdateHoursOfOperationOverride-request-uri-HoursOfOperationOverrideId"></a>
The identifier for the hours of operation override.  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Required: Yes

 ** [InstanceId](#API_UpdateHoursOfOperationOverride_RequestSyntax) **   <a name="connect-UpdateHoursOfOperationOverride-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdateHoursOfOperationOverride_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Config](#API_UpdateHoursOfOperationOverride_RequestSyntax) **   <a name="connect-UpdateHoursOfOperationOverride-request-Config"></a>
Configuration information for the hours of operation override: day, start time, and end time.  
Type: Array of [HoursOfOperationOverrideConfig](API_HoursOfOperationOverrideConfig.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Required: No

 ** [Description](#API_UpdateHoursOfOperationOverride_RequestSyntax) **   <a name="connect-UpdateHoursOfOperationOverride-request-Description"></a>
The description of the hours of operation override.  
Type: String  
Pattern: `^[\P{C}\r\n\t]{1,250}$`   
Required: No

 ** [EffectiveFrom](#API_UpdateHoursOfOperationOverride_RequestSyntax) **   <a name="connect-UpdateHoursOfOperationOverride-request-EffectiveFrom"></a>
The date from when the hours of operation override would be effective.  
Type: String  
Pattern: `^\d{4}-\d{2}-\d{2}$`   
Required: No

 ** [EffectiveTill](#API_UpdateHoursOfOperationOverride_RequestSyntax) **   <a name="connect-UpdateHoursOfOperationOverride-request-EffectiveTill"></a>
The date until the hours of operation override is effective.  
Type: String  
Pattern: `^\d{4}-\d{2}-\d{2}$`   
Required: No

 ** [Name](#API_UpdateHoursOfOperationOverride_RequestSyntax) **   <a name="connect-UpdateHoursOfOperationOverride-request-Name"></a>
The name of the hours of operation override.  
Type: String  
Pattern: `^[\P{C}\r\n\t]{1,127}$`   
Required: No

 ** [OverrideType](#API_UpdateHoursOfOperationOverride_RequestSyntax) **   <a name="connect-UpdateHoursOfOperationOverride-request-OverrideType"></a>
Whether the override will be defined as a *standard* or as a *recurring event*.  
For more information about how override types are applied, see [Build your list of overrides](https://docs.aws.amazon.com/https:/docs.aws.amazon.com/connect/latest/adminguide/hours-of-operation-overrides.html) in the * Administrator Guide*.  
Type: String  
Valid Values: `STANDARD | OPEN | CLOSED`   
Required: No

 ** [RecurrenceConfig](#API_UpdateHoursOfOperationOverride_RequestSyntax) **   <a name="connect-UpdateHoursOfOperationOverride-request-RecurrenceConfig"></a>
Configuration for a recurring event.  
Type: [RecurrenceConfig](API_RecurrenceConfig.md) object  
Required: No

## Response Syntax
<a name="API_UpdateHoursOfOperationOverride_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateHoursOfOperationOverride_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateHoursOfOperationOverride_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** ConditionalOperationFailedException **   
Request processing failed because dependent condition failed.  
HTTP Status Code: 409

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateHoursOfOperationOverride_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateHoursOfOperationOverride) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateHoursOfOperationOverride) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateHoursOfOperationOverride) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateHoursOfOperationOverride) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateHoursOfOperationOverride) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateHoursOfOperationOverride) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateHoursOfOperationOverride) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateHoursOfOperationOverride) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateHoursOfOperationOverride) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateHoursOfOperationOverride) 

# UpdateInstanceAttribute
<a name="API_UpdateInstanceAttribute"></a>

This API is in preview release for Amazon Connect and is subject to change.

Updates the value for the specified attribute type.

## Request Syntax
<a name="API_UpdateInstanceAttribute_RequestSyntax"></a>

```
POST /instance/InstanceId/attribute/AttributeType HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "Value": "string"
}
```

## URI Request Parameters
<a name="API_UpdateInstanceAttribute_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AttributeType](#API_UpdateInstanceAttribute_RequestSyntax) **   <a name="connect-UpdateInstanceAttribute-request-uri-AttributeType"></a>
The type of attribute.  
Only allowlisted customers can consume USE\$1CUSTOM\$1TTS\$1VOICES. To access this feature, contact AWS Support for allowlisting.
If you set the attribute type as `MESSAGE_STREAMING`, you need to update the Lex bot alias resource based policy to include the `lex:RecognizeMessageAsync` action for the connect instance ARN resource.
Valid Values: `INBOUND_CALLS | OUTBOUND_CALLS | CONTACTFLOW_LOGS | CONTACT_LENS | AUTO_RESOLVE_BEST_VOICES | USE_CUSTOM_TTS_VOICES | EARLY_MEDIA | MULTI_PARTY_CONFERENCE | HIGH_VOLUME_OUTBOUND | ENHANCED_CONTACT_MONITORING | ENHANCED_CHAT_MONITORING | MULTI_PARTY_CHAT_CONFERENCE | MESSAGE_STREAMING`   
Required: Yes

 ** [InstanceId](#API_UpdateInstanceAttribute_RequestSyntax) **   <a name="connect-UpdateInstanceAttribute-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdateInstanceAttribute_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_UpdateInstanceAttribute_RequestSyntax) **   <a name="connect-UpdateInstanceAttribute-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [Value](#API_UpdateInstanceAttribute_RequestSyntax) **   <a name="connect-UpdateInstanceAttribute-request-Value"></a>
The value for the attribute. Maximum character limit is 100.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Syntax
<a name="API_UpdateInstanceAttribute_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateInstanceAttribute_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateInstanceAttribute_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateInstanceAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateInstanceAttribute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateInstanceAttribute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateInstanceAttribute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateInstanceAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateInstanceAttribute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateInstanceAttribute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateInstanceAttribute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateInstanceAttribute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateInstanceAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateInstanceAttribute) 

# UpdateInstanceStorageConfig
<a name="API_UpdateInstanceStorageConfig"></a>

This API is in preview release for Amazon Connect and is subject to change.

Updates an existing configuration for a resource type. This API is idempotent.

## Request Syntax
<a name="API_UpdateInstanceStorageConfig_RequestSyntax"></a>

```
POST /instance/InstanceId/storage-config/AssociationId?resourceType=ResourceType HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "StorageConfig": { 
      "AssociationId": "string",
      "KinesisFirehoseConfig": { 
         "FirehoseArn": "string"
      },
      "KinesisStreamConfig": { 
         "StreamArn": "string"
      },
      "KinesisVideoStreamConfig": { 
         "EncryptionConfig": { 
            "EncryptionType": "string",
            "KeyId": "string"
         },
         "Prefix": "string",
         "RetentionPeriodHours": number
      },
      "S3Config": { 
         "BucketName": "string",
         "BucketPrefix": "string",
         "EncryptionConfig": { 
            "EncryptionType": "string",
            "KeyId": "string"
         }
      },
      "StorageType": "string"
   }
}
```

## URI Request Parameters
<a name="API_UpdateInstanceStorageConfig_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AssociationId](#API_UpdateInstanceStorageConfig_RequestSyntax) **   <a name="connect-UpdateInstanceStorageConfig-request-uri-AssociationId"></a>
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [InstanceId](#API_UpdateInstanceStorageConfig_RequestSyntax) **   <a name="connect-UpdateInstanceStorageConfig-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [ResourceType](#API_UpdateInstanceStorageConfig_RequestSyntax) **   <a name="connect-UpdateInstanceStorageConfig-request-uri-ResourceType"></a>
A valid resource type.  
Valid Values: `CHAT_TRANSCRIPTS | CALL_RECORDINGS | SCHEDULED_REPORTS | MEDIA_STREAMS | CONTACT_TRACE_RECORDS | AGENT_EVENTS | REAL_TIME_CONTACT_ANALYSIS_SEGMENTS | ATTACHMENTS | CONTACT_EVALUATIONS | SCREEN_RECORDINGS | REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS | REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS | EMAIL_MESSAGES`   
Required: Yes

## Request Body
<a name="API_UpdateInstanceStorageConfig_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_UpdateInstanceStorageConfig_RequestSyntax) **   <a name="connect-UpdateInstanceStorageConfig-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [StorageConfig](#API_UpdateInstanceStorageConfig_RequestSyntax) **   <a name="connect-UpdateInstanceStorageConfig-request-StorageConfig"></a>
The storage configuration for the instance.  
Type: [InstanceStorageConfig](API_InstanceStorageConfig.md) object  
Required: Yes

## Response Syntax
<a name="API_UpdateInstanceStorageConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateInstanceStorageConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateInstanceStorageConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateInstanceStorageConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateInstanceStorageConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateInstanceStorageConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateInstanceStorageConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateInstanceStorageConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateInstanceStorageConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateInstanceStorageConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateInstanceStorageConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateInstanceStorageConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateInstanceStorageConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateInstanceStorageConfig) 

# UpdateNotificationContent
<a name="API_UpdateNotificationContent"></a>

Updates the localized content of an existing notification. This operation applies to all users for whom the notification was sent.

## Request Syntax
<a name="API_UpdateNotificationContent_RequestSyntax"></a>

```
POST /notifications/InstanceId/NotificationId HTTP/1.1
Content-type: application/json

{
   "Content": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_UpdateNotificationContent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateNotificationContent_RequestSyntax) **   <a name="connect-UpdateNotificationContent-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [NotificationId](#API_UpdateNotificationContent_RequestSyntax) **   <a name="connect-UpdateNotificationContent-request-uri-NotificationId"></a>
The unique identifier for the notification to update.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_UpdateNotificationContent_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Content](#API_UpdateNotificationContent_RequestSyntax) **   <a name="connect-UpdateNotificationContent-request-Content"></a>
The updated localized content of the notification. A map of locale codes and values. Maximum 500 characters per locale.  
Type: String to string map  
Valid Keys: `en_US | de_DE | es_ES | fr_FR | id_ID | it_IT | ja_JP | ko_KR | pt_BR | zh_CN | zh_TW`   
Value Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_UpdateNotificationContent_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateNotificationContent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateNotificationContent_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateNotificationContent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateNotificationContent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateNotificationContent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateNotificationContent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateNotificationContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateNotificationContent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateNotificationContent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateNotificationContent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateNotificationContent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateNotificationContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateNotificationContent) 

# UpdateParticipantAuthentication
<a name="API_UpdateParticipantAuthentication"></a>

Instructs Amazon Connect to resume the authentication process. The subsequent actions depend on the request body contents:
+  **If a code is provided**: Connect retrieves the identity information from Amazon Cognito and imports it into Connect Customer Profiles.
+  **If an error is provided**: The error branch of the Authenticate Customer block is executed.

**Note**  
The API returns a success response to acknowledge the request. However, the interaction and exchange of identity information occur asynchronously after the response is returned.

## Request Syntax
<a name="API_UpdateParticipantAuthentication_RequestSyntax"></a>

```
POST /contact/update-participant-authentication HTTP/1.1
Content-type: application/json

{
   "Code": "string",
   "Error": "string",
   "ErrorDescription": "string",
   "InstanceId": "string",
   "State": "string"
}
```

## URI Request Parameters
<a name="API_UpdateParticipantAuthentication_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_UpdateParticipantAuthentication_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Code](#API_UpdateParticipantAuthentication_RequestSyntax) **   <a name="connect-UpdateParticipantAuthentication-request-Code"></a>
The `code` query parameter provided by Cognito in the `redirectUri`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [Error](#API_UpdateParticipantAuthentication_RequestSyntax) **   <a name="connect-UpdateParticipantAuthentication-request-Error"></a>
The `error` query parameter provided by Cognito in the `redirectUri`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[\x20-\x21\x23-\x5B\x5D-\x7E]*$`   
Required: No

 ** [ErrorDescription](#API_UpdateParticipantAuthentication_RequestSyntax) **   <a name="connect-UpdateParticipantAuthentication-request-ErrorDescription"></a>
The `error_description` parameter provided by Cognito in the `redirectUri`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[\x20-\x21\x23-\x5B\x5D-\x7E]*$`   
Required: No

 ** [InstanceId](#API_UpdateParticipantAuthentication_RequestSyntax) **   <a name="connect-UpdateParticipantAuthentication-request-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [State](#API_UpdateParticipantAuthentication_RequestSyntax) **   <a name="connect-UpdateParticipantAuthentication-request-State"></a>
The `state` query parameter that was provided by Cognito in the `redirectUri`. This will also match the `state` parameter provided in the `AuthenticationUrl` from the [GetAuthenticationUrl](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetAuthenticationUrl.html) response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

## Response Syntax
<a name="API_UpdateParticipantAuthentication_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateParticipantAuthentication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateParticipantAuthentication_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
Operation cannot be performed at this time as there is a conflict with another operation or contact state.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateParticipantAuthentication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateParticipantAuthentication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateParticipantAuthentication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateParticipantAuthentication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateParticipantAuthentication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateParticipantAuthentication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateParticipantAuthentication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateParticipantAuthentication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateParticipantAuthentication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateParticipantAuthentication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateParticipantAuthentication) 

# UpdateParticipantRoleConfig
<a name="API_UpdateParticipantRoleConfig"></a>

Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:
+ Customer idle timeout
+ Customer auto-disconnect timeout
+ Agent idle timeout
+ Agent auto-disconnect timeout

For more information about how chat timeouts work, see [Set up chat timeouts for human participants](https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html). 

## Request Syntax
<a name="API_UpdateParticipantRoleConfig_RequestSyntax"></a>

```
PUT /contact/participant-role-config/InstanceId/ContactId HTTP/1.1
Content-type: application/json

{
   "ChannelConfiguration": { ... }
}
```

## URI Request Parameters
<a name="API_UpdateParticipantRoleConfig_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ContactId](#API_UpdateParticipantRoleConfig_RequestSyntax) **   <a name="connect-UpdateParticipantRoleConfig-request-uri-ContactId"></a>
The identifier of the contact in this instance of Amazon Connect.   
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [InstanceId](#API_UpdateParticipantRoleConfig_RequestSyntax) **   <a name="connect-UpdateParticipantRoleConfig-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdateParticipantRoleConfig_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ChannelConfiguration](#API_UpdateParticipantRoleConfig_RequestSyntax) **   <a name="connect-UpdateParticipantRoleConfig-request-ChannelConfiguration"></a>
The Amazon Connect channel you want to configure.  
Type: [UpdateParticipantRoleConfigChannelInfo](API_UpdateParticipantRoleConfigChannelInfo.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## Response Syntax
<a name="API_UpdateParticipantRoleConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateParticipantRoleConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateParticipantRoleConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateParticipantRoleConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateParticipantRoleConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateParticipantRoleConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateParticipantRoleConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateParticipantRoleConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateParticipantRoleConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateParticipantRoleConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateParticipantRoleConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateParticipantRoleConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateParticipantRoleConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateParticipantRoleConfig) 

# UpdatePhoneNumber
<a name="API_UpdatePhoneNumber"></a>

Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same AWS Region.

**Important**  
After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too.  
You can call [DescribePhoneNumber](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html) API to verify the status of a previous [UpdatePhoneNumber](https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html) operation.

## Request Syntax
<a name="API_UpdatePhoneNumber_RequestSyntax"></a>

```
PUT /phone-number/PhoneNumberId HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "InstanceId": "string",
   "TargetArn": "string"
}
```

## URI Request Parameters
<a name="API_UpdatePhoneNumber_RequestParameters"></a>

The request uses the following URI parameters.

 ** [PhoneNumberId](#API_UpdatePhoneNumber_RequestSyntax) **   <a name="connect-UpdatePhoneNumber-request-uri-PhoneNumberId"></a>
A unique identifier for the phone number.  
Required: Yes

## Request Body
<a name="API_UpdatePhoneNumber_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_UpdatePhoneNumber_RequestSyntax) **   <a name="connect-UpdatePhoneNumber-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [InstanceId](#API_UpdatePhoneNumber_RequestSyntax) **   <a name="connect-UpdatePhoneNumber-request-InstanceId"></a>
The identifier of the Amazon Connect instance that phone numbers are claimed to. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance. You must enter `InstanceId` or `TargetArn`.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [TargetArn](#API_UpdatePhoneNumber_RequestSyntax) **   <a name="connect-UpdatePhoneNumber-request-TargetArn"></a>
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter `InstanceId` or `TargetArn`.   
Type: String  
Required: No

## Response Syntax
<a name="API_UpdatePhoneNumber_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "PhoneNumberArn": "string",
   "PhoneNumberId": "string"
}
```

## Response Elements
<a name="API_UpdatePhoneNumber_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PhoneNumberArn](#API_UpdatePhoneNumber_ResponseSyntax) **   <a name="connect-UpdatePhoneNumber-response-PhoneNumberArn"></a>
The Amazon Resource Name (ARN) of the phone number.  
Type: String

 ** [PhoneNumberId](#API_UpdatePhoneNumber_ResponseSyntax) **   <a name="connect-UpdatePhoneNumber-response-PhoneNumberId"></a>
A unique identifier for the phone number.  
Type: String

## Errors
<a name="API_UpdatePhoneNumber_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** IdempotencyException **   
An entity with the same name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** ResourceInUseException **   
That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.    
 ** ResourceId **   
The identifier for the resource.  
 ** ResourceType **   
The type of resource.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdatePhoneNumber_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdatePhoneNumber) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdatePhoneNumber) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdatePhoneNumber) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdatePhoneNumber) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdatePhoneNumber) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdatePhoneNumber) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdatePhoneNumber) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdatePhoneNumber) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdatePhoneNumber) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdatePhoneNumber) 

# UpdatePhoneNumberMetadata
<a name="API_UpdatePhoneNumberMetadata"></a>

Updates a phone number’s metadata.

**Important**  
To verify the status of a previous UpdatePhoneNumberMetadata operation, call the [DescribePhoneNumber](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html) API.

## Request Syntax
<a name="API_UpdatePhoneNumberMetadata_RequestSyntax"></a>

```
PUT /phone-number/PhoneNumberId/metadata HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "PhoneNumberDescription": "string"
}
```

## URI Request Parameters
<a name="API_UpdatePhoneNumberMetadata_RequestParameters"></a>

The request uses the following URI parameters.

 ** [PhoneNumberId](#API_UpdatePhoneNumberMetadata_RequestSyntax) **   <a name="connect-UpdatePhoneNumberMetadata-request-uri-PhoneNumberId"></a>
The Amazon Resource Name (ARN) or resource ID of the phone number.  
Required: Yes

## Request Body
<a name="API_UpdatePhoneNumberMetadata_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_UpdatePhoneNumberMetadata_RequestSyntax) **   <a name="connect-UpdatePhoneNumberMetadata-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [PhoneNumberDescription](#API_UpdatePhoneNumberMetadata_RequestSyntax) **   <a name="connect-UpdatePhoneNumberMetadata-request-PhoneNumberDescription"></a>
The description of the phone number.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Pattern: `^[\W\S_]*`   
Required: No

## Response Syntax
<a name="API_UpdatePhoneNumberMetadata_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdatePhoneNumberMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdatePhoneNumberMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** IdempotencyException **   
An entity with the same name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceInUseException **   
That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.    
 ** ResourceId **   
The identifier for the resource.  
 ** ResourceType **   
The type of resource.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdatePhoneNumberMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdatePhoneNumberMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdatePhoneNumberMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdatePhoneNumberMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdatePhoneNumberMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdatePhoneNumberMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdatePhoneNumberMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdatePhoneNumberMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdatePhoneNumberMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdatePhoneNumberMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdatePhoneNumberMetadata) 

# UpdatePredefinedAttribute
<a name="API_UpdatePredefinedAttribute"></a>

Updates a predefined attribute for the specified Amazon Connect instance. A *predefined attribute* is made up of a name and a value.

For the predefined attributes per instance quota, see [Amazon Connect quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas).

 **Use cases** 

Following are common uses cases for this API:
+ Update routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see [Create predefined attributes for routing contacts to agents](https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html).
+ Update an attribute for business unit name that has a list of predefined business unit names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see [Use contact segment attributes](https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html).

 **Endpoints**: See [Amazon Connect endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/connect_region.html).

## Request Syntax
<a name="API_UpdatePredefinedAttribute_RequestSyntax"></a>

```
POST /predefined-attributes/InstanceId/Name HTTP/1.1
Content-type: application/json

{
   "AttributeConfiguration": { 
      "EnableValueValidationOnAssociation": boolean
   },
   "Purposes": [ "string" ],
   "Values": { ... }
}
```

## URI Request Parameters
<a name="API_UpdatePredefinedAttribute_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdatePredefinedAttribute_RequestSyntax) **   <a name="connect-UpdatePredefinedAttribute-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [Name](#API_UpdatePredefinedAttribute_RequestSyntax) **   <a name="connect-UpdatePredefinedAttribute-request-uri-Name"></a>
The name of the predefined attribute.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdatePredefinedAttribute_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AttributeConfiguration](#API_UpdatePredefinedAttribute_RequestSyntax) **   <a name="connect-UpdatePredefinedAttribute-request-AttributeConfiguration"></a>
Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.  
Type: [InputPredefinedAttributeConfiguration](API_InputPredefinedAttributeConfiguration.md) object  
Required: No

 ** [Purposes](#API_UpdatePredefinedAttribute_RequestSyntax) **   <a name="connect-UpdatePredefinedAttribute-request-Purposes"></a>
Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [Values](#API_UpdatePredefinedAttribute_RequestSyntax) **   <a name="connect-UpdatePredefinedAttribute-request-Values"></a>
The values of the predefined attribute.  
Type: [PredefinedAttributeValues](API_PredefinedAttributeValues.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## Response Syntax
<a name="API_UpdatePredefinedAttribute_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdatePredefinedAttribute_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdatePredefinedAttribute_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_UpdatePredefinedAttribute_Examples"></a>

### Example
<a name="API_UpdatePredefinedAttribute_Example_1"></a>

The following example shows a request and response.

```
POST https://connect.us-west-2.amazonaws.com/predefined-attributes/InstanceId/Name HTTP/1.1
Content-type: application/json
{
    "Values": {
        "StringList": [
            "value1"
        ]
    },
    "Purposes": [
        "proficiency"
    ],
    "Configuration": {
        "EnableValueValidationOnAssociation": true
    }
}

Response:
200
```

## See Also
<a name="API_UpdatePredefinedAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdatePredefinedAttribute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdatePredefinedAttribute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdatePredefinedAttribute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdatePredefinedAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdatePredefinedAttribute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdatePredefinedAttribute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdatePredefinedAttribute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdatePredefinedAttribute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdatePredefinedAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdatePredefinedAttribute) 

# UpdatePrompt
<a name="API_UpdatePrompt"></a>

Updates a prompt.

## Request Syntax
<a name="API_UpdatePrompt_RequestSyntax"></a>

```
POST /prompts/InstanceId/PromptId HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "S3Uri": "string"
}
```

## URI Request Parameters
<a name="API_UpdatePrompt_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdatePrompt_RequestSyntax) **   <a name="connect-UpdatePrompt-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [PromptId](#API_UpdatePrompt_RequestSyntax) **   <a name="connect-UpdatePrompt-request-uri-PromptId"></a>
A unique identifier for the prompt.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_UpdatePrompt_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_UpdatePrompt_RequestSyntax) **   <a name="connect-UpdatePrompt-request-Description"></a>
A description of the prompt.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Required: No

 ** [Name](#API_UpdatePrompt_RequestSyntax) **   <a name="connect-UpdatePrompt-request-Name"></a>
The name of the prompt.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Required: No

 ** [S3Uri](#API_UpdatePrompt_RequestSyntax) **   <a name="connect-UpdatePrompt-request-S3Uri"></a>
The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the [GetPromptFile](https://docs.aws.amazon.com/connect/latest/APIReference/API_GetPromptFile.html) API instead of providing S3 URIs.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.  
Pattern: `s3://\S+/.+|https://\\S+\\.s3\\.\\S+\\.amazonaws\\.com/\\S+`   
Required: No

## Response Syntax
<a name="API_UpdatePrompt_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "PromptARN": "string",
   "PromptId": "string"
}
```

## Response Elements
<a name="API_UpdatePrompt_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [PromptARN](#API_UpdatePrompt_ResponseSyntax) **   <a name="connect-UpdatePrompt-response-PromptARN"></a>
The Amazon Resource Name (ARN) of the prompt.  
Type: String

 ** [PromptId](#API_UpdatePrompt_ResponseSyntax) **   <a name="connect-UpdatePrompt-response-PromptId"></a>
A unique identifier for the prompt.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_UpdatePrompt_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdatePrompt_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdatePrompt) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdatePrompt) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdatePrompt) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdatePrompt) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdatePrompt) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdatePrompt) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdatePrompt) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdatePrompt) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdatePrompt) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdatePrompt) 

# UpdateQueueHoursOfOperation
<a name="API_UpdateQueueHoursOfOperation"></a>

Updates the hours of operation for the specified queue.

## Request Syntax
<a name="API_UpdateQueueHoursOfOperation_RequestSyntax"></a>

```
POST /queues/InstanceId/QueueId/hours-of-operation HTTP/1.1
Content-type: application/json

{
   "HoursOfOperationId": "string"
}
```

## URI Request Parameters
<a name="API_UpdateQueueHoursOfOperation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateQueueHoursOfOperation_RequestSyntax) **   <a name="connect-UpdateQueueHoursOfOperation-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [QueueId](#API_UpdateQueueHoursOfOperation_RequestSyntax) **   <a name="connect-UpdateQueueHoursOfOperation-request-uri-QueueId"></a>
The identifier for the queue.  
Required: Yes

## Request Body
<a name="API_UpdateQueueHoursOfOperation_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [HoursOfOperationId](#API_UpdateQueueHoursOfOperation_RequestSyntax) **   <a name="connect-UpdateQueueHoursOfOperation-request-HoursOfOperationId"></a>
The identifier for the hours of operation.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_UpdateQueueHoursOfOperation_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateQueueHoursOfOperation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateQueueHoursOfOperation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateQueueHoursOfOperation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateQueueHoursOfOperation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateQueueHoursOfOperation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateQueueHoursOfOperation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateQueueHoursOfOperation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateQueueHoursOfOperation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateQueueHoursOfOperation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateQueueHoursOfOperation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateQueueHoursOfOperation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateQueueHoursOfOperation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateQueueHoursOfOperation) 

# UpdateQueueMaxContacts
<a name="API_UpdateQueueMaxContacts"></a>

Updates the maximum number of contacts allowed in a queue before it is considered full.

## Request Syntax
<a name="API_UpdateQueueMaxContacts_RequestSyntax"></a>

```
POST /queues/InstanceId/QueueId/max-contacts HTTP/1.1
Content-type: application/json

{
   "MaxContacts": number
}
```

## URI Request Parameters
<a name="API_UpdateQueueMaxContacts_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateQueueMaxContacts_RequestSyntax) **   <a name="connect-UpdateQueueMaxContacts-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [QueueId](#API_UpdateQueueMaxContacts_RequestSyntax) **   <a name="connect-UpdateQueueMaxContacts-request-uri-QueueId"></a>
The identifier for the queue.  
Required: Yes

## Request Body
<a name="API_UpdateQueueMaxContacts_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [MaxContacts](#API_UpdateQueueMaxContacts_RequestSyntax) **   <a name="connect-UpdateQueueMaxContacts-request-MaxContacts"></a>
The maximum number of contacts that can be in the queue before it is considered full.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

## Response Syntax
<a name="API_UpdateQueueMaxContacts_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateQueueMaxContacts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateQueueMaxContacts_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateQueueMaxContacts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateQueueMaxContacts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateQueueMaxContacts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateQueueMaxContacts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateQueueMaxContacts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateQueueMaxContacts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateQueueMaxContacts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateQueueMaxContacts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateQueueMaxContacts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateQueueMaxContacts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateQueueMaxContacts) 

# UpdateQueueName
<a name="API_UpdateQueueName"></a>

Updates the name and description of a queue. At least `Name` or `Description` must be provided.

## Request Syntax
<a name="API_UpdateQueueName_RequestSyntax"></a>

```
POST /queues/InstanceId/QueueId/name HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string"
}
```

## URI Request Parameters
<a name="API_UpdateQueueName_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateQueueName_RequestSyntax) **   <a name="connect-UpdateQueueName-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [QueueId](#API_UpdateQueueName_RequestSyntax) **   <a name="connect-UpdateQueueName-request-uri-QueueId"></a>
The identifier for the queue.  
Required: Yes

## Request Body
<a name="API_UpdateQueueName_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateQueueName_RequestSyntax) **   <a name="connect-UpdateQueueName-request-Description"></a>
The description of the queue.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Required: No

 ** [Name](#API_UpdateQueueName_RequestSyntax) **   <a name="connect-UpdateQueueName-request-Name"></a>
The name of the queue.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Required: No

## Response Syntax
<a name="API_UpdateQueueName_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateQueueName_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateQueueName_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateQueueName_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateQueueName) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateQueueName) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateQueueName) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateQueueName) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateQueueName) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateQueueName) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateQueueName) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateQueueName) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateQueueName) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateQueueName) 

# UpdateQueueOutboundCallerConfig
<a name="API_UpdateQueueOutboundCallerConfig"></a>

Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.

**Important**  
If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for `OutboundCallerIdNumberId`. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another AWS Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a `ResourceNotFoundException`.
Only use the phone number ARN format that doesn't contain `instance` in the path, for example, `arn:aws:connect:us-east-1:1234567890:phone-number/uuid`. This is the same ARN format that is returned when you call the [ListPhoneNumbersV2](https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html) API.
If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see [Allow or Deny queue API actions for phone numbers in a replica Region](https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_resource-level-policy-examples.html#allow-deny-queue-actions-replica-region).

## Request Syntax
<a name="API_UpdateQueueOutboundCallerConfig_RequestSyntax"></a>

```
POST /queues/InstanceId/QueueId/outbound-caller-config HTTP/1.1
Content-type: application/json

{
   "OutboundCallerConfig": { 
      "OutboundCallerIdName": "string",
      "OutboundCallerIdNumberId": "string",
      "OutboundFlowId": "string"
   }
}
```

## URI Request Parameters
<a name="API_UpdateQueueOutboundCallerConfig_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateQueueOutboundCallerConfig_RequestSyntax) **   <a name="connect-UpdateQueueOutboundCallerConfig-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [QueueId](#API_UpdateQueueOutboundCallerConfig_RequestSyntax) **   <a name="connect-UpdateQueueOutboundCallerConfig-request-uri-QueueId"></a>
The identifier for the queue.  
Required: Yes

## Request Body
<a name="API_UpdateQueueOutboundCallerConfig_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [OutboundCallerConfig](#API_UpdateQueueOutboundCallerConfig_RequestSyntax) **   <a name="connect-UpdateQueueOutboundCallerConfig-request-OutboundCallerConfig"></a>
The outbound caller ID name, number, and outbound whisper flow.  
Type: [OutboundCallerConfig](API_OutboundCallerConfig.md) object  
Required: Yes

## Response Syntax
<a name="API_UpdateQueueOutboundCallerConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateQueueOutboundCallerConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateQueueOutboundCallerConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateQueueOutboundCallerConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateQueueOutboundCallerConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateQueueOutboundCallerConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateQueueOutboundCallerConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateQueueOutboundCallerConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateQueueOutboundCallerConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateQueueOutboundCallerConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateQueueOutboundCallerConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateQueueOutboundCallerConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateQueueOutboundCallerConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateQueueOutboundCallerConfig) 

# UpdateQueueOutboundEmailConfig
<a name="API_UpdateQueueOutboundEmailConfig"></a>

Updates the outbound email address Id for a specified queue.

## Request Syntax
<a name="API_UpdateQueueOutboundEmailConfig_RequestSyntax"></a>

```
POST /queues/InstanceId/QueueId/outbound-email-config HTTP/1.1
Content-type: application/json

{
   "OutboundEmailConfig": { 
      "OutboundEmailAddressId": "string"
   }
}
```

## URI Request Parameters
<a name="API_UpdateQueueOutboundEmailConfig_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateQueueOutboundEmailConfig_RequestSyntax) **   <a name="connect-UpdateQueueOutboundEmailConfig-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [QueueId](#API_UpdateQueueOutboundEmailConfig_RequestSyntax) **   <a name="connect-UpdateQueueOutboundEmailConfig-request-uri-QueueId"></a>
The identifier for the queue.  
Required: Yes

## Request Body
<a name="API_UpdateQueueOutboundEmailConfig_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [OutboundEmailConfig](#API_UpdateQueueOutboundEmailConfig_RequestSyntax) **   <a name="connect-UpdateQueueOutboundEmailConfig-request-OutboundEmailConfig"></a>
The outbound email address ID for a specified queue.  
Type: [OutboundEmailConfig](API_OutboundEmailConfig.md) object  
Required: Yes

## Response Syntax
<a name="API_UpdateQueueOutboundEmailConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateQueueOutboundEmailConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateQueueOutboundEmailConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** ConditionalOperationFailedException **   
Request processing failed because dependent condition failed.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateQueueOutboundEmailConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateQueueOutboundEmailConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateQueueOutboundEmailConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateQueueOutboundEmailConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateQueueOutboundEmailConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateQueueOutboundEmailConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateQueueOutboundEmailConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateQueueOutboundEmailConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateQueueOutboundEmailConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateQueueOutboundEmailConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateQueueOutboundEmailConfig) 

# UpdateQueueStatus
<a name="API_UpdateQueueStatus"></a>

Updates the status of the queue.

## Request Syntax
<a name="API_UpdateQueueStatus_RequestSyntax"></a>

```
POST /queues/InstanceId/QueueId/status HTTP/1.1
Content-type: application/json

{
   "Status": "string"
}
```

## URI Request Parameters
<a name="API_UpdateQueueStatus_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateQueueStatus_RequestSyntax) **   <a name="connect-UpdateQueueStatus-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [QueueId](#API_UpdateQueueStatus_RequestSyntax) **   <a name="connect-UpdateQueueStatus-request-uri-QueueId"></a>
The identifier for the queue.  
Required: Yes

## Request Body
<a name="API_UpdateQueueStatus_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Status](#API_UpdateQueueStatus_RequestSyntax) **   <a name="connect-UpdateQueueStatus-request-Status"></a>
The status of the queue.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: Yes

## Response Syntax
<a name="API_UpdateQueueStatus_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateQueueStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateQueueStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateQueueStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateQueueStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateQueueStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateQueueStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateQueueStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateQueueStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateQueueStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateQueueStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateQueueStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateQueueStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateQueueStatus) 

# UpdateQuickConnectConfig
<a name="API_UpdateQuickConnectConfig"></a>

Updates the configuration settings for the specified quick connect.

## Request Syntax
<a name="API_UpdateQuickConnectConfig_RequestSyntax"></a>

```
POST /quick-connects/InstanceId/QuickConnectId/config HTTP/1.1
Content-type: application/json

{
   "QuickConnectConfig": { 
      "FlowConfig": { 
         "ContactFlowId": "string"
      },
      "PhoneConfig": { 
         "PhoneNumber": "string"
      },
      "QueueConfig": { 
         "ContactFlowId": "string",
         "QueueId": "string"
      },
      "QuickConnectType": "string",
      "UserConfig": { 
         "ContactFlowId": "string",
         "UserId": "string"
      }
   }
}
```

## URI Request Parameters
<a name="API_UpdateQuickConnectConfig_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateQuickConnectConfig_RequestSyntax) **   <a name="connect-UpdateQuickConnectConfig-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [QuickConnectId](#API_UpdateQuickConnectConfig_RequestSyntax) **   <a name="connect-UpdateQuickConnectConfig-request-uri-QuickConnectId"></a>
The identifier for the quick connect.  
Required: Yes

## Request Body
<a name="API_UpdateQuickConnectConfig_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [QuickConnectConfig](#API_UpdateQuickConnectConfig_RequestSyntax) **   <a name="connect-UpdateQuickConnectConfig-request-QuickConnectConfig"></a>
Information about the configuration settings for the quick connect.  
Type: [QuickConnectConfig](API_QuickConnectConfig.md) object  
Required: Yes

## Response Syntax
<a name="API_UpdateQuickConnectConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateQuickConnectConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateQuickConnectConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateQuickConnectConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateQuickConnectConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateQuickConnectConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateQuickConnectConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateQuickConnectConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateQuickConnectConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateQuickConnectConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateQuickConnectConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateQuickConnectConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateQuickConnectConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateQuickConnectConfig) 

# UpdateQuickConnectName
<a name="API_UpdateQuickConnectName"></a>

Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least `Name` or `Description` must be provided.

## Request Syntax
<a name="API_UpdateQuickConnectName_RequestSyntax"></a>

```
POST /quick-connects/InstanceId/QuickConnectId/name HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string"
}
```

## URI Request Parameters
<a name="API_UpdateQuickConnectName_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateQuickConnectName_RequestSyntax) **   <a name="connect-UpdateQuickConnectName-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [QuickConnectId](#API_UpdateQuickConnectName_RequestSyntax) **   <a name="connect-UpdateQuickConnectName-request-uri-QuickConnectId"></a>
The identifier for the quick connect.  
Required: Yes

## Request Body
<a name="API_UpdateQuickConnectName_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateQuickConnectName_RequestSyntax) **   <a name="connect-UpdateQuickConnectName-request-Description"></a>
The description of the quick connect.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 250.  
Required: No

 ** [Name](#API_UpdateQuickConnectName_RequestSyntax) **   <a name="connect-UpdateQuickConnectName-request-Name"></a>
The name of the quick connect.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Required: No

## Response Syntax
<a name="API_UpdateQuickConnectName_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateQuickConnectName_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateQuickConnectName_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateQuickConnectName_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateQuickConnectName) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateQuickConnectName) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateQuickConnectName) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateQuickConnectName) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateQuickConnectName) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateQuickConnectName) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateQuickConnectName) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateQuickConnectName) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateQuickConnectName) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateQuickConnectName) 

# UpdateRoutingProfileAgentAvailabilityTimer
<a name="API_UpdateRoutingProfileAgentAvailabilityTimer"></a>

Whether agents with this routing profile will have their routing order calculated based on *time since their last inbound contact* or *longest idle time*. 

## Request Syntax
<a name="API_UpdateRoutingProfileAgentAvailabilityTimer_RequestSyntax"></a>

```
POST /routing-profiles/InstanceId/RoutingProfileId/agent-availability-timer HTTP/1.1
Content-type: application/json

{
   "AgentAvailabilityTimer": "string"
}
```

## URI Request Parameters
<a name="API_UpdateRoutingProfileAgentAvailabilityTimer_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateRoutingProfileAgentAvailabilityTimer_RequestSyntax) **   <a name="connect-UpdateRoutingProfileAgentAvailabilityTimer-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [RoutingProfileId](#API_UpdateRoutingProfileAgentAvailabilityTimer_RequestSyntax) **   <a name="connect-UpdateRoutingProfileAgentAvailabilityTimer-request-uri-RoutingProfileId"></a>
The identifier of the routing profile.  
Required: Yes

## Request Body
<a name="API_UpdateRoutingProfileAgentAvailabilityTimer_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AgentAvailabilityTimer](#API_UpdateRoutingProfileAgentAvailabilityTimer_RequestSyntax) **   <a name="connect-UpdateRoutingProfileAgentAvailabilityTimer-request-AgentAvailabilityTimer"></a>
Whether agents with this routing profile will have their routing order calculated based on *time since their last inbound contact* or *longest idle time*.   
Type: String  
Valid Values: `TIME_SINCE_LAST_ACTIVITY | TIME_SINCE_LAST_INBOUND`   
Required: Yes

## Response Syntax
<a name="API_UpdateRoutingProfileAgentAvailabilityTimer_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateRoutingProfileAgentAvailabilityTimer_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateRoutingProfileAgentAvailabilityTimer_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateRoutingProfileAgentAvailabilityTimer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateRoutingProfileAgentAvailabilityTimer) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateRoutingProfileAgentAvailabilityTimer) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateRoutingProfileAgentAvailabilityTimer) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateRoutingProfileAgentAvailabilityTimer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateRoutingProfileAgentAvailabilityTimer) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateRoutingProfileAgentAvailabilityTimer) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateRoutingProfileAgentAvailabilityTimer) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateRoutingProfileAgentAvailabilityTimer) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateRoutingProfileAgentAvailabilityTimer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateRoutingProfileAgentAvailabilityTimer) 

# UpdateRoutingProfileConcurrency
<a name="API_UpdateRoutingProfileConcurrency"></a>

Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.

## Request Syntax
<a name="API_UpdateRoutingProfileConcurrency_RequestSyntax"></a>

```
POST /routing-profiles/InstanceId/RoutingProfileId/concurrency HTTP/1.1
Content-type: application/json

{
   "MediaConcurrencies": [ 
      { 
         "Channel": "string",
         "Concurrency": number,
         "CrossChannelBehavior": { 
            "BehaviorType": "string"
         }
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateRoutingProfileConcurrency_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateRoutingProfileConcurrency_RequestSyntax) **   <a name="connect-UpdateRoutingProfileConcurrency-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [RoutingProfileId](#API_UpdateRoutingProfileConcurrency_RequestSyntax) **   <a name="connect-UpdateRoutingProfileConcurrency-request-uri-RoutingProfileId"></a>
The identifier of the routing profile.  
Required: Yes

## Request Body
<a name="API_UpdateRoutingProfileConcurrency_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [MediaConcurrencies](#API_UpdateRoutingProfileConcurrency_RequestSyntax) **   <a name="connect-UpdateRoutingProfileConcurrency-request-MediaConcurrencies"></a>
The channels that agents can handle in the Contact Control Panel (CCP).  
Type: Array of [MediaConcurrency](API_MediaConcurrency.md) objects  
Required: Yes

## Response Syntax
<a name="API_UpdateRoutingProfileConcurrency_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateRoutingProfileConcurrency_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateRoutingProfileConcurrency_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateRoutingProfileConcurrency_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateRoutingProfileConcurrency) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateRoutingProfileConcurrency) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateRoutingProfileConcurrency) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateRoutingProfileConcurrency) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateRoutingProfileConcurrency) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateRoutingProfileConcurrency) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateRoutingProfileConcurrency) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateRoutingProfileConcurrency) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateRoutingProfileConcurrency) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateRoutingProfileConcurrency) 

# UpdateRoutingProfileDefaultOutboundQueue
<a name="API_UpdateRoutingProfileDefaultOutboundQueue"></a>

Updates the default outbound queue of a routing profile.

## Request Syntax
<a name="API_UpdateRoutingProfileDefaultOutboundQueue_RequestSyntax"></a>

```
POST /routing-profiles/InstanceId/RoutingProfileId/default-outbound-queue HTTP/1.1
Content-type: application/json

{
   "DefaultOutboundQueueId": "string"
}
```

## URI Request Parameters
<a name="API_UpdateRoutingProfileDefaultOutboundQueue_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateRoutingProfileDefaultOutboundQueue_RequestSyntax) **   <a name="connect-UpdateRoutingProfileDefaultOutboundQueue-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [RoutingProfileId](#API_UpdateRoutingProfileDefaultOutboundQueue_RequestSyntax) **   <a name="connect-UpdateRoutingProfileDefaultOutboundQueue-request-uri-RoutingProfileId"></a>
The identifier of the routing profile.  
Required: Yes

## Request Body
<a name="API_UpdateRoutingProfileDefaultOutboundQueue_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [DefaultOutboundQueueId](#API_UpdateRoutingProfileDefaultOutboundQueue_RequestSyntax) **   <a name="connect-UpdateRoutingProfileDefaultOutboundQueue-request-DefaultOutboundQueueId"></a>
The identifier for the default outbound queue.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_UpdateRoutingProfileDefaultOutboundQueue_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateRoutingProfileDefaultOutboundQueue_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateRoutingProfileDefaultOutboundQueue_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateRoutingProfileDefaultOutboundQueue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateRoutingProfileDefaultOutboundQueue) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateRoutingProfileDefaultOutboundQueue) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateRoutingProfileDefaultOutboundQueue) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateRoutingProfileDefaultOutboundQueue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateRoutingProfileDefaultOutboundQueue) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateRoutingProfileDefaultOutboundQueue) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateRoutingProfileDefaultOutboundQueue) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateRoutingProfileDefaultOutboundQueue) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateRoutingProfileDefaultOutboundQueue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateRoutingProfileDefaultOutboundQueue) 

# UpdateRoutingProfileName
<a name="API_UpdateRoutingProfileName"></a>

Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least `Name` or `Description` must be provided.

## Request Syntax
<a name="API_UpdateRoutingProfileName_RequestSyntax"></a>

```
POST /routing-profiles/InstanceId/RoutingProfileId/name HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string"
}
```

## URI Request Parameters
<a name="API_UpdateRoutingProfileName_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateRoutingProfileName_RequestSyntax) **   <a name="connect-UpdateRoutingProfileName-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [RoutingProfileId](#API_UpdateRoutingProfileName_RequestSyntax) **   <a name="connect-UpdateRoutingProfileName-request-uri-RoutingProfileId"></a>
The identifier of the routing profile.  
Required: Yes

## Request Body
<a name="API_UpdateRoutingProfileName_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateRoutingProfileName_RequestSyntax) **   <a name="connect-UpdateRoutingProfileName-request-Description"></a>
The description of the routing profile. Must not be more than 250 characters.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Required: No

 ** [Name](#API_UpdateRoutingProfileName_RequestSyntax) **   <a name="connect-UpdateRoutingProfileName-request-Name"></a>
The name of the routing profile. Must not be more than 127 characters.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Required: No

## Response Syntax
<a name="API_UpdateRoutingProfileName_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateRoutingProfileName_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateRoutingProfileName_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateRoutingProfileName_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateRoutingProfileName) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateRoutingProfileName) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateRoutingProfileName) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateRoutingProfileName) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateRoutingProfileName) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateRoutingProfileName) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateRoutingProfileName) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateRoutingProfileName) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateRoutingProfileName) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateRoutingProfileName) 

# UpdateRoutingProfileQueues
<a name="API_UpdateRoutingProfileQueues"></a>

Updates the properties associated with a set of queues for a routing profile.

## Request Syntax
<a name="API_UpdateRoutingProfileQueues_RequestSyntax"></a>

```
POST /routing-profiles/InstanceId/RoutingProfileId/queues HTTP/1.1
Content-type: application/json

{
   "QueueConfigs": [ 
      { 
         "Delay": number,
         "Priority": number,
         "QueueReference": { 
            "Channel": "string",
            "QueueId": "string"
         }
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateRoutingProfileQueues_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateRoutingProfileQueues_RequestSyntax) **   <a name="connect-UpdateRoutingProfileQueues-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [RoutingProfileId](#API_UpdateRoutingProfileQueues_RequestSyntax) **   <a name="connect-UpdateRoutingProfileQueues-request-uri-RoutingProfileId"></a>
The identifier of the routing profile.  
Required: Yes

## Request Body
<a name="API_UpdateRoutingProfileQueues_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [QueueConfigs](#API_UpdateRoutingProfileQueues_RequestSyntax) **   <a name="connect-UpdateRoutingProfileQueues-request-QueueConfigs"></a>
The queues to be updated for this routing profile. Queues must first be associated to the routing profile. You can do this using AssociateRoutingProfileQueues.  
Type: Array of [RoutingProfileQueueConfig](API_RoutingProfileQueueConfig.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: Yes

## Response Syntax
<a name="API_UpdateRoutingProfileQueues_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateRoutingProfileQueues_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateRoutingProfileQueues_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateRoutingProfileQueues_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateRoutingProfileQueues) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateRoutingProfileQueues) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateRoutingProfileQueues) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateRoutingProfileQueues) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateRoutingProfileQueues) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateRoutingProfileQueues) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateRoutingProfileQueues) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateRoutingProfileQueues) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateRoutingProfileQueues) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateRoutingProfileQueues) 

# UpdateRule
<a name="API_UpdateRule"></a>

Updates a rule for the specified Amazon Connect instance.

Use the [Rules Function language](https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html) to code conditions for the rule. 

## Request Syntax
<a name="API_UpdateRule_RequestSyntax"></a>

```
PUT /rules/InstanceId/RuleId HTTP/1.1
Content-type: application/json

{
   "Actions": [ 
      { 
         "ActionType": "string",
         "AssignContactCategoryAction": { 
         },
         "AssignSlaAction": { 
            "CaseSlaConfiguration": { 
               "FieldId": "string",
               "Name": "string",
               "TargetFieldValues": [ 
                  { 
                     "BooleanValue": boolean,
                     "DoubleValue": number,
                     "EmptyValue": { 
                     },
                     "StringValue": "string"
                  }
               ],
               "TargetSlaMinutes": number,
               "Type": "string"
            },
            "SlaAssignmentType": "string"
         },
         "CreateCaseAction": { 
            "Fields": [ 
               { 
                  "Id": "string",
                  "Value": { 
                     "BooleanValue": boolean,
                     "DoubleValue": number,
                     "EmptyValue": { 
                     },
                     "StringValue": "string"
                  }
               }
            ],
            "TemplateId": "string"
         },
         "EndAssociatedTasksAction": { 
         },
         "EventBridgeAction": { 
            "Name": "string"
         },
         "SendNotificationAction": { 
            "Content": "string",
            "ContentType": "string",
            "DeliveryMethod": "string",
            "Exclusion": { 
               "UserIds": [ "string" ],
               "UserTags": { 
                  "string" : "string" 
               }
            },
            "Recipient": { 
               "UserIds": [ "string" ],
               "UserTags": { 
                  "string" : "string" 
               }
            },
            "Subject": "string"
         },
         "SubmitAutoEvaluationAction": { 
            "EvaluationFormId": "string"
         },
         "TaskAction": { 
            "ContactFlowId": "string",
            "Description": "string",
            "Name": "string",
            "References": { 
               "string" : { 
                  "Arn": "string",
                  "Status": "string",
                  "StatusReason": "string",
                  "Type": "string",
                  "Value": "string"
               }
            }
         },
         "UpdateCaseAction": { 
            "Fields": [ 
               { 
                  "Id": "string",
                  "Value": { 
                     "BooleanValue": boolean,
                     "DoubleValue": number,
                     "EmptyValue": { 
                     },
                     "StringValue": "string"
                  }
               }
            ]
         }
      }
   ],
   "Function": "string",
   "Name": "string",
   "PublishStatus": "string"
}
```

## URI Request Parameters
<a name="API_UpdateRule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateRule_RequestSyntax) **   <a name="connect-UpdateRule-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [RuleId](#API_UpdateRule_RequestSyntax) **   <a name="connect-UpdateRule-request-uri-RuleId"></a>
A unique identifier for the rule.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_UpdateRule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Actions](#API_UpdateRule_RequestSyntax) **   <a name="connect-UpdateRule-request-Actions"></a>
A list of actions to be run when the rule is triggered.  
Type: Array of [RuleAction](API_RuleAction.md) objects  
Required: Yes

 ** [Function](#API_UpdateRule_RequestSyntax) **   <a name="connect-UpdateRule-request-Function"></a>
The conditions of the rule.  
Type: String  
Required: Yes

 ** [Name](#API_UpdateRule_RequestSyntax) **   <a name="connect-UpdateRule-request-Name"></a>
The name of the rule. You can change the name only if `TriggerEventSource` is one of the following values: `OnZendeskTicketCreate` \$1 `OnZendeskTicketStatusUpdate` \$1 `OnSalesforceCaseCreate`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `^[0-9a-zA-Z._-]+`   
Required: Yes

 ** [PublishStatus](#API_UpdateRule_RequestSyntax) **   <a name="connect-UpdateRule-request-PublishStatus"></a>
The publish status of the rule.  
Type: String  
Valid Values: `DRAFT | PUBLISHED`   
Required: Yes

## Response Syntax
<a name="API_UpdateRule_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateRule) 

# UpdateSecurityProfile
<a name="API_UpdateSecurityProfile"></a>

Updates a security profile.

For information about security profiles, see [Security Profiles](https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html) in the *Amazon Connect Administrator Guide*. For a mapping of the API name and user interface name of the security profile permissions, see [List of security profile permissions](https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html). 

## Request Syntax
<a name="API_UpdateSecurityProfile_RequestSyntax"></a>

```
POST /security-profiles/InstanceId/SecurityProfileId HTTP/1.1
Content-type: application/json

{
   "AllowedAccessControlHierarchyGroupId": "string",
   "AllowedAccessControlTags": { 
      "string" : "string" 
   },
   "AllowedFlowModules": [ 
      { 
         "FlowModuleId": "string",
         "Type": "string"
      }
   ],
   "Applications": [ 
      { 
         "ApplicationPermissions": [ "string" ],
         "Namespace": "string",
         "Type": "string"
      }
   ],
   "Description": "string",
   "GranularAccessControlConfiguration": { 
      "DataTableAccessControlConfiguration": { 
         "PrimaryAttributeAccessControlConfiguration": { 
            "PrimaryAttributeValues": [ 
               { 
                  "AccessType": "string",
                  "AttributeName": "string",
                  "Values": [ "string" ]
               }
            ]
         }
      }
   },
   "HierarchyRestrictedResources": [ "string" ],
   "Permissions": [ "string" ],
   "TagRestrictedResources": [ "string" ]
}
```

## URI Request Parameters
<a name="API_UpdateSecurityProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateSecurityProfile_RequestSyntax) **   <a name="connect-UpdateSecurityProfile-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [SecurityProfileId](#API_UpdateSecurityProfile_RequestSyntax) **   <a name="connect-UpdateSecurityProfile-request-uri-SecurityProfileId"></a>
The identifier for the security profle.  
Required: Yes

## Request Body
<a name="API_UpdateSecurityProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AllowedAccessControlHierarchyGroupId](#API_UpdateSecurityProfile_RequestSyntax) **   <a name="connect-UpdateSecurityProfile-request-AllowedAccessControlHierarchyGroupId"></a>
The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.  
Type: String  
Required: No

 ** [AllowedAccessControlTags](#API_UpdateSecurityProfile_RequestSyntax) **   <a name="connect-UpdateSecurityProfile-request-AllowedAccessControlTags"></a>
The list of tags that a security profile uses to restrict access to resources in Amazon Connect.  
Type: String to string map  
Map Entries: Maximum number of 4 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Value Length Constraints: Maximum length of 256.  
Required: No

 ** [AllowedFlowModules](#API_UpdateSecurityProfile_RequestSyntax) **   <a name="connect-UpdateSecurityProfile-request-AllowedFlowModules"></a>
 A list of Flow Modules an AI Agent can invoke as a tool   
Type: Array of [FlowModule](API_FlowModule.md) objects  
Array Members: Maximum number of 10 items.  
Required: No

 ** [Applications](#API_UpdateSecurityProfile_RequestSyntax) **   <a name="connect-UpdateSecurityProfile-request-Applications"></a>
A list of the third-party application's metadata.  
Type: Array of [Application](API_Application.md) objects  
Array Members: Maximum number of 10 items.  
Required: No

 ** [Description](#API_UpdateSecurityProfile_RequestSyntax) **   <a name="connect-UpdateSecurityProfile-request-Description"></a>
The description of the security profile.  
Type: String  
Length Constraints: Maximum length of 250.  
Required: No

 ** [GranularAccessControlConfiguration](#API_UpdateSecurityProfile_RequestSyntax) **   <a name="connect-UpdateSecurityProfile-request-GranularAccessControlConfiguration"></a>
The granular access control configuration for the security profile, including data table permissions.  
Type: [GranularAccessControlConfiguration](API_GranularAccessControlConfiguration.md) object  
Required: No

 ** [HierarchyRestrictedResources](#API_UpdateSecurityProfile_RequestSyntax) **   <a name="connect-UpdateSecurityProfile-request-HierarchyRestrictedResources"></a>
The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: `User`.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [Permissions](#API_UpdateSecurityProfile_RequestSyntax) **   <a name="connect-UpdateSecurityProfile-request-Permissions"></a>
The permissions granted to a security profile. For a list of valid permissions, see [List of security profile permissions](https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html).  
Type: Array of strings  
Array Members: Maximum number of 500 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

 ** [TagRestrictedResources](#API_UpdateSecurityProfile_RequestSyntax) **   <a name="connect-UpdateSecurityProfile-request-TagRestrictedResources"></a>
The list of resources that a security profile applies tag restrictions to in Amazon Connect.  
Type: Array of strings  
Array Members: Maximum number of 10 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: No

## Response Syntax
<a name="API_UpdateSecurityProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateSecurityProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateSecurityProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateSecurityProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateSecurityProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateSecurityProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateSecurityProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateSecurityProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateSecurityProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateSecurityProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateSecurityProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateSecurityProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateSecurityProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateSecurityProfile) 

# UpdateTaskTemplate
<a name="API_UpdateTaskTemplate"></a>

Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content.

## Request Syntax
<a name="API_UpdateTaskTemplate_RequestSyntax"></a>

```
POST /instance/InstanceId/task/template/TaskTemplateId HTTP/1.1
Content-type: application/json

{
   "Constraints": { 
      "InvisibleFields": [ 
         { 
            "Id": { 
               "Name": "string"
            }
         }
      ],
      "ReadOnlyFields": [ 
         { 
            "Id": { 
               "Name": "string"
            }
         }
      ],
      "RequiredFields": [ 
         { 
            "Id": { 
               "Name": "string"
            }
         }
      ]
   },
   "ContactFlowId": "string",
   "Defaults": { 
      "DefaultFieldValues": [ 
         { 
            "DefaultValue": "string",
            "Id": { 
               "Name": "string"
            }
         }
      ]
   },
   "Description": "string",
   "Fields": [ 
      { 
         "Description": "string",
         "Id": { 
            "Name": "string"
         },
         "SingleSelectOptions": [ "string" ],
         "Type": "string"
      }
   ],
   "Name": "string",
   "SelfAssignFlowId": "string",
   "Status": "string"
}
```

## URI Request Parameters
<a name="API_UpdateTaskTemplate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateTaskTemplate_RequestSyntax) **   <a name="connect-UpdateTaskTemplate-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [TaskTemplateId](#API_UpdateTaskTemplate_RequestSyntax) **   <a name="connect-UpdateTaskTemplate-request-uri-TaskTemplateId"></a>
A unique identifier for the task template.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_UpdateTaskTemplate_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Constraints](#API_UpdateTaskTemplate_RequestSyntax) **   <a name="connect-UpdateTaskTemplate-request-Constraints"></a>
Constraints that are applicable to the fields listed.  
Type: [TaskTemplateConstraints](API_TaskTemplateConstraints.md) object  
Required: No

 ** [ContactFlowId](#API_UpdateTaskTemplate_RequestSyntax) **   <a name="connect-UpdateTaskTemplate-request-ContactFlowId"></a>
The identifier of the flow that runs by default when a task is created by referencing this template.  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [Defaults](#API_UpdateTaskTemplate_RequestSyntax) **   <a name="connect-UpdateTaskTemplate-request-Defaults"></a>
The default values for fields when a task is created by referencing this template.  
Type: [TaskTemplateDefaults](API_TaskTemplateDefaults.md) object  
Required: No

 ** [Description](#API_UpdateTaskTemplate_RequestSyntax) **   <a name="connect-UpdateTaskTemplate-request-Description"></a>
The description of the task template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [Fields](#API_UpdateTaskTemplate_RequestSyntax) **   <a name="connect-UpdateTaskTemplate-request-Fields"></a>
Fields that are part of the template.  
Type: Array of [TaskTemplateField](API_TaskTemplateField.md) objects  
Required: No

 ** [Name](#API_UpdateTaskTemplate_RequestSyntax) **   <a name="connect-UpdateTaskTemplate-request-Name"></a>
The name of the task template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [SelfAssignFlowId](#API_UpdateTaskTemplate_RequestSyntax) **   <a name="connect-UpdateTaskTemplate-request-SelfAssignFlowId"></a>
The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [Status](#API_UpdateTaskTemplate_RequestSyntax) **   <a name="connect-UpdateTaskTemplate-request-Status"></a>
Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to it. Tasks can only be created from `ACTIVE` templates. If a template is marked as `INACTIVE`, then a task that refers to this template cannot be created.  
Type: String  
Valid Values: `ACTIVE | INACTIVE`   
Required: No

## Response Syntax
<a name="API_UpdateTaskTemplate_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Constraints": { 
      "InvisibleFields": [ 
         { 
            "Id": { 
               "Name": "string"
            }
         }
      ],
      "ReadOnlyFields": [ 
         { 
            "Id": { 
               "Name": "string"
            }
         }
      ],
      "RequiredFields": [ 
         { 
            "Id": { 
               "Name": "string"
            }
         }
      ]
   },
   "ContactFlowId": "string",
   "CreatedTime": number,
   "Defaults": { 
      "DefaultFieldValues": [ 
         { 
            "DefaultValue": "string",
            "Id": { 
               "Name": "string"
            }
         }
      ]
   },
   "Description": "string",
   "Fields": [ 
      { 
         "Description": "string",
         "Id": { 
            "Name": "string"
         },
         "SingleSelectOptions": [ "string" ],
         "Type": "string"
      }
   ],
   "Id": "string",
   "InstanceId": "string",
   "LastModifiedTime": number,
   "Name": "string",
   "SelfAssignFlowId": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_UpdateTaskTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_UpdateTaskTemplate_ResponseSyntax) **   <a name="connect-UpdateTaskTemplate-response-Arn"></a>
The Amazon Resource Name (ARN) for the task template resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [Constraints](#API_UpdateTaskTemplate_ResponseSyntax) **   <a name="connect-UpdateTaskTemplate-response-Constraints"></a>
Constraints that are applicable to the fields listed.  
Type: [TaskTemplateConstraints](API_TaskTemplateConstraints.md) object

 ** [ContactFlowId](#API_UpdateTaskTemplate_ResponseSyntax) **   <a name="connect-UpdateTaskTemplate-response-ContactFlowId"></a>
The identifier of the flow that runs by default when a task is created by referencing this template.  
Type: String  
Length Constraints: Maximum length of 500.

 ** [CreatedTime](#API_UpdateTaskTemplate_ResponseSyntax) **   <a name="connect-UpdateTaskTemplate-response-CreatedTime"></a>
The timestamp when the task template was created.  
Type: Timestamp

 ** [Defaults](#API_UpdateTaskTemplate_ResponseSyntax) **   <a name="connect-UpdateTaskTemplate-response-Defaults"></a>
The default values for fields when a task is created by referencing this template.  
Type: [TaskTemplateDefaults](API_TaskTemplateDefaults.md) object

 ** [Description](#API_UpdateTaskTemplate_ResponseSyntax) **   <a name="connect-UpdateTaskTemplate-response-Description"></a>
The description of the task template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [Fields](#API_UpdateTaskTemplate_ResponseSyntax) **   <a name="connect-UpdateTaskTemplate-response-Fields"></a>
Fields that are part of the template.  
Type: Array of [TaskTemplateField](API_TaskTemplateField.md) objects

 ** [Id](#API_UpdateTaskTemplate_ResponseSyntax) **   <a name="connect-UpdateTaskTemplate-response-Id"></a>
The identifier of the task template resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [InstanceId](#API_UpdateTaskTemplate_ResponseSyntax) **   <a name="connect-UpdateTaskTemplate-response-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** [LastModifiedTime](#API_UpdateTaskTemplate_ResponseSyntax) **   <a name="connect-UpdateTaskTemplate-response-LastModifiedTime"></a>
The timestamp when the task template was last modified.  
Type: Timestamp

 ** [Name](#API_UpdateTaskTemplate_ResponseSyntax) **   <a name="connect-UpdateTaskTemplate-response-Name"></a>
The name of the task template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** [SelfAssignFlowId](#API_UpdateTaskTemplate_ResponseSyntax) **   <a name="connect-UpdateTaskTemplate-response-SelfAssignFlowId"></a>
The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.  
Type: String  
Length Constraints: Maximum length of 500.

 ** [Status](#API_UpdateTaskTemplate_ResponseSyntax) **   <a name="connect-UpdateTaskTemplate-response-Status"></a>
Marks a template as `ACTIVE` or `INACTIVE` for a task to refer to it. Tasks can only be created from `ACTIVE` templates. If a template is marked as `INACTIVE`, then a task that refers to this template cannot be created.  
Type: String  
Valid Values: `ACTIVE | INACTIVE` 

## Errors
<a name="API_UpdateTaskTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** PropertyValidationException **   
The property is not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded.    
 ** Reason **   
The reason for the exception.
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateTaskTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateTaskTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateTaskTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateTaskTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateTaskTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateTaskTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateTaskTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateTaskTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateTaskTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateTaskTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateTaskTemplate) 

# UpdateTestCase
<a name="API_UpdateTestCase"></a>

Updates any of the metadata for a test case, such as the name, description, and status or content of an existing test case. This API doesn't allow customers to update the tags of the test case resource for the specified Amazon Connect instance.

## Request Syntax
<a name="API_UpdateTestCase_RequestSyntax"></a>

```
POST /test-cases/InstanceId/TestCaseId HTTP/1.1
x-amz-last-modified-time: LastModifiedTime
x-amz-last-modified-region: LastModifiedRegion
Content-type: application/json

{
   "Content": "string",
   "Description": "string",
   "EntryPoint": { 
      "ChatEntryPointParameters": { 
         "FlowId": "string"
      },
      "Type": "string",
      "VoiceCallEntryPointParameters": { 
         "DestinationPhoneNumber": "string",
         "FlowId": "string",
         "SourcePhoneNumber": "string"
      }
   },
   "InitializationData": "string",
   "Name": "string",
   "Status": "string"
}
```

## URI Request Parameters
<a name="API_UpdateTestCase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateTestCase_RequestSyntax) **   <a name="connect-UpdateTestCase-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Length Constraints: Minimum length of 1. Maximum length of 250.  
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z]+-[0-9]{1}:[0-9]{1,20}:instance/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

 ** [LastModifiedRegion](#API_UpdateTestCase_RequestSyntax) **   <a name="connect-UpdateTestCase-request-LastModifiedRegion"></a>
The region in which the resource was last modified  
Pattern: `[a-z]{2}(-[a-z]+){1,2}(-[0-9])?` 

 ** [LastModifiedTime](#API_UpdateTestCase_RequestSyntax) **   <a name="connect-UpdateTestCase-request-LastModifiedTime"></a>
The time at which the resource was last modified.

 ** [TestCaseId](#API_UpdateTestCase_RequestSyntax) **   <a name="connect-UpdateTestCase-request-uri-TestCaseId"></a>
The identifier of the test case to update.  
Length Constraints: Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_UpdateTestCase_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Content](#API_UpdateTestCase_RequestSyntax) **   <a name="connect-UpdateTestCase-request-Content"></a>
The JSON string that represents the content of the test.  
Type: String  
Required: No

 ** [Description](#API_UpdateTestCase_RequestSyntax) **   <a name="connect-UpdateTestCase-request-Description"></a>
The description of the test case.  
Type: String  
Required: No

 ** [EntryPoint](#API_UpdateTestCase_RequestSyntax) **   <a name="connect-UpdateTestCase-request-EntryPoint"></a>
Defines the starting point for your test.  
Type: [TestCaseEntryPoint](API_TestCaseEntryPoint.md) object  
Required: No

 ** [InitializationData](#API_UpdateTestCase_RequestSyntax) **   <a name="connect-UpdateTestCase-request-InitializationData"></a>
Defines the test attributes for precise data representation.  
Type: String  
Required: No

 ** [Name](#API_UpdateTestCase_RequestSyntax) **   <a name="connect-UpdateTestCase-request-Name"></a>
The name of the test case.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

 ** [Status](#API_UpdateTestCase_RequestSyntax) **   <a name="connect-UpdateTestCase-request-Status"></a>
Indicates the test status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. The SAVED status does not initiate validation of the content.  
Type: String  
Valid Values: `PUBLISHED | SAVED`   
Required: No

## Response Syntax
<a name="API_UpdateTestCase_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateTestCase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateTestCase_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** InvalidTestCaseException **   
The test is not valid.    
 ** Problems **   
The problems with the test. Please fix before trying again.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateTestCase_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateTestCase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateTestCase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateTestCase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateTestCase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateTestCase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateTestCase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateTestCase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateTestCase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateTestCase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateTestCase) 

# UpdateTrafficDistribution
<a name="API_UpdateTrafficDistribution"></a>

Updates the traffic distribution for a given traffic distribution group. 

**Important**  
When you shift telephony traffic, also shift agents and/or agent sign-ins to ensure they can handle the calls in the other Region. If you don't shift the agents, voice calls will go to the shifted Region but there won't be any agents available to receive the calls.

**Note**  
The `SignInConfig` distribution is available only on a default `TrafficDistributionGroup` (see the `IsDefault` parameter in the [TrafficDistributionGroup](https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html) data type). If you call `UpdateTrafficDistribution` with a modified `SignInConfig` and a non-default `TrafficDistributionGroup`, an `InvalidRequestException` is returned.

For more information about updating a traffic distribution group, see [Update telephony traffic distribution across AWS Regions](https://docs.aws.amazon.com/connect/latest/adminguide/update-telephony-traffic-distribution.html) in the *Amazon Connect Administrator Guide*. 

 **Important things to know** 
+ Invoke the UpdateTrafficDistribution API in the region that should handle traffic.

## Request Syntax
<a name="API_UpdateTrafficDistribution_RequestSyntax"></a>

```
PUT /traffic-distribution/Id HTTP/1.1
Content-type: application/json

{
   "AgentConfig": { 
      "Distributions": [ 
         { 
            "Percentage": number,
            "Region": "string"
         }
      ]
   },
   "SignInConfig": { 
      "Distributions": [ 
         { 
            "Enabled": boolean,
            "Region": "string"
         }
      ]
   },
   "TelephonyConfig": { 
      "Distributions": [ 
         { 
            "Percentage": number,
            "Region": "string"
         }
      ]
   }
}
```

## URI Request Parameters
<a name="API_UpdateTrafficDistribution_RequestParameters"></a>

The request uses the following URI parameters.

 ** [Id](#API_UpdateTrafficDistribution_RequestSyntax) **   <a name="connect-UpdateTrafficDistribution-request-uri-Id"></a>
The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.   
Pattern: `^(arn:(aws|aws-us-gov):connect:[a-z]{2}-[a-z-]+-[0-9]{1}:[0-9]{1,20}:traffic-distribution-group/)?[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$`   
Required: Yes

## Request Body
<a name="API_UpdateTrafficDistribution_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AgentConfig](#API_UpdateTrafficDistribution_RequestSyntax) **   <a name="connect-UpdateTrafficDistribution-request-AgentConfig"></a>
The distribution of agents between the instance and its replica(s).  
Type: [AgentConfig](API_AgentConfig.md) object  
Required: No

 ** [SignInConfig](#API_UpdateTrafficDistribution_RequestSyntax) **   <a name="connect-UpdateTrafficDistribution-request-SignInConfig"></a>
The distribution that determines which AWS Regions should be used to sign in agents in to both the instance and its replica(s).  
Type: [SignInConfig](API_SignInConfig.md) object  
Required: No

 ** [TelephonyConfig](#API_UpdateTrafficDistribution_RequestSyntax) **   <a name="connect-UpdateTrafficDistribution-request-TelephonyConfig"></a>
The distribution of traffic between the instance and its replica(s).  
Type: [TelephonyConfig](API_TelephonyConfig.md) object  
Required: No

## Response Syntax
<a name="API_UpdateTrafficDistribution_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateTrafficDistribution_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateTrafficDistribution_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateTrafficDistribution_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateTrafficDistribution) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateTrafficDistribution) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateTrafficDistribution) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateTrafficDistribution) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateTrafficDistribution) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateTrafficDistribution) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateTrafficDistribution) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateTrafficDistribution) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateTrafficDistribution) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateTrafficDistribution) 

# UpdateUserConfig
<a name="API_UpdateUserConfig"></a>

Updates the configuration settings for the specified user, including per-channel auto-accept and after contact work (ACW) timeout settings.

**Note**  
This operation replaces the UpdateUserPhoneConfig API. While UpdateUserPhoneConfig applies the same ACW timeout to all channels, UpdateUserConfig allows you to set different auto-accept and ACW timeout values for each channel type.

## Request Syntax
<a name="API_UpdateUserConfig_RequestSyntax"></a>

```
POST /users/InstanceId/UserId/config HTTP/1.1
Content-type: application/json

{
   "AfterContactWorkConfigs": [ 
      { 
         "AfterContactWorkConfig": { 
            "AfterContactWorkTimeLimit": number
         },
         "AgentFirstCallbackAfterContactWorkConfig": { 
            "AfterContactWorkTimeLimit": number
         },
         "Channel": "string"
      }
   ],
   "AutoAcceptConfigs": [ 
      { 
         "AgentFirstCallbackAutoAccept": boolean,
         "AutoAccept": boolean,
         "Channel": "string"
      }
   ],
   "PersistentConnectionConfigs": [ 
      { 
         "Channel": "string",
         "PersistentConnection": boolean
      }
   ],
   "PhoneNumberConfigs": [ 
      { 
         "Channel": "string",
         "PhoneNumber": "string",
         "PhoneType": "string"
      }
   ],
   "VoiceEnhancementConfigs": [ 
      { 
         "Channel": "string",
         "VoiceEnhancementMode": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateUserConfig_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateUserConfig_RequestSyntax) **   <a name="connect-UpdateUserConfig-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [UserId](#API_UpdateUserConfig_RequestSyntax) **   <a name="connect-UpdateUserConfig-request-uri-UserId"></a>
The identifier of the user account.  
Required: Yes

## Request Body
<a name="API_UpdateUserConfig_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AfterContactWorkConfigs](#API_UpdateUserConfig_RequestSyntax) **   <a name="connect-UpdateUserConfig-request-AfterContactWorkConfigs"></a>
The list of after contact work (ACW) timeout configuration settings for each channel. ACW timeout specifies how many seconds agents have for after contact work, such as entering notes about the contact. The minimum setting is 1 second, and the maximum is 2,000,000 seconds (24 days). Enter 0 for an indefinite amount of time, meaning agents must manually choose to end ACW.  
Type: Array of [AfterContactWorkConfigPerChannel](API_AfterContactWorkConfigPerChannel.md) objects  
Required: No

 ** [AutoAcceptConfigs](#API_UpdateUserConfig_RequestSyntax) **   <a name="connect-UpdateUserConfig-request-AutoAcceptConfigs"></a>
The list of auto-accept configuration settings for each channel. When auto-accept is enabled for a channel, available agents are automatically connected to contacts from that channel without needing to manually accept. Auto-accept connects agents to contacts in less than one second.  
Type: Array of [AutoAcceptConfig](API_AutoAcceptConfig.md) objects  
Required: No

 ** [PersistentConnectionConfigs](#API_UpdateUserConfig_RequestSyntax) **   <a name="connect-UpdateUserConfig-request-PersistentConnectionConfigs"></a>
The list of persistent connection configuration settings for each channel.  
Type: Array of [PersistentConnectionConfig](API_PersistentConnectionConfig.md) objects  
Required: No

 ** [PhoneNumberConfigs](#API_UpdateUserConfig_RequestSyntax) **   <a name="connect-UpdateUserConfig-request-PhoneNumberConfigs"></a>
The list of phone number configuration settings for each channel.  
Type: Array of [PhoneNumberConfig](API_PhoneNumberConfig.md) objects  
Required: No

 ** [VoiceEnhancementConfigs](#API_UpdateUserConfig_RequestSyntax) **   <a name="connect-UpdateUserConfig-request-VoiceEnhancementConfigs"></a>
The list of voice enhancement configuration settings for each channel.  
Type: Array of [VoiceEnhancementConfig](API_VoiceEnhancementConfig.md) objects  
Required: No

## Response Syntax
<a name="API_UpdateUserConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateUserConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateUserConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** ConditionalOperationFailedException **   
Request processing failed because dependent condition failed.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_UpdateUserConfig_Examples"></a>

### Request syntax
<a name="API_UpdateUserConfig_Example_1"></a>

This example illustrates one usage of UpdateUserConfig.

```
POST /users/{InstanceId}/{UserId}/config HTTP/1.1
Content-type: application/json

{
   "AfterContactWorkConfigs": [
      {
         "AfterContactWorkConfig": {
            "AfterContactWorkTimeLimit": number
         },
         "Channel": "CHAT"
      },
      {
         "AfterContactWorkConfig": {
            "AfterContactWorkTimeLimit": number
         },
         "Channel": "EMAIL"
      },
      {
         "AfterContactWorkConfig": {
            "AfterContactWorkTimeLimit": number
         },
         "Channel": "TASK"
      },
      {
         "AfterContactWorkConfig": {
            "AfterContactWorkTimeLimit": number
         },
         "AgentFirstCallbackAfterContactWorkConfig": {
            "AfterContactWorkTimeLimit": number
         },
         "Channel": "VOICE"
      }
   ],
   "AutoAcceptConfigs": [
      {
         "AutoAccept": boolean,
         "Channel": "CHAT"
      },
      {
         "AutoAccept": boolean,
         "Channel": "EMAIL"
      },
      {
         "AutoAccept": boolean,
         "Channel": "TASK"
      },
      {
         "AgentFirstCallbackAutoAccept": boolean,
         "AutoAccept": boolean,
         "Channel": "VOICE"
      }
   ],
   "PhoneNumberConfigs": [
      {
         "Channel": "VOICE",
         "PhoneNumber": "string",
         "PhoneType": "string"
      }
   ],
   "PersistentConnectionConfigs": [
      {
         "Channel": "VOICE",
         "PersistentConnection": boolean
      }
   ],
   "VoiceEnhancementConfigs": [
      {
         "Channel": "VOICE",
         "VoiceEnhancementMode": "string"
      }
   ]
}
```

## See Also
<a name="API_UpdateUserConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateUserConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateUserConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateUserConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateUserConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateUserConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateUserConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateUserConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateUserConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateUserConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateUserConfig) 

# UpdateUserHierarchy
<a name="API_UpdateUserHierarchy"></a>

Assigns the specified hierarchy group to the specified user.

## Request Syntax
<a name="API_UpdateUserHierarchy_RequestSyntax"></a>

```
POST /users/InstanceId/UserId/hierarchy HTTP/1.1
Content-type: application/json

{
   "HierarchyGroupId": "string"
}
```

## URI Request Parameters
<a name="API_UpdateUserHierarchy_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateUserHierarchy_RequestSyntax) **   <a name="connect-UpdateUserHierarchy-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [UserId](#API_UpdateUserHierarchy_RequestSyntax) **   <a name="connect-UpdateUserHierarchy-request-uri-UserId"></a>
The identifier of the user account.  
Required: Yes

## Request Body
<a name="API_UpdateUserHierarchy_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [HierarchyGroupId](#API_UpdateUserHierarchy_RequestSyntax) **   <a name="connect-UpdateUserHierarchy-request-HierarchyGroupId"></a>
The identifier of the hierarchy group.  
Type: String  
Required: No

## Response Syntax
<a name="API_UpdateUserHierarchy_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateUserHierarchy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateUserHierarchy_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateUserHierarchy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateUserHierarchy) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateUserHierarchy) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateUserHierarchy) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateUserHierarchy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateUserHierarchy) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateUserHierarchy) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateUserHierarchy) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateUserHierarchy) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateUserHierarchy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateUserHierarchy) 

# UpdateUserHierarchyGroupName
<a name="API_UpdateUserHierarchyGroupName"></a>

Updates the name of the user hierarchy group. 

## Request Syntax
<a name="API_UpdateUserHierarchyGroupName_RequestSyntax"></a>

```
POST /user-hierarchy-groups/InstanceId/HierarchyGroupId/name HTTP/1.1
Content-type: application/json

{
   "Name": "string"
}
```

## URI Request Parameters
<a name="API_UpdateUserHierarchyGroupName_RequestParameters"></a>

The request uses the following URI parameters.

 ** [HierarchyGroupId](#API_UpdateUserHierarchyGroupName_RequestSyntax) **   <a name="connect-UpdateUserHierarchyGroupName-request-uri-HierarchyGroupId"></a>
The identifier of the hierarchy group.  
Required: Yes

 ** [InstanceId](#API_UpdateUserHierarchyGroupName_RequestSyntax) **   <a name="connect-UpdateUserHierarchyGroupName-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdateUserHierarchyGroupName_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Name](#API_UpdateUserHierarchyGroupName_RequestSyntax) **   <a name="connect-UpdateUserHierarchyGroupName-request-Name"></a>
The name of the hierarchy group. Must not be more than 100 characters.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_UpdateUserHierarchyGroupName_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateUserHierarchyGroupName_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateUserHierarchyGroupName_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateUserHierarchyGroupName_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateUserHierarchyGroupName) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateUserHierarchyGroupName) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateUserHierarchyGroupName) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateUserHierarchyGroupName) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateUserHierarchyGroupName) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateUserHierarchyGroupName) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateUserHierarchyGroupName) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateUserHierarchyGroupName) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateUserHierarchyGroupName) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateUserHierarchyGroupName) 

# UpdateUserHierarchyStructure
<a name="API_UpdateUserHierarchyStructure"></a>

Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.

## Request Syntax
<a name="API_UpdateUserHierarchyStructure_RequestSyntax"></a>

```
POST /user-hierarchy-structure/InstanceId HTTP/1.1
Content-type: application/json

{
   "HierarchyStructure": { 
      "LevelFive": { 
         "Name": "string"
      },
      "LevelFour": { 
         "Name": "string"
      },
      "LevelOne": { 
         "Name": "string"
      },
      "LevelThree": { 
         "Name": "string"
      },
      "LevelTwo": { 
         "Name": "string"
      }
   }
}
```

## URI Request Parameters
<a name="API_UpdateUserHierarchyStructure_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateUserHierarchyStructure_RequestSyntax) **   <a name="connect-UpdateUserHierarchyStructure-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Request Body
<a name="API_UpdateUserHierarchyStructure_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [HierarchyStructure](#API_UpdateUserHierarchyStructure_RequestSyntax) **   <a name="connect-UpdateUserHierarchyStructure-request-HierarchyStructure"></a>
The hierarchy levels to update.  
Type: [HierarchyStructureUpdate](API_HierarchyStructureUpdate.md) object  
Required: Yes

## Response Syntax
<a name="API_UpdateUserHierarchyStructure_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateUserHierarchyStructure_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateUserHierarchyStructure_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceInUseException **   
That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.    
 ** ResourceId **   
The identifier for the resource.  
 ** ResourceType **   
The type of resource.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateUserHierarchyStructure_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateUserHierarchyStructure) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateUserHierarchyStructure) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateUserHierarchyStructure) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateUserHierarchyStructure) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateUserHierarchyStructure) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateUserHierarchyStructure) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateUserHierarchyStructure) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateUserHierarchyStructure) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateUserHierarchyStructure) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateUserHierarchyStructure) 

# UpdateUserIdentityInfo
<a name="API_UpdateUserIdentityInfo"></a>

Updates the identity information for the specified user.

**Important**  
We strongly recommend limiting who has the ability to invoke `UpdateUserIdentityInfo`. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see [Best Practices for Security Profiles](https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html) in the *Amazon Connect Administrator Guide*.

## Request Syntax
<a name="API_UpdateUserIdentityInfo_RequestSyntax"></a>

```
POST /users/InstanceId/UserId/identity-info HTTP/1.1
Content-type: application/json

{
   "IdentityInfo": { 
      "Email": "string",
      "FirstName": "string",
      "LastName": "string",
      "Mobile": "string",
      "SecondaryEmail": "string"
   }
}
```

## URI Request Parameters
<a name="API_UpdateUserIdentityInfo_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateUserIdentityInfo_RequestSyntax) **   <a name="connect-UpdateUserIdentityInfo-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [UserId](#API_UpdateUserIdentityInfo_RequestSyntax) **   <a name="connect-UpdateUserIdentityInfo-request-uri-UserId"></a>
The identifier of the user account.  
Required: Yes

## Request Body
<a name="API_UpdateUserIdentityInfo_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [IdentityInfo](#API_UpdateUserIdentityInfo_RequestSyntax) **   <a name="connect-UpdateUserIdentityInfo-request-IdentityInfo"></a>
The identity information for the user.  
Type: [UserIdentityInfo](API_UserIdentityInfo.md) object  
Required: Yes

## Response Syntax
<a name="API_UpdateUserIdentityInfo_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateUserIdentityInfo_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateUserIdentityInfo_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateUserIdentityInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateUserIdentityInfo) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateUserIdentityInfo) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateUserIdentityInfo) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateUserIdentityInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateUserIdentityInfo) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateUserIdentityInfo) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateUserIdentityInfo) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateUserIdentityInfo) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateUserIdentityInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateUserIdentityInfo) 

# UpdateUserNotificationStatus
<a name="API_UpdateUserNotificationStatus"></a>

Updates the status of a notification for a specific user, such as marking it as read or hidden. Users can only update notification status for notifications that have been sent to them. READ status deprioritizes the notification and greys it out, while HIDDEN status removes it from the notification widget.

## Request Syntax
<a name="API_UpdateUserNotificationStatus_RequestSyntax"></a>

```
POST /users/InstanceId/UserId/notifications/NotificationId HTTP/1.1
x-amz-last-modified-time: LastModifiedTime
x-amz-last-modified-region: LastModifiedRegion
Content-type: application/json

{
   "Status": "string"
}
```

## URI Request Parameters
<a name="API_UpdateUserNotificationStatus_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateUserNotificationStatus_RequestSyntax) **   <a name="connect-UpdateUserNotificationStatus-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [LastModifiedRegion](#API_UpdateUserNotificationStatus_RequestSyntax) **   <a name="connect-UpdateUserNotificationStatus-request-LastModifiedRegion"></a>
The AWS Region where the notification status was last modified. Used for cross-region replication.  
Pattern: `[a-z]{2}(-[a-z]+){1,2}(-[0-9])?` 

 ** [LastModifiedTime](#API_UpdateUserNotificationStatus_RequestSyntax) **   <a name="connect-UpdateUserNotificationStatus-request-LastModifiedTime"></a>
The timestamp when the notification status was last modified. Used for cross-region replication and optimistic locking.

 ** [NotificationId](#API_UpdateUserNotificationStatus_RequestSyntax) **   <a name="connect-UpdateUserNotificationStatus-request-uri-NotificationId"></a>
The unique identifier for the notification.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [UserId](#API_UpdateUserNotificationStatus_RequestSyntax) **   <a name="connect-UpdateUserNotificationStatus-request-uri-UserId"></a>
The identifier of the user whose notification status is being updated.  
Required: Yes

## Request Body
<a name="API_UpdateUserNotificationStatus_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Status](#API_UpdateUserNotificationStatus_RequestSyntax) **   <a name="connect-UpdateUserNotificationStatus-request-Status"></a>
The new status for the notification. Valid values are READ, UNREAD, and HIDDEN.  
Type: String  
Valid Values: `READ | UNREAD | HIDDEN`   
Required: Yes

## Response Syntax
<a name="API_UpdateUserNotificationStatus_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateUserNotificationStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateUserNotificationStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateUserNotificationStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateUserNotificationStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateUserNotificationStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateUserNotificationStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateUserNotificationStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateUserNotificationStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateUserNotificationStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateUserNotificationStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateUserNotificationStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateUserNotificationStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateUserNotificationStatus) 

# UpdateUserPhoneConfig
<a name="API_UpdateUserPhoneConfig"></a>

Updates the phone configuration settings for the specified user.

**Note**  
We recommend using the [UpdateUserConfig](https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateUserConfig.html) API, which supports additional functionality that is not available in the UpdateUserPhoneConfig API, such as voice enhancement settings and per-channel configuration for auto-accept and After Contact Work (ACW) timeouts. In comparison, the UpdateUserPhoneConfig API will always set the same ACW timeouts to all channels the user handles.

## Request Syntax
<a name="API_UpdateUserPhoneConfig_RequestSyntax"></a>

```
POST /users/InstanceId/UserId/phone-config HTTP/1.1
Content-type: application/json

{
   "PhoneConfig": { 
      "AfterContactWorkTimeLimit": number,
      "AutoAccept": boolean,
      "DeskPhoneNumber": "string",
      "PersistentConnection": boolean,
      "PhoneType": "string"
   }
}
```

## URI Request Parameters
<a name="API_UpdateUserPhoneConfig_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateUserPhoneConfig_RequestSyntax) **   <a name="connect-UpdateUserPhoneConfig-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [UserId](#API_UpdateUserPhoneConfig_RequestSyntax) **   <a name="connect-UpdateUserPhoneConfig-request-uri-UserId"></a>
The identifier of the user account.  
Required: Yes

## Request Body
<a name="API_UpdateUserPhoneConfig_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [PhoneConfig](#API_UpdateUserPhoneConfig_RequestSyntax) **   <a name="connect-UpdateUserPhoneConfig-request-PhoneConfig"></a>
Information about phone configuration settings for the user.  
Type: [UserPhoneConfig](API_UserPhoneConfig.md) object  
Required: Yes

## Response Syntax
<a name="API_UpdateUserPhoneConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateUserPhoneConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateUserPhoneConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateUserPhoneConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateUserPhoneConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateUserPhoneConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateUserPhoneConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateUserPhoneConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateUserPhoneConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateUserPhoneConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateUserPhoneConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateUserPhoneConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateUserPhoneConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateUserPhoneConfig) 

# UpdateUserProficiencies
<a name="API_UpdateUserProficiencies"></a>

Updates the properties associated with the proficiencies of a user.

## Request Syntax
<a name="API_UpdateUserProficiencies_RequestSyntax"></a>

```
POST /users/InstanceId/UserId/proficiencies HTTP/1.1
Content-type: application/json

{
   "UserProficiencies": [ 
      { 
         "AttributeName": "string",
         "AttributeValue": "string",
         "Level": number
      }
   ]
}
```

## URI Request Parameters
<a name="API_UpdateUserProficiencies_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateUserProficiencies_RequestSyntax) **   <a name="connect-UpdateUserProficiencies-request-uri-InstanceId"></a>
 The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [UserId](#API_UpdateUserProficiencies_RequestSyntax) **   <a name="connect-UpdateUserProficiencies-request-uri-UserId"></a>
The identifier of the user account.  
Required: Yes

## Request Body
<a name="API_UpdateUserProficiencies_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [UserProficiencies](#API_UpdateUserProficiencies_RequestSyntax) **   <a name="connect-UpdateUserProficiencies-request-UserProficiencies"></a>
The proficiencies to be updated for the user. Proficiencies must first be associated to the user. You can do this using AssociateUserProficiencies API.  
Type: Array of [UserProficiency](API_UserProficiency.md) objects  
Required: Yes

## Response Syntax
<a name="API_UpdateUserProficiencies_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateUserProficiencies_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateUserProficiencies_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateUserProficiencies_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateUserProficiencies) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateUserProficiencies) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateUserProficiencies) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateUserProficiencies) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateUserProficiencies) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateUserProficiencies) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateUserProficiencies) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateUserProficiencies) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateUserProficiencies) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateUserProficiencies) 

# UpdateUserRoutingProfile
<a name="API_UpdateUserRoutingProfile"></a>

Assigns the specified routing profile to the specified user.

## Request Syntax
<a name="API_UpdateUserRoutingProfile_RequestSyntax"></a>

```
POST /users/InstanceId/UserId/routing-profile HTTP/1.1
Content-type: application/json

{
   "RoutingProfileId": "string"
}
```

## URI Request Parameters
<a name="API_UpdateUserRoutingProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateUserRoutingProfile_RequestSyntax) **   <a name="connect-UpdateUserRoutingProfile-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [UserId](#API_UpdateUserRoutingProfile_RequestSyntax) **   <a name="connect-UpdateUserRoutingProfile-request-uri-UserId"></a>
The identifier of the user account.  
Required: Yes

## Request Body
<a name="API_UpdateUserRoutingProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [RoutingProfileId](#API_UpdateUserRoutingProfile_RequestSyntax) **   <a name="connect-UpdateUserRoutingProfile-request-RoutingProfileId"></a>
The identifier of the routing profile for the user.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_UpdateUserRoutingProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateUserRoutingProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateUserRoutingProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateUserRoutingProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateUserRoutingProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateUserRoutingProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateUserRoutingProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateUserRoutingProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateUserRoutingProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateUserRoutingProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateUserRoutingProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateUserRoutingProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateUserRoutingProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateUserRoutingProfile) 

# UpdateUserSecurityProfiles
<a name="API_UpdateUserSecurityProfiles"></a>

Assigns the specified security profiles to the specified user.

## Request Syntax
<a name="API_UpdateUserSecurityProfiles_RequestSyntax"></a>

```
POST /users/InstanceId/UserId/security-profiles HTTP/1.1
Content-type: application/json

{
   "SecurityProfileIds": [ "string" ]
}
```

## URI Request Parameters
<a name="API_UpdateUserSecurityProfiles_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateUserSecurityProfiles_RequestSyntax) **   <a name="connect-UpdateUserSecurityProfiles-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [UserId](#API_UpdateUserSecurityProfiles_RequestSyntax) **   <a name="connect-UpdateUserSecurityProfiles-request-uri-UserId"></a>
The identifier of the user account.  
Required: Yes

## Request Body
<a name="API_UpdateUserSecurityProfiles_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [SecurityProfileIds](#API_UpdateUserSecurityProfiles_RequestSyntax) **   <a name="connect-UpdateUserSecurityProfiles-request-SecurityProfileIds"></a>
The identifiers of the security profiles for the user.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: Yes

## Response Syntax
<a name="API_UpdateUserSecurityProfiles_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateUserSecurityProfiles_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateUserSecurityProfiles_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateUserSecurityProfiles_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateUserSecurityProfiles) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateUserSecurityProfiles) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateUserSecurityProfiles) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateUserSecurityProfiles) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateUserSecurityProfiles) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateUserSecurityProfiles) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateUserSecurityProfiles) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateUserSecurityProfiles) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateUserSecurityProfiles) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateUserSecurityProfiles) 

# UpdateViewContent
<a name="API_UpdateViewContent"></a>

Updates the view content of the given view identifier in the specified Amazon Connect instance.

It performs content validation if `Status` is set to `SAVED` and performs full content validation if `Status` is `PUBLISHED`. Note that the `$SAVED` alias' content will always be updated, but the `$LATEST` alias' content will only be updated if `Status` is `PUBLISHED`.

## Request Syntax
<a name="API_UpdateViewContent_RequestSyntax"></a>

```
POST /views/InstanceId/ViewId HTTP/1.1
Content-type: application/json

{
   "Content": { 
      "Actions": [ "string" ],
      "Template": "string"
   },
   "Status": "string"
}
```

## URI Request Parameters
<a name="API_UpdateViewContent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateViewContent_RequestSyntax) **   <a name="connect-UpdateViewContent-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9\_\-:\/]+$`   
Required: Yes

 ** [ViewId](#API_UpdateViewContent_RequestSyntax) **   <a name="connect-UpdateViewContent-request-uri-ViewId"></a>
The identifier of the view. Both `ViewArn` and `ViewId` can be used.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Pattern: `^[a-zA-Z0-9\_\-:\/$]+$`   
Required: Yes

## Request Body
<a name="API_UpdateViewContent_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Content](#API_UpdateViewContent_RequestSyntax) **   <a name="connect-UpdateViewContent-request-Content"></a>
View content containing all content necessary to render a view except for runtime input data and the runtime input schema, which is auto-generated by this operation.  
The total uncompressed content has a maximum file size of 400kB.  
Type: [ViewInputContent](API_ViewInputContent.md) object  
Required: Yes

 ** [Status](#API_UpdateViewContent_RequestSyntax) **   <a name="connect-UpdateViewContent-request-Status"></a>
Indicates the view status as either `SAVED` or `PUBLISHED`. The `PUBLISHED` status will initiate validation on the content.  
Type: String  
Valid Values: `PUBLISHED | SAVED`   
Required: Yes

## Response Syntax
<a name="API_UpdateViewContent_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "View": { 
      "Arn": "string",
      "Content": { 
         "Actions": [ "string" ],
         "InputSchema": "string",
         "Template": "string"
      },
      "CreatedTime": number,
      "Description": "string",
      "Id": "string",
      "LastModifiedTime": number,
      "Name": "string",
      "Status": "string",
      "Tags": { 
         "string" : "string" 
      },
      "Type": "string",
      "Version": number,
      "VersionDescription": "string",
      "ViewContentSha256": "string"
   }
}
```

## Response Elements
<a name="API_UpdateViewContent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [View](#API_UpdateViewContent_ResponseSyntax) **   <a name="connect-UpdateViewContent-response-View"></a>
A view resource object. Contains metadata and content necessary to render the view.  
Type: [View](API_View.md) object

## Errors
<a name="API_UpdateViewContent_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceInUseException **   
That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.    
 ** ResourceId **   
The identifier for the resource.  
 ** ResourceType **   
The type of resource.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** TooManyRequestsException **   
Displayed when rate-related API limits are exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateViewContent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateViewContent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateViewContent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateViewContent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateViewContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateViewContent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateViewContent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateViewContent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateViewContent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateViewContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateViewContent) 

# UpdateViewMetadata
<a name="API_UpdateViewMetadata"></a>

Updates the view metadata. Note that either `Name` or `Description` must be provided.

## Request Syntax
<a name="API_UpdateViewMetadata_RequestSyntax"></a>

```
POST /views/InstanceId/ViewId/metadata HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string"
}
```

## URI Request Parameters
<a name="API_UpdateViewMetadata_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateViewMetadata_RequestSyntax) **   <a name="connect-UpdateViewMetadata-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^[a-zA-Z0-9\_\-:\/]+$`   
Required: Yes

 ** [ViewId](#API_UpdateViewMetadata_RequestSyntax) **   <a name="connect-UpdateViewMetadata-request-uri-ViewId"></a>
The identifier of the view. Both `ViewArn` and `ViewId` can be used.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Pattern: `^[a-zA-Z0-9\_\-:\/$]+$`   
Required: Yes

## Request Body
<a name="API_UpdateViewMetadata_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateViewMetadata_RequestSyntax) **   <a name="connect-UpdateViewMetadata-request-Description"></a>
The description of the view.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Pattern: `^([\p{L}\p{N}_.:\/=+\-@,()']+[\p{L}\p{Z}\p{N}_.:\/=+\-@,()']*)$`   
Required: No

 ** [Name](#API_UpdateViewMetadata_RequestSyntax) **   <a name="connect-UpdateViewMetadata-request-Name"></a>
The name of the view.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^([\p{L}\p{N}_.:\/=+\-@()']+[\p{L}\p{Z}\p{N}_.:\/=+\-@()']*)$`   
Required: No

## Response Syntax
<a name="API_UpdateViewMetadata_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateViewMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateViewMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceInUseException **   
That resource is already in use (for example, you're trying to add a record with the same name as an existing record). If you are trying to delete a resource (for example, DeleteHoursOfOperation or DeletePredefinedAttribute), remove its reference from related resources and then try again.    
 ** ResourceId **   
The identifier for the resource.  
 ** ResourceType **   
The type of resource.
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** TooManyRequestsException **   
Displayed when rate-related API limits are exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateViewMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateViewMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateViewMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateViewMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateViewMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateViewMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateViewMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateViewMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateViewMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateViewMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateViewMetadata) 

# UpdateWorkspaceMetadata
<a name="API_UpdateWorkspaceMetadata"></a>

Updates the metadata of a workspace, such as its name and description.

## Request Syntax
<a name="API_UpdateWorkspaceMetadata_RequestSyntax"></a>

```
POST /workspaces/InstanceId/WorkspaceId/metadata HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string",
   "Title": "string"
}
```

## URI Request Parameters
<a name="API_UpdateWorkspaceMetadata_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateWorkspaceMetadata_RequestSyntax) **   <a name="connect-UpdateWorkspaceMetadata-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [WorkspaceId](#API_UpdateWorkspaceMetadata_RequestSyntax) **   <a name="connect-UpdateWorkspaceMetadata-request-uri-WorkspaceId"></a>
The identifier of the workspace.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_UpdateWorkspaceMetadata_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateWorkspaceMetadata_RequestSyntax) **   <a name="connect-UpdateWorkspaceMetadata-request-Description"></a>
The description of the workspace.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Pattern: `^[\\P{C}\r\n\t]*$`   
Required: No

 ** [Name](#API_UpdateWorkspaceMetadata_RequestSyntax) **   <a name="connect-UpdateWorkspaceMetadata-request-Name"></a>
The name of the workspace.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Pattern: `.*\\S.*`   
Required: No

 ** [Title](#API_UpdateWorkspaceMetadata_RequestSyntax) **   <a name="connect-UpdateWorkspaceMetadata-request-Title"></a>
The title displayed for the workspace.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 127.  
Pattern: `^[\\P{C}]*$`   
Required: No

## Response Syntax
<a name="API_UpdateWorkspaceMetadata_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateWorkspaceMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateWorkspaceMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateWorkspaceMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateWorkspaceMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateWorkspaceMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateWorkspaceMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateWorkspaceMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateWorkspaceMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateWorkspaceMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateWorkspaceMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateWorkspaceMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateWorkspaceMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateWorkspaceMetadata) 

# UpdateWorkspacePage
<a name="API_UpdateWorkspacePage"></a>

Updates the configuration of a page in a workspace, including the associated view and input data.

## Request Syntax
<a name="API_UpdateWorkspacePage_RequestSyntax"></a>

```
POST /workspaces/InstanceId/WorkspaceId/pages/Page HTTP/1.1
Content-type: application/json

{
   "InputData": "string",
   "NewPage": "string",
   "ResourceArn": "string",
   "Slug": "string"
}
```

## URI Request Parameters
<a name="API_UpdateWorkspacePage_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateWorkspacePage_RequestSyntax) **   <a name="connect-UpdateWorkspacePage-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [Page](#API_UpdateWorkspacePage_RequestSyntax) **   <a name="connect-UpdateWorkspacePage-request-uri-Page"></a>
The current page identifier.  
Length Constraints: Minimum length of 1. Maximum length of 25.  
Pattern: `^(?!\\.$)(?!\\.\\.$)[\\p{L}\\p{Z}\\p{N}\\-_.:=@'|]+$`   
Required: Yes

 ** [WorkspaceId](#API_UpdateWorkspacePage_RequestSyntax) **   <a name="connect-UpdateWorkspacePage-request-uri-WorkspaceId"></a>
The identifier of the workspace.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_UpdateWorkspacePage_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [InputData](#API_UpdateWorkspacePage_RequestSyntax) **   <a name="connect-UpdateWorkspacePage-request-InputData"></a>
A JSON string containing input parameters for the view.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 4096.  
Required: No

 ** [NewPage](#API_UpdateWorkspacePage_RequestSyntax) **   <a name="connect-UpdateWorkspacePage-request-NewPage"></a>
The new page identifier, if changing the page name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 25.  
Pattern: `^(?!\\.$)(?!\\.\\.$)[\\p{L}\\p{Z}\\p{N}\\-_.:=@'|]+$`   
Required: No

 ** [ResourceArn](#API_UpdateWorkspacePage_RequestSyntax) **   <a name="connect-UpdateWorkspacePage-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the view to associate with the page.  
Type: String  
Required: No

 ** [Slug](#API_UpdateWorkspacePage_RequestSyntax) **   <a name="connect-UpdateWorkspacePage-request-Slug"></a>
The URL-friendly identifier for the page.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 63.  
Pattern: `^$|^[\\p{L}\\p{Z}\\p{N}\\-_.:=@'|]{3,}$`   
Required: No

## Response Syntax
<a name="API_UpdateWorkspacePage_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateWorkspacePage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateWorkspacePage_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceConflictException **   
A resource already has that name.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateWorkspacePage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateWorkspacePage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateWorkspacePage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateWorkspacePage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateWorkspacePage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateWorkspacePage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateWorkspacePage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateWorkspacePage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateWorkspacePage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateWorkspacePage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateWorkspacePage) 

# UpdateWorkspaceTheme
<a name="API_UpdateWorkspaceTheme"></a>

Updates the theme configuration for a workspace, including colors and styling.

## Request Syntax
<a name="API_UpdateWorkspaceTheme_RequestSyntax"></a>

```
POST /workspaces/InstanceId/WorkspaceId/theme HTTP/1.1
Content-type: application/json

{
   "Theme": { 
      "Dark": { 
         "Images": { 
            "Logo": { 
               "Default": "string",
               "Favicon": "string"
            }
         },
         "Palette": { 
            "Canvas": { 
               "ActiveBackground": "string",
               "ContainerBackground": "string",
               "PageBackground": "string"
            },
            "Header": { 
               "Background": "string",
               "InvertActionsColors": boolean,
               "Text": "string",
               "TextHover": "string"
            },
            "Navigation": { 
               "Background": "string",
               "InvertActionsColors": boolean,
               "Text": "string",
               "TextActive": "string",
               "TextBackgroundActive": "string",
               "TextBackgroundHover": "string",
               "TextHover": "string"
            },
            "Primary": { 
               "Active": "string",
               "ContrastText": "string",
               "Default": "string"
            }
         },
         "Typography": { 
            "FontFamily": { 
               "Default": "string"
            }
         }
      },
      "Light": { 
         "Images": { 
            "Logo": { 
               "Default": "string",
               "Favicon": "string"
            }
         },
         "Palette": { 
            "Canvas": { 
               "ActiveBackground": "string",
               "ContainerBackground": "string",
               "PageBackground": "string"
            },
            "Header": { 
               "Background": "string",
               "InvertActionsColors": boolean,
               "Text": "string",
               "TextHover": "string"
            },
            "Navigation": { 
               "Background": "string",
               "InvertActionsColors": boolean,
               "Text": "string",
               "TextActive": "string",
               "TextBackgroundActive": "string",
               "TextBackgroundHover": "string",
               "TextHover": "string"
            },
            "Primary": { 
               "Active": "string",
               "ContrastText": "string",
               "Default": "string"
            }
         },
         "Typography": { 
            "FontFamily": { 
               "Default": "string"
            }
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_UpdateWorkspaceTheme_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateWorkspaceTheme_RequestSyntax) **   <a name="connect-UpdateWorkspaceTheme-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [WorkspaceId](#API_UpdateWorkspaceTheme_RequestSyntax) **   <a name="connect-UpdateWorkspaceTheme-request-uri-WorkspaceId"></a>
The identifier of the workspace.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_UpdateWorkspaceTheme_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Theme](#API_UpdateWorkspaceTheme_RequestSyntax) **   <a name="connect-UpdateWorkspaceTheme-request-Theme"></a>
The theme configuration, including color schemes and visual styles.  
Type: [WorkspaceTheme](API_WorkspaceTheme.md) object  
Required: No

## Response Syntax
<a name="API_UpdateWorkspaceTheme_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateWorkspaceTheme_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateWorkspaceTheme_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateWorkspaceTheme_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateWorkspaceTheme) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateWorkspaceTheme) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateWorkspaceTheme) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateWorkspaceTheme) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateWorkspaceTheme) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateWorkspaceTheme) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateWorkspaceTheme) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateWorkspaceTheme) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateWorkspaceTheme) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateWorkspaceTheme) 

# UpdateWorkspaceVisibility
<a name="API_UpdateWorkspaceVisibility"></a>

Updates the visibility setting of a workspace, controlling whether it is available to all users, assigned users only, or none.

## Request Syntax
<a name="API_UpdateWorkspaceVisibility_RequestSyntax"></a>

```
POST /workspaces/InstanceId/WorkspaceId/visibility HTTP/1.1
Content-type: application/json

{
   "Visibility": "string"
}
```

## URI Request Parameters
<a name="API_UpdateWorkspaceVisibility_RequestParameters"></a>

The request uses the following URI parameters.

 ** [InstanceId](#API_UpdateWorkspaceVisibility_RequestSyntax) **   <a name="connect-UpdateWorkspaceVisibility-request-uri-InstanceId"></a>
The identifier of the Amazon Connect instance. You can [find the instance ID](https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html) in the Amazon Resource Name (ARN) of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [WorkspaceId](#API_UpdateWorkspaceVisibility_RequestSyntax) **   <a name="connect-UpdateWorkspaceVisibility-request-uri-WorkspaceId"></a>
The identifier of the workspace.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Request Body
<a name="API_UpdateWorkspaceVisibility_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Visibility](#API_UpdateWorkspaceVisibility_RequestSyntax) **   <a name="connect-UpdateWorkspaceVisibility-request-Visibility"></a>
The visibility setting for the workspace. Valid values are: `ALL` (available to all users), `ASSIGNED` (available only to assigned users and routing profiles), and `NONE` (not visible to any users).  
Type: String  
Valid Values: `ALL | ASSIGNED | NONE`   
Required: Yes

## Response Syntax
<a name="API_UpdateWorkspaceVisibility_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateWorkspaceVisibility_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateWorkspaceVisibility_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed because of an error or failure with the service.    
 ** Message **   
The message.
HTTP Status Code: 500

 ** InvalidParameterException **   
One or more of the specified parameters are not valid.    
 ** Message **   
The message about the parameters.
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is not valid.    
 ** Message **   
The message about the request.  
 ** Reason **   
Reason why the request was invalid.
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.    
 ** Message **   
The message about the resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_UpdateWorkspaceVisibility_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-2017-08-08/UpdateWorkspaceVisibility) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-2017-08-08/UpdateWorkspaceVisibility) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-2017-08-08/UpdateWorkspaceVisibility) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-2017-08-08/UpdateWorkspaceVisibility) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-2017-08-08/UpdateWorkspaceVisibility) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-2017-08-08/UpdateWorkspaceVisibility) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-2017-08-08/UpdateWorkspaceVisibility) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-2017-08-08/UpdateWorkspaceVisibility) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-2017-08-08/UpdateWorkspaceVisibility) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-2017-08-08/UpdateWorkspaceVisibility) 

# Amazon AppIntegrations Service
<a name="API_Operations_Amazon_AppIntegrations_Service"></a>

The following actions are supported by Amazon AppIntegrations Service:
+  [CreateApplication](API_connect-app-integrations_CreateApplication.md) 
+  [CreateDataIntegration](API_connect-app-integrations_CreateDataIntegration.md) 
+  [CreateDataIntegrationAssociation](API_connect-app-integrations_CreateDataIntegrationAssociation.md) 
+  [CreateEventIntegration](API_connect-app-integrations_CreateEventIntegration.md) 
+  [DeleteApplication](API_connect-app-integrations_DeleteApplication.md) 
+  [DeleteDataIntegration](API_connect-app-integrations_DeleteDataIntegration.md) 
+  [DeleteEventIntegration](API_connect-app-integrations_DeleteEventIntegration.md) 
+  [GetApplication](API_connect-app-integrations_GetApplication.md) 
+  [GetDataIntegration](API_connect-app-integrations_GetDataIntegration.md) 
+  [GetEventIntegration](API_connect-app-integrations_GetEventIntegration.md) 
+  [ListApplicationAssociations](API_connect-app-integrations_ListApplicationAssociations.md) 
+  [ListApplications](API_connect-app-integrations_ListApplications.md) 
+  [ListDataIntegrationAssociations](API_connect-app-integrations_ListDataIntegrationAssociations.md) 
+  [ListDataIntegrations](API_connect-app-integrations_ListDataIntegrations.md) 
+  [ListEventIntegrationAssociations](API_connect-app-integrations_ListEventIntegrationAssociations.md) 
+  [ListEventIntegrations](API_connect-app-integrations_ListEventIntegrations.md) 
+  [ListTagsForResource](API_connect-app-integrations_ListTagsForResource.md) 
+  [TagResource](API_connect-app-integrations_TagResource.md) 
+  [UntagResource](API_connect-app-integrations_UntagResource.md) 
+  [UpdateApplication](API_connect-app-integrations_UpdateApplication.md) 
+  [UpdateDataIntegration](API_connect-app-integrations_UpdateDataIntegration.md) 
+  [UpdateDataIntegrationAssociation](API_connect-app-integrations_UpdateDataIntegrationAssociation.md) 
+  [UpdateEventIntegration](API_connect-app-integrations_UpdateEventIntegration.md) 

# CreateApplication
<a name="API_connect-app-integrations_CreateApplication"></a>

Creates and persists an Application resource.

## Request Syntax
<a name="API_connect-app-integrations_CreateApplication_RequestSyntax"></a>

```
POST /applications HTTP/1.1
Content-type: application/json

{
   "ApplicationConfig": { 
      "ContactHandling": { 
         "Scope": "string"
      }
   },
   "ApplicationSourceConfig": { 
      "ExternalUrlConfig": { 
         "AccessUrl": "string",
         "ApprovedOrigins": [ "string" ]
      }
   },
   "ApplicationType": "string",
   "ClientToken": "string",
   "Description": "string",
   "IframeConfig": { 
      "Allow": [ "string" ],
      "Sandbox": [ "string" ]
   },
   "InitializationTimeout": number,
   "IsService": boolean,
   "Name": "string",
   "Namespace": "string",
   "Permissions": [ "string" ],
   "Publications": [ 
      { 
         "Description": "string",
         "Event": "string",
         "Schema": "string"
      }
   ],
   "Subscriptions": [ 
      { 
         "Description": "string",
         "Event": "string"
      }
   ],
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_connect-app-integrations_CreateApplication_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_connect-app-integrations_CreateApplication_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ApplicationConfig](#API_connect-app-integrations_CreateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateApplication-request-ApplicationConfig"></a>
The configuration settings for the application.  
Type: [ApplicationConfig](API_connect-app-integrations_ApplicationConfig.md) object  
Required: No

 ** [ApplicationSourceConfig](#API_connect-app-integrations_CreateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateApplication-request-ApplicationSourceConfig"></a>
The configuration for where the application should be loaded from.  
Type: [ApplicationSourceConfig](API_connect-app-integrations_ApplicationSourceConfig.md) object  
Required: Yes

 ** [ApplicationType](#API_connect-app-integrations_CreateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateApplication-request-ApplicationType"></a>
The type of application.  
Type: String  
Valid Values: `STANDARD | SERVICE | MCP_SERVER`   
Required: No

 ** [ClientToken](#API_connect-app-integrations_CreateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateApplication-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `.*`   
Required: No

 ** [Description](#API_connect-app-integrations_CreateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateApplication-request-Description"></a>
The description of the application.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `.*`   
Required: No

 ** [IframeConfig](#API_connect-app-integrations_CreateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateApplication-request-IframeConfig"></a>
The iframe configuration for the application.  
Type: [IframeConfig](API_connect-app-integrations_IframeConfig.md) object  
Required: No

 ** [InitializationTimeout](#API_connect-app-integrations_CreateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateApplication-request-InitializationTimeout"></a>
The maximum time in milliseconds allowed to establish a connection with the workspace.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 600000.  
Required: No

 ** [IsService](#API_connect-app-integrations_CreateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateApplication-request-IsService"></a>
 *This parameter has been deprecated.*   
Indicates whether the application is a service.  
Type: Boolean  
Required: No

 ** [Name](#API_connect-app-integrations_CreateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateApplication-request-Name"></a>
The name of the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9\/\._ \-]+$`   
Required: Yes

 ** [Namespace](#API_connect-app-integrations_CreateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateApplication-request-Namespace"></a>
The namespace of the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 211.  
Pattern: `^[a-zA-Z0-9\/\._\-]+$`   
Required: Yes

 ** [Permissions](#API_connect-app-integrations_CreateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateApplication-request-Permissions"></a>
The configuration of events or requests that the application has access to.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 150 items.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9\/\._\-\*]+$`   
Required: No

 ** [Publications](#API_connect-app-integrations_CreateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateApplication-request-Publications"></a>
 *This parameter has been deprecated.*   
The events that the application publishes.  
Type: Array of [Publication](API_connect-app-integrations_Publication.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** [Subscriptions](#API_connect-app-integrations_CreateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateApplication-request-Subscriptions"></a>
 *This parameter has been deprecated.*   
The events that the application subscribes.  
Type: Array of [Subscription](API_connect-app-integrations_Subscription.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** [Tags](#API_connect-app-integrations_CreateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateApplication-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_connect-app-integrations_CreateApplication_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Id": "string"
}
```

## Response Elements
<a name="API_connect-app-integrations_CreateApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_connect-app-integrations_CreateApplication_ResponseSyntax) **   <a name="connect-connect-app-integrations_CreateApplication-response-Arn"></a>
The Amazon Resource Name (ARN) of the Application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$` 

 ** [Id](#API_connect-app-integrations_CreateApplication_ResponseSyntax) **   <a name="connect-connect-app-integrations_CreateApplication-response-Id"></a>
A unique identifier for the Application.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

## Errors
<a name="API_connect-app-integrations_CreateApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ResourceQuotaExceededException **   
The allowed quota for the resource has been exceeded.  
HTTP Status Code: 429

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnsupportedOperationException **   
The operation is not supported.  
HTTP Status Code: 400

## See Also
<a name="API_connect-app-integrations_CreateApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/CreateApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/CreateApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/CreateApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/CreateApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/CreateApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/CreateApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/CreateApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/CreateApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/CreateApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/CreateApplication) 

# CreateDataIntegration
<a name="API_connect-app-integrations_CreateDataIntegration"></a>

Creates and persists a DataIntegration resource.

**Note**  
You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the `CreateDataIntegration` API.

## Request Syntax
<a name="API_connect-app-integrations_CreateDataIntegration_RequestSyntax"></a>

```
POST /dataIntegrations HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "Description": "string",
   "FileConfiguration": { 
      "Filters": { 
         "string" : [ "string" ]
      },
      "Folders": [ "string" ]
   },
   "KmsKey": "string",
   "Name": "string",
   "ObjectConfiguration": { 
      "string" : { 
         "string" : [ "string" ]
      }
   },
   "ScheduleConfig": { 
      "FirstExecutionFrom": "string",
      "Object": "string",
      "ScheduleExpression": "string"
   },
   "SourceURI": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_connect-app-integrations_CreateDataIntegration_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_connect-app-integrations_CreateDataIntegration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_connect-app-integrations_CreateDataIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegration-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `.*`   
Required: No

 ** [Description](#API_connect-app-integrations_CreateDataIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegration-request-Description"></a>
A description of the DataIntegration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `.*`   
Required: No

 ** [FileConfiguration](#API_connect-app-integrations_CreateDataIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegration-request-FileConfiguration"></a>
The configuration for what files should be pulled from the source.  
Type: [FileConfiguration](API_connect-app-integrations_FileConfiguration.md) object  
Required: No

 ** [KmsKey](#API_connect-app-integrations_CreateDataIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegration-request-KmsKey"></a>
The KMS key ARN for the DataIntegration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `.*\S.*`   
Required: Yes

 ** [Name](#API_connect-app-integrations_CreateDataIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegration-request-Name"></a>
The name of the DataIntegration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9\/\._\-]+$`   
Required: Yes

 ** [ObjectConfiguration](#API_connect-app-integrations_CreateDataIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegration-request-ObjectConfiguration"></a>
The configuration for what data should be pulled from the source.  
Type: String to string to array of strings map map  
Key Length Constraints: Minimum length of 1. Maximum length of 255.  
Key Pattern: `.*\S.*`   
Key Length Constraints: Minimum length of 1. Maximum length of 255.  
Key Pattern: `.*\S.*`   
Array Members: Minimum number of 1 item. Maximum number of 2048 items.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9\/\._\-]+$`   
Required: No

 ** [ScheduleConfig](#API_connect-app-integrations_CreateDataIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegration-request-ScheduleConfig"></a>
The name of the data and how often it should be pulled from the source.  
Type: [ScheduleConfiguration](API_connect-app-integrations_ScheduleConfiguration.md) object  
Required: No

 ** [SourceURI](#API_connect-app-integrations_CreateDataIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegration-request-SourceURI"></a>
The URI of the data source.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `^(\w+\:\/\/[\w.-]+[\w/!@#+=.-]+$)|(\w+\:\/\/[\w.-]+[\w/!@#+=.-]+[\w/!@#+=.-]+[\w/!@#+=.,-]+$)`   
Required: No

 ** [Tags](#API_connect-app-integrations_CreateDataIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegration-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_connect-app-integrations_CreateDataIntegration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "ClientToken": "string",
   "Description": "string",
   "FileConfiguration": { 
      "Filters": { 
         "string" : [ "string" ]
      },
      "Folders": [ "string" ]
   },
   "Id": "string",
   "KmsKey": "string",
   "Name": "string",
   "ObjectConfiguration": { 
      "string" : { 
         "string" : [ "string" ]
      }
   },
   "ScheduleConfiguration": { 
      "FirstExecutionFrom": "string",
      "Object": "string",
      "ScheduleExpression": "string"
   },
   "SourceURI": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-app-integrations_CreateDataIntegration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_connect-app-integrations_CreateDataIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegration-response-Arn"></a>
The Amazon Resource Name (ARN)  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$` 

 ** [ClientToken](#API_connect-app-integrations_CreateDataIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegration-response-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `.*` 

 ** [Description](#API_connect-app-integrations_CreateDataIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegration-response-Description"></a>
A description of the DataIntegration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `.*` 

 ** [FileConfiguration](#API_connect-app-integrations_CreateDataIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegration-response-FileConfiguration"></a>
The configuration for what files should be pulled from the source.  
Type: [FileConfiguration](API_connect-app-integrations_FileConfiguration.md) object

 ** [Id](#API_connect-app-integrations_CreateDataIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegration-response-Id"></a>
A unique identifier.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [KmsKey](#API_connect-app-integrations_CreateDataIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegration-response-KmsKey"></a>
The KMS key ARN for the DataIntegration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `.*\S.*` 

 ** [Name](#API_connect-app-integrations_CreateDataIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegration-response-Name"></a>
The name of the DataIntegration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9\/\._\-]+$` 

 ** [ObjectConfiguration](#API_connect-app-integrations_CreateDataIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegration-response-ObjectConfiguration"></a>
The configuration for what data should be pulled from the source.  
Type: String to string to array of strings map map  
Key Length Constraints: Minimum length of 1. Maximum length of 255.  
Key Pattern: `.*\S.*`   
Key Length Constraints: Minimum length of 1. Maximum length of 255.  
Key Pattern: `.*\S.*`   
Array Members: Minimum number of 1 item. Maximum number of 2048 items.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9\/\._\-]+$` 

 ** [ScheduleConfiguration](#API_connect-app-integrations_CreateDataIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegration-response-ScheduleConfiguration"></a>
The name of the data and how often it should be pulled from the source.  
Type: [ScheduleConfiguration](API_connect-app-integrations_ScheduleConfiguration.md) object

 ** [SourceURI](#API_connect-app-integrations_CreateDataIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegration-response-SourceURI"></a>
The URI of the data source.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `^(\w+\:\/\/[\w.-]+[\w/!@#+=.-]+$)|(\w+\:\/\/[\w.-]+[\w/!@#+=.-]+[\w/!@#+=.-]+[\w/!@#+=.,-]+$)` 

 ** [Tags](#API_connect-app-integrations_CreateDataIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegration-response-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_connect-app-integrations_CreateDataIntegration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ResourceQuotaExceededException **   
The allowed quota for the resource has been exceeded.  
HTTP Status Code: 429

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_connect-app-integrations_CreateDataIntegration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/CreateDataIntegration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/CreateDataIntegration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/CreateDataIntegration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/CreateDataIntegration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/CreateDataIntegration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/CreateDataIntegration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/CreateDataIntegration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/CreateDataIntegration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/CreateDataIntegration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/CreateDataIntegration) 

# CreateDataIntegrationAssociation
<a name="API_connect-app-integrations_CreateDataIntegrationAssociation"></a>

Creates and persists a DataIntegrationAssociation resource.

## Request Syntax
<a name="API_connect-app-integrations_CreateDataIntegrationAssociation_RequestSyntax"></a>

```
POST /dataIntegrations/Identifier/associations HTTP/1.1
Content-type: application/json

{
   "ClientAssociationMetadata": { 
      "string" : "string" 
   },
   "ClientId": "string",
   "ClientToken": "string",
   "DestinationURI": "string",
   "ExecutionConfiguration": { 
      "ExecutionMode": "string",
      "OnDemandConfiguration": { 
         "EndTime": "string",
         "StartTime": "string"
      },
      "ScheduleConfiguration": { 
         "FirstExecutionFrom": "string",
         "Object": "string",
         "ScheduleExpression": "string"
      }
   },
   "ObjectConfiguration": { 
      "string" : { 
         "string" : [ "string" ]
      }
   }
}
```

## URI Request Parameters
<a name="API_connect-app-integrations_CreateDataIntegrationAssociation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [Identifier](#API_connect-app-integrations_CreateDataIntegrationAssociation_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegrationAssociation-request-uri-DataIntegrationIdentifier"></a>
A unique identifier for the DataIntegration.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_connect-app-integrations_CreateDataIntegrationAssociation_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientAssociationMetadata](#API_connect-app-integrations_CreateDataIntegrationAssociation_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegrationAssociation-request-ClientAssociationMetadata"></a>
The mapping of metadata to be extracted from the data.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 255.  
Key Pattern: `.*\S.*`   
Value Length Constraints: Minimum length of 1. Maximum length of 255.  
Value Pattern: `.*\S.*`   
Required: No

 ** [ClientId](#API_connect-app-integrations_CreateDataIntegrationAssociation_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegrationAssociation-request-ClientId"></a>
The identifier for the client that is associated with the DataIntegration association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `.*`   
Required: No

 ** [ClientToken](#API_connect-app-integrations_CreateDataIntegrationAssociation_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegrationAssociation-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `.*`   
Required: No

 ** [DestinationURI](#API_connect-app-integrations_CreateDataIntegrationAssociation_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegrationAssociation-request-DestinationURI"></a>
The URI of the data destination.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `^(\w+\:\/\/[\w.-]+[\w/!@#+=.-]+$)|(\w+\:\/\/[\w.-]+[\w/!@#+=.-]+[\w/!@#+=.-]+[\w/!@#+=.,-]+$)`   
Required: No

 ** [ExecutionConfiguration](#API_connect-app-integrations_CreateDataIntegrationAssociation_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegrationAssociation-request-ExecutionConfiguration"></a>
The configuration for how the files should be pulled from the source.  
Type: [ExecutionConfiguration](API_connect-app-integrations_ExecutionConfiguration.md) object  
Required: No

 ** [ObjectConfiguration](#API_connect-app-integrations_CreateDataIntegrationAssociation_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegrationAssociation-request-ObjectConfiguration"></a>
The configuration for what data should be pulled from the source.  
Type: String to string to array of strings map map  
Key Length Constraints: Minimum length of 1. Maximum length of 255.  
Key Pattern: `.*\S.*`   
Key Length Constraints: Minimum length of 1. Maximum length of 255.  
Key Pattern: `.*\S.*`   
Array Members: Minimum number of 1 item. Maximum number of 2048 items.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9\/\._\-]+$`   
Required: No

## Response Syntax
<a name="API_connect-app-integrations_CreateDataIntegrationAssociation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DataIntegrationArn": "string",
   "DataIntegrationAssociationId": "string"
}
```

## Response Elements
<a name="API_connect-app-integrations_CreateDataIntegrationAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DataIntegrationArn](#API_connect-app-integrations_CreateDataIntegrationAssociation_ResponseSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegrationAssociation-response-DataIntegrationArn"></a>
The Amazon Resource Name (ARN) for the DataIntegration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$` 

 ** [DataIntegrationAssociationId](#API_connect-app-integrations_CreateDataIntegrationAssociation_ResponseSyntax) **   <a name="connect-connect-app-integrations_CreateDataIntegrationAssociation-response-DataIntegrationAssociationId"></a>
A unique identifier. for the DataIntegrationAssociation.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

## Errors
<a name="API_connect-app-integrations_CreateDataIntegrationAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 404

 ** ResourceQuotaExceededException **   
The allowed quota for the resource has been exceeded.  
HTTP Status Code: 429

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_connect-app-integrations_CreateDataIntegrationAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/CreateDataIntegrationAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/CreateDataIntegrationAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/CreateDataIntegrationAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/CreateDataIntegrationAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/CreateDataIntegrationAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/CreateDataIntegrationAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/CreateDataIntegrationAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/CreateDataIntegrationAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/CreateDataIntegrationAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/CreateDataIntegrationAssociation) 

# CreateEventIntegration
<a name="API_connect-app-integrations_CreateEventIntegration"></a>

Creates an EventIntegration, given a specified name, description, and a reference to an Amazon EventBridge bus in your account and a partner event source that pushes events to that bus. No objects are created in the your account, only metadata that is persisted on the EventIntegration control plane.

## Request Syntax
<a name="API_connect-app-integrations_CreateEventIntegration_RequestSyntax"></a>

```
POST /eventIntegrations HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "Description": "string",
   "EventBridgeBus": "string",
   "EventFilter": { 
      "Source": "string"
   },
   "Name": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_connect-app-integrations_CreateEventIntegration_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_connect-app-integrations_CreateEventIntegration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_connect-app-integrations_CreateEventIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateEventIntegration-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `.*`   
Required: No

 ** [Description](#API_connect-app-integrations_CreateEventIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateEventIntegration-request-Description"></a>
The description of the event integration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `.*`   
Required: No

 ** [EventBridgeBus](#API_connect-app-integrations_CreateEventIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateEventIntegration-request-EventBridgeBus"></a>
The EventBridge bus.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9\/\._\-]+$`   
Required: Yes

 ** [EventFilter](#API_connect-app-integrations_CreateEventIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateEventIntegration-request-EventFilter"></a>
The event filter.  
Type: [EventFilter](API_connect-app-integrations_EventFilter.md) object  
Required: Yes

 ** [Name](#API_connect-app-integrations_CreateEventIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateEventIntegration-request-Name"></a>
The name of the event integration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9\/\._\-]+$`   
Required: Yes

 ** [Tags](#API_connect-app-integrations_CreateEventIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_CreateEventIntegration-request-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_connect-app-integrations_CreateEventIntegration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EventIntegrationArn": "string"
}
```

## Response Elements
<a name="API_connect-app-integrations_CreateEventIntegration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EventIntegrationArn](#API_connect-app-integrations_CreateEventIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_CreateEventIntegration-response-EventIntegrationArn"></a>
The Amazon Resource Name (ARN) of the event integration.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$` 

## Errors
<a name="API_connect-app-integrations_CreateEventIntegration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** DuplicateResourceException **   
A resource with the specified name already exists.  
HTTP Status Code: 409

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ResourceQuotaExceededException **   
The allowed quota for the resource has been exceeded.  
HTTP Status Code: 429

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_connect-app-integrations_CreateEventIntegration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/CreateEventIntegration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/CreateEventIntegration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/CreateEventIntegration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/CreateEventIntegration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/CreateEventIntegration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/CreateEventIntegration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/CreateEventIntegration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/CreateEventIntegration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/CreateEventIntegration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/CreateEventIntegration) 

# DeleteApplication
<a name="API_connect-app-integrations_DeleteApplication"></a>

Deletes the Application. Only Applications that don't have any Application Associations can be deleted.

## Request Syntax
<a name="API_connect-app-integrations_DeleteApplication_RequestSyntax"></a>

```
DELETE /applications/ApplicationIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-app-integrations_DeleteApplication_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationIdentifier](#API_connect-app-integrations_DeleteApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_DeleteApplication-request-uri-Arn"></a>
The Amazon Resource Name (ARN) of the Application.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}|[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})(:[\w\$]+)?$`   
Required: Yes

## Request Body
<a name="API_connect-app-integrations_DeleteApplication_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-app-integrations_DeleteApplication_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-app-integrations_DeleteApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-app-integrations_DeleteApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_connect-app-integrations_DeleteApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/DeleteApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/DeleteApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/DeleteApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/DeleteApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/DeleteApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/DeleteApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/DeleteApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/DeleteApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/DeleteApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/DeleteApplication) 

# DeleteDataIntegration
<a name="API_connect-app-integrations_DeleteDataIntegration"></a>

Deletes the DataIntegration. Only DataIntegrations that don't have any DataIntegrationAssociations can be deleted. Deleting a DataIntegration also deletes the underlying Amazon AppFlow flow and service linked role. 

**Note**  
You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the [CreateDataIntegration](https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) API.

## Request Syntax
<a name="API_connect-app-integrations_DeleteDataIntegration_RequestSyntax"></a>

```
DELETE /dataIntegrations/Identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-app-integrations_DeleteDataIntegration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [Identifier](#API_connect-app-integrations_DeleteDataIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_DeleteDataIntegration-request-uri-DataIntegrationIdentifier"></a>
A unique identifier for the DataIntegration.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_connect-app-integrations_DeleteDataIntegration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-app-integrations_DeleteDataIntegration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-app-integrations_DeleteDataIntegration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-app-integrations_DeleteDataIntegration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_connect-app-integrations_DeleteDataIntegration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/DeleteDataIntegration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/DeleteDataIntegration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/DeleteDataIntegration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/DeleteDataIntegration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/DeleteDataIntegration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/DeleteDataIntegration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/DeleteDataIntegration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/DeleteDataIntegration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/DeleteDataIntegration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/DeleteDataIntegration) 

# DeleteEventIntegration
<a name="API_connect-app-integrations_DeleteEventIntegration"></a>

Deletes the specified existing event integration. If the event integration is associated with clients, the request is rejected.

## Request Syntax
<a name="API_connect-app-integrations_DeleteEventIntegration_RequestSyntax"></a>

```
DELETE /eventIntegrations/Name HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-app-integrations_DeleteEventIntegration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [Name](#API_connect-app-integrations_DeleteEventIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_DeleteEventIntegration-request-uri-Name"></a>
The name of the event integration.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9\/\._\-]+$`   
Required: Yes

## Request Body
<a name="API_connect-app-integrations_DeleteEventIntegration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-app-integrations_DeleteEventIntegration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-app-integrations_DeleteEventIntegration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-app-integrations_DeleteEventIntegration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_connect-app-integrations_DeleteEventIntegration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/DeleteEventIntegration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/DeleteEventIntegration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/DeleteEventIntegration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/DeleteEventIntegration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/DeleteEventIntegration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/DeleteEventIntegration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/DeleteEventIntegration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/DeleteEventIntegration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/DeleteEventIntegration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/DeleteEventIntegration) 

# GetApplication
<a name="API_connect-app-integrations_GetApplication"></a>

Get an Application resource.

## Request Syntax
<a name="API_connect-app-integrations_GetApplication_RequestSyntax"></a>

```
GET /applications/ApplicationIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-app-integrations_GetApplication_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationIdentifier](#API_connect-app-integrations_GetApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_GetApplication-request-uri-Arn"></a>
The Amazon Resource Name (ARN) of the Application.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}|[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})(:[\w\$]+)?$`   
Required: Yes

## Request Body
<a name="API_connect-app-integrations_GetApplication_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-app-integrations_GetApplication_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApplicationConfig": { 
      "ContactHandling": { 
         "Scope": "string"
      }
   },
   "ApplicationSourceConfig": { 
      "ExternalUrlConfig": { 
         "AccessUrl": "string",
         "ApprovedOrigins": [ "string" ]
      }
   },
   "ApplicationType": "string",
   "Arn": "string",
   "CreatedTime": number,
   "Description": "string",
   "Id": "string",
   "IframeConfig": { 
      "Allow": [ "string" ],
      "Sandbox": [ "string" ]
   },
   "InitializationTimeout": number,
   "IsService": boolean,
   "LastModifiedTime": number,
   "Name": "string",
   "Namespace": "string",
   "Permissions": [ "string" ],
   "Publications": [ 
      { 
         "Description": "string",
         "Event": "string",
         "Schema": "string"
      }
   ],
   "Subscriptions": [ 
      { 
         "Description": "string",
         "Event": "string"
      }
   ],
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-app-integrations_GetApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApplicationConfig](#API_connect-app-integrations_GetApplication_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetApplication-response-ApplicationConfig"></a>
The configuration settings for the application.  
Type: [ApplicationConfig](API_connect-app-integrations_ApplicationConfig.md) object

 ** [ApplicationSourceConfig](#API_connect-app-integrations_GetApplication_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetApplication-response-ApplicationSourceConfig"></a>
The configuration for where the application should be loaded from.  
Type: [ApplicationSourceConfig](API_connect-app-integrations_ApplicationSourceConfig.md) object

 ** [ApplicationType](#API_connect-app-integrations_GetApplication_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetApplication-response-ApplicationType"></a>
The type of application.  
Type: String  
Valid Values: `STANDARD | SERVICE | MCP_SERVER` 

 ** [Arn](#API_connect-app-integrations_GetApplication_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetApplication-response-Arn"></a>
The Amazon Resource Name (ARN) of the Application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$` 

 ** [CreatedTime](#API_connect-app-integrations_GetApplication_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetApplication-response-CreatedTime"></a>
The created time of the Application.  
Type: Timestamp

 ** [Description](#API_connect-app-integrations_GetApplication_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetApplication-response-Description"></a>
The description of the application.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `.*` 

 ** [Id](#API_connect-app-integrations_GetApplication_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetApplication-response-Id"></a>
A unique identifier for the Application.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [IframeConfig](#API_connect-app-integrations_GetApplication_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetApplication-response-IframeConfig"></a>
The iframe configuration for the application.  
Type: [IframeConfig](API_connect-app-integrations_IframeConfig.md) object

 ** [InitializationTimeout](#API_connect-app-integrations_GetApplication_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetApplication-response-InitializationTimeout"></a>
The maximum time in milliseconds allowed to establish a connection with the workspace.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 600000.

 ** [IsService](#API_connect-app-integrations_GetApplication_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetApplication-response-IsService"></a>
 *This parameter has been deprecated.*   
Indicates whether the application is a service.  
Type: Boolean

 ** [LastModifiedTime](#API_connect-app-integrations_GetApplication_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetApplication-response-LastModifiedTime"></a>
The last modified time of the Application.  
Type: Timestamp

 ** [Name](#API_connect-app-integrations_GetApplication_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetApplication-response-Name"></a>
The name of the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9\/\._ \-]+$` 

 ** [Namespace](#API_connect-app-integrations_GetApplication_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetApplication-response-Namespace"></a>
The namespace of the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 211.  
Pattern: `^[a-zA-Z0-9\/\._\-]+$` 

 ** [Permissions](#API_connect-app-integrations_GetApplication_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetApplication-response-Permissions"></a>
The configuration of events or requests that the application has access to.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 150 items.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9\/\._\-\*]+$` 

 ** [Publications](#API_connect-app-integrations_GetApplication_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetApplication-response-Publications"></a>
 *This parameter has been deprecated.*   
The events that the application publishes.  
Type: Array of [Publication](API_connect-app-integrations_Publication.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.

 ** [Subscriptions](#API_connect-app-integrations_GetApplication_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetApplication-response-Subscriptions"></a>
 *This parameter has been deprecated.*   
The events that the application subscribes.  
Type: Array of [Subscription](API_connect-app-integrations_Subscription.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.

 ** [Tags](#API_connect-app-integrations_GetApplication_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetApplication-response-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_connect-app-integrations_GetApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_connect-app-integrations_GetApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/GetApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/GetApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/GetApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/GetApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/GetApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/GetApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/GetApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/GetApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/GetApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/GetApplication) 

# GetDataIntegration
<a name="API_connect-app-integrations_GetDataIntegration"></a>

Returns information about the DataIntegration.

**Note**  
You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the [CreateDataIntegration](https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) API.

## Request Syntax
<a name="API_connect-app-integrations_GetDataIntegration_RequestSyntax"></a>

```
GET /dataIntegrations/Identifier HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-app-integrations_GetDataIntegration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [Identifier](#API_connect-app-integrations_GetDataIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_GetDataIntegration-request-uri-Identifier"></a>
A unique identifier.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_connect-app-integrations_GetDataIntegration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-app-integrations_GetDataIntegration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Description": "string",
   "FileConfiguration": { 
      "Filters": { 
         "string" : [ "string" ]
      },
      "Folders": [ "string" ]
   },
   "Id": "string",
   "KmsKey": "string",
   "Name": "string",
   "ObjectConfiguration": { 
      "string" : { 
         "string" : [ "string" ]
      }
   },
   "ScheduleConfiguration": { 
      "FirstExecutionFrom": "string",
      "Object": "string",
      "ScheduleExpression": "string"
   },
   "SourceURI": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-app-integrations_GetDataIntegration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_connect-app-integrations_GetDataIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetDataIntegration-response-Arn"></a>
The Amazon Resource Name (ARN) for the DataIntegration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$` 

 ** [Description](#API_connect-app-integrations_GetDataIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetDataIntegration-response-Description"></a>
The KMS key ARN for the DataIntegration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `.*` 

 ** [FileConfiguration](#API_connect-app-integrations_GetDataIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetDataIntegration-response-FileConfiguration"></a>
The configuration for what files should be pulled from the source.  
Type: [FileConfiguration](API_connect-app-integrations_FileConfiguration.md) object

 ** [Id](#API_connect-app-integrations_GetDataIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetDataIntegration-response-Id"></a>
A unique identifier.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [KmsKey](#API_connect-app-integrations_GetDataIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetDataIntegration-response-KmsKey"></a>
The KMS key ARN for the DataIntegration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `.*\S.*` 

 ** [Name](#API_connect-app-integrations_GetDataIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetDataIntegration-response-Name"></a>
The name of the DataIntegration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9\/\._\-]+$` 

 ** [ObjectConfiguration](#API_connect-app-integrations_GetDataIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetDataIntegration-response-ObjectConfiguration"></a>
The configuration for what data should be pulled from the source.  
Type: String to string to array of strings map map  
Key Length Constraints: Minimum length of 1. Maximum length of 255.  
Key Pattern: `.*\S.*`   
Key Length Constraints: Minimum length of 1. Maximum length of 255.  
Key Pattern: `.*\S.*`   
Array Members: Minimum number of 1 item. Maximum number of 2048 items.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9\/\._\-]+$` 

 ** [ScheduleConfiguration](#API_connect-app-integrations_GetDataIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetDataIntegration-response-ScheduleConfiguration"></a>
The name of the data and how often it should be pulled from the source.  
Type: [ScheduleConfiguration](API_connect-app-integrations_ScheduleConfiguration.md) object

 ** [SourceURI](#API_connect-app-integrations_GetDataIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetDataIntegration-response-SourceURI"></a>
The URI of the data source.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `^(\w+\:\/\/[\w.-]+[\w/!@#+=.-]+$)|(\w+\:\/\/[\w.-]+[\w/!@#+=.-]+[\w/!@#+=.-]+[\w/!@#+=.,-]+$)` 

 ** [Tags](#API_connect-app-integrations_GetDataIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetDataIntegration-response-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_connect-app-integrations_GetDataIntegration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_connect-app-integrations_GetDataIntegration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/GetDataIntegration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/GetDataIntegration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/GetDataIntegration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/GetDataIntegration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/GetDataIntegration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/GetDataIntegration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/GetDataIntegration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/GetDataIntegration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/GetDataIntegration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/GetDataIntegration) 

# GetEventIntegration
<a name="API_connect-app-integrations_GetEventIntegration"></a>

Returns information about the event integration.

## Request Syntax
<a name="API_connect-app-integrations_GetEventIntegration_RequestSyntax"></a>

```
GET /eventIntegrations/Name HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-app-integrations_GetEventIntegration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [Name](#API_connect-app-integrations_GetEventIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_GetEventIntegration-request-uri-Name"></a>
The name of the event integration.   
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9\/\._\-]+$`   
Required: Yes

## Request Body
<a name="API_connect-app-integrations_GetEventIntegration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-app-integrations_GetEventIntegration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Description": "string",
   "EventBridgeBus": "string",
   "EventFilter": { 
      "Source": "string"
   },
   "EventIntegrationArn": "string",
   "Name": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-app-integrations_GetEventIntegration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Description](#API_connect-app-integrations_GetEventIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetEventIntegration-response-Description"></a>
The description of the event integration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `.*` 

 ** [EventBridgeBus](#API_connect-app-integrations_GetEventIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetEventIntegration-response-EventBridgeBus"></a>
The EventBridge bus.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9\/\._\-]+$` 

 ** [EventFilter](#API_connect-app-integrations_GetEventIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetEventIntegration-response-EventFilter"></a>
The event filter.  
Type: [EventFilter](API_connect-app-integrations_EventFilter.md) object

 ** [EventIntegrationArn](#API_connect-app-integrations_GetEventIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetEventIntegration-response-EventIntegrationArn"></a>
The Amazon Resource Name (ARN) for the event integration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$` 

 ** [Name](#API_connect-app-integrations_GetEventIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetEventIntegration-response-Name"></a>
The name of the event integration.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9\/\._\-]+$` 

 ** [Tags](#API_connect-app-integrations_GetEventIntegration_ResponseSyntax) **   <a name="connect-connect-app-integrations_GetEventIntegration-response-Tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_connect-app-integrations_GetEventIntegration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_connect-app-integrations_GetEventIntegration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/GetEventIntegration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/GetEventIntegration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/GetEventIntegration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/GetEventIntegration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/GetEventIntegration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/GetEventIntegration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/GetEventIntegration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/GetEventIntegration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/GetEventIntegration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/GetEventIntegration) 

# ListApplicationAssociations
<a name="API_connect-app-integrations_ListApplicationAssociations"></a>

Returns a paginated list of application associations for an application.

## Request Syntax
<a name="API_connect-app-integrations_ListApplicationAssociations_RequestSyntax"></a>

```
GET /applications/ApplicationIdentifier/associations?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-app-integrations_ListApplicationAssociations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationIdentifier](#API_connect-app-integrations_ListApplicationAssociations_RequestSyntax) **   <a name="connect-connect-app-integrations_ListApplicationAssociations-request-uri-ApplicationId"></a>
A unique identifier for the Application.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}|[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})(:[\w\$]+)?$`   
Required: Yes

 ** [MaxResults](#API_connect-app-integrations_ListApplicationAssociations_RequestSyntax) **   <a name="connect-connect-app-integrations_ListApplicationAssociations-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_connect-app-integrations_ListApplicationAssociations_RequestSyntax) **   <a name="connect-connect-app-integrations_ListApplicationAssociations-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `.*` 

## Request Body
<a name="API_connect-app-integrations_ListApplicationAssociations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-app-integrations_ListApplicationAssociations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ApplicationAssociations": [ 
      { 
         "ApplicationArn": "string",
         "ApplicationAssociationArn": "string",
         "ClientId": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-app-integrations_ListApplicationAssociations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApplicationAssociations](#API_connect-app-integrations_ListApplicationAssociations_ResponseSyntax) **   <a name="connect-connect-app-integrations_ListApplicationAssociations-response-ApplicationAssociations"></a>
List of Application Associations for the Application.  
Type: Array of [ApplicationAssociationSummary](API_connect-app-integrations_ApplicationAssociationSummary.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.

 ** [NextToken](#API_connect-app-integrations_ListApplicationAssociations_ResponseSyntax) **   <a name="connect-connect-app-integrations_ListApplicationAssociations-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `.*` 

## Errors
<a name="API_connect-app-integrations_ListApplicationAssociations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_connect-app-integrations_ListApplicationAssociations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/ListApplicationAssociations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/ListApplicationAssociations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/ListApplicationAssociations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/ListApplicationAssociations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/ListApplicationAssociations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/ListApplicationAssociations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/ListApplicationAssociations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/ListApplicationAssociations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/ListApplicationAssociations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/ListApplicationAssociations) 

# ListApplications
<a name="API_connect-app-integrations_ListApplications"></a>

Lists applications in the account.

## Request Syntax
<a name="API_connect-app-integrations_ListApplications_RequestSyntax"></a>

```
GET /applications?applicationType=ApplicationType&maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-app-integrations_ListApplications_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationType](#API_connect-app-integrations_ListApplications_RequestSyntax) **   <a name="connect-connect-app-integrations_ListApplications-request-uri-ApplicationType"></a>
The type of application.  
Valid Values: `STANDARD | SERVICE | MCP_SERVER` 

 ** [MaxResults](#API_connect-app-integrations_ListApplications_RequestSyntax) **   <a name="connect-connect-app-integrations_ListApplications-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_connect-app-integrations_ListApplications_RequestSyntax) **   <a name="connect-connect-app-integrations_ListApplications-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `.*` 

## Request Body
<a name="API_connect-app-integrations_ListApplications_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-app-integrations_ListApplications_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Applications": [ 
      { 
         "ApplicationType": "string",
         "Arn": "string",
         "CreatedTime": number,
         "Id": "string",
         "IsService": boolean,
         "LastModifiedTime": number,
         "Name": "string",
         "Namespace": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-app-integrations_ListApplications_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Applications](#API_connect-app-integrations_ListApplications_ResponseSyntax) **   <a name="connect-connect-app-integrations_ListApplications-response-Applications"></a>
The Applications associated with this account.  
Type: Array of [ApplicationSummary](API_connect-app-integrations_ApplicationSummary.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.

 ** [NextToken](#API_connect-app-integrations_ListApplications_ResponseSyntax) **   <a name="connect-connect-app-integrations_ListApplications-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `.*` 

## Errors
<a name="API_connect-app-integrations_ListApplications_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_connect-app-integrations_ListApplications_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/ListApplications) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/ListApplications) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/ListApplications) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/ListApplications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/ListApplications) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/ListApplications) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/ListApplications) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/ListApplications) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/ListApplications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/ListApplications) 

# ListDataIntegrationAssociations
<a name="API_connect-app-integrations_ListDataIntegrationAssociations"></a>

Returns a paginated list of DataIntegration associations in the account.

**Note**  
You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the [CreateDataIntegration](https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) API.

## Request Syntax
<a name="API_connect-app-integrations_ListDataIntegrationAssociations_RequestSyntax"></a>

```
GET /dataIntegrations/Identifier/associations?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-app-integrations_ListDataIntegrationAssociations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [Identifier](#API_connect-app-integrations_ListDataIntegrationAssociations_RequestSyntax) **   <a name="connect-connect-app-integrations_ListDataIntegrationAssociations-request-uri-DataIntegrationIdentifier"></a>
A unique identifier for the DataIntegration.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `.*\S.*`   
Required: Yes

 ** [MaxResults](#API_connect-app-integrations_ListDataIntegrationAssociations_RequestSyntax) **   <a name="connect-connect-app-integrations_ListDataIntegrationAssociations-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_connect-app-integrations_ListDataIntegrationAssociations_RequestSyntax) **   <a name="connect-connect-app-integrations_ListDataIntegrationAssociations-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `.*` 

## Request Body
<a name="API_connect-app-integrations_ListDataIntegrationAssociations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-app-integrations_ListDataIntegrationAssociations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DataIntegrationAssociations": [ 
      { 
         "ClientId": "string",
         "DataIntegrationArn": "string",
         "DataIntegrationAssociationArn": "string",
         "DestinationURI": "string",
         "ExecutionConfiguration": { 
            "ExecutionMode": "string",
            "OnDemandConfiguration": { 
               "EndTime": "string",
               "StartTime": "string"
            },
            "ScheduleConfiguration": { 
               "FirstExecutionFrom": "string",
               "Object": "string",
               "ScheduleExpression": "string"
            }
         },
         "LastExecutionStatus": { 
            "ExecutionStatus": "string",
            "StatusMessage": "string"
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-app-integrations_ListDataIntegrationAssociations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DataIntegrationAssociations](#API_connect-app-integrations_ListDataIntegrationAssociations_ResponseSyntax) **   <a name="connect-connect-app-integrations_ListDataIntegrationAssociations-response-DataIntegrationAssociations"></a>
The Amazon Resource Name (ARN) and unique ID of the DataIntegration association.  
Type: Array of [DataIntegrationAssociationSummary](API_connect-app-integrations_DataIntegrationAssociationSummary.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.

 ** [NextToken](#API_connect-app-integrations_ListDataIntegrationAssociations_ResponseSyntax) **   <a name="connect-connect-app-integrations_ListDataIntegrationAssociations-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `.*` 

## Errors
<a name="API_connect-app-integrations_ListDataIntegrationAssociations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_connect-app-integrations_ListDataIntegrationAssociations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/ListDataIntegrationAssociations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/ListDataIntegrationAssociations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/ListDataIntegrationAssociations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/ListDataIntegrationAssociations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/ListDataIntegrationAssociations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/ListDataIntegrationAssociations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/ListDataIntegrationAssociations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/ListDataIntegrationAssociations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/ListDataIntegrationAssociations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/ListDataIntegrationAssociations) 

# ListDataIntegrations
<a name="API_connect-app-integrations_ListDataIntegrations"></a>

Returns a paginated list of DataIntegrations in the account.

**Note**  
You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the [CreateDataIntegration](https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) API.

## Request Syntax
<a name="API_connect-app-integrations_ListDataIntegrations_RequestSyntax"></a>

```
GET /dataIntegrations?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-app-integrations_ListDataIntegrations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_connect-app-integrations_ListDataIntegrations_RequestSyntax) **   <a name="connect-connect-app-integrations_ListDataIntegrations-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_connect-app-integrations_ListDataIntegrations_RequestSyntax) **   <a name="connect-connect-app-integrations_ListDataIntegrations-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `.*` 

## Request Body
<a name="API_connect-app-integrations_ListDataIntegrations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-app-integrations_ListDataIntegrations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DataIntegrations": [ 
      { 
         "Arn": "string",
         "Name": "string",
         "SourceURI": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-app-integrations_ListDataIntegrations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DataIntegrations](#API_connect-app-integrations_ListDataIntegrations_ResponseSyntax) **   <a name="connect-connect-app-integrations_ListDataIntegrations-response-DataIntegrations"></a>
The DataIntegrations associated with this account.  
Type: Array of [DataIntegrationSummary](API_connect-app-integrations_DataIntegrationSummary.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.

 ** [NextToken](#API_connect-app-integrations_ListDataIntegrations_ResponseSyntax) **   <a name="connect-connect-app-integrations_ListDataIntegrations-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `.*` 

## Errors
<a name="API_connect-app-integrations_ListDataIntegrations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_connect-app-integrations_ListDataIntegrations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/ListDataIntegrations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/ListDataIntegrations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/ListDataIntegrations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/ListDataIntegrations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/ListDataIntegrations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/ListDataIntegrations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/ListDataIntegrations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/ListDataIntegrations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/ListDataIntegrations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/ListDataIntegrations) 

# ListEventIntegrationAssociations
<a name="API_connect-app-integrations_ListEventIntegrationAssociations"></a>

Returns a paginated list of event integration associations in the account. 

## Request Syntax
<a name="API_connect-app-integrations_ListEventIntegrationAssociations_RequestSyntax"></a>

```
GET /eventIntegrations/Name/associations?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-app-integrations_ListEventIntegrationAssociations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [Name](#API_connect-app-integrations_ListEventIntegrationAssociations_RequestSyntax) **   <a name="connect-connect-app-integrations_ListEventIntegrationAssociations-request-uri-EventIntegrationName"></a>
The name of the event integration.   
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9\/\._\-]+$`   
Required: Yes

 ** [MaxResults](#API_connect-app-integrations_ListEventIntegrationAssociations_RequestSyntax) **   <a name="connect-connect-app-integrations_ListEventIntegrationAssociations-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_connect-app-integrations_ListEventIntegrationAssociations_RequestSyntax) **   <a name="connect-connect-app-integrations_ListEventIntegrationAssociations-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `.*` 

## Request Body
<a name="API_connect-app-integrations_ListEventIntegrationAssociations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-app-integrations_ListEventIntegrationAssociations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EventIntegrationAssociations": [ 
      { 
         "ClientAssociationMetadata": { 
            "string" : "string" 
         },
         "ClientId": "string",
         "EventBridgeRuleName": "string",
         "EventIntegrationAssociationArn": "string",
         "EventIntegrationAssociationId": "string",
         "EventIntegrationName": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-app-integrations_ListEventIntegrationAssociations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EventIntegrationAssociations](#API_connect-app-integrations_ListEventIntegrationAssociations_ResponseSyntax) **   <a name="connect-connect-app-integrations_ListEventIntegrationAssociations-response-EventIntegrationAssociations"></a>
The event integration associations.  
Type: Array of [EventIntegrationAssociation](API_connect-app-integrations_EventIntegrationAssociation.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.

 ** [NextToken](#API_connect-app-integrations_ListEventIntegrationAssociations_ResponseSyntax) **   <a name="connect-connect-app-integrations_ListEventIntegrationAssociations-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `.*` 

## Errors
<a name="API_connect-app-integrations_ListEventIntegrationAssociations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_connect-app-integrations_ListEventIntegrationAssociations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/ListEventIntegrationAssociations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/ListEventIntegrationAssociations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/ListEventIntegrationAssociations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/ListEventIntegrationAssociations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/ListEventIntegrationAssociations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/ListEventIntegrationAssociations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/ListEventIntegrationAssociations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/ListEventIntegrationAssociations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/ListEventIntegrationAssociations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/ListEventIntegrationAssociations) 

# ListEventIntegrations
<a name="API_connect-app-integrations_ListEventIntegrations"></a>

Returns a paginated list of event integrations in the account.

## Request Syntax
<a name="API_connect-app-integrations_ListEventIntegrations_RequestSyntax"></a>

```
GET /eventIntegrations?maxResults=MaxResults&nextToken=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-app-integrations_ListEventIntegrations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_connect-app-integrations_ListEventIntegrations_RequestSyntax) **   <a name="connect-connect-app-integrations_ListEventIntegrations-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [NextToken](#API_connect-app-integrations_ListEventIntegrations_RequestSyntax) **   <a name="connect-connect-app-integrations_ListEventIntegrations-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `.*` 

## Request Body
<a name="API_connect-app-integrations_ListEventIntegrations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-app-integrations_ListEventIntegrations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EventIntegrations": [ 
      { 
         "Description": "string",
         "EventBridgeBus": "string",
         "EventFilter": { 
            "Source": "string"
         },
         "EventIntegrationArn": "string",
         "Name": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-app-integrations_ListEventIntegrations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EventIntegrations](#API_connect-app-integrations_ListEventIntegrations_ResponseSyntax) **   <a name="connect-connect-app-integrations_ListEventIntegrations-response-EventIntegrations"></a>
The event integrations.  
Type: Array of [EventIntegration](API_connect-app-integrations_EventIntegration.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.

 ** [NextToken](#API_connect-app-integrations_ListEventIntegrations_ResponseSyntax) **   <a name="connect-connect-app-integrations_ListEventIntegrations-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Pattern: `.*` 

## Errors
<a name="API_connect-app-integrations_ListEventIntegrations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_connect-app-integrations_ListEventIntegrations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/ListEventIntegrations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/ListEventIntegrations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/ListEventIntegrations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/ListEventIntegrations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/ListEventIntegrations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/ListEventIntegrations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/ListEventIntegrations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/ListEventIntegrations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/ListEventIntegrations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/ListEventIntegrations) 

# ListTagsForResource
<a name="API_connect-app-integrations_ListTagsForResource"></a>

Lists the tags for the specified resource.

## Request Syntax
<a name="API_connect-app-integrations_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/resourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-app-integrations_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_connect-app-integrations_ListTagsForResource_RequestSyntax) **   <a name="connect-connect-app-integrations_ListTagsForResource-request-uri-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource.   
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$`   
Required: Yes

## Request Body
<a name="API_connect-app-integrations_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-app-integrations_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-app-integrations_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tags](#API_connect-app-integrations_ListTagsForResource_ResponseSyntax) **   <a name="connect-connect-app-integrations_ListTagsForResource-response-tags"></a>
Information about the tags.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_connect-app-integrations_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_connect-app-integrations_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/ListTagsForResource) 

# TagResource
<a name="API_connect-app-integrations_TagResource"></a>

Adds the specified tags to the specified resource.

## Request Syntax
<a name="API_connect-app-integrations_TagResource_RequestSyntax"></a>

```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_connect-app-integrations_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_connect-app-integrations_TagResource_RequestSyntax) **   <a name="connect-connect-app-integrations_TagResource-request-uri-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$`   
Required: Yes

## Request Body
<a name="API_connect-app-integrations_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [tags](#API_connect-app-integrations_TagResource_RequestSyntax) **   <a name="connect-connect-app-integrations_TagResource-request-tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Map Entries: Maximum number of 200 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Required: Yes

## Response Syntax
<a name="API_connect-app-integrations_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-app-integrations_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-app-integrations_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_connect-app-integrations_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/TagResource) 

# UntagResource
<a name="API_connect-app-integrations_UntagResource"></a>

Removes the specified tags from the specified resource.

## Request Syntax
<a name="API_connect-app-integrations_UntagResource_RequestSyntax"></a>

```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-app-integrations_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_connect-app-integrations_UntagResource_RequestSyntax) **   <a name="connect-connect-app-integrations_UntagResource-request-uri-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$`   
Required: Yes

 ** [tagKeys](#API_connect-app-integrations_UntagResource_RequestSyntax) **   <a name="connect-connect-app-integrations_UntagResource-request-uri-tagKeys"></a>
The tag keys.  
Array Members: Minimum number of 1 item. Maximum number of 200 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Required: Yes

## Request Body
<a name="API_connect-app-integrations_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-app-integrations_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-app-integrations_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-app-integrations_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_connect-app-integrations_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/UntagResource) 

# UpdateApplication
<a name="API_connect-app-integrations_UpdateApplication"></a>

Updates and persists an Application resource.

## Request Syntax
<a name="API_connect-app-integrations_UpdateApplication_RequestSyntax"></a>

```
PATCH /applications/ApplicationIdentifier HTTP/1.1
Content-type: application/json

{
   "ApplicationConfig": { 
      "ContactHandling": { 
         "Scope": "string"
      }
   },
   "ApplicationSourceConfig": { 
      "ExternalUrlConfig": { 
         "AccessUrl": "string",
         "ApprovedOrigins": [ "string" ]
      }
   },
   "ApplicationType": "string",
   "Description": "string",
   "IframeConfig": { 
      "Allow": [ "string" ],
      "Sandbox": [ "string" ]
   },
   "InitializationTimeout": number,
   "IsService": boolean,
   "Name": "string",
   "Permissions": [ "string" ],
   "Publications": [ 
      { 
         "Description": "string",
         "Event": "string",
         "Schema": "string"
      }
   ],
   "Subscriptions": [ 
      { 
         "Description": "string",
         "Event": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_connect-app-integrations_UpdateApplication_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ApplicationIdentifier](#API_connect-app-integrations_UpdateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_UpdateApplication-request-uri-Arn"></a>
The Amazon Resource Name (ARN) of the Application.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^(arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}|[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})(:[\w\$]+)?$`   
Required: Yes

## Request Body
<a name="API_connect-app-integrations_UpdateApplication_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ApplicationConfig](#API_connect-app-integrations_UpdateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_UpdateApplication-request-ApplicationConfig"></a>
The configuration settings for the application.  
Type: [ApplicationConfig](API_connect-app-integrations_ApplicationConfig.md) object  
Required: No

 ** [ApplicationSourceConfig](#API_connect-app-integrations_UpdateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_UpdateApplication-request-ApplicationSourceConfig"></a>
The configuration for where the application should be loaded from.  
Type: [ApplicationSourceConfig](API_connect-app-integrations_ApplicationSourceConfig.md) object  
Required: No

 ** [ApplicationType](#API_connect-app-integrations_UpdateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_UpdateApplication-request-ApplicationType"></a>
The type of application.  
Type: String  
Valid Values: `STANDARD | SERVICE | MCP_SERVER`   
Required: No

 ** [Description](#API_connect-app-integrations_UpdateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_UpdateApplication-request-Description"></a>
The description of the application.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `.*`   
Required: No

 ** [IframeConfig](#API_connect-app-integrations_UpdateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_UpdateApplication-request-IframeConfig"></a>
The iframe configuration for the application.  
Type: [IframeConfig](API_connect-app-integrations_IframeConfig.md) object  
Required: No

 ** [InitializationTimeout](#API_connect-app-integrations_UpdateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_UpdateApplication-request-InitializationTimeout"></a>
The maximum time in milliseconds allowed to establish a connection with the workspace.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 600000.  
Required: No

 ** [IsService](#API_connect-app-integrations_UpdateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_UpdateApplication-request-IsService"></a>
 *This parameter has been deprecated.*   
Indicates whether the application is a service.  
Type: Boolean  
Required: No

 ** [Name](#API_connect-app-integrations_UpdateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_UpdateApplication-request-Name"></a>
The name of the application.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9\/\._ \-]+$`   
Required: No

 ** [Permissions](#API_connect-app-integrations_UpdateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_UpdateApplication-request-Permissions"></a>
The configuration of events or requests that the application has access to.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 150 items.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9\/\._\-\*]+$`   
Required: No

 ** [Publications](#API_connect-app-integrations_UpdateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_UpdateApplication-request-Publications"></a>
 *This parameter has been deprecated.*   
The events that the application publishes.  
Type: Array of [Publication](API_connect-app-integrations_Publication.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** [Subscriptions](#API_connect-app-integrations_UpdateApplication_RequestSyntax) **   <a name="connect-connect-app-integrations_UpdateApplication-request-Subscriptions"></a>
 *This parameter has been deprecated.*   
The events that the application subscribes.  
Type: Array of [Subscription](API_connect-app-integrations_Subscription.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

## Response Syntax
<a name="API_connect-app-integrations_UpdateApplication_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-app-integrations_UpdateApplication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-app-integrations_UpdateApplication_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnsupportedOperationException **   
The operation is not supported.  
HTTP Status Code: 400

## See Also
<a name="API_connect-app-integrations_UpdateApplication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/UpdateApplication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/UpdateApplication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/UpdateApplication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/UpdateApplication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/UpdateApplication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/UpdateApplication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/UpdateApplication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/UpdateApplication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/UpdateApplication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/UpdateApplication) 

# UpdateDataIntegration
<a name="API_connect-app-integrations_UpdateDataIntegration"></a>

Updates the description of a DataIntegration.

**Note**  
You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the [CreateDataIntegration](https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) API.

## Request Syntax
<a name="API_connect-app-integrations_UpdateDataIntegration_RequestSyntax"></a>

```
PATCH /dataIntegrations/Identifier HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Name": "string"
}
```

## URI Request Parameters
<a name="API_connect-app-integrations_UpdateDataIntegration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [Identifier](#API_connect-app-integrations_UpdateDataIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_UpdateDataIntegration-request-uri-Identifier"></a>
A unique identifier for the DataIntegration.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_connect-app-integrations_UpdateDataIntegration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_connect-app-integrations_UpdateDataIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_UpdateDataIntegration-request-Description"></a>
A description of the DataIntegration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `.*`   
Required: No

 ** [Name](#API_connect-app-integrations_UpdateDataIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_UpdateDataIntegration-request-Name"></a>
The name of the DataIntegration.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9\/\._\-]+$`   
Required: No

## Response Syntax
<a name="API_connect-app-integrations_UpdateDataIntegration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-app-integrations_UpdateDataIntegration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-app-integrations_UpdateDataIntegration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_connect-app-integrations_UpdateDataIntegration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/UpdateDataIntegration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/UpdateDataIntegration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/UpdateDataIntegration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/UpdateDataIntegration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/UpdateDataIntegration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/UpdateDataIntegration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/UpdateDataIntegration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/UpdateDataIntegration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/UpdateDataIntegration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/UpdateDataIntegration) 

# UpdateDataIntegrationAssociation
<a name="API_connect-app-integrations_UpdateDataIntegrationAssociation"></a>

Updates and persists a DataIntegrationAssociation resource.

**Note**  
 Updating a DataIntegrationAssociation with ExecutionConfiguration will rerun the on-demand job. 

## Request Syntax
<a name="API_connect-app-integrations_UpdateDataIntegrationAssociation_RequestSyntax"></a>

```
PATCH /dataIntegrations/Identifier/associations/DataIntegrationAssociationIdentifier HTTP/1.1
Content-type: application/json

{
   "ExecutionConfiguration": { 
      "ExecutionMode": "string",
      "OnDemandConfiguration": { 
         "EndTime": "string",
         "StartTime": "string"
      },
      "ScheduleConfiguration": { 
         "FirstExecutionFrom": "string",
         "Object": "string",
         "ScheduleExpression": "string"
      }
   }
}
```

## URI Request Parameters
<a name="API_connect-app-integrations_UpdateDataIntegrationAssociation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DataIntegrationAssociationIdentifier](#API_connect-app-integrations_UpdateDataIntegrationAssociation_RequestSyntax) **   <a name="connect-connect-app-integrations_UpdateDataIntegrationAssociation-request-uri-DataIntegrationAssociationIdentifier"></a>
A unique identifier. of the DataIntegrationAssociation resource  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `.*\S.*`   
Required: Yes

 ** [Identifier](#API_connect-app-integrations_UpdateDataIntegrationAssociation_RequestSyntax) **   <a name="connect-connect-app-integrations_UpdateDataIntegrationAssociation-request-uri-DataIntegrationIdentifier"></a>
A unique identifier for the DataIntegration.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `.*\S.*`   
Required: Yes

## Request Body
<a name="API_connect-app-integrations_UpdateDataIntegrationAssociation_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ExecutionConfiguration](#API_connect-app-integrations_UpdateDataIntegrationAssociation_RequestSyntax) **   <a name="connect-connect-app-integrations_UpdateDataIntegrationAssociation-request-ExecutionConfiguration"></a>
The configuration for how the files should be pulled from the source.  
Type: [ExecutionConfiguration](API_connect-app-integrations_ExecutionConfiguration.md) object  
Required: Yes

## Response Syntax
<a name="API_connect-app-integrations_UpdateDataIntegrationAssociation_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-app-integrations_UpdateDataIntegrationAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-app-integrations_UpdateDataIntegrationAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_connect-app-integrations_UpdateDataIntegrationAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/UpdateDataIntegrationAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/UpdateDataIntegrationAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/UpdateDataIntegrationAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/UpdateDataIntegrationAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/UpdateDataIntegrationAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/UpdateDataIntegrationAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/UpdateDataIntegrationAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/UpdateDataIntegrationAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/UpdateDataIntegrationAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/UpdateDataIntegrationAssociation) 

# UpdateEventIntegration
<a name="API_connect-app-integrations_UpdateEventIntegration"></a>

Updates the description of an event integration.

## Request Syntax
<a name="API_connect-app-integrations_UpdateEventIntegration_RequestSyntax"></a>

```
PATCH /eventIntegrations/Name HTTP/1.1
Content-type: application/json

{
   "Description": "string"
}
```

## URI Request Parameters
<a name="API_connect-app-integrations_UpdateEventIntegration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [Name](#API_connect-app-integrations_UpdateEventIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_UpdateEventIntegration-request-uri-Name"></a>
The name of the event integration.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9\/\._\-]+$`   
Required: Yes

## Request Body
<a name="API_connect-app-integrations_UpdateEventIntegration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_connect-app-integrations_UpdateEventIntegration_RequestSyntax) **   <a name="connect-connect-app-integrations_UpdateEventIntegration-request-Description"></a>
The description of the event integration.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Pattern: `.*`   
Required: No

## Response Syntax
<a name="API_connect-app-integrations_UpdateEventIntegration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-app-integrations_UpdateEventIntegration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-app-integrations_UpdateEventIntegration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServiceError **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## See Also
<a name="API_connect-app-integrations_UpdateEventIntegration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/appintegrations-2020-07-29/UpdateEventIntegration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/appintegrations-2020-07-29/UpdateEventIntegration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/appintegrations-2020-07-29/UpdateEventIntegration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/appintegrations-2020-07-29/UpdateEventIntegration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/appintegrations-2020-07-29/UpdateEventIntegration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/appintegrations-2020-07-29/UpdateEventIntegration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/appintegrations-2020-07-29/UpdateEventIntegration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/appintegrations-2020-07-29/UpdateEventIntegration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/appintegrations-2020-07-29/UpdateEventIntegration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/appintegrations-2020-07-29/UpdateEventIntegration) 

# Amazon Connect Contact Lens
<a name="API_Operations_Amazon_Connect_Contact_Lens"></a>

The following actions are supported by Amazon Connect Contact Lens:
+  [ListRealtimeContactAnalysisSegments](API_connect-contact-lens_ListRealtimeContactAnalysisSegments.md) 

# ListRealtimeContactAnalysisSegments
<a name="API_connect-contact-lens_ListRealtimeContactAnalysisSegments"></a>

Provides a list of analysis segments for a real-time analysis session for voice.

**Note**  
Voice data is retained for 24 hours. You must invoke this API during that time.

## Request Syntax
<a name="API_connect-contact-lens_ListRealtimeContactAnalysisSegments_RequestSyntax"></a>

```
POST /realtime-contact-analysis/analysis-segments HTTP/1.1
Content-type: application/json

{
   "ContactId": "string",
   "InstanceId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## URI Request Parameters
<a name="API_connect-contact-lens_ListRealtimeContactAnalysisSegments_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_connect-contact-lens_ListRealtimeContactAnalysisSegments_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ContactId](#API_connect-contact-lens_ListRealtimeContactAnalysisSegments_RequestSyntax) **   <a name="connect-connect-contact-lens_ListRealtimeContactAnalysisSegments-request-ContactId"></a>
The identifier of the contact.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

 ** [InstanceId](#API_connect-contact-lens_ListRealtimeContactAnalysisSegments_RequestSyntax) **   <a name="connect-connect-contact-lens_ListRealtimeContactAnalysisSegments-request-InstanceId"></a>
The identifier of the Amazon Connect instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

 ** [MaxResults](#API_connect-contact-lens_ListRealtimeContactAnalysisSegments_RequestSyntax) **   <a name="connect-connect-contact-lens_ListRealtimeContactAnalysisSegments-request-MaxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_connect-contact-lens_ListRealtimeContactAnalysisSegments_RequestSyntax) **   <a name="connect-connect-contact-lens_ListRealtimeContactAnalysisSegments-request-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 131070.  
Pattern: `.*\S.*`   
Required: No

## Response Syntax
<a name="API_connect-contact-lens_ListRealtimeContactAnalysisSegments_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Segments": [ 
      { 
         "Categories": { 
            "MatchedCategories": [ "string" ],
            "MatchedDetails": { 
               "string" : { 
                  "PointsOfInterest": [ 
                     { 
                        "BeginOffsetMillis": number,
                        "EndOffsetMillis": number
                     }
                  ]
               }
            }
         },
         "PostContactSummary": { 
            "Content": "string",
            "FailureCode": "string",
            "Status": "string"
         },
         "Transcript": { 
            "BeginOffsetMillis": number,
            "Content": "string",
            "EndOffsetMillis": number,
            "Id": "string",
            "IssuesDetected": [ 
               { 
                  "CharacterOffsets": { 
                     "BeginOffsetChar": number,
                     "EndOffsetChar": number
                  }
               }
            ],
            "ParticipantId": "string",
            "ParticipantRole": "string",
            "Sentiment": "string"
         }
      }
   ]
}
```

## Response Elements
<a name="API_connect-contact-lens_ListRealtimeContactAnalysisSegments_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_connect-contact-lens_ListRealtimeContactAnalysisSegments_ResponseSyntax) **   <a name="connect-connect-contact-lens_ListRealtimeContactAnalysisSegments-response-NextToken"></a>
If there are additional results, this is the token for the next set of results. If response includes `nextToken` there are two possible scenarios:  
+ There are more segments so another call is required to get them.
+ There are no more segments at this time, but more may be available later (real-time analysis is in progress) so the client should call the operation again to get new segments.
If response does not include `nextToken`, the analysis is completed (successfully or failed) and there are no more segments to retrieve.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 131070.  
Pattern: `.*\S.*` 

 ** [Segments](#API_connect-contact-lens_ListRealtimeContactAnalysisSegments_ResponseSyntax) **   <a name="connect-connect-contact-lens_ListRealtimeContactAnalysisSegments-response-Segments"></a>
An analyzed transcript or category.  
Type: Array of [RealtimeContactAnalysisSegment](API_connect-contact-lens_RealtimeContactAnalysisSegment.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

## Errors
<a name="API_connect-contact-lens_ListRealtimeContactAnalysisSegments_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServiceException **   
Request processing failed due to an error or failure with the service.  
HTTP Status Code: 500

 ** InvalidRequestException **   
The request is not valid.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
The specified resource was not found.  
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

## Examples
<a name="API_connect-contact-lens_ListRealtimeContactAnalysisSegments_Examples"></a>

### Example
<a name="API_connect-contact-lens_ListRealtimeContactAnalysisSegments_Example_1"></a>

This example illustrates one usage of ListRealtimeContactAnalysisSegments.

#### Sample Request
<a name="API_connect-contact-lens_ListRealtimeContactAnalysisSegments_Example_1_Request"></a>

```
POST /realtime-contact-analysis/analysis-segments
{
  "InstanceId": "eeeeeee-eeee-eeee-eeee-eeeeeeeeeeee",
  "ContactId": "11111111-1111-1111-1111-11111111111",
  "MaxResults": 50,
  "NextToken": "fdsfsadgdfsgdfgfdhfghfghfgjmbnmnm"
}
```

#### Sample Response
<a name="API_connect-contact-lens_ListRealtimeContactAnalysisSegments_Example_1_Response"></a>

```
{
    "Segments": [
        {
            "Transcript": {
                "Id": "tttttttt-tttt-tttt-tttt-tttttttt",
                "ParticipantId": "AGENT",
                "ParticipantRole": "AGENT",
                "Content": "I can't login.",
                "BeginOffsetMillis": 19010,
                "EndOffsetMillis": 22690,
                "Sentiment": "NEUTRAL",
                "IssuesDetected": [
                    {
                        "CharacterOffsets": {
                            "BeginOffsetChar": 8,
                            "EndOffsetChar": 12
                        }
                    }
                ]
            }
        },
        {
            "Categories": {
                "MatchedCategories": [
                    "CreditCardRelated",
                    "CardBrokenIssue"
                ],
                "MatchedDetails": {
                    "CreditCardRelated": {
                        "PointsOfInterest": [
                            {
                                "BeginOffsetMillis": 19010,
                                "EndOffsetMillis": 22690
                            }
                        ]
                    },
                    "CardBrokenIssue": {
                        "PointsOfInterest": [
                            {
                                "BeginOffsetMillis": 25000,
                                "EndOffsetMillis": 29690
                            }
                        ]
                    }
                }
            }
        }
    ],
    "NextToken": "fdsfsadgdfsgdfgfdhfghfghfgjmbnmnm"
}
```

## See Also
<a name="API_connect-contact-lens_ListRealtimeContactAnalysisSegments_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connect-contact-lens-2020-08-21/ListRealtimeContactAnalysisSegments) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connect-contact-lens-2020-08-21/ListRealtimeContactAnalysisSegments) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connect-contact-lens-2020-08-21/ListRealtimeContactAnalysisSegments) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connect-contact-lens-2020-08-21/ListRealtimeContactAnalysisSegments) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connect-contact-lens-2020-08-21/ListRealtimeContactAnalysisSegments) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connect-contact-lens-2020-08-21/ListRealtimeContactAnalysisSegments) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connect-contact-lens-2020-08-21/ListRealtimeContactAnalysisSegments) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connect-contact-lens-2020-08-21/ListRealtimeContactAnalysisSegments) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connect-contact-lens-2020-08-21/ListRealtimeContactAnalysisSegments) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connect-contact-lens-2020-08-21/ListRealtimeContactAnalysisSegments) 

# Amazon Connect Outbound Campaigns
<a name="API_Operations_Amazon_Connect_Outbound_Campaigns"></a>

The following actions are supported by Amazon Connect Outbound Campaigns:
+  [CreateCampaign](API_connect-outbound-campaigns_CreateCampaign.md) 
+  [DeleteCampaign](API_connect-outbound-campaigns_DeleteCampaign.md) 
+  [DeleteConnectInstanceConfig](API_connect-outbound-campaigns_DeleteConnectInstanceConfig.md) 
+  [DeleteInstanceOnboardingJob](API_connect-outbound-campaigns_DeleteInstanceOnboardingJob.md) 
+  [DescribeCampaign](API_connect-outbound-campaigns_DescribeCampaign.md) 
+  [GetCampaignState](API_connect-outbound-campaigns_GetCampaignState.md) 
+  [GetCampaignStateBatch](API_connect-outbound-campaigns_GetCampaignStateBatch.md) 
+  [GetConnectInstanceConfig](API_connect-outbound-campaigns_GetConnectInstanceConfig.md) 
+  [GetInstanceOnboardingJobStatus](API_connect-outbound-campaigns_GetInstanceOnboardingJobStatus.md) 
+  [ListCampaigns](API_connect-outbound-campaigns_ListCampaigns.md) 
+  [ListTagsForResource](API_connect-outbound-campaigns_ListTagsForResource.md) 
+  [PauseCampaign](API_connect-outbound-campaigns_PauseCampaign.md) 
+  [PutDialRequestBatch](API_connect-outbound-campaigns_PutDialRequestBatch.md) 
+  [ResumeCampaign](API_connect-outbound-campaigns_ResumeCampaign.md) 
+  [StartCampaign](API_connect-outbound-campaigns_StartCampaign.md) 
+  [StartInstanceOnboardingJob](API_connect-outbound-campaigns_StartInstanceOnboardingJob.md) 
+  [StopCampaign](API_connect-outbound-campaigns_StopCampaign.md) 
+  [TagResource](API_connect-outbound-campaigns_TagResource.md) 
+  [UntagResource](API_connect-outbound-campaigns_UntagResource.md) 
+  [UpdateCampaignDialerConfig](API_connect-outbound-campaigns_UpdateCampaignDialerConfig.md) 
+  [UpdateCampaignName](API_connect-outbound-campaigns_UpdateCampaignName.md) 
+  [UpdateCampaignOutboundCallConfig](API_connect-outbound-campaigns_UpdateCampaignOutboundCallConfig.md) 

# CreateCampaign
<a name="API_connect-outbound-campaigns_CreateCampaign"></a>

Creates an outbound campaign. 

**Note**  
For users to be able to view or edit a campaign at a later date by using the Amazon Connect user interface, you must add the instance ID as a tag.
After a campaign is saved, you can't change the dialer type for an agentless campaign, and you can't change the dialer type to agentless for progressive and predictive campaigns.

## Request Syntax
<a name="API_connect-outbound-campaigns_CreateCampaign_RequestSyntax"></a>

```
PUT /campaigns HTTP/1.1
Content-type: application/json

{
   "connectInstanceId": "string",
   "dialerConfig": { ... },
   "name": "string",
   "outboundCallConfig": { 
      "answerMachineDetectionConfig": { 
         "awaitAnswerMachinePrompt": boolean,
         "enableAnswerMachineDetection": boolean
      },
      "connectContactFlowId": "string",
      "connectQueueId": "string",
      "connectSourcePhoneNumber": "string"
   },
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns_CreateCampaign_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_connect-outbound-campaigns_CreateCampaign_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [connectInstanceId](#API_connect-outbound-campaigns_CreateCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_CreateCampaign-request-connectInstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-_.a-zA-Z0-9]+`   
Required: Yes

 ** [dialerConfig](#API_connect-outbound-campaigns_CreateCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_CreateCampaign-request-dialerConfig"></a>
Dialer configuration for an outbound campaign.  
Type: [DialerConfig](API_connect-outbound-campaigns_DialerConfig.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [name](#API_connect-outbound-campaigns_CreateCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_CreateCampaign-request-name"></a>
The name of the campaign.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Required: Yes

 ** [outboundCallConfig](#API_connect-outbound-campaigns_CreateCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_CreateCampaign-request-outboundCallConfig"></a>
Outbound call configuration for an outbound campaign.  
Type: [OutboundCallConfig](API_connect-outbound-campaigns_OutboundCallConfig.md) object  
Required: Yes

 ** [tags](#API_connect-outbound-campaigns_CreateCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_CreateCampaign-request-tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_connect-outbound-campaigns_CreateCampaign_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "id": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-outbound-campaigns_CreateCampaign_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_connect-outbound-campaigns_CreateCampaign_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns_CreateCampaign-response-arn"></a>
The Amazon Resource Name (ARN).  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 500.

 ** [id](#API_connect-outbound-campaigns_CreateCampaign_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns_CreateCampaign-response-id"></a>
The identifier of the campaign.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+` 

 ** [tags](#API_connect-outbound-campaigns_CreateCampaign_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns_CreateCampaign-response-tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.

## Errors
<a name="API_connect-outbound-campaigns_CreateCampaign_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.   
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota for your Amazon Connect has been exceeded. Contact Support.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWSservice.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns_CreateCampaign_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaigns-2021-01-30/CreateCampaign) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaigns-2021-01-30/CreateCampaign) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaigns-2021-01-30/CreateCampaign) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaigns-2021-01-30/CreateCampaign) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaigns-2021-01-30/CreateCampaign) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaigns-2021-01-30/CreateCampaign) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaigns-2021-01-30/CreateCampaign) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaigns-2021-01-30/CreateCampaign) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaigns-2021-01-30/CreateCampaign) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaigns-2021-01-30/CreateCampaign) 

# DeleteCampaign
<a name="API_connect-outbound-campaigns_DeleteCampaign"></a>

Deletes an outbound campaign.

## Request Syntax
<a name="API_connect-outbound-campaigns_DeleteCampaign_RequestSyntax"></a>

```
DELETE /campaigns/id HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns_DeleteCampaign_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns_DeleteCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_DeleteCampaign-request-uri-id"></a>
The identifier of the campaign..  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns_DeleteCampaign_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns_DeleteCampaign_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns_DeleteCampaign_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns_DeleteCampaign_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.   
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWSservice.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns_DeleteCampaign_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaigns-2021-01-30/DeleteCampaign) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaigns-2021-01-30/DeleteCampaign) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaigns-2021-01-30/DeleteCampaign) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaigns-2021-01-30/DeleteCampaign) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaigns-2021-01-30/DeleteCampaign) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaigns-2021-01-30/DeleteCampaign) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaigns-2021-01-30/DeleteCampaign) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaigns-2021-01-30/DeleteCampaign) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaigns-2021-01-30/DeleteCampaign) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaigns-2021-01-30/DeleteCampaign) 

# DeleteConnectInstanceConfig
<a name="API_connect-outbound-campaigns_DeleteConnectInstanceConfig"></a>

Deletes configuration information for an Amazon Connect instance.

## Request Syntax
<a name="API_connect-outbound-campaigns_DeleteConnectInstanceConfig_RequestSyntax"></a>

```
DELETE /connect-instance/connectInstanceId/config HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns_DeleteConnectInstanceConfig_RequestParameters"></a>

The request uses the following URI parameters.

 ** [connectInstanceId](#API_connect-outbound-campaigns_DeleteConnectInstanceConfig_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_DeleteConnectInstanceConfig-request-uri-connectInstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-_.a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns_DeleteConnectInstanceConfig_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns_DeleteConnectInstanceConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns_DeleteConnectInstanceConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns_DeleteConnectInstanceConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.   
HTTP Status Code: 500

 ** InvalidStateException **   
An attempt was made to modify a campaign state and the new campaign state is not valid. Check campaign state before retrying the operation.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWSservice.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns_DeleteConnectInstanceConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaigns-2021-01-30/DeleteConnectInstanceConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaigns-2021-01-30/DeleteConnectInstanceConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaigns-2021-01-30/DeleteConnectInstanceConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaigns-2021-01-30/DeleteConnectInstanceConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaigns-2021-01-30/DeleteConnectInstanceConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaigns-2021-01-30/DeleteConnectInstanceConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaigns-2021-01-30/DeleteConnectInstanceConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaigns-2021-01-30/DeleteConnectInstanceConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaigns-2021-01-30/DeleteConnectInstanceConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaigns-2021-01-30/DeleteConnectInstanceConfig) 

# DeleteInstanceOnboardingJob
<a name="API_connect-outbound-campaigns_DeleteInstanceOnboardingJob"></a>

Deletes the workflow to onboard to outbound campaigns. Only `Failed` workflows can be deleted.

## Request Syntax
<a name="API_connect-outbound-campaigns_DeleteInstanceOnboardingJob_RequestSyntax"></a>

```
DELETE /connect-instance/connectInstanceId/onboarding HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns_DeleteInstanceOnboardingJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [connectInstanceId](#API_connect-outbound-campaigns_DeleteInstanceOnboardingJob_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_DeleteInstanceOnboardingJob-request-uri-connectInstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-_.a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns_DeleteInstanceOnboardingJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns_DeleteInstanceOnboardingJob_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns_DeleteInstanceOnboardingJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns_DeleteInstanceOnboardingJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.   
HTTP Status Code: 500

 ** InvalidStateException **   
An attempt was made to modify a campaign state and the new campaign state is not valid. Check campaign state before retrying the operation.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWSservice.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns_DeleteInstanceOnboardingJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaigns-2021-01-30/DeleteInstanceOnboardingJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaigns-2021-01-30/DeleteInstanceOnboardingJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaigns-2021-01-30/DeleteInstanceOnboardingJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaigns-2021-01-30/DeleteInstanceOnboardingJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaigns-2021-01-30/DeleteInstanceOnboardingJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaigns-2021-01-30/DeleteInstanceOnboardingJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaigns-2021-01-30/DeleteInstanceOnboardingJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaigns-2021-01-30/DeleteInstanceOnboardingJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaigns-2021-01-30/DeleteInstanceOnboardingJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaigns-2021-01-30/DeleteInstanceOnboardingJob) 

# DescribeCampaign
<a name="API_connect-outbound-campaigns_DescribeCampaign"></a>

Describes an outbound campaign.

## Request Syntax
<a name="API_connect-outbound-campaigns_DescribeCampaign_RequestSyntax"></a>

```
GET /campaigns/id HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns_DescribeCampaign_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns_DescribeCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_DescribeCampaign-request-uri-id"></a>
The identifier of the campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns_DescribeCampaign_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns_DescribeCampaign_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "campaign": { 
      "arn": "string",
      "connectInstanceId": "string",
      "dialerConfig": { ... },
      "id": "string",
      "name": "string",
      "outboundCallConfig": { 
         "answerMachineDetectionConfig": { 
            "awaitAnswerMachinePrompt": boolean,
            "enableAnswerMachineDetection": boolean
         },
         "connectContactFlowId": "string",
         "connectQueueId": "string",
         "connectSourcePhoneNumber": "string"
      },
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_connect-outbound-campaigns_DescribeCampaign_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [campaign](#API_connect-outbound-campaigns_DescribeCampaign_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns_DescribeCampaign-response-campaign"></a>
The campaign.  
Type: [Campaign](API_connect-outbound-campaigns_Campaign.md) object

## Errors
<a name="API_connect-outbound-campaigns_DescribeCampaign_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.   
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWSservice.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns_DescribeCampaign_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaigns-2021-01-30/DescribeCampaign) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaigns-2021-01-30/DescribeCampaign) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaigns-2021-01-30/DescribeCampaign) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaigns-2021-01-30/DescribeCampaign) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaigns-2021-01-30/DescribeCampaign) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaigns-2021-01-30/DescribeCampaign) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaigns-2021-01-30/DescribeCampaign) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaigns-2021-01-30/DescribeCampaign) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaigns-2021-01-30/DescribeCampaign) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaigns-2021-01-30/DescribeCampaign) 

# GetCampaignState
<a name="API_connect-outbound-campaigns_GetCampaignState"></a>

Returns the state of an outbound campaign.

## Request Syntax
<a name="API_connect-outbound-campaigns_GetCampaignState_RequestSyntax"></a>

```
GET /campaigns/id/state HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns_GetCampaignState_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns_GetCampaignState_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_GetCampaignState-request-uri-id"></a>
The identifier of the campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns_GetCampaignState_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns_GetCampaignState_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "state": "string"
}
```

## Response Elements
<a name="API_connect-outbound-campaigns_GetCampaignState_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [state](#API_connect-outbound-campaigns_GetCampaignState_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns_GetCampaignState-response-state"></a>
The state of a campaign. For detailed descriptions of each state, see [Campaign status](https://docs.aws.amazon.com/connect/latest/adminguide/enable-high-volume-outbound-communications.html#campaign-status) in the *Amazon Connect Administrator Guide*.  
Type: String  
Valid Values: `Initialized | Running | Paused | Stopped | Failed` 

## Errors
<a name="API_connect-outbound-campaigns_GetCampaignState_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.   
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWSservice.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns_GetCampaignState_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaigns-2021-01-30/GetCampaignState) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaigns-2021-01-30/GetCampaignState) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaigns-2021-01-30/GetCampaignState) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaigns-2021-01-30/GetCampaignState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaigns-2021-01-30/GetCampaignState) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaigns-2021-01-30/GetCampaignState) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaigns-2021-01-30/GetCampaignState) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaigns-2021-01-30/GetCampaignState) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaigns-2021-01-30/GetCampaignState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaigns-2021-01-30/GetCampaignState) 

# GetCampaignStateBatch
<a name="API_connect-outbound-campaigns_GetCampaignStateBatch"></a>

Returns the state of listed of outbound campaigns.

## Request Syntax
<a name="API_connect-outbound-campaigns_GetCampaignStateBatch_RequestSyntax"></a>

```
POST /campaigns-state HTTP/1.1
Content-type: application/json

{
   "campaignIds": [ "string" ]
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns_GetCampaignStateBatch_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_connect-outbound-campaigns_GetCampaignStateBatch_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [campaignIds](#API_connect-outbound-campaigns_GetCampaignStateBatch_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_GetCampaignStateBatch-request-campaignIds"></a>
The identifiers of the campaigns.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 25 items.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Response Syntax
<a name="API_connect-outbound-campaigns_GetCampaignStateBatch_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "failedRequests": [ 
      { 
         "campaignId": "string",
         "failureCode": "string"
      }
   ],
   "successfulRequests": [ 
      { 
         "campaignId": "string",
         "state": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-outbound-campaigns_GetCampaignStateBatch_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [failedRequests](#API_connect-outbound-campaigns_GetCampaignStateBatch_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns_GetCampaignStateBatch-response-failedRequests"></a>
Failed requests.  
Type: Array of [FailedCampaignStateResponse](API_connect-outbound-campaigns_FailedCampaignStateResponse.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.

 ** [successfulRequests](#API_connect-outbound-campaigns_GetCampaignStateBatch_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns_GetCampaignStateBatch-response-successfulRequests"></a>
Successful requests.  
Type: Array of [SuccessfulCampaignStateResponse](API_connect-outbound-campaigns_SuccessfulCampaignStateResponse.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.

## Errors
<a name="API_connect-outbound-campaigns_GetCampaignStateBatch_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.   
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWSservice.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns_GetCampaignStateBatch_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaigns-2021-01-30/GetCampaignStateBatch) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaigns-2021-01-30/GetCampaignStateBatch) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaigns-2021-01-30/GetCampaignStateBatch) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaigns-2021-01-30/GetCampaignStateBatch) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaigns-2021-01-30/GetCampaignStateBatch) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaigns-2021-01-30/GetCampaignStateBatch) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaigns-2021-01-30/GetCampaignStateBatch) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaigns-2021-01-30/GetCampaignStateBatch) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaigns-2021-01-30/GetCampaignStateBatch) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaigns-2021-01-30/GetCampaignStateBatch) 

# GetConnectInstanceConfig
<a name="API_connect-outbound-campaigns_GetConnectInstanceConfig"></a>

Get configuration information about an Amazon Connect instance.

## Request Syntax
<a name="API_connect-outbound-campaigns_GetConnectInstanceConfig_RequestSyntax"></a>

```
GET /connect-instance/connectInstanceId/config HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns_GetConnectInstanceConfig_RequestParameters"></a>

The request uses the following URI parameters.

 ** [connectInstanceId](#API_connect-outbound-campaigns_GetConnectInstanceConfig_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_GetConnectInstanceConfig-request-uri-connectInstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-_.a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns_GetConnectInstanceConfig_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns_GetConnectInstanceConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "connectInstanceConfig": { 
      "connectInstanceId": "string",
      "encryptionConfig": { 
         "enabled": boolean,
         "encryptionType": "string",
         "keyArn": "string"
      },
      "serviceLinkedRoleArn": "string"
   }
}
```

## Response Elements
<a name="API_connect-outbound-campaigns_GetConnectInstanceConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [connectInstanceConfig](#API_connect-outbound-campaigns_GetConnectInstanceConfig_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns_GetConnectInstanceConfig-response-connectInstanceConfig"></a>
Configuration information about the Amazon Connect instance.  
Type: [InstanceConfig](API_connect-outbound-campaigns_InstanceConfig.md) object

## Errors
<a name="API_connect-outbound-campaigns_GetConnectInstanceConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.   
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWSservice.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns_GetConnectInstanceConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaigns-2021-01-30/GetConnectInstanceConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaigns-2021-01-30/GetConnectInstanceConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaigns-2021-01-30/GetConnectInstanceConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaigns-2021-01-30/GetConnectInstanceConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaigns-2021-01-30/GetConnectInstanceConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaigns-2021-01-30/GetConnectInstanceConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaigns-2021-01-30/GetConnectInstanceConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaigns-2021-01-30/GetConnectInstanceConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaigns-2021-01-30/GetConnectInstanceConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaigns-2021-01-30/GetConnectInstanceConfig) 

# GetInstanceOnboardingJobStatus
<a name="API_connect-outbound-campaigns_GetInstanceOnboardingJobStatus"></a>

Gets the status of the workflow to onboard to outbound campaigns.

**Note**  
The `GetInstanceOnboardingJobStatus` API may return a 404 response in the following cases:  
The requested resource does not exist.
If the instance was onboarded more than 14 days ago, this API will return a 404 response as expected. In such cases, you should call the [GetConnectInstanceConfig](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-outbound-campaigns_GetConnectInstanceConfig.html) API to retrieve the instance details.

## Request Syntax
<a name="API_connect-outbound-campaigns_GetInstanceOnboardingJobStatus_RequestSyntax"></a>

```
GET /connect-instance/connectInstanceId/onboarding HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns_GetInstanceOnboardingJobStatus_RequestParameters"></a>

The request uses the following URI parameters.

 ** [connectInstanceId](#API_connect-outbound-campaigns_GetInstanceOnboardingJobStatus_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_GetInstanceOnboardingJobStatus-request-uri-connectInstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-_.a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns_GetInstanceOnboardingJobStatus_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns_GetInstanceOnboardingJobStatus_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "connectInstanceOnboardingJobStatus": { 
      "connectInstanceId": "string",
      "failureCode": "string",
      "status": "string"
   }
}
```

## Response Elements
<a name="API_connect-outbound-campaigns_GetInstanceOnboardingJobStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [connectInstanceOnboardingJobStatus](#API_connect-outbound-campaigns_GetInstanceOnboardingJobStatus_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns_GetInstanceOnboardingJobStatus-response-connectInstanceOnboardingJobStatus"></a>
The status of the onboarding workflow.  
Type: [InstanceOnboardingJobStatus](API_connect-outbound-campaigns_InstanceOnboardingJobStatus.md) object

## Errors
<a name="API_connect-outbound-campaigns_GetInstanceOnboardingJobStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.   
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWSservice.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns_GetInstanceOnboardingJobStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaigns-2021-01-30/GetInstanceOnboardingJobStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaigns-2021-01-30/GetInstanceOnboardingJobStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaigns-2021-01-30/GetInstanceOnboardingJobStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaigns-2021-01-30/GetInstanceOnboardingJobStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaigns-2021-01-30/GetInstanceOnboardingJobStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaigns-2021-01-30/GetInstanceOnboardingJobStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaigns-2021-01-30/GetInstanceOnboardingJobStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaigns-2021-01-30/GetInstanceOnboardingJobStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaigns-2021-01-30/GetInstanceOnboardingJobStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaigns-2021-01-30/GetInstanceOnboardingJobStatus) 

# ListCampaigns
<a name="API_connect-outbound-campaigns_ListCampaigns"></a>

Lists outbound campaigns.

## Request Syntax
<a name="API_connect-outbound-campaigns_ListCampaigns_RequestSyntax"></a>

```
POST /campaigns-summary HTTP/1.1
Content-type: application/json

{
   "filters": { 
      "instanceIdFilter": { 
         "operator": "string",
         "value": "string"
      }
   },
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns_ListCampaigns_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_connect-outbound-campaigns_ListCampaigns_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filters](#API_connect-outbound-campaigns_ListCampaigns_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_ListCampaigns-request-filters"></a>
Filters the list of campaigns.  
Type: [CampaignFilters](API_connect-outbound-campaigns_CampaignFilters.md) object  
Required: No

 ** [maxResults](#API_connect-outbound-campaigns_ListCampaigns_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_ListCampaigns-request-maxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [nextToken](#API_connect-outbound-campaigns_ListCampaigns_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_ListCampaigns-request-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Required: No

## Response Syntax
<a name="API_connect-outbound-campaigns_ListCampaigns_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "campaignSummaryList": [ 
      { 
         "arn": "string",
         "connectInstanceId": "string",
         "id": "string",
         "name": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_connect-outbound-campaigns_ListCampaigns_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [campaignSummaryList](#API_connect-outbound-campaigns_ListCampaigns_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns_ListCampaigns-response-campaignSummaryList"></a>
Summary information about the outbound campaigns.  
Type: Array of [CampaignSummary](API_connect-outbound-campaigns_CampaignSummary.md) objects

 ** [nextToken](#API_connect-outbound-campaigns_ListCampaigns_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns_ListCampaigns-response-nextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.

## Errors
<a name="API_connect-outbound-campaigns_ListCampaigns_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.   
HTTP Status Code: 500

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWSservice.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns_ListCampaigns_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaigns-2021-01-30/ListCampaigns) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaigns-2021-01-30/ListCampaigns) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaigns-2021-01-30/ListCampaigns) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaigns-2021-01-30/ListCampaigns) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaigns-2021-01-30/ListCampaigns) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaigns-2021-01-30/ListCampaigns) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaigns-2021-01-30/ListCampaigns) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaigns-2021-01-30/ListCampaigns) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaigns-2021-01-30/ListCampaigns) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaigns-2021-01-30/ListCampaigns) 

# ListTagsForResource
<a name="API_connect-outbound-campaigns_ListTagsForResource"></a>

Lists tags for a resource.

## Request Syntax
<a name="API_connect-outbound-campaigns_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/arn HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [arn](#API_connect-outbound-campaigns_ListTagsForResource_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_ListTagsForResource-request-uri-arn"></a>
The Amazon Resource Name (ARN).  
Length Constraints: Minimum length of 20. Maximum length of 500.  
Pattern: `arn:[a-zA-Z0-9-]+:[a-zA-Z0-9-]+:[a-z]{2}-[a-z]+-\d{1,2}:[a-zA-Z0-9-]+:[^:]+(?:/[^:]+)*(?:/[^:]+)?(?:\:[^:]+)?`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-outbound-campaigns_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tags](#API_connect-outbound-campaigns_ListTagsForResource_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns_ListTagsForResource-response-tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.

## Errors
<a name="API_connect-outbound-campaigns_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.   
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWSservice.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaigns-2021-01-30/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaigns-2021-01-30/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaigns-2021-01-30/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaigns-2021-01-30/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaigns-2021-01-30/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaigns-2021-01-30/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaigns-2021-01-30/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaigns-2021-01-30/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaigns-2021-01-30/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaigns-2021-01-30/ListTagsForResource) 

# PauseCampaign
<a name="API_connect-outbound-campaigns_PauseCampaign"></a>

Pauses an outbound campaign. A paused outbound campaign can be resumed.

## Request Syntax
<a name="API_connect-outbound-campaigns_PauseCampaign_RequestSyntax"></a>

```
POST /campaigns/id/pause HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns_PauseCampaign_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns_PauseCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_PauseCampaign-request-uri-id"></a>
The identifier of the campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns_PauseCampaign_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns_PauseCampaign_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns_PauseCampaign_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns_PauseCampaign_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.   
HTTP Status Code: 500

 ** InvalidCampaignStateException **   
An attempt was made to modify a campaign that is in a state that is not valid. Check your campaign to ensure that it is in a valid state before retrying the operation.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWSservice.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns_PauseCampaign_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaigns-2021-01-30/PauseCampaign) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaigns-2021-01-30/PauseCampaign) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaigns-2021-01-30/PauseCampaign) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaigns-2021-01-30/PauseCampaign) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaigns-2021-01-30/PauseCampaign) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaigns-2021-01-30/PauseCampaign) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaigns-2021-01-30/PauseCampaign) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaigns-2021-01-30/PauseCampaign) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaigns-2021-01-30/PauseCampaign) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaigns-2021-01-30/PauseCampaign) 

# PutDialRequestBatch
<a name="API_connect-outbound-campaigns_PutDialRequestBatch"></a>

Takes in a list of [DialRequests](https://docs.aws.amazon.com/connect-outbound/latest/APIReference/API_DialRequest.html) to be dialed as part of an outbound campaign. For more information about using PutDialRequestBatch, see [Best practices for using PutDialRequestBatch for outbound campaign calling](https://docs.aws.amazon.com/connect-outbound/latest/APIReference/api-outbound-campaign-calls.html). 

## Request Syntax
<a name="API_connect-outbound-campaigns_PutDialRequestBatch_RequestSyntax"></a>

```
PUT /campaigns/id/dial-requests HTTP/1.1
Content-type: application/json

{
   "dialRequests": [ 
      { 
         "attributes": { 
            "string" : "string" 
         },
         "clientToken": "string",
         "expirationTime": "string",
         "phoneNumber": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns_PutDialRequestBatch_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns_PutDialRequestBatch_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_PutDialRequestBatch-request-uri-id"></a>
The identifier of the campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns_PutDialRequestBatch_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [dialRequests](#API_connect-outbound-campaigns_PutDialRequestBatch_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_PutDialRequestBatch-request-dialRequests"></a>
Dial requests.  
Type: Array of [DialRequest](API_connect-outbound-campaigns_DialRequest.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 25 items.  
Required: Yes

## Response Syntax
<a name="API_connect-outbound-campaigns_PutDialRequestBatch_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "failedRequests": [ 
      { 
         "clientToken": "string",
         "failureCode": "string",
         "id": "string"
      }
   ],
   "successfulRequests": [ 
      { 
         "clientToken": "string",
         "id": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-outbound-campaigns_PutDialRequestBatch_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [failedRequests](#API_connect-outbound-campaigns_PutDialRequestBatch_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns_PutDialRequestBatch-response-failedRequests"></a>
Failed dial requests.  
Type: Array of [FailedRequest](API_connect-outbound-campaigns_FailedRequest.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.

 ** [successfulRequests](#API_connect-outbound-campaigns_PutDialRequestBatch_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns_PutDialRequestBatch-response-successfulRequests"></a>
Successful dial requests.  
Type: Array of [SuccessfulRequest](API_connect-outbound-campaigns_SuccessfulRequest.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.

## Errors
<a name="API_connect-outbound-campaigns_PutDialRequestBatch_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.   
HTTP Status Code: 500

 ** InvalidCampaignStateException **   
An attempt was made to modify a campaign that is in a state that is not valid. Check your campaign to ensure that it is in a valid state before retrying the operation.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWSservice.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns_PutDialRequestBatch_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaigns-2021-01-30/PutDialRequestBatch) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaigns-2021-01-30/PutDialRequestBatch) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaigns-2021-01-30/PutDialRequestBatch) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaigns-2021-01-30/PutDialRequestBatch) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaigns-2021-01-30/PutDialRequestBatch) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaigns-2021-01-30/PutDialRequestBatch) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaigns-2021-01-30/PutDialRequestBatch) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaigns-2021-01-30/PutDialRequestBatch) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaigns-2021-01-30/PutDialRequestBatch) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaigns-2021-01-30/PutDialRequestBatch) 

# ResumeCampaign
<a name="API_connect-outbound-campaigns_ResumeCampaign"></a>

Resumes an outbound campaign.

## Request Syntax
<a name="API_connect-outbound-campaigns_ResumeCampaign_RequestSyntax"></a>

```
POST /campaigns/id/resume HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns_ResumeCampaign_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns_ResumeCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_ResumeCampaign-request-uri-id"></a>
The identifier of the campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns_ResumeCampaign_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns_ResumeCampaign_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns_ResumeCampaign_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns_ResumeCampaign_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.   
HTTP Status Code: 500

 ** InvalidCampaignStateException **   
An attempt was made to modify a campaign that is in a state that is not valid. Check your campaign to ensure that it is in a valid state before retrying the operation.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWSservice.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns_ResumeCampaign_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaigns-2021-01-30/ResumeCampaign) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaigns-2021-01-30/ResumeCampaign) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaigns-2021-01-30/ResumeCampaign) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaigns-2021-01-30/ResumeCampaign) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaigns-2021-01-30/ResumeCampaign) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaigns-2021-01-30/ResumeCampaign) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaigns-2021-01-30/ResumeCampaign) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaigns-2021-01-30/ResumeCampaign) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaigns-2021-01-30/ResumeCampaign) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaigns-2021-01-30/ResumeCampaign) 

# StartCampaign
<a name="API_connect-outbound-campaigns_StartCampaign"></a>

Starts an outbound campaign.

## Request Syntax
<a name="API_connect-outbound-campaigns_StartCampaign_RequestSyntax"></a>

```
POST /campaigns/id/start HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns_StartCampaign_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns_StartCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_StartCampaign-request-uri-id"></a>
The identifier of the campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns_StartCampaign_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns_StartCampaign_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns_StartCampaign_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns_StartCampaign_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.   
HTTP Status Code: 500

 ** InvalidCampaignStateException **   
An attempt was made to modify a campaign that is in a state that is not valid. Check your campaign to ensure that it is in a valid state before retrying the operation.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWSservice.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns_StartCampaign_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaigns-2021-01-30/StartCampaign) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaigns-2021-01-30/StartCampaign) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaigns-2021-01-30/StartCampaign) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaigns-2021-01-30/StartCampaign) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaigns-2021-01-30/StartCampaign) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaigns-2021-01-30/StartCampaign) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaigns-2021-01-30/StartCampaign) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaigns-2021-01-30/StartCampaign) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaigns-2021-01-30/StartCampaign) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaigns-2021-01-30/StartCampaign) 

# StartInstanceOnboardingJob
<a name="API_connect-outbound-campaigns_StartInstanceOnboardingJob"></a>

Starts the workflow to onboard an Amazon Connect instance to outbound campaigns.

**Note**  
If the current [InstanceOnboardingJobStatus](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-outbound-campaigns_InstanceOnboardingJobStatus.html) is **FAILED**, the `StartInstanceOnboardingJob` API will continue to return the existing status for 14 days from the initial attempt. To reattempt onboarding, first call the [DeleteInstanceOnboardingJob](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-outbound-campaigns_DeleteInstanceOnboardingJob.html) API, then invoke the `StartInstanceOnboardingJob` API again.

## Request Syntax
<a name="API_connect-outbound-campaigns_StartInstanceOnboardingJob_RequestSyntax"></a>

```
PUT /connect-instance/connectInstanceId/onboarding HTTP/1.1
Content-type: application/json

{
   "encryptionConfig": { 
      "enabled": boolean,
      "encryptionType": "string",
      "keyArn": "string"
   }
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns_StartInstanceOnboardingJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [connectInstanceId](#API_connect-outbound-campaigns_StartInstanceOnboardingJob_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_StartInstanceOnboardingJob-request-uri-connectInstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-_.a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns_StartInstanceOnboardingJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [encryptionConfig](#API_connect-outbound-campaigns_StartInstanceOnboardingJob_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_StartInstanceOnboardingJob-request-encryptionConfig"></a>
Encryption configuration for an Amazon Connect instance.  
Type: [EncryptionConfig](API_connect-outbound-campaigns_EncryptionConfig.md) object  
Required: Yes

## Response Syntax
<a name="API_connect-outbound-campaigns_StartInstanceOnboardingJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "connectInstanceOnboardingJobStatus": { 
      "connectInstanceId": "string",
      "failureCode": "string",
      "status": "string"
   }
}
```

## Response Elements
<a name="API_connect-outbound-campaigns_StartInstanceOnboardingJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [connectInstanceOnboardingJobStatus](#API_connect-outbound-campaigns_StartInstanceOnboardingJob_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns_StartInstanceOnboardingJob-response-connectInstanceOnboardingJobStatus"></a>
The status of the onboarding workflow.  
Type: [InstanceOnboardingJobStatus](API_connect-outbound-campaigns_InstanceOnboardingJobStatus.md) object

## Errors
<a name="API_connect-outbound-campaigns_StartInstanceOnboardingJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.   
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWSservice.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns_StartInstanceOnboardingJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaigns-2021-01-30/StartInstanceOnboardingJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaigns-2021-01-30/StartInstanceOnboardingJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaigns-2021-01-30/StartInstanceOnboardingJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaigns-2021-01-30/StartInstanceOnboardingJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaigns-2021-01-30/StartInstanceOnboardingJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaigns-2021-01-30/StartInstanceOnboardingJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaigns-2021-01-30/StartInstanceOnboardingJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaigns-2021-01-30/StartInstanceOnboardingJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaigns-2021-01-30/StartInstanceOnboardingJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaigns-2021-01-30/StartInstanceOnboardingJob) 

# StopCampaign
<a name="API_connect-outbound-campaigns_StopCampaign"></a>

Stops an Amazon Connect campaign. When this API is called, no more calls are dialed for the campaign. Inflight contacts aren't impacted.

## Request Syntax
<a name="API_connect-outbound-campaigns_StopCampaign_RequestSyntax"></a>

```
POST /campaigns/id/stop HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns_StopCampaign_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns_StopCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_StopCampaign-request-uri-id"></a>
The identifier of the campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns_StopCampaign_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns_StopCampaign_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns_StopCampaign_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns_StopCampaign_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.   
HTTP Status Code: 500

 ** InvalidCampaignStateException **   
An attempt was made to modify a campaign that is in a state that is not valid. Check your campaign to ensure that it is in a valid state before retrying the operation.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWSservice.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns_StopCampaign_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaigns-2021-01-30/StopCampaign) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaigns-2021-01-30/StopCampaign) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaigns-2021-01-30/StopCampaign) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaigns-2021-01-30/StopCampaign) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaigns-2021-01-30/StopCampaign) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaigns-2021-01-30/StopCampaign) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaigns-2021-01-30/StopCampaign) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaigns-2021-01-30/StopCampaign) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaigns-2021-01-30/StopCampaign) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaigns-2021-01-30/StopCampaign) 

# TagResource
<a name="API_connect-outbound-campaigns_TagResource"></a>

Adds the specified tags to a resource.

## Request Syntax
<a name="API_connect-outbound-campaigns_TagResource_RequestSyntax"></a>

```
POST /tags/arn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [arn](#API_connect-outbound-campaigns_TagResource_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_TagResource-request-uri-arn"></a>
The Amazon Resource Name (ARN).  
Length Constraints: Minimum length of 20. Maximum length of 500.  
Pattern: `arn:[a-zA-Z0-9-]+:[a-zA-Z0-9-]+:[a-z]{2}-[a-z]+-\d{1,2}:[a-zA-Z0-9-]+:[^:]+(?:/[^:]+)*(?:/[^:]+)?(?:\:[^:]+)?`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [tags](#API_connect-outbound-campaigns_TagResource_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_TagResource-request-tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

## Response Syntax
<a name="API_connect-outbound-campaigns_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.   
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWSservice.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaigns-2021-01-30/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaigns-2021-01-30/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaigns-2021-01-30/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaigns-2021-01-30/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaigns-2021-01-30/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaigns-2021-01-30/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaigns-2021-01-30/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaigns-2021-01-30/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaigns-2021-01-30/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaigns-2021-01-30/TagResource) 

# UntagResource
<a name="API_connect-outbound-campaigns_UntagResource"></a>

Removes the specified tags from the specified resource.

## Request Syntax
<a name="API_connect-outbound-campaigns_UntagResource_RequestSyntax"></a>

```
DELETE /tags/arn?tagKeys=tagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [arn](#API_connect-outbound-campaigns_UntagResource_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_UntagResource-request-uri-arn"></a>
The Amazon Resource Name (ARN).  
Length Constraints: Minimum length of 20. Maximum length of 500.  
Pattern: `arn:[a-zA-Z0-9-]+:[a-zA-Z0-9-]+:[a-z]{2}-[a-z]+-\d{1,2}:[a-zA-Z0-9-]+:[^:]+(?:/[^:]+)*(?:/[^:]+)?(?:\:[^:]+)?`   
Required: Yes

 ** [tagKeys](#API_connect-outbound-campaigns_UntagResource_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_UntagResource-request-uri-tagKeys"></a>
The tag keys.  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.   
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWSservice.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaigns-2021-01-30/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaigns-2021-01-30/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaigns-2021-01-30/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaigns-2021-01-30/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaigns-2021-01-30/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaigns-2021-01-30/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaigns-2021-01-30/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaigns-2021-01-30/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaigns-2021-01-30/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaigns-2021-01-30/UntagResource) 

# UpdateCampaignDialerConfig
<a name="API_connect-outbound-campaigns_UpdateCampaignDialerConfig"></a>

Updates [DialerConfig](https://docs.aws.amazon.com/connect-outbound/latest/APIReference/API_DialerConfig.html) for an outbound campaign.

## Request Syntax
<a name="API_connect-outbound-campaigns_UpdateCampaignDialerConfig_RequestSyntax"></a>

```
POST /campaigns/id/dialer-config HTTP/1.1
Content-type: application/json

{
   "dialerConfig": { ... }
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns_UpdateCampaignDialerConfig_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns_UpdateCampaignDialerConfig_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_UpdateCampaignDialerConfig-request-uri-id"></a>
The identifier of the campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns_UpdateCampaignDialerConfig_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [dialerConfig](#API_connect-outbound-campaigns_UpdateCampaignDialerConfig_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_UpdateCampaignDialerConfig-request-dialerConfig"></a>
Dialer configuration for an outbound campaign.   
Type: [DialerConfig](API_connect-outbound-campaigns_DialerConfig.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## Response Syntax
<a name="API_connect-outbound-campaigns_UpdateCampaignDialerConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns_UpdateCampaignDialerConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns_UpdateCampaignDialerConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.   
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWSservice.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns_UpdateCampaignDialerConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaigns-2021-01-30/UpdateCampaignDialerConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaigns-2021-01-30/UpdateCampaignDialerConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaigns-2021-01-30/UpdateCampaignDialerConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaigns-2021-01-30/UpdateCampaignDialerConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaigns-2021-01-30/UpdateCampaignDialerConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaigns-2021-01-30/UpdateCampaignDialerConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaigns-2021-01-30/UpdateCampaignDialerConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaigns-2021-01-30/UpdateCampaignDialerConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaigns-2021-01-30/UpdateCampaignDialerConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaigns-2021-01-30/UpdateCampaignDialerConfig) 

# UpdateCampaignName
<a name="API_connect-outbound-campaigns_UpdateCampaignName"></a>

Updates the name of an outbound campaign.

## Request Syntax
<a name="API_connect-outbound-campaigns_UpdateCampaignName_RequestSyntax"></a>

```
POST /campaigns/id/name HTTP/1.1
Content-type: application/json

{
   "name": "string"
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns_UpdateCampaignName_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns_UpdateCampaignName_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_UpdateCampaignName-request-uri-id"></a>
The identifier of the campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns_UpdateCampaignName_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [name](#API_connect-outbound-campaigns_UpdateCampaignName_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_UpdateCampaignName-request-name"></a>
The name of the campaign.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Required: Yes

## Response Syntax
<a name="API_connect-outbound-campaigns_UpdateCampaignName_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns_UpdateCampaignName_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns_UpdateCampaignName_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.   
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWSservice.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns_UpdateCampaignName_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaigns-2021-01-30/UpdateCampaignName) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaigns-2021-01-30/UpdateCampaignName) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaigns-2021-01-30/UpdateCampaignName) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaigns-2021-01-30/UpdateCampaignName) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaigns-2021-01-30/UpdateCampaignName) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaigns-2021-01-30/UpdateCampaignName) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaigns-2021-01-30/UpdateCampaignName) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaigns-2021-01-30/UpdateCampaignName) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaigns-2021-01-30/UpdateCampaignName) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaigns-2021-01-30/UpdateCampaignName) 

# UpdateCampaignOutboundCallConfig
<a name="API_connect-outbound-campaigns_UpdateCampaignOutboundCallConfig"></a>

Updates [OutboundCallConfig](https://docs.aws.amazon.com/connect-outbound/latest/APIReference/API_OutboundCallConfig.html) for an outbound campaign.

## Request Syntax
<a name="API_connect-outbound-campaigns_UpdateCampaignOutboundCallConfig_RequestSyntax"></a>

```
POST /campaigns/id/outbound-call-config HTTP/1.1
Content-type: application/json

{
   "answerMachineDetectionConfig": { 
      "awaitAnswerMachinePrompt": boolean,
      "enableAnswerMachineDetection": boolean
   },
   "connectContactFlowId": "string",
   "connectSourcePhoneNumber": "string"
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns_UpdateCampaignOutboundCallConfig_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns_UpdateCampaignOutboundCallConfig_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_UpdateCampaignOutboundCallConfig-request-uri-id"></a>
The identifier of the campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns_UpdateCampaignOutboundCallConfig_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [answerMachineDetectionConfig](#API_connect-outbound-campaigns_UpdateCampaignOutboundCallConfig_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_UpdateCampaignOutboundCallConfig-request-answerMachineDetectionConfig"></a>
Information about answering machine detection.  
Type: [AnswerMachineDetectionConfig](API_connect-outbound-campaigns_AnswerMachineDetectionConfig.md) object  
Required: No

 ** [connectContactFlowId](#API_connect-outbound-campaigns_UpdateCampaignOutboundCallConfig_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_UpdateCampaignOutboundCallConfig-request-connectContactFlowId"></a>
The identifier of the published flow associated with this campaign.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 500.  
Required: No

 ** [connectSourcePhoneNumber](#API_connect-outbound-campaigns_UpdateCampaignOutboundCallConfig_RequestSyntax) **   <a name="connect-connect-outbound-campaigns_UpdateCampaignOutboundCallConfig-request-connectSourcePhoneNumber"></a>
The outbound phone number associated with this campaign. Only ported or claimed Amazon Connect phone numbers are allowed.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 100.  
Required: No

## Response Syntax
<a name="API_connect-outbound-campaigns_UpdateCampaignOutboundCallConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns_UpdateCampaignOutboundCallConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns_UpdateCampaignOutboundCallConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.   
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWSservice.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns_UpdateCampaignOutboundCallConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaigns-2021-01-30/UpdateCampaignOutboundCallConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaigns-2021-01-30/UpdateCampaignOutboundCallConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaigns-2021-01-30/UpdateCampaignOutboundCallConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaigns-2021-01-30/UpdateCampaignOutboundCallConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaigns-2021-01-30/UpdateCampaignOutboundCallConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaigns-2021-01-30/UpdateCampaignOutboundCallConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaigns-2021-01-30/UpdateCampaignOutboundCallConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaigns-2021-01-30/UpdateCampaignOutboundCallConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaigns-2021-01-30/UpdateCampaignOutboundCallConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaigns-2021-01-30/UpdateCampaignOutboundCallConfig) 

# Amazon Connect Outbound Campaigns V2
<a name="API_Operations_Amazon_Connect_Outbound_Campaigns_V2"></a>

The following actions are supported by Amazon Connect Outbound Campaigns V2:
+  [CreateCampaign](API_connect-outbound-campaigns-v2_CreateCampaign.md) 
+  [DeleteCampaign](API_connect-outbound-campaigns-v2_DeleteCampaign.md) 
+  [DeleteCampaignChannelSubtypeConfig](API_connect-outbound-campaigns-v2_DeleteCampaignChannelSubtypeConfig.md) 
+  [DeleteCampaignCommunicationLimits](API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationLimits.md) 
+  [DeleteCampaignCommunicationTime](API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationTime.md) 
+  [DeleteConnectInstanceConfig](API_connect-outbound-campaigns-v2_DeleteConnectInstanceConfig.md) 
+  [DeleteConnectInstanceIntegration](API_connect-outbound-campaigns-v2_DeleteConnectInstanceIntegration.md) 
+  [DeleteInstanceOnboardingJob](API_connect-outbound-campaigns-v2_DeleteInstanceOnboardingJob.md) 
+  [DescribeCampaign](API_connect-outbound-campaigns-v2_DescribeCampaign.md) 
+  [GetCampaignState](API_connect-outbound-campaigns-v2_GetCampaignState.md) 
+  [GetCampaignStateBatch](API_connect-outbound-campaigns-v2_GetCampaignStateBatch.md) 
+  [GetConnectInstanceConfig](API_connect-outbound-campaigns-v2_GetConnectInstanceConfig.md) 
+  [GetInstanceOnboardingJobStatus](API_connect-outbound-campaigns-v2_GetInstanceOnboardingJobStatus.md) 
+  [ListCampaigns](API_connect-outbound-campaigns-v2_ListCampaigns.md) 
+  [ListConnectInstanceIntegrations](API_connect-outbound-campaigns-v2_ListConnectInstanceIntegrations.md) 
+  [ListTagsForResource](API_connect-outbound-campaigns-v2_ListTagsForResource.md) 
+  [PauseCampaign](API_connect-outbound-campaigns-v2_PauseCampaign.md) 
+  [PutConnectInstanceIntegration](API_connect-outbound-campaigns-v2_PutConnectInstanceIntegration.md) 
+  [PutOutboundRequestBatch](API_connect-outbound-campaigns-v2_PutOutboundRequestBatch.md) 
+  [PutProfileOutboundRequestBatch](API_connect-outbound-campaigns-v2_PutProfileOutboundRequestBatch.md) 
+  [ResumeCampaign](API_connect-outbound-campaigns-v2_ResumeCampaign.md) 
+  [StartCampaign](API_connect-outbound-campaigns-v2_StartCampaign.md) 
+  [StartInstanceOnboardingJob](API_connect-outbound-campaigns-v2_StartInstanceOnboardingJob.md) 
+  [StopCampaign](API_connect-outbound-campaigns-v2_StopCampaign.md) 
+  [TagResource](API_connect-outbound-campaigns-v2_TagResource.md) 
+  [UntagResource](API_connect-outbound-campaigns-v2_UntagResource.md) 
+  [UpdateCampaignChannelSubtypeConfig](API_connect-outbound-campaigns-v2_UpdateCampaignChannelSubtypeConfig.md) 
+  [UpdateCampaignCommunicationLimits](API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationLimits.md) 
+  [UpdateCampaignCommunicationTime](API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationTime.md) 
+  [UpdateCampaignFlowAssociation](API_connect-outbound-campaigns-v2_UpdateCampaignFlowAssociation.md) 
+  [UpdateCampaignName](API_connect-outbound-campaigns-v2_UpdateCampaignName.md) 
+  [UpdateCampaignSchedule](API_connect-outbound-campaigns-v2_UpdateCampaignSchedule.md) 
+  [UpdateCampaignSource](API_connect-outbound-campaigns-v2_UpdateCampaignSource.md) 

# CreateCampaign
<a name="API_connect-outbound-campaigns-v2_CreateCampaign"></a>

 Creates an outbound campaign. 

**Note**  
For users to be able to view or edit a campaign at a later date by using the Amazon Connect user interface, you must add the instance ID as a tag. For example, `{ "tags": {"owner": "arn:aws:connect:{REGION}:{AWS_ACCOUNT_ID}:instance/{CONNECT_INSTANCE_ID}"}}`.
After a campaign is created, you can't add/remove source.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_CreateCampaign_RequestSyntax"></a>

```
PUT /v2/campaigns HTTP/1.1
Content-type: application/json

{
   "channelSubtypeConfig": { 
      "email": { 
         "capacity": number,
         "defaultOutboundConfig": { 
            "connectSourceEmailAddress": "string",
            "sourceEmailAddressDisplayName": "string",
            "wisdomTemplateArn": "string"
         },
         "outboundMode": { ... }
      },
      "sms": { 
         "capacity": number,
         "defaultOutboundConfig": { 
            "connectSourcePhoneNumberArn": "string",
            "wisdomTemplateArn": "string"
         },
         "outboundMode": { ... }
      },
      "telephony": { 
         "capacity": number,
         "connectQueueId": "string",
         "defaultOutboundConfig": { 
            "answerMachineDetectionConfig": { 
               "awaitAnswerMachinePrompt": boolean,
               "enableAnswerMachineDetection": boolean
            },
            "connectContactFlowId": "string",
            "connectSourcePhoneNumber": "string",
            "ringTimeout": number
         },
         "outboundMode": { ... }
      },
      "whatsApp": { 
         "capacity": number,
         "defaultOutboundConfig": { 
            "connectSourcePhoneNumberArn": "string",
            "wisdomTemplateArn": "string"
         },
         "outboundMode": { ... }
      }
   },
   "communicationLimitsOverride": { 
      "allChannelSubtypes": { ... },
      "instanceLimitsHandling": "string"
   },
   "communicationTimeConfig": { 
      "email": { 
         "openHours": { ... },
         "restrictedPeriods": { ... }
      },
      "localTimeZoneConfig": { 
         "defaultTimeZone": "string",
         "localTimeZoneDetection": [ "string" ]
      },
      "sms": { 
         "openHours": { ... },
         "restrictedPeriods": { ... }
      },
      "telephony": { 
         "openHours": { ... },
         "restrictedPeriods": { ... }
      },
      "whatsApp": { 
         "openHours": { ... },
         "restrictedPeriods": { ... }
      }
   },
   "connectCampaignFlowArn": "string",
   "connectInstanceId": "string",
   "name": "string",
   "schedule": { 
      "endTime": "string",
      "refreshFrequency": "string",
      "startTime": "string"
   },
   "source": { ... },
   "tags": { 
      "string" : "string" 
   },
   "type": "string"
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_CreateCampaign_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_connect-outbound-campaigns-v2_CreateCampaign_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [channelSubtypeConfig](#API_connect-outbound-campaigns-v2_CreateCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_CreateCampaign-request-channelSubtypeConfig"></a>
Channel subtype configuration for an outbound campaign.  
Type: [ChannelSubtypeConfig](API_connect-outbound-campaigns-v2_ChannelSubtypeConfig.md) object  
Required: No

 ** [communicationLimitsOverride](#API_connect-outbound-campaigns-v2_CreateCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_CreateCampaign-request-communicationLimitsOverride"></a>
Communication limits configuration for an outbound campaign.  
Type: [CommunicationLimitsConfig](API_connect-outbound-campaigns-v2_CommunicationLimitsConfig.md) object  
Required: No

 ** [communicationTimeConfig](#API_connect-outbound-campaigns-v2_CreateCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_CreateCampaign-request-communicationTimeConfig"></a>
Communication time configuration for an outbound campaign.  
Type: [CommunicationTimeConfig](API_connect-outbound-campaigns-v2_CommunicationTimeConfig.md) object  
Required: No

 ** [connectCampaignFlowArn](#API_connect-outbound-campaigns-v2_CreateCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_CreateCampaign-request-connectCampaignFlowArn"></a>
The Amazon Resource Name (ARN) of the Amazon Connect campaign flow.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 500.  
Pattern: `arn:[a-zA-Z0-9-]+:[a-zA-Z0-9-]+:[a-z]{2}-[a-z]+-\d{1,2}:[a-zA-Z0-9-]+:[^:]+(?:/[^:]+)*(?:/[^:]+)?(?:\:[^:]+)?`   
Required: No

 ** [connectInstanceId](#API_connect-outbound-campaigns-v2_CreateCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_CreateCampaign-request-connectInstanceId"></a>
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-_.a-zA-Z0-9]+`   
Required: Yes

 ** [name](#API_connect-outbound-campaigns-v2_CreateCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_CreateCampaign-request-name"></a>
The name of the campaign.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Required: Yes

 ** [schedule](#API_connect-outbound-campaigns-v2_CreateCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_CreateCampaign-request-schedule"></a>
Schedule configuration for an outbound campaign.  
Type: [Schedule](API_connect-outbound-campaigns-v2_Schedule.md) object  
Required: No

 ** [source](#API_connect-outbound-campaigns-v2_CreateCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_CreateCampaign-request-source"></a>
Source configuration for an outbound campaign.  
Type: [Source](API_connect-outbound-campaigns-v2_Source.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [tags](#API_connect-outbound-campaigns-v2_CreateCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_CreateCampaign-request-tags"></a>
The tags used to organize, track, or control access for this resource. For example, `{ "tags": {"key1":"value1", "key2":"value2"} }`.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: No

 ** [type](#API_connect-outbound-campaigns-v2_CreateCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_CreateCampaign-request-type"></a>
The type of campaign.  
Type: String  
Valid Values: `MANAGED | JOURNEY`   
Required: No

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_CreateCampaign_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "id": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_CreateCampaign_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [arn](#API_connect-outbound-campaigns-v2_CreateCampaign_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns-v2_CreateCampaign-response-arn"></a>
The Amazon Resource Name (ARN) of the outbound campaign.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 500.

 ** [id](#API_connect-outbound-campaigns-v2_CreateCampaign_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns-v2_CreateCampaign-response-id"></a>
The identifier of the outbound campaign.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+` 

 ** [tags](#API_connect-outbound-campaigns-v2_CreateCampaign_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns-v2_CreateCampaign-response-tags"></a>
The tags used to organize, track, or control access for this resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.

## Errors
<a name="API_connect-outbound-campaigns-v2_CreateCampaign_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of a conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota for your Amazon Connect has been exceeded. Contact AWS Support.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_CreateCampaign_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/CreateCampaign) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/CreateCampaign) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/CreateCampaign) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/CreateCampaign) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/CreateCampaign) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/CreateCampaign) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/CreateCampaign) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/CreateCampaign) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/CreateCampaign) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/CreateCampaign) 

# DeleteCampaign
<a name="API_connect-outbound-campaigns-v2_DeleteCampaign"></a>

Deletes an outbound campaign. Only campaigns in `Initialized`, `Failed`, `Completed`, or `Stopped` states are valid for this operation.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_DeleteCampaign_RequestSyntax"></a>

```
DELETE /v2/campaigns/id HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_DeleteCampaign_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns-v2_DeleteCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_DeleteCampaign-request-uri-id"></a>
The identifier of the outbound campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_DeleteCampaign_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_DeleteCampaign_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_DeleteCampaign_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns-v2_DeleteCampaign_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_DeleteCampaign_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/DeleteCampaign) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/DeleteCampaign) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/DeleteCampaign) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/DeleteCampaign) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/DeleteCampaign) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/DeleteCampaign) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/DeleteCampaign) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/DeleteCampaign) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/DeleteCampaign) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/DeleteCampaign) 

# DeleteCampaignChannelSubtypeConfig
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignChannelSubtypeConfig"></a>

Deletes the channel subtype configuration of an outbound campaign. Only campaigns in the `Initialized` state are valid for this operation.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignChannelSubtypeConfig_RequestSyntax"></a>

```
DELETE /v2/campaigns/id/channel-subtype-config?channelSubtype=channelSubtype HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignChannelSubtypeConfig_RequestParameters"></a>

The request uses the following URI parameters.

 ** [channelSubtype](#API_connect-outbound-campaigns-v2_DeleteCampaignChannelSubtypeConfig_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_DeleteCampaignChannelSubtypeConfig-request-uri-channelSubtype"></a>
The name of the channel subtype configuration.  
Valid Values: `TELEPHONY | SMS | EMAIL | WHATSAPP`   
Required: Yes

 ** [id](#API_connect-outbound-campaigns-v2_DeleteCampaignChannelSubtypeConfig_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_DeleteCampaignChannelSubtypeConfig-request-uri-id"></a>
The identifier of the outbound campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignChannelSubtypeConfig_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignChannelSubtypeConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignChannelSubtypeConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignChannelSubtypeConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of a conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignChannelSubtypeConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/DeleteCampaignChannelSubtypeConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/DeleteCampaignChannelSubtypeConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/DeleteCampaignChannelSubtypeConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/DeleteCampaignChannelSubtypeConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/DeleteCampaignChannelSubtypeConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/DeleteCampaignChannelSubtypeConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/DeleteCampaignChannelSubtypeConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/DeleteCampaignChannelSubtypeConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/DeleteCampaignChannelSubtypeConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/DeleteCampaignChannelSubtypeConfig) 

# DeleteCampaignCommunicationLimits
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationLimits"></a>

Deletes the communication limits configuration of an outbound campaign. Only campaigns in the `Initialized` state are valid for this operation.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationLimits_RequestSyntax"></a>

```
DELETE /v2/campaigns/id/communication-limits?config=config HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationLimits_RequestParameters"></a>

The request uses the following URI parameters.

 ** [config](#API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationLimits_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_DeleteCampaignCommunicationLimits-request-uri-config"></a>
The name of the communication limits configuration.  
Valid Values: `ALL_CHANNEL_SUBTYPES`   
Required: Yes

 ** [id](#API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationLimits_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_DeleteCampaignCommunicationLimits-request-uri-id"></a>
The identifier of the outbound campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationLimits_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationLimits_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationLimits_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationLimits_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of a conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** InvalidCampaignStateException **   
An attempt was made to modify a campaign that is in a state that is not valid. Check your campaign to ensure that it is in a valid state before retrying the operation.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationLimits_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationLimits) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationLimits) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationLimits) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationLimits) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationLimits) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationLimits) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationLimits) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationLimits) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationLimits) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationLimits) 

# DeleteCampaignCommunicationTime
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationTime"></a>

Deletes the communication time configuration of an outbound campaign. Only campaigns in the `Initialized` state are valid for this operation.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationTime_RequestSyntax"></a>

```
DELETE /v2/campaigns/id/communication-time?config=config HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationTime_RequestParameters"></a>

The request uses the following URI parameters.

 ** [config](#API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationTime_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_DeleteCampaignCommunicationTime-request-uri-config"></a>
The name of the communication time configuration.  
Valid Values: `TELEPHONY | SMS | EMAIL | WHATSAPP`   
Required: Yes

 ** [id](#API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationTime_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_DeleteCampaignCommunicationTime-request-uri-id"></a>
The identifier of the outbound campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationTime_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationTime_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationTime_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationTime_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of a conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** InvalidCampaignStateException **   
An attempt was made to modify a campaign that is in a state that is not valid. Check your campaign to ensure that it is in a valid state before retrying the operation.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_DeleteCampaignCommunicationTime_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationTime) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationTime) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationTime) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationTime) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationTime) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationTime) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationTime) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationTime) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationTime) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/DeleteCampaignCommunicationTime) 

# DeleteConnectInstanceConfig
<a name="API_connect-outbound-campaigns-v2_DeleteConnectInstanceConfig"></a>

Deletes configuration information for an Amazon Connect instance.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_DeleteConnectInstanceConfig_RequestSyntax"></a>

```
DELETE /v2/connect-instance/connectInstanceId/config?campaignDeletionPolicy=campaignDeletionPolicy HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_DeleteConnectInstanceConfig_RequestParameters"></a>

The request uses the following URI parameters.

 ** [campaignDeletionPolicy](#API_connect-outbound-campaigns-v2_DeleteConnectInstanceConfig_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_DeleteConnectInstanceConfig-request-uri-campaignDeletionPolicy"></a>
The policy to enact on existing campaigns during instance configuration deletion. The default is `RETAIN_ALL`, if no value is given.  
Valid Values: `RETAIN_ALL | DELETE_ALL` 

 ** [connectInstanceId](#API_connect-outbound-campaigns-v2_DeleteConnectInstanceConfig_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_DeleteConnectInstanceConfig-request-uri-connectInstanceId"></a>
The identifier of the Amazon Connect instance. You can find the `instanceId` in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-_.a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_DeleteConnectInstanceConfig_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_DeleteConnectInstanceConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_DeleteConnectInstanceConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns-v2_DeleteConnectInstanceConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** InvalidStateException **   
An attempt was made to modify a resource that is in a state that is not valid.   
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_DeleteConnectInstanceConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/DeleteConnectInstanceConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/DeleteConnectInstanceConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/DeleteConnectInstanceConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/DeleteConnectInstanceConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/DeleteConnectInstanceConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/DeleteConnectInstanceConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/DeleteConnectInstanceConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/DeleteConnectInstanceConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/DeleteConnectInstanceConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/DeleteConnectInstanceConfig) 

# DeleteConnectInstanceIntegration
<a name="API_connect-outbound-campaigns-v2_DeleteConnectInstanceIntegration"></a>

Deletes integration for an Amazon Connect instance.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_DeleteConnectInstanceIntegration_RequestSyntax"></a>

```
POST /v2/connect-instance/connectInstanceId/integrations/delete HTTP/1.1
Content-type: application/json

{
   "integrationIdentifier": { ... }
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_DeleteConnectInstanceIntegration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [connectInstanceId](#API_connect-outbound-campaigns-v2_DeleteConnectInstanceIntegration_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_DeleteConnectInstanceIntegration-request-uri-connectInstanceId"></a>
The identifier of the Amazon Connect instance. You can find the `instanceId` in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-_.a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_DeleteConnectInstanceIntegration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [integrationIdentifier](#API_connect-outbound-campaigns-v2_DeleteConnectInstanceIntegration_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_DeleteConnectInstanceIntegration-request-integrationIdentifier"></a>
The identifier of the integration between an Amazon Connect instance and other services.  
Type: [IntegrationIdentifier](API_connect-outbound-campaigns-v2_IntegrationIdentifier.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_DeleteConnectInstanceIntegration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_DeleteConnectInstanceIntegration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns-v2_DeleteConnectInstanceIntegration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_DeleteConnectInstanceIntegration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/DeleteConnectInstanceIntegration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/DeleteConnectInstanceIntegration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/DeleteConnectInstanceIntegration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/DeleteConnectInstanceIntegration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/DeleteConnectInstanceIntegration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/DeleteConnectInstanceIntegration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/DeleteConnectInstanceIntegration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/DeleteConnectInstanceIntegration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/DeleteConnectInstanceIntegration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/DeleteConnectInstanceIntegration) 

# DeleteInstanceOnboardingJob
<a name="API_connect-outbound-campaigns-v2_DeleteInstanceOnboardingJob"></a>

Deletes the workflow to onboard to outbound campaigns. Only `Failed` workflows can be deleted.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_DeleteInstanceOnboardingJob_RequestSyntax"></a>

```
DELETE /v2/connect-instance/connectInstanceId/onboarding HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_DeleteInstanceOnboardingJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [connectInstanceId](#API_connect-outbound-campaigns-v2_DeleteInstanceOnboardingJob_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_DeleteInstanceOnboardingJob-request-uri-connectInstanceId"></a>
The identifier of the Amazon Connect instance. You can find the `instanceId` in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-_.a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_DeleteInstanceOnboardingJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_DeleteInstanceOnboardingJob_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_DeleteInstanceOnboardingJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns-v2_DeleteInstanceOnboardingJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** InvalidStateException **   
An attempt was made to modify a resource that is in a state that is not valid.   
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_DeleteInstanceOnboardingJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/DeleteInstanceOnboardingJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/DeleteInstanceOnboardingJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/DeleteInstanceOnboardingJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/DeleteInstanceOnboardingJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/DeleteInstanceOnboardingJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/DeleteInstanceOnboardingJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/DeleteInstanceOnboardingJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/DeleteInstanceOnboardingJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/DeleteInstanceOnboardingJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/DeleteInstanceOnboardingJob) 

# DescribeCampaign
<a name="API_connect-outbound-campaigns-v2_DescribeCampaign"></a>

Describes an outbound campaign.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_DescribeCampaign_RequestSyntax"></a>

```
GET /v2/campaigns/id HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_DescribeCampaign_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns-v2_DescribeCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_DescribeCampaign-request-uri-id"></a>
The identifier of the outbound campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_DescribeCampaign_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_DescribeCampaign_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "campaign": { 
      "arn": "string",
      "channelSubtypeConfig": { 
         "email": { 
            "capacity": number,
            "defaultOutboundConfig": { 
               "connectSourceEmailAddress": "string",
               "sourceEmailAddressDisplayName": "string",
               "wisdomTemplateArn": "string"
            },
            "outboundMode": { ... }
         },
         "sms": { 
            "capacity": number,
            "defaultOutboundConfig": { 
               "connectSourcePhoneNumberArn": "string",
               "wisdomTemplateArn": "string"
            },
            "outboundMode": { ... }
         },
         "telephony": { 
            "capacity": number,
            "connectQueueId": "string",
            "defaultOutboundConfig": { 
               "answerMachineDetectionConfig": { 
                  "awaitAnswerMachinePrompt": boolean,
                  "enableAnswerMachineDetection": boolean
               },
               "connectContactFlowId": "string",
               "connectSourcePhoneNumber": "string",
               "ringTimeout": number
            },
            "outboundMode": { ... }
         },
         "whatsApp": { 
            "capacity": number,
            "defaultOutboundConfig": { 
               "connectSourcePhoneNumberArn": "string",
               "wisdomTemplateArn": "string"
            },
            "outboundMode": { ... }
         }
      },
      "communicationLimitsOverride": { 
         "allChannelSubtypes": { ... },
         "instanceLimitsHandling": "string"
      },
      "communicationTimeConfig": { 
         "email": { 
            "openHours": { ... },
            "restrictedPeriods": { ... }
         },
         "localTimeZoneConfig": { 
            "defaultTimeZone": "string",
            "localTimeZoneDetection": [ "string" ]
         },
         "sms": { 
            "openHours": { ... },
            "restrictedPeriods": { ... }
         },
         "telephony": { 
            "openHours": { ... },
            "restrictedPeriods": { ... }
         },
         "whatsApp": { 
            "openHours": { ... },
            "restrictedPeriods": { ... }
         }
      },
      "connectCampaignFlowArn": "string",
      "connectInstanceId": "string",
      "id": "string",
      "name": "string",
      "schedule": { 
         "endTime": "string",
         "refreshFrequency": "string",
         "startTime": "string"
      },
      "source": { ... },
      "tags": { 
         "string" : "string" 
      },
      "type": "string"
   }
}
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_DescribeCampaign_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [campaign](#API_connect-outbound-campaigns-v2_DescribeCampaign_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns-v2_DescribeCampaign-response-campaign"></a>
The configuration for an outbound campaign.  
Type: [Campaign](API_connect-outbound-campaigns-v2_Campaign.md) object

## Errors
<a name="API_connect-outbound-campaigns-v2_DescribeCampaign_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_DescribeCampaign_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/DescribeCampaign) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/DescribeCampaign) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/DescribeCampaign) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/DescribeCampaign) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/DescribeCampaign) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/DescribeCampaign) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/DescribeCampaign) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/DescribeCampaign) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/DescribeCampaign) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/DescribeCampaign) 

# GetCampaignState
<a name="API_connect-outbound-campaigns-v2_GetCampaignState"></a>

Returns the state of an outbound campaign.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_GetCampaignState_RequestSyntax"></a>

```
GET /v2/campaigns/id/state HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_GetCampaignState_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns-v2_GetCampaignState_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_GetCampaignState-request-uri-id"></a>
The identifier of the Amazon Connect instance. You can find the `instanceId` in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_GetCampaignState_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_GetCampaignState_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "state": "string"
}
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_GetCampaignState_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [state](#API_connect-outbound-campaigns-v2_GetCampaignState_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns-v2_GetCampaignState-response-state"></a>
The state of a campaign. For detailed descriptions of each state, see Campaign status in the Amazon Connect Administrator Guide.  
Type: String  
Valid Values: `Initialized | Running | Paused | Stopped | Failed | Completed` 

## Errors
<a name="API_connect-outbound-campaigns-v2_GetCampaignState_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_GetCampaignState_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/GetCampaignState) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/GetCampaignState) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/GetCampaignState) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/GetCampaignState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/GetCampaignState) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/GetCampaignState) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/GetCampaignState) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/GetCampaignState) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/GetCampaignState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/GetCampaignState) 

# GetCampaignStateBatch
<a name="API_connect-outbound-campaigns-v2_GetCampaignStateBatch"></a>

Returns the state of listed of outbound campaigns.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_GetCampaignStateBatch_RequestSyntax"></a>

```
POST /v2/campaigns-state HTTP/1.1
Content-type: application/json

{
   "campaignIds": [ "string" ]
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_GetCampaignStateBatch_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_connect-outbound-campaigns-v2_GetCampaignStateBatch_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [campaignIds](#API_connect-outbound-campaigns-v2_GetCampaignStateBatch_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_GetCampaignStateBatch-request-campaignIds"></a>
The identifiers of the campaigns.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 25 items.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_GetCampaignStateBatch_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "failedRequests": [ 
      { 
         "campaignId": "string",
         "failureCode": "string"
      }
   ],
   "successfulRequests": [ 
      { 
         "campaignId": "string",
         "state": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_GetCampaignStateBatch_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [failedRequests](#API_connect-outbound-campaigns-v2_GetCampaignStateBatch_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns-v2_GetCampaignStateBatch-response-failedRequests"></a>
Failed requests.  
Type: Array of [FailedCampaignStateResponse](API_connect-outbound-campaigns-v2_FailedCampaignStateResponse.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.

 ** [successfulRequests](#API_connect-outbound-campaigns-v2_GetCampaignStateBatch_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns-v2_GetCampaignStateBatch-response-successfulRequests"></a>
Successful requests.  
Type: Array of [SuccessfulCampaignStateResponse](API_connect-outbound-campaigns-v2_SuccessfulCampaignStateResponse.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.

## Errors
<a name="API_connect-outbound-campaigns-v2_GetCampaignStateBatch_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_GetCampaignStateBatch_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/GetCampaignStateBatch) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/GetCampaignStateBatch) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/GetCampaignStateBatch) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/GetCampaignStateBatch) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/GetCampaignStateBatch) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/GetCampaignStateBatch) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/GetCampaignStateBatch) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/GetCampaignStateBatch) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/GetCampaignStateBatch) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/GetCampaignStateBatch) 

# GetConnectInstanceConfig
<a name="API_connect-outbound-campaigns-v2_GetConnectInstanceConfig"></a>

Get configuration information about an Amazon Connect instance.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_GetConnectInstanceConfig_RequestSyntax"></a>

```
GET /v2/connect-instance/connectInstanceId/config HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_GetConnectInstanceConfig_RequestParameters"></a>

The request uses the following URI parameters.

 ** [connectInstanceId](#API_connect-outbound-campaigns-v2_GetConnectInstanceConfig_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_GetConnectInstanceConfig-request-uri-connectInstanceId"></a>
The identifier of the Amazon Connect instance. You can find the `instanceId` in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-_.a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_GetConnectInstanceConfig_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_GetConnectInstanceConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "connectInstanceConfig": { 
      "connectInstanceId": "string",
      "encryptionConfig": { 
         "enabled": boolean,
         "encryptionType": "string",
         "keyArn": "string"
      },
      "serviceLinkedRoleArn": "string"
   }
}
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_GetConnectInstanceConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [connectInstanceConfig](#API_connect-outbound-campaigns-v2_GetConnectInstanceConfig_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns-v2_GetConnectInstanceConfig-response-connectInstanceConfig"></a>
Configuration information about the Amazon Connect instance.  
Type: [InstanceConfig](API_connect-outbound-campaigns-v2_InstanceConfig.md) object

## Errors
<a name="API_connect-outbound-campaigns-v2_GetConnectInstanceConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_GetConnectInstanceConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/GetConnectInstanceConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/GetConnectInstanceConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/GetConnectInstanceConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/GetConnectInstanceConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/GetConnectInstanceConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/GetConnectInstanceConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/GetConnectInstanceConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/GetConnectInstanceConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/GetConnectInstanceConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/GetConnectInstanceConfig) 

# GetInstanceOnboardingJobStatus
<a name="API_connect-outbound-campaigns-v2_GetInstanceOnboardingJobStatus"></a>

Gets the status of the workflow to onboard to outbound campaigns.

**Note**  
The `GetInstanceOnboardingJobStatus` API may return a 404 response in the following cases:  
The requested resource does not exist.
If the instance was onboarded more than 14 days ago, this API will return a 404 response as expected. In such cases, you should call the [GetConnectInstanceConfig](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-outbound-campaigns-v2_GetConnectInstanceConfig.html) API to retrieve the instance details.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_GetInstanceOnboardingJobStatus_RequestSyntax"></a>

```
GET /v2/connect-instance/connectInstanceId/onboarding HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_GetInstanceOnboardingJobStatus_RequestParameters"></a>

The request uses the following URI parameters.

 ** [connectInstanceId](#API_connect-outbound-campaigns-v2_GetInstanceOnboardingJobStatus_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_GetInstanceOnboardingJobStatus-request-uri-connectInstanceId"></a>
The identifier of the Amazon Connect instance. You can find the `instanceId` in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-_.a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_GetInstanceOnboardingJobStatus_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_GetInstanceOnboardingJobStatus_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "connectInstanceOnboardingJobStatus": { 
      "connectInstanceId": "string",
      "failureCode": "string",
      "status": "string"
   }
}
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_GetInstanceOnboardingJobStatus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [connectInstanceOnboardingJobStatus](#API_connect-outbound-campaigns-v2_GetInstanceOnboardingJobStatus_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns-v2_GetInstanceOnboardingJobStatus-response-connectInstanceOnboardingJobStatus"></a>
The status of the onboarding workflow.  
Type: [InstanceOnboardingJobStatus](API_connect-outbound-campaigns-v2_InstanceOnboardingJobStatus.md) object

## Errors
<a name="API_connect-outbound-campaigns-v2_GetInstanceOnboardingJobStatus_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_GetInstanceOnboardingJobStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/GetInstanceOnboardingJobStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/GetInstanceOnboardingJobStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/GetInstanceOnboardingJobStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/GetInstanceOnboardingJobStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/GetInstanceOnboardingJobStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/GetInstanceOnboardingJobStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/GetInstanceOnboardingJobStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/GetInstanceOnboardingJobStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/GetInstanceOnboardingJobStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/GetInstanceOnboardingJobStatus) 

# ListCampaigns
<a name="API_connect-outbound-campaigns-v2_ListCampaigns"></a>

Lists outbound campaigns.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_ListCampaigns_RequestSyntax"></a>

```
POST /v2/campaigns-summary HTTP/1.1
Content-type: application/json

{
   "filters": { 
      "instanceIdFilter": { 
         "operator": "string",
         "value": "string"
      }
   },
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_ListCampaigns_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_connect-outbound-campaigns-v2_ListCampaigns_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filters](#API_connect-outbound-campaigns-v2_ListCampaigns_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_ListCampaigns-request-filters"></a>
Filters the list of campaigns.  
Type: [CampaignFilters](API_connect-outbound-campaigns-v2_CampaignFilters.md) object  
Required: No

 ** [maxResults](#API_connect-outbound-campaigns-v2_ListCampaigns_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_ListCampaigns-request-maxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 50.  
Required: No

 ** [nextToken](#API_connect-outbound-campaigns-v2_ListCampaigns_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_ListCampaigns-request-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Required: No

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_ListCampaigns_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "campaignSummaryList": [ 
      { 
         "arn": "string",
         "channelSubtypes": [ "string" ],
         "connectCampaignFlowArn": "string",
         "connectInstanceId": "string",
         "id": "string",
         "name": "string",
         "schedule": { 
            "endTime": "string",
            "refreshFrequency": "string",
            "startTime": "string"
         },
         "type": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_ListCampaigns_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [campaignSummaryList](#API_connect-outbound-campaigns-v2_ListCampaigns_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns-v2_ListCampaigns-response-campaignSummaryList"></a>
Summary information about the outbound campaigns.  
Type: Array of [CampaignSummary](API_connect-outbound-campaigns-v2_CampaignSummary.md) objects

 ** [nextToken](#API_connect-outbound-campaigns-v2_ListCampaigns_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns-v2_ListCampaigns-response-nextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.

## Errors
<a name="API_connect-outbound-campaigns-v2_ListCampaigns_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_ListCampaigns_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/ListCampaigns) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/ListCampaigns) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/ListCampaigns) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/ListCampaigns) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/ListCampaigns) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/ListCampaigns) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/ListCampaigns) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/ListCampaigns) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/ListCampaigns) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/ListCampaigns) 

# ListConnectInstanceIntegrations
<a name="API_connect-outbound-campaigns-v2_ListConnectInstanceIntegrations"></a>

Lists integrations with the Amazon Connect instance.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_ListConnectInstanceIntegrations_RequestSyntax"></a>

```
GET /v2/connect-instance/connectInstanceId/integrations?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_ListConnectInstanceIntegrations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [connectInstanceId](#API_connect-outbound-campaigns-v2_ListConnectInstanceIntegrations_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_ListConnectInstanceIntegrations-request-uri-connectInstanceId"></a>
The identifier of the Amazon Connect instance. You can find the `instanceId` in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-_.a-zA-Z0-9]+`   
Required: Yes

 ** [maxResults](#API_connect-outbound-campaigns-v2_ListConnectInstanceIntegrations_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_ListConnectInstanceIntegrations-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 50.

 ** [nextToken](#API_connect-outbound-campaigns-v2_ListConnectInstanceIntegrations_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_ListConnectInstanceIntegrations-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 0. Maximum length of 1000.

## Request Body
<a name="API_connect-outbound-campaigns-v2_ListConnectInstanceIntegrations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_ListConnectInstanceIntegrations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "integrationSummaryList": [ 
      { ... }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_ListConnectInstanceIntegrations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [integrationSummaryList](#API_connect-outbound-campaigns-v2_ListConnectInstanceIntegrations_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns-v2_ListConnectInstanceIntegrations-response-integrationSummaryList"></a>
Summary information about the integrations.  
Type: Array of [IntegrationSummary](API_connect-outbound-campaigns-v2_IntegrationSummary.md) objects

 ** [nextToken](#API_connect-outbound-campaigns-v2_ListConnectInstanceIntegrations_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns-v2_ListConnectInstanceIntegrations-response-nextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.

## Errors
<a name="API_connect-outbound-campaigns-v2_ListConnectInstanceIntegrations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_ListConnectInstanceIntegrations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/ListConnectInstanceIntegrations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/ListConnectInstanceIntegrations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/ListConnectInstanceIntegrations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/ListConnectInstanceIntegrations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/ListConnectInstanceIntegrations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/ListConnectInstanceIntegrations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/ListConnectInstanceIntegrations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/ListConnectInstanceIntegrations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/ListConnectInstanceIntegrations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/ListConnectInstanceIntegrations) 

# ListTagsForResource
<a name="API_connect-outbound-campaigns-v2_ListTagsForResource"></a>

Lists tags for a resource.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_ListTagsForResource_RequestSyntax"></a>

```
GET /v2/tags/arn HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [arn](#API_connect-outbound-campaigns-v2_ListTagsForResource_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_ListTagsForResource-request-uri-arn"></a>
The Amazon Resource Name (ARN).  
Length Constraints: Minimum length of 20. Maximum length of 500.  
Pattern: `arn:[a-zA-Z0-9-]+:[a-zA-Z0-9-]+:[a-z]{2}-[a-z]+-\d{1,2}:[a-zA-Z0-9-]+:[^:]+(?:/[^:]+)*(?:/[^:]+)?(?:\:[^:]+)?`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tags](#API_connect-outbound-campaigns-v2_ListTagsForResource_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns-v2_ListTagsForResource-response-tags"></a>
The tags used to organize, track, or control access for this resource. For example, `{ "tags": {"key1":"value1", "key2":"value2"} }`.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.

## Errors
<a name="API_connect-outbound-campaigns-v2_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/ListTagsForResource) 

# PauseCampaign
<a name="API_connect-outbound-campaigns-v2_PauseCampaign"></a>

Pauses an outbound campaign. A paused outbound campaign can be resumed.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_PauseCampaign_RequestSyntax"></a>

```
POST /v2/campaigns/id/pause HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_PauseCampaign_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns-v2_PauseCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_PauseCampaign-request-uri-id"></a>
The identifier of the campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_PauseCampaign_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_PauseCampaign_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_PauseCampaign_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns-v2_PauseCampaign_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of a conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** InvalidCampaignStateException **   
An attempt was made to modify a campaign that is in a state that is not valid. Check your campaign to ensure that it is in a valid state before retrying the operation.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_PauseCampaign_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/PauseCampaign) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/PauseCampaign) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/PauseCampaign) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/PauseCampaign) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/PauseCampaign) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/PauseCampaign) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/PauseCampaign) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/PauseCampaign) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/PauseCampaign) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/PauseCampaign) 

# PutConnectInstanceIntegration
<a name="API_connect-outbound-campaigns-v2_PutConnectInstanceIntegration"></a>

Puts an integration for the Amazon Connect instance.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_PutConnectInstanceIntegration_RequestSyntax"></a>

```
PUT /v2/connect-instance/connectInstanceId/integrations HTTP/1.1
Content-type: application/json

{
   "integrationConfig": { ... }
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_PutConnectInstanceIntegration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [connectInstanceId](#API_connect-outbound-campaigns-v2_PutConnectInstanceIntegration_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_PutConnectInstanceIntegration-request-uri-connectInstanceId"></a>
The identifier of the Amazon Connect instance. You can find the `instanceId` in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-_.a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_PutConnectInstanceIntegration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [integrationConfig](#API_connect-outbound-campaigns-v2_PutConnectInstanceIntegration_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_PutConnectInstanceIntegration-request-integrationConfig"></a>
The integration configuration for the Amazon Connect instance  
Type: [IntegrationConfig](API_connect-outbound-campaigns-v2_IntegrationConfig.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_PutConnectInstanceIntegration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_PutConnectInstanceIntegration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns-v2_PutConnectInstanceIntegration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of a conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_PutConnectInstanceIntegration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/PutConnectInstanceIntegration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/PutConnectInstanceIntegration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/PutConnectInstanceIntegration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/PutConnectInstanceIntegration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/PutConnectInstanceIntegration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/PutConnectInstanceIntegration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/PutConnectInstanceIntegration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/PutConnectInstanceIntegration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/PutConnectInstanceIntegration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/PutConnectInstanceIntegration) 

# PutOutboundRequestBatch
<a name="API_connect-outbound-campaigns-v2_PutOutboundRequestBatch"></a>

Takes in a list of outbound requests to be placed as part of an outbound campaign.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_PutOutboundRequestBatch_RequestSyntax"></a>

```
PUT /v2/campaigns/id/outbound-requests HTTP/1.1
Content-type: application/json

{
   "outboundRequests": [ 
      { 
         "channelSubtypeParameters": { ... },
         "clientToken": "string",
         "expirationTime": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_PutOutboundRequestBatch_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns-v2_PutOutboundRequestBatch_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_PutOutboundRequestBatch-request-uri-id"></a>
The identifier of the outbound campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_PutOutboundRequestBatch_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [outboundRequests](#API_connect-outbound-campaigns-v2_PutOutboundRequestBatch_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_PutOutboundRequestBatch-request-outboundRequests"></a>
Outbound requests for outreaching.  
Type: Array of [OutboundRequest](API_connect-outbound-campaigns-v2_OutboundRequest.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 25 items.  
Required: Yes

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_PutOutboundRequestBatch_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "failedRequests": [ 
      { 
         "clientToken": "string",
         "failureCode": "string",
         "id": "string"
      }
   ],
   "successfulRequests": [ 
      { 
         "clientToken": "string",
         "id": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_PutOutboundRequestBatch_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [failedRequests](#API_connect-outbound-campaigns-v2_PutOutboundRequestBatch_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns-v2_PutOutboundRequestBatch-response-failedRequests"></a>
Failed outbound requests.  
Type: Array of [FailedRequest](API_connect-outbound-campaigns-v2_FailedRequest.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.

 ** [successfulRequests](#API_connect-outbound-campaigns-v2_PutOutboundRequestBatch_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns-v2_PutOutboundRequestBatch-response-successfulRequests"></a>
Successful outbound requests.  
Type: Array of [SuccessfulRequest](API_connect-outbound-campaigns-v2_SuccessfulRequest.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.

## Errors
<a name="API_connect-outbound-campaigns-v2_PutOutboundRequestBatch_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of a conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** InvalidCampaignStateException **   
An attempt was made to modify a campaign that is in a state that is not valid. Check your campaign to ensure that it is in a valid state before retrying the operation.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_PutOutboundRequestBatch_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/PutOutboundRequestBatch) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/PutOutboundRequestBatch) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/PutOutboundRequestBatch) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/PutOutboundRequestBatch) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/PutOutboundRequestBatch) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/PutOutboundRequestBatch) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/PutOutboundRequestBatch) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/PutOutboundRequestBatch) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/PutOutboundRequestBatch) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/PutOutboundRequestBatch) 

# PutProfileOutboundRequestBatch
<a name="API_connect-outbound-campaigns-v2_PutProfileOutboundRequestBatch"></a>

Takes in a list of profile outbound requests to be placed as part of an outbound campaign. For more information on profiles, see [What is a customer profile in Amazon Connect?](https://docs.aws.amazon.com/connect/latest/adminguide/customer-profiles-what-data.html).

**Important**  
Only Customer Profiles event triggers are permitted to invoke this API.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_PutProfileOutboundRequestBatch_RequestSyntax"></a>

```
PUT /v2/campaigns/id/profile-outbound-requests HTTP/1.1
Content-type: application/json

{
   "profileOutboundRequests": [ 
      { 
         "clientToken": "string",
         "expirationTime": "string",
         "profileId": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_PutProfileOutboundRequestBatch_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns-v2_PutProfileOutboundRequestBatch_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_PutProfileOutboundRequestBatch-request-uri-id"></a>
The identifier of the outbound campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_PutProfileOutboundRequestBatch_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [profileOutboundRequests](#API_connect-outbound-campaigns-v2_PutProfileOutboundRequestBatch_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_PutProfileOutboundRequestBatch-request-profileOutboundRequests"></a>
Profile outbound requests for outreaching.  
Type: Array of [ProfileOutboundRequest](API_connect-outbound-campaigns-v2_ProfileOutboundRequest.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Required: Yes

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_PutProfileOutboundRequestBatch_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "failedRequests": [ 
      { 
         "clientToken": "string",
         "failureCode": "string",
         "id": "string"
      }
   ],
   "successfulRequests": [ 
      { 
         "clientToken": "string",
         "id": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_PutProfileOutboundRequestBatch_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [failedRequests](#API_connect-outbound-campaigns-v2_PutProfileOutboundRequestBatch_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns-v2_PutProfileOutboundRequestBatch-response-failedRequests"></a>
Failed profile outbound requests.  
Type: Array of [FailedProfileOutboundRequest](API_connect-outbound-campaigns-v2_FailedProfileOutboundRequest.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.

 ** [successfulRequests](#API_connect-outbound-campaigns-v2_PutProfileOutboundRequestBatch_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns-v2_PutProfileOutboundRequestBatch-response-successfulRequests"></a>
Successful profile outbound requests.  
Type: Array of [SuccessfulProfileOutboundRequest](API_connect-outbound-campaigns-v2_SuccessfulProfileOutboundRequest.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 20 items.

## Errors
<a name="API_connect-outbound-campaigns-v2_PutProfileOutboundRequestBatch_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of a conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** InvalidCampaignStateException **   
An attempt was made to modify a campaign that is in a state that is not valid. Check your campaign to ensure that it is in a valid state before retrying the operation.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_PutProfileOutboundRequestBatch_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/PutProfileOutboundRequestBatch) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/PutProfileOutboundRequestBatch) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/PutProfileOutboundRequestBatch) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/PutProfileOutboundRequestBatch) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/PutProfileOutboundRequestBatch) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/PutProfileOutboundRequestBatch) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/PutProfileOutboundRequestBatch) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/PutProfileOutboundRequestBatch) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/PutProfileOutboundRequestBatch) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/PutProfileOutboundRequestBatch) 

# ResumeCampaign
<a name="API_connect-outbound-campaigns-v2_ResumeCampaign"></a>

Resumes an outbound campaign.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_ResumeCampaign_RequestSyntax"></a>

```
POST /v2/campaigns/id/resume HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_ResumeCampaign_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns-v2_ResumeCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_ResumeCampaign-request-uri-id"></a>
The identifier of the outbound campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_ResumeCampaign_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_ResumeCampaign_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_ResumeCampaign_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns-v2_ResumeCampaign_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of a conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** InvalidCampaignStateException **   
An attempt was made to modify a campaign that is in a state that is not valid. Check your campaign to ensure that it is in a valid state before retrying the operation.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_ResumeCampaign_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/ResumeCampaign) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/ResumeCampaign) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/ResumeCampaign) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/ResumeCampaign) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/ResumeCampaign) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/ResumeCampaign) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/ResumeCampaign) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/ResumeCampaign) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/ResumeCampaign) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/ResumeCampaign) 

# StartCampaign
<a name="API_connect-outbound-campaigns-v2_StartCampaign"></a>

Starts an outbound campaign.

**Note**  
After a campaign is started, `schedule`, `source`, `associatedCampaignFlowArn`, `communicationTimeConfig`, and `communicationLimitsOverride` cannot be modified.
After a campaign is started, the queue of the telephony `channelSubtypeConfig` cannot be modified.
After a campaign is started, you can't change the outbound mode of the telephony `channelSubtypeConfig` from agentless to progressive/predictive, or the other way around.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_StartCampaign_RequestSyntax"></a>

```
POST /v2/campaigns/id/start HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_StartCampaign_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns-v2_StartCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_StartCampaign-request-uri-id"></a>
The identifier of the outbound campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_StartCampaign_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_StartCampaign_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_StartCampaign_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns-v2_StartCampaign_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of a conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** InvalidCampaignStateException **   
An attempt was made to modify a campaign that is in a state that is not valid. Check your campaign to ensure that it is in a valid state before retrying the operation.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_StartCampaign_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/StartCampaign) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/StartCampaign) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/StartCampaign) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/StartCampaign) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/StartCampaign) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/StartCampaign) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/StartCampaign) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/StartCampaign) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/StartCampaign) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/StartCampaign) 

# StartInstanceOnboardingJob
<a name="API_connect-outbound-campaigns-v2_StartInstanceOnboardingJob"></a>

Starts the workflow to onboard an Amazon Connect instance to Outbound Campaigns.

**Note**  
If the current [InstanceOnboardingJobStatus](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-outbound-campaigns-v2_InstanceOnboardingJobStatus.html) is **FAILED**, the `StartInstanceOnboardingJob` API will continue to return the existing status for 14 days from the initial attempt. To reattempt onboarding, first call the [DeleteInstanceOnboardingJob](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-outbound-campaigns-v2_DeleteInstanceOnboardingJob.html) API, then invoke the `StartInstanceOnboardingJob` API again.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_StartInstanceOnboardingJob_RequestSyntax"></a>

```
PUT /v2/connect-instance/connectInstanceId/onboarding HTTP/1.1
Content-type: application/json

{
   "encryptionConfig": { 
      "enabled": boolean,
      "encryptionType": "string",
      "keyArn": "string"
   }
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_StartInstanceOnboardingJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [connectInstanceId](#API_connect-outbound-campaigns-v2_StartInstanceOnboardingJob_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_StartInstanceOnboardingJob-request-uri-connectInstanceId"></a>
The identifier of the Amazon Connect instance. You can find the `instanceId` in the ARN of the instance.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-_.a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_StartInstanceOnboardingJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [encryptionConfig](#API_connect-outbound-campaigns-v2_StartInstanceOnboardingJob_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_StartInstanceOnboardingJob-request-encryptionConfig"></a>
Encryption configuration for an Amazon Connect instance.  
Type: [EncryptionConfig](API_connect-outbound-campaigns-v2_EncryptionConfig.md) object  
Required: Yes

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_StartInstanceOnboardingJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "connectInstanceOnboardingJobStatus": { 
      "connectInstanceId": "string",
      "failureCode": "string",
      "status": "string"
   }
}
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_StartInstanceOnboardingJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [connectInstanceOnboardingJobStatus](#API_connect-outbound-campaigns-v2_StartInstanceOnboardingJob_ResponseSyntax) **   <a name="connect-connect-outbound-campaigns-v2_StartInstanceOnboardingJob-response-connectInstanceOnboardingJobStatus"></a>
The status of the onboarding workflow.  
Type: [InstanceOnboardingJobStatus](API_connect-outbound-campaigns-v2_InstanceOnboardingJobStatus.md) object

## Errors
<a name="API_connect-outbound-campaigns-v2_StartInstanceOnboardingJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of a conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_StartInstanceOnboardingJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/StartInstanceOnboardingJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/StartInstanceOnboardingJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/StartInstanceOnboardingJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/StartInstanceOnboardingJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/StartInstanceOnboardingJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/StartInstanceOnboardingJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/StartInstanceOnboardingJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/StartInstanceOnboardingJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/StartInstanceOnboardingJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/StartInstanceOnboardingJob) 

# StopCampaign
<a name="API_connect-outbound-campaigns-v2_StopCampaign"></a>

Stops an Amazon Connect campaign. When this API is called, no more outbound requests are started for the campaign. Inflight requests aren't impacted.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_StopCampaign_RequestSyntax"></a>

```
POST /v2/campaigns/id/stop HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_StopCampaign_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns-v2_StopCampaign_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_StopCampaign-request-uri-id"></a>
The identifier of the outbound campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_StopCampaign_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_StopCampaign_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_StopCampaign_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns-v2_StopCampaign_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of a conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** InvalidCampaignStateException **   
An attempt was made to modify a campaign that is in a state that is not valid. Check your campaign to ensure that it is in a valid state before retrying the operation.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_StopCampaign_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/StopCampaign) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/StopCampaign) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/StopCampaign) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/StopCampaign) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/StopCampaign) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/StopCampaign) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/StopCampaign) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/StopCampaign) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/StopCampaign) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/StopCampaign) 

# TagResource
<a name="API_connect-outbound-campaigns-v2_TagResource"></a>

Adds the specified tags to a resource.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_TagResource_RequestSyntax"></a>

```
POST /v2/tags/arn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [arn](#API_connect-outbound-campaigns-v2_TagResource_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_TagResource-request-uri-arn"></a>
The Amazon Resource Name (ARN).  
Length Constraints: Minimum length of 20. Maximum length of 500.  
Pattern: `arn:[a-zA-Z0-9-]+:[a-zA-Z0-9-]+:[a-z]{2}-[a-z]+-\d{1,2}:[a-zA-Z0-9-]+:[^:]+(?:/[^:]+)*(?:/[^:]+)?(?:\:[^:]+)?`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [tags](#API_connect-outbound-campaigns-v2_TagResource_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_TagResource-request-tags"></a>
The tags used to organize, track, or control access for this resource. For example, `{ "tags": {"key1":"value1", "key2":"value2"} }`.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Required: Yes

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns-v2_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/TagResource) 

# UntagResource
<a name="API_connect-outbound-campaigns-v2_UntagResource"></a>

Removes the specified tags from the specified resource.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_UntagResource_RequestSyntax"></a>

```
DELETE /v2/tags/arn?tagKeys=tagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [arn](#API_connect-outbound-campaigns-v2_UntagResource_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_UntagResource-request-uri-arn"></a>
The Amazon Resource Name (ARN).  
Length Constraints: Minimum length of 20. Maximum length of 500.  
Pattern: `arn:[a-zA-Z0-9-]+:[a-zA-Z0-9-]+:[a-z]{2}-[a-z]+-\d{1,2}:[a-zA-Z0-9-]+:[^:]+(?:/[^:]+)*(?:/[^:]+)?(?:\:[^:]+)?`   
Required: Yes

 ** [tagKeys](#API_connect-outbound-campaigns-v2_UntagResource_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_UntagResource-request-uri-tagKeys"></a>
The tag keys.  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns-v2_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/UntagResource) 

# UpdateCampaignChannelSubtypeConfig
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignChannelSubtypeConfig"></a>

Updates `ChannelSubtypeConfig` for an outbound campaign.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignChannelSubtypeConfig_RequestSyntax"></a>

```
POST /v2/campaigns/id/channel-subtype-config HTTP/1.1
Content-type: application/json

{
   "channelSubtypeConfig": { 
      "email": { 
         "capacity": number,
         "defaultOutboundConfig": { 
            "connectSourceEmailAddress": "string",
            "sourceEmailAddressDisplayName": "string",
            "wisdomTemplateArn": "string"
         },
         "outboundMode": { ... }
      },
      "sms": { 
         "capacity": number,
         "defaultOutboundConfig": { 
            "connectSourcePhoneNumberArn": "string",
            "wisdomTemplateArn": "string"
         },
         "outboundMode": { ... }
      },
      "telephony": { 
         "capacity": number,
         "connectQueueId": "string",
         "defaultOutboundConfig": { 
            "answerMachineDetectionConfig": { 
               "awaitAnswerMachinePrompt": boolean,
               "enableAnswerMachineDetection": boolean
            },
            "connectContactFlowId": "string",
            "connectSourcePhoneNumber": "string",
            "ringTimeout": number
         },
         "outboundMode": { ... }
      },
      "whatsApp": { 
         "capacity": number,
         "defaultOutboundConfig": { 
            "connectSourcePhoneNumberArn": "string",
            "wisdomTemplateArn": "string"
         },
         "outboundMode": { ... }
      }
   }
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignChannelSubtypeConfig_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns-v2_UpdateCampaignChannelSubtypeConfig_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_UpdateCampaignChannelSubtypeConfig-request-uri-id"></a>
The identifier of the outbound campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignChannelSubtypeConfig_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [channelSubtypeConfig](#API_connect-outbound-campaigns-v2_UpdateCampaignChannelSubtypeConfig_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_UpdateCampaignChannelSubtypeConfig-request-channelSubtypeConfig"></a>
Channel subtype configuration for an outbound campaign.  
Type: [ChannelSubtypeConfig](API_connect-outbound-campaigns-v2_ChannelSubtypeConfig.md) object  
Required: Yes

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignChannelSubtypeConfig_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignChannelSubtypeConfig_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignChannelSubtypeConfig_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of a conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignChannelSubtypeConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/UpdateCampaignChannelSubtypeConfig) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/UpdateCampaignChannelSubtypeConfig) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/UpdateCampaignChannelSubtypeConfig) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/UpdateCampaignChannelSubtypeConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/UpdateCampaignChannelSubtypeConfig) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/UpdateCampaignChannelSubtypeConfig) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/UpdateCampaignChannelSubtypeConfig) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/UpdateCampaignChannelSubtypeConfig) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/UpdateCampaignChannelSubtypeConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/UpdateCampaignChannelSubtypeConfig) 

# UpdateCampaignCommunicationLimits
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationLimits"></a>

Updates `CommunicationLimitsOverride` for an outbound campaign. Only campaigns in the `Initialized` state are valid for this operation.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationLimits_RequestSyntax"></a>

```
POST /v2/campaigns/id/communication-limits HTTP/1.1
Content-type: application/json

{
   "communicationLimitsOverride": { 
      "allChannelSubtypes": { ... },
      "instanceLimitsHandling": "string"
   }
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationLimits_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationLimits_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_UpdateCampaignCommunicationLimits-request-uri-id"></a>
The identifier of the outbound campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationLimits_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [communicationLimitsOverride](#API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationLimits_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_UpdateCampaignCommunicationLimits-request-communicationLimitsOverride"></a>
Communication limits configuration for an outbound campaign.  
Type: [CommunicationLimitsConfig](API_connect-outbound-campaigns-v2_CommunicationLimitsConfig.md) object  
Required: Yes

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationLimits_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationLimits_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationLimits_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of a conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** InvalidCampaignStateException **   
An attempt was made to modify a campaign that is in a state that is not valid. Check your campaign to ensure that it is in a valid state before retrying the operation.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationLimits_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationLimits) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationLimits) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationLimits) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationLimits) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationLimits) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationLimits) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationLimits) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationLimits) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationLimits) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationLimits) 

# UpdateCampaignCommunicationTime
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationTime"></a>

Updates `CommunicationTimeConfig` for an outbound campaign. Only campaigns in the `Initialized` state are valid for this operation.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationTime_RequestSyntax"></a>

```
POST /v2/campaigns/id/communication-time HTTP/1.1
Content-type: application/json

{
   "communicationTimeConfig": { 
      "email": { 
         "openHours": { ... },
         "restrictedPeriods": { ... }
      },
      "localTimeZoneConfig": { 
         "defaultTimeZone": "string",
         "localTimeZoneDetection": [ "string" ]
      },
      "sms": { 
         "openHours": { ... },
         "restrictedPeriods": { ... }
      },
      "telephony": { 
         "openHours": { ... },
         "restrictedPeriods": { ... }
      },
      "whatsApp": { 
         "openHours": { ... },
         "restrictedPeriods": { ... }
      }
   }
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationTime_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationTime_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_UpdateCampaignCommunicationTime-request-uri-id"></a>
The identifier of the outbound campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationTime_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [communicationTimeConfig](#API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationTime_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_UpdateCampaignCommunicationTime-request-communicationTimeConfig"></a>
Communication time configuration for an outbound campaign. Only campaigns in the `Initialized` state are valid for this operation.  
Type: [CommunicationTimeConfig](API_connect-outbound-campaigns-v2_CommunicationTimeConfig.md) object  
Required: Yes

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationTime_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationTime_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationTime_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of a conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** InvalidCampaignStateException **   
An attempt was made to modify a campaign that is in a state that is not valid. Check your campaign to ensure that it is in a valid state before retrying the operation.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignCommunicationTime_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationTime) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationTime) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationTime) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationTime) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationTime) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationTime) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationTime) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationTime) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationTime) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/UpdateCampaignCommunicationTime) 

# UpdateCampaignFlowAssociation
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignFlowAssociation"></a>

Updates associated Amazon Connect campaign flow for an outbound campaign.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignFlowAssociation_RequestSyntax"></a>

```
POST /v2/campaigns/id/flow HTTP/1.1
Content-type: application/json

{
   "connectCampaignFlowArn": "string"
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignFlowAssociation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns-v2_UpdateCampaignFlowAssociation_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_UpdateCampaignFlowAssociation-request-uri-id"></a>
The identifier of the outbound campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignFlowAssociation_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [connectCampaignFlowArn](#API_connect-outbound-campaigns-v2_UpdateCampaignFlowAssociation_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_UpdateCampaignFlowAssociation-request-connectCampaignFlowArn"></a>
The Amazon Resource Name (ARN) of the Amazon Connect campaign flow.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 500.  
Pattern: `arn:[a-zA-Z0-9-]+:[a-zA-Z0-9-]+:[a-z]{2}-[a-z]+-\d{1,2}:[a-zA-Z0-9-]+:[^:]+(?:/[^:]+)*(?:/[^:]+)?(?:\:[^:]+)?`   
Required: Yes

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignFlowAssociation_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignFlowAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignFlowAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of a conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** InvalidCampaignStateException **   
An attempt was made to modify a campaign that is in a state that is not valid. Check your campaign to ensure that it is in a valid state before retrying the operation.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignFlowAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/UpdateCampaignFlowAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/UpdateCampaignFlowAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/UpdateCampaignFlowAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/UpdateCampaignFlowAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/UpdateCampaignFlowAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/UpdateCampaignFlowAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/UpdateCampaignFlowAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/UpdateCampaignFlowAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/UpdateCampaignFlowAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/UpdateCampaignFlowAssociation) 

# UpdateCampaignName
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignName"></a>

Updates the name of an outbound campaign.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignName_RequestSyntax"></a>

```
POST /v2/campaigns/id/name HTTP/1.1
Content-type: application/json

{
   "name": "string"
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignName_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns-v2_UpdateCampaignName_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_UpdateCampaignName-request-uri-id"></a>
The identifier of the outbound campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignName_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [name](#API_connect-outbound-campaigns-v2_UpdateCampaignName_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_UpdateCampaignName-request-name"></a>
The name of the outbound campaign.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 127.  
Required: Yes

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignName_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignName_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignName_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of a conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignName_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/UpdateCampaignName) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/UpdateCampaignName) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/UpdateCampaignName) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/UpdateCampaignName) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/UpdateCampaignName) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/UpdateCampaignName) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/UpdateCampaignName) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/UpdateCampaignName) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/UpdateCampaignName) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/UpdateCampaignName) 

# UpdateCampaignSchedule
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignSchedule"></a>

Updates schedule of an outbound campaign. Only campaigns in the `Initialized` state are valid for this operation.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignSchedule_RequestSyntax"></a>

```
POST /v2/campaigns/id/schedule HTTP/1.1
Content-type: application/json

{
   "schedule": { 
      "endTime": "string",
      "refreshFrequency": "string",
      "startTime": "string"
   }
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignSchedule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns-v2_UpdateCampaignSchedule_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_UpdateCampaignSchedule-request-uri-id"></a>
The identifier of the outbound campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignSchedule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [schedule](#API_connect-outbound-campaigns-v2_UpdateCampaignSchedule_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_UpdateCampaignSchedule-request-schedule"></a>
The schedule configuration of the outbound campaign.  
Type: [Schedule](API_connect-outbound-campaigns-v2_Schedule.md) object  
Required: Yes

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignSchedule_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignSchedule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignSchedule_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of a conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** InvalidCampaignStateException **   
An attempt was made to modify a campaign that is in a state that is not valid. Check your campaign to ensure that it is in a valid state before retrying the operation.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignSchedule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/UpdateCampaignSchedule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/UpdateCampaignSchedule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/UpdateCampaignSchedule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/UpdateCampaignSchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/UpdateCampaignSchedule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/UpdateCampaignSchedule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/UpdateCampaignSchedule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/UpdateCampaignSchedule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/UpdateCampaignSchedule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/UpdateCampaignSchedule) 

# UpdateCampaignSource
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignSource"></a>

Updates source of an outbound campaign. Only campaigns in the `Initialized` state are valid for this operation.

## Request Syntax
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignSource_RequestSyntax"></a>

```
POST /v2/campaigns/id/source HTTP/1.1
Content-type: application/json

{
   "source": { ... }
}
```

## URI Request Parameters
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignSource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [id](#API_connect-outbound-campaigns-v2_UpdateCampaignSource_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_UpdateCampaignSource-request-uri-id"></a>
The identifier of the outbound campaign.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[-:/a-zA-Z0-9]+`   
Required: Yes

## Request Body
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignSource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [source](#API_connect-outbound-campaigns-v2_UpdateCampaignSource_RequestSyntax) **   <a name="connect-connect-outbound-campaigns-v2_UpdateCampaignSource-request-source"></a>
The source configuration of the outbound campaign.  
Type: [Source](API_connect-outbound-campaigns-v2_Source.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## Response Syntax
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignSource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignSource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of a conflict in the current state of the resource.  
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the outbound campaigns.  
HTTP Status Code: 500

 ** InvalidCampaignStateException **   
An attempt was made to modify a campaign that is in a state that is not valid. Check your campaign to ensure that it is in a valid state before retrying the operation.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.  
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## See Also
<a name="API_connect-outbound-campaigns-v2_UpdateCampaignSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcampaignsv2-2024-04-23/UpdateCampaignSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcampaignsv2-2024-04-23/UpdateCampaignSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcampaignsv2-2024-04-23/UpdateCampaignSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcampaignsv2-2024-04-23/UpdateCampaignSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcampaignsv2-2024-04-23/UpdateCampaignSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcampaignsv2-2024-04-23/UpdateCampaignSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcampaignsv2-2024-04-23/UpdateCampaignSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcampaignsv2-2024-04-23/UpdateCampaignSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcampaignsv2-2024-04-23/UpdateCampaignSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcampaignsv2-2024-04-23/UpdateCampaignSource) 

# Amazon Connect Cases
<a name="API_Operations_Amazon_Connect_Cases"></a>

The following actions are supported by Amazon Connect Cases:
+  [BatchGetCaseRule](API_connect-cases_BatchGetCaseRule.md) 
+  [BatchGetField](API_connect-cases_BatchGetField.md) 
+  [BatchPutFieldOptions](API_connect-cases_BatchPutFieldOptions.md) 
+  [CreateCase](API_connect-cases_CreateCase.md) 
+  [CreateCaseRule](API_connect-cases_CreateCaseRule.md) 
+  [CreateDomain](API_connect-cases_CreateDomain.md) 
+  [CreateField](API_connect-cases_CreateField.md) 
+  [CreateLayout](API_connect-cases_CreateLayout.md) 
+  [CreateRelatedItem](API_connect-cases_CreateRelatedItem.md) 
+  [CreateTemplate](API_connect-cases_CreateTemplate.md) 
+  [DeleteCase](API_connect-cases_DeleteCase.md) 
+  [DeleteCaseRule](API_connect-cases_DeleteCaseRule.md) 
+  [DeleteDomain](API_connect-cases_DeleteDomain.md) 
+  [DeleteField](API_connect-cases_DeleteField.md) 
+  [DeleteLayout](API_connect-cases_DeleteLayout.md) 
+  [DeleteRelatedItem](API_connect-cases_DeleteRelatedItem.md) 
+  [DeleteTemplate](API_connect-cases_DeleteTemplate.md) 
+  [GetCase](API_connect-cases_GetCase.md) 
+  [GetCaseAuditEvents](API_connect-cases_GetCaseAuditEvents.md) 
+  [GetCaseEventConfiguration](API_connect-cases_GetCaseEventConfiguration.md) 
+  [GetDomain](API_connect-cases_GetDomain.md) 
+  [GetLayout](API_connect-cases_GetLayout.md) 
+  [GetTemplate](API_connect-cases_GetTemplate.md) 
+  [ListCaseRules](API_connect-cases_ListCaseRules.md) 
+  [ListCasesForContact](API_connect-cases_ListCasesForContact.md) 
+  [ListDomains](API_connect-cases_ListDomains.md) 
+  [ListFieldOptions](API_connect-cases_ListFieldOptions.md) 
+  [ListFields](API_connect-cases_ListFields.md) 
+  [ListLayouts](API_connect-cases_ListLayouts.md) 
+  [ListTagsForResource](API_connect-cases_ListTagsForResource.md) 
+  [ListTemplates](API_connect-cases_ListTemplates.md) 
+  [PutCaseEventConfiguration](API_connect-cases_PutCaseEventConfiguration.md) 
+  [SearchAllRelatedItems](API_connect-cases_SearchAllRelatedItems.md) 
+  [SearchCases](API_connect-cases_SearchCases.md) 
+  [SearchRelatedItems](API_connect-cases_SearchRelatedItems.md) 
+  [TagResource](API_connect-cases_TagResource.md) 
+  [UntagResource](API_connect-cases_UntagResource.md) 
+  [UpdateCase](API_connect-cases_UpdateCase.md) 
+  [UpdateCaseRule](API_connect-cases_UpdateCaseRule.md) 
+  [UpdateField](API_connect-cases_UpdateField.md) 
+  [UpdateLayout](API_connect-cases_UpdateLayout.md) 
+  [UpdateRelatedItem](API_connect-cases_UpdateRelatedItem.md) 
+  [UpdateTemplate](API_connect-cases_UpdateTemplate.md) 

# BatchGetCaseRule
<a name="API_connect-cases_BatchGetCaseRule"></a>

Gets a batch of case rules. In the Amazon Connect admin website, case rules are known as *case field conditions*. For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html).

## Request Syntax
<a name="API_connect-cases_BatchGetCaseRule_RequestSyntax"></a>

```
POST /domains/domainId/rules-batch HTTP/1.1
Content-type: application/json

{
   "caseRules": [ 
      { 
         "id": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_connect-cases_BatchGetCaseRule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_BatchGetCaseRule_RequestSyntax) **   <a name="connect-connect-cases_BatchGetCaseRule-request-uri-domainId"></a>
Unique identifier of a Cases domain.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_BatchGetCaseRule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [caseRules](#API_connect-cases_BatchGetCaseRule_RequestSyntax) **   <a name="connect-connect-cases_BatchGetCaseRule-request-caseRules"></a>
A list of case rule identifiers.  
Type: Array of [CaseRuleIdentifier](API_connect-cases_CaseRuleIdentifier.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: Yes

## Response Syntax
<a name="API_connect-cases_BatchGetCaseRule_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "caseRules": [ 
      { 
         "caseRuleArn": "string",
         "caseRuleId": "string",
         "createdTime": "string",
         "deleted": boolean,
         "description": "string",
         "lastModifiedTime": "string",
         "name": "string",
         "rule": { ... },
         "tags": { 
            "string" : "string" 
         }
      }
   ],
   "errors": [ 
      { 
         "errorCode": "string",
         "id": "string",
         "message": "string"
      }
   ],
   "unprocessedCaseRules": [ "string" ]
}
```

## Response Elements
<a name="API_connect-cases_BatchGetCaseRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [caseRules](#API_connect-cases_BatchGetCaseRule_ResponseSyntax) **   <a name="connect-connect-cases_BatchGetCaseRule-response-caseRules"></a>
A list of detailed case rule information.  
Type: Array of [GetCaseRuleResponse](API_connect-cases_GetCaseRuleResponse.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.

 ** [errors](#API_connect-cases_BatchGetCaseRule_ResponseSyntax) **   <a name="connect-connect-cases_BatchGetCaseRule-response-errors"></a>
A list of case rule errors.  
Type: Array of [CaseRuleError](API_connect-cases_CaseRuleError.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.

 ** [unprocessedCaseRules](#API_connect-cases_BatchGetCaseRule_ResponseSyntax) **   <a name="connect-connect-cases_BatchGetCaseRule-response-unprocessedCaseRules"></a>
A list of unprocessed case rule identifiers.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_connect-cases_BatchGetCaseRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## See Also
<a name="API_connect-cases_BatchGetCaseRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/BatchGetCaseRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/BatchGetCaseRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/BatchGetCaseRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/BatchGetCaseRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/BatchGetCaseRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/BatchGetCaseRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/BatchGetCaseRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/BatchGetCaseRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/BatchGetCaseRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/BatchGetCaseRule) 

# BatchGetField
<a name="API_connect-cases_BatchGetField"></a>

Returns the description for the list of fields in the request parameters. 

## Request Syntax
<a name="API_connect-cases_BatchGetField_RequestSyntax"></a>

```
POST /domains/domainId/fields-batch HTTP/1.1
Content-type: application/json

{
   "fields": [ 
      { 
         "id": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_connect-cases_BatchGetField_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_BatchGetField_RequestSyntax) **   <a name="connect-connect-cases_BatchGetField-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_BatchGetField_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [fields](#API_connect-cases_BatchGetField_RequestSyntax) **   <a name="connect-connect-cases_BatchGetField-request-fields"></a>
A list of unique field identifiers.   
Type: Array of [FieldIdentifier](API_connect-cases_FieldIdentifier.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Required: Yes

## Response Syntax
<a name="API_connect-cases_BatchGetField_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "errors": [ 
      { 
         "errorCode": "string",
         "id": "string",
         "message": "string"
      }
   ],
   "fields": [ 
      { 
         "attributes": { ... },
         "createdTime": "string",
         "deleted": boolean,
         "description": "string",
         "fieldArn": "string",
         "fieldId": "string",
         "lastModifiedTime": "string",
         "name": "string",
         "namespace": "string",
         "tags": { 
            "string" : "string" 
         },
         "type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-cases_BatchGetField_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [errors](#API_connect-cases_BatchGetField_ResponseSyntax) **   <a name="connect-connect-cases_BatchGetField-response-errors"></a>
A list of field errors.   
Type: Array of [FieldError](API_connect-cases_FieldError.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.

 ** [fields](#API_connect-cases_BatchGetField_ResponseSyntax) **   <a name="connect-connect-cases_BatchGetField-response-fields"></a>
A list of detailed field information.   
Type: Array of [GetFieldResponse](API_connect-cases_GetFieldResponse.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.

## Errors
<a name="API_connect-cases_BatchGetField_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_BatchGetField_Examples"></a>

### Request and Response example
<a name="API_connect-cases_BatchGetField_Example_1"></a>

This example illustrates one usage of BatchGetField.

```
{
   "fields":[   
   {
      "id":"[field_id_1]"
   },
   {
      "id":"[field_id_2]"
   },
   {
      "id":"case_id"
   }
   ]
}
```

```
{
   "errors":[
     ],
     "fields":[
      {
      "description":"Test with description",
      "fieldArn":"arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/field/[field_id_1]",
      "fieldId":"[field_id_1]",
      "name":"field1",
      "namespace":"Custom",
      "tags":{
         "resourceArn":"arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/field/5a17045a-9150-48f9-8cd5-8a5946585b73"
         },
      "type":"SingleSelect"
      },
      {
      "description":"Unique Identifier of the case",
      "fieldArn":"arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/field/case_id",
      "fieldId":"case_id",
      "name":"Case Id",
      "namespace":"System",
      "tags":{
         "resourceArn":"arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/field/case_id"
         },
      "type":"Text"
      },
      {
         "description":"test",
         "fieldArn":"arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/field/[field_id_2]",
         "fieldId":"[field_id_2]",
         "name":"field2",
         "namespace":"Custom",
         "tags":{
            "resourceArn":"arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/field/[field_id_2]"
            },
      "type":"SingleSelect"
      }
   ]
}
```

## See Also
<a name="API_connect-cases_BatchGetField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/BatchGetField) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/BatchGetField) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/BatchGetField) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/BatchGetField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/BatchGetField) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/BatchGetField) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/BatchGetField) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/BatchGetField) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/BatchGetField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/BatchGetField) 

# BatchPutFieldOptions
<a name="API_connect-cases_BatchPutFieldOptions"></a>

Creates and updates a set of field options for a single select field in a Cases domain.

## Request Syntax
<a name="API_connect-cases_BatchPutFieldOptions_RequestSyntax"></a>

```
PUT /domains/domainId/fields/fieldId/options HTTP/1.1
Content-type: application/json

{
   "options": [ 
      { 
         "active": boolean,
         "name": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_connect-cases_BatchPutFieldOptions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_BatchPutFieldOptions_RequestSyntax) **   <a name="connect-connect-cases_BatchPutFieldOptions-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [fieldId](#API_connect-cases_BatchPutFieldOptions_RequestSyntax) **   <a name="connect-connect-cases_BatchPutFieldOptions-request-uri-fieldId"></a>
The unique identifier of a field.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_BatchPutFieldOptions_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [options](#API_connect-cases_BatchPutFieldOptions_RequestSyntax) **   <a name="connect-connect-cases_BatchPutFieldOptions-request-options"></a>
A list of `FieldOption` objects.  
Type: Array of [FieldOption](API_connect-cases_FieldOption.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: Yes

## Response Syntax
<a name="API_connect-cases_BatchPutFieldOptions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "errors": [ 
      { 
         "errorCode": "string",
         "message": "string",
         "value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-cases_BatchPutFieldOptions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [errors](#API_connect-cases_BatchPutFieldOptions_ResponseSyntax) **   <a name="connect-connect-cases_BatchPutFieldOptions-response-errors"></a>
A list of field errors.   
Type: Array of [FieldOptionError](API_connect-cases_FieldOptionError.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.

## Errors
<a name="API_connect-cases_BatchPutFieldOptions_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*.  
HTTP Status Code: 402

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_BatchPutFieldOptions_Examples"></a>

### Example
<a name="API_connect-cases_BatchPutFieldOptions_Example_1"></a>

Request and Response Example:

```
{
  "options": [
    {
    "active": true,
    "name": "California",
    "value": "CA"
    },
    {
    "active": true,
    "name": "Washington",
    "value": "WA"
    },
    {
    "active": false,
    "name": "New York",
    "value": "NY"
    },
    {
    "active": false,
    "name": "Massachusetts",
    "value": "MA"
    }
  ]
}
```

```
{
"errors": []
}
```

## See Also
<a name="API_connect-cases_BatchPutFieldOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/BatchPutFieldOptions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/BatchPutFieldOptions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/BatchPutFieldOptions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/BatchPutFieldOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/BatchPutFieldOptions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/BatchPutFieldOptions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/BatchPutFieldOptions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/BatchPutFieldOptions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/BatchPutFieldOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/BatchPutFieldOptions) 

# CreateCase
<a name="API_connect-cases_CreateCase"></a>

**Note**  
If you provide a value for `PerformedBy.UserArn` you must also have [connect:DescribeUser](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html) permission on the User ARN resource that you provide

Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.

When creating a case from a template that has tag propagation configurations, the specified tags are automatically applied to the case.

The following fields are required when creating a case:
+  `customer_id` - You must provide the full customer profile ARN in this format: `arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID` 
+  `title` 

## Request Syntax
<a name="API_connect-cases_CreateCase_RequestSyntax"></a>

```
POST /domains/domainId/cases HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "fields": [ 
      { 
         "id": "string",
         "value": { ... }
      }
   ],
   "performedBy": { ... },
   "tags": { 
      "string" : "string" 
   },
   "templateId": "string"
}
```

## URI Request Parameters
<a name="API_connect-cases_CreateCase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_CreateCase_RequestSyntax) **   <a name="connect-connect-cases_CreateCase-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_CreateCase_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_connect-cases_CreateCase_RequestSyntax) **   <a name="connect-connect-cases_CreateCase-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 64.  
Required: No

 ** [fields](#API_connect-cases_CreateCase_RequestSyntax) **   <a name="connect-connect-cases_CreateCase-request-fields"></a>
An array of objects with field ID (matching ListFields/DescribeField) and value union data.  
Type: Array of [FieldValue](API_connect-cases_FieldValue.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 220 items.  
Required: Yes

 ** [performedBy](#API_connect-cases_CreateCase_RequestSyntax) **   <a name="connect-connect-cases_CreateCase-request-performedBy"></a>
Represents the entity that performed the action.  
Type: [UserUnion](API_connect-cases_UserUnion.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [tags](#API_connect-cases_CreateCase_RequestSyntax) **   <a name="connect-connect-cases_CreateCase-request-tags"></a>
A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?![aA][wW][sS]:)[a-zA-Z0-9 _.:/=+\-@]+`   
Value Length Constraints: Minimum length of 0. Maximum length of 256.  
Value Pattern: `([a-zA-Z0-9 _.:/=+\-@]*)`   
Required: No

 ** [templateId](#API_connect-cases_CreateCase_RequestSyntax) **   <a name="connect-connect-cases_CreateCase-request-templateId"></a>
A unique identifier of a template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_connect-cases_CreateCase_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "caseArn": "string",
   "caseId": "string"
}
```

## Response Elements
<a name="API_connect-cases_CreateCase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [caseArn](#API_connect-cases_CreateCase_ResponseSyntax) **   <a name="connect-connect-cases_CreateCase-response-caseArn"></a>
The Amazon Resource Name (ARN) of the case.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [caseId](#API_connect-cases_CreateCase_ResponseSyntax) **   <a name="connect-connect-cases_CreateCase-response-caseId"></a>
A unique identifier of the case.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_connect-cases_CreateCase_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_CreateCase_Examples"></a>

### Request and Response example
<a name="API_connect-cases_CreateCase_Example_1"></a>

This example illustrates one usage of CreateCase.

```
{
  "templateId": "[template_id]",
  "fields": [
  {
    "id": "customer_id",
    "value": {
      "stringValue": "[customer_id]"
     },
    {
    "id": "title",
    "value": {
      "stringValue": "Incorrect Shipping Address"
      }
    }
  ],
  "clientToken": "[clientToken]",
  "tags": {
    "Department": "Shipping",
    "Priority": "High"
  }
}
```

```
{
  "caseArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/case/[case_id]",
  "caseId": "[case_id]"
}
```

## See Also
<a name="API_connect-cases_CreateCase_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/CreateCase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/CreateCase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/CreateCase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/CreateCase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/CreateCase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/CreateCase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/CreateCase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/CreateCase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/CreateCase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/CreateCase) 

# CreateCaseRule
<a name="API_connect-cases_CreateCaseRule"></a>

Creates a new case rule. In the Amazon Connect admin website, case rules are known as *case field conditions*. For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html).

## Request Syntax
<a name="API_connect-cases_CreateCaseRule_RequestSyntax"></a>

```
POST /domains/domainId/case-rules HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "name": "string",
   "rule": { ... }
}
```

## URI Request Parameters
<a name="API_connect-cases_CreateCaseRule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_CreateCaseRule_RequestSyntax) **   <a name="connect-connect-cases_CreateCaseRule-request-uri-domainId"></a>
Unique identifier of a Cases domain.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_CreateCaseRule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_connect-cases_CreateCaseRule_RequestSyntax) **   <a name="connect-connect-cases_CreateCaseRule-request-description"></a>
The description of a case rule.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [name](#API_connect-cases_CreateCaseRule_RequestSyntax) **   <a name="connect-connect-cases_CreateCaseRule-request-name"></a>
Name of the case rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]`   
Required: Yes

 ** [rule](#API_connect-cases_CreateCaseRule_RequestSyntax) **   <a name="connect-connect-cases_CreateCaseRule-request-rule"></a>
Represents what rule type should take place, under what conditions.  
Type: [CaseRuleDetails](API_connect-cases_CaseRuleDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

## Response Syntax
<a name="API_connect-cases_CreateCaseRule_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "caseRuleArn": "string",
   "caseRuleId": "string"
}
```

## Response Elements
<a name="API_connect-cases_CreateCaseRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [caseRuleArn](#API_connect-cases_CreateCaseRule_ResponseSyntax) **   <a name="connect-connect-cases_CreateCaseRule-response-caseRuleArn"></a>
The Amazon Resource Name (ARN) of a case rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [caseRuleId](#API_connect-cases_CreateCaseRule_ResponseSyntax) **   <a name="connect-connect-cases_CreateCaseRule-response-caseRuleId"></a>
Unique identifier of a case rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_connect-cases_CreateCaseRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*.  
HTTP Status Code: 402

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_CreateCaseRule_Examples"></a>

### Example
<a name="API_connect-cases_CreateCaseRule_Example_1"></a>

This example illustrates one usage of CreateCaseRule.

```
CreateCaseRule
POST /domains/domainId/case-rules HTTP/1.1
Content-type: application/json
{
	"name": "RequiredIfStatusOpen",
	"description": "Makes field required if status is set to Open",
	"rule": {
		"required": {
			"conditions": [
				{
					"equalTo": {
						"operandOne": {
							"fieldId": "status"
						},
						"operandTwo": {
							"doubleValue": "Open"
						},
						"result": true
					}
				}
			],
			"defaultValue": false
		}
	}
}
```

## See Also
<a name="API_connect-cases_CreateCaseRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/CreateCaseRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/CreateCaseRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/CreateCaseRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/CreateCaseRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/CreateCaseRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/CreateCaseRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/CreateCaseRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/CreateCaseRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/CreateCaseRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/CreateCaseRule) 

# CreateDomain
<a name="API_connect-cases_CreateDomain"></a>

Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain.

**Important**  
This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect [CreateIntegrationAssociation](https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateIntegrationAssociation.html) API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see [Onboard to Cases](https://docs.aws.amazon.com/connect/latest/adminguide/required-permissions-iam-cases.html#onboard-cases-iam).

## Request Syntax
<a name="API_connect-cases_CreateDomain_RequestSyntax"></a>

```
POST /domains HTTP/1.1
Content-type: application/json

{
   "name": "string"
}
```

## URI Request Parameters
<a name="API_connect-cases_CreateDomain_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_connect-cases_CreateDomain_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [name](#API_connect-cases_CreateDomain_RequestSyntax) **   <a name="connect-connect-cases_CreateDomain-request-name"></a>
The name for your Cases domain. It must be unique for your AWS account.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]`   
Required: Yes

## Response Syntax
<a name="API_connect-cases_CreateDomain_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "domainArn": "string",
   "domainId": "string",
   "domainStatus": "string"
}
```

## Response Elements
<a name="API_connect-cases_CreateDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [domainArn](#API_connect-cases_CreateDomain_ResponseSyntax) **   <a name="connect-connect-cases_CreateDomain-response-domainArn"></a>
The Amazon Resource Name (ARN) for the Cases domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [domainId](#API_connect-cases_CreateDomain_ResponseSyntax) **   <a name="connect-connect-cases_CreateDomain-response-domainId"></a>
The unique identifier of the Cases domain.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [domainStatus](#API_connect-cases_CreateDomain_ResponseSyntax) **   <a name="connect-connect-cases_CreateDomain-response-domainStatus"></a>
The status of the domain.  
Type: String  
Valid Values: `Active | CreationInProgress | CreationFailed` 

## Errors
<a name="API_connect-cases_CreateDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*.  
HTTP Status Code: 402

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_CreateDomain_Examples"></a>

### Request and Response example
<a name="API_connect-cases_CreateDomain_Example_1"></a>

This example illustrates one usage of CreateDomain.

```
{
  "name": "demo-amazon-cases-domain"
 }
```

```
{
  "domainArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]",
  "domainId": "[domain_id]",
  "domainStatus": "CreationInProgress"
}
```

## See Also
<a name="API_connect-cases_CreateDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/CreateDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/CreateDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/CreateDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/CreateDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/CreateDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/CreateDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/CreateDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/CreateDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/CreateDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/CreateDomain) 

# CreateField
<a name="API_connect-cases_CreateField"></a>

Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain. 

## Request Syntax
<a name="API_connect-cases_CreateField_RequestSyntax"></a>

```
POST /domains/domainId/fields HTTP/1.1
Content-type: application/json

{
   "attributes": { ... },
   "description": "string",
   "name": "string",
   "type": "string"
}
```

## URI Request Parameters
<a name="API_connect-cases_CreateField_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_CreateField_RequestSyntax) **   <a name="connect-connect-cases_CreateField-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_CreateField_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [attributes](#API_connect-cases_CreateField_RequestSyntax) **   <a name="connect-connect-cases_CreateField-request-attributes"></a>
Union of field attributes.  
Type: [FieldAttributes](API_connect-cases_FieldAttributes.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [description](#API_connect-cases_CreateField_RequestSyntax) **   <a name="connect-connect-cases_CreateField-request-description"></a>
The description of the field.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [name](#API_connect-cases_CreateField_RequestSyntax) **   <a name="connect-connect-cases_CreateField-request-name"></a>
The name of the field.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]`   
Required: Yes

 ** [type](#API_connect-cases_CreateField_RequestSyntax) **   <a name="connect-connect-cases_CreateField-request-type"></a>
Defines the data type, some system constraints, and default display of the field.  
Type: String  
Valid Values: `Text | Number | Boolean | DateTime | SingleSelect | Url | User`   
Required: Yes

## Response Syntax
<a name="API_connect-cases_CreateField_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "fieldArn": "string",
   "fieldId": "string"
}
```

## Response Elements
<a name="API_connect-cases_CreateField_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [fieldArn](#API_connect-cases_CreateField_ResponseSyntax) **   <a name="connect-connect-cases_CreateField-response-fieldArn"></a>
The Amazon Resource Name (ARN) of the field.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [fieldId](#API_connect-cases_CreateField_ResponseSyntax) **   <a name="connect-connect-cases_CreateField-response-fieldId"></a>
The unique identifier of a field.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_connect-cases_CreateField_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*.  
HTTP Status Code: 402

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_CreateField_Examples"></a>

### Request and Response example
<a name="API_connect-cases_CreateField_Example_1"></a>

This example illustrates one usage of CreateField.

```
{
  "name": "Color",
  "type": "Text",
  "description": "The color of the item"
}
```

```
{
  "fieldArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/field/[field_id]",
  "fieldId": "[field_id]"
}
```

## See Also
<a name="API_connect-cases_CreateField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/CreateField) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/CreateField) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/CreateField) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/CreateField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/CreateField) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/CreateField) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/CreateField) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/CreateField) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/CreateField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/CreateField) 

# CreateLayout
<a name="API_connect-cases_CreateLayout"></a>

Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface:
+ Fields to display to the users
+ Field ordering

**Note**  
Title and Status fields cannot be part of layouts since they are not configurable.

## Request Syntax
<a name="API_connect-cases_CreateLayout_RequestSyntax"></a>

```
POST /domains/domainId/layouts HTTP/1.1
Content-type: application/json

{
   "content": { ... },
   "name": "string"
}
```

## URI Request Parameters
<a name="API_connect-cases_CreateLayout_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_CreateLayout_RequestSyntax) **   <a name="connect-connect-cases_CreateLayout-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_CreateLayout_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [content](#API_connect-cases_CreateLayout_RequestSyntax) **   <a name="connect-connect-cases_CreateLayout-request-content"></a>
Information about which fields will be present in the layout, and information about the order of the fields.  
Type: [LayoutContent](API_connect-cases_LayoutContent.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [name](#API_connect-cases_CreateLayout_RequestSyntax) **   <a name="connect-connect-cases_CreateLayout-request-name"></a>
The name of the layout. It must be unique for the Cases domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]`   
Required: Yes

## Response Syntax
<a name="API_connect-cases_CreateLayout_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "layoutArn": "string",
   "layoutId": "string"
}
```

## Response Elements
<a name="API_connect-cases_CreateLayout_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [layoutArn](#API_connect-cases_CreateLayout_ResponseSyntax) **   <a name="connect-connect-cases_CreateLayout-response-layoutArn"></a>
The Amazon Resource Name (ARN) of the newly created layout.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [layoutId](#API_connect-cases_CreateLayout_ResponseSyntax) **   <a name="connect-connect-cases_CreateLayout-response-layoutId"></a>
The unique identifier of the layout.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_connect-cases_CreateLayout_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*.  
HTTP Status Code: 402

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_CreateLayout_Examples"></a>

### Request and Response example
<a name="API_connect-cases_CreateLayout_Example_1"></a>

This example illustrates one usage of CreateLayout.

```
{
  "content": {
    "basic": {
      "moreInfo": {
        "sections": [
          {
            "fieldGroup": {
              "fields": [
                {
                "id": "created_datetime"
                },
                {
                "id": "case_id"
                }
            ]
          }
        }
      ]
    },
  "topPanel": {
        "sections": [
          {
          "fieldGroup": {
          "fields": [
           {
           "id": "status"
           },
          {
          "id": "case_id"
          }
         ]
        }
       }
      ]
     }
    }
   },
  "name": "testLayout"
}
```

```
{
  "layoutArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/layout/[layout_id]",
  "layoutId": "[layout_id]"
}
```

## See Also
<a name="API_connect-cases_CreateLayout_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/CreateLayout) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/CreateLayout) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/CreateLayout) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/CreateLayout) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/CreateLayout) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/CreateLayout) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/CreateLayout) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/CreateLayout) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/CreateLayout) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/CreateLayout) 

# CreateRelatedItem
<a name="API_connect-cases_CreateRelatedItem"></a>

Creates a related item (comments, tasks, and contacts) and associates it with a case.

There's a quota for the number of fields allowed in a Custom type related item. See [Amazon Connect Cases quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#cases-quotas).

 **Use cases** 

Following are examples of related items that you may want to associate with a case:
+ Related contacts, such as calls, chats, emails tasks
+ Comments, for agent notes
+ SLAs, to capture target resolution goals
+ Cases, to capture related Amazon Connect Cases
+ Files, such as policy documentation or customer-provided attachments
+ Custom related items, which provide flexibility for you to define related items that such as bookings, orders, products, notices, and more

 **Important things to know** 
+ If you are associating a contact to a case by passing in `Contact` for a `type`, you must have [DescribeContact](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeContact.html) permission on the ARN of the contact that you provide in `content.contact.contactArn`.
+ A Related Item is a resource that is associated with a case. It may or may not have an external identifier linking it to an external resource (for example, a `contactArn`). All Related Items have their own internal identifier, the `relatedItemArn`. Examples of related items include `comments` and `contacts`.
+ If you provide a value for `performedBy.userArn` you must also have [DescribeUser](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html) permission on the ARN of the user that you provide.
+ The `type` field is reserved for internal use only.

 **Endpoints**: See [Amazon Connect endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/connect_region.html).

## Request Syntax
<a name="API_connect-cases_CreateRelatedItem_RequestSyntax"></a>

```
POST /domains/domainId/cases/caseId/related-items/ HTTP/1.1
Content-type: application/json

{
   "content": { ... },
   "performedBy": { ... },
   "type": "string"
}
```

## URI Request Parameters
<a name="API_connect-cases_CreateRelatedItem_RequestParameters"></a>

The request uses the following URI parameters.

 ** [caseId](#API_connect-cases_CreateRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_CreateRelatedItem-request-uri-caseId"></a>
A unique identifier of the case.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [domainId](#API_connect-cases_CreateRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_CreateRelatedItem-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_CreateRelatedItem_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [content](#API_connect-cases_CreateRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_CreateRelatedItem-request-content"></a>
The content of a related item to be created.  
Type: [RelatedItemInputContent](API_connect-cases_RelatedItemInputContent.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [performedBy](#API_connect-cases_CreateRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_CreateRelatedItem-request-performedBy"></a>
Represents the creator of the related item.  
Type: [UserUnion](API_connect-cases_UserUnion.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [type](#API_connect-cases_CreateRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_CreateRelatedItem-request-type"></a>
The type of a related item.  
Type: String  
Valid Values: `Contact | Comment | File | Sla | ConnectCase | Custom`   
Required: Yes

## Response Syntax
<a name="API_connect-cases_CreateRelatedItem_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "relatedItemArn": "string",
   "relatedItemId": "string"
}
```

## Response Elements
<a name="API_connect-cases_CreateRelatedItem_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [relatedItemArn](#API_connect-cases_CreateRelatedItem_ResponseSyntax) **   <a name="connect-connect-cases_CreateRelatedItem-response-relatedItemArn"></a>
The Amazon Resource Name (ARN) of the related item.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [relatedItemId](#API_connect-cases_CreateRelatedItem_ResponseSyntax) **   <a name="connect-connect-cases_CreateRelatedItem-response-relatedItemId"></a>
The unique identifier of the related item.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_connect-cases_CreateRelatedItem_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*.  
HTTP Status Code: 402

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_CreateRelatedItem_Examples"></a>

This section provides examples for supported related item types.

### Type: Comment
<a name="API_connect-cases_CreateRelatedItem_Example_1"></a>

Request:

```
{
  "content": {
    "comment": {
      "body": "Hello World!",
      "contentType": "Text/Plain"
    }
  },
  "type": "Comment"
}
```

### Type: Sla
<a name="API_connect-cases_CreateRelatedItem_Example_2"></a>

Request: 
+  `name` is the descriptive name for the SLA
+  `targetSlaMinutes` is the time in minutes within which the SLA must be met
+  `type` only supports "CaseField"
+  `fieldId` only supports "status" field
+  `targetFieldValues` is the value that the field must reach for the SLA to be met and only supports one value.

```
{
  "content": {
    "sla": {
      "slaInputConfiguration": {
        "name": "Resolution SLA",
        "targetSlaMinutes": 10,
        "type": "CaseField",
        "fieldId": "status",
        "targetFieldValues": [
          {
            "stringValue": "closed"
          }
        ]
      }
    }
  },
  "type": "Sla"
}
```

### Type: File
<a name="API_connect-cases_CreateRelatedItem_Example_3"></a>

Request:

```
{
  "content": {
    "file": {
      "fileArn": "[fileArn]"
    }
  },
  "type": "File"
}
```

### Type: Contact
<a name="API_connect-cases_CreateRelatedItem_Example_4"></a>

Request to associate a customer contact with a case:

```
{
  "content": {
    "contact": {
      "contactArn": "[contactArn]"
    }
  },
  "type": "Contact"
}
```

### Type: Custom
<a name="API_connect-cases_CreateRelatedItem_Example_5"></a>

Request to associate a custom defined related item with a case:

**Note**  
 [System case fields](https://docs.aws.amazon.com/connect/latest/adminguide/case-fields.html#system-case-fields) cannot be used in a custom related item.

```
{
  "content": {
    "custom": {
        "fields": [
            {
            "id": "[field_id_1]",
            "value": {
                "stringValue": "Billing"
                },
            {
            "id": "[field_id_2]",
            "value": {
                "stringValue": "Incorrect Shipping Address"
                }
            }
        ],
    }
  },
  "type": "Custom"
}
```

### Type: ConnectCase
<a name="API_connect-cases_CreateRelatedItem_Example_6"></a>

Request to associate another Amazon Connect case with a case:

```
{
  "content": {
    "connectCase": {
      "caseId": "[caseId]"
    }
  },
  "type": "ConnectCase"
}
```

### CreateRelatedItem Response example
<a name="API_connect-cases_CreateRelatedItem_Example_7"></a>

All successful CreateRelatedItem requests return the same response structure: 

```
{
  "relatedItemArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/case/[case_id]/related-item/[related_item_id]",
  "relatedItemId": "[related_item_id]"
}
```

## See Also
<a name="API_connect-cases_CreateRelatedItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/CreateRelatedItem) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/CreateRelatedItem) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/CreateRelatedItem) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/CreateRelatedItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/CreateRelatedItem) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/CreateRelatedItem) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/CreateRelatedItem) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/CreateRelatedItem) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/CreateRelatedItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/CreateRelatedItem) 

# CreateTemplate
<a name="API_connect-cases_CreateTemplate"></a>

Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.

 Other template APIs are: 
+  [DeleteTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html) 
+  [GetTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html) 
+  [ListTemplates](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html) 
+  [UpdateTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html) 

## Request Syntax
<a name="API_connect-cases_CreateTemplate_RequestSyntax"></a>

```
POST /domains/domainId/templates HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "layoutConfiguration": { 
      "defaultLayout": "string"
   },
   "name": "string",
   "requiredFields": [ 
      { 
         "fieldId": "string"
      }
   ],
   "rules": [ 
      { 
         "caseRuleId": "string",
         "fieldId": "string"
      }
   ],
   "status": "string",
   "tagPropagationConfigurations": [ 
      { 
         "resourceType": "string",
         "tagMap": { 
            "string" : "string" 
         }
      }
   ]
}
```

## URI Request Parameters
<a name="API_connect-cases_CreateTemplate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_CreateTemplate_RequestSyntax) **   <a name="connect-connect-cases_CreateTemplate-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_CreateTemplate_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_connect-cases_CreateTemplate_RequestSyntax) **   <a name="connect-connect-cases_CreateTemplate-request-description"></a>
A brief description of the template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [layoutConfiguration](#API_connect-cases_CreateTemplate_RequestSyntax) **   <a name="connect-connect-cases_CreateTemplate-request-layoutConfiguration"></a>
Configuration of layouts associated to the template.  
Type: [LayoutConfiguration](API_connect-cases_LayoutConfiguration.md) object  
Required: No

 ** [name](#API_connect-cases_CreateTemplate_RequestSyntax) **   <a name="connect-connect-cases_CreateTemplate-request-name"></a>
A name for the template. It must be unique per domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]`   
Required: Yes

 ** [requiredFields](#API_connect-cases_CreateTemplate_RequestSyntax) **   <a name="connect-connect-cases_CreateTemplate-request-requiredFields"></a>
A list of fields that must contain a value for a case to be successfully created with this template.  
Type: Array of [RequiredField](API_connect-cases_RequiredField.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Required: No

 ** [rules](#API_connect-cases_CreateTemplate_RequestSyntax) **   <a name="connect-connect-cases_CreateTemplate-request-rules"></a>
A list of case rules (also known as [case field conditions](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html)) on a template.   
Type: Array of [TemplateRule](API_connect-cases_TemplateRule.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** [status](#API_connect-cases_CreateTemplate_RequestSyntax) **   <a name="connect-connect-cases_CreateTemplate-request-status"></a>
The status of the template.  
Type: String  
Valid Values: `Active | Inactive`   
Required: No

 ** [tagPropagationConfigurations](#API_connect-cases_CreateTemplate_RequestSyntax) **   <a name="connect-connect-cases_CreateTemplate-request-tagPropagationConfigurations"></a>
Defines tag propagation configuration for resources created within a domain. Tags specified here will be automatically applied to resources being created for the specified resource type.  
Type: Array of [TagPropagationConfiguration](API_connect-cases_TagPropagationConfiguration.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Required: No

## Response Syntax
<a name="API_connect-cases_CreateTemplate_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "templateArn": "string",
   "templateId": "string"
}
```

## Response Elements
<a name="API_connect-cases_CreateTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [templateArn](#API_connect-cases_CreateTemplate_ResponseSyntax) **   <a name="connect-connect-cases_CreateTemplate-response-templateArn"></a>
The Amazon Resource Name (ARN) of the newly created template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [templateId](#API_connect-cases_CreateTemplate_ResponseSyntax) **   <a name="connect-connect-cases_CreateTemplate-response-templateId"></a>
A unique identifier of a template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_connect-cases_CreateTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*.  
HTTP Status Code: 402

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_CreateTemplate_Examples"></a>

### Request and Response example
<a name="API_connect-cases_CreateTemplate_Example_1"></a>

This example illustrates one usage of CreateTemplate.

```
{
  "name": "Shipping",
  "layoutConfiguration": {
    "defaultLayout": "[layout_id]"
    },
  "requiredFields": [
    {
    "fieldId": "[field_id]"
    }
  ],
  "description": "This is an example template for shipping issues",
  "status": "Inactive",
  "tagPropagationConfigurations": [
    {
      "resourceType": "Cases",
      "tagMap": {
        "Department" : "Shipping"
      }
    }
  ]
}
```

```
{
  "templateArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/template/[template_id]",
  "templateId": "[template_id]"
}
```

## See Also
<a name="API_connect-cases_CreateTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/CreateTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/CreateTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/CreateTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/CreateTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/CreateTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/CreateTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/CreateTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/CreateTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/CreateTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/CreateTemplate) 

# DeleteCase
<a name="API_connect-cases_DeleteCase"></a>

 The DeleteCase API permanently deletes a case and all its associated resources from the cases data store. After a successful deletion, you cannot:
+ Retrieve related items
+ Access audit history
+ Perform any operations that require the CaseID

**Important**  
This action is irreversible. After you delete a case, you cannot recover its data.

## Request Syntax
<a name="API_connect-cases_DeleteCase_RequestSyntax"></a>

```
DELETE /domains/domainId/cases/caseId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_DeleteCase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [caseId](#API_connect-cases_DeleteCase_RequestSyntax) **   <a name="connect-connect-cases_DeleteCase-request-uri-caseId"></a>
A unique identifier of the case.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [domainId](#API_connect-cases_DeleteCase_RequestSyntax) **   <a name="connect-connect-cases_DeleteCase-request-uri-domainId"></a>
A unique identifier of the Cases domain.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_DeleteCase_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_DeleteCase_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_DeleteCase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_DeleteCase_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## See Also
<a name="API_connect-cases_DeleteCase_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/DeleteCase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/DeleteCase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/DeleteCase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/DeleteCase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/DeleteCase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/DeleteCase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/DeleteCase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/DeleteCase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/DeleteCase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/DeleteCase) 

# DeleteCaseRule
<a name="API_connect-cases_DeleteCaseRule"></a>

Deletes a case rule. In the Amazon Connect admin website, case rules are known as *case field conditions*. For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html).

## Request Syntax
<a name="API_connect-cases_DeleteCaseRule_RequestSyntax"></a>

```
DELETE /domains/domainId/case-rules/caseRuleId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_DeleteCaseRule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [caseRuleId](#API_connect-cases_DeleteCaseRule_RequestSyntax) **   <a name="connect-connect-cases_DeleteCaseRule-request-uri-caseRuleId"></a>
Unique identifier of a case rule.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [domainId](#API_connect-cases_DeleteCaseRule_RequestSyntax) **   <a name="connect-connect-cases_DeleteCaseRule-request-uri-domainId"></a>
Unique identifier of a Cases domain.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_DeleteCaseRule_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_DeleteCaseRule_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_DeleteCaseRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_DeleteCaseRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

## See Also
<a name="API_connect-cases_DeleteCaseRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/DeleteCaseRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/DeleteCaseRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/DeleteCaseRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/DeleteCaseRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/DeleteCaseRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/DeleteCaseRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/DeleteCaseRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/DeleteCaseRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/DeleteCaseRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/DeleteCaseRule) 

# DeleteDomain
<a name="API_connect-cases_DeleteDomain"></a>

Deletes a Cases domain.

**Note**  
After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this Amazon Connect instance. See [DeleteIntegrationAssociation](https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAssociation.html).

## Request Syntax
<a name="API_connect-cases_DeleteDomain_RequestSyntax"></a>

```
DELETE /domains/domainId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_DeleteDomain_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_DeleteDomain_RequestSyntax) **   <a name="connect-connect-cases_DeleteDomain-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_DeleteDomain_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_DeleteDomain_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_DeleteDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_DeleteDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## See Also
<a name="API_connect-cases_DeleteDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/DeleteDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/DeleteDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/DeleteDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/DeleteDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/DeleteDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/DeleteDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/DeleteDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/DeleteDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/DeleteDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/DeleteDomain) 

# DeleteField
<a name="API_connect-cases_DeleteField"></a>

Deletes a field from a cases template.

After a field is deleted:
+ You can still retrieve the field by calling `BatchGetField`.
+ You cannot update a deleted field by calling `UpdateField`; it throws a `ValidationException`.
+ Deleted fields are not included in the `ListFields` response.
+ Calling `CreateCase` with a deleted field throws a `ValidationException` denoting which field identifiers in the request have been deleted.
+ Calling `GetCase` with a deleted field identifier returns the deleted field's value if one exists.
+ Calling `UpdateCase` with a deleted field ID throws a `ValidationException` if the case does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove (using `emptyValue: {}`) the field's value from the case.
+  `GetTemplate` does not return field IDs for deleted fields.
+  `GetLayout` does not return field IDs for deleted fields.
+ Calling `SearchCases` with the deleted field ID as a filter returns any cases that have a value for the deleted field that matches the filter criteria.
+ Calling `SearchCases` with a `searchTerm` value that matches a deleted field's value on a case returns the case in the response.
+ Calling `BatchPutFieldOptions` with a deleted field ID throw a `ValidationException`.
+ Calling `GetCaseEventConfiguration` does not return field IDs for deleted fields.

## Request Syntax
<a name="API_connect-cases_DeleteField_RequestSyntax"></a>

```
DELETE /domains/domainId/fields/fieldId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_DeleteField_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_DeleteField_RequestSyntax) **   <a name="connect-connect-cases_DeleteField-request-uri-domainId"></a>
The unique identifier of the Cases domain.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [fieldId](#API_connect-cases_DeleteField_RequestSyntax) **   <a name="connect-connect-cases_DeleteField-request-uri-fieldId"></a>
Unique identifier of the field.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_DeleteField_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_DeleteField_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_DeleteField_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_DeleteField_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*.  
HTTP Status Code: 402

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## See Also
<a name="API_connect-cases_DeleteField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/DeleteField) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/DeleteField) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/DeleteField) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/DeleteField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/DeleteField) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/DeleteField) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/DeleteField) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/DeleteField) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/DeleteField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/DeleteField) 

# DeleteLayout
<a name="API_connect-cases_DeleteLayout"></a>

Deletes a layout from a cases template. You can delete up to 100 layouts per domain.

After a layout is deleted:
+ You can still retrieve the layout by calling `GetLayout`.
+ You cannot update a deleted layout by calling `UpdateLayout`; it throws a `ValidationException`.
+ Deleted layouts are not included in the `ListLayouts` response.

## Request Syntax
<a name="API_connect-cases_DeleteLayout_RequestSyntax"></a>

```
DELETE /domains/domainId/layouts/layoutId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_DeleteLayout_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_DeleteLayout_RequestSyntax) **   <a name="connect-connect-cases_DeleteLayout-request-uri-domainId"></a>
The unique identifier of the Cases domain.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [layoutId](#API_connect-cases_DeleteLayout_RequestSyntax) **   <a name="connect-connect-cases_DeleteLayout-request-uri-layoutId"></a>
The unique identifier of the layout.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_DeleteLayout_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_DeleteLayout_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_DeleteLayout_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_DeleteLayout_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## See Also
<a name="API_connect-cases_DeleteLayout_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/DeleteLayout) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/DeleteLayout) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/DeleteLayout) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/DeleteLayout) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/DeleteLayout) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/DeleteLayout) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/DeleteLayout) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/DeleteLayout) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/DeleteLayout) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/DeleteLayout) 

# DeleteRelatedItem
<a name="API_connect-cases_DeleteRelatedItem"></a>

Deletes the related item resource under a case.

**Note**  
This API cannot be used on a FILE type related attachment. To delete this type of file, use the [DeleteAttachedFile](https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteAttachedFile.html) API

## Request Syntax
<a name="API_connect-cases_DeleteRelatedItem_RequestSyntax"></a>

```
DELETE /domains/domainId/cases/caseId/related-items/relatedItemId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_DeleteRelatedItem_RequestParameters"></a>

The request uses the following URI parameters.

 ** [caseId](#API_connect-cases_DeleteRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_DeleteRelatedItem-request-uri-caseId"></a>
A unique identifier of the case.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [domainId](#API_connect-cases_DeleteRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_DeleteRelatedItem-request-uri-domainId"></a>
A unique identifier of the Cases domain.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [relatedItemId](#API_connect-cases_DeleteRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_DeleteRelatedItem-request-uri-relatedItemId"></a>
A unique identifier of a related item.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_DeleteRelatedItem_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_DeleteRelatedItem_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_DeleteRelatedItem_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_DeleteRelatedItem_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## See Also
<a name="API_connect-cases_DeleteRelatedItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/DeleteRelatedItem) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/DeleteRelatedItem) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/DeleteRelatedItem) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/DeleteRelatedItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/DeleteRelatedItem) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/DeleteRelatedItem) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/DeleteRelatedItem) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/DeleteRelatedItem) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/DeleteRelatedItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/DeleteRelatedItem) 

# DeleteTemplate
<a name="API_connect-cases_DeleteTemplate"></a>

Deletes a cases template. You can delete up to 100 templates per domain.

After a cases template is deleted:
+ You can still retrieve the template by calling `GetTemplate`.
+ You cannot update the template. 
+ You cannot create a case by using the deleted template.
+ Deleted templates are not included in the `ListTemplates` response.

## Request Syntax
<a name="API_connect-cases_DeleteTemplate_RequestSyntax"></a>

```
DELETE /domains/domainId/templates/templateId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_DeleteTemplate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_DeleteTemplate_RequestSyntax) **   <a name="connect-connect-cases_DeleteTemplate-request-uri-domainId"></a>
The unique identifier of the Cases domain.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [templateId](#API_connect-cases_DeleteTemplate_RequestSyntax) **   <a name="connect-connect-cases_DeleteTemplate-request-uri-templateId"></a>
A unique identifier of a template.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_DeleteTemplate_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_DeleteTemplate_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_DeleteTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_DeleteTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## See Also
<a name="API_connect-cases_DeleteTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/DeleteTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/DeleteTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/DeleteTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/DeleteTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/DeleteTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/DeleteTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/DeleteTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/DeleteTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/DeleteTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/DeleteTemplate) 

# GetCase
<a name="API_connect-cases_GetCase"></a>

Returns information about a specific case if it exists. 

## Request Syntax
<a name="API_connect-cases_GetCase_RequestSyntax"></a>

```
POST /domains/domainId/cases/caseId HTTP/1.1
Content-type: application/json

{
   "fields": [ 
      { 
         "id": "string"
      }
   ],
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_connect-cases_GetCase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [caseId](#API_connect-cases_GetCase_RequestSyntax) **   <a name="connect-connect-cases_GetCase-request-uri-caseId"></a>
A unique identifier of the case.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [domainId](#API_connect-cases_GetCase_RequestSyntax) **   <a name="connect-connect-cases_GetCase-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_GetCase_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [fields](#API_connect-cases_GetCase_RequestSyntax) **   <a name="connect-connect-cases_GetCase-request-fields"></a>
A list of unique field identifiers.   
Type: Array of [FieldIdentifier](API_connect-cases_FieldIdentifier.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 220 items.  
Required: Yes

 ** [nextToken](#API_connect-cases_GetCase_RequestSyntax) **   <a name="connect-connect-cases_GetCase-request-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.  
Required: No

## Response Syntax
<a name="API_connect-cases_GetCase_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "fields": [ 
      { 
         "id": "string",
         "value": { ... }
      }
   ],
   "nextToken": "string",
   "tags": { 
      "string" : "string" 
   },
   "templateId": "string"
}
```

## Response Elements
<a name="API_connect-cases_GetCase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [fields](#API_connect-cases_GetCase_ResponseSyntax) **   <a name="connect-connect-cases_GetCase-response-fields"></a>
A list of detailed field information.   
Type: Array of [FieldValue](API_connect-cases_FieldValue.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 220 items.

 ** [nextToken](#API_connect-cases_GetCase_ResponseSyntax) **   <a name="connect-connect-cases_GetCase-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

 ** [tags](#API_connect-cases_GetCase_ResponseSyntax) **   <a name="connect-connect-cases_GetCase-response-tags"></a>
A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.  
Type: String to string map

 ** [templateId](#API_connect-cases_GetCase_ResponseSyntax) **   <a name="connect-connect-cases_GetCase-response-templateId"></a>
A unique identifier of a template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_connect-cases_GetCase_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_GetCase_Examples"></a>

### Request and Response example
<a name="API_connect-cases_GetCase_Example_1"></a>

This example illustrates one usage of GetCase.

```
{
  "fields": [
  {
    "id": "title"
  },
  {
  "id": "status"
  }
 ]
}
```

```
{
  "fields": [
    {
      "id": "title",
      "value": {
         "stringValue": "Incorrect Shipping Address"
          }
     },
     {
      "id": "status",
      "value": {
         "stringValue": "Open"
          }
     }
  ],
  "templateId": "[template_id]",
  "tags": {},
  "nextToken": [nextToken]
}
```

## See Also
<a name="API_connect-cases_GetCase_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/GetCase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/GetCase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/GetCase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/GetCase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/GetCase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/GetCase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/GetCase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/GetCase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/GetCase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/GetCase) 

# GetCaseAuditEvents
<a name="API_connect-cases_GetCaseAuditEvents"></a>

Returns the audit history about a specific case if it exists.

## Request Syntax
<a name="API_connect-cases_GetCaseAuditEvents_RequestSyntax"></a>

```
POST /domains/domainId/cases/caseId/audit-history HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_connect-cases_GetCaseAuditEvents_RequestParameters"></a>

The request uses the following URI parameters.

 ** [caseId](#API_connect-cases_GetCaseAuditEvents_RequestSyntax) **   <a name="connect-connect-cases_GetCaseAuditEvents-request-uri-caseId"></a>
A unique identifier of the case.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [domainId](#API_connect-cases_GetCaseAuditEvents_RequestSyntax) **   <a name="connect-connect-cases_GetCaseAuditEvents-request-uri-domainId"></a>
The unique identifier of the Cases domain.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_GetCaseAuditEvents_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [maxResults](#API_connect-cases_GetCaseAuditEvents_RequestSyntax) **   <a name="connect-connect-cases_GetCaseAuditEvents-request-maxResults"></a>
The maximum number of audit events to return. When no value is provided, 25 is the default.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 25.  
Required: No

 ** [nextToken](#API_connect-cases_GetCaseAuditEvents_RequestSyntax) **   <a name="connect-connect-cases_GetCaseAuditEvents-request-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.  
Required: No

## Response Syntax
<a name="API_connect-cases_GetCaseAuditEvents_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "auditEvents": [ 
      { 
         "eventId": "string",
         "fields": [ 
            { 
               "eventFieldId": "string",
               "newValue": { ... },
               "oldValue": { ... }
            }
         ],
         "performedBy": { 
            "iamPrincipalArn": "string",
            "user": { ... }
         },
         "performedTime": "string",
         "relatedItemType": "string",
         "type": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_connect-cases_GetCaseAuditEvents_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [auditEvents](#API_connect-cases_GetCaseAuditEvents_ResponseSyntax) **   <a name="connect-connect-cases_GetCaseAuditEvents-response-auditEvents"></a>
A list of case audits where each represents a particular edit of the case.  
Type: Array of [AuditEvent](API_connect-cases_AuditEvent.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.

 ** [nextToken](#API_connect-cases_GetCaseAuditEvents_ResponseSyntax) **   <a name="connect-connect-cases_GetCaseAuditEvents-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

## Errors
<a name="API_connect-cases_GetCaseAuditEvents_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## See Also
<a name="API_connect-cases_GetCaseAuditEvents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/GetCaseAuditEvents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/GetCaseAuditEvents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/GetCaseAuditEvents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/GetCaseAuditEvents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/GetCaseAuditEvents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/GetCaseAuditEvents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/GetCaseAuditEvents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/GetCaseAuditEvents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/GetCaseAuditEvents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/GetCaseAuditEvents) 

# GetCaseEventConfiguration
<a name="API_connect-cases_GetCaseEventConfiguration"></a>

Returns the case event publishing configuration.

## Request Syntax
<a name="API_connect-cases_GetCaseEventConfiguration_RequestSyntax"></a>

```
POST /domains/domainId/case-event-configuration HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_GetCaseEventConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_GetCaseEventConfiguration_RequestSyntax) **   <a name="connect-connect-cases_GetCaseEventConfiguration-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_GetCaseEventConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_GetCaseEventConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "eventBridge": { 
      "enabled": boolean,
      "includedData": { 
         "caseData": { 
            "fields": [ 
               { 
                  "id": "string"
               }
            ]
         },
         "relatedItemData": { 
            "includeContent": boolean
         }
      }
   }
}
```

## Response Elements
<a name="API_connect-cases_GetCaseEventConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [eventBridge](#API_connect-cases_GetCaseEventConfiguration_ResponseSyntax) **   <a name="connect-connect-cases_GetCaseEventConfiguration-response-eventBridge"></a>
Configuration to enable EventBridge case event delivery and determine what data is delivered.  
Type: [EventBridgeConfiguration](API_connect-cases_EventBridgeConfiguration.md) object

## Errors
<a name="API_connect-cases_GetCaseEventConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_GetCaseEventConfiguration_Examples"></a>

### Request and Response example
<a name="API_connect-cases_GetCaseEventConfiguration_Example_1"></a>

This example illustrates one usage of GetCaseEventConfiguration.

```
{ }
```

```
{
  "enabled":true,
  "includedData":{
   "caseData":{
   "fields":[
    {
    "id":"status"
    },
    {
    "id":"title"
    },
    {
    "id":"customer_id"
    },
    {
    "id":"case_reason"
    }
   ]
  },
  "relatedItemData":{
  "includeContent":true
  }
 }
}
```

## See Also
<a name="API_connect-cases_GetCaseEventConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/GetCaseEventConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/GetCaseEventConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/GetCaseEventConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/GetCaseEventConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/GetCaseEventConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/GetCaseEventConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/GetCaseEventConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/GetCaseEventConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/GetCaseEventConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/GetCaseEventConfiguration) 

# GetDomain
<a name="API_connect-cases_GetDomain"></a>

Returns information about a specific domain if it exists. 

## Request Syntax
<a name="API_connect-cases_GetDomain_RequestSyntax"></a>

```
POST /domains/domainId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_GetDomain_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_GetDomain_RequestSyntax) **   <a name="connect-connect-cases_GetDomain-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_GetDomain_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_GetDomain_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdTime": "string",
   "domainArn": "string",
   "domainId": "string",
   "domainStatus": "string",
   "name": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-cases_GetDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdTime](#API_connect-cases_GetDomain_ResponseSyntax) **   <a name="connect-connect-cases_GetDomain-response-createdTime"></a>
The timestamp when the Cases domain was created.  
Type: Timestamp

 ** [domainArn](#API_connect-cases_GetDomain_ResponseSyntax) **   <a name="connect-connect-cases_GetDomain-response-domainArn"></a>
The Amazon Resource Name (ARN) for the Cases domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [domainId](#API_connect-cases_GetDomain_ResponseSyntax) **   <a name="connect-connect-cases_GetDomain-response-domainId"></a>
The unique identifier of the Cases domain.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [domainStatus](#API_connect-cases_GetDomain_ResponseSyntax) **   <a name="connect-connect-cases_GetDomain-response-domainStatus"></a>
The status of the Cases domain.  
Type: String  
Valid Values: `Active | CreationInProgress | CreationFailed` 

 ** [name](#API_connect-cases_GetDomain_ResponseSyntax) **   <a name="connect-connect-cases_GetDomain-response-name"></a>
The name of the Cases domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]` 

 ** [tags](#API_connect-cases_GetDomain_ResponseSyntax) **   <a name="connect-connect-cases_GetDomain-response-tags"></a>
A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.  
Type: String to string map

## Errors
<a name="API_connect-cases_GetDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_GetDomain_Examples"></a>

### Request and Response example
<a name="API_connect-cases_GetDomain_Example_1"></a>

This example illustrates one usage of GetDomain.

```
{ }
```

```
{
  "createdAt": "2021-03-05T21:25:30.261392Z",
  "domainArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]",
  "domainId": "[domain_id]",
  "domainStatus": "Active",
  "name": "Demo Domain",
  "tags": {}
}
```

## See Also
<a name="API_connect-cases_GetDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/GetDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/GetDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/GetDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/GetDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/GetDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/GetDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/GetDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/GetDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/GetDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/GetDomain) 

# GetLayout
<a name="API_connect-cases_GetLayout"></a>

Returns the details for the requested layout.

## Request Syntax
<a name="API_connect-cases_GetLayout_RequestSyntax"></a>

```
POST /domains/domainId/layouts/layoutId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_GetLayout_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_GetLayout_RequestSyntax) **   <a name="connect-connect-cases_GetLayout-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [layoutId](#API_connect-cases_GetLayout_RequestSyntax) **   <a name="connect-connect-cases_GetLayout-request-uri-layoutId"></a>
The unique identifier of the layout.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_GetLayout_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_GetLayout_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "content": { ... },
   "createdTime": "string",
   "deleted": boolean,
   "lastModifiedTime": "string",
   "layoutArn": "string",
   "layoutId": "string",
   "name": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-cases_GetLayout_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [content](#API_connect-cases_GetLayout_ResponseSyntax) **   <a name="connect-connect-cases_GetLayout-response-content"></a>
Information about which fields will be present in the layout, the order of the fields, and read-only attribute of the field.   
Type: [LayoutContent](API_connect-cases_LayoutContent.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [createdTime](#API_connect-cases_GetLayout_ResponseSyntax) **   <a name="connect-connect-cases_GetLayout-response-createdTime"></a>
Timestamp at which the resource was created.  
Type: Timestamp

 ** [deleted](#API_connect-cases_GetLayout_ResponseSyntax) **   <a name="connect-connect-cases_GetLayout-response-deleted"></a>
Denotes whether or not the resource has been deleted.  
Type: Boolean

 ** [lastModifiedTime](#API_connect-cases_GetLayout_ResponseSyntax) **   <a name="connect-connect-cases_GetLayout-response-lastModifiedTime"></a>
Timestamp at which the resource was created or last modified.  
Type: Timestamp

 ** [layoutArn](#API_connect-cases_GetLayout_ResponseSyntax) **   <a name="connect-connect-cases_GetLayout-response-layoutArn"></a>
The Amazon Resource Name (ARN) of the newly created layout.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [layoutId](#API_connect-cases_GetLayout_ResponseSyntax) **   <a name="connect-connect-cases_GetLayout-response-layoutId"></a>
The unique identifier of the layout.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [name](#API_connect-cases_GetLayout_ResponseSyntax) **   <a name="connect-connect-cases_GetLayout-response-name"></a>
The name of the layout. It must be unique.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]` 

 ** [tags](#API_connect-cases_GetLayout_ResponseSyntax) **   <a name="connect-connect-cases_GetLayout-response-tags"></a>
A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.  
Type: String to string map

## Errors
<a name="API_connect-cases_GetLayout_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_GetLayout_Examples"></a>

### Request and Response example
<a name="API_connect-cases_GetLayout_Example_1"></a>

Following is an example of a content attribute.

```
{ }
```

```
{
  "name": "My layout",
  "content": {
  "basic": {
    "topPanel": {
      "sections": [
      {
        "fieldGroup": {
        "fields": [
          {
          "editable": false,
          "fieldId": "[field_id_1]"
          },
          {
          "editable": false,
          "fieldId": "[field_id_2]"
          }
         ]
       }
     }
    ]
  },
  "moreInfo": {
  "sections": [
      {
      "fieldGroup": {
        "name": "Address",
        "fields": [
          {
          "editable": false,
          "fieldId": "[field_id_3]"
          },
          {
          "editable": false,
          "fieldId": "[field_id_4]"
          }
         ]
        }
       }
      ]
     }
    }
  },
  "layoutArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/layout/[layout_id]",
  "layoutId": "[layout_id]",
  "tags": {}
}
```

## See Also
<a name="API_connect-cases_GetLayout_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/GetLayout) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/GetLayout) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/GetLayout) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/GetLayout) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/GetLayout) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/GetLayout) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/GetLayout) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/GetLayout) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/GetLayout) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/GetLayout) 

# GetTemplate
<a name="API_connect-cases_GetTemplate"></a>

Returns the details for the requested template. Other template APIs are: 
+  [CreateTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateTemplate.html) 
+  [DeleteTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html) 
+  [ListTemplates](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html) 
+  [UpdateTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html) 

## Request Syntax
<a name="API_connect-cases_GetTemplate_RequestSyntax"></a>

```
POST /domains/domainId/templates/templateId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_GetTemplate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_GetTemplate_RequestSyntax) **   <a name="connect-connect-cases_GetTemplate-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [templateId](#API_connect-cases_GetTemplate_RequestSyntax) **   <a name="connect-connect-cases_GetTemplate-request-uri-templateId"></a>
A unique identifier of a template.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_GetTemplate_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_GetTemplate_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdTime": "string",
   "deleted": boolean,
   "description": "string",
   "lastModifiedTime": "string",
   "layoutConfiguration": { 
      "defaultLayout": "string"
   },
   "name": "string",
   "requiredFields": [ 
      { 
         "fieldId": "string"
      }
   ],
   "rules": [ 
      { 
         "caseRuleId": "string",
         "fieldId": "string"
      }
   ],
   "status": "string",
   "tagPropagationConfigurations": [ 
      { 
         "resourceType": "string",
         "tagMap": { 
            "string" : "string" 
         }
      }
   ],
   "tags": { 
      "string" : "string" 
   },
   "templateArn": "string",
   "templateId": "string"
}
```

## Response Elements
<a name="API_connect-cases_GetTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [createdTime](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-createdTime"></a>
Timestamp at which the resource was created.  
Type: Timestamp

 ** [deleted](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-deleted"></a>
Denotes whether or not the resource has been deleted.  
Type: Boolean

 ** [description](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-description"></a>
A brief description of the template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.

 ** [lastModifiedTime](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-lastModifiedTime"></a>
Timestamp at which the resource was created or last modified.  
Type: Timestamp

 ** [layoutConfiguration](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-layoutConfiguration"></a>
Configuration of layouts associated to the template.  
Type: [LayoutConfiguration](API_connect-cases_LayoutConfiguration.md) object

 ** [name](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-name"></a>
The name of the template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]` 

 ** [requiredFields](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-requiredFields"></a>
A list of fields that must contain a value for a case to be successfully created with this template.  
Type: Array of [RequiredField](API_connect-cases_RequiredField.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

 ** [rules](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-rules"></a>
A list of case rules (also known as [case field conditions](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html)) on a template.   
Type: Array of [TemplateRule](API_connect-cases_TemplateRule.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.

 ** [status](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-status"></a>
The status of the template.  
Type: String  
Valid Values: `Active | Inactive` 

 ** [tagPropagationConfigurations](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-tagPropagationConfigurations"></a>
Defines tag propagation configuration for resources created within a domain. Tags specified here will be automatically applied to resources being created for the specified resource type.  
Type: Array of [TagPropagationConfiguration](API_connect-cases_TagPropagationConfiguration.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 1 item.

 ** [tags](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-tags"></a>
A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.  
Type: String to string map

 ** [templateArn](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-templateArn"></a>
The Amazon Resource Name (ARN) of the template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [templateId](#API_connect-cases_GetTemplate_ResponseSyntax) **   <a name="connect-connect-cases_GetTemplate-response-templateId"></a>
A unique identifier of a template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

## Errors
<a name="API_connect-cases_GetTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_GetTemplate_Examples"></a>

### Request and Response example
<a name="API_connect-cases_GetTemplate_Example_1"></a>

This example illustrates one usage of GetTemplate.

```
{ }
```

```
{
  "templateId": "[template_id]",
  "templateArn": "[template_arn]",
  "name": "Shipping",
  "layoutConfiguration": {
  "defaultLayout": "[layout_id]"
    },
  "requiredFields": [
    {
    "fieldId": "[field_id]"
    }
  ],
  "description": "This is an example template for shipping issues",
  "status": "Inactive",
  "tagPropagationConfigurations": [
    {
      "resourceType": "Cases",
      "tagMap": {
        "Department" : "Shipping"
      }
    }
  ]
}
```

## See Also
<a name="API_connect-cases_GetTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/GetTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/GetTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/GetTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/GetTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/GetTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/GetTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/GetTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/GetTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/GetTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/GetTemplate) 

# ListCaseRules
<a name="API_connect-cases_ListCaseRules"></a>

Lists all case rules in a Cases domain. In the Amazon Connect admin website, case rules are known as *case field conditions*. For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html).

## Request Syntax
<a name="API_connect-cases_ListCaseRules_RequestSyntax"></a>

```
POST /domains/domainId/rules-list/?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_ListCaseRules_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_ListCaseRules_RequestSyntax) **   <a name="connect-connect-cases_ListCaseRules-request-uri-domainId"></a>
Unique identifier of a Cases domain.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [maxResults](#API_connect-cases_ListCaseRules_RequestSyntax) **   <a name="connect-connect-cases_ListCaseRules-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_connect-cases_ListCaseRules_RequestSyntax) **   <a name="connect-connect-cases_ListCaseRules-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 0. Maximum length of 9000.

## Request Body
<a name="API_connect-cases_ListCaseRules_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_ListCaseRules_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "caseRules": [ 
      { 
         "caseRuleArn": "string",
         "caseRuleId": "string",
         "description": "string",
         "name": "string",
         "ruleType": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_connect-cases_ListCaseRules_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [caseRules](#API_connect-cases_ListCaseRules_ResponseSyntax) **   <a name="connect-connect-cases_ListCaseRules-response-caseRules"></a>
A list of field summary objects.  
Type: Array of [CaseRuleSummary](API_connect-cases_CaseRuleSummary.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

 ** [nextToken](#API_connect-cases_ListCaseRules_ResponseSyntax) **   <a name="connect-connect-cases_ListCaseRules-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

## Errors
<a name="API_connect-cases_ListCaseRules_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## See Also
<a name="API_connect-cases_ListCaseRules_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/ListCaseRules) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/ListCaseRules) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/ListCaseRules) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/ListCaseRules) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/ListCaseRules) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/ListCaseRules) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/ListCaseRules) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/ListCaseRules) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/ListCaseRules) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/ListCaseRules) 

# ListCasesForContact
<a name="API_connect-cases_ListCasesForContact"></a>

Lists cases for a given contact.

## Request Syntax
<a name="API_connect-cases_ListCasesForContact_RequestSyntax"></a>

```
POST /domains/domainId/list-cases-for-contact HTTP/1.1
Content-type: application/json

{
   "contactArn": "string",
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_connect-cases_ListCasesForContact_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_ListCasesForContact_RequestSyntax) **   <a name="connect-connect-cases_ListCasesForContact-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_ListCasesForContact_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [contactArn](#API_connect-cases_ListCasesForContact_RequestSyntax) **   <a name="connect-connect-cases_ListCasesForContact-request-contactArn"></a>
A unique identifier of a contact in Amazon Connect.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [maxResults](#API_connect-cases_ListCasesForContact_RequestSyntax) **   <a name="connect-connect-cases_ListCasesForContact-request-maxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 10.  
Required: No

 ** [nextToken](#API_connect-cases_ListCasesForContact_RequestSyntax) **   <a name="connect-connect-cases_ListCasesForContact-request-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.  
Required: No

## Response Syntax
<a name="API_connect-cases_ListCasesForContact_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cases": [ 
      { 
         "caseId": "string",
         "templateId": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_connect-cases_ListCasesForContact_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [cases](#API_connect-cases_ListCasesForContact_ResponseSyntax) **   <a name="connect-connect-cases_ListCasesForContact-response-cases"></a>
A list of Case summary information.  
Type: Array of [CaseSummary](API_connect-cases_CaseSummary.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.

 ** [nextToken](#API_connect-cases_ListCasesForContact_ResponseSyntax) **   <a name="connect-connect-cases_ListCasesForContact-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

## Errors
<a name="API_connect-cases_ListCasesForContact_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_ListCasesForContact_Examples"></a>

### Request and Response example
<a name="API_connect-cases_ListCasesForContact_Example_1"></a>

This example illustrates one usage of ListCasesForContact.

```
{
  "contactArn": "arn:aws:connect:us-west-2:[account_id]:instance/[connect_instance_id]/contact/[contact_id]",
  "maxResults": 10
}
```

```
{
  "cases": [
    {
      "caseId": "[case_id_1]",
      "templateId": "[template_id_1]"
    },
    {
      "caseId": "[case_id_2]",
      "templateId": "[template_id_2]"
      },
      {
      "caseId": "[case_id_3]",
      "templateId": "[template_id_3]"
      }
    ]
  "nextToken": null
}
```

## See Also
<a name="API_connect-cases_ListCasesForContact_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/ListCasesForContact) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/ListCasesForContact) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/ListCasesForContact) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/ListCasesForContact) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/ListCasesForContact) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/ListCasesForContact) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/ListCasesForContact) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/ListCasesForContact) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/ListCasesForContact) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/ListCasesForContact) 

# ListDomains
<a name="API_connect-cases_ListDomains"></a>

Lists all cases domains in the AWS account. Each list item is a condensed summary object of the domain.

## Request Syntax
<a name="API_connect-cases_ListDomains_RequestSyntax"></a>

```
POST /domains-list?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_ListDomains_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_connect-cases_ListDomains_RequestSyntax) **   <a name="connect-connect-cases_ListDomains-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 10.

 ** [nextToken](#API_connect-cases_ListDomains_RequestSyntax) **   <a name="connect-connect-cases_ListDomains-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 0. Maximum length of 9000.

## Request Body
<a name="API_connect-cases_ListDomains_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_ListDomains_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "domains": [ 
      { 
         "domainArn": "string",
         "domainId": "string",
         "name": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_connect-cases_ListDomains_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [domains](#API_connect-cases_ListDomains_ResponseSyntax) **   <a name="connect-connect-cases_ListDomains-response-domains"></a>
The Cases domain.  
Type: Array of [DomainSummary](API_connect-cases_DomainSummary.md) objects

 ** [nextToken](#API_connect-cases_ListDomains_ResponseSyntax) **   <a name="connect-connect-cases_ListDomains-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

## Errors
<a name="API_connect-cases_ListDomains_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_ListDomains_Examples"></a>

### Request and Response example
<a name="API_connect-cases_ListDomains_Example_1"></a>

This example illustrates one usage of ListDomains.

```
{ }
```

```
{
"domains": [
  {
    "domainArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]",
    "domainId": "[domain_id]",
    "name": "[domain_name]"
  }
]
"nextToken": [nextToken]
}
```

## See Also
<a name="API_connect-cases_ListDomains_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/ListDomains) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/ListDomains) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/ListDomains) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/ListDomains) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/ListDomains) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/ListDomains) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/ListDomains) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/ListDomains) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/ListDomains) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/ListDomains) 

# ListFieldOptions
<a name="API_connect-cases_ListFieldOptions"></a>

Lists all of the field options for a field identifier in the domain. 

## Request Syntax
<a name="API_connect-cases_ListFieldOptions_RequestSyntax"></a>

```
POST /domains/domainId/fields/fieldId/options-list?maxResults=maxResults&nextToken=nextToken&values=values HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_ListFieldOptions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_ListFieldOptions_RequestSyntax) **   <a name="connect-connect-cases_ListFieldOptions-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [fieldId](#API_connect-cases_ListFieldOptions_RequestSyntax) **   <a name="connect-connect-cases_ListFieldOptions-request-uri-fieldId"></a>
The unique identifier of a field.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [maxResults](#API_connect-cases_ListFieldOptions_RequestSyntax) **   <a name="connect-connect-cases_ListFieldOptions-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_connect-cases_ListFieldOptions_RequestSyntax) **   <a name="connect-connect-cases_ListFieldOptions-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 0. Maximum length of 9000.

 ** [values](#API_connect-cases_ListFieldOptions_RequestSyntax) **   <a name="connect-connect-cases_ListFieldOptions-request-uri-values"></a>
A list of `FieldOption` values to filter on for `ListFieldOptions`.  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Length Constraints: Minimum length of 0. Maximum length of 100.

## Request Body
<a name="API_connect-cases_ListFieldOptions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_ListFieldOptions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "options": [ 
      { 
         "active": boolean,
         "name": "string",
         "value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-cases_ListFieldOptions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_connect-cases_ListFieldOptions_ResponseSyntax) **   <a name="connect-connect-cases_ListFieldOptions-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

 ** [options](#API_connect-cases_ListFieldOptions_ResponseSyntax) **   <a name="connect-connect-cases_ListFieldOptions-response-options"></a>
A list of `FieldOption` objects.  
Type: Array of [FieldOption](API_connect-cases_FieldOption.md) objects

## Errors
<a name="API_connect-cases_ListFieldOptions_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_ListFieldOptions_Examples"></a>

### Request and Response example
<a name="API_connect-cases_ListFieldOptions_Example_1"></a>

This example illustrates one usage of ListFieldOptions.

```
{ }
```

```
{
  "nextToken": [nextToken],
  "options": [
     {
     "active": true,
     "name": "California",
     "value": "CA"
     },
     {
     "active": true,
     "name": "Washington",
     "value": "WA"
     },
     {
     "active": true,
     "name": "New York",
     "value": "NY"
     },
     {
     "active": false,
     "name": "Massachusetts",
     "value": "MA"
     }
  ]
}
```

## See Also
<a name="API_connect-cases_ListFieldOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/ListFieldOptions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/ListFieldOptions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/ListFieldOptions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/ListFieldOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/ListFieldOptions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/ListFieldOptions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/ListFieldOptions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/ListFieldOptions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/ListFieldOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/ListFieldOptions) 

# ListFields
<a name="API_connect-cases_ListFields"></a>

Lists all fields in a Cases domain.

## Request Syntax
<a name="API_connect-cases_ListFields_RequestSyntax"></a>

```
POST /domains/domainId/fields-list?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_ListFields_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_ListFields_RequestSyntax) **   <a name="connect-connect-cases_ListFields-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [maxResults](#API_connect-cases_ListFields_RequestSyntax) **   <a name="connect-connect-cases_ListFields-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_connect-cases_ListFields_RequestSyntax) **   <a name="connect-connect-cases_ListFields-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 0. Maximum length of 9000.

## Request Body
<a name="API_connect-cases_ListFields_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_ListFields_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "fields": [ 
      { 
         "attributes": { ... },
         "fieldArn": "string",
         "fieldId": "string",
         "name": "string",
         "namespace": "string",
         "type": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_connect-cases_ListFields_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [fields](#API_connect-cases_ListFields_ResponseSyntax) **   <a name="connect-connect-cases_ListFields-response-fields"></a>
List of detailed field information.  
Type: Array of [FieldSummary](API_connect-cases_FieldSummary.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

 ** [nextToken](#API_connect-cases_ListFields_ResponseSyntax) **   <a name="connect-connect-cases_ListFields-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

## Errors
<a name="API_connect-cases_ListFields_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_ListFields_Examples"></a>

### Request and Response example
<a name="API_connect-cases_ListFields_Example_1"></a>

This example illustrates one usage of ListFields.

```
{ }
```

```
{
  "fields": [
  {
    "fieldId": "[field_id]",
    "fieldArn": "[field_arn]",
    "name": "Color",
    "type": "Text",
    "namespace": "Custom",
    "tags": {}
    }
   ],
   "nextToken": [nextToken]
}
```

## See Also
<a name="API_connect-cases_ListFields_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/ListFields) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/ListFields) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/ListFields) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/ListFields) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/ListFields) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/ListFields) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/ListFields) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/ListFields) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/ListFields) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/ListFields) 

# ListLayouts
<a name="API_connect-cases_ListLayouts"></a>

Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout.

## Request Syntax
<a name="API_connect-cases_ListLayouts_RequestSyntax"></a>

```
POST /domains/domainId/layouts-list?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_ListLayouts_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_ListLayouts_RequestSyntax) **   <a name="connect-connect-cases_ListLayouts-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [maxResults](#API_connect-cases_ListLayouts_RequestSyntax) **   <a name="connect-connect-cases_ListLayouts-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_connect-cases_ListLayouts_RequestSyntax) **   <a name="connect-connect-cases_ListLayouts-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 0. Maximum length of 9000.

## Request Body
<a name="API_connect-cases_ListLayouts_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_ListLayouts_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "layouts": [ 
      { 
         "layoutArn": "string",
         "layoutId": "string",
         "name": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_connect-cases_ListLayouts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [layouts](#API_connect-cases_ListLayouts_ResponseSyntax) **   <a name="connect-connect-cases_ListLayouts-response-layouts"></a>
The layouts for the domain.  
Type: Array of [LayoutSummary](API_connect-cases_LayoutSummary.md) objects

 ** [nextToken](#API_connect-cases_ListLayouts_ResponseSyntax) **   <a name="connect-connect-cases_ListLayouts-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

## Errors
<a name="API_connect-cases_ListLayouts_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_ListLayouts_Examples"></a>

### Request and Response example
<a name="API_connect-cases_ListLayouts_Example_1"></a>

This example illustrates one usage of ListLayouts.

```
{ }
```

```
{
  "layouts": [
    {
      "layoutArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/layout/[layout_id]",
      "layoutId": "[layout_id]",
      "name": "[layout_name]"
    }
  ],
  "nextToken": "[nextToken]"
}
```

## See Also
<a name="API_connect-cases_ListLayouts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/ListLayouts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/ListLayouts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/ListLayouts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/ListLayouts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/ListLayouts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/ListLayouts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/ListLayouts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/ListLayouts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/ListLayouts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/ListLayouts) 

# ListTagsForResource
<a name="API_connect-cases_ListTagsForResource"></a>

Lists tags for a resource.

## Request Syntax
<a name="API_connect-cases_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/arn HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [arn](#API_connect-cases_ListTagsForResource_RequestSyntax) **   <a name="connect-connect-cases_ListTagsForResource-request-uri-arn"></a>
The Amazon Resource Name (ARN)  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-cases_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tags](#API_connect-cases_ListTagsForResource_ResponseSyntax) **   <a name="connect-connect-cases_ListTagsForResource-response-tags"></a>
A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.  
Type: String to string map

## Errors
<a name="API_connect-cases_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_ListTagsForResource_Examples"></a>

### Request and Response example
<a name="API_connect-cases_ListTagsForResource_Example_1"></a>

This example illustrates one usage of ListTagsForResource.

```
{ }
```

```
{
  "tags": {
  "some_key": "some_value"
  }
}
```

## See Also
<a name="API_connect-cases_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/ListTagsForResource) 

# ListTemplates
<a name="API_connect-cases_ListTemplates"></a>

Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template. 

 Other template APIs are: 
+  [CreateTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateTemplate.html) 
+  [DeleteTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html) 
+  [GetTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html) 
+  [UpdateTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html) 

## Request Syntax
<a name="API_connect-cases_ListTemplates_RequestSyntax"></a>

```
POST /domains/domainId/templates-list?maxResults=maxResults&nextToken=nextToken&status=status HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_ListTemplates_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_ListTemplates_RequestSyntax) **   <a name="connect-connect-cases_ListTemplates-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [maxResults](#API_connect-cases_ListTemplates_RequestSyntax) **   <a name="connect-connect-cases_ListTemplates-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_connect-cases_ListTemplates_RequestSyntax) **   <a name="connect-connect-cases_ListTemplates-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 0. Maximum length of 9000.

 ** [status](#API_connect-cases_ListTemplates_RequestSyntax) **   <a name="connect-connect-cases_ListTemplates-request-uri-status"></a>
A list of status values to filter on.  
Array Members: Minimum number of 1 item. Maximum number of 2 items.  
Valid Values: `Active | Inactive` 

## Request Body
<a name="API_connect-cases_ListTemplates_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_ListTemplates_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "templates": [ 
      { 
         "name": "string",
         "status": "string",
         "tagPropagationConfigurations": [ 
            { 
               "resourceType": "string",
               "tagMap": { 
                  "string" : "string" 
               }
            }
         ],
         "templateArn": "string",
         "templateId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-cases_ListTemplates_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_connect-cases_ListTemplates_ResponseSyntax) **   <a name="connect-connect-cases_ListTemplates-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

 ** [templates](#API_connect-cases_ListTemplates_ResponseSyntax) **   <a name="connect-connect-cases_ListTemplates-response-templates"></a>
List of template summary objects.  
Type: Array of [TemplateSummary](API_connect-cases_TemplateSummary.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

## Errors
<a name="API_connect-cases_ListTemplates_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_ListTemplates_Examples"></a>

### Request and Response example
<a name="API_connect-cases_ListTemplates_Example_1"></a>

This example illustrates one usage of ListTemplates.

```
{ }
```

```
{
  "templates":[
  {
    "name":"Test",   
    "templateArn":"arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/template/[template_id]",
    "templateId":"[template_id]",
    "status": "Active",
    "tagPropagationConfigurations": [
      {
        "resourceType": "Cases",
        "tagMap": {
          "Department" : "Support"
        }
      }
    ]
  }
  ],
  "nextToken":"[nextToken]"
}
```

## See Also
<a name="API_connect-cases_ListTemplates_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/ListTemplates) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/ListTemplates) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/ListTemplates) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/ListTemplates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/ListTemplates) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/ListTemplates) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/ListTemplates) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/ListTemplates) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/ListTemplates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/ListTemplates) 

# PutCaseEventConfiguration
<a name="API_connect-cases_PutCaseEventConfiguration"></a>

Adds case event publishing configuration. For a complete list of fields you can add to the event message, see [Create case fields](https://docs.aws.amazon.com/connect/latest/adminguide/case-fields.html) in the *Amazon Connect Administrator Guide* 

## Request Syntax
<a name="API_connect-cases_PutCaseEventConfiguration_RequestSyntax"></a>

```
PUT /domains/domainId/case-event-configuration HTTP/1.1
Content-type: application/json

{
   "eventBridge": { 
      "enabled": boolean,
      "includedData": { 
         "caseData": { 
            "fields": [ 
               { 
                  "id": "string"
               }
            ]
         },
         "relatedItemData": { 
            "includeContent": boolean
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_connect-cases_PutCaseEventConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_PutCaseEventConfiguration_RequestSyntax) **   <a name="connect-connect-cases_PutCaseEventConfiguration-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_PutCaseEventConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [eventBridge](#API_connect-cases_PutCaseEventConfiguration_RequestSyntax) **   <a name="connect-connect-cases_PutCaseEventConfiguration-request-eventBridge"></a>
Configuration to enable EventBridge case event delivery and determine what data is delivered.  
Type: [EventBridgeConfiguration](API_connect-cases_EventBridgeConfiguration.md) object  
Required: Yes

## Response Syntax
<a name="API_connect-cases_PutCaseEventConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_PutCaseEventConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_PutCaseEventConfiguration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_PutCaseEventConfiguration_Examples"></a>

### Request and Response example
<a name="API_connect-cases_PutCaseEventConfiguration_Example_1"></a>

This example illustrates one use of PutCaseEventConfiguration. 

```
{
  "enabled":true,
  "includedData":{
    "caseData":{
      "fields":[
        {
        "id":"status"
        },
        {
        "id":"title"
        },
        {
        "id":"customer_id"
        },
        {
        "id":"case_reason"
        }
        ]
    },
   "relatedItemData":{
       "includeContent":true
    }
  }}
```

```
{ }
```

## See Also
<a name="API_connect-cases_PutCaseEventConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/PutCaseEventConfiguration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/PutCaseEventConfiguration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/PutCaseEventConfiguration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/PutCaseEventConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/PutCaseEventConfiguration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/PutCaseEventConfiguration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/PutCaseEventConfiguration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/PutCaseEventConfiguration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/PutCaseEventConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/PutCaseEventConfiguration) 

# SearchAllRelatedItems
<a name="API_connect-cases_SearchAllRelatedItems"></a>

Searches for related items across all cases within a domain. This is a global search operation that returns related items from multiple cases, unlike the case-specific [SearchRelatedItems](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_SearchRelatedItems.html) API.

 **Use cases** 

Following are common uses cases for this API:
+ Find cases with similar issues across the domain. For example, search for all cases containing comments about "product defect" to identify patterns and existing solutions.
+ Locate all cases associated with specific contacts or orders. For example, find all cases linked to a contactArn to understand the complete customer journey. 
+ Monitor SLA compliance across cases. For example, search for all cases with "Active" SLA status to prioritize remediation efforts.

 **Important things to know** 
+ This API returns case identifiers, not complete case objects. To retrieve full case details, you must make additional calls to the [GetCase](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetCase.html) API for each returned case ID. 
+ This API searches across related items content, not case fields. Use the [SearchCases](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_SearchCases.html) API to search within case field values.

 **Endpoints**: See [Amazon Connect endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/connect_region.html).

## Request Syntax
<a name="API_connect-cases_SearchAllRelatedItems_RequestSyntax"></a>

```
POST /domains/domainId/related-items-search HTTP/1.1
Content-type: application/json

{
   "filters": [ 
      { ... }
   ],
   "maxResults": number,
   "nextToken": "string",
   "sorts": [ 
      { 
         "sortOrder": "string",
         "sortProperty": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_connect-cases_SearchAllRelatedItems_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_SearchAllRelatedItems_RequestSyntax) **   <a name="connect-connect-cases_SearchAllRelatedItems-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_SearchAllRelatedItems_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filters](#API_connect-cases_SearchAllRelatedItems_RequestSyntax) **   <a name="connect-connect-cases_SearchAllRelatedItems-request-filters"></a>
The list of types of related items and their parameters to use for filtering. The filters work as an OR condition: caller gets back related items that match any of the specified filter types.  
Type: Array of [RelatedItemTypeFilter](API_connect-cases_RelatedItemTypeFilter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** [maxResults](#API_connect-cases_SearchAllRelatedItems_RequestSyntax) **   <a name="connect-connect-cases_SearchAllRelatedItems-request-maxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 25.  
Required: No

 ** [nextToken](#API_connect-cases_SearchAllRelatedItems_RequestSyntax) **   <a name="connect-connect-cases_SearchAllRelatedItems-request-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.  
Required: No

 ** [sorts](#API_connect-cases_SearchAllRelatedItems_RequestSyntax) **   <a name="connect-connect-cases_SearchAllRelatedItems-request-sorts"></a>
A structured set of sort terms to specify the order in which related items should be returned. Supports sorting by association time or case ID. The sorts work in the order specified: first sort term takes precedence over subsequent terms.  
Type: Array of [SearchAllRelatedItemsSort](API_connect-cases_SearchAllRelatedItemsSort.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 2 items.  
Required: No

## Response Syntax
<a name="API_connect-cases_SearchAllRelatedItems_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "relatedItems": [ 
      { 
         "associationTime": "string",
         "caseId": "string",
         "content": { ... },
         "performedBy": { ... },
         "relatedItemId": "string",
         "tags": { 
            "string" : "string" 
         },
         "type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-cases_SearchAllRelatedItems_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_connect-cases_SearchAllRelatedItems_ResponseSyntax) **   <a name="connect-connect-cases_SearchAllRelatedItems-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

 ** [relatedItems](#API_connect-cases_SearchAllRelatedItems_ResponseSyntax) **   <a name="connect-connect-cases_SearchAllRelatedItems-response-relatedItems"></a>
A list of items related to a case.  
Type: Array of [SearchAllRelatedItemsResponseItem](API_connect-cases_SearchAllRelatedItemsResponseItem.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.

## Errors
<a name="API_connect-cases_SearchAllRelatedItems_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_SearchAllRelatedItems_Examples"></a>

### Example request to search for all contact-type related items
<a name="API_connect-cases_SearchAllRelatedItems_Example_1"></a>

The following example shows how to search for all contact-type related items across cases in a domain, filtering by a specific contactArn and sorting results by association time in descending order, then by case ID in descending order.

```
{
  "sorts": [
    {
      "sortProperty": "AssociationTime",
      "sortOrder": "Desc"
    },
    {
      "sortProperty": "CaseId",
      "sortOrder": "Desc"
    }
  ],
  "maxResults": 10,
  "filters": [
    {
      "contact": {
        "contactArn": "arn:aws:connect:us-west-2:[account-id]:instance/[instance-id]/contact/[contact-id]"
      }
    }
  ]
}
```

### Example response for a successful search
<a name="API_connect-cases_SearchAllRelatedItems_Example_2"></a>

The following example shows a successful search returning two contact-type related items from different cases, each with their associated case identifiers, contact details, and metadata sorted by most recent association time first.

```
{
  "nextToken": null,
  "relatedItems": [
    {
      "associationTime": "2025-05-16T13:18:37.608074706Z",
      "caseId": "[case-id-1]",
      "content": {
        "contact": {
          "contactArn": "arn:aws:connect:us-west-2:[account-id]:instance/[instance-id]/contact/[contact-id]",
          "channel": "VOICE",
          "connectedToSystemTime": "2025-05-16T13:18:30.000000000Z"
        }
      },
      "performedBy": null,
      "relatedItemId": "[related-item-id-1]",
      "tags": {
        "Company": "AWS",
        "Team": "Connect"
      },
      "type": "Contact"
    },
    {
      "associationTime": "2025-05-16T13:18:19.270469991Z",
      "caseId": "[case-id-2]",
      "content": {
        "contact": {
          "contactArn": "arn:aws:connect:us-west-2:[account-id]:instance/[instance-id]/contact/[contact-id]",
          "channel": "CHAT",
          "connectedToSystemTime": "2025-05-16T13:18:15.000000000Z"
        }
      },
      "performedBy": null,
      "relatedItemId": "[related-item-id-2]",
      "tags": {},
      "type": "Contact"
    }
  ]
}
```

## See Also
<a name="API_connect-cases_SearchAllRelatedItems_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/SearchAllRelatedItems) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/SearchAllRelatedItems) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/SearchAllRelatedItems) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/SearchAllRelatedItems) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/SearchAllRelatedItems) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/SearchAllRelatedItems) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/SearchAllRelatedItems) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/SearchAllRelatedItems) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/SearchAllRelatedItems) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/SearchAllRelatedItems) 

# SearchCases
<a name="API_connect-cases_SearchCases"></a>

Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.

**Note**  
For `customer_id` you must provide the full customer profile ARN in this format: ` arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain name/profiles/profile ID`. 

## Request Syntax
<a name="API_connect-cases_SearchCases_RequestSyntax"></a>

```
POST /domains/domainId/cases-search HTTP/1.1
Content-type: application/json

{
   "fields": [ 
      { 
         "id": "string"
      }
   ],
   "filter": { ... },
   "maxResults": number,
   "nextToken": "string",
   "searchTerm": "string",
   "sorts": [ 
      { 
         "fieldId": "string",
         "sortOrder": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_connect-cases_SearchCases_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_SearchCases_RequestSyntax) **   <a name="connect-connect-cases_SearchCases-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_SearchCases_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [fields](#API_connect-cases_SearchCases_RequestSyntax) **   <a name="connect-connect-cases_SearchCases-request-fields"></a>
The list of field identifiers to be returned as part of the response.  
Type: Array of [FieldIdentifier](API_connect-cases_FieldIdentifier.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.  
Required: No

 ** [filter](#API_connect-cases_SearchCases_RequestSyntax) **   <a name="connect-connect-cases_SearchCases-request-filter"></a>
A list of filter objects.  
Type: [CaseFilter](API_connect-cases_CaseFilter.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [maxResults](#API_connect-cases_SearchCases_RequestSyntax) **   <a name="connect-connect-cases_SearchCases-request-maxResults"></a>
The maximum number of cases to return. When no value is provided, 25 is the default.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_connect-cases_SearchCases_RequestSyntax) **   <a name="connect-connect-cases_SearchCases-request-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.  
Required: No

 ** [searchTerm](#API_connect-cases_SearchCases_RequestSyntax) **   <a name="connect-connect-cases_SearchCases-request-searchTerm"></a>
A word or phrase used to perform a quick search.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [sorts](#API_connect-cases_SearchCases_RequestSyntax) **   <a name="connect-connect-cases_SearchCases-request-sorts"></a>
A list of sorts where each sort specifies a field and their sort order to be applied to the results.   
Type: Array of [Sort](API_connect-cases_Sort.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 2 items.  
Required: No

## Response Syntax
<a name="API_connect-cases_SearchCases_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "cases": [ 
      { 
         "caseId": "string",
         "fields": [ 
            { 
               "id": "string",
               "value": { ... }
            }
         ],
         "tags": { 
            "string" : "string" 
         },
         "templateId": "string"
      }
   ],
   "nextToken": "string",
   "totalCount": number
}
```

## Response Elements
<a name="API_connect-cases_SearchCases_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [cases](#API_connect-cases_SearchCases_ResponseSyntax) **   <a name="connect-connect-cases_SearchCases-response-cases"></a>
A list of case documents where each case contains the properties `CaseId` and `Fields` where each field is a complex union structure.   
Type: Array of [SearchCasesResponseItem](API_connect-cases_SearchCasesResponseItem.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

 ** [nextToken](#API_connect-cases_SearchCases_ResponseSyntax) **   <a name="connect-connect-cases_SearchCases-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

 ** [totalCount](#API_connect-cases_SearchCases_ResponseSyntax) **   <a name="connect-connect-cases_SearchCases-response-totalCount"></a>
The total number of cases that matched the search criteria.  
Type: Long  
Valid Range: Minimum value of 0.

## Errors
<a name="API_connect-cases_SearchCases_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_SearchCases_Examples"></a>

### Request example
<a name="API_connect-cases_SearchCases_Example_1"></a>

This example illustrates one usage of SearchCases.

```
{
   "filter":{
      "andAll":[
         {
            "field":{
               "equalTo":{
                  "id":"title",
                  "value":{
                     "stringValue":"Forward Web Engineer"
                  }
               }
            }
         },
         {
            "not":{
               "field":{
                  "greaterThan":{
                     "id":"customer_age",
                     "value":{
                        "doubleValue":38
                     }
                  }
               }
            }
         }
      ]
   },
   "fields":[
      {
         "id":"title"
      }
   ],
   "maxResults":10,
   "nextToken":null,
   "sorts":[
      {
         "fieldId":"created_datetime",
         "sortOrder":"Asc"
      }
   ]
}
```

### Response example
<a name="API_connect-cases_SearchCases_Example_2"></a>

This example illustrates one usage of SearchCases.

```
{
   "cases":[
      {
         "caseId":"[case_id_1]",
         "fields":[
            {
               "id":"title",
               "value":{
                  "stringValue":"Forward Web Engineer-1"
               }
            }
         ],
         "tags":{
            
         },
         "templateId":"[template_id]"
      },
      {
         "caseId":"[case_id_2]",
         "fields":[
            {
               "id":"title",
               "value":{
                  "stringValue":"Forward Web Engineer-2"
               }
            }
         ],
         "tags":{
            
         },
         "templateId":"[template_id]"
      },
      {
         "caseId":"[case_id_3]",
         "fields":[
            {
               "id":"title",
               "value":{
                  "stringValue":"Forward Web Engineer-3"
               }
            }
         ],
         "tags":{
            
         },
         "templateId":"[template_id]"
      }
   ],
   "nextToken":"[nextToken]"
}
```

## See Also
<a name="API_connect-cases_SearchCases_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/SearchCases) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/SearchCases) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/SearchCases) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/SearchCases) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/SearchCases) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/SearchCases) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/SearchCases) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/SearchCases) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/SearchCases) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/SearchCases) 

# SearchRelatedItems
<a name="API_connect-cases_SearchRelatedItems"></a>

Searches for related items that are associated with a case.

**Note**  
If no filters are provided, this returns all related items associated with a case.

## Request Syntax
<a name="API_connect-cases_SearchRelatedItems_RequestSyntax"></a>

```
POST /domains/domainId/cases/caseId/related-items-search HTTP/1.1
Content-type: application/json

{
   "filters": [ 
      { ... }
   ],
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_connect-cases_SearchRelatedItems_RequestParameters"></a>

The request uses the following URI parameters.

 ** [caseId](#API_connect-cases_SearchRelatedItems_RequestSyntax) **   <a name="connect-connect-cases_SearchRelatedItems-request-uri-caseId"></a>
A unique identifier of the case.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [domainId](#API_connect-cases_SearchRelatedItems_RequestSyntax) **   <a name="connect-connect-cases_SearchRelatedItems-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_SearchRelatedItems_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filters](#API_connect-cases_SearchRelatedItems_RequestSyntax) **   <a name="connect-connect-cases_SearchRelatedItems-request-filters"></a>
The list of types of related items and their parameters to use for filtering.  
Type: Array of [RelatedItemTypeFilter](API_connect-cases_RelatedItemTypeFilter.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

 ** [maxResults](#API_connect-cases_SearchRelatedItems_RequestSyntax) **   <a name="connect-connect-cases_SearchRelatedItems-request-maxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 25.  
Required: No

 ** [nextToken](#API_connect-cases_SearchRelatedItems_RequestSyntax) **   <a name="connect-connect-cases_SearchRelatedItems-request-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.  
Required: No

## Response Syntax
<a name="API_connect-cases_SearchRelatedItems_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "relatedItems": [ 
      { 
         "associationTime": "string",
         "content": { ... },
         "performedBy": { ... },
         "relatedItemId": "string",
         "tags": { 
            "string" : "string" 
         },
         "type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-cases_SearchRelatedItems_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_connect-cases_SearchRelatedItems_ResponseSyntax) **   <a name="connect-connect-cases_SearchRelatedItems-response-nextToken"></a>
The token for the next set of results. This is null if there are no more results to return.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 9000.

 ** [relatedItems](#API_connect-cases_SearchRelatedItems_ResponseSyntax) **   <a name="connect-connect-cases_SearchRelatedItems-response-relatedItems"></a>
A list of items related to a case.   
Type: Array of [SearchRelatedItemsResponseItem](API_connect-cases_SearchRelatedItemsResponseItem.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 25 items.

## Errors
<a name="API_connect-cases_SearchRelatedItems_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_SearchRelatedItems_Examples"></a>

### Request and Response example
<a name="API_connect-cases_SearchRelatedItems_Example_1"></a>

This example illustrates one usage of SearchRelatedItems.

```
{
  "maxResults": 25,
  "filters": [
  {
    "contact": {
      "contactArn": "arn:aws:connect:us-west-2:[account_id]:instance/[connect_instance_id]/contact/[contact_id]"
      }
    }
  ]
}
```

```
{
  "nextToken": null,
  "relatedItems": [
    {
    "associationTime": "2022-06-06T18:59:09.865709Z",
    "content": {
      "contact": {
      "channel": "CHAT",
      "connectedToSystemTime": "2022-06-08T18:57:50.558897Z",
      "contactArn": "arn:aws:connect:us-west-2:[account_id]:instance/[connect_instance_id]/contact/[contact_id]"
      }
    },
  "relatedItemId": "[relatedItem_id]",
  "tags": {},
  "type": "Contact"
   }
  ]
}
```

## See Also
<a name="API_connect-cases_SearchRelatedItems_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/SearchRelatedItems) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/SearchRelatedItems) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/SearchRelatedItems) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/SearchRelatedItems) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/SearchRelatedItems) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/SearchRelatedItems) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/SearchRelatedItems) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/SearchRelatedItems) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/SearchRelatedItems) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/SearchRelatedItems) 

# TagResource
<a name="API_connect-cases_TagResource"></a>

Adds tags to a resource.

## Request Syntax
<a name="API_connect-cases_TagResource_RequestSyntax"></a>

```
POST /tags/arn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_connect-cases_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [arn](#API_connect-cases_TagResource_RequestSyntax) **   <a name="connect-connect-cases_TagResource-request-uri-arn"></a>
The Amazon Resource Name (ARN)  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [tags](#API_connect-cases_TagResource_RequestSyntax) **   <a name="connect-connect-cases_TagResource-request-tags"></a>
A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.  
Type: String to string map  
Required: Yes

## Response Syntax
<a name="API_connect-cases_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_TagResource_Examples"></a>

### Request and Response example
<a name="API_connect-cases_TagResource_Example_1"></a>

This example illustrates one usage of TagResource.

```
{
  "tags": {
  "some_key": "some_value"
  }
}
```

```
{ }
```

## See Also
<a name="API_connect-cases_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/TagResource) 

# UntagResource
<a name="API_connect-cases_UntagResource"></a>

Untags a resource.

## Request Syntax
<a name="API_connect-cases_UntagResource_RequestSyntax"></a>

```
DELETE /tags/arn?tagKeys=tagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-cases_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [arn](#API_connect-cases_UntagResource_RequestSyntax) **   <a name="connect-connect-cases_UntagResource-request-uri-arn"></a>
The Amazon Resource Name (ARN)  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [tagKeys](#API_connect-cases_UntagResource_RequestSyntax) **   <a name="connect-connect-cases_UntagResource-request-uri-tagKeys"></a>
List of tag keys.  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Required: Yes

## Request Body
<a name="API_connect-cases_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-cases_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_UntagResource_Examples"></a>

### Request and Response example
<a name="API_connect-cases_UntagResource_Example_1"></a>

This example illustrates one usage of UntagResource.

```
{ }
```

```
{ }
```

## See Also
<a name="API_connect-cases_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/UntagResource) 

# UpdateCase
<a name="API_connect-cases_UpdateCase"></a>

**Note**  
If you provide a value for `PerformedBy.UserArn` you must also have [connect:DescribeUser](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html) permission on the User ARN resource that you provide

Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the `CreateCase` input .

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Request Syntax
<a name="API_connect-cases_UpdateCase_RequestSyntax"></a>

```
PUT /domains/domainId/cases/caseId HTTP/1.1
Content-type: application/json

{
   "fields": [ 
      { 
         "id": "string",
         "value": { ... }
      }
   ],
   "performedBy": { ... }
}
```

## URI Request Parameters
<a name="API_connect-cases_UpdateCase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [caseId](#API_connect-cases_UpdateCase_RequestSyntax) **   <a name="connect-connect-cases_UpdateCase-request-uri-caseId"></a>
A unique identifier of the case.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [domainId](#API_connect-cases_UpdateCase_RequestSyntax) **   <a name="connect-connect-cases_UpdateCase-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_UpdateCase_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [fields](#API_connect-cases_UpdateCase_RequestSyntax) **   <a name="connect-connect-cases_UpdateCase-request-fields"></a>
An array of objects with `fieldId` (matching ListFields/DescribeField) and value union data, structured identical to `CreateCase`.  
Type: Array of [FieldValue](API_connect-cases_FieldValue.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 220 items.  
Required: Yes

 ** [performedBy](#API_connect-cases_UpdateCase_RequestSyntax) **   <a name="connect-connect-cases_UpdateCase-request-performedBy"></a>
Represents the entity that performed the action.  
Type: [UserUnion](API_connect-cases_UserUnion.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## Response Syntax
<a name="API_connect-cases_UpdateCase_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_UpdateCase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_UpdateCase_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_UpdateCase_Examples"></a>

### Request and Response example
<a name="API_connect-cases_UpdateCase_Example_1"></a>

This example illustrates one usage of UpdateCase.

```
{
  "fields": [
    {
      "id": "title",
      "value": {
        "stringValue": "New Title"
        }
      }
  ]
}
```

```
{ }
```

## See Also
<a name="API_connect-cases_UpdateCase_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/UpdateCase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/UpdateCase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/UpdateCase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/UpdateCase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/UpdateCase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/UpdateCase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/UpdateCase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/UpdateCase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/UpdateCase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/UpdateCase) 

# UpdateCaseRule
<a name="API_connect-cases_UpdateCaseRule"></a>

Updates a case rule. In the Amazon Connect admin website, case rules are known as *case field conditions*. For more information about case field conditions, see [Add case field conditions to a case template](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html).

## Request Syntax
<a name="API_connect-cases_UpdateCaseRule_RequestSyntax"></a>

```
PUT /domains/domainId/case-rules/caseRuleId HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "name": "string",
   "rule": { ... }
}
```

## URI Request Parameters
<a name="API_connect-cases_UpdateCaseRule_RequestParameters"></a>

The request uses the following URI parameters.

 ** [caseRuleId](#API_connect-cases_UpdateCaseRule_RequestSyntax) **   <a name="connect-connect-cases_UpdateCaseRule-request-uri-caseRuleId"></a>
Unique identifier of a case rule.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [domainId](#API_connect-cases_UpdateCaseRule_RequestSyntax) **   <a name="connect-connect-cases_UpdateCaseRule-request-uri-domainId"></a>
Unique identifier of a Cases domain.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_UpdateCaseRule_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_connect-cases_UpdateCaseRule_RequestSyntax) **   <a name="connect-connect-cases_UpdateCaseRule-request-description"></a>
Description of a case rule.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [name](#API_connect-cases_UpdateCaseRule_RequestSyntax) **   <a name="connect-connect-cases_UpdateCaseRule-request-name"></a>
Name of the case rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]`   
Required: No

 ** [rule](#API_connect-cases_UpdateCaseRule_RequestSyntax) **   <a name="connect-connect-cases_UpdateCaseRule-request-rule"></a>
Represents what rule type should take place, under what conditions.  
Type: [CaseRuleDetails](API_connect-cases_CaseRuleDetails.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## Response Syntax
<a name="API_connect-cases_UpdateCaseRule_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_UpdateCaseRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_UpdateCaseRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*.  
HTTP Status Code: 402

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## See Also
<a name="API_connect-cases_UpdateCaseRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/UpdateCaseRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/UpdateCaseRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/UpdateCaseRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/UpdateCaseRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/UpdateCaseRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/UpdateCaseRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/UpdateCaseRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/UpdateCaseRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/UpdateCaseRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/UpdateCaseRule) 

# UpdateField
<a name="API_connect-cases_UpdateField"></a>

Updates the properties of an existing field. 

## Request Syntax
<a name="API_connect-cases_UpdateField_RequestSyntax"></a>

```
PUT /domains/domainId/fields/fieldId HTTP/1.1
Content-type: application/json

{
   "attributes": { ... },
   "description": "string",
   "name": "string"
}
```

## URI Request Parameters
<a name="API_connect-cases_UpdateField_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_UpdateField_RequestSyntax) **   <a name="connect-connect-cases_UpdateField-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [fieldId](#API_connect-cases_UpdateField_RequestSyntax) **   <a name="connect-connect-cases_UpdateField-request-uri-fieldId"></a>
The unique identifier of a field.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_UpdateField_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [attributes](#API_connect-cases_UpdateField_RequestSyntax) **   <a name="connect-connect-cases_UpdateField-request-attributes"></a>
Union of field attributes.  
Type: [FieldAttributes](API_connect-cases_FieldAttributes.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [description](#API_connect-cases_UpdateField_RequestSyntax) **   <a name="connect-connect-cases_UpdateField-request-description"></a>
The description of a field.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [name](#API_connect-cases_UpdateField_RequestSyntax) **   <a name="connect-connect-cases_UpdateField-request-name"></a>
The name of the field.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]`   
Required: No

## Response Syntax
<a name="API_connect-cases_UpdateField_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_UpdateField_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_UpdateField_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_UpdateField_Examples"></a>

### Request and Response example
<a name="API_connect-cases_UpdateField_Example_1"></a>

This example illustrates one usage of UpdateField.

```
{
  "name": "updated_field_name"
}
```

```
{ }
```

## See Also
<a name="API_connect-cases_UpdateField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/UpdateField) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/UpdateField) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/UpdateField) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/UpdateField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/UpdateField) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/UpdateField) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/UpdateField) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/UpdateField) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/UpdateField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/UpdateField) 

# UpdateLayout
<a name="API_connect-cases_UpdateLayout"></a>

Updates the attributes of an existing layout.

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

A `ValidationException` is returned when you add non-existent `fieldIds` to a layout.

**Note**  
Title and Status fields cannot be part of layouts because they are not configurable.

## Request Syntax
<a name="API_connect-cases_UpdateLayout_RequestSyntax"></a>

```
PUT /domains/domainId/layouts/layoutId HTTP/1.1
Content-type: application/json

{
   "content": { ... },
   "name": "string"
}
```

## URI Request Parameters
<a name="API_connect-cases_UpdateLayout_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_UpdateLayout_RequestSyntax) **   <a name="connect-connect-cases_UpdateLayout-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [layoutId](#API_connect-cases_UpdateLayout_RequestSyntax) **   <a name="connect-connect-cases_UpdateLayout-request-uri-layoutId"></a>
The unique identifier of the layout.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_UpdateLayout_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [content](#API_connect-cases_UpdateLayout_RequestSyntax) **   <a name="connect-connect-cases_UpdateLayout-request-content"></a>
Information about which fields will be present in the layout, the order of the fields.  
Type: [LayoutContent](API_connect-cases_LayoutContent.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [name](#API_connect-cases_UpdateLayout_RequestSyntax) **   <a name="connect-connect-cases_UpdateLayout-request-name"></a>
The name of the layout. It must be unique per domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]`   
Required: No

## Response Syntax
<a name="API_connect-cases_UpdateLayout_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_UpdateLayout_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_UpdateLayout_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*.  
HTTP Status Code: 402

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_UpdateLayout_Examples"></a>

### Request and Response example
<a name="API_connect-cases_UpdateLayout_Example_1"></a>

This example illustrates one usage of UpdateLayout.

```
{
  "content": {
    "basic": {
      "moreInfo": {
        "sections": [
          {
          "fieldGroup": {
            "fields": [
              {
              "id": "created_datetime"
              },
              {
              "id": "case_id"
              }
            ]
           }
          }
         ]
      },
    "topPanel": {
      "sections": [
        {
        "fieldGroup": {
          "fields": [
            {
              "id": "summary"
               },
              {
              "id": "status"
              },
              {
              "id": "case_id"
              }
            ]
          }
        }
      ]
    }
  }
},
"name": "testLayout"
}
```

```
{ }
```

## See Also
<a name="API_connect-cases_UpdateLayout_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/UpdateLayout) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/UpdateLayout) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/UpdateLayout) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/UpdateLayout) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/UpdateLayout) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/UpdateLayout) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/UpdateLayout) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/UpdateLayout) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/UpdateLayout) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/UpdateLayout) 

# UpdateRelatedItem
<a name="API_connect-cases_UpdateRelatedItem"></a>

Updates the content of a related item associated with a case. The following related item types are supported:
+  **Comment** - Update the text content of an existing comment
+  **Custom** - Update the fields of a custom related item. You can add, modify, and remove fields from a custom related item. There's a quota for the number of fields allowed in a Custom type related item. See [Amazon Connect Cases quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#cases-quotas).

 **Important things to know** 
+ When updating a Custom related item, all existing and new fields, and their associated values should be included in the request. Fields not included as part of this request will be removed.
+ If you provide a value for `performedBy.userArn` you must also have [DescribeUser](https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html) permission on the ARN of the user that you provide.
+  [System case fields](https://docs.aws.amazon.com/connect/latest/adminguide/case-fields.html#system-case-fields) cannot be used in a custom related item.

 **Endpoints**: See [Amazon Connect endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/connect_region.html).

## Request Syntax
<a name="API_connect-cases_UpdateRelatedItem_RequestSyntax"></a>

```
PUT /domains/domainId/cases/caseId/related-items/relatedItemId HTTP/1.1
Content-type: application/json

{
   "content": { ... },
   "performedBy": { ... }
}
```

## URI Request Parameters
<a name="API_connect-cases_UpdateRelatedItem_RequestParameters"></a>

The request uses the following URI parameters.

 ** [caseId](#API_connect-cases_UpdateRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-request-uri-caseId"></a>
A unique identifier of the case.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [domainId](#API_connect-cases_UpdateRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [relatedItemId](#API_connect-cases_UpdateRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-request-uri-relatedItemId"></a>
Unique identifier of a related item.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_UpdateRelatedItem_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [content](#API_connect-cases_UpdateRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-request-content"></a>
The content of a related item to be updated.  
Type: [RelatedItemUpdateContent](API_connect-cases_RelatedItemUpdateContent.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [performedBy](#API_connect-cases_UpdateRelatedItem_RequestSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-request-performedBy"></a>
Represents the user who performed the update of the related item.  
Type: [UserUnion](API_connect-cases_UserUnion.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## Response Syntax
<a name="API_connect-cases_UpdateRelatedItem_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "associationTime": "string",
   "content": { ... },
   "createdBy": { ... },
   "lastUpdatedUser": { ... },
   "relatedItemArn": "string",
   "relatedItemId": "string",
   "tags": { 
      "string" : "string" 
   },
   "type": "string"
}
```

## Response Elements
<a name="API_connect-cases_UpdateRelatedItem_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [associationTime](#API_connect-cases_UpdateRelatedItem_ResponseSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-response-associationTime"></a>
Time at which the related item was associated with the case.  
Type: Timestamp

 ** [content](#API_connect-cases_UpdateRelatedItem_ResponseSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-response-content"></a>
Represents the content of the updated related item.  
Type: [RelatedItemContent](API_connect-cases_RelatedItemContent.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [createdBy](#API_connect-cases_UpdateRelatedItem_ResponseSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-response-createdBy"></a>
Represents the creator of the related item.  
Type: [UserUnion](API_connect-cases_UserUnion.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [lastUpdatedUser](#API_connect-cases_UpdateRelatedItem_ResponseSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-response-lastUpdatedUser"></a>
Represents the last user that updated the related item.  
Type: [UserUnion](API_connect-cases_UserUnion.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [relatedItemArn](#API_connect-cases_UpdateRelatedItem_ResponseSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-response-relatedItemArn"></a>
The Amazon Resource Name (ARN) of the updated related item.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [relatedItemId](#API_connect-cases_UpdateRelatedItem_ResponseSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-response-relatedItemId"></a>
The unique identifier of the updated related item.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.

 ** [tags](#API_connect-cases_UpdateRelatedItem_ResponseSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-response-tags"></a>
A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.  
Type: String to string map

 ** [type](#API_connect-cases_UpdateRelatedItem_ResponseSyntax) **   <a name="connect-connect-cases_UpdateRelatedItem-response-type"></a>
Type of the updated related item.  
Type: String  
Valid Values: `Contact | Comment | File | Sla | ConnectCase | Custom` 

## Errors
<a name="API_connect-cases_UpdateRelatedItem_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_UpdateRelatedItem_Examples"></a>

This section provides examples for updating supported related item types.

### Update Comment related item
<a name="API_connect-cases_UpdateRelatedItem_Example_1"></a>

Request to update a comment's text and content type:

```
{
  "domainId": "[domain_id]",
  "caseId": "[case_id]",
  "relatedItemId": "[related_item_id]",
  "content": {
    "comment": {
      "body": "Updated comment text with additional details",
      "contentType": "Text/Plain"
    }
  }
}
```

### Update Custom related item
<a name="API_connect-cases_UpdateRelatedItem_Example_2"></a>

Request to update field values in a custom related item:

**Note**  
 [System case fields](https://docs.aws.amazon.com/connect/latest/adminguide/case-fields.html#system-case-fields) cannot be used in a custom related item.

```
{
  "domainId": "[domain_id]",
  "caseId": "[case_id]",
  "relatedItemId": "[related_item_id]",
  "content": {
    "custom": {
      "fields": [
        {
          "id": "[field_id_1]",
          "value": {
            "stringValue": "Updated value for first field"
          }
        },
        {
          "id": "[field_id_2]",
          "value": {
            "stringValue": "Updated value for second field"
          }
        },
        {
          "id": "[field_id_3]",
          "value": {
            "stringValue": "Existing value that remains unchanged"
          }
        }
      ]
    }
  }
}
```

### Update with performedBy parameter
<a name="API_connect-cases_UpdateRelatedItem_Example_3"></a>

Request to update a comment and specify who performed the update:

```
{
  "domainId": "[domain_id]",
  "caseId": "[case_id]",
  "relatedItemId": "[related_item_id]",
  "content": {
    "comment": {
      "body": "Updated comment text with additional details",
      "contentType": "Text/Plain"
    }
  },
  "performedBy": {
    "userArn": "arn:aws:connect:us-west-2:[account_id]:instance/[instance_id]/agent/[agent_id]"
  }
}
```

### UpdateRelatedItem Response example
<a name="API_connect-cases_UpdateRelatedItem_Example_4"></a>

All successful UpdateRelatedItem requests return the updated related item: 

```
{
  "relatedItemArn": "arn:aws:cases:us-west-2:[account_id]:domain/[domain_id]/case/[case_id]/related-item/[related_item_id]",
  "relatedItemId": "[related_item_id]",
  "type": "Comment",
  "content": {
    "comment": {
      "body": "Updated comment text with additional details",
      "contentType": "Text/Plain"
    }
  },
  "associationTime": "2024-11-22T01:35:46.329Z",
  "lastUpdatedUser": {
    "userArn": "arn:aws:connect:us-west-2:[account_id]:instance/[instance_id]/agent/[agent_id]"
  },
  "createdBy": {
    "userArn": "arn:aws:connect:us-west-2:[account_id]:instance/[instance_id]/agent/[agent_id]"
  }
}
```

## See Also
<a name="API_connect-cases_UpdateRelatedItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/UpdateRelatedItem) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/UpdateRelatedItem) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/UpdateRelatedItem) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/UpdateRelatedItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/UpdateRelatedItem) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/UpdateRelatedItem) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/UpdateRelatedItem) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/UpdateRelatedItem) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/UpdateRelatedItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/UpdateRelatedItem) 

# UpdateTemplate
<a name="API_connect-cases_UpdateTemplate"></a>

Updates the attributes of an existing template. The template attributes that can be modified include `name`, `description`, `layoutConfiguration`, `requiredFields`, and `status`. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved.

Other template APIs are:
+  [CreateTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateTemplate.html) 
+  [DeleteTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html) 
+  [GetTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html) 
+  [ListTemplates](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html) 

## Request Syntax
<a name="API_connect-cases_UpdateTemplate_RequestSyntax"></a>

```
PUT /domains/domainId/templates/templateId HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "layoutConfiguration": { 
      "defaultLayout": "string"
   },
   "name": "string",
   "requiredFields": [ 
      { 
         "fieldId": "string"
      }
   ],
   "rules": [ 
      { 
         "caseRuleId": "string",
         "fieldId": "string"
      }
   ],
   "status": "string",
   "tagPropagationConfigurations": [ 
      { 
         "resourceType": "string",
         "tagMap": { 
            "string" : "string" 
         }
      }
   ]
}
```

## URI Request Parameters
<a name="API_connect-cases_UpdateTemplate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [domainId](#API_connect-cases_UpdateTemplate_RequestSyntax) **   <a name="connect-connect-cases_UpdateTemplate-request-uri-domainId"></a>
The unique identifier of the Cases domain.   
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [templateId](#API_connect-cases_UpdateTemplate_RequestSyntax) **   <a name="connect-connect-cases_UpdateTemplate-request-uri-templateId"></a>
A unique identifier for the template.  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Request Body
<a name="API_connect-cases_UpdateTemplate_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_connect-cases_UpdateTemplate_RequestSyntax) **   <a name="connect-connect-cases_UpdateTemplate-request-description"></a>
A brief description of the template.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [layoutConfiguration](#API_connect-cases_UpdateTemplate_RequestSyntax) **   <a name="connect-connect-cases_UpdateTemplate-request-layoutConfiguration"></a>
Configuration of layouts associated to the template.  
Type: [LayoutConfiguration](API_connect-cases_LayoutConfiguration.md) object  
Required: No

 ** [name](#API_connect-cases_UpdateTemplate_RequestSyntax) **   <a name="connect-connect-cases_UpdateTemplate-request-name"></a>
The name of the template. It must be unique per domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*[\S]`   
Required: No

 ** [requiredFields](#API_connect-cases_UpdateTemplate_RequestSyntax) **   <a name="connect-connect-cases_UpdateTemplate-request-requiredFields"></a>
A list of fields that must contain a value for a case to be successfully created with this template.  
Type: Array of [RequiredField](API_connect-cases_RequiredField.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.  
Required: No

 ** [rules](#API_connect-cases_UpdateTemplate_RequestSyntax) **   <a name="connect-connect-cases_UpdateTemplate-request-rules"></a>
A list of case rules (also known as [case field conditions](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html)) on a template.  
Type: Array of [TemplateRule](API_connect-cases_TemplateRule.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: No

 ** [status](#API_connect-cases_UpdateTemplate_RequestSyntax) **   <a name="connect-connect-cases_UpdateTemplate-request-status"></a>
The status of the template.  
Type: String  
Valid Values: `Active | Inactive`   
Required: No

 ** [tagPropagationConfigurations](#API_connect-cases_UpdateTemplate_RequestSyntax) **   <a name="connect-connect-cases_UpdateTemplate-request-tagPropagationConfigurations"></a>
Defines tag propagation configuration for resources created within a domain. Tags specified here will be automatically applied to resources being created for the specified resource type.  
Type: Array of [TagPropagationConfiguration](API_connect-cases_TagPropagationConfiguration.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Required: No

## Response Syntax
<a name="API_connect-cases_UpdateTemplate_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-cases_UpdateTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-cases_UpdateTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.  
HTTP Status Code: 409

 ** InternalServerException **   
We couldn't process your request because of an issue with the server. Try again later.    
 ** retryAfterSeconds **   
Advice to clients on when the call can be safely retried.
HTTP Status Code: 500

 ** ResourceNotFoundException **   
We couldn't find the requested resource. Check that your resources exists and were created in the same AWS Region as your request, and try your request again.    
 ** resourceId **   
Unique identifier of the resource affected.  
 ** resourceType **   
Type of the resource affected.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
The service quota has been exceeded. For a list of service quotas, see [Amazon Connect Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html) in the *Amazon Connect Administrator Guide*.  
HTTP Status Code: 402

 ** ThrottlingException **   
The rate has been exceeded for this API. Please try again after a few minutes.  
HTTP Status Code: 429

 ** ValidationException **   
The request isn't valid. Check the syntax and try again.  
HTTP Status Code: 400

## Examples
<a name="API_connect-cases_UpdateTemplate_Examples"></a>

### Request and Response example
<a name="API_connect-cases_UpdateTemplate_Example_1"></a>

This example illustrates one usage of UpdateTemplate.

```
{
  "name": "updated_template_name",
  "tagPropagationConfigurations": [
    {
      "resourceType": "Cases",
      "tagMap": {
        "Department" : "UpdatedShipping"
      }
    }
  ]
}
```

```
{ }
```

## See Also
<a name="API_connect-cases_UpdateTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectcases-2022-10-03/UpdateTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectcases-2022-10-03/UpdateTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectcases-2022-10-03/UpdateTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectcases-2022-10-03/UpdateTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectcases-2022-10-03/UpdateTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectcases-2022-10-03/UpdateTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectcases-2022-10-03/UpdateTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectcases-2022-10-03/UpdateTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectcases-2022-10-03/UpdateTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectcases-2022-10-03/UpdateTemplate) 

# Amazon Connect Participant Service
<a name="API_Operations_Amazon_Connect_Participant_Service"></a>

The following actions are supported by Amazon Connect Participant Service:
+  [CancelParticipantAuthentication](API_connect-participant_CancelParticipantAuthentication.md) 
+  [CompleteAttachmentUpload](API_connect-participant_CompleteAttachmentUpload.md) 
+  [CreateParticipantConnection](API_connect-participant_CreateParticipantConnection.md) 
+  [DescribeView](API_connect-participant_DescribeView.md) 
+  [DisconnectParticipant](API_connect-participant_DisconnectParticipant.md) 
+  [GetAttachment](API_connect-participant_GetAttachment.md) 
+  [GetAuthenticationUrl](API_connect-participant_GetAuthenticationUrl.md) 
+  [GetTranscript](API_connect-participant_GetTranscript.md) 
+  [SendEvent](API_connect-participant_SendEvent.md) 
+  [SendMessage](API_connect-participant_SendMessage.md) 
+  [StartAttachmentUpload](API_connect-participant_StartAttachmentUpload.md) 

# CancelParticipantAuthentication
<a name="API_connect-participant_CancelParticipantAuthentication"></a>

Cancels the authentication session. The opted out branch of the Authenticate Customer flow block will be taken.

**Note**  
The current supported channel is chat. This API is not supported for Apple Messages for Business, WhatsApp, or SMS chats.

**Note**  
 `ConnectionToken` is used for invoking this API instead of `ParticipantToken`.

The Amazon Connect Participant Service APIs do not use [Signature Version 4 authentication](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

## Request Syntax
<a name="API_connect-participant_CancelParticipantAuthentication_RequestSyntax"></a>

```
POST /participant/cancel-authentication HTTP/1.1
X-Amz-Bearer: ConnectionToken
Content-type: application/json

{
   "SessionId": "string"
}
```

## URI Request Parameters
<a name="API_connect-participant_CancelParticipantAuthentication_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ConnectionToken](#API_connect-participant_CancelParticipantAuthentication_RequestSyntax) **   <a name="connect-connect-participant_CancelParticipantAuthentication-request-ConnectionToken"></a>
The authentication token associated with the participant's connection.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

## Request Body
<a name="API_connect-participant_CancelParticipantAuthentication_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [SessionId](#API_connect-participant_CancelParticipantAuthentication_RequestSyntax) **   <a name="connect-connect-participant_CancelParticipantAuthentication-request-SessionId"></a>
The `sessionId` provided in the `authenticationInitiated` event.  
Type: String  
Length Constraints: Fixed length of 36.  
Required: Yes

## Response Syntax
<a name="API_connect-participant_CancelParticipantAuthentication_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-participant_CancelParticipantAuthentication_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-participant_CancelParticipantAuthentication_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the Amazon Connect service.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by Amazon Connect.  
HTTP Status Code: 400

## See Also
<a name="API_connect-participant_CancelParticipantAuthentication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectparticipant-2018-09-07/CancelParticipantAuthentication) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectparticipant-2018-09-07/CancelParticipantAuthentication) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectparticipant-2018-09-07/CancelParticipantAuthentication) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectparticipant-2018-09-07/CancelParticipantAuthentication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectparticipant-2018-09-07/CancelParticipantAuthentication) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectparticipant-2018-09-07/CancelParticipantAuthentication) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectparticipant-2018-09-07/CancelParticipantAuthentication) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectparticipant-2018-09-07/CancelParticipantAuthentication) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectparticipant-2018-09-07/CancelParticipantAuthentication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectparticipant-2018-09-07/CancelParticipantAuthentication) 

# CompleteAttachmentUpload
<a name="API_connect-participant_CompleteAttachmentUpload"></a>

Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API. A conflict exception is thrown when an attachment with that identifier is already being uploaded.

For security recommendations, see [Amazon Connect Chat security best practices](https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat). 

**Note**  
 `ConnectionToken` is used for invoking this API instead of `ParticipantToken`.

The Amazon Connect Participant Service APIs do not use [Signature Version 4 authentication](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

## Request Syntax
<a name="API_connect-participant_CompleteAttachmentUpload_RequestSyntax"></a>

```
POST /participant/complete-attachment-upload HTTP/1.1
X-Amz-Bearer: ConnectionToken
Content-type: application/json

{
   "AttachmentIds": [ "string" ],
   "ClientToken": "string"
}
```

## URI Request Parameters
<a name="API_connect-participant_CompleteAttachmentUpload_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ConnectionToken](#API_connect-participant_CompleteAttachmentUpload_RequestSyntax) **   <a name="connect-connect-participant_CompleteAttachmentUpload-request-ConnectionToken"></a>
The authentication token associated with the participant's connection.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

## Request Body
<a name="API_connect-participant_CompleteAttachmentUpload_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AttachmentIds](#API_connect-participant_CompleteAttachmentUpload_RequestSyntax) **   <a name="connect-connect-participant_CompleteAttachmentUpload-request-AttachmentIds"></a>
A list of unique identifiers for the attachments.  
Type: Array of strings  
Array Members: Fixed number of 1 item.  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [ClientToken](#API_connect-participant_CompleteAttachmentUpload_RequestSyntax) **   <a name="connect-connect-participant_CompleteAttachmentUpload-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

## Response Syntax
<a name="API_connect-participant_CompleteAttachmentUpload_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-participant_CompleteAttachmentUpload_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-participant_CompleteAttachmentUpload_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation conflicts with the current state of a service resource associated with the request.   
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the Amazon Connect service.  
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
The number of attachments per contact exceeds the quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by Amazon Connect.  
HTTP Status Code: 400

## See Also
<a name="API_connect-participant_CompleteAttachmentUpload_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectparticipant-2018-09-07/CompleteAttachmentUpload) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectparticipant-2018-09-07/CompleteAttachmentUpload) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectparticipant-2018-09-07/CompleteAttachmentUpload) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectparticipant-2018-09-07/CompleteAttachmentUpload) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectparticipant-2018-09-07/CompleteAttachmentUpload) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectparticipant-2018-09-07/CompleteAttachmentUpload) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectparticipant-2018-09-07/CompleteAttachmentUpload) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectparticipant-2018-09-07/CompleteAttachmentUpload) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectparticipant-2018-09-07/CompleteAttachmentUpload) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectparticipant-2018-09-07/CompleteAttachmentUpload) 

# CreateParticipantConnection
<a name="API_connect-participant_CreateParticipantConnection"></a>

Creates the participant's connection. 

For security recommendations, see [Amazon Connect Chat security best practices](https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat). 

For WebRTC security recommendations, see [Amazon Connect WebRTC security best practices](https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-webrtc-security). 

**Note**  
 `ParticipantToken` is used for invoking this API instead of `ConnectionToken`.

The participant token is valid for the lifetime of the participant – until they are part of a contact. For WebRTC participants, if they leave or are disconnected for 60 seconds, a new participant needs to be created using the [CreateParticipant](https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateParticipant.html) API. 

 **For `WEBSOCKET` Type**: 

The response URL for has a connect expiry timeout of 100s. Clients must manually connect to the returned websocket URL and subscribe to the desired topic. 

For chat, you need to publish the following on the established websocket connection:

 `{"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}` 

Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before.

The expiry time for the connection token is different than the `ChatDurationInMinutes`. Expiry time for the connection token is 1 day.

 **For `WEBRTC_CONNECTION` Type**: 

The response includes connection data required for the client application to join the call using the Amazon Chime SDK client libraries. The WebRTCConnection response contains Meeting and Attendee information needed to establish the media connection. 

The attendee join token in WebRTCConnection response is valid for the lifetime of the participant in the call. If a participant leaves or is disconnected for 60 seconds, their participant credentials will no longer be valid, and a new participant will need to be created to rejoin the call. 

 **Message streaming support**: This API can also be used together with the [StartContactStreaming](https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html) API to create a participant connection for chat contacts that are not using a websocket. For more information about message streaming, [Enable real-time chat message streaming](https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html) in the *Amazon Connect Administrator Guide*.

 **Multi-user web, in-app, video calling support**: 

For WebRTC calls, this API is used in conjunction with the CreateParticipant API to enable multi-party calling. The StartWebRTCContact API creates the initial contact and routes it to an agent, while CreateParticipant adds additional participants to the ongoing call. For more information about multi-party WebRTC calls, see [Enable multi-user web, in-app, and video calling](https://docs.aws.amazon.com/connect/latest/adminguide/enable-multiuser-inapp.html) in the *Amazon Connect Administrator Guide*. 

 **Feature specifications**: For information about feature specifications, such as the allowed number of open websocket connections per participant or maximum number of WebRTC participants, see [Feature specifications](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits) in the *Amazon Connect Administrator Guide*. 

**Note**  
The Amazon Connect Participant Service APIs do not use [Signature Version 4 authentication](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

## Request Syntax
<a name="API_connect-participant_CreateParticipantConnection_RequestSyntax"></a>

```
POST /participant/connection HTTP/1.1
X-Amz-Bearer: ParticipantToken
Content-type: application/json

{
   "ConnectParticipant": boolean,
   "Type": [ "string" ]
}
```

## URI Request Parameters
<a name="API_connect-participant_CreateParticipantConnection_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ParticipantToken](#API_connect-participant_CreateParticipantConnection_RequestSyntax) **   <a name="connect-connect-participant_CreateParticipantConnection-request-ParticipantToken"></a>
This is a header parameter.  
The ParticipantToken as obtained from [StartChatContact](https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html) API response.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

## Request Body
<a name="API_connect-participant_CreateParticipantConnection_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ConnectParticipant](#API_connect-participant_CreateParticipantConnection_RequestSyntax) **   <a name="connect-connect-participant_CreateParticipantConnection-request-ConnectParticipant"></a>
Amazon Connect Participant is used to mark the participant as connected for customer participant in message streaming, as well as for agent or manager participant in non-streaming chats.  
Type: Boolean  
Required: No

 ** [Type](#API_connect-participant_CreateParticipantConnection_RequestSyntax) **   <a name="connect-connect-participant_CreateParticipantConnection-request-Type"></a>
Type of connection information required. If you need `CONNECTION_CREDENTIALS` along with marking participant as connected, pass `CONNECTION_CREDENTIALS` in `Type`.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Valid Values: `WEBSOCKET | CONNECTION_CREDENTIALS | WEBRTC_CONNECTION`   
Required: No

## Response Syntax
<a name="API_connect-participant_CreateParticipantConnection_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ConnectionCredentials": { 
      "ConnectionToken": "string",
      "Expiry": "string"
   },
   "WebRTCConnection": { 
      "Attendee": { 
         "AttendeeId": "string",
         "JoinToken": "string"
      },
      "Meeting": { 
         "MediaPlacement": { 
            "AudioFallbackUrl": "string",
            "AudioHostUrl": "string",
            "EventIngestionUrl": "string",
            "SignalingUrl": "string"
         },
         "MeetingFeatures": { 
            "Audio": { 
               "EchoReduction": "string"
            }
         },
         "MeetingId": "string"
      }
   },
   "Websocket": { 
      "ConnectionExpiry": "string",
      "Url": "string"
   }
}
```

## Response Elements
<a name="API_connect-participant_CreateParticipantConnection_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ConnectionCredentials](#API_connect-participant_CreateParticipantConnection_ResponseSyntax) **   <a name="connect-connect-participant_CreateParticipantConnection-response-ConnectionCredentials"></a>
Creates the participant's connection credentials. The authentication token associated with the participant's connection.  
Type: [ConnectionCredentials](API_connect-participant_ConnectionCredentials.md) object

 ** [WebRTCConnection](#API_connect-participant_CreateParticipantConnection_ResponseSyntax) **   <a name="connect-connect-participant_CreateParticipantConnection-response-WebRTCConnection"></a>
Creates the participant's WebRTC connection data required for the client application (mobile application or website) to connect to the call.   
Type: [WebRTCConnection](API_connect-participant_WebRTCConnection.md) object

 ** [Websocket](#API_connect-participant_CreateParticipantConnection_ResponseSyntax) **   <a name="connect-connect-participant_CreateParticipantConnection-response-Websocket"></a>
Creates the participant's websocket connection.  
Type: [Websocket](API_connect-participant_Websocket.md) object

## Errors
<a name="API_connect-participant_CreateParticipantConnection_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the Amazon Connect service.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by Amazon Connect.  
HTTP Status Code: 400

## See Also
<a name="API_connect-participant_CreateParticipantConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectparticipant-2018-09-07/CreateParticipantConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectparticipant-2018-09-07/CreateParticipantConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectparticipant-2018-09-07/CreateParticipantConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectparticipant-2018-09-07/CreateParticipantConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectparticipant-2018-09-07/CreateParticipantConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectparticipant-2018-09-07/CreateParticipantConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectparticipant-2018-09-07/CreateParticipantConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectparticipant-2018-09-07/CreateParticipantConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectparticipant-2018-09-07/CreateParticipantConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectparticipant-2018-09-07/CreateParticipantConnection) 

# DescribeView
<a name="API_connect-participant_DescribeView"></a>

Retrieves the view for the specified view token.

For security recommendations, see [Amazon Connect Chat security best practices](https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat). 

## Request Syntax
<a name="API_connect-participant_DescribeView_RequestSyntax"></a>

```
GET /participant/views/ViewToken HTTP/1.1
X-Amz-Bearer: ConnectionToken
```

## URI Request Parameters
<a name="API_connect-participant_DescribeView_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ConnectionToken](#API_connect-participant_DescribeView_RequestSyntax) **   <a name="connect-connect-participant_DescribeView-request-ConnectionToken"></a>
The connection token.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

 ** [ViewToken](#API_connect-participant_DescribeView_RequestSyntax) **   <a name="connect-connect-participant_DescribeView-request-uri-ViewToken"></a>
An encrypted token originating from the interactive message of a ShowView block operation. Represents the desired view.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

## Request Body
<a name="API_connect-participant_DescribeView_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-participant_DescribeView_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "View": { 
      "Arn": "string",
      "Content": { 
         "Actions": [ "string" ],
         "InputSchema": "string",
         "Template": "string"
      },
      "Id": "string",
      "Name": "string",
      "Version": number
   }
}
```

## Response Elements
<a name="API_connect-participant_DescribeView_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [View](#API_connect-participant_DescribeView_ResponseSyntax) **   <a name="connect-connect-participant_DescribeView-response-View"></a>
A view resource object. Contains metadata and content necessary to render the view.  
Type: [View](API_connect-participant_View.md) object

## Errors
<a name="API_connect-participant_DescribeView_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the Amazon Connect service.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource was not found.    
 ** ResourceId **   
The identifier of the resource.  
 ** ResourceType **   
The type of Amazon Connect resource.
HTTP Status Code: 404

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by Amazon Connect.  
HTTP Status Code: 400

## See Also
<a name="API_connect-participant_DescribeView_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectparticipant-2018-09-07/DescribeView) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectparticipant-2018-09-07/DescribeView) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectparticipant-2018-09-07/DescribeView) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectparticipant-2018-09-07/DescribeView) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectparticipant-2018-09-07/DescribeView) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectparticipant-2018-09-07/DescribeView) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectparticipant-2018-09-07/DescribeView) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectparticipant-2018-09-07/DescribeView) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectparticipant-2018-09-07/DescribeView) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectparticipant-2018-09-07/DescribeView) 

# DisconnectParticipant
<a name="API_connect-participant_DisconnectParticipant"></a>

Disconnects a participant. 

For security recommendations, see [Amazon Connect Chat security best practices](https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat). 

**Note**  
 `ConnectionToken` is used for invoking this API instead of `ParticipantToken`.

The Amazon Connect Participant Service APIs do not use [Signature Version 4 authentication](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

## Request Syntax
<a name="API_connect-participant_DisconnectParticipant_RequestSyntax"></a>

```
POST /participant/disconnect HTTP/1.1
X-Amz-Bearer: ConnectionToken
Content-type: application/json

{
   "ClientToken": "string"
}
```

## URI Request Parameters
<a name="API_connect-participant_DisconnectParticipant_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ConnectionToken](#API_connect-participant_DisconnectParticipant_RequestSyntax) **   <a name="connect-connect-participant_DisconnectParticipant-request-ConnectionToken"></a>
The authentication token associated with the participant's connection.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

## Request Body
<a name="API_connect-participant_DisconnectParticipant_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_connect-participant_DisconnectParticipant_RequestSyntax) **   <a name="connect-connect-participant_DisconnectParticipant-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

## Response Syntax
<a name="API_connect-participant_DisconnectParticipant_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-participant_DisconnectParticipant_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-participant_DisconnectParticipant_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the Amazon Connect service.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by Amazon Connect.  
HTTP Status Code: 400

## See Also
<a name="API_connect-participant_DisconnectParticipant_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectparticipant-2018-09-07/DisconnectParticipant) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectparticipant-2018-09-07/DisconnectParticipant) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectparticipant-2018-09-07/DisconnectParticipant) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectparticipant-2018-09-07/DisconnectParticipant) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectparticipant-2018-09-07/DisconnectParticipant) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectparticipant-2018-09-07/DisconnectParticipant) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectparticipant-2018-09-07/DisconnectParticipant) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectparticipant-2018-09-07/DisconnectParticipant) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectparticipant-2018-09-07/DisconnectParticipant) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectparticipant-2018-09-07/DisconnectParticipant) 

# GetAttachment
<a name="API_connect-participant_GetAttachment"></a>

Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.

For security recommendations, see [Amazon Connect Chat security best practices](https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat). 

**Note**  
The participant role `CUSTOM_BOT` is not permitted to access attachments customers may upload. An `AccessDeniedException` can indicate that the participant may be a CUSTOM\$1BOT, and it doesn't have access to attachments.
 `ConnectionToken` is used for invoking this API instead of `ParticipantToken`.

The Amazon Connect Participant Service APIs do not use [Signature Version 4 authentication](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

## Request Syntax
<a name="API_connect-participant_GetAttachment_RequestSyntax"></a>

```
POST /participant/attachment HTTP/1.1
X-Amz-Bearer: ConnectionToken
Content-type: application/json

{
   "AttachmentId": "string",
   "UrlExpiryInSeconds": number
}
```

## URI Request Parameters
<a name="API_connect-participant_GetAttachment_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ConnectionToken](#API_connect-participant_GetAttachment_RequestSyntax) **   <a name="connect-connect-participant_GetAttachment-request-ConnectionToken"></a>
The authentication token associated with the participant's connection.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

## Request Body
<a name="API_connect-participant_GetAttachment_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AttachmentId](#API_connect-participant_GetAttachment_RequestSyntax) **   <a name="connect-connect-participant_GetAttachment-request-AttachmentId"></a>
A unique identifier for the attachment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [UrlExpiryInSeconds](#API_connect-participant_GetAttachment_RequestSyntax) **   <a name="connect-connect-participant_GetAttachment-request-UrlExpiryInSeconds"></a>
The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.  
Type: Integer  
Valid Range: Minimum value of 5. Maximum value of 300.  
Required: No

## Response Syntax
<a name="API_connect-participant_GetAttachment_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AttachmentSizeInBytes": number,
   "Url": "string",
   "UrlExpiry": "string"
}
```

## Response Elements
<a name="API_connect-participant_GetAttachment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AttachmentSizeInBytes](#API_connect-participant_GetAttachment_ResponseSyntax) **   <a name="connect-connect-participant_GetAttachment-response-AttachmentSizeInBytes"></a>
The size of the attachment in bytes.  
Type: Long  
Valid Range: Minimum value of 1.

 ** [Url](#API_connect-participant_GetAttachment_ResponseSyntax) **   <a name="connect-connect-participant_GetAttachment-response-Url"></a>
This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response to [StartAttachmentUpload](https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_StartAttachmentUpload.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000.

 ** [UrlExpiry](#API_connect-participant_GetAttachment_ResponseSyntax) **   <a name="connect-connect-participant_GetAttachment-response-UrlExpiry"></a>
The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.  
Type: String

## Errors
<a name="API_connect-participant_GetAttachment_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the Amazon Connect service.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by Amazon Connect.  
HTTP Status Code: 400

## See Also
<a name="API_connect-participant_GetAttachment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectparticipant-2018-09-07/GetAttachment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectparticipant-2018-09-07/GetAttachment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectparticipant-2018-09-07/GetAttachment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectparticipant-2018-09-07/GetAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectparticipant-2018-09-07/GetAttachment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectparticipant-2018-09-07/GetAttachment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectparticipant-2018-09-07/GetAttachment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectparticipant-2018-09-07/GetAttachment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectparticipant-2018-09-07/GetAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectparticipant-2018-09-07/GetAttachment) 

# GetAuthenticationUrl
<a name="API_connect-participant_GetAuthenticationUrl"></a>

Retrieves the AuthenticationUrl for the current authentication session for the AuthenticateCustomer flow block. 

For security recommendations, see [Amazon Connect Chat security best practices](https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat).

**Note**  
This API can only be called within one minute of receiving the authenticationInitiated event.
The current supported channel is chat. This API is not supported for Apple Messages for Business, WhatsApp, or SMS chats.

**Note**  
 `ConnectionToken` is used for invoking this API instead of `ParticipantToken`.

The Amazon Connect Participant Service APIs do not use [Signature Version 4 authentication](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

## Request Syntax
<a name="API_connect-participant_GetAuthenticationUrl_RequestSyntax"></a>

```
POST /participant/authentication-url HTTP/1.1
X-Amz-Bearer: ConnectionToken
Content-type: application/json

{
   "RedirectUri": "string",
   "SessionId": "string"
}
```

## URI Request Parameters
<a name="API_connect-participant_GetAuthenticationUrl_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ConnectionToken](#API_connect-participant_GetAuthenticationUrl_RequestSyntax) **   <a name="connect-connect-participant_GetAuthenticationUrl-request-ConnectionToken"></a>
The authentication token associated with the participant's connection.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

## Request Body
<a name="API_connect-participant_GetAuthenticationUrl_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [RedirectUri](#API_connect-participant_GetAuthenticationUrl_RequestSyntax) **   <a name="connect-connect-participant_GetAuthenticationUrl-request-RedirectUri"></a>
The URL where the customer will be redirected after Amazon Cognito authorizes the user.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** [SessionId](#API_connect-participant_GetAuthenticationUrl_RequestSyntax) **   <a name="connect-connect-participant_GetAuthenticationUrl-request-SessionId"></a>
The sessionId provided in the authenticationInitiated event.  
Type: String  
Length Constraints: Fixed length of 36.  
Required: Yes

## Response Syntax
<a name="API_connect-participant_GetAuthenticationUrl_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AuthenticationUrl": "string"
}
```

## Response Elements
<a name="API_connect-participant_GetAuthenticationUrl_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AuthenticationUrl](#API_connect-participant_GetAuthenticationUrl_ResponseSyntax) **   <a name="connect-connect-participant_GetAuthenticationUrl-response-AuthenticationUrl"></a>
The URL where the customer will sign in to the identity provider. This URL contains the authorize endpoint for the Cognito UserPool used in the authentication.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2083.

## Errors
<a name="API_connect-participant_GetAuthenticationUrl_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the Amazon Connect service.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by Amazon Connect.  
HTTP Status Code: 400

## See Also
<a name="API_connect-participant_GetAuthenticationUrl_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectparticipant-2018-09-07/GetAuthenticationUrl) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectparticipant-2018-09-07/GetAuthenticationUrl) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectparticipant-2018-09-07/GetAuthenticationUrl) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectparticipant-2018-09-07/GetAuthenticationUrl) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectparticipant-2018-09-07/GetAuthenticationUrl) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectparticipant-2018-09-07/GetAuthenticationUrl) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectparticipant-2018-09-07/GetAuthenticationUrl) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectparticipant-2018-09-07/GetAuthenticationUrl) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectparticipant-2018-09-07/GetAuthenticationUrl) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectparticipant-2018-09-07/GetAuthenticationUrl) 

# GetTranscript
<a name="API_connect-participant_GetTranscript"></a>

Retrieves a transcript of the session, including details about any attachments. For information about accessing past chat contact transcripts for a persistent chat, see [Enable persistent chat](https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html). 

For security recommendations, see [Amazon Connect Chat security best practices](https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat). 

If you have a process that consumes events in the transcript of an chat that has ended, note that chat transcripts contain the following event content types if the event has occurred during the chat session:
+  `application/vnd.amazonaws.connect.event.participant.invited` 
+  `application/vnd.amazonaws.connect.event.participant.joined` 
+  `application/vnd.amazonaws.connect.event.participant.left` 
+  `application/vnd.amazonaws.connect.event.chat.ended` 
+  `application/vnd.amazonaws.connect.event.transfer.succeeded` 
+  `application/vnd.amazonaws.connect.event.transfer.failed` 

**Note**  
 `ConnectionToken` is used for invoking this API instead of `ParticipantToken`.

The Amazon Connect Participant Service APIs do not use [Signature Version 4 authentication](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

## Request Syntax
<a name="API_connect-participant_GetTranscript_RequestSyntax"></a>

```
POST /participant/transcript HTTP/1.1
X-Amz-Bearer: ConnectionToken
Content-type: application/json

{
   "ContactId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "ScanDirection": "string",
   "SortOrder": "string",
   "StartPosition": { 
      "AbsoluteTime": "string",
      "Id": "string",
      "MostRecent": number
   }
}
```

## URI Request Parameters
<a name="API_connect-participant_GetTranscript_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ConnectionToken](#API_connect-participant_GetTranscript_RequestSyntax) **   <a name="connect-connect-participant_GetTranscript-request-ConnectionToken"></a>
The authentication token associated with the participant's connection.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

## Request Body
<a name="API_connect-participant_GetTranscript_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ContactId](#API_connect-participant_GetTranscript_RequestSyntax) **   <a name="connect-connect-participant_GetTranscript-request-ContactId"></a>
The contactId from the current contact chain for which transcript is needed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [MaxResults](#API_connect-participant_GetTranscript_RequestSyntax) **   <a name="connect-connect-participant_GetTranscript-request-MaxResults"></a>
The maximum number of results to return in the page. Default: 10.   
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 100.  
Required: No

 ** [NextToken](#API_connect-participant_GetTranscript_RequestSyntax) **   <a name="connect-connect-participant_GetTranscript-request-NextToken"></a>
The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: No

 ** [ScanDirection](#API_connect-participant_GetTranscript_RequestSyntax) **   <a name="connect-connect-participant_GetTranscript-request-ScanDirection"></a>
The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.   
Type: String  
Valid Values: `FORWARD | BACKWARD`   
Required: No

 ** [SortOrder](#API_connect-participant_GetTranscript_RequestSyntax) **   <a name="connect-connect-participant_GetTranscript-request-SortOrder"></a>
The sort order for the records. Default: DESCENDING.  
Type: String  
Valid Values: `DESCENDING | ASCENDING`   
Required: No

 ** [StartPosition](#API_connect-participant_GetTranscript_RequestSyntax) **   <a name="connect-connect-participant_GetTranscript-request-StartPosition"></a>
A filtering option for where to start.  
Type: [StartPosition](API_connect-participant_StartPosition.md) object  
Required: No

## Response Syntax
<a name="API_connect-participant_GetTranscript_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "InitialContactId": "string",
   "NextToken": "string",
   "Transcript": [ 
      { 
         "AbsoluteTime": "string",
         "Attachments": [ 
            { 
               "AttachmentId": "string",
               "AttachmentName": "string",
               "ContentType": "string",
               "Status": "string"
            }
         ],
         "ContactId": "string",
         "Content": "string",
         "ContentType": "string",
         "DisplayName": "string",
         "Id": "string",
         "MessageMetadata": { 
            "MessageId": "string",
            "MessageProcessingStatus": "string",
            "Receipts": [ 
               { 
                  "DeliveredTimestamp": "string",
                  "ReadTimestamp": "string",
                  "RecipientParticipantId": "string"
               }
            ]
         },
         "ParticipantId": "string",
         "ParticipantRole": "string",
         "RelatedContactId": "string",
         "Type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-participant_GetTranscript_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [InitialContactId](#API_connect-participant_GetTranscript_ResponseSyntax) **   <a name="connect-connect-participant_GetTranscript-response-InitialContactId"></a>
The initial contact ID for the contact.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [NextToken](#API_connect-participant_GetTranscript_ResponseSyntax) **   <a name="connect-connect-participant_GetTranscript-response-NextToken"></a>
The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.

 ** [Transcript](#API_connect-participant_GetTranscript_ResponseSyntax) **   <a name="connect-connect-participant_GetTranscript-response-Transcript"></a>
The list of messages in the session.  
Type: Array of [Item](API_connect-participant_Item.md) objects

## Errors
<a name="API_connect-participant_GetTranscript_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the Amazon Connect service.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by Amazon Connect.  
HTTP Status Code: 400

## See Also
<a name="API_connect-participant_GetTranscript_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectparticipant-2018-09-07/GetTranscript) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectparticipant-2018-09-07/GetTranscript) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectparticipant-2018-09-07/GetTranscript) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectparticipant-2018-09-07/GetTranscript) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectparticipant-2018-09-07/GetTranscript) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectparticipant-2018-09-07/GetTranscript) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectparticipant-2018-09-07/GetTranscript) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectparticipant-2018-09-07/GetTranscript) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectparticipant-2018-09-07/GetTranscript) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectparticipant-2018-09-07/GetTranscript) 

# SendEvent
<a name="API_connect-participant_SendEvent"></a>

**Note**  
The `application/vnd.amazonaws.connect.event.connection.acknowledged` ContentType is no longer maintained since December 31, 2024. This event has been migrated to the [CreateParticipantConnection](https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html) API using the `ConnectParticipant` field.

Sends an event. Message receipts are not supported when there are more than two active participants in the chat. Using the SendEvent API for message receipts when a supervisor is barged-in will result in a conflict exception.

For security recommendations, see [Amazon Connect Chat security best practices](https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat). 

**Note**  
 `ConnectionToken` is used for invoking this API instead of `ParticipantToken`.

The Amazon Connect Participant Service APIs do not use [Signature Version 4 authentication](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

## Request Syntax
<a name="API_connect-participant_SendEvent_RequestSyntax"></a>

```
POST /participant/event HTTP/1.1
X-Amz-Bearer: ConnectionToken
Content-type: application/json

{
   "ClientToken": "string",
   "Content": "string",
   "ContentType": "string"
}
```

## URI Request Parameters
<a name="API_connect-participant_SendEvent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ConnectionToken](#API_connect-participant_SendEvent_RequestSyntax) **   <a name="connect-connect-participant_SendEvent-request-ConnectionToken"></a>
The authentication token associated with the participant's connection.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

## Request Body
<a name="API_connect-participant_SendEvent_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_connect-participant_SendEvent_RequestSyntax) **   <a name="connect-connect-participant_SendEvent-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [Content](#API_connect-participant_SendEvent_RequestSyntax) **   <a name="connect-connect-participant_SendEvent-request-Content"></a>
The content of the event to be sent (for example, message text). For content related to message receipts, this is supported in the form of a JSON string.  
Sample Content: "\$1\$1"messageId\$1":\$1"11111111-aaaa-bbbb-cccc-EXAMPLE01234\$1"\$1"  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 16384.  
Required: No

 ** [ContentType](#API_connect-participant_SendEvent_RequestSyntax) **   <a name="connect-connect-participant_SendEvent-request-ContentType"></a>
The content type of the request. Supported types are:  
+ application/vnd.amazonaws.connect.event.typing
+ application/vnd.amazonaws.connect.event.connection.acknowledged (is no longer maintained since December 31, 2024) 
+ application/vnd.amazonaws.connect.event.message.delivered
+ application/vnd.amazonaws.connect.event.message.read
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Syntax
<a name="API_connect-participant_SendEvent_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AbsoluteTime": "string",
   "Id": "string"
}
```

## Response Elements
<a name="API_connect-participant_SendEvent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AbsoluteTime](#API_connect-participant_SendEvent_ResponseSyntax) **   <a name="connect-connect-participant_SendEvent-response-AbsoluteTime"></a>
The time when the event was sent.  
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** [Id](#API_connect-participant_SendEvent_ResponseSyntax) **   <a name="connect-connect-participant_SendEvent-response-Id"></a>
The ID of the response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_connect-participant_SendEvent_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The requested operation conflicts with the current state of a service resource associated with the request.   
HTTP Status Code: 409

 ** InternalServerException **   
This exception occurs when there is an internal failure in the Amazon Connect service.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by Amazon Connect.  
HTTP Status Code: 400

## See Also
<a name="API_connect-participant_SendEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectparticipant-2018-09-07/SendEvent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectparticipant-2018-09-07/SendEvent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectparticipant-2018-09-07/SendEvent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectparticipant-2018-09-07/SendEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectparticipant-2018-09-07/SendEvent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectparticipant-2018-09-07/SendEvent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectparticipant-2018-09-07/SendEvent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectparticipant-2018-09-07/SendEvent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectparticipant-2018-09-07/SendEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectparticipant-2018-09-07/SendEvent) 

# SendMessage
<a name="API_connect-participant_SendMessage"></a>

Sends a message.

For security recommendations, see [Amazon Connect Chat security best practices](https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat). 

**Note**  
 `ConnectionToken` is used for invoking this API instead of `ParticipantToken`.

The Amazon Connect Participant Service APIs do not use [Signature Version 4 authentication](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

## Request Syntax
<a name="API_connect-participant_SendMessage_RequestSyntax"></a>

```
POST /participant/message HTTP/1.1
X-Amz-Bearer: ConnectionToken
Content-type: application/json

{
   "ClientToken": "string",
   "Content": "string",
   "ContentType": "string"
}
```

## URI Request Parameters
<a name="API_connect-participant_SendMessage_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ConnectionToken](#API_connect-participant_SendMessage_RequestSyntax) **   <a name="connect-connect-participant_SendMessage-request-ConnectionToken"></a>
The authentication token associated with the connection.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

## Request Body
<a name="API_connect-participant_SendMessage_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ClientToken](#API_connect-participant_SendMessage_RequestSyntax) **   <a name="connect-connect-participant_SendMessage-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Maximum length of 500.  
Required: No

 ** [Content](#API_connect-participant_SendMessage_RequestSyntax) **   <a name="connect-connect-participant_SendMessage-request-Content"></a>
The content of the message.   
+ For `text/plain` and `text/markdown`, the Length Constraints are Minimum of 1, Maximum of 1024. 
+ For `application/json`, the Length Constraints are Minimum of 1, Maximum of 12000. 
+ For `application/vnd.amazonaws.connect.message.interactive.response`, the Length Constraints are Minimum of 1, Maximum of 12288.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Required: Yes

 ** [ContentType](#API_connect-participant_SendMessage_RequestSyntax) **   <a name="connect-connect-participant_SendMessage-request-ContentType"></a>
The type of the content. Possible types are `text/plain`, `text/markdown`, `application/json`, and `application/vnd.amazonaws.connect.message.interactive.response`.   
Supported types on the contact are configured through `SupportedMessagingContentTypes` on [StartChatContact](https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html) and [StartOutboundChatContact](https://docs.aws.amazon.com/connect/latest/APIReference/API_StartOutboundChatContact.html).  
 For Apple Messages for Business, SMS, and WhatsApp Business Messaging contacts, only `text/plain` is supported.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

## Response Syntax
<a name="API_connect-participant_SendMessage_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AbsoluteTime": "string",
   "Id": "string",
   "MessageMetadata": { 
      "MessageProcessingStatus": "string"
   }
}
```

## Response Elements
<a name="API_connect-participant_SendMessage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AbsoluteTime](#API_connect-participant_SendMessage_ResponseSyntax) **   <a name="connect-connect-participant_SendMessage-response-AbsoluteTime"></a>
The time when the message was sent.  
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.

 ** [Id](#API_connect-participant_SendMessage_ResponseSyntax) **   <a name="connect-connect-participant_SendMessage-response-Id"></a>
The ID of the message.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [MessageMetadata](#API_connect-participant_SendMessage_ResponseSyntax) **   <a name="connect-connect-participant_SendMessage-response-MessageMetadata"></a>
Contains metadata for the message.  
Type: [MessageProcessingMetadata](API_connect-participant_MessageProcessingMetadata.md) object

## Errors
<a name="API_connect-participant_SendMessage_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the Amazon Connect service.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by Amazon Connect.  
HTTP Status Code: 400

## See Also
<a name="API_connect-participant_SendMessage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectparticipant-2018-09-07/SendMessage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectparticipant-2018-09-07/SendMessage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectparticipant-2018-09-07/SendMessage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectparticipant-2018-09-07/SendMessage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectparticipant-2018-09-07/SendMessage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectparticipant-2018-09-07/SendMessage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectparticipant-2018-09-07/SendMessage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectparticipant-2018-09-07/SendMessage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectparticipant-2018-09-07/SendMessage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectparticipant-2018-09-07/SendMessage) 

# StartAttachmentUpload
<a name="API_connect-participant_StartAttachmentUpload"></a>

Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.

For security recommendations, see [Amazon Connect Chat security best practices](https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat). 

**Note**  
 `ConnectionToken` is used for invoking this API instead of `ParticipantToken`.

The Amazon Connect Participant Service APIs do not use [Signature Version 4 authentication](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

## Request Syntax
<a name="API_connect-participant_StartAttachmentUpload_RequestSyntax"></a>

```
POST /participant/start-attachment-upload HTTP/1.1
X-Amz-Bearer: ConnectionToken
Content-type: application/json

{
   "AttachmentName": "string",
   "AttachmentSizeInBytes": number,
   "ClientToken": "string",
   "ContentType": "string"
}
```

## URI Request Parameters
<a name="API_connect-participant_StartAttachmentUpload_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ConnectionToken](#API_connect-participant_StartAttachmentUpload_RequestSyntax) **   <a name="connect-connect-participant_StartAttachmentUpload-request-ConnectionToken"></a>
The authentication token associated with the participant's connection.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

## Request Body
<a name="API_connect-participant_StartAttachmentUpload_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AttachmentName](#API_connect-participant_StartAttachmentUpload_RequestSyntax) **   <a name="connect-connect-participant_StartAttachmentUpload-request-AttachmentName"></a>
A case-sensitive name of the attachment being uploaded.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

 ** [AttachmentSizeInBytes](#API_connect-participant_StartAttachmentUpload_RequestSyntax) **   <a name="connect-connect-participant_StartAttachmentUpload-request-AttachmentSizeInBytes"></a>
The size of the attachment in bytes.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: Yes

 ** [ClientToken](#API_connect-participant_StartAttachmentUpload_RequestSyntax) **   <a name="connect-connect-participant_StartAttachmentUpload-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [ContentType](#API_connect-participant_StartAttachmentUpload_RequestSyntax) **   <a name="connect-connect-participant_StartAttachmentUpload-request-ContentType"></a>
Describes the MIME file type of the attachment. For a list of supported file types, see [Feature specifications](https://docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html) in the *Amazon Connect Administrator Guide*.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Response Syntax
<a name="API_connect-participant_StartAttachmentUpload_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AttachmentId": "string",
   "UploadMetadata": { 
      "HeadersToInclude": { 
         "string" : "string" 
      },
      "Url": "string",
      "UrlExpiry": "string"
   }
}
```

## Response Elements
<a name="API_connect-participant_StartAttachmentUpload_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AttachmentId](#API_connect-participant_StartAttachmentUpload_ResponseSyntax) **   <a name="connect-connect-participant_StartAttachmentUpload-response-AttachmentId"></a>
A unique identifier for the attachment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [UploadMetadata](#API_connect-participant_StartAttachmentUpload_ResponseSyntax) **   <a name="connect-connect-participant_StartAttachmentUpload-response-UploadMetadata"></a>
The headers to be provided while uploading the file to the URL.  
Type: [UploadMetadata](API_connect-participant_UploadMetadata.md) object

## Errors
<a name="API_connect-participant_StartAttachmentUpload_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** InternalServerException **   
This exception occurs when there is an internal failure in the Amazon Connect service.  
HTTP Status Code: 500

 ** ServiceQuotaExceededException **   
The number of attachments per contact exceeds the quota.  
HTTP Status Code: 402

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by Amazon Connect.  
HTTP Status Code: 400

## See Also
<a name="API_connect-participant_StartAttachmentUpload_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/connectparticipant-2018-09-07/StartAttachmentUpload) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/connectparticipant-2018-09-07/StartAttachmentUpload) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/connectparticipant-2018-09-07/StartAttachmentUpload) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/connectparticipant-2018-09-07/StartAttachmentUpload) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/connectparticipant-2018-09-07/StartAttachmentUpload) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/connectparticipant-2018-09-07/StartAttachmentUpload) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/connectparticipant-2018-09-07/StartAttachmentUpload) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/connectparticipant-2018-09-07/StartAttachmentUpload) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/connectparticipant-2018-09-07/StartAttachmentUpload) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/connectparticipant-2018-09-07/StartAttachmentUpload) 

# Amazon Connect Customer Profiles
<a name="API_Operations_Amazon_Connect_Customer_Profiles"></a>

The following actions are supported by Amazon Connect Customer Profiles:
+  [AddProfileKey](API_connect-customer-profiles_AddProfileKey.md) 
+  [BatchGetCalculatedAttributeForProfile](API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile.md) 
+  [BatchGetProfile](API_connect-customer-profiles_BatchGetProfile.md) 
+  [CreateCalculatedAttributeDefinition](API_connect-customer-profiles_CreateCalculatedAttributeDefinition.md) 
+  [CreateDomain](API_connect-customer-profiles_CreateDomain.md) 
+  [CreateDomainLayout](API_connect-customer-profiles_CreateDomainLayout.md) 
+  [CreateEventStream](API_connect-customer-profiles_CreateEventStream.md) 
+  [CreateEventTrigger](API_connect-customer-profiles_CreateEventTrigger.md) 
+  [CreateIntegrationWorkflow](API_connect-customer-profiles_CreateIntegrationWorkflow.md) 
+  [CreateProfile](API_connect-customer-profiles_CreateProfile.md) 
+  [CreateRecommender](API_connect-customer-profiles_CreateRecommender.md) 
+  [CreateSegmentDefinition](API_connect-customer-profiles_CreateSegmentDefinition.md) 
+  [CreateSegmentEstimate](API_connect-customer-profiles_CreateSegmentEstimate.md) 
+  [CreateSegmentSnapshot](API_connect-customer-profiles_CreateSegmentSnapshot.md) 
+  [CreateUploadJob](API_connect-customer-profiles_CreateUploadJob.md) 
+  [DeleteCalculatedAttributeDefinition](API_connect-customer-profiles_DeleteCalculatedAttributeDefinition.md) 
+  [DeleteDomain](API_connect-customer-profiles_DeleteDomain.md) 
+  [DeleteDomainLayout](API_connect-customer-profiles_DeleteDomainLayout.md) 
+  [DeleteDomainObjectType](API_connect-customer-profiles_DeleteDomainObjectType.md) 
+  [DeleteEventStream](API_connect-customer-profiles_DeleteEventStream.md) 
+  [DeleteEventTrigger](API_connect-customer-profiles_DeleteEventTrigger.md) 
+  [DeleteIntegration](API_connect-customer-profiles_DeleteIntegration.md) 
+  [DeleteProfile](API_connect-customer-profiles_DeleteProfile.md) 
+  [DeleteProfileKey](API_connect-customer-profiles_DeleteProfileKey.md) 
+  [DeleteProfileObject](API_connect-customer-profiles_DeleteProfileObject.md) 
+  [DeleteProfileObjectType](API_connect-customer-profiles_DeleteProfileObjectType.md) 
+  [DeleteRecommender](API_connect-customer-profiles_DeleteRecommender.md) 
+  [DeleteSegmentDefinition](API_connect-customer-profiles_DeleteSegmentDefinition.md) 
+  [DeleteWorkflow](API_connect-customer-profiles_DeleteWorkflow.md) 
+  [DetectProfileObjectType](API_connect-customer-profiles_DetectProfileObjectType.md) 
+  [GetAutoMergingPreview](API_connect-customer-profiles_GetAutoMergingPreview.md) 
+  [GetCalculatedAttributeDefinition](API_connect-customer-profiles_GetCalculatedAttributeDefinition.md) 
+  [GetCalculatedAttributeForProfile](API_connect-customer-profiles_GetCalculatedAttributeForProfile.md) 
+  [GetDomain](API_connect-customer-profiles_GetDomain.md) 
+  [GetDomainLayout](API_connect-customer-profiles_GetDomainLayout.md) 
+  [GetDomainObjectType](API_connect-customer-profiles_GetDomainObjectType.md) 
+  [GetEventStream](API_connect-customer-profiles_GetEventStream.md) 
+  [GetEventTrigger](API_connect-customer-profiles_GetEventTrigger.md) 
+  [GetIdentityResolutionJob](API_connect-customer-profiles_GetIdentityResolutionJob.md) 
+  [GetIntegration](API_connect-customer-profiles_GetIntegration.md) 
+  [GetMatches](API_connect-customer-profiles_GetMatches.md) 
+  [GetObjectTypeAttributeStatistics](API_connect-customer-profiles_GetObjectTypeAttributeStatistics.md) 
+  [GetProfileHistoryRecord](API_connect-customer-profiles_GetProfileHistoryRecord.md) 
+  [GetProfileObjectType](API_connect-customer-profiles_GetProfileObjectType.md) 
+  [GetProfileObjectTypeTemplate](API_connect-customer-profiles_GetProfileObjectTypeTemplate.md) 
+  [GetProfileRecommendations](API_connect-customer-profiles_GetProfileRecommendations.md) 
+  [GetRecommender](API_connect-customer-profiles_GetRecommender.md) 
+  [GetSegmentDefinition](API_connect-customer-profiles_GetSegmentDefinition.md) 
+  [GetSegmentEstimate](API_connect-customer-profiles_GetSegmentEstimate.md) 
+  [GetSegmentMembership](API_connect-customer-profiles_GetSegmentMembership.md) 
+  [GetSegmentSnapshot](API_connect-customer-profiles_GetSegmentSnapshot.md) 
+  [GetSimilarProfiles](API_connect-customer-profiles_GetSimilarProfiles.md) 
+  [GetUploadJob](API_connect-customer-profiles_GetUploadJob.md) 
+  [GetUploadJobPath](API_connect-customer-profiles_GetUploadJobPath.md) 
+  [GetWorkflow](API_connect-customer-profiles_GetWorkflow.md) 
+  [GetWorkflowSteps](API_connect-customer-profiles_GetWorkflowSteps.md) 
+  [ListAccountIntegrations](API_connect-customer-profiles_ListAccountIntegrations.md) 
+  [ListCalculatedAttributeDefinitions](API_connect-customer-profiles_ListCalculatedAttributeDefinitions.md) 
+  [ListCalculatedAttributesForProfile](API_connect-customer-profiles_ListCalculatedAttributesForProfile.md) 
+  [ListDomainLayouts](API_connect-customer-profiles_ListDomainLayouts.md) 
+  [ListDomainObjectTypes](API_connect-customer-profiles_ListDomainObjectTypes.md) 
+  [ListDomains](API_connect-customer-profiles_ListDomains.md) 
+  [ListEventStreams](API_connect-customer-profiles_ListEventStreams.md) 
+  [ListEventTriggers](API_connect-customer-profiles_ListEventTriggers.md) 
+  [ListIdentityResolutionJobs](API_connect-customer-profiles_ListIdentityResolutionJobs.md) 
+  [ListIntegrations](API_connect-customer-profiles_ListIntegrations.md) 
+  [ListObjectTypeAttributes](API_connect-customer-profiles_ListObjectTypeAttributes.md) 
+  [ListObjectTypeAttributeValues](API_connect-customer-profiles_ListObjectTypeAttributeValues.md) 
+  [ListProfileAttributeValues](API_connect-customer-profiles_ListProfileAttributeValues.md) 
+  [ListProfileHistoryRecords](API_connect-customer-profiles_ListProfileHistoryRecords.md) 
+  [ListProfileObjects](API_connect-customer-profiles_ListProfileObjects.md) 
+  [ListProfileObjectTypes](API_connect-customer-profiles_ListProfileObjectTypes.md) 
+  [ListProfileObjectTypeTemplates](API_connect-customer-profiles_ListProfileObjectTypeTemplates.md) 
+  [ListRecommenderRecipes](API_connect-customer-profiles_ListRecommenderRecipes.md) 
+  [ListRecommenders](API_connect-customer-profiles_ListRecommenders.md) 
+  [ListRuleBasedMatches](API_connect-customer-profiles_ListRuleBasedMatches.md) 
+  [ListSegmentDefinitions](API_connect-customer-profiles_ListSegmentDefinitions.md) 
+  [ListTagsForResource](API_connect-customer-profiles_ListTagsForResource.md) 
+  [ListUploadJobs](API_connect-customer-profiles_ListUploadJobs.md) 
+  [ListWorkflows](API_connect-customer-profiles_ListWorkflows.md) 
+  [MergeProfiles](API_connect-customer-profiles_MergeProfiles.md) 
+  [PutDomainObjectType](API_connect-customer-profiles_PutDomainObjectType.md) 
+  [PutIntegration](API_connect-customer-profiles_PutIntegration.md) 
+  [PutProfileObject](API_connect-customer-profiles_PutProfileObject.md) 
+  [PutProfileObjectType](API_connect-customer-profiles_PutProfileObjectType.md) 
+  [SearchProfiles](API_connect-customer-profiles_SearchProfiles.md) 
+  [StartRecommender](API_connect-customer-profiles_StartRecommender.md) 
+  [StartUploadJob](API_connect-customer-profiles_StartUploadJob.md) 
+  [StopRecommender](API_connect-customer-profiles_StopRecommender.md) 
+  [StopUploadJob](API_connect-customer-profiles_StopUploadJob.md) 
+  [TagResource](API_connect-customer-profiles_TagResource.md) 
+  [UntagResource](API_connect-customer-profiles_UntagResource.md) 
+  [UpdateCalculatedAttributeDefinition](API_connect-customer-profiles_UpdateCalculatedAttributeDefinition.md) 
+  [UpdateDomain](API_connect-customer-profiles_UpdateDomain.md) 
+  [UpdateDomainLayout](API_connect-customer-profiles_UpdateDomainLayout.md) 
+  [UpdateEventTrigger](API_connect-customer-profiles_UpdateEventTrigger.md) 
+  [UpdateProfile](API_connect-customer-profiles_UpdateProfile.md) 
+  [UpdateRecommender](API_connect-customer-profiles_UpdateRecommender.md) 

# AddProfileKey
<a name="API_connect-customer-profiles_AddProfileKey"></a>

Associates a new key value with a specific profile, such as a Contact Record ContactId.

A profile object can have a single unique key and any number of additional keys that can be used to identify the profile that it belongs to.

## Request Syntax
<a name="API_connect-customer-profiles_AddProfileKey_RequestSyntax"></a>

```
POST /domains/DomainName/profiles/keys HTTP/1.1
Content-type: application/json

{
   "KeyName": "string",
   "ProfileId": "string",
   "Values": [ "string" ]
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_AddProfileKey_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_AddProfileKey_RequestSyntax) **   <a name="connect-connect-customer-profiles_AddProfileKey-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_AddProfileKey_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [KeyName](#API_connect-customer-profiles_AddProfileKey_RequestSyntax) **   <a name="connect-connect-customer-profiles_AddProfileKey-request-KeyName"></a>
A searchable identifier of a customer profile. The predefined keys you can use include: \$1account, \$1profileId, \$1assetId, \$1caseId, \$1orderId, \$1fullName, \$1phone, \$1email, \$1ctrContactId, \$1marketoLeadId, \$1salesforceAccountId, \$1salesforceContactId, \$1salesforceAssetId, \$1zendeskUserId, \$1zendeskExternalId, \$1zendeskTicketId, \$1serviceNowSystemId, \$1serviceNowIncidentId, \$1segmentUserId, \$1shopifyCustomerId, \$1shopifyOrderId.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [ProfileId](#API_connect-customer-profiles_AddProfileKey_RequestSyntax) **   <a name="connect-connect-customer-profiles_AddProfileKey-request-ProfileId"></a>
The unique identifier of a customer profile.  
Type: String  
Pattern: `[a-f0-9]{32}`   
Required: Yes

 ** [Values](#API_connect-customer-profiles_AddProfileKey_RequestSyntax) **   <a name="connect-connect-customer-profiles_AddProfileKey-request-Values"></a>
A list of key values.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_AddProfileKey_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "KeyName": "string",
   "Values": [ "string" ]
}
```

## Response Elements
<a name="API_connect-customer-profiles_AddProfileKey_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [KeyName](#API_connect-customer-profiles_AddProfileKey_ResponseSyntax) **   <a name="connect-connect-customer-profiles_AddProfileKey-response-KeyName"></a>
A searchable identifier of a customer profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [Values](#API_connect-customer-profiles_AddProfileKey_ResponseSyntax) **   <a name="connect-connect-customer-profiles_AddProfileKey-response-Values"></a>
A list of key values.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_connect-customer-profiles_AddProfileKey_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_AddProfileKey_Examples"></a>

### Example
<a name="API_connect-customer-profiles_AddProfileKey_Example_1"></a>

This example illustrates one usage of AddProfileKey.

#### Sample Request
<a name="API_connect-customer-profiles_AddProfileKey_Example_1_Request"></a>

```
POST /v1/domains/ExampleDomainName/profiles/keys

Content-type: application/json 
{
  "ProfileId": "3991a7d959d248bba82546b2dEXAMPLE",
  "KeyName": "_ctrContactId",
  "Values": ["valueOfTheContactId"]
}
```

#### Sample Response
<a name="API_connect-customer-profiles_AddProfileKey_Example_1_Response"></a>

```
Content-type: application/json
{
   "KeyName": "_ctrContactId",
   "Values": ["valueOfTheContactId"]
}
```

## See Also
<a name="API_connect-customer-profiles_AddProfileKey_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/AddProfileKey) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/AddProfileKey) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/AddProfileKey) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/AddProfileKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/AddProfileKey) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/AddProfileKey) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/AddProfileKey) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/AddProfileKey) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/AddProfileKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/AddProfileKey) 

# BatchGetCalculatedAttributeForProfile
<a name="API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile"></a>

Fetch the possible attribute values given the attribute name.

## Request Syntax
<a name="API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile_RequestSyntax"></a>

```
POST /domains/DomainName/calculated-attributes/CalculatedAttributeName/batch-get-for-profiles HTTP/1.1
Content-type: application/json

{
   "ConditionOverrides": { 
      "Range": { 
         "End": number,
         "Start": number,
         "Unit": "string"
      }
   },
   "ProfileIds": [ "string" ]
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [CalculatedAttributeName](#API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_BatchGetCalculatedAttributeForProfile-request-uri-CalculatedAttributeName"></a>
The unique name of the calculated attribute.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: Yes

 ** [DomainName](#API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_BatchGetCalculatedAttributeForProfile-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ConditionOverrides](#API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_BatchGetCalculatedAttributeForProfile-request-ConditionOverrides"></a>
Overrides the condition block within the original calculated attribute definition.  
Type: [ConditionOverrides](API_connect-customer-profiles_ConditionOverrides.md) object  
Required: No

 ** [ProfileIds](#API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_BatchGetCalculatedAttributeForProfile-request-ProfileIds"></a>
List of unique identifiers for customer profiles to retrieve.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Pattern: `[a-f0-9]{32}`   
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CalculatedAttributeValues": [ 
      { 
         "CalculatedAttributeName": "string",
         "DisplayName": "string",
         "IsDataPartial": "string",
         "LastObjectTimestamp": number,
         "ProfileId": "string",
         "Value": "string"
      }
   ],
   "ConditionOverrides": { 
      "Range": { 
         "End": number,
         "Start": number,
         "Unit": "string"
      }
   },
   "Errors": [ 
      { 
         "Code": "string",
         "Message": "string",
         "ProfileId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CalculatedAttributeValues](#API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile_ResponseSyntax) **   <a name="connect-connect-customer-profiles_BatchGetCalculatedAttributeForProfile-response-CalculatedAttributeValues"></a>
List of calculated attribute values retrieved.  
Type: Array of [CalculatedAttributeValue](API_connect-customer-profiles_CalculatedAttributeValue.md) objects

 ** [ConditionOverrides](#API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile_ResponseSyntax) **   <a name="connect-connect-customer-profiles_BatchGetCalculatedAttributeForProfile-response-ConditionOverrides"></a>
Overrides the condition block within the original calculated attribute definition.  
Type: [ConditionOverrides](API_connect-customer-profiles_ConditionOverrides.md) object

 ** [Errors](#API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile_ResponseSyntax) **   <a name="connect-connect-customer-profiles_BatchGetCalculatedAttributeForProfile-response-Errors"></a>
List of errors for calculated attribute values that could not be retrieved.  
Type: Array of [BatchGetCalculatedAttributeForProfileError](API_connect-customer-profiles_BatchGetCalculatedAttributeForProfileError.md) objects

## Errors
<a name="API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_BatchGetCalculatedAttributeForProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/BatchGetCalculatedAttributeForProfile) 

# BatchGetProfile
<a name="API_connect-customer-profiles_BatchGetProfile"></a>

Get a batch of profiles.

## Request Syntax
<a name="API_connect-customer-profiles_BatchGetProfile_RequestSyntax"></a>

```
POST /domains/DomainName/batch-get-profiles HTTP/1.1
Content-type: application/json

{
   "ProfileIds": [ "string" ]
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_BatchGetProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_BatchGetProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_BatchGetProfile-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_BatchGetProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ProfileIds](#API_connect-customer-profiles_BatchGetProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_BatchGetProfile-request-ProfileIds"></a>
List of unique identifiers for customer profiles to retrieve.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-f0-9]{32}`   
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_BatchGetProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Errors": [ 
      { 
         "Code": "string",
         "Message": "string",
         "ProfileId": "string"
      }
   ],
   "Profiles": [ 
      { 
         "AccountNumber": "string",
         "AdditionalInformation": "string",
         "Address": { 
            "Address1": "string",
            "Address2": "string",
            "Address3": "string",
            "Address4": "string",
            "City": "string",
            "Country": "string",
            "County": "string",
            "PostalCode": "string",
            "Province": "string",
            "State": "string"
         },
         "Attributes": { 
            "string" : "string" 
         },
         "BillingAddress": { 
            "Address1": "string",
            "Address2": "string",
            "Address3": "string",
            "Address4": "string",
            "City": "string",
            "Country": "string",
            "County": "string",
            "PostalCode": "string",
            "Province": "string",
            "State": "string"
         },
         "BirthDate": "string",
         "BusinessEmailAddress": "string",
         "BusinessName": "string",
         "BusinessPhoneNumber": "string",
         "EmailAddress": "string",
         "EngagementPreferences": { 
            "Email": [ 
               { 
                  "ContactType": "string",
                  "KeyName": "string",
                  "KeyValue": "string",
                  "ProfileId": "string"
               }
            ],
            "Phone": [ 
               { 
                  "ContactType": "string",
                  "KeyName": "string",
                  "KeyValue": "string",
                  "ProfileId": "string"
               }
            ]
         },
         "FirstName": "string",
         "FoundByItems": [ 
            { 
               "KeyName": "string",
               "Values": [ "string" ]
            }
         ],
         "Gender": "string",
         "GenderString": "string",
         "HomePhoneNumber": "string",
         "LastName": "string",
         "MailingAddress": { 
            "Address1": "string",
            "Address2": "string",
            "Address3": "string",
            "Address4": "string",
            "City": "string",
            "Country": "string",
            "County": "string",
            "PostalCode": "string",
            "Province": "string",
            "State": "string"
         },
         "MiddleName": "string",
         "MobilePhoneNumber": "string",
         "PartyType": "string",
         "PartyTypeString": "string",
         "PersonalEmailAddress": "string",
         "PhoneNumber": "string",
         "ProfileId": "string",
         "ProfileType": "string",
         "ShippingAddress": { 
            "Address1": "string",
            "Address2": "string",
            "Address3": "string",
            "Address4": "string",
            "City": "string",
            "Country": "string",
            "County": "string",
            "PostalCode": "string",
            "Province": "string",
            "State": "string"
         }
      }
   ]
}
```

## Response Elements
<a name="API_connect-customer-profiles_BatchGetProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Errors](#API_connect-customer-profiles_BatchGetProfile_ResponseSyntax) **   <a name="connect-connect-customer-profiles_BatchGetProfile-response-Errors"></a>
For information about the errors that are common to all actions, see [Common Errors](https://docs.aws.amazon.com/connect/latest/APIReference/CommonErrors.html).  
Type: Array of [BatchGetProfileError](API_connect-customer-profiles_BatchGetProfileError.md) objects

 ** [Profiles](#API_connect-customer-profiles_BatchGetProfile_ResponseSyntax) **   <a name="connect-connect-customer-profiles_BatchGetProfile-response-Profiles"></a>
Array of Profile Objects.  
Type: Array of [Profile](API_connect-customer-profiles_Profile.md) objects

## Errors
<a name="API_connect-customer-profiles_BatchGetProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_BatchGetProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/BatchGetProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/BatchGetProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/BatchGetProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/BatchGetProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/BatchGetProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/BatchGetProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/BatchGetProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/BatchGetProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/BatchGetProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/BatchGetProfile) 

# CreateCalculatedAttributeDefinition
<a name="API_connect-customer-profiles_CreateCalculatedAttributeDefinition"></a>

Creates a new calculated attribute definition. After creation, new object data ingested into Customer Profiles will be included in the calculated attribute, which can be retrieved for a profile using the [GetCalculatedAttributeForProfile](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetCalculatedAttributeForProfile.html) API. Defining a calculated attribute makes it available for all profiles within a domain. Each calculated attribute can only reference one `ObjectType` and at most, two fields from that `ObjectType`.

## Request Syntax
<a name="API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax"></a>

```
POST /domains/DomainName/calculated-attributes/CalculatedAttributeName HTTP/1.1
Content-type: application/json

{
   "AttributeDetails": { 
      "Attributes": [ 
         { 
            "Name": "string"
         }
      ],
      "Expression": "string"
   },
   "Conditions": { 
      "ObjectCount": number,
      "Range": { 
         "TimestampFormat": "string",
         "TimestampSource": "string",
         "Unit": "string",
         "Value": number,
         "ValueRange": { 
            "End": number,
            "Start": number
         }
      },
      "Threshold": { 
         "Operator": "string",
         "Value": "string"
      }
   },
   "Description": "string",
   "DisplayName": "string",
   "Filter": { 
      "Groups": [ 
         { 
            "Dimensions": [ 
               { 
                  "Attributes": { 
                     "string" : { 
                        "DimensionType": "string",
                        "Values": [ "string" ]
                     }
                  }
               }
            ],
            "Type": "string"
         }
      ],
      "Include": "string"
   },
   "Statistic": "string",
   "Tags": { 
      "string" : "string" 
   },
   "UseHistoricalData": boolean
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestParameters"></a>

The request uses the following URI parameters.

 ** [CalculatedAttributeName](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-request-uri-CalculatedAttributeName"></a>
The unique name of the calculated attribute.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: Yes

 ** [DomainName](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AttributeDetails](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-request-AttributeDetails"></a>
Mathematical expression and a list of attribute items specified in that expression.  
Type: [AttributeDetails](API_connect-customer-profiles_AttributeDetails.md) object  
Required: Yes

 ** [Conditions](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-request-Conditions"></a>
The conditions including range, object count, and threshold for the calculated attribute.  
Type: [Conditions](API_connect-customer-profiles_Conditions.md) object  
Required: No

 ** [Description](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-request-Description"></a>
The description of the calculated attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: No

 ** [DisplayName](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-request-DisplayName"></a>
The display name of the calculated attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$`   
Required: No

 ** [Filter](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-request-Filter"></a>
Defines how to filter incoming objects to include part of the Calculated Attribute.  
Type: [Filter](API_connect-customer-profiles_Filter.md) object  
Required: No

 ** [Statistic](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-request-Statistic"></a>
The aggregation operation to perform for the calculated attribute.  
Type: String  
Valid Values: `FIRST_OCCURRENCE | LAST_OCCURRENCE | COUNT | SUM | MINIMUM | MAXIMUM | AVERAGE | MAX_OCCURRENCE`   
Required: Yes

 ** [Tags](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-request-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Required: No

 ** [UseHistoricalData](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-request-UseHistoricalData"></a>
Whether historical data ingested before the Calculated Attribute was created should be included in calculations.  
Type: Boolean  
Required: No

## Response Syntax
<a name="API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AttributeDetails": { 
      "Attributes": [ 
         { 
            "Name": "string"
         }
      ],
      "Expression": "string"
   },
   "CalculatedAttributeName": "string",
   "Conditions": { 
      "ObjectCount": number,
      "Range": { 
         "TimestampFormat": "string",
         "TimestampSource": "string",
         "Unit": "string",
         "Value": number,
         "ValueRange": { 
            "End": number,
            "Start": number
         }
      },
      "Threshold": { 
         "Operator": "string",
         "Value": "string"
      }
   },
   "CreatedAt": number,
   "Description": "string",
   "DisplayName": "string",
   "Filter": { 
      "Groups": [ 
         { 
            "Dimensions": [ 
               { 
                  "Attributes": { 
                     "string" : { 
                        "DimensionType": "string",
                        "Values": [ "string" ]
                     }
                  }
               }
            ],
            "Type": "string"
         }
      ],
      "Include": "string"
   },
   "LastUpdatedAt": number,
   "Readiness": { 
      "Message": "string",
      "ProgressPercentage": number
   },
   "Statistic": "string",
   "Status": "string",
   "Tags": { 
      "string" : "string" 
   },
   "UseHistoricalData": boolean
}
```

## Response Elements
<a name="API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AttributeDetails](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-AttributeDetails"></a>
Mathematical expression and a list of attribute items specified in that expression.  
Type: [AttributeDetails](API_connect-customer-profiles_AttributeDetails.md) object

 ** [CalculatedAttributeName](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-CalculatedAttributeName"></a>
The unique name of the calculated attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` 

 ** [Conditions](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-Conditions"></a>
The conditions including range, object count, and threshold for the calculated attribute.  
Type: [Conditions](API_connect-customer-profiles_Conditions.md) object

 ** [CreatedAt](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-CreatedAt"></a>
The timestamp of when the calculated attribute definition was created.  
Type: Timestamp

 ** [Description](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-Description"></a>
The description of the calculated attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.

 ** [DisplayName](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-DisplayName"></a>
The display name of the calculated attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$` 

 ** [Filter](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-Filter"></a>
The filter that was used as part of the request.  
Type: [Filter](API_connect-customer-profiles_Filter.md) object

 ** [LastUpdatedAt](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-LastUpdatedAt"></a>
The timestamp of when the calculated attribute definition was most recently edited.  
Type: Timestamp

 ** [Readiness](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-Readiness"></a>
Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected.  
Type: [Readiness](API_connect-customer-profiles_Readiness.md) object

 ** [Statistic](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-Statistic"></a>
The aggregation operation to perform for the calculated attribute.  
Type: String  
Valid Values: `FIRST_OCCURRENCE | LAST_OCCURRENCE | COUNT | SUM | MINIMUM | MAXIMUM | AVERAGE | MAX_OCCURRENCE` 

 ** [Status](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-Status"></a>
Status of the Calculated Attribute creation (whether all historical data has been indexed.)  
Type: String  
Valid Values: `PREPARING | IN_PROGRESS | COMPLETED | FAILED` 

 ** [Tags](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

 ** [UseHistoricalData](#API_connect-customer-profiles_CreateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateCalculatedAttributeDefinition-response-UseHistoricalData"></a>
Whether historical data ingested before the Calculated Attribute was created should be included in calculations.  
Type: Boolean

## Errors
<a name="API_connect-customer-profiles_CreateCalculatedAttributeDefinition_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_CreateCalculatedAttributeDefinition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateCalculatedAttributeDefinition) 

# CreateDomain
<a name="API_connect-customer-profiles_CreateDomain"></a>

Creates a domain, which is a container for all customer data, such as customer profile attributes, object types, profile keys, and encryption keys. You can create multiple domains, and each domain can have multiple third-party integrations.

Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.

Use this API or [UpdateDomain](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html) to enable [identity resolution](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html): set `Matching` to true.

To prevent cross-service impersonation when you call this API, see [Cross-service confused deputy prevention](https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html) for sample policies that you should apply. 

**Note**  
It is not possible to associate a Customer Profiles domain with an Amazon Connect Instance directly from the API. If you would like to create a domain and associate a Customer Profiles domain, use the Amazon Connect admin website. For more information, see [Enable Customer Profiles](https://docs.aws.amazon.com/connect/latest/adminguide/enable-customer-profiles.html#enable-customer-profiles-step1).  
Each Amazon Connect instance can be associated with only one domain. Multiple Amazon Connect instances can be associated with one domain.

## Request Syntax
<a name="API_connect-customer-profiles_CreateDomain_RequestSyntax"></a>

```
POST /domains/DomainName HTTP/1.1
Content-type: application/json

{
   "DataStore": { 
      "Enabled": boolean
   },
   "DeadLetterQueueUrl": "string",
   "DefaultEncryptionKey": "string",
   "DefaultExpirationDays": number,
   "Matching": { 
      "AutoMerging": { 
         "ConflictResolution": { 
            "ConflictResolvingModel": "string",
            "SourceName": "string"
         },
         "Consolidation": { 
            "MatchingAttributesList": [ 
               [ "string" ]
            ]
         },
         "Enabled": boolean,
         "MinAllowedConfidenceScoreForMerging": number
      },
      "Enabled": boolean,
      "ExportingConfig": { 
         "S3Exporting": { 
            "S3BucketName": "string",
            "S3KeyName": "string"
         }
      },
      "JobSchedule": { 
         "DayOfTheWeek": "string",
         "Time": "string"
      }
   },
   "RuleBasedMatching": { 
      "AttributeTypesSelector": { 
         "Address": [ "string" ],
         "AttributeMatchingModel": "string",
         "EmailAddress": [ "string" ],
         "PhoneNumber": [ "string" ]
      },
      "ConflictResolution": { 
         "ConflictResolvingModel": "string",
         "SourceName": "string"
      },
      "Enabled": boolean,
      "ExportingConfig": { 
         "S3Exporting": { 
            "S3BucketName": "string",
            "S3KeyName": "string"
         }
      },
      "MatchingRules": [ 
         { 
            "Rule": [ "string" ]
         }
      ],
      "MaxAllowedRuleLevelForMatching": number,
      "MaxAllowedRuleLevelForMerging": number
   },
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_CreateDomain_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_CreateDomain_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateDomain-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_CreateDomain_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [DataStore](#API_connect-customer-profiles_CreateDomain_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateDomain-request-DataStore"></a>
Set to true to enabled data store for this domain.  
Type: [DataStoreRequest](API_connect-customer-profiles_DataStoreRequest.md) object  
Required: No

 ** [DeadLetterQueueUrl](#API_connect-customer-profiles_CreateDomain_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateDomain-request-DeadLetterQueueUrl"></a>
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [DefaultEncryptionKey](#API_connect-customer-profiles_CreateDomain_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateDomain-request-DefaultEncryptionKey"></a>
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [DefaultExpirationDays](#API_connect-customer-profiles_CreateDomain_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateDomain-request-DefaultExpirationDays"></a>
The default number of days until the data within the domain expires.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1098.  
Required: Yes

 ** [Matching](#API_connect-customer-profiles_CreateDomain_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateDomain-request-Matching"></a>
The process of matching duplicate profiles. If `Matching` = `true`, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.   
After the Identity Resolution Job completes, use the [GetMatches](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) API to return and review the results. Or, if you have configured `ExportingConfig` in the `MatchingRequest`, you can download the results from S3.  
Type: [MatchingRequest](API_connect-customer-profiles_MatchingRequest.md) object  
Required: No

 ** [RuleBasedMatching](#API_connect-customer-profiles_CreateDomain_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateDomain-request-RuleBasedMatching"></a>
The process of matching duplicate profiles using the Rule-Based matching. If `RuleBasedMatching` = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the `RuleBasedMatchingRequest`. You can use the `ListRuleBasedMatches` and `GetSimilarProfiles` API to return and review the results. Also, if you have configured `ExportingConfig` in the `RuleBasedMatchingRequest`, you can download the results from S3.  
Type: [RuleBasedMatchingRequest](API_connect-customer-profiles_RuleBasedMatchingRequest.md) object  
Required: No

 ** [Tags](#API_connect-customer-profiles_CreateDomain_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateDomain-request-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_connect-customer-profiles_CreateDomain_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": number,
   "DataStore": { 
      "Enabled": boolean,
      "Readiness": { 
         "Message": "string",
         "ProgressPercentage": number
      }
   },
   "DeadLetterQueueUrl": "string",
   "DefaultEncryptionKey": "string",
   "DefaultExpirationDays": number,
   "DomainName": "string",
   "LastUpdatedAt": number,
   "Matching": { 
      "AutoMerging": { 
         "ConflictResolution": { 
            "ConflictResolvingModel": "string",
            "SourceName": "string"
         },
         "Consolidation": { 
            "MatchingAttributesList": [ 
               [ "string" ]
            ]
         },
         "Enabled": boolean,
         "MinAllowedConfidenceScoreForMerging": number
      },
      "Enabled": boolean,
      "ExportingConfig": { 
         "S3Exporting": { 
            "S3BucketName": "string",
            "S3KeyName": "string"
         }
      },
      "JobSchedule": { 
         "DayOfTheWeek": "string",
         "Time": "string"
      }
   },
   "RuleBasedMatching": { 
      "AttributeTypesSelector": { 
         "Address": [ "string" ],
         "AttributeMatchingModel": "string",
         "EmailAddress": [ "string" ],
         "PhoneNumber": [ "string" ]
      },
      "ConflictResolution": { 
         "ConflictResolvingModel": "string",
         "SourceName": "string"
      },
      "Enabled": boolean,
      "ExportingConfig": { 
         "S3Exporting": { 
            "S3BucketName": "string",
            "S3KeyName": "string"
         }
      },
      "MatchingRules": [ 
         { 
            "Rule": [ "string" ]
         }
      ],
      "MaxAllowedRuleLevelForMatching": number,
      "MaxAllowedRuleLevelForMerging": number,
      "Status": "string"
   },
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-customer-profiles_CreateDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreatedAt](#API_connect-customer-profiles_CreateDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateDomain-response-CreatedAt"></a>
The timestamp of when the domain was created.  
Type: Timestamp

 ** [DataStore](#API_connect-customer-profiles_CreateDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateDomain-response-DataStore"></a>
The data store.  
Type: [DataStoreResponse](API_connect-customer-profiles_DataStoreResponse.md) object

 ** [DeadLetterQueueUrl](#API_connect-customer-profiles_CreateDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateDomain-response-DeadLetterQueueUrl"></a>
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.

 ** [DefaultEncryptionKey](#API_connect-customer-profiles_CreateDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateDomain-response-DefaultEncryptionKey"></a>
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.

 ** [DefaultExpirationDays](#API_connect-customer-profiles_CreateDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateDomain-response-DefaultExpirationDays"></a>
The default number of days until the data within the domain expires.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1098.

 ** [DomainName](#API_connect-customer-profiles_CreateDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateDomain-response-DomainName"></a>
The unique name of the domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [LastUpdatedAt](#API_connect-customer-profiles_CreateDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateDomain-response-LastUpdatedAt"></a>
The timestamp of when the domain was most recently edited.  
Type: Timestamp

 ** [Matching](#API_connect-customer-profiles_CreateDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateDomain-response-Matching"></a>
The process of matching duplicate profiles. If `Matching` = `true`, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.   
After the Identity Resolution Job completes, use the [GetMatches](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) API to return and review the results. Or, if you have configured `ExportingConfig` in the `MatchingRequest`, you can download the results from S3.  
Type: [MatchingResponse](API_connect-customer-profiles_MatchingResponse.md) object

 ** [RuleBasedMatching](#API_connect-customer-profiles_CreateDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateDomain-response-RuleBasedMatching"></a>
The process of matching duplicate profiles using the Rule-Based matching. If `RuleBasedMatching` = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the `RuleBasedMatchingRequest`. You can use the `ListRuleBasedMatches` and `GetSimilarProfiles` API to return and review the results. Also, if you have configured `ExportingConfig` in the `RuleBasedMatchingRequest`, you can download the results from S3.  
Type: [RuleBasedMatchingResponse](API_connect-customer-profiles_RuleBasedMatchingResponse.md) object

 ** [Tags](#API_connect-customer-profiles_CreateDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateDomain-response-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_connect-customer-profiles_CreateDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_CreateDomain_Examples"></a>

### Example
<a name="API_connect-customer-profiles_CreateDomain_Example_1"></a>

This example illustrates one usage of CreateDomain.

#### Sample Request
<a name="API_connect-customer-profiles_CreateDomain_Example_1_Request"></a>

```
POST /v1/domains/ExampleDomainName 
Content-type: application/json 
{ 
   "DeadLetterQueueUrl": "arn:aws:sqs:us-east-1:123456789012:DLQName", 
   "DefaultEncryptionKey": "arn:aws:kms:us-east-1:123456789012:key/1988472d-6b77-4bb6-ae39-efce5EXAMPLE", 
   "DefaultExpirationDays": 1098,
   "DomainName":"ExampleDomainName" 
}
```

#### Sample Response
<a name="API_connect-customer-profiles_CreateDomain_Example_1_Response"></a>

```
Content-type: application/json 
{ 
   "DeadLetterQueueUrl": "arn:aws:sqs:us-east-1:123456789012:DLQName", 
   "CreatedAt": 1479249799770, 
   "DefaultEncryptionKey":"arn:aws:kms:us-east-1:123456789012:key/1988472d-6b77-4bb6-ae39-efce5EXAMPLE", 
   "DefaultExpirationDays": 1098,   
   "LastUpdatedAt":1479249799770, 
   "DomainName": "ExampleDomainName"
}
```

## See Also
<a name="API_connect-customer-profiles_CreateDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateDomain) 

# CreateDomainLayout
<a name="API_connect-customer-profiles_CreateDomainLayout"></a>

Creates the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

## Request Syntax
<a name="API_connect-customer-profiles_CreateDomainLayout_RequestSyntax"></a>

```
POST /domains/DomainName/layouts/LayoutDefinitionName HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "DisplayName": "string",
   "IsDefault": boolean,
   "Layout": "string",
   "LayoutType": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_CreateDomainLayout_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_CreateDomainLayout_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateDomainLayout-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [LayoutDefinitionName](#API_connect-customer-profiles_CreateDomainLayout_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateDomainLayout-request-uri-LayoutDefinitionName"></a>
The unique name of the layout.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_CreateDomainLayout_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_connect-customer-profiles_CreateDomainLayout_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateDomainLayout-request-Description"></a>
The description of the layout  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

 ** [DisplayName](#API_connect-customer-profiles_CreateDomainLayout_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateDomainLayout-request-DisplayName"></a>
The display name of the layout  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$`   
Required: Yes

 ** [IsDefault](#API_connect-customer-profiles_CreateDomainLayout_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateDomainLayout-request-IsDefault"></a>
If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console.  
Type: Boolean  
Required: No

 ** [Layout](#API_connect-customer-profiles_CreateDomainLayout_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateDomainLayout-request-Layout"></a>
A customizable layout that can be used to view data under a Customer Profiles domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000000.  
Required: Yes

 ** [LayoutType](#API_connect-customer-profiles_CreateDomainLayout_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateDomainLayout-request-LayoutType"></a>
The type of layout that can be used to view data under a Customer Profiles domain.  
Type: String  
Valid Values: `PROFILE_EXPLORER`   
Required: Yes

 ** [Tags](#API_connect-customer-profiles_CreateDomainLayout_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateDomainLayout-request-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_connect-customer-profiles_CreateDomainLayout_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": number,
   "Description": "string",
   "DisplayName": "string",
   "IsDefault": boolean,
   "LastUpdatedAt": number,
   "Layout": "string",
   "LayoutDefinitionName": "string",
   "LayoutType": "string",
   "Tags": { 
      "string" : "string" 
   },
   "Version": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_CreateDomainLayout_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreatedAt](#API_connect-customer-profiles_CreateDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateDomainLayout-response-CreatedAt"></a>
The timestamp of when the layout was created.  
Type: Timestamp

 ** [Description](#API_connect-customer-profiles_CreateDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateDomainLayout-response-Description"></a>
The description of the layout  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.

 ** [DisplayName](#API_connect-customer-profiles_CreateDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateDomainLayout-response-DisplayName"></a>
The display name of the layout  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$` 

 ** [IsDefault](#API_connect-customer-profiles_CreateDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateDomainLayout-response-IsDefault"></a>
If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console.  
Type: Boolean

 ** [LastUpdatedAt](#API_connect-customer-profiles_CreateDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateDomainLayout-response-LastUpdatedAt"></a>
The timestamp of when the layout was most recently updated.  
Type: Timestamp

 ** [Layout](#API_connect-customer-profiles_CreateDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateDomainLayout-response-Layout"></a>
A customizable layout that can be used to view data under Customer Profiles domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000000.

 ** [LayoutDefinitionName](#API_connect-customer-profiles_CreateDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateDomainLayout-response-LayoutDefinitionName"></a>
The unique name of the layout.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [LayoutType](#API_connect-customer-profiles_CreateDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateDomainLayout-response-LayoutType"></a>
The type of layout that can be used to view data under customer profiles domain.  
Type: String  
Valid Values: `PROFILE_EXPLORER` 

 ** [Tags](#API_connect-customer-profiles_CreateDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateDomainLayout-response-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

 ** [Version](#API_connect-customer-profiles_CreateDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateDomainLayout-response-Version"></a>
The version used to create layout.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_connect-customer-profiles_CreateDomainLayout_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_CreateDomainLayout_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateDomainLayout) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateDomainLayout) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateDomainLayout) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateDomainLayout) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateDomainLayout) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateDomainLayout) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateDomainLayout) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateDomainLayout) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateDomainLayout) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateDomainLayout) 

# CreateEventStream
<a name="API_connect-customer-profiles_CreateEventStream"></a>

Creates an event stream, which is a subscription to real-time events, such as when profiles are created and updated through Amazon Connect Customer Profiles.

Each event stream can be associated with only one Kinesis Data Stream destination in the same region and AWS account as the customer profiles domain

## Request Syntax
<a name="API_connect-customer-profiles_CreateEventStream_RequestSyntax"></a>

```
POST /domains/DomainName/event-streams/EventStreamName HTTP/1.1
Content-type: application/json

{
   "Tags": { 
      "string" : "string" 
   },
   "Uri": "string"
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_CreateEventStream_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_CreateEventStream_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateEventStream-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [EventStreamName](#API_connect-customer-profiles_CreateEventStream_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateEventStream-request-uri-EventStreamName"></a>
The name of the event stream.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_CreateEventStream_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Tags](#API_connect-customer-profiles_CreateEventStream_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateEventStream-request-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Required: No

 ** [Uri](#API_connect-customer-profiles_CreateEventStream_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateEventStream-request-Uri"></a>
The StreamARN of the destination to deliver profile events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_CreateEventStream_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "EventStreamArn": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-customer-profiles_CreateEventStream_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EventStreamArn](#API_connect-customer-profiles_CreateEventStream_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateEventStream-response-EventStreamArn"></a>
A unique identifier for the event stream.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [Tags](#API_connect-customer-profiles_CreateEventStream_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateEventStream-response-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_connect-customer-profiles_CreateEventStream_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_CreateEventStream_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateEventStream) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateEventStream) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateEventStream) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateEventStream) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateEventStream) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateEventStream) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateEventStream) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateEventStream) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateEventStream) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateEventStream) 

# CreateEventTrigger
<a name="API_connect-customer-profiles_CreateEventTrigger"></a>

Creates an event trigger, which specifies the rules when to perform action based on customer's ingested data.

Each event stream can be associated with only one integration in the same region and AWS account as the event stream. 

## Request Syntax
<a name="API_connect-customer-profiles_CreateEventTrigger_RequestSyntax"></a>

```
POST /domains/DomainName/event-triggers/EventTriggerName HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "EventTriggerConditions": [ 
      { 
         "EventTriggerDimensions": [ 
            { 
               "ObjectAttributes": [ 
                  { 
                     "ComparisonOperator": "string",
                     "FieldName": "string",
                     "Source": "string",
                     "Values": [ "string" ]
                  }
               ]
            }
         ],
         "LogicalOperator": "string"
      }
   ],
   "EventTriggerLimits": { 
      "EventExpiration": number,
      "Periods": [ 
         { 
            "MaxInvocationsPerProfile": number,
            "Unit": "string",
            "Unlimited": boolean,
            "Value": number
         }
      ]
   },
   "ObjectTypeName": "string",
   "SegmentFilter": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_CreateEventTrigger_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_CreateEventTrigger_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateEventTrigger-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [EventTriggerName](#API_connect-customer-profiles_CreateEventTrigger_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateEventTrigger-request-uri-EventTriggerName"></a>
The unique name of the event trigger.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_CreateEventTrigger_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_connect-customer-profiles_CreateEventTrigger_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateEventTrigger-request-Description"></a>
The description of the event trigger.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: No

 ** [EventTriggerConditions](#API_connect-customer-profiles_CreateEventTrigger_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateEventTrigger-request-EventTriggerConditions"></a>
A list of conditions that determine when an event should trigger the destination.  
Type: Array of [EventTriggerCondition](API_connect-customer-profiles_EventTriggerCondition.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Required: Yes

 ** [EventTriggerLimits](#API_connect-customer-profiles_CreateEventTrigger_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateEventTrigger-request-EventTriggerLimits"></a>
Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.  
Type: [EventTriggerLimits](API_connect-customer-profiles_EventTriggerLimits.md) object  
Required: No

 ** [ObjectTypeName](#API_connect-customer-profiles_CreateEventTrigger_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateEventTrigger-request-ObjectTypeName"></a>
The unique name of the object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: Yes

 ** [SegmentFilter](#API_connect-customer-profiles_CreateEventTrigger_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateEventTrigger-request-SegmentFilter"></a>
The destination is triggered only for profiles that meet the criteria of a segment definition.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: No

 ** [Tags](#API_connect-customer-profiles_CreateEventTrigger_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateEventTrigger-request-Tags"></a>
An array of key-value pairs to apply to this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_connect-customer-profiles_CreateEventTrigger_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": number,
   "Description": "string",
   "EventTriggerConditions": [ 
      { 
         "EventTriggerDimensions": [ 
            { 
               "ObjectAttributes": [ 
                  { 
                     "ComparisonOperator": "string",
                     "FieldName": "string",
                     "Source": "string",
                     "Values": [ "string" ]
                  }
               ]
            }
         ],
         "LogicalOperator": "string"
      }
   ],
   "EventTriggerLimits": { 
      "EventExpiration": number,
      "Periods": [ 
         { 
            "MaxInvocationsPerProfile": number,
            "Unit": "string",
            "Unlimited": boolean,
            "Value": number
         }
      ]
   },
   "EventTriggerName": "string",
   "LastUpdatedAt": number,
   "ObjectTypeName": "string",
   "SegmentFilter": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-customer-profiles_CreateEventTrigger_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreatedAt](#API_connect-customer-profiles_CreateEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateEventTrigger-response-CreatedAt"></a>
The timestamp of when the event trigger was created.  
Type: Timestamp

 ** [Description](#API_connect-customer-profiles_CreateEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateEventTrigger-response-Description"></a>
The description of the event trigger.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.

 ** [EventTriggerConditions](#API_connect-customer-profiles_CreateEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateEventTrigger-response-EventTriggerConditions"></a>
A list of conditions that determine when an event should trigger the destination.  
Type: Array of [EventTriggerCondition](API_connect-customer-profiles_EventTriggerCondition.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 5 items.

 ** [EventTriggerLimits](#API_connect-customer-profiles_CreateEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateEventTrigger-response-EventTriggerLimits"></a>
Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.  
Type: [EventTriggerLimits](API_connect-customer-profiles_EventTriggerLimits.md) object

 ** [EventTriggerName](#API_connect-customer-profiles_CreateEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateEventTrigger-response-EventTriggerName"></a>
The unique name of the event trigger.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [LastUpdatedAt](#API_connect-customer-profiles_CreateEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateEventTrigger-response-LastUpdatedAt"></a>
The timestamp of when the event trigger was most recently updated.  
Type: Timestamp

 ** [ObjectTypeName](#API_connect-customer-profiles_CreateEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateEventTrigger-response-ObjectTypeName"></a>
The unique name of the object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` 

 ** [SegmentFilter](#API_connect-customer-profiles_CreateEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateEventTrigger-response-SegmentFilter"></a>
The destination is triggered only for profiles that meet the criteria of a segment definition.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [Tags](#API_connect-customer-profiles_CreateEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateEventTrigger-response-Tags"></a>
An array of key-value pairs to apply to this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_connect-customer-profiles_CreateEventTrigger_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_CreateEventTrigger_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateEventTrigger) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateEventTrigger) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateEventTrigger) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateEventTrigger) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateEventTrigger) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateEventTrigger) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateEventTrigger) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateEventTrigger) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateEventTrigger) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateEventTrigger) 

# CreateIntegrationWorkflow
<a name="API_connect-customer-profiles_CreateIntegrationWorkflow"></a>

 Creates an integration workflow. An integration workflow is an async process which ingests historic data and sets up an integration for ongoing updates. The supported Amazon AppFlow sources are Salesforce, ServiceNow, and Marketo. 

## Request Syntax
<a name="API_connect-customer-profiles_CreateIntegrationWorkflow_RequestSyntax"></a>

```
POST /domains/DomainName/workflows/integrations HTTP/1.1
Content-type: application/json

{
   "IntegrationConfig": { 
      "AppflowIntegration": { 
         "Batches": [ 
            { 
               "EndTime": number,
               "StartTime": number
            }
         ],
         "FlowDefinition": { 
            "Description": "string",
            "FlowName": "string",
            "KmsArn": "string",
            "SourceFlowConfig": { 
               "ConnectorProfileName": "string",
               "ConnectorType": "string",
               "IncrementalPullConfig": { 
                  "DatetimeTypeFieldName": "string"
               },
               "SourceConnectorProperties": { 
                  "Marketo": { 
                     "Object": "string"
                  },
                  "S3": { 
                     "BucketName": "string",
                     "BucketPrefix": "string"
                  },
                  "Salesforce": { 
                     "EnableDynamicFieldUpdate": boolean,
                     "IncludeDeletedRecords": boolean,
                     "Object": "string"
                  },
                  "ServiceNow": { 
                     "Object": "string"
                  },
                  "Zendesk": { 
                     "Object": "string"
                  }
               }
            },
            "Tasks": [ 
               { 
                  "ConnectorOperator": { 
                     "Marketo": "string",
                     "S3": "string",
                     "Salesforce": "string",
                     "ServiceNow": "string",
                     "Zendesk": "string"
                  },
                  "DestinationField": "string",
                  "SourceFields": [ "string" ],
                  "TaskProperties": { 
                     "string" : "string" 
                  },
                  "TaskType": "string"
               }
            ],
            "TriggerConfig": { 
               "TriggerProperties": { 
                  "Scheduled": { 
                     "DataPullMode": "string",
                     "FirstExecutionFrom": number,
                     "ScheduleEndTime": number,
                     "ScheduleExpression": "string",
                     "ScheduleOffset": number,
                     "ScheduleStartTime": number,
                     "Timezone": "string"
                  }
               },
               "TriggerType": "string"
            }
         }
      }
   },
   "ObjectTypeName": "string",
   "RoleArn": "string",
   "Tags": { 
      "string" : "string" 
   },
   "WorkflowType": "string"
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_CreateIntegrationWorkflow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_CreateIntegrationWorkflow_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateIntegrationWorkflow-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_CreateIntegrationWorkflow_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [IntegrationConfig](#API_connect-customer-profiles_CreateIntegrationWorkflow_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateIntegrationWorkflow-request-IntegrationConfig"></a>
Configuration data for integration workflow.  
Type: [IntegrationConfig](API_connect-customer-profiles_IntegrationConfig.md) object  
Required: Yes

 ** [ObjectTypeName](#API_connect-customer-profiles_CreateIntegrationWorkflow_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateIntegrationWorkflow-request-ObjectTypeName"></a>
The name of the profile object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: Yes

 ** [RoleArn](#API_connect-customer-profiles_CreateIntegrationWorkflow_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateIntegrationWorkflow-request-RoleArn"></a>
The Amazon Resource Name (ARN) of the IAM role. Customer Profiles assumes this role to create resources on your behalf as part of workflow execution.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `arn:aws:iam:.*:[0-9]+:.*`   
Required: Yes

 ** [Tags](#API_connect-customer-profiles_CreateIntegrationWorkflow_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateIntegrationWorkflow-request-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Required: No

 ** [WorkflowType](#API_connect-customer-profiles_CreateIntegrationWorkflow_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateIntegrationWorkflow-request-WorkflowType"></a>
The type of workflow. The only supported value is APPFLOW\$1INTEGRATION.  
Type: String  
Valid Values: `APPFLOW_INTEGRATION`   
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_CreateIntegrationWorkflow_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Message": "string",
   "WorkflowId": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_CreateIntegrationWorkflow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Message](#API_connect-customer-profiles_CreateIntegrationWorkflow_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateIntegrationWorkflow-response-Message"></a>
A message indicating create request was received.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [WorkflowId](#API_connect-customer-profiles_CreateIntegrationWorkflow_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateIntegrationWorkflow-response-WorkflowId"></a>
Unique identifier for the workflow.  
Type: String  
Pattern: `[a-f0-9]{32}` 

## Errors
<a name="API_connect-customer-profiles_CreateIntegrationWorkflow_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_CreateIntegrationWorkflow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateIntegrationWorkflow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateIntegrationWorkflow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateIntegrationWorkflow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateIntegrationWorkflow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateIntegrationWorkflow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateIntegrationWorkflow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateIntegrationWorkflow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateIntegrationWorkflow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateIntegrationWorkflow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateIntegrationWorkflow) 

# CreateProfile
<a name="API_connect-customer-profiles_CreateProfile"></a>

Creates a standard profile.

A standard profile represents the following attributes for a customer profile in a domain.

## Request Syntax
<a name="API_connect-customer-profiles_CreateProfile_RequestSyntax"></a>

```
POST /domains/DomainName/profiles HTTP/1.1
Content-type: application/json

{
   "AccountNumber": "string",
   "AdditionalInformation": "string",
   "Address": { 
      "Address1": "string",
      "Address2": "string",
      "Address3": "string",
      "Address4": "string",
      "City": "string",
      "Country": "string",
      "County": "string",
      "PostalCode": "string",
      "Province": "string",
      "State": "string"
   },
   "Attributes": { 
      "string" : "string" 
   },
   "BillingAddress": { 
      "Address1": "string",
      "Address2": "string",
      "Address3": "string",
      "Address4": "string",
      "City": "string",
      "Country": "string",
      "County": "string",
      "PostalCode": "string",
      "Province": "string",
      "State": "string"
   },
   "BirthDate": "string",
   "BusinessEmailAddress": "string",
   "BusinessName": "string",
   "BusinessPhoneNumber": "string",
   "EmailAddress": "string",
   "EngagementPreferences": { 
      "Email": [ 
         { 
            "ContactType": "string",
            "KeyName": "string",
            "KeyValue": "string",
            "ProfileId": "string"
         }
      ],
      "Phone": [ 
         { 
            "ContactType": "string",
            "KeyName": "string",
            "KeyValue": "string",
            "ProfileId": "string"
         }
      ]
   },
   "FirstName": "string",
   "Gender": "string",
   "GenderString": "string",
   "HomePhoneNumber": "string",
   "LastName": "string",
   "MailingAddress": { 
      "Address1": "string",
      "Address2": "string",
      "Address3": "string",
      "Address4": "string",
      "City": "string",
      "Country": "string",
      "County": "string",
      "PostalCode": "string",
      "Province": "string",
      "State": "string"
   },
   "MiddleName": "string",
   "MobilePhoneNumber": "string",
   "PartyType": "string",
   "PartyTypeString": "string",
   "PersonalEmailAddress": "string",
   "PhoneNumber": "string",
   "ProfileType": "string",
   "ShippingAddress": { 
      "Address1": "string",
      "Address2": "string",
      "Address3": "string",
      "Address4": "string",
      "City": "string",
      "Country": "string",
      "County": "string",
      "PostalCode": "string",
      "Province": "string",
      "State": "string"
   }
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_CreateProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_CreateProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AccountNumber](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-AccountNumber"></a>
An account number that you have assigned to the customer.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [AdditionalInformation](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-AdditionalInformation"></a>
Any additional information relevant to the customer’s profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: No

 ** [Address](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-Address"></a>
A generic address associated with the customer that is not mailing, shipping, or billing.  
Type: [Address](API_connect-customer-profiles_Address.md) object  
Required: No

 ** [Attributes](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-Attributes"></a>
A key value pair of attributes of a customer profile.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 255.  
Value Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [BillingAddress](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-BillingAddress"></a>
The customer’s billing address.  
Type: [Address](API_connect-customer-profiles_Address.md) object  
Required: No

 ** [BirthDate](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-BirthDate"></a>
The customer’s birth date.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [BusinessEmailAddress](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-BusinessEmailAddress"></a>
The customer’s business email address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [BusinessName](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-BusinessName"></a>
The name of the customer’s business.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [BusinessPhoneNumber](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-BusinessPhoneNumber"></a>
The customer’s business phone number.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [EmailAddress](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-EmailAddress"></a>
The customer’s email address, which has not been specified as a personal or business address.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [EngagementPreferences](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-EngagementPreferences"></a>
Object that defines the preferred methods of engagement, per channel.  
Type: [EngagementPreferences](API_connect-customer-profiles_EngagementPreferences.md) object  
Required: No

 ** [FirstName](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-FirstName"></a>
The customer’s first name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [Gender](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-Gender"></a>
 *This parameter has been deprecated.*   
The gender with which the customer identifies.   
Type: String  
Valid Values: `MALE | FEMALE | UNSPECIFIED`   
Required: No

 ** [GenderString](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-GenderString"></a>
An alternative to `Gender` which accepts any string as input.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [HomePhoneNumber](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-HomePhoneNumber"></a>
The customer’s home phone number.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [LastName](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-LastName"></a>
The customer’s last name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [MailingAddress](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-MailingAddress"></a>
The customer’s mailing address.  
Type: [Address](API_connect-customer-profiles_Address.md) object  
Required: No

 ** [MiddleName](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-MiddleName"></a>
The customer’s middle name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [MobilePhoneNumber](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-MobilePhoneNumber"></a>
The customer’s mobile phone number.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [PartyType](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-PartyType"></a>
 *This parameter has been deprecated.*   
The type of profile used to describe the customer.  
Type: String  
Valid Values: `INDIVIDUAL | BUSINESS | OTHER`   
Required: No

 ** [PartyTypeString](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-PartyTypeString"></a>
An alternative to `PartyType` which accepts any string as input.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [PersonalEmailAddress](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-PersonalEmailAddress"></a>
The customer’s personal email address.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [PhoneNumber](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-PhoneNumber"></a>
The customer’s phone number, which has not been specified as a mobile, home, or business number.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [ProfileType](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-ProfileType"></a>
The type of the profile.  
Type: String  
Valid Values: `ACCOUNT_PROFILE | PROFILE`   
Required: No

 ** [ShippingAddress](#API_connect-customer-profiles_CreateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-request-ShippingAddress"></a>
The customer’s shipping address.  
Type: [Address](API_connect-customer-profiles_Address.md) object  
Required: No

## Response Syntax
<a name="API_connect-customer-profiles_CreateProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ProfileId": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_CreateProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProfileId](#API_connect-customer-profiles_CreateProfile_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateProfile-response-ProfileId"></a>
The unique identifier of a customer profile.  
Type: String  
Pattern: `[a-f0-9]{32}` 

## Errors
<a name="API_connect-customer-profiles_CreateProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_CreateProfile_Examples"></a>

### Example
<a name="API_connect-customer-profiles_CreateProfile_Example_1"></a>

This example illustrates one usage of CreateProfile.

#### Sample Request
<a name="API_connect-customer-profiles_CreateProfile_Example_1_Request"></a>

```
POST /domains/ExampleDomainName/profiles HTTP/1.1

Content-type: application/json
{
   "AccountNumber": "ACCT12344",
   "Address": { 
      "Address1": "123 Sample St",
      "Address2": "Apt 4",
      "Address3": "null",
      "Address4": "null",
      "City": "Seattle",
      "Country": "USA",
      "County": "King",
      "PostalCode": "98011",
      "Province": "",
      "State": "WA"
   },
   "Attributes": { 
      "SSN" : "123-44-3433",
      "LoyaltyPoints" : "3000" 
   },
   "BillingAddress": { 
      "Address1": "789 Sample St",
      "Address2": "Apt 1",
      "City": "Seattle",
      "Country": "USA",
      "County": "King",
      "PostalCode": "98011",
      "Province": "",
      "State": "WA"
   },
   "BirthDate": "07/12/1980",
   "BusinessEmailAddress": "example@amazon.com",
   "BusinessName": "My Awesome Company",
   "BusinessPhoneNumber": "555-334-3389",
   "EmailAddress": "example@gmail.com",
   "FirstName": "John",
   "Gender": "MALE",
   "HomePhoneNumber": "555-334-3344",
   "LastName": "Doe",
   "MailingAddress": { 
      "Address1": "234 Home St",
      "Address2": "Apt 5",
      "City": "Seattle",
      "Country": "USA",
      "County": "King",
      "PostalCode": "98011",
      "Province": "",
      "State": "WA"
   },
   "AdditionalInformation": "High Profile Customer",
   "MiddleName": "",
   "MobilePhoneNumber": "555-334-7777",
   "PartyType": "INDIVIDUAL",
   "PersonalEmailAddress": "email1@gmail.com",
   "PhoneNumber": "",
   "ShippingAddress": { 
      "Address1": "555 A St",
      "Address2": "Suite 100",
      "City": "Seattle",
      "Country": "USA",
      "County": "King",
      "PostalCode": "98011",
      "Province": "",
      "State": "WA"
   }
}
```

#### Sample Response
<a name="API_connect-customer-profiles_CreateProfile_Example_1_Response"></a>

```
Content-type: application/json
{
   "ProfileId" : "3991a7d959d248bb982546b2dEXAMPLE"
}
```

## See Also
<a name="API_connect-customer-profiles_CreateProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateProfile) 

# CreateRecommender
<a name="API_connect-customer-profiles_CreateRecommender"></a>

Creates a recommender

## Request Syntax
<a name="API_connect-customer-profiles_CreateRecommender_RequestSyntax"></a>

```
POST /domains/DomainName/recommenders/RecommenderName HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "RecommenderConfig": { 
      "EventsConfig": { 
         "EventParametersList": [ 
            { 
               "EventType": "string",
               "EventValueThreshold": number
            }
         ]
      },
      "TrainingFrequency": number
   },
   "RecommenderRecipeName": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_CreateRecommender_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_CreateRecommender_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateRecommender-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [RecommenderName](#API_connect-customer-profiles_CreateRecommender_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateRecommender-request-uri-RecommenderName"></a>
The name of the recommender.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_CreateRecommender_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_connect-customer-profiles_CreateRecommender_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateRecommender-request-Description"></a>
The description of the domain object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: No

 ** [RecommenderConfig](#API_connect-customer-profiles_CreateRecommender_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateRecommender-request-RecommenderConfig"></a>
The recommender configuration.  
Type: [RecommenderConfig](API_connect-customer-profiles_RecommenderConfig.md) object  
Required: No

 ** [RecommenderRecipeName](#API_connect-customer-profiles_CreateRecommender_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateRecommender-request-RecommenderRecipeName"></a>
The name of the recommeder recipe.  
Type: String  
Valid Values: `recommended-for-you | similar-items | frequently-paired-items | popular-items | trending-now`   
Required: Yes

 ** [Tags](#API_connect-customer-profiles_CreateRecommender_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateRecommender-request-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_connect-customer-profiles_CreateRecommender_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "RecommenderArn": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-customer-profiles_CreateRecommender_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [RecommenderArn](#API_connect-customer-profiles_CreateRecommender_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateRecommender-response-RecommenderArn"></a>
The ARN of the recommender  
Type: String  
Pattern: `arn:([a-z\d-]+):profile:.*:.*:.+` 

 ** [Tags](#API_connect-customer-profiles_CreateRecommender_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateRecommender-response-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_connect-customer-profiles_CreateRecommender_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_CreateRecommender_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateRecommender) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateRecommender) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateRecommender) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateRecommender) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateRecommender) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateRecommender) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateRecommender) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateRecommender) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateRecommender) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateRecommender) 

# CreateSegmentDefinition
<a name="API_connect-customer-profiles_CreateSegmentDefinition"></a>

Creates a segment definition associated to the given domain.

## Request Syntax
<a name="API_connect-customer-profiles_CreateSegmentDefinition_RequestSyntax"></a>

```
POST /domains/DomainName/segment-definitions/SegmentDefinitionName HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "DisplayName": "string",
   "SegmentGroups": { 
      "Groups": [ 
         { 
            "Dimensions": [ 
               { ... }
            ],
            "SourceSegments": [ 
               { 
                  "SegmentDefinitionName": "string"
               }
            ],
            "SourceType": "string",
            "Type": "string"
         }
      ],
      "Include": "string"
   },
   "SegmentSqlQuery": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_CreateSegmentDefinition_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_CreateSegmentDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentDefinition-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [SegmentDefinitionName](#API_connect-customer-profiles_CreateSegmentDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentDefinition-request-uri-SegmentDefinitionName"></a>
The unique name of the segment definition.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_CreateSegmentDefinition_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_connect-customer-profiles_CreateSegmentDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentDefinition-request-Description"></a>
The description of the segment definition.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4000.  
Required: No

 ** [DisplayName](#API_connect-customer-profiles_CreateSegmentDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentDefinition-request-DisplayName"></a>
The display name of the segment definition.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** [SegmentGroups](#API_connect-customer-profiles_CreateSegmentDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentDefinition-request-SegmentGroups"></a>
Specifies the base segments and dimensions for a segment definition along with their respective relationship.  
Type: [SegmentGroup](API_connect-customer-profiles_SegmentGroup.md) object  
Required: No

 ** [SegmentSqlQuery](#API_connect-customer-profiles_CreateSegmentDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentDefinition-request-SegmentSqlQuery"></a>
The segment SQL query.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50000.  
Required: No

 ** [Tags](#API_connect-customer-profiles_CreateSegmentDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentDefinition-request-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_connect-customer-profiles_CreateSegmentDefinition_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": number,
   "Description": "string",
   "DisplayName": "string",
   "SegmentDefinitionArn": "string",
   "SegmentDefinitionName": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-customer-profiles_CreateSegmentDefinition_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreatedAt](#API_connect-customer-profiles_CreateSegmentDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentDefinition-response-CreatedAt"></a>
The timestamp of when the segment definition was created.  
Type: Timestamp

 ** [Description](#API_connect-customer-profiles_CreateSegmentDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentDefinition-response-Description"></a>
The description of the segment definition.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4000.

 ** [DisplayName](#API_connect-customer-profiles_CreateSegmentDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentDefinition-response-DisplayName"></a>
The display name of the segment definition.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [SegmentDefinitionArn](#API_connect-customer-profiles_CreateSegmentDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentDefinition-response-SegmentDefinitionArn"></a>
The arn of the segment definition.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [SegmentDefinitionName](#API_connect-customer-profiles_CreateSegmentDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentDefinition-response-SegmentDefinitionName"></a>
The name of the segment definition.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [Tags](#API_connect-customer-profiles_CreateSegmentDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentDefinition-response-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_connect-customer-profiles_CreateSegmentDefinition_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_CreateSegmentDefinition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateSegmentDefinition) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateSegmentDefinition) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateSegmentDefinition) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateSegmentDefinition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateSegmentDefinition) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateSegmentDefinition) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateSegmentDefinition) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateSegmentDefinition) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateSegmentDefinition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateSegmentDefinition) 

# CreateSegmentEstimate
<a name="API_connect-customer-profiles_CreateSegmentEstimate"></a>

Creates a segment estimate query.

## Request Syntax
<a name="API_connect-customer-profiles_CreateSegmentEstimate_RequestSyntax"></a>

```
POST /domains/DomainName/segment-estimates HTTP/1.1
Content-type: application/json

{
   "SegmentQuery": { 
      "Groups": [ 
         { 
            "Dimensions": [ 
               { ... }
            ],
            "SourceSegments": [ 
               { 
                  "SegmentDefinitionName": "string"
               }
            ],
            "SourceType": "string",
            "Type": "string"
         }
      ],
      "Include": "string"
   },
   "SegmentSqlQuery": "string"
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_CreateSegmentEstimate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_CreateSegmentEstimate_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentEstimate-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_CreateSegmentEstimate_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [SegmentQuery](#API_connect-customer-profiles_CreateSegmentEstimate_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentEstimate-request-SegmentQuery"></a>
The segment query for calculating a segment estimate.  
Type: [SegmentGroupStructure](API_connect-customer-profiles_SegmentGroupStructure.md) object  
Required: No

 ** [SegmentSqlQuery](#API_connect-customer-profiles_CreateSegmentEstimate_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentEstimate-request-SegmentSqlQuery"></a>
The segment SQL query.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50000.  
Required: No

## Response Syntax
<a name="API_connect-customer-profiles_CreateSegmentEstimate_ResponseSyntax"></a>

```
HTTP/1.1 StatusCode
Content-type: application/json

{
   "DomainName": "string",
   "EstimateId": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_CreateSegmentEstimate_ResponseElements"></a>

If the action is successful, the service sends back the following HTTP response.

 ** [StatusCode](#API_connect-customer-profiles_CreateSegmentEstimate_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentEstimate-response-StatusCode"></a>
The status code for the response.

The following data is returned in JSON format by the service.

 ** [DomainName](#API_connect-customer-profiles_CreateSegmentEstimate_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentEstimate-response-DomainName"></a>
The unique name of the domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [EstimateId](#API_connect-customer-profiles_CreateSegmentEstimate_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentEstimate-response-EstimateId"></a>
A unique identifier for the resource. The value can be passed to `GetSegmentEstimate` to retrieve the result of segment estimate status.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_connect-customer-profiles_CreateSegmentEstimate_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_CreateSegmentEstimate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateSegmentEstimate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateSegmentEstimate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateSegmentEstimate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateSegmentEstimate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateSegmentEstimate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateSegmentEstimate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateSegmentEstimate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateSegmentEstimate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateSegmentEstimate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateSegmentEstimate) 

# CreateSegmentSnapshot
<a name="API_connect-customer-profiles_CreateSegmentSnapshot"></a>

Triggers a job to export a segment to a specified destination.

## Request Syntax
<a name="API_connect-customer-profiles_CreateSegmentSnapshot_RequestSyntax"></a>

```
POST /domains/DomainName/segments/SegmentDefinitionName/snapshots HTTP/1.1
Content-type: application/json

{
   "DataFormat": "string",
   "DestinationUri": "string",
   "EncryptionKey": "string",
   "RoleArn": "string"
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_CreateSegmentSnapshot_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_CreateSegmentSnapshot_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentSnapshot-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [SegmentDefinitionName](#API_connect-customer-profiles_CreateSegmentSnapshot_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentSnapshot-request-uri-SegmentDefinitionName"></a>
The name of the segment definition used in this snapshot request.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_CreateSegmentSnapshot_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [DataFormat](#API_connect-customer-profiles_CreateSegmentSnapshot_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentSnapshot-request-DataFormat"></a>
The format in which the segment will be exported.  
Type: String  
Valid Values: `CSV | JSONL | ORC`   
Required: Yes

 ** [DestinationUri](#API_connect-customer-profiles_CreateSegmentSnapshot_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentSnapshot-request-DestinationUri"></a>
The destination to which the segment will be exported. This field must be provided if the request is not submitted from the Amazon Connect Admin Website.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [EncryptionKey](#API_connect-customer-profiles_CreateSegmentSnapshot_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentSnapshot-request-EncryptionKey"></a>
The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported segment.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [RoleArn](#API_connect-customer-profiles_CreateSegmentSnapshot_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentSnapshot-request-RoleArn"></a>
The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service principal to assume the role for conducting KMS and S3 operations.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `arn:aws:iam:.*:[0-9]+:.*`   
Required: No

## Response Syntax
<a name="API_connect-customer-profiles_CreateSegmentSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "SnapshotId": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_CreateSegmentSnapshot_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [SnapshotId](#API_connect-customer-profiles_CreateSegmentSnapshot_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateSegmentSnapshot-response-SnapshotId"></a>
The unique identifier of the segment snapshot.  
Type: String  
Pattern: `[a-f0-9]{32}` 

## Errors
<a name="API_connect-customer-profiles_CreateSegmentSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_CreateSegmentSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateSegmentSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateSegmentSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateSegmentSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateSegmentSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateSegmentSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateSegmentSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateSegmentSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateSegmentSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateSegmentSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateSegmentSnapshot) 

# CreateUploadJob
<a name="API_connect-customer-profiles_CreateUploadJob"></a>

Creates an Upload job to ingest data for segment imports. The metadata is created for the job with the provided field mapping and unique key. 

## Request Syntax
<a name="API_connect-customer-profiles_CreateUploadJob_RequestSyntax"></a>

```
POST /domains/DomainName/upload-jobs HTTP/1.1
Content-type: application/json

{
   "DataExpiry": number,
   "DisplayName": "string",
   "Fields": { 
      "string" : { 
         "ContentType": "string",
         "Source": "string",
         "Target": "string"
      }
   },
   "UniqueKey": "string"
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_CreateUploadJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_CreateUploadJob_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateUploadJob-request-uri-DomainName"></a>
The unique name of the domain. Domain should be exists for the upload job to be created.   
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_CreateUploadJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [DataExpiry](#API_connect-customer-profiles_CreateUploadJob_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateUploadJob-request-DataExpiry"></a>
The expiry duration for the profiles ingested with the job. If not provided, the system default of 2 weeks is used.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1098.  
Required: No

 ** [DisplayName](#API_connect-customer-profiles_CreateUploadJob_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateUploadJob-request-DisplayName"></a>
The unique name of the upload job. Could be a file name to identify the upload job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** [Fields](#API_connect-customer-profiles_CreateUploadJob_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateUploadJob-request-Fields"></a>
The mapping between CSV Columns and Profile Object attributes. A map of the name and ObjectType field.  
Type: String to [ObjectTypeField](API_connect-customer-profiles_ObjectTypeField.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Key Pattern: `^[a-zA-Z0-9_.-]+$`   
Required: Yes

 ** [UniqueKey](#API_connect-customer-profiles_CreateUploadJob_RequestSyntax) **   <a name="connect-connect-customer-profiles_CreateUploadJob-request-UniqueKey"></a>
The unique key columns for de-duping the profiles used to map data to the profile.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_CreateUploadJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "JobId": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_CreateUploadJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [JobId](#API_connect-customer-profiles_CreateUploadJob_ResponseSyntax) **   <a name="connect-connect-customer-profiles_CreateUploadJob-response-JobId"></a>
The unique identifier for the created upload job.   
Type: String  
Pattern: `[a-f0-9]{32}` 

## Errors
<a name="API_connect-customer-profiles_CreateUploadJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_CreateUploadJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/CreateUploadJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/CreateUploadJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/CreateUploadJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/CreateUploadJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/CreateUploadJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/CreateUploadJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/CreateUploadJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/CreateUploadJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/CreateUploadJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/CreateUploadJob) 

# DeleteCalculatedAttributeDefinition
<a name="API_connect-customer-profiles_DeleteCalculatedAttributeDefinition"></a>

Deletes an existing calculated attribute definition. Note that deleting a default calculated attribute is possible, however once deleted, you will be unable to undo that action and will need to recreate it on your own using the CreateCalculatedAttributeDefinition API if you want it back.

## Request Syntax
<a name="API_connect-customer-profiles_DeleteCalculatedAttributeDefinition_RequestSyntax"></a>

```
DELETE /domains/DomainName/calculated-attributes/CalculatedAttributeName HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_DeleteCalculatedAttributeDefinition_RequestParameters"></a>

The request uses the following URI parameters.

 ** [CalculatedAttributeName](#API_connect-customer-profiles_DeleteCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteCalculatedAttributeDefinition-request-uri-CalculatedAttributeName"></a>
The unique name of the calculated attribute.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: Yes

 ** [DomainName](#API_connect-customer-profiles_DeleteCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteCalculatedAttributeDefinition-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_DeleteCalculatedAttributeDefinition_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_DeleteCalculatedAttributeDefinition_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-customer-profiles_DeleteCalculatedAttributeDefinition_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-customer-profiles_DeleteCalculatedAttributeDefinition_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_DeleteCalculatedAttributeDefinition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteCalculatedAttributeDefinition) 

# DeleteDomain
<a name="API_connect-customer-profiles_DeleteDomain"></a>

Deletes a specific domain and all of its customer data, such as customer profile attributes and their related objects.

## Request Syntax
<a name="API_connect-customer-profiles_DeleteDomain_RequestSyntax"></a>

```
DELETE /domains/DomainName HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_DeleteDomain_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_DeleteDomain_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteDomain-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_DeleteDomain_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_DeleteDomain_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Message": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_DeleteDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Message](#API_connect-customer-profiles_DeleteDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_DeleteDomain-response-Message"></a>
A message that indicates the delete request is done.  
Type: String

## Errors
<a name="API_connect-customer-profiles_DeleteDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_DeleteDomain_Examples"></a>

### Example
<a name="API_connect-customer-profiles_DeleteDomain_Example_1"></a>

This example illustrates one usage of DeleteDomain.

#### Sample Request
<a name="API_connect-customer-profiles_DeleteDomain_Example_1_Request"></a>

```
DELETE /v1/domains/ExampleDomainName HTTP/1.1
```

#### Sample Response
<a name="API_connect-customer-profiles_DeleteDomain_Example_1_Response"></a>

```
Content-type: application/json
{
   "Message": "Domain Deleted"
}
```

## See Also
<a name="API_connect-customer-profiles_DeleteDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteDomain) 

# DeleteDomainLayout
<a name="API_connect-customer-profiles_DeleteDomainLayout"></a>

Deletes the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

## Request Syntax
<a name="API_connect-customer-profiles_DeleteDomainLayout_RequestSyntax"></a>

```
DELETE /domains/DomainName/layouts/LayoutDefinitionName HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_DeleteDomainLayout_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_DeleteDomainLayout_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteDomainLayout-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [LayoutDefinitionName](#API_connect-customer-profiles_DeleteDomainLayout_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteDomainLayout-request-uri-LayoutDefinitionName"></a>
The unique name of the layout.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_DeleteDomainLayout_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_DeleteDomainLayout_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Message": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_DeleteDomainLayout_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Message](#API_connect-customer-profiles_DeleteDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_DeleteDomainLayout-response-Message"></a>
A message that indicates the delete request is done.  
Type: String

## Errors
<a name="API_connect-customer-profiles_DeleteDomainLayout_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_DeleteDomainLayout_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteDomainLayout) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteDomainLayout) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteDomainLayout) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteDomainLayout) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteDomainLayout) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteDomainLayout) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteDomainLayout) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteDomainLayout) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteDomainLayout) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteDomainLayout) 

# DeleteDomainObjectType
<a name="API_connect-customer-profiles_DeleteDomainObjectType"></a>

Delete a DomainObjectType for the given Domain and ObjectType name.

## Request Syntax
<a name="API_connect-customer-profiles_DeleteDomainObjectType_RequestSyntax"></a>

```
DELETE /domains/DomainName/domain-object-types/ObjectTypeName HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_DeleteDomainObjectType_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_DeleteDomainObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteDomainObjectType-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [ObjectTypeName](#API_connect-customer-profiles_DeleteDomainObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteDomainObjectType-request-uri-ObjectTypeName"></a>
The unique name of the domain object type.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_DeleteDomainObjectType_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_DeleteDomainObjectType_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-customer-profiles_DeleteDomainObjectType_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-customer-profiles_DeleteDomainObjectType_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_DeleteDomainObjectType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteDomainObjectType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteDomainObjectType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteDomainObjectType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteDomainObjectType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteDomainObjectType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteDomainObjectType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteDomainObjectType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteDomainObjectType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteDomainObjectType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteDomainObjectType) 

# DeleteEventStream
<a name="API_connect-customer-profiles_DeleteEventStream"></a>

Disables and deletes the specified event stream.

## Request Syntax
<a name="API_connect-customer-profiles_DeleteEventStream_RequestSyntax"></a>

```
DELETE /domains/DomainName/event-streams/EventStreamName HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_DeleteEventStream_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_DeleteEventStream_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteEventStream-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [EventStreamName](#API_connect-customer-profiles_DeleteEventStream_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteEventStream-request-uri-EventStreamName"></a>
The name of the event stream  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_DeleteEventStream_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_DeleteEventStream_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-customer-profiles_DeleteEventStream_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-customer-profiles_DeleteEventStream_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_DeleteEventStream_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteEventStream) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteEventStream) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteEventStream) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteEventStream) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteEventStream) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteEventStream) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteEventStream) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteEventStream) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteEventStream) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteEventStream) 

# DeleteEventTrigger
<a name="API_connect-customer-profiles_DeleteEventTrigger"></a>

Disable and deletes the Event Trigger.

**Note**  
You cannot delete an Event Trigger with an active Integration associated.

## Request Syntax
<a name="API_connect-customer-profiles_DeleteEventTrigger_RequestSyntax"></a>

```
DELETE /domains/DomainName/event-triggers/EventTriggerName HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_DeleteEventTrigger_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_DeleteEventTrigger_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteEventTrigger-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [EventTriggerName](#API_connect-customer-profiles_DeleteEventTrigger_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteEventTrigger-request-uri-EventTriggerName"></a>
The unique name of the event trigger.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_DeleteEventTrigger_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_DeleteEventTrigger_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Message": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_DeleteEventTrigger_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Message](#API_connect-customer-profiles_DeleteEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_DeleteEventTrigger-response-Message"></a>
A message that indicates the delete request is done.  
Type: String

## Errors
<a name="API_connect-customer-profiles_DeleteEventTrigger_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_DeleteEventTrigger_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteEventTrigger) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteEventTrigger) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteEventTrigger) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteEventTrigger) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteEventTrigger) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteEventTrigger) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteEventTrigger) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteEventTrigger) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteEventTrigger) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteEventTrigger) 

# DeleteIntegration
<a name="API_connect-customer-profiles_DeleteIntegration"></a>

Removes an integration from a specific domain.

## Request Syntax
<a name="API_connect-customer-profiles_DeleteIntegration_RequestSyntax"></a>

```
POST /domains/DomainName/integrations/delete HTTP/1.1
Content-type: application/json

{
   "Uri": "string"
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_DeleteIntegration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_DeleteIntegration_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteIntegration-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_DeleteIntegration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Uri](#API_connect-customer-profiles_DeleteIntegration_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteIntegration-request-Uri"></a>
The URI of the S3 bucket or any other type of data source.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_DeleteIntegration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Message": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_DeleteIntegration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Message](#API_connect-customer-profiles_DeleteIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_DeleteIntegration-response-Message"></a>
A message that indicates the delete request is done.  
Type: String

## Errors
<a name="API_connect-customer-profiles_DeleteIntegration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_DeleteIntegration_Examples"></a>

### Example
<a name="API_connect-customer-profiles_DeleteIntegration_Example_1"></a>

This example illustrates one usage of DeleteIntegration.

#### Sample Request
<a name="API_connect-customer-profiles_DeleteIntegration_Example_1_Request"></a>

```
POST /domains/{DomainName}/integrations/delete HTTP/1.1
            
{
   "Uri": "arn:aws:sqs:us-east-1:123456789012:URIOfIntegration1"
}
```

#### Sample Response
<a name="API_connect-customer-profiles_DeleteIntegration_Example_1_Response"></a>

```
Content-type: application/json
{
   "Message": "Deleted"
}
```

## See Also
<a name="API_connect-customer-profiles_DeleteIntegration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteIntegration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteIntegration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteIntegration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteIntegration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteIntegration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteIntegration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteIntegration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteIntegration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteIntegration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteIntegration) 

# DeleteProfile
<a name="API_connect-customer-profiles_DeleteProfile"></a>

Deletes the standard customer profile and all data pertaining to the profile.

## Request Syntax
<a name="API_connect-customer-profiles_DeleteProfile_RequestSyntax"></a>

```
POST /domains/DomainName/profiles/delete HTTP/1.1
Content-type: application/json

{
   "ProfileId": "string"
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_DeleteProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_DeleteProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteProfile-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_DeleteProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ProfileId](#API_connect-customer-profiles_DeleteProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteProfile-request-ProfileId"></a>
The unique identifier of a customer profile.  
Type: String  
Pattern: `[a-f0-9]{32}`   
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_DeleteProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Message": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_DeleteProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Message](#API_connect-customer-profiles_DeleteProfile_ResponseSyntax) **   <a name="connect-connect-customer-profiles_DeleteProfile-response-Message"></a>
A message that indicates the delete request is done.  
Type: String

## Errors
<a name="API_connect-customer-profiles_DeleteProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_DeleteProfile_Examples"></a>

### Example
<a name="API_connect-customer-profiles_DeleteProfile_Example_1"></a>

This example illustrates one usage of DeleteProfile.

#### Sample Request
<a name="API_connect-customer-profiles_DeleteProfile_Example_1_Request"></a>

```
POST /domains/ExampleDomainName/profiles/delete HTTP/1.1

Content-type: application/json
{
   "ProfileId": "3991a7d959d248bba82546b2dEXAMPLE"
}
```

#### Sample Response
<a name="API_connect-customer-profiles_DeleteProfile_Example_1_Response"></a>

```
Content-type: application/json 
{
  "Message": "OK"
}
```

## See Also
<a name="API_connect-customer-profiles_DeleteProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteProfile) 

# DeleteProfileKey
<a name="API_connect-customer-profiles_DeleteProfileKey"></a>

Removes a searchable key from a customer profile.

## Request Syntax
<a name="API_connect-customer-profiles_DeleteProfileKey_RequestSyntax"></a>

```
POST /domains/DomainName/profiles/keys/delete HTTP/1.1
Content-type: application/json

{
   "KeyName": "string",
   "ProfileId": "string",
   "Values": [ "string" ]
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_DeleteProfileKey_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_DeleteProfileKey_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteProfileKey-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_DeleteProfileKey_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [KeyName](#API_connect-customer-profiles_DeleteProfileKey_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteProfileKey-request-KeyName"></a>
A searchable identifier of a customer profile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [ProfileId](#API_connect-customer-profiles_DeleteProfileKey_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteProfileKey-request-ProfileId"></a>
The unique identifier of a customer profile.  
Type: String  
Pattern: `[a-f0-9]{32}`   
Required: Yes

 ** [Values](#API_connect-customer-profiles_DeleteProfileKey_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteProfileKey-request-Values"></a>
A list of key values.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_DeleteProfileKey_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Message": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_DeleteProfileKey_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Message](#API_connect-customer-profiles_DeleteProfileKey_ResponseSyntax) **   <a name="connect-connect-customer-profiles_DeleteProfileKey-response-Message"></a>
A message that indicates the delete request is done.  
Type: String

## Errors
<a name="API_connect-customer-profiles_DeleteProfileKey_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_DeleteProfileKey_Examples"></a>

### Example
<a name="API_connect-customer-profiles_DeleteProfileKey_Example_1"></a>

This example illustrates one usage of DeleteProfileKey.

#### Sample Request
<a name="API_connect-customer-profiles_DeleteProfileKey_Example_1_Request"></a>

```
POST /domains/ExampleDomainName/profiles/keys/delete HTTP/1.1

Content-type: application/json
{
   "KeyName": "_phone",
   "ProfileId": "3991a7d959d248bba82546b2dEXAMPLE",
   "Values": [ "555-445-3344" ]
}
```

#### Sample Response
<a name="API_connect-customer-profiles_DeleteProfileKey_Example_1_Response"></a>

```
Content-type: application/json 
{
  "Message": "OK"
}
```

## See Also
<a name="API_connect-customer-profiles_DeleteProfileKey_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteProfileKey) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteProfileKey) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteProfileKey) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteProfileKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteProfileKey) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteProfileKey) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteProfileKey) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteProfileKey) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteProfileKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteProfileKey) 

# DeleteProfileObject
<a name="API_connect-customer-profiles_DeleteProfileObject"></a>

Removes an object associated with a profile of a given ProfileObjectType.

## Request Syntax
<a name="API_connect-customer-profiles_DeleteProfileObject_RequestSyntax"></a>

```
POST /domains/DomainName/profiles/objects/delete HTTP/1.1
Content-type: application/json

{
   "ObjectTypeName": "string",
   "ProfileId": "string",
   "ProfileObjectUniqueKey": "string"
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_DeleteProfileObject_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_DeleteProfileObject_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteProfileObject-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_DeleteProfileObject_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ObjectTypeName](#API_connect-customer-profiles_DeleteProfileObject_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteProfileObject-request-ObjectTypeName"></a>
The name of the profile object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: Yes

 ** [ProfileId](#API_connect-customer-profiles_DeleteProfileObject_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteProfileObject-request-ProfileId"></a>
The unique identifier of a customer profile.  
Type: String  
Pattern: `[a-f0-9]{32}`   
Required: Yes

 ** [ProfileObjectUniqueKey](#API_connect-customer-profiles_DeleteProfileObject_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteProfileObject-request-ProfileObjectUniqueKey"></a>
The unique identifier of the profile object generated by the service.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_DeleteProfileObject_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Message": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_DeleteProfileObject_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Message](#API_connect-customer-profiles_DeleteProfileObject_ResponseSyntax) **   <a name="connect-connect-customer-profiles_DeleteProfileObject-response-Message"></a>
A message that indicates the delete request is done.  
Type: String

## Errors
<a name="API_connect-customer-profiles_DeleteProfileObject_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_DeleteProfileObject_Examples"></a>

### Example
<a name="API_connect-customer-profiles_DeleteProfileObject_Example_1"></a>

This example illustrates one usage of DeleteProfileObject.

#### Sample Request
<a name="API_connect-customer-profiles_DeleteProfileObject_Example_1_Request"></a>

```
POST /domains/DomainName/profiles/objects/delete HTTP/1.1

Content-type: application/json
{
   "ObjectTypeName": "MyCustomObjectName",
   "ProfileId": "3991a7d959d248bba82546b2dEXAMPLE",
   "ProfileObjectUniqueKey": "UniqueKeyOfTheProfileObject"
}
```

#### Sample Response
<a name="API_connect-customer-profiles_DeleteProfileObject_Example_1_Response"></a>

```
Content-type: application/json
{
   "Message": "OK"
}
```

## See Also
<a name="API_connect-customer-profiles_DeleteProfileObject_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteProfileObject) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteProfileObject) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteProfileObject) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteProfileObject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteProfileObject) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteProfileObject) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteProfileObject) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteProfileObject) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteProfileObject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteProfileObject) 

# DeleteProfileObjectType
<a name="API_connect-customer-profiles_DeleteProfileObjectType"></a>

Removes a ProfileObjectType from a specific domain as well as removes all the ProfileObjects of that type. It also disables integrations from this specific ProfileObjectType. In addition, it scrubs all of the fields of the standard profile that were populated from this ProfileObjectType.

## Request Syntax
<a name="API_connect-customer-profiles_DeleteProfileObjectType_RequestSyntax"></a>

```
DELETE /domains/DomainName/object-types/ObjectTypeName HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_DeleteProfileObjectType_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_DeleteProfileObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteProfileObjectType-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [ObjectTypeName](#API_connect-customer-profiles_DeleteProfileObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteProfileObjectType-request-uri-ObjectTypeName"></a>
The name of the profile object type.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_DeleteProfileObjectType_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_DeleteProfileObjectType_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Message": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_DeleteProfileObjectType_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Message](#API_connect-customer-profiles_DeleteProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_DeleteProfileObjectType-response-Message"></a>
A message that indicates the delete request is done.  
Type: String

## Errors
<a name="API_connect-customer-profiles_DeleteProfileObjectType_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_DeleteProfileObjectType_Examples"></a>

### Example
<a name="API_connect-customer-profiles_DeleteProfileObjectType_Example_1"></a>

This example illustrates one usage of DeleteProfileObjectType.

#### Sample Request
<a name="API_connect-customer-profiles_DeleteProfileObjectType_Example_1_Request"></a>

```
DELETE /domains/ExampleDomainName/object-types/MyCustomObjectTypeName HTTP/1.1
```

#### Sample Response
<a name="API_connect-customer-profiles_DeleteProfileObjectType_Example_1_Response"></a>

```
Content-type: application/json
{
   "Message": "Deleted"
}
```

## See Also
<a name="API_connect-customer-profiles_DeleteProfileObjectType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteProfileObjectType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteProfileObjectType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteProfileObjectType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteProfileObjectType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteProfileObjectType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteProfileObjectType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteProfileObjectType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteProfileObjectType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteProfileObjectType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteProfileObjectType) 

# DeleteRecommender
<a name="API_connect-customer-profiles_DeleteRecommender"></a>

Deletes a recommender.

## Request Syntax
<a name="API_connect-customer-profiles_DeleteRecommender_RequestSyntax"></a>

```
DELETE /domains/DomainName/recommenders/RecommenderName HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_DeleteRecommender_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_DeleteRecommender_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteRecommender-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [RecommenderName](#API_connect-customer-profiles_DeleteRecommender_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteRecommender-request-uri-RecommenderName"></a>
The recommender name.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_DeleteRecommender_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_DeleteRecommender_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-customer-profiles_DeleteRecommender_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-customer-profiles_DeleteRecommender_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_DeleteRecommender_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteRecommender) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteRecommender) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteRecommender) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteRecommender) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteRecommender) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteRecommender) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteRecommender) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteRecommender) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteRecommender) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteRecommender) 

# DeleteSegmentDefinition
<a name="API_connect-customer-profiles_DeleteSegmentDefinition"></a>

Deletes a segment definition from the domain.

## Request Syntax
<a name="API_connect-customer-profiles_DeleteSegmentDefinition_RequestSyntax"></a>

```
DELETE /domains/DomainName/segment-definitions/SegmentDefinitionName HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_DeleteSegmentDefinition_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_DeleteSegmentDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteSegmentDefinition-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [SegmentDefinitionName](#API_connect-customer-profiles_DeleteSegmentDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteSegmentDefinition-request-uri-SegmentDefinitionName"></a>
The unique name of the segment definition.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_DeleteSegmentDefinition_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_DeleteSegmentDefinition_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Message": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_DeleteSegmentDefinition_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Message](#API_connect-customer-profiles_DeleteSegmentDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_DeleteSegmentDefinition-response-Message"></a>
A message that indicates the delete request is done.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.

## Errors
<a name="API_connect-customer-profiles_DeleteSegmentDefinition_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_DeleteSegmentDefinition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteSegmentDefinition) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteSegmentDefinition) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteSegmentDefinition) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteSegmentDefinition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteSegmentDefinition) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteSegmentDefinition) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteSegmentDefinition) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteSegmentDefinition) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteSegmentDefinition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteSegmentDefinition) 

# DeleteWorkflow
<a name="API_connect-customer-profiles_DeleteWorkflow"></a>

Deletes the specified workflow and all its corresponding resources. This is an async process.

## Request Syntax
<a name="API_connect-customer-profiles_DeleteWorkflow_RequestSyntax"></a>

```
DELETE /domains/DomainName/workflows/WorkflowId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_DeleteWorkflow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_DeleteWorkflow_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteWorkflow-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [WorkflowId](#API_connect-customer-profiles_DeleteWorkflow_RequestSyntax) **   <a name="connect-connect-customer-profiles_DeleteWorkflow-request-uri-WorkflowId"></a>
Unique identifier for the workflow.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_DeleteWorkflow_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_DeleteWorkflow_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-customer-profiles_DeleteWorkflow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-customer-profiles_DeleteWorkflow_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_DeleteWorkflow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DeleteWorkflow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DeleteWorkflow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DeleteWorkflow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DeleteWorkflow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DeleteWorkflow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DeleteWorkflow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DeleteWorkflow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DeleteWorkflow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DeleteWorkflow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DeleteWorkflow) 

# DetectProfileObjectType
<a name="API_connect-customer-profiles_DetectProfileObjectType"></a>

The process of detecting profile object type mapping by using given objects.

## Request Syntax
<a name="API_connect-customer-profiles_DetectProfileObjectType_RequestSyntax"></a>

```
POST /domains/DomainName/detect/object-types HTTP/1.1
Content-type: application/json

{
   "Objects": [ "string" ]
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_DetectProfileObjectType_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_DetectProfileObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_DetectProfileObjectType-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_DetectProfileObjectType_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Objects](#API_connect-customer-profiles_DetectProfileObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_DetectProfileObjectType-request-Objects"></a>
A string that is serialized from a JSON object.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 256000.  
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_DetectProfileObjectType_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DetectedProfileObjectTypes": [ 
      { 
         "Fields": { 
            "string" : { 
               "ContentType": "string",
               "Source": "string",
               "Target": "string"
            }
         },
         "Keys": { 
            "string" : [ 
               { 
                  "FieldNames": [ "string" ],
                  "StandardIdentifiers": [ "string" ]
               }
            ]
         },
         "SourceLastUpdatedTimestampFormat": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-customer-profiles_DetectProfileObjectType_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DetectedProfileObjectTypes](#API_connect-customer-profiles_DetectProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_DetectProfileObjectType-response-DetectedProfileObjectTypes"></a>
Detected `ProfileObjectType` mappings from given objects. A maximum of one mapping is supported.  
Type: Array of [DetectedProfileObjectType](API_connect-customer-profiles_DetectedProfileObjectType.md) objects

## Errors
<a name="API_connect-customer-profiles_DetectProfileObjectType_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_DetectProfileObjectType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/DetectProfileObjectType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/DetectProfileObjectType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/DetectProfileObjectType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/DetectProfileObjectType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/DetectProfileObjectType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/DetectProfileObjectType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/DetectProfileObjectType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/DetectProfileObjectType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/DetectProfileObjectType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/DetectProfileObjectType) 

# GetAutoMergingPreview
<a name="API_connect-customer-profiles_GetAutoMergingPreview"></a>

Tests the auto-merging settings of your Identity Resolution Job without merging your data. It randomly selects a sample of matching groups from the existing matching results, and applies the automerging settings that you provided. You can then view the number of profiles in the sample, the number of matches, and the number of profiles identified to be merged. This enables you to evaluate the accuracy of the attributes in your matching list. 

You can't view which profiles are matched and would be merged.

**Important**  
We strongly recommend you use this API to do a dry run of the automerging process before running the Identity Resolution Job. Include **at least** two matching attributes. If your matching list includes too few attributes (such as only `FirstName` or only `LastName`), there may be a large number of matches. This increases the chances of erroneous merges.

## Request Syntax
<a name="API_connect-customer-profiles_GetAutoMergingPreview_RequestSyntax"></a>

```
POST /domains/DomainName/identity-resolution-jobs/auto-merging-preview HTTP/1.1
Content-type: application/json

{
   "ConflictResolution": { 
      "ConflictResolvingModel": "string",
      "SourceName": "string"
   },
   "Consolidation": { 
      "MatchingAttributesList": [ 
         [ "string" ]
      ]
   },
   "MinAllowedConfidenceScoreForMerging": number
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetAutoMergingPreview_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_GetAutoMergingPreview_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetAutoMergingPreview-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetAutoMergingPreview_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ConflictResolution](#API_connect-customer-profiles_GetAutoMergingPreview_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetAutoMergingPreview-request-ConflictResolution"></a>
How the auto-merging process should resolve conflicts between different profiles.  
Type: [ConflictResolution](API_connect-customer-profiles_ConflictResolution.md) object  
Required: Yes

 ** [Consolidation](#API_connect-customer-profiles_GetAutoMergingPreview_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetAutoMergingPreview-request-Consolidation"></a>
A list of matching attributes that represent matching criteria.  
Type: [Consolidation](API_connect-customer-profiles_Consolidation.md) object  
Required: Yes

 ** [MinAllowedConfidenceScoreForMerging](#API_connect-customer-profiles_GetAutoMergingPreview_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetAutoMergingPreview-request-MinAllowedConfidenceScoreForMerging"></a>
Minimum confidence score required for profiles within a matching group to be merged during the auto-merge process.  
Type: Double  
Valid Range: Minimum value of 0.0. Maximum value of 1.0.  
Required: No

## Response Syntax
<a name="API_connect-customer-profiles_GetAutoMergingPreview_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DomainName": "string",
   "NumberOfMatchesInSample": number,
   "NumberOfProfilesInSample": number,
   "NumberOfProfilesWillBeMerged": number
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetAutoMergingPreview_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DomainName](#API_connect-customer-profiles_GetAutoMergingPreview_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetAutoMergingPreview-response-DomainName"></a>
The unique name of the domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [NumberOfMatchesInSample](#API_connect-customer-profiles_GetAutoMergingPreview_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetAutoMergingPreview-response-NumberOfMatchesInSample"></a>
The number of match groups in the domain that have been reviewed in this preview dry run.  
Type: Long

 ** [NumberOfProfilesInSample](#API_connect-customer-profiles_GetAutoMergingPreview_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetAutoMergingPreview-response-NumberOfProfilesInSample"></a>
The number of profiles found in this preview dry run.  
Type: Long

 ** [NumberOfProfilesWillBeMerged](#API_connect-customer-profiles_GetAutoMergingPreview_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetAutoMergingPreview-response-NumberOfProfilesWillBeMerged"></a>
The number of profiles that would be merged if this wasn't a preview dry run.  
Type: Long

## Errors
<a name="API_connect-customer-profiles_GetAutoMergingPreview_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetAutoMergingPreview_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetAutoMergingPreview) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetAutoMergingPreview) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetAutoMergingPreview) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetAutoMergingPreview) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetAutoMergingPreview) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetAutoMergingPreview) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetAutoMergingPreview) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetAutoMergingPreview) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetAutoMergingPreview) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetAutoMergingPreview) 

# GetCalculatedAttributeDefinition
<a name="API_connect-customer-profiles_GetCalculatedAttributeDefinition"></a>

Provides more information on a calculated attribute definition for Customer Profiles.

## Request Syntax
<a name="API_connect-customer-profiles_GetCalculatedAttributeDefinition_RequestSyntax"></a>

```
GET /domains/DomainName/calculated-attributes/CalculatedAttributeName HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetCalculatedAttributeDefinition_RequestParameters"></a>

The request uses the following URI parameters.

 ** [CalculatedAttributeName](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeDefinition-request-uri-CalculatedAttributeName"></a>
The unique name of the calculated attribute.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: Yes

 ** [DomainName](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeDefinition-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetCalculatedAttributeDefinition_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AttributeDetails": { 
      "Attributes": [ 
         { 
            "Name": "string"
         }
      ],
      "Expression": "string"
   },
   "CalculatedAttributeName": "string",
   "Conditions": { 
      "ObjectCount": number,
      "Range": { 
         "TimestampFormat": "string",
         "TimestampSource": "string",
         "Unit": "string",
         "Value": number,
         "ValueRange": { 
            "End": number,
            "Start": number
         }
      },
      "Threshold": { 
         "Operator": "string",
         "Value": "string"
      }
   },
   "CreatedAt": number,
   "Description": "string",
   "DisplayName": "string",
   "Filter": { 
      "Groups": [ 
         { 
            "Dimensions": [ 
               { 
                  "Attributes": { 
                     "string" : { 
                        "DimensionType": "string",
                        "Values": [ "string" ]
                     }
                  }
               }
            ],
            "Type": "string"
         }
      ],
      "Include": "string"
   },
   "LastUpdatedAt": number,
   "Readiness": { 
      "Message": "string",
      "ProgressPercentage": number
   },
   "Statistic": "string",
   "Status": "string",
   "Tags": { 
      "string" : "string" 
   },
   "UseHistoricalData": boolean
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AttributeDetails](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeDefinition-response-AttributeDetails"></a>
Mathematical expression and a list of attribute items specified in that expression.  
Type: [AttributeDetails](API_connect-customer-profiles_AttributeDetails.md) object

 ** [CalculatedAttributeName](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeDefinition-response-CalculatedAttributeName"></a>
The unique name of the calculated attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` 

 ** [Conditions](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeDefinition-response-Conditions"></a>
The conditions including range, object count, and threshold for the calculated attribute.  
Type: [Conditions](API_connect-customer-profiles_Conditions.md) object

 ** [CreatedAt](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeDefinition-response-CreatedAt"></a>
The timestamp of when the calculated attribute definition was created.  
Type: Timestamp

 ** [Description](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeDefinition-response-Description"></a>
The description of the calculated attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.

 ** [DisplayName](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeDefinition-response-DisplayName"></a>
The display name of the calculated attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$` 

 ** [Filter](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeDefinition-response-Filter"></a>
The filter assigned to this calculated attribute definition.  
Type: [Filter](API_connect-customer-profiles_Filter.md) object

 ** [LastUpdatedAt](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeDefinition-response-LastUpdatedAt"></a>
The timestamp of when the calculated attribute definition was most recently edited.  
Type: Timestamp

 ** [Readiness](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeDefinition-response-Readiness"></a>
Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected.  
Type: [Readiness](API_connect-customer-profiles_Readiness.md) object

 ** [Statistic](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeDefinition-response-Statistic"></a>
The aggregation operation to perform for the calculated attribute.  
Type: String  
Valid Values: `FIRST_OCCURRENCE | LAST_OCCURRENCE | COUNT | SUM | MINIMUM | MAXIMUM | AVERAGE | MAX_OCCURRENCE` 

 ** [Status](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeDefinition-response-Status"></a>
Status of the Calculated Attribute creation (whether all historical data has been indexed).  
Type: String  
Valid Values: `PREPARING | IN_PROGRESS | COMPLETED | FAILED` 

 ** [Tags](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeDefinition-response-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

 ** [UseHistoricalData](#API_connect-customer-profiles_GetCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeDefinition-response-UseHistoricalData"></a>
Whether historical data ingested before the Calculated Attribute was created should be included in calculations.  
Type: Boolean

## Errors
<a name="API_connect-customer-profiles_GetCalculatedAttributeDefinition_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetCalculatedAttributeDefinition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetCalculatedAttributeDefinition) 

# GetCalculatedAttributeForProfile
<a name="API_connect-customer-profiles_GetCalculatedAttributeForProfile"></a>

Retrieve a calculated attribute for a customer profile.

## Request Syntax
<a name="API_connect-customer-profiles_GetCalculatedAttributeForProfile_RequestSyntax"></a>

```
GET /domains/DomainName/profile/ProfileId/calculated-attributes/CalculatedAttributeName HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetCalculatedAttributeForProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [CalculatedAttributeName](#API_connect-customer-profiles_GetCalculatedAttributeForProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeForProfile-request-uri-CalculatedAttributeName"></a>
The unique name of the calculated attribute.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: Yes

 ** [DomainName](#API_connect-customer-profiles_GetCalculatedAttributeForProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeForProfile-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [ProfileId](#API_connect-customer-profiles_GetCalculatedAttributeForProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeForProfile-request-uri-ProfileId"></a>
The unique identifier of a customer profile.  
Pattern: `[a-f0-9]{32}`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetCalculatedAttributeForProfile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_GetCalculatedAttributeForProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CalculatedAttributeName": "string",
   "DisplayName": "string",
   "IsDataPartial": "string",
   "LastObjectTimestamp": number,
   "Value": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetCalculatedAttributeForProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CalculatedAttributeName](#API_connect-customer-profiles_GetCalculatedAttributeForProfile_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeForProfile-response-CalculatedAttributeName"></a>
The unique name of the calculated attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` 

 ** [DisplayName](#API_connect-customer-profiles_GetCalculatedAttributeForProfile_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeForProfile-response-DisplayName"></a>
The display name of the calculated attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$` 

 ** [IsDataPartial](#API_connect-customer-profiles_GetCalculatedAttributeForProfile_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeForProfile-response-IsDataPartial"></a>
Indicates whether the calculated attribute’s value is based on partial data. If data is partial, it is set to true.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [LastObjectTimestamp](#API_connect-customer-profiles_GetCalculatedAttributeForProfile_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeForProfile-response-LastObjectTimestamp"></a>
The timestamp of the newest object included in the calculated attribute calculation.  
Type: Timestamp

 ** [Value](#API_connect-customer-profiles_GetCalculatedAttributeForProfile_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetCalculatedAttributeForProfile-response-Value"></a>
The value of the calculated attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_connect-customer-profiles_GetCalculatedAttributeForProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetCalculatedAttributeForProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetCalculatedAttributeForProfile) 

# GetDomain
<a name="API_connect-customer-profiles_GetDomain"></a>

Returns information about a specific domain.

## Request Syntax
<a name="API_connect-customer-profiles_GetDomain_RequestSyntax"></a>

```
GET /domains/DomainName HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetDomain_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_GetDomain_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetDomain-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetDomain_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_GetDomain_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": number,
   "DataStore": { 
      "Enabled": boolean,
      "Readiness": { 
         "Message": "string",
         "ProgressPercentage": number
      }
   },
   "DeadLetterQueueUrl": "string",
   "DefaultEncryptionKey": "string",
   "DefaultExpirationDays": number,
   "DomainName": "string",
   "LastUpdatedAt": number,
   "Matching": { 
      "AutoMerging": { 
         "ConflictResolution": { 
            "ConflictResolvingModel": "string",
            "SourceName": "string"
         },
         "Consolidation": { 
            "MatchingAttributesList": [ 
               [ "string" ]
            ]
         },
         "Enabled": boolean,
         "MinAllowedConfidenceScoreForMerging": number
      },
      "Enabled": boolean,
      "ExportingConfig": { 
         "S3Exporting": { 
            "S3BucketName": "string",
            "S3KeyName": "string"
         }
      },
      "JobSchedule": { 
         "DayOfTheWeek": "string",
         "Time": "string"
      }
   },
   "RuleBasedMatching": { 
      "AttributeTypesSelector": { 
         "Address": [ "string" ],
         "AttributeMatchingModel": "string",
         "EmailAddress": [ "string" ],
         "PhoneNumber": [ "string" ]
      },
      "ConflictResolution": { 
         "ConflictResolvingModel": "string",
         "SourceName": "string"
      },
      "Enabled": boolean,
      "ExportingConfig": { 
         "S3Exporting": { 
            "S3BucketName": "string",
            "S3KeyName": "string"
         }
      },
      "MatchingRules": [ 
         { 
            "Rule": [ "string" ]
         }
      ],
      "MaxAllowedRuleLevelForMatching": number,
      "MaxAllowedRuleLevelForMerging": number,
      "Status": "string"
   },
   "Stats": { 
      "MeteringProfileCount": number,
      "ObjectCount": number,
      "ProfileCount": number,
      "TotalSize": number
   },
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreatedAt](#API_connect-customer-profiles_GetDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomain-response-CreatedAt"></a>
The timestamp of when the domain was created.  
Type: Timestamp

 ** [DataStore](#API_connect-customer-profiles_GetDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomain-response-DataStore"></a>
 True if data store is enabled for this domain.  
Type: [DataStoreResponse](API_connect-customer-profiles_DataStoreResponse.md) object

 ** [DeadLetterQueueUrl](#API_connect-customer-profiles_GetDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomain-response-DeadLetterQueueUrl"></a>
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.

 ** [DefaultEncryptionKey](#API_connect-customer-profiles_GetDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomain-response-DefaultEncryptionKey"></a>
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.

 ** [DefaultExpirationDays](#API_connect-customer-profiles_GetDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomain-response-DefaultExpirationDays"></a>
The default number of days until the data within the domain expires.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1098.

 ** [DomainName](#API_connect-customer-profiles_GetDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomain-response-DomainName"></a>
The unique name of the domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [LastUpdatedAt](#API_connect-customer-profiles_GetDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomain-response-LastUpdatedAt"></a>
The timestamp of when the domain was most recently edited.  
Type: Timestamp

 ** [Matching](#API_connect-customer-profiles_GetDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomain-response-Matching"></a>
The process of matching duplicate profiles. If `Matching` = `true`, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.   
After the Identity Resolution Job completes, use the [GetMatches](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) API to return and review the results. Or, if you have configured `ExportingConfig` in the `MatchingRequest`, you can download the results from S3.  
Type: [MatchingResponse](API_connect-customer-profiles_MatchingResponse.md) object

 ** [RuleBasedMatching](#API_connect-customer-profiles_GetDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomain-response-RuleBasedMatching"></a>
The process of matching duplicate profiles using the Rule-Based matching. If `RuleBasedMatching` = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the `RuleBasedMatchingRequest`. You can use the `ListRuleBasedMatches` and `GetSimilarProfiles` API to return and review the results. Also, if you have configured `ExportingConfig` in the `RuleBasedMatchingRequest`, you can download the results from S3.  
Type: [RuleBasedMatchingResponse](API_connect-customer-profiles_RuleBasedMatchingResponse.md) object

 ** [Stats](#API_connect-customer-profiles_GetDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomain-response-Stats"></a>
Usage-specific statistics about the domain.  
Type: [DomainStats](API_connect-customer-profiles_DomainStats.md) object

 ** [Tags](#API_connect-customer-profiles_GetDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomain-response-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_connect-customer-profiles_GetDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetDomain) 

# GetDomainLayout
<a name="API_connect-customer-profiles_GetDomainLayout"></a>

Gets the layout to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

## Request Syntax
<a name="API_connect-customer-profiles_GetDomainLayout_RequestSyntax"></a>

```
GET /domains/DomainName/layouts/LayoutDefinitionName HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetDomainLayout_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_GetDomainLayout_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetDomainLayout-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [LayoutDefinitionName](#API_connect-customer-profiles_GetDomainLayout_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetDomainLayout-request-uri-LayoutDefinitionName"></a>
The unique name of the layout.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetDomainLayout_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_GetDomainLayout_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": number,
   "Description": "string",
   "DisplayName": "string",
   "IsDefault": boolean,
   "LastUpdatedAt": number,
   "Layout": "string",
   "LayoutDefinitionName": "string",
   "LayoutType": "string",
   "Tags": { 
      "string" : "string" 
   },
   "Version": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetDomainLayout_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreatedAt](#API_connect-customer-profiles_GetDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomainLayout-response-CreatedAt"></a>
The timestamp of when the layout was created.  
Type: Timestamp

 ** [Description](#API_connect-customer-profiles_GetDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomainLayout-response-Description"></a>
The description of the layout  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.

 ** [DisplayName](#API_connect-customer-profiles_GetDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomainLayout-response-DisplayName"></a>
The display name of the layout  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$` 

 ** [IsDefault](#API_connect-customer-profiles_GetDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomainLayout-response-IsDefault"></a>
If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console.  
Type: Boolean

 ** [LastUpdatedAt](#API_connect-customer-profiles_GetDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomainLayout-response-LastUpdatedAt"></a>
The timestamp of when the layout was most recently updated.  
Type: Timestamp

 ** [Layout](#API_connect-customer-profiles_GetDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomainLayout-response-Layout"></a>
A customizable layout that can be used to view data under a Customer Profiles domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000000.

 ** [LayoutDefinitionName](#API_connect-customer-profiles_GetDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomainLayout-response-LayoutDefinitionName"></a>
The unique name of the layout.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [LayoutType](#API_connect-customer-profiles_GetDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomainLayout-response-LayoutType"></a>
The type of layout that can be used to view data under a Customer Profiles domain.  
Type: String  
Valid Values: `PROFILE_EXPLORER` 

 ** [Tags](#API_connect-customer-profiles_GetDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomainLayout-response-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

 ** [Version](#API_connect-customer-profiles_GetDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomainLayout-response-Version"></a>
The version used to create layout.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_connect-customer-profiles_GetDomainLayout_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetDomainLayout_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetDomainLayout) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetDomainLayout) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetDomainLayout) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetDomainLayout) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetDomainLayout) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetDomainLayout) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetDomainLayout) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetDomainLayout) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetDomainLayout) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetDomainLayout) 

# GetDomainObjectType
<a name="API_connect-customer-profiles_GetDomainObjectType"></a>

Return a DomainObjectType for the input Domain and ObjectType names. 

## Request Syntax
<a name="API_connect-customer-profiles_GetDomainObjectType_RequestSyntax"></a>

```
GET /domains/DomainName/domain-object-types/ObjectTypeName HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetDomainObjectType_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_GetDomainObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetDomainObjectType-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [ObjectTypeName](#API_connect-customer-profiles_GetDomainObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetDomainObjectType-request-uri-ObjectTypeName"></a>
The unique name of the domain object type.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetDomainObjectType_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_GetDomainObjectType_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": number,
   "Description": "string",
   "EncryptionKey": "string",
   "Fields": { 
      "string" : { 
         "ContentType": "string",
         "FeatureType": "string",
         "Source": "string",
         "Target": "string"
      }
   },
   "LastUpdatedAt": number,
   "ObjectTypeName": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetDomainObjectType_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreatedAt](#API_connect-customer-profiles_GetDomainObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomainObjectType-response-CreatedAt"></a>
The timestamp of when the domain object type was created.  
Type: Timestamp

 ** [Description](#API_connect-customer-profiles_GetDomainObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomainObjectType-response-Description"></a>
The description of the domain object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10000.

 ** [EncryptionKey](#API_connect-customer-profiles_GetDomainObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomainObjectType-response-EncryptionKey"></a>
The customer provided KMS key used to encrypt this type of domain object.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.

 ** [Fields](#API_connect-customer-profiles_GetDomainObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomainObjectType-response-Fields"></a>
A map of field names to their corresponding domain object type field definitions.  
Type: String to [DomainObjectTypeField](API_connect-customer-profiles_DomainObjectTypeField.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Key Pattern: `^[a-zA-Z0-9_.-]+$` 

 ** [LastUpdatedAt](#API_connect-customer-profiles_GetDomainObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomainObjectType-response-LastUpdatedAt"></a>
The timestamp of when the domain object type was most recently edited.  
Type: Timestamp

 ** [ObjectTypeName](#API_connect-customer-profiles_GetDomainObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomainObjectType-response-ObjectTypeName"></a>
The unique name of the domain object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` 

 ** [Tags](#API_connect-customer-profiles_GetDomainObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetDomainObjectType-response-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_connect-customer-profiles_GetDomainObjectType_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetDomainObjectType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetDomainObjectType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetDomainObjectType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetDomainObjectType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetDomainObjectType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetDomainObjectType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetDomainObjectType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetDomainObjectType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetDomainObjectType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetDomainObjectType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetDomainObjectType) 

# GetEventStream
<a name="API_connect-customer-profiles_GetEventStream"></a>

Returns information about the specified event stream in a specific domain.

## Request Syntax
<a name="API_connect-customer-profiles_GetEventStream_RequestSyntax"></a>

```
GET /domains/DomainName/event-streams/EventStreamName HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetEventStream_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_GetEventStream_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetEventStream-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [EventStreamName](#API_connect-customer-profiles_GetEventStream_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetEventStream-request-uri-EventStreamName"></a>
The name of the event stream provided during create operations.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetEventStream_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_GetEventStream_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": number,
   "DestinationDetails": { 
      "Message": "string",
      "Status": "string",
      "UnhealthySince": number,
      "Uri": "string"
   },
   "DomainName": "string",
   "EventStreamArn": "string",
   "State": "string",
   "StoppedSince": number,
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetEventStream_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreatedAt](#API_connect-customer-profiles_GetEventStream_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetEventStream-response-CreatedAt"></a>
The timestamp of when the export was created.  
Type: Timestamp

 ** [DestinationDetails](#API_connect-customer-profiles_GetEventStream_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetEventStream-response-DestinationDetails"></a>
Details regarding the Kinesis stream.  
Type: [EventStreamDestinationDetails](API_connect-customer-profiles_EventStreamDestinationDetails.md) object

 ** [DomainName](#API_connect-customer-profiles_GetEventStream_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetEventStream-response-DomainName"></a>
The unique name of the domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [EventStreamArn](#API_connect-customer-profiles_GetEventStream_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetEventStream-response-EventStreamArn"></a>
A unique identifier for the event stream.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [State](#API_connect-customer-profiles_GetEventStream_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetEventStream-response-State"></a>
The operational state of destination stream for export.  
Type: String  
Valid Values: `RUNNING | STOPPED` 

 ** [StoppedSince](#API_connect-customer-profiles_GetEventStream_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetEventStream-response-StoppedSince"></a>
The timestamp when the `State` changed to `STOPPED`.  
Type: Timestamp

 ** [Tags](#API_connect-customer-profiles_GetEventStream_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetEventStream-response-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_connect-customer-profiles_GetEventStream_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetEventStream_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetEventStream) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetEventStream) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetEventStream) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetEventStream) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetEventStream) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetEventStream) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetEventStream) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetEventStream) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetEventStream) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetEventStream) 

# GetEventTrigger
<a name="API_connect-customer-profiles_GetEventTrigger"></a>

Get a specific Event Trigger from the domain.

## Request Syntax
<a name="API_connect-customer-profiles_GetEventTrigger_RequestSyntax"></a>

```
GET /domains/DomainName/event-triggers/EventTriggerName HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetEventTrigger_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_GetEventTrigger_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetEventTrigger-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [EventTriggerName](#API_connect-customer-profiles_GetEventTrigger_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetEventTrigger-request-uri-EventTriggerName"></a>
The unique name of the event trigger.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetEventTrigger_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_GetEventTrigger_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": number,
   "Description": "string",
   "EventTriggerConditions": [ 
      { 
         "EventTriggerDimensions": [ 
            { 
               "ObjectAttributes": [ 
                  { 
                     "ComparisonOperator": "string",
                     "FieldName": "string",
                     "Source": "string",
                     "Values": [ "string" ]
                  }
               ]
            }
         ],
         "LogicalOperator": "string"
      }
   ],
   "EventTriggerLimits": { 
      "EventExpiration": number,
      "Periods": [ 
         { 
            "MaxInvocationsPerProfile": number,
            "Unit": "string",
            "Unlimited": boolean,
            "Value": number
         }
      ]
   },
   "EventTriggerName": "string",
   "LastUpdatedAt": number,
   "ObjectTypeName": "string",
   "SegmentFilter": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetEventTrigger_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreatedAt](#API_connect-customer-profiles_GetEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetEventTrigger-response-CreatedAt"></a>
The timestamp of when the event trigger was created.  
Type: Timestamp

 ** [Description](#API_connect-customer-profiles_GetEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetEventTrigger-response-Description"></a>
The description of the event trigger.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.

 ** [EventTriggerConditions](#API_connect-customer-profiles_GetEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetEventTrigger-response-EventTriggerConditions"></a>
A list of conditions that determine when an event should trigger the destination.  
Type: Array of [EventTriggerCondition](API_connect-customer-profiles_EventTriggerCondition.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 5 items.

 ** [EventTriggerLimits](#API_connect-customer-profiles_GetEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetEventTrigger-response-EventTriggerLimits"></a>
Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.  
Type: [EventTriggerLimits](API_connect-customer-profiles_EventTriggerLimits.md) object

 ** [EventTriggerName](#API_connect-customer-profiles_GetEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetEventTrigger-response-EventTriggerName"></a>
The unique name of the event trigger.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [LastUpdatedAt](#API_connect-customer-profiles_GetEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetEventTrigger-response-LastUpdatedAt"></a>
The timestamp of when the event trigger was most recently updated.  
Type: Timestamp

 ** [ObjectTypeName](#API_connect-customer-profiles_GetEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetEventTrigger-response-ObjectTypeName"></a>
The unique name of the object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` 

 ** [SegmentFilter](#API_connect-customer-profiles_GetEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetEventTrigger-response-SegmentFilter"></a>
The destination is triggered only for profiles that meet the criteria of a segment definition.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [Tags](#API_connect-customer-profiles_GetEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetEventTrigger-response-Tags"></a>
An array of key-value pairs to apply to this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_connect-customer-profiles_GetEventTrigger_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetEventTrigger_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetEventTrigger) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetEventTrigger) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetEventTrigger) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetEventTrigger) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetEventTrigger) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetEventTrigger) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetEventTrigger) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetEventTrigger) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetEventTrigger) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetEventTrigger) 

# GetIdentityResolutionJob
<a name="API_connect-customer-profiles_GetIdentityResolutionJob"></a>

Returns information about an Identity Resolution Job in a specific domain. 

Identity Resolution Jobs are set up using the Amazon Connect admin console. For more information, see [Use Identity Resolution to consolidate similar profiles](https://docs.aws.amazon.com/connect/latest/adminguide/use-identity-resolution.html).

## Request Syntax
<a name="API_connect-customer-profiles_GetIdentityResolutionJob_RequestSyntax"></a>

```
GET /domains/DomainName/identity-resolution-jobs/JobId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetIdentityResolutionJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_GetIdentityResolutionJob_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetIdentityResolutionJob-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [JobId](#API_connect-customer-profiles_GetIdentityResolutionJob_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetIdentityResolutionJob-request-uri-JobId"></a>
The unique identifier of the Identity Resolution Job.  
Pattern: `[a-f0-9]{32}`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetIdentityResolutionJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AutoMerging": { 
      "ConflictResolution": { 
         "ConflictResolvingModel": "string",
         "SourceName": "string"
      },
      "Consolidation": { 
         "MatchingAttributesList": [ 
            [ "string" ]
         ]
      },
      "Enabled": boolean,
      "MinAllowedConfidenceScoreForMerging": number
   },
   "DomainName": "string",
   "ExportingLocation": { 
      "S3Exporting": { 
         "S3BucketName": "string",
         "S3KeyName": "string"
      }
   },
   "JobEndTime": number,
   "JobExpirationTime": number,
   "JobId": "string",
   "JobStartTime": number,
   "JobStats": { 
      "NumberOfMatchesFound": number,
      "NumberOfMergesDone": number,
      "NumberOfProfilesReviewed": number
   },
   "LastUpdatedAt": number,
   "Message": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetIdentityResolutionJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AutoMerging](#API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIdentityResolutionJob-response-AutoMerging"></a>
Configuration settings for how to perform the auto-merging of profiles.  
Type: [AutoMerging](API_connect-customer-profiles_AutoMerging.md) object

 ** [DomainName](#API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIdentityResolutionJob-response-DomainName"></a>
The unique name of the domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [ExportingLocation](#API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIdentityResolutionJob-response-ExportingLocation"></a>
The S3 location where the Identity Resolution Job writes result files.  
Type: [ExportingLocation](API_connect-customer-profiles_ExportingLocation.md) object

 ** [JobEndTime](#API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIdentityResolutionJob-response-JobEndTime"></a>
The timestamp of when the Identity Resolution Job was completed.  
Type: Timestamp

 ** [JobExpirationTime](#API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIdentityResolutionJob-response-JobExpirationTime"></a>
The timestamp of when the Identity Resolution Job will expire.  
Type: Timestamp

 ** [JobId](#API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIdentityResolutionJob-response-JobId"></a>
The unique identifier of the Identity Resolution Job.  
Type: String  
Pattern: `[a-f0-9]{32}` 

 ** [JobStartTime](#API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIdentityResolutionJob-response-JobStartTime"></a>
The timestamp of when the Identity Resolution Job was started or will be started.  
Type: Timestamp

 ** [JobStats](#API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIdentityResolutionJob-response-JobStats"></a>
Statistics about the Identity Resolution Job.  
Type: [JobStats](API_connect-customer-profiles_JobStats.md) object

 ** [LastUpdatedAt](#API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIdentityResolutionJob-response-LastUpdatedAt"></a>
The timestamp of when the Identity Resolution Job was most recently edited.  
Type: Timestamp

 ** [Message](#API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIdentityResolutionJob-response-Message"></a>
The error messages that are generated when the Identity Resolution Job runs.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `.*` 

 ** [Status](#API_connect-customer-profiles_GetIdentityResolutionJob_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIdentityResolutionJob-response-Status"></a>
The status of the Identity Resolution Job.  
+  `PENDING`: The Identity Resolution Job is scheduled but has not started yet. If you turn off the Identity Resolution feature in your domain, jobs in the `PENDING` state are deleted.
+  `PREPROCESSING`: The Identity Resolution Job is loading your data.
+  `FIND_MATCHING`: The Identity Resolution Job is using the machine learning model to identify profiles that belong to the same matching group.
+  `MERGING`: The Identity Resolution Job is merging duplicate profiles.
+  `COMPLETED`: The Identity Resolution Job completed successfully.
+  `PARTIAL_SUCCESS`: There's a system error and not all of the data is merged. The Identity Resolution Job writes a message indicating the source of the problem.
+  `FAILED`: The Identity Resolution Job did not merge any data. It writes a message indicating the source of the problem.
Type: String  
Valid Values: `PENDING | PREPROCESSING | FIND_MATCHING | MERGING | COMPLETED | PARTIAL_SUCCESS | FAILED` 

## Errors
<a name="API_connect-customer-profiles_GetIdentityResolutionJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetIdentityResolutionJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetIdentityResolutionJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetIdentityResolutionJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetIdentityResolutionJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetIdentityResolutionJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetIdentityResolutionJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetIdentityResolutionJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetIdentityResolutionJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetIdentityResolutionJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetIdentityResolutionJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetIdentityResolutionJob) 

# GetIntegration
<a name="API_connect-customer-profiles_GetIntegration"></a>

Returns an integration for a domain.

## Request Syntax
<a name="API_connect-customer-profiles_GetIntegration_RequestSyntax"></a>

```
POST /domains/DomainName/integrations HTTP/1.1
Content-type: application/json

{
   "Uri": "string"
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetIntegration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_GetIntegration_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetIntegration-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetIntegration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Uri](#API_connect-customer-profiles_GetIntegration_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetIntegration-request-Uri"></a>
The URI of the S3 bucket or any other type of data source.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_GetIntegration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": number,
   "DomainName": "string",
   "EventTriggerNames": [ "string" ],
   "IsUnstructured": boolean,
   "LastUpdatedAt": number,
   "ObjectTypeName": "string",
   "ObjectTypeNames": { 
      "string" : "string" 
   },
   "RoleArn": "string",
   "Scope": "string",
   "Tags": { 
      "string" : "string" 
   },
   "Uri": "string",
   "WorkflowId": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetIntegration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreatedAt](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIntegration-response-CreatedAt"></a>
The timestamp of when the domain was created.  
Type: Timestamp

 ** [DomainName](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIntegration-response-DomainName"></a>
The unique name of the domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [EventTriggerNames](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIntegration-response-EventTriggerNames"></a>
A list of unique names for active event triggers associated with the integration. This list would be empty if no Event Trigger is associated with the integration.  
Type: Array of strings  
Array Members: Fixed number of 1 item.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [IsUnstructured](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIntegration-response-IsUnstructured"></a>
Boolean that shows if the Flow that's associated with the Integration is created in Amazon Appflow, or with ObjectTypeName equals \$1unstructured via API/CLI in flowDefinition.  
Type: Boolean

 ** [LastUpdatedAt](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIntegration-response-LastUpdatedAt"></a>
The timestamp of when the domain was most recently edited.  
Type: Timestamp

 ** [ObjectTypeName](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIntegration-response-ObjectTypeName"></a>
The name of the profile object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` 

 ** [ObjectTypeNames](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIntegration-response-ObjectTypeNames"></a>
A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an `ObjectTypeName` (template) used to ingest the event. It supports the following event types: `SegmentIdentify`, `ShopifyCreateCustomers`, `ShopifyUpdateCustomers`, `ShopifyCreateDraftOrders`, `ShopifyUpdateDraftOrders`, `ShopifyCreateOrders`, and `ShopifyUpdatedOrders`.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 255.  
Value Length Constraints: Minimum length of 1. Maximum length of 255.  
Value Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` 

 ** [RoleArn](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIntegration-response-RoleArn"></a>
The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make Customer Profiles requests on your behalf.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `arn:aws:iam:.*:[0-9]+:.*` 

 ** [Scope](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIntegration-response-Scope"></a>
Specifies whether the integration applies to profile level data (associated with profiles) or domain level data (not associated with any specific profile). The default value is PROFILE.  
Type: String  
Valid Values: `PROFILE | DOMAIN` 

 ** [Tags](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIntegration-response-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

 ** [Uri](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIntegration-response-Uri"></a>
The URI of the S3 bucket or any other type of data source.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [WorkflowId](#API_connect-customer-profiles_GetIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetIntegration-response-WorkflowId"></a>
Unique identifier for the workflow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_connect-customer-profiles_GetIntegration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_GetIntegration_Examples"></a>

### Example
<a name="API_connect-customer-profiles_GetIntegration_Example_1"></a>

This example illustrates one usage of GetIntegration.

#### Sample Request
<a name="API_connect-customer-profiles_GetIntegration_Example_1_Request"></a>

```
POST /domains/ExampleDomainName/integrations HTTP/1.1
{
     "Uri": "arn:aws:flow:us-east-1:123456789012:URIOfIntegration1"
}
```

#### Sample Response
<a name="API_connect-customer-profiles_GetIntegration_Example_1_Response"></a>

```
Content-type: application/json
{
   "CreatedAt": 1479249799770,
    "DomainName": "ExampleDomainName",
    "LastUpdatedAt": 1479249799770,
    "ObjectTypeName": "MyCustomObject",
    "Uri": "arn:aws:flow:us-east-1:123456789012:URIOfIntegration1"
}
```

## See Also
<a name="API_connect-customer-profiles_GetIntegration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetIntegration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetIntegration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetIntegration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetIntegration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetIntegration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetIntegration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetIntegration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetIntegration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetIntegration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetIntegration) 

# GetMatches
<a name="API_connect-customer-profiles_GetMatches"></a>

Before calling this API, use [CreateDomain](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html) or [UpdateDomain](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UpdateDomain.html) to enable identity resolution: set `Matching` to true.

GetMatches returns potentially matching profiles, based on the results of the latest run of a machine learning process. 

**Important**  
The process of matching duplicate profiles. If `Matching` = `true`, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.   
After the Identity Resolution Job completes, use the [GetMatches](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) API to return and review the results. Or, if you have configured `ExportingConfig` in the `MatchingRequest`, you can download the results from S3.

Amazon Connect uses the following profile attributes to identify matches:
+ PhoneNumber
+ HomePhoneNumber
+ BusinessPhoneNumber
+ MobilePhoneNumber
+ EmailAddress
+ PersonalEmailAddress
+ BusinessEmailAddress
+ FullName

For example, two or more profiles—with spelling mistakes such as **John Doe** and **Jhn Doe**, or different casing email addresses such as **JOHN\$1DOE@ANYCOMPANY.COM** and **johndoe@anycompany.com**, or different phone number formats such as **555-010-0000** and **\$11-555-010-0000**—can be detected as belonging to the same customer **John Doe** and merged into a unified profile.

## Request Syntax
<a name="API_connect-customer-profiles_GetMatches_RequestSyntax"></a>

```
GET /domains/DomainName/matches?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetMatches_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_GetMatches_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetMatches-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [MaxResults](#API_connect-customer-profiles_GetMatches_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetMatches-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_GetMatches_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetMatches-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Request Body
<a name="API_connect-customer-profiles_GetMatches_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_GetMatches_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Matches": [ 
      { 
         "ConfidenceScore": number,
         "MatchId": "string",
         "ProfileIds": [ "string" ]
      }
   ],
   "MatchGenerationDate": number,
   "NextToken": "string",
   "PotentialMatches": number
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetMatches_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Matches](#API_connect-customer-profiles_GetMatches_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetMatches-response-Matches"></a>
The list of matched profiles for this instance.  
Type: Array of [MatchItem](API_connect-customer-profiles_MatchItem.md) objects

 ** [MatchGenerationDate](#API_connect-customer-profiles_GetMatches_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetMatches-response-MatchGenerationDate"></a>
The timestamp this version of Match Result generated.  
Type: Timestamp

 ** [NextToken](#API_connect-customer-profiles_GetMatches_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetMatches-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [PotentialMatches](#API_connect-customer-profiles_GetMatches_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetMatches-response-PotentialMatches"></a>
The number of potential matches found.  
Type: Integer  
Valid Range: Minimum value of 0.

## Errors
<a name="API_connect-customer-profiles_GetMatches_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetMatches_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetMatches) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetMatches) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetMatches) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetMatches) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetMatches) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetMatches) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetMatches) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetMatches) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetMatches) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetMatches) 

# GetObjectTypeAttributeStatistics
<a name="API_connect-customer-profiles_GetObjectTypeAttributeStatistics"></a>

The GetObjectTypeAttributeValues API delivers statistical insights about attributes within a specific object type, but is exclusively available for domains with data store enabled. This API performs daily calculations to provide statistical information about your attribute values, helping you understand patterns and trends in your data. The statistical calculations are performed once per day, providing a consistent snapshot of your attribute data characteristics.

**Note**  
You'll receive null values in two scenarios:   
During the first period after enabling data vault (unless a calculation cycle occurs, which happens once daily).  
For attributes that don't contain numeric values. 

## Request Syntax
<a name="API_connect-customer-profiles_GetObjectTypeAttributeStatistics_RequestSyntax"></a>

```
POST /domains/DomainName/object-types/ObjectTypeName/attributes/AttributeName/statistics HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetObjectTypeAttributeStatistics_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AttributeName](#API_connect-customer-profiles_GetObjectTypeAttributeStatistics_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetObjectTypeAttributeStatistics-request-uri-AttributeName"></a>
The attribute name.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

 ** [DomainName](#API_connect-customer-profiles_GetObjectTypeAttributeStatistics_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetObjectTypeAttributeStatistics-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [ObjectTypeName](#API_connect-customer-profiles_GetObjectTypeAttributeStatistics_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetObjectTypeAttributeStatistics-request-uri-ObjectTypeName"></a>
The unique name of the domain object type.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetObjectTypeAttributeStatistics_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_GetObjectTypeAttributeStatistics_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CalculatedAt": number,
   "Statistics": { 
      "Average": number,
      "Maximum": number,
      "Minimum": number,
      "Percentiles": { 
         "P25": number,
         "P5": number,
         "P50": number,
         "P75": number,
         "P95": number
      },
      "StandardDeviation": number
   }
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetObjectTypeAttributeStatistics_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CalculatedAt](#API_connect-customer-profiles_GetObjectTypeAttributeStatistics_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetObjectTypeAttributeStatistics-response-CalculatedAt"></a>
Time when this statistics was calculated.  
Type: Timestamp

 ** [Statistics](#API_connect-customer-profiles_GetObjectTypeAttributeStatistics_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetObjectTypeAttributeStatistics-response-Statistics"></a>
The statistics.  
Type: [GetObjectTypeAttributeStatisticsStats](API_connect-customer-profiles_GetObjectTypeAttributeStatisticsStats.md) object

## Errors
<a name="API_connect-customer-profiles_GetObjectTypeAttributeStatistics_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetObjectTypeAttributeStatistics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetObjectTypeAttributeStatistics) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetObjectTypeAttributeStatistics) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetObjectTypeAttributeStatistics) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetObjectTypeAttributeStatistics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetObjectTypeAttributeStatistics) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetObjectTypeAttributeStatistics) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetObjectTypeAttributeStatistics) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetObjectTypeAttributeStatistics) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetObjectTypeAttributeStatistics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetObjectTypeAttributeStatistics) 

# GetProfileHistoryRecord
<a name="API_connect-customer-profiles_GetProfileHistoryRecord"></a>

Returns a history record for a specific profile, for a specific domain.

## Request Syntax
<a name="API_connect-customer-profiles_GetProfileHistoryRecord_RequestSyntax"></a>

```
GET /domains/DomainName/profiles/ProfileId/history-records/Id HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetProfileHistoryRecord_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_GetProfileHistoryRecord_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetProfileHistoryRecord-request-uri-DomainName"></a>
The unique name of the domain for which to return a profile history record.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [Id](#API_connect-customer-profiles_GetProfileHistoryRecord_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetProfileHistoryRecord-request-uri-Id"></a>
The unique identifier of the profile history record to return.  
Pattern: `[a-f0-9]{32}`   
Required: Yes

 ** [ProfileId](#API_connect-customer-profiles_GetProfileHistoryRecord_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetProfileHistoryRecord-request-uri-ProfileId"></a>
The unique identifier of the profile for which to return a history record.  
Pattern: `[a-f0-9]{32}`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetProfileHistoryRecord_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_GetProfileHistoryRecord_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ActionType": "string",
   "Content": "string",
   "CreatedAt": number,
   "Id": "string",
   "LastUpdatedAt": number,
   "ObjectTypeName": "string",
   "PerformedBy": "string",
   "ProfileObjectUniqueKey": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetProfileHistoryRecord_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ActionType](#API_connect-customer-profiles_GetProfileHistoryRecord_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileHistoryRecord-response-ActionType"></a>
The action type of the profile history record.  
Type: String  
Valid Values: `ADDED_PROFILE_KEY | DELETED_PROFILE_KEY | CREATED | UPDATED | INGESTED | DELETED_BY_CUSTOMER | EXPIRED | MERGED | DELETED_BY_MERGE` 

 ** [Content](#API_connect-customer-profiles_GetProfileHistoryRecord_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileHistoryRecord-response-Content"></a>
A string containing the customer profile, profile object, or profile key content.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256000.

 ** [CreatedAt](#API_connect-customer-profiles_GetProfileHistoryRecord_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileHistoryRecord-response-CreatedAt"></a>
The timestamp of when the profile history record was created.  
Type: Timestamp

 ** [Id](#API_connect-customer-profiles_GetProfileHistoryRecord_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileHistoryRecord-response-Id"></a>
The unique identifier of the profile history record.  
Type: String  
Pattern: `[a-f0-9]{32}` 

 ** [LastUpdatedAt](#API_connect-customer-profiles_GetProfileHistoryRecord_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileHistoryRecord-response-LastUpdatedAt"></a>
The timestamp of when the profile history record was last updated.  
Type: Timestamp

 ** [ObjectTypeName](#API_connect-customer-profiles_GetProfileHistoryRecord_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileHistoryRecord-response-ObjectTypeName"></a>
The name of the profile object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` 

 ** [PerformedBy](#API_connect-customer-profiles_GetProfileHistoryRecord_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileHistoryRecord-response-PerformedBy"></a>
The Amazon Resource Name (ARN) of the person or service principal who performed the action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [ProfileObjectUniqueKey](#API_connect-customer-profiles_GetProfileHistoryRecord_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileHistoryRecord-response-ProfileObjectUniqueKey"></a>
The unique identifier of the profile object generated by the service.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_connect-customer-profiles_GetProfileHistoryRecord_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetProfileHistoryRecord_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetProfileHistoryRecord) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetProfileHistoryRecord) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetProfileHistoryRecord) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetProfileHistoryRecord) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetProfileHistoryRecord) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetProfileHistoryRecord) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetProfileHistoryRecord) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetProfileHistoryRecord) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetProfileHistoryRecord) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetProfileHistoryRecord) 

# GetProfileObjectType
<a name="API_connect-customer-profiles_GetProfileObjectType"></a>

Returns the object types for a specific domain.

## Request Syntax
<a name="API_connect-customer-profiles_GetProfileObjectType_RequestSyntax"></a>

```
GET /domains/DomainName/object-types/ObjectTypeName HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetProfileObjectType_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_GetProfileObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectType-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [ObjectTypeName](#API_connect-customer-profiles_GetProfileObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectType-request-uri-ObjectTypeName"></a>
The name of the profile object type.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetProfileObjectType_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AllowProfileCreation": boolean,
   "CreatedAt": number,
   "Description": "string",
   "EncryptionKey": "string",
   "ExpirationDays": number,
   "Fields": { 
      "string" : { 
         "ContentType": "string",
         "Source": "string",
         "Target": "string"
      }
   },
   "Keys": { 
      "string" : [ 
         { 
            "FieldNames": [ "string" ],
            "StandardIdentifiers": [ "string" ]
         }
      ]
   },
   "LastUpdatedAt": number,
   "MaxAvailableProfileObjectCount": number,
   "MaxProfileObjectCount": number,
   "ObjectTypeName": "string",
   "SourceLastUpdatedTimestampFormat": "string",
   "Tags": { 
      "string" : "string" 
   },
   "TemplateId": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetProfileObjectType_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AllowProfileCreation](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectType-response-AllowProfileCreation"></a>
Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is `FALSE`. If the AllowProfileCreation flag is set to `FALSE`, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to `TRUE`, and if no match is found, then the service creates a new standard profile.  
Type: Boolean

 ** [CreatedAt](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectType-response-CreatedAt"></a>
The timestamp of when the domain was created.  
Type: Timestamp

 ** [Description](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectType-response-Description"></a>
The description of the profile object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.

 ** [EncryptionKey](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectType-response-EncryptionKey"></a>
The customer-provided key to encrypt the profile object that will be created in this profile object type.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.

 ** [ExpirationDays](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectType-response-ExpirationDays"></a>
The number of days until the data in the object expires.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1098.

 ** [Fields](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectType-response-Fields"></a>
A map of the name and ObjectType field.  
Type: String to [ObjectTypeField](API_connect-customer-profiles_ObjectTypeField.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Key Pattern: `^[a-zA-Z0-9_.-]+$` 

 ** [Keys](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectType-response-Keys"></a>
A list of unique keys that can be used to map data to the profile.  
Type: String to array of [ObjectTypeKey](API_connect-customer-profiles_ObjectTypeKey.md) objects map  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Key Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [LastUpdatedAt](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectType-response-LastUpdatedAt"></a>
The timestamp of when the domain was most recently edited.  
Type: Timestamp

 ** [MaxAvailableProfileObjectCount](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectType-response-MaxAvailableProfileObjectCount"></a>
The amount of provisioned profile object max count available.  
Type: Integer  
Valid Range: Minimum value of 0.

 ** [MaxProfileObjectCount](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectType-response-MaxProfileObjectCount"></a>
The amount of profile object max count assigned to the object type.  
Type: Integer  
Valid Range: Minimum value of 1.

 ** [ObjectTypeName](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectType-response-ObjectTypeName"></a>
The name of the profile object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` 

 ** [SourceLastUpdatedTimestampFormat](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectType-response-SourceLastUpdatedTimestampFormat"></a>
The format of your `sourceLastUpdatedTimestamp` that was previously set up.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [Tags](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectType-response-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

 ** [TemplateId](#API_connect-customer-profiles_GetProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectType-response-TemplateId"></a>
A unique identifier for the object template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

## Errors
<a name="API_connect-customer-profiles_GetProfileObjectType_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_GetProfileObjectType_Examples"></a>

### Example
<a name="API_connect-customer-profiles_GetProfileObjectType_Example_1"></a>

This example illustrates one usage of GetProfileObjectType.

#### Sample Request
<a name="API_connect-customer-profiles_GetProfileObjectType_Example_1_Request"></a>

```
GET /domains/ExampleDomainName/object-types/MyCustomObject HTTP/1.1
```

#### Sample Response
<a name="API_connect-customer-profiles_GetProfileObjectType_Example_1_Response"></a>

```
Content-type: application/jsonContent-type: application/json
{
   "CreatedAt": 1479249799770,
   "Description": "Internal ERP System",
   "EncryptionKey": "arn:aws:kms:us-east-1:123456789012:key/1988472d-6b77-4bb6-ae39-efce5EXAMPLE",
   "AllowProfileCreation": "FALSE",
   "ExpirationDays": 100,
   "Fields": { 
      "email" : { 
         "ContentType": "EMAIL_ADDRESS",
         "Source": "_source.email",
         "Target": "_profile.BusinessEmailAddress"
      },
      "phone" : { 
         "ContentType": "PHONE_NUMBER",
         "Source": "_source.phone",
         "Target": "_profile.BusinessPhoneNumber"
      },
      "loyaltyPoints" : { 
         "ContentType": "NUMBER",
         "Source": "_source.loyaltypoints",
         "Target": "_profile.Attributes.loyaltypoints"
      }
   },
   "Keys": { 
      "email" : [ 
         { 
            "FieldNames": [ "email" ],
            "StandardIdentifiers": [ "PROFILE", "UNIQUE" ]
         }
      ],
      "loyaltypoints" : [ 
         { 
            "FieldNames": [ "loyaltyPoints" ],
            "StandardIdentifiers": [ "PROFILE"]
         }
      ]
   },
   "LastUpdatedAt": 1479249799770,
   "ObjectTypeName": "CustomProfileObjectTypeName",
   "TemplateId": "MyTemplateId"
}
```

## See Also
<a name="API_connect-customer-profiles_GetProfileObjectType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetProfileObjectType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetProfileObjectType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetProfileObjectType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetProfileObjectType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetProfileObjectType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetProfileObjectType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetProfileObjectType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetProfileObjectType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetProfileObjectType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetProfileObjectType) 

# GetProfileObjectTypeTemplate
<a name="API_connect-customer-profiles_GetProfileObjectTypeTemplate"></a>

Returns the template information for a specific object type.

A template is a predefined ProfileObjectType, such as “Salesforce-Account” or “Salesforce-Contact.” When a user sends a ProfileObject, using the PutProfileObject API, with an ObjectTypeName that matches one of the TemplateIds, it uses the mappings from the template.

## Request Syntax
<a name="API_connect-customer-profiles_GetProfileObjectTypeTemplate_RequestSyntax"></a>

```
GET /templates/TemplateId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetProfileObjectTypeTemplate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [TemplateId](#API_connect-customer-profiles_GetProfileObjectTypeTemplate_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectTypeTemplate-request-uri-TemplateId"></a>
A unique identifier for the object template.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetProfileObjectTypeTemplate_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_GetProfileObjectTypeTemplate_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AllowProfileCreation": boolean,
   "Fields": { 
      "string" : { 
         "ContentType": "string",
         "Source": "string",
         "Target": "string"
      }
   },
   "Keys": { 
      "string" : [ 
         { 
            "FieldNames": [ "string" ],
            "StandardIdentifiers": [ "string" ]
         }
      ]
   },
   "SourceLastUpdatedTimestampFormat": "string",
   "SourceName": "string",
   "SourceObject": "string",
   "TemplateId": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetProfileObjectTypeTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AllowProfileCreation](#API_connect-customer-profiles_GetProfileObjectTypeTemplate_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectTypeTemplate-response-AllowProfileCreation"></a>
Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is `FALSE`. If the AllowProfileCreation flag is set to `FALSE`, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to `TRUE`, and if no match is found, then the service creates a new standard profile.  
Type: Boolean

 ** [Fields](#API_connect-customer-profiles_GetProfileObjectTypeTemplate_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectTypeTemplate-response-Fields"></a>
A map of the name and ObjectType field.  
Type: String to [ObjectTypeField](API_connect-customer-profiles_ObjectTypeField.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Key Pattern: `^[a-zA-Z0-9_.-]+$` 

 ** [Keys](#API_connect-customer-profiles_GetProfileObjectTypeTemplate_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectTypeTemplate-response-Keys"></a>
A list of unique keys that can be used to map data to the profile.  
Type: String to array of [ObjectTypeKey](API_connect-customer-profiles_ObjectTypeKey.md) objects map  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Key Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [SourceLastUpdatedTimestampFormat](#API_connect-customer-profiles_GetProfileObjectTypeTemplate_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectTypeTemplate-response-SourceLastUpdatedTimestampFormat"></a>
The format of your `sourceLastUpdatedTimestamp` that was previously set up.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [SourceName](#API_connect-customer-profiles_GetProfileObjectTypeTemplate_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectTypeTemplate-response-SourceName"></a>
The name of the source of the object template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [SourceObject](#API_connect-customer-profiles_GetProfileObjectTypeTemplate_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectTypeTemplate-response-SourceObject"></a>
The source of the object template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [TemplateId](#API_connect-customer-profiles_GetProfileObjectTypeTemplate_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileObjectTypeTemplate-response-TemplateId"></a>
A unique identifier for the object template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

## Errors
<a name="API_connect-customer-profiles_GetProfileObjectTypeTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_GetProfileObjectTypeTemplate_Examples"></a>

### Example
<a name="API_connect-customer-profiles_GetProfileObjectTypeTemplate_Example_1"></a>

This example illustrates one usage of GetProfileObjectTypeTemplate.

#### Sample Request
<a name="API_connect-customer-profiles_GetProfileObjectTypeTemplate_Example_1_Request"></a>

```
GET /templates/{TemplateId} HTTP/1.1
```

#### Sample Response
<a name="API_connect-customer-profiles_GetProfileObjectTypeTemplate_Example_1_Response"></a>

```
Content-type: application/json
{
   "AllowProfileCreätion": "FALSE",
   "Fields": { 
      "email" : { 
         "ContentType": "EMAIL_ADDRESS",
         "Source": "_source.email",
         "Target": "_profile.BusinessEmailAddress"
      },
      "phone" : { 
         "ContentType": "PHONE_NUMBER",
         "Source": "_source.phone",
         "Target": "_profile.Businessphonenumber"
      }
   },
   "Keys": { 
      "_email" : [ 
         { 
            "FieldNames": [ "email" ],
            "StandardIdentifiers": [ "PROFILE", "UNIQUE" ]
         }
      ]
   },
   "SourceName": "Saleforce-Account",
   "SourceObject": "Account",
   "TemplateId": "Saleforce-Account"
}
```

## See Also
<a name="API_connect-customer-profiles_GetProfileObjectTypeTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetProfileObjectTypeTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetProfileObjectTypeTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetProfileObjectTypeTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetProfileObjectTypeTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetProfileObjectTypeTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetProfileObjectTypeTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetProfileObjectTypeTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetProfileObjectTypeTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetProfileObjectTypeTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetProfileObjectTypeTemplate) 

# GetProfileRecommendations
<a name="API_connect-customer-profiles_GetProfileRecommendations"></a>

Fetches the recommendations for a profile in the input Customer Profiles domain. Fetches all the profile recommendations 

## Request Syntax
<a name="API_connect-customer-profiles_GetProfileRecommendations_RequestSyntax"></a>

```
POST /domains/DomainName/profiles/ProfileId/recommendations HTTP/1.1
Content-type: application/json

{
   "Context": { 
      "string" : "string" 
   },
   "MaxResults": number,
   "RecommenderName": "string"
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetProfileRecommendations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_GetProfileRecommendations_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetProfileRecommendations-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [ProfileId](#API_connect-customer-profiles_GetProfileRecommendations_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetProfileRecommendations-request-uri-ProfileId"></a>
The unique identifier of the profile for which to retrieve recommendations.  
Pattern: `[a-f0-9]{32}`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetProfileRecommendations_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Context](#API_connect-customer-profiles_GetProfileRecommendations_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetProfileRecommendations-request-Context"></a>
The contextual metadata used to provide dynamic runtime information to tailor recommendations.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Key Pattern: `^[a-zA-Z0-9_.-]+$`   
Value Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [MaxResults](#API_connect-customer-profiles_GetProfileRecommendations_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetProfileRecommendations-request-MaxResults"></a>
The maximum number of recommendations to return. The default value is 10.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 10.  
Required: No

 ** [RecommenderName](#API_connect-customer-profiles_GetProfileRecommendations_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetProfileRecommendations-request-RecommenderName"></a>
The unique name of the recommender.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_GetProfileRecommendations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Recommendations": [ 
      { 
         "CatalogItem": { 
            "AdditionalInformation": "string",
            "Attributes": { 
               "string" : "string" 
            },
            "Category": "string",
            "Code": "string",
            "CreatedAt": number,
            "Description": "string",
            "Id": "string",
            "ImageLink": "string",
            "Link": "string",
            "Name": "string",
            "Price": "string",
            "Type": "string",
            "UpdatedAt": number
         },
         "Score": number
      }
   ]
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetProfileRecommendations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Recommendations](#API_connect-customer-profiles_GetProfileRecommendations_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetProfileRecommendations-response-Recommendations"></a>
List of recommendations generated by the recommender.  
Type: Array of [Recommendation](API_connect-customer-profiles_Recommendation.md) objects

## Errors
<a name="API_connect-customer-profiles_GetProfileRecommendations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetProfileRecommendations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetProfileRecommendations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetProfileRecommendations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetProfileRecommendations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetProfileRecommendations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetProfileRecommendations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetProfileRecommendations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetProfileRecommendations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetProfileRecommendations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetProfileRecommendations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetProfileRecommendations) 

# GetRecommender
<a name="API_connect-customer-profiles_GetRecommender"></a>

Retrieves a recommender.

## Request Syntax
<a name="API_connect-customer-profiles_GetRecommender_RequestSyntax"></a>

```
GET /domains/DomainName/recommenders/RecommenderName?training-metrics-count=TrainingMetricsCount HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetRecommender_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_GetRecommender_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetRecommender-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [RecommenderName](#API_connect-customer-profiles_GetRecommender_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetRecommender-request-uri-RecommenderName"></a>
The name of the recommender.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [TrainingMetricsCount](#API_connect-customer-profiles_GetRecommender_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetRecommender-request-uri-TrainingMetricsCount"></a>
The number of training metrics to retrieve for the recommender.  
Valid Range: Minimum value of 0. Maximum value of 5.

## Request Body
<a name="API_connect-customer-profiles_GetRecommender_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_GetRecommender_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": number,
   "Description": "string",
   "FailureReason": "string",
   "LastUpdatedAt": number,
   "LatestRecommenderUpdate": { 
      "CreatedAt": number,
      "FailureReason": "string",
      "LastUpdatedAt": number,
      "RecommenderConfig": { 
         "EventsConfig": { 
            "EventParametersList": [ 
               { 
                  "EventType": "string",
                  "EventValueThreshold": number
               }
            ]
         },
         "TrainingFrequency": number
      },
      "Status": "string"
   },
   "RecommenderConfig": { 
      "EventsConfig": { 
         "EventParametersList": [ 
            { 
               "EventType": "string",
               "EventValueThreshold": number
            }
         ]
      },
      "TrainingFrequency": number
   },
   "RecommenderName": "string",
   "RecommenderRecipeName": "string",
   "Status": "string",
   "Tags": { 
      "string" : "string" 
   },
   "TrainingMetrics": [ 
      { 
         "Metrics": { 
            "string" : number 
         },
         "Time": number
      }
   ]
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetRecommender_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreatedAt](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetRecommender-response-CreatedAt"></a>
The timestamp of when the recommender was created.  
Type: Timestamp

 ** [Description](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetRecommender-response-Description"></a>
A detailed description of the recommender providing information about its purpose and functionality.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.

 ** [FailureReason](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetRecommender-response-FailureReason"></a>
If the recommender fails, provides the reason for the failure.  
Type: String

 ** [LastUpdatedAt](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetRecommender-response-LastUpdatedAt"></a>
The timestamp of when the recommender was edited.  
Type: Timestamp

 ** [LatestRecommenderUpdate](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetRecommender-response-LatestRecommenderUpdate"></a>
Information about the most recent update performed on the recommender, including status and timestamp.  
Type: [RecommenderUpdate](API_connect-customer-profiles_RecommenderUpdate.md) object

 ** [RecommenderConfig](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetRecommender-response-RecommenderConfig"></a>
The configuration settings for the recommender, including parameters and settings that define its behavior.  
Type: [RecommenderConfig](API_connect-customer-profiles_RecommenderConfig.md) object

 ** [RecommenderName](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetRecommender-response-RecommenderName"></a>
The name of the recommender.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [RecommenderRecipeName](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetRecommender-response-RecommenderRecipeName"></a>
The name of the recipe used by the recommender to generate recommendations.  
Type: String  
Valid Values: `recommended-for-you | similar-items | frequently-paired-items | popular-items | trending-now` 

 ** [Status](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetRecommender-response-Status"></a>
The current status of the recommender, indicating whether it is active, creating, updating, or in another state.  
Type: String  
Valid Values: `PENDING | IN_PROGRESS | ACTIVE | FAILED | STOPPING | INACTIVE | STARTING | DELETING` 

 ** [Tags](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetRecommender-response-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

 ** [TrainingMetrics](#API_connect-customer-profiles_GetRecommender_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetRecommender-response-TrainingMetrics"></a>
A set of metrics that provide information about the recommender's training performance and accuracy.  
Type: Array of [TrainingMetrics](API_connect-customer-profiles_TrainingMetrics.md) objects

## Errors
<a name="API_connect-customer-profiles_GetRecommender_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetRecommender_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetRecommender) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetRecommender) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetRecommender) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetRecommender) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetRecommender) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetRecommender) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetRecommender) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetRecommender) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetRecommender) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetRecommender) 

# GetSegmentDefinition
<a name="API_connect-customer-profiles_GetSegmentDefinition"></a>

Gets a segment definition from the domain.

## Request Syntax
<a name="API_connect-customer-profiles_GetSegmentDefinition_RequestSyntax"></a>

```
GET /domains/DomainName/segment-definitions/SegmentDefinitionName HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetSegmentDefinition_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_GetSegmentDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentDefinition-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [SegmentDefinitionName](#API_connect-customer-profiles_GetSegmentDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentDefinition-request-uri-SegmentDefinitionName"></a>
The unique name of the segment definition.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetSegmentDefinition_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_GetSegmentDefinition_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": number,
   "Description": "string",
   "DisplayName": "string",
   "SegmentDefinitionArn": "string",
   "SegmentDefinitionName": "string",
   "SegmentGroups": { 
      "Groups": [ 
         { 
            "Dimensions": [ 
               { ... }
            ],
            "SourceSegments": [ 
               { 
                  "SegmentDefinitionName": "string"
               }
            ],
            "SourceType": "string",
            "Type": "string"
         }
      ],
      "Include": "string"
   },
   "SegmentSqlQuery": "string",
   "SegmentType": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetSegmentDefinition_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreatedAt](#API_connect-customer-profiles_GetSegmentDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentDefinition-response-CreatedAt"></a>
The timestamp of when the segment definition was created.  
Type: Timestamp

 ** [Description](#API_connect-customer-profiles_GetSegmentDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentDefinition-response-Description"></a>
The description of the segment definition.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4000.

 ** [DisplayName](#API_connect-customer-profiles_GetSegmentDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentDefinition-response-DisplayName"></a>
The display name of the segment definition.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [SegmentDefinitionArn](#API_connect-customer-profiles_GetSegmentDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentDefinition-response-SegmentDefinitionArn"></a>
The arn of the segment definition.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [SegmentDefinitionName](#API_connect-customer-profiles_GetSegmentDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentDefinition-response-SegmentDefinitionName"></a>
The name of the segment definition.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [SegmentGroups](#API_connect-customer-profiles_GetSegmentDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentDefinition-response-SegmentGroups"></a>
The segment criteria associated with this definition.  
Type: [SegmentGroup](API_connect-customer-profiles_SegmentGroup.md) object

 ** [SegmentSqlQuery](#API_connect-customer-profiles_GetSegmentDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentDefinition-response-SegmentSqlQuery"></a>
The segment SQL query.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50000.

 ** [SegmentType](#API_connect-customer-profiles_GetSegmentDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentDefinition-response-SegmentType"></a>
The segment type.  
 Classic : Segments created using traditional SegmentGroup structure  
 Enhanced : Segments created using SQL queries   
Type: String  
Valid Values: `CLASSIC | ENHANCED` 

 ** [Tags](#API_connect-customer-profiles_GetSegmentDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentDefinition-response-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_connect-customer-profiles_GetSegmentDefinition_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetSegmentDefinition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetSegmentDefinition) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetSegmentDefinition) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetSegmentDefinition) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetSegmentDefinition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetSegmentDefinition) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetSegmentDefinition) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetSegmentDefinition) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetSegmentDefinition) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetSegmentDefinition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetSegmentDefinition) 

# GetSegmentEstimate
<a name="API_connect-customer-profiles_GetSegmentEstimate"></a>

Gets the result of a segment estimate query.

## Request Syntax
<a name="API_connect-customer-profiles_GetSegmentEstimate_RequestSyntax"></a>

```
GET /domains/DomainName/segment-estimates/EstimateId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetSegmentEstimate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_GetSegmentEstimate_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentEstimate-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [EstimateId](#API_connect-customer-profiles_GetSegmentEstimate_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentEstimate-request-uri-EstimateId"></a>
The query Id passed by a previous `CreateSegmentEstimate` operation.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetSegmentEstimate_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_GetSegmentEstimate_ResponseSyntax"></a>

```
HTTP/1.1 StatusCode
Content-type: application/json

{
   "DomainName": "string",
   "Estimate": "string",
   "EstimateId": "string",
   "Message": "string",
   "Status": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetSegmentEstimate_ResponseElements"></a>

If the action is successful, the service sends back the following HTTP response.

 ** [StatusCode](#API_connect-customer-profiles_GetSegmentEstimate_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentEstimate-response-StatusCode"></a>
The status code of the segment estimate.

The following data is returned in JSON format by the service.

 ** [DomainName](#API_connect-customer-profiles_GetSegmentEstimate_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentEstimate-response-DomainName"></a>
The unique name of the domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [Estimate](#API_connect-customer-profiles_GetSegmentEstimate_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentEstimate-response-Estimate"></a>
The estimated number of profiles contained in the segment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [EstimateId](#API_connect-customer-profiles_GetSegmentEstimate_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentEstimate-response-EstimateId"></a>
The `QueryId` which is the same as the value passed in `QueryId`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [Message](#API_connect-customer-profiles_GetSegmentEstimate_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentEstimate-response-Message"></a>
The error message if there is any error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [Status](#API_connect-customer-profiles_GetSegmentEstimate_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentEstimate-response-Status"></a>
The current status of the query.  
Type: String  
Valid Values: `RUNNING | SUCCEEDED | FAILED` 

## Errors
<a name="API_connect-customer-profiles_GetSegmentEstimate_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetSegmentEstimate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetSegmentEstimate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetSegmentEstimate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetSegmentEstimate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetSegmentEstimate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetSegmentEstimate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetSegmentEstimate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetSegmentEstimate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetSegmentEstimate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetSegmentEstimate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetSegmentEstimate) 

# GetSegmentMembership
<a name="API_connect-customer-profiles_GetSegmentMembership"></a>

Determines if the given profiles are within a segment.

## Request Syntax
<a name="API_connect-customer-profiles_GetSegmentMembership_RequestSyntax"></a>

```
POST /domains/DomainName/segments/SegmentDefinitionName/membership HTTP/1.1
Content-type: application/json

{
   "ProfileIds": [ "string" ]
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetSegmentMembership_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_GetSegmentMembership_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentMembership-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [SegmentDefinitionName](#API_connect-customer-profiles_GetSegmentMembership_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentMembership-request-uri-SegmentDefinitionName"></a>
The Id of the wanted segment. Needs to be a valid, and existing segment Id.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetSegmentMembership_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ProfileIds](#API_connect-customer-profiles_GetSegmentMembership_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentMembership-request-ProfileIds"></a>
The list of profile IDs to query for.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Pattern: `[a-f0-9]{32}`   
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_GetSegmentMembership_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Failures": [ 
      { 
         "Message": "string",
         "ProfileId": "string",
         "Status": number
      }
   ],
   "LastComputedAt": number,
   "Profiles": [ 
      { 
         "Profile": { 
            "AccountNumber": "string",
            "AdditionalInformation": "string",
            "Address": { 
               "Address1": "string",
               "Address2": "string",
               "Address3": "string",
               "Address4": "string",
               "City": "string",
               "Country": "string",
               "County": "string",
               "PostalCode": "string",
               "Province": "string",
               "State": "string"
            },
            "Attributes": { 
               "string" : "string" 
            },
            "BillingAddress": { 
               "Address1": "string",
               "Address2": "string",
               "Address3": "string",
               "Address4": "string",
               "City": "string",
               "Country": "string",
               "County": "string",
               "PostalCode": "string",
               "Province": "string",
               "State": "string"
            },
            "BirthDate": "string",
            "BusinessEmailAddress": "string",
            "BusinessName": "string",
            "BusinessPhoneNumber": "string",
            "EmailAddress": "string",
            "EngagementPreferences": { 
               "Email": [ 
                  { 
                     "ContactType": "string",
                     "KeyName": "string",
                     "KeyValue": "string",
                     "ProfileId": "string"
                  }
               ],
               "Phone": [ 
                  { 
                     "ContactType": "string",
                     "KeyName": "string",
                     "KeyValue": "string",
                     "ProfileId": "string"
                  }
               ]
            },
            "FirstName": "string",
            "FoundByItems": [ 
               { 
                  "KeyName": "string",
                  "Values": [ "string" ]
               }
            ],
            "Gender": "string",
            "GenderString": "string",
            "HomePhoneNumber": "string",
            "LastName": "string",
            "MailingAddress": { 
               "Address1": "string",
               "Address2": "string",
               "Address3": "string",
               "Address4": "string",
               "City": "string",
               "Country": "string",
               "County": "string",
               "PostalCode": "string",
               "Province": "string",
               "State": "string"
            },
            "MiddleName": "string",
            "MobilePhoneNumber": "string",
            "PartyType": "string",
            "PartyTypeString": "string",
            "PersonalEmailAddress": "string",
            "PhoneNumber": "string",
            "ProfileId": "string",
            "ProfileType": "string",
            "ShippingAddress": { 
               "Address1": "string",
               "Address2": "string",
               "Address3": "string",
               "Address4": "string",
               "City": "string",
               "Country": "string",
               "County": "string",
               "PostalCode": "string",
               "Province": "string",
               "State": "string"
            }
         },
         "ProfileId": "string",
         "QueryResult": "string"
      }
   ],
   "SegmentDefinitionName": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetSegmentMembership_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Failures](#API_connect-customer-profiles_GetSegmentMembership_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentMembership-response-Failures"></a>
An array of maps where each contains a response per profile failed for the request.  
Type: Array of [ProfileQueryFailures](API_connect-customer-profiles_ProfileQueryFailures.md) objects

 ** [LastComputedAt](#API_connect-customer-profiles_GetSegmentMembership_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentMembership-response-LastComputedAt"></a>
The timestamp indicating when the segment membership was last computed or updated.  
Type: Timestamp

 ** [Profiles](#API_connect-customer-profiles_GetSegmentMembership_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentMembership-response-Profiles"></a>
An array of maps where each contains a response per profile requested.  
Type: Array of [ProfileQueryResult](API_connect-customer-profiles_ProfileQueryResult.md) objects

 ** [SegmentDefinitionName](#API_connect-customer-profiles_GetSegmentMembership_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentMembership-response-SegmentDefinitionName"></a>
The unique name of the segment definition.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

## Errors
<a name="API_connect-customer-profiles_GetSegmentMembership_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetSegmentMembership_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetSegmentMembership) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetSegmentMembership) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetSegmentMembership) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetSegmentMembership) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetSegmentMembership) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetSegmentMembership) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetSegmentMembership) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetSegmentMembership) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetSegmentMembership) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetSegmentMembership) 

# GetSegmentSnapshot
<a name="API_connect-customer-profiles_GetSegmentSnapshot"></a>

Retrieve the latest status of a segment snapshot.

## Request Syntax
<a name="API_connect-customer-profiles_GetSegmentSnapshot_RequestSyntax"></a>

```
GET /domains/DomainName/segments/SegmentDefinitionName/snapshots/SnapshotId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetSegmentSnapshot_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_GetSegmentSnapshot_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentSnapshot-request-uri-DomainName"></a>
The unique identifier of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [SegmentDefinitionName](#API_connect-customer-profiles_GetSegmentSnapshot_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentSnapshot-request-uri-SegmentDefinitionName"></a>
The unique name of the segment definition.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [SnapshotId](#API_connect-customer-profiles_GetSegmentSnapshot_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentSnapshot-request-uri-SnapshotId"></a>
The unique identifier of the segment snapshot.  
Pattern: `[a-f0-9]{32}`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetSegmentSnapshot_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_GetSegmentSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "DataFormat": "string",
   "DestinationUri": "string",
   "EncryptionKey": "string",
   "RoleArn": "string",
   "SnapshotId": "string",
   "Status": "string",
   "StatusMessage": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetSegmentSnapshot_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DataFormat](#API_connect-customer-profiles_GetSegmentSnapshot_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentSnapshot-response-DataFormat"></a>
The format in which the segment will be exported.  
Type: String  
Valid Values: `CSV | JSONL | ORC` 

 ** [DestinationUri](#API_connect-customer-profiles_GetSegmentSnapshot_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentSnapshot-response-DestinationUri"></a>
The destination to which the segment will be exported. This field must be provided if the request is not submitted from the Amazon Connect Admin Website.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [EncryptionKey](#API_connect-customer-profiles_GetSegmentSnapshot_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentSnapshot-response-EncryptionKey"></a>
The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported segment.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.

 ** [RoleArn](#API_connect-customer-profiles_GetSegmentSnapshot_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentSnapshot-response-RoleArn"></a>
The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service principal to assume the role for conducting KMS and S3 operations.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `arn:aws:iam:.*:[0-9]+:.*` 

 ** [SnapshotId](#API_connect-customer-profiles_GetSegmentSnapshot_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentSnapshot-response-SnapshotId"></a>
The unique identifier of the segment snapshot.  
Type: String  
Pattern: `[a-f0-9]{32}` 

 ** [Status](#API_connect-customer-profiles_GetSegmentSnapshot_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentSnapshot-response-Status"></a>
The status of the asynchronous job for exporting the segment snapshot.  
Type: String  
Valid Values: `COMPLETED | IN_PROGRESS | FAILED` 

 ** [StatusMessage](#API_connect-customer-profiles_GetSegmentSnapshot_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSegmentSnapshot-response-StatusMessage"></a>
The status message of the asynchronous job for exporting the segment snapshot.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.

## Errors
<a name="API_connect-customer-profiles_GetSegmentSnapshot_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetSegmentSnapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetSegmentSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetSegmentSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetSegmentSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetSegmentSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetSegmentSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetSegmentSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetSegmentSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetSegmentSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetSegmentSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetSegmentSnapshot) 

# GetSimilarProfiles
<a name="API_connect-customer-profiles_GetSimilarProfiles"></a>

Returns a set of profiles that belong to the same matching group using the `matchId` or `profileId`. You can also specify the type of matching that you want for finding similar profiles using either `RULE_BASED_MATCHING` or `ML_BASED_MATCHING`.

## Request Syntax
<a name="API_connect-customer-profiles_GetSimilarProfiles_RequestSyntax"></a>

```
POST /domains/DomainName/matches?max-results=MaxResults&next-token=NextToken HTTP/1.1
Content-type: application/json

{
   "MatchType": "string",
   "SearchKey": "string",
   "SearchValue": "string"
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetSimilarProfiles_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_GetSimilarProfiles_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetSimilarProfiles-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [MaxResults](#API_connect-customer-profiles_GetSimilarProfiles_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetSimilarProfiles-request-uri-MaxResults"></a>
The maximum number of objects returned per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_GetSimilarProfiles_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetSimilarProfiles-request-uri-NextToken"></a>
The pagination token from the previous `GetSimilarProfiles` API call.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Request Body
<a name="API_connect-customer-profiles_GetSimilarProfiles_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [MatchType](#API_connect-customer-profiles_GetSimilarProfiles_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetSimilarProfiles-request-MatchType"></a>
Specify the type of matching to get similar profiles for.  
Type: String  
Valid Values: `RULE_BASED_MATCHING | ML_BASED_MATCHING`   
Required: Yes

 ** [SearchKey](#API_connect-customer-profiles_GetSimilarProfiles_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetSimilarProfiles-request-SearchKey"></a>
The string indicating the search key to be used.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** [SearchValue](#API_connect-customer-profiles_GetSimilarProfiles_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetSimilarProfiles-request-SearchValue"></a>
The string based on `SearchKey` to be searched for similar profiles.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_GetSimilarProfiles_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ConfidenceScore": number,
   "MatchId": "string",
   "MatchType": "string",
   "NextToken": "string",
   "ProfileIds": [ "string" ],
   "RuleLevel": number
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetSimilarProfiles_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ConfidenceScore](#API_connect-customer-profiles_GetSimilarProfiles_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSimilarProfiles-response-ConfidenceScore"></a>
It only has value when the `MatchType` is `ML_BASED_MATCHING`.A number between 0 and 1, where a higher score means higher similarity. Examining match confidence scores lets you distinguish between groups of similar records in which the system is highly confident (which you may decide to merge), groups of similar records about which the system is uncertain (which you may decide to have reviewed by a human), and groups of similar records that the system deems to be unlikely (which you may decide to reject). Given confidence scores vary as per the data input, it should not be used as an absolute measure of matching quality.  
Type: Double

 ** [MatchId](#API_connect-customer-profiles_GetSimilarProfiles_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSimilarProfiles-response-MatchId"></a>
The string `matchId` that the similar profiles belong to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [MatchType](#API_connect-customer-profiles_GetSimilarProfiles_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSimilarProfiles-response-MatchType"></a>
Specify the type of matching to get similar profiles for.  
Type: String  
Valid Values: `RULE_BASED_MATCHING | ML_BASED_MATCHING` 

 ** [NextToken](#API_connect-customer-profiles_GetSimilarProfiles_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSimilarProfiles-response-NextToken"></a>
The pagination token from the previous `GetSimilarProfiles` API call.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [ProfileIds](#API_connect-customer-profiles_GetSimilarProfiles_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSimilarProfiles-response-ProfileIds"></a>
Set of `profileId`s that belong to the same matching group.  
Type: Array of strings  
Pattern: `[a-f0-9]{32}` 

 ** [RuleLevel](#API_connect-customer-profiles_GetSimilarProfiles_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetSimilarProfiles-response-RuleLevel"></a>
The integer rule level that the profiles matched on.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 15.

## Errors
<a name="API_connect-customer-profiles_GetSimilarProfiles_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetSimilarProfiles_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetSimilarProfiles) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetSimilarProfiles) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetSimilarProfiles) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetSimilarProfiles) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetSimilarProfiles) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetSimilarProfiles) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetSimilarProfiles) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetSimilarProfiles) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetSimilarProfiles) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetSimilarProfiles) 

# GetUploadJob
<a name="API_connect-customer-profiles_GetUploadJob"></a>

This API retrieves the details of a specific upload job. 

## Request Syntax
<a name="API_connect-customer-profiles_GetUploadJob_RequestSyntax"></a>

```
GET /domains/DomainName/upload-jobs/JobId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetUploadJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_GetUploadJob_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetUploadJob-request-uri-DomainName"></a>
The unique name of the domain containing the upload job.   
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [JobId](#API_connect-customer-profiles_GetUploadJob_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetUploadJob-request-uri-JobId"></a>
The unique identifier of the upload job to retrieve.   
Pattern: `[a-f0-9]{32}`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetUploadJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_GetUploadJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CompletedAt": number,
   "CreatedAt": number,
   "DataExpiry": number,
   "DisplayName": "string",
   "Fields": { 
      "string" : { 
         "ContentType": "string",
         "Source": "string",
         "Target": "string"
      }
   },
   "JobId": "string",
   "ResultsSummary": { 
      "CreatedRecords": number,
      "FailedRecords": number,
      "UpdatedRecords": number
   },
   "Status": "string",
   "StatusReason": "string",
   "UniqueKey": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetUploadJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CompletedAt](#API_connect-customer-profiles_GetUploadJob_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetUploadJob-response-CompletedAt"></a>
The timestamp when the upload job was completed.   
Type: Timestamp

 ** [CreatedAt](#API_connect-customer-profiles_GetUploadJob_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetUploadJob-response-CreatedAt"></a>
The timestamp when the upload job was created.   
Type: Timestamp

 ** [DataExpiry](#API_connect-customer-profiles_GetUploadJob_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetUploadJob-response-DataExpiry"></a>
The expiry duration for the profiles ingested with the upload job.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1098.

 ** [DisplayName](#API_connect-customer-profiles_GetUploadJob_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetUploadJob-response-DisplayName"></a>
The unique name of the upload job. Could be a file name to identify the upload job.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [Fields](#API_connect-customer-profiles_GetUploadJob_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetUploadJob-response-Fields"></a>
The mapping between CSV Columns and Profile Object attributes for the upload job.   
Type: String to [ObjectTypeField](API_connect-customer-profiles_ObjectTypeField.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Key Pattern: `^[a-zA-Z0-9_.-]+$` 

 ** [JobId](#API_connect-customer-profiles_GetUploadJob_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetUploadJob-response-JobId"></a>
The unique identifier of the upload job.   
Type: String  
Pattern: `[a-f0-9]{32}` 

 ** [ResultsSummary](#API_connect-customer-profiles_GetUploadJob_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetUploadJob-response-ResultsSummary"></a>
The summary of results for the upload job, including the number of updated, created, and failed records.   
Type: [ResultsSummary](API_connect-customer-profiles_ResultsSummary.md) object

 ** [Status](#API_connect-customer-profiles_GetUploadJob_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetUploadJob-response-Status"></a>
The status describing the status for the upload job. The following are Valid Values:   
+  **CREATED**: The upload job has been created, but has not started processing yet. 
+  **IN\$1PROGRESS**: The upload job is currently in progress, ingesting and processing the profile data. 
+  **PARTIALLY\$1SUCCEEDED**: The upload job has successfully completed the ingestion and processing of all profile data. 
+  **SUCCEEDED**: The upload job has successfully completed the ingestion and processing of all profile data. 
+  **FAILED**: The upload job has failed to complete. 
+  **STOPPED**: The upload job has been manually stopped or terminated before completion. 
Type: String  
Valid Values: `CREATED | IN_PROGRESS | PARTIALLY_SUCCEEDED | SUCCEEDED | FAILED | STOPPED` 

 ** [StatusReason](#API_connect-customer-profiles_GetUploadJob_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetUploadJob-response-StatusReason"></a>
The reason for the current status of the upload job. Possible reasons:   
+  **VALIDATION\$1FAILURE**: The upload job has encountered an error or issue and was unable to complete the profile data ingestion. 
+  **INTERNAL\$1FAILURE**: Failure caused from service side 
Type: String  
Valid Values: `VALIDATION_FAILURE | INTERNAL_FAILURE` 

 ** [UniqueKey](#API_connect-customer-profiles_GetUploadJob_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetUploadJob-response-UniqueKey"></a>
The unique key columns used for de-duping the keys in the upload job.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.

## Errors
<a name="API_connect-customer-profiles_GetUploadJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetUploadJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetUploadJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetUploadJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetUploadJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetUploadJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetUploadJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetUploadJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetUploadJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetUploadJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetUploadJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetUploadJob) 

# GetUploadJobPath
<a name="API_connect-customer-profiles_GetUploadJobPath"></a>

This API retrieves the pre-signed URL and client token for uploading the file associated with the upload job. 

## Request Syntax
<a name="API_connect-customer-profiles_GetUploadJobPath_RequestSyntax"></a>

```
GET /domains/DomainName/upload-jobs/JobId/path HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetUploadJobPath_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_GetUploadJobPath_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetUploadJobPath-request-uri-DomainName"></a>
The unique name of the domain containing the upload job.   
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [JobId](#API_connect-customer-profiles_GetUploadJobPath_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetUploadJobPath-request-uri-JobId"></a>
The unique identifier of the upload job to retrieve the upload path for. This is generated from the CreateUploadJob API.   
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetUploadJobPath_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_GetUploadJobPath_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ClientToken": "string",
   "Url": "string",
   "ValidUntil": number
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetUploadJobPath_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ClientToken](#API_connect-customer-profiles_GetUploadJobPath_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetUploadJobPath-response-ClientToken"></a>
The plaintext data key used to encrypt the upload file.   
To persist to the pre-signed url, use the client token and MD5 client token as header. The required headers are as follows:   
+ x-amz-server-side-encryption-customer-key: Client Token 
+ x-amz-server-side-encryption-customer-key-MD5: MD5 Client Token 
+ x-amz-server-side-encryption-customer-algorithm: AES256 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.

 ** [Url](#API_connect-customer-profiles_GetUploadJobPath_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetUploadJobPath-response-Url"></a>
The pre-signed S3 URL for uploading the CSV file associated with the upload job.   
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `.*` 

 ** [ValidUntil](#API_connect-customer-profiles_GetUploadJobPath_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetUploadJobPath-response-ValidUntil"></a>
The expiry timestamp for the pre-signed URL, after which the URL will no longer be valid.   
Type: Timestamp

## Errors
<a name="API_connect-customer-profiles_GetUploadJobPath_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetUploadJobPath_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetUploadJobPath) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetUploadJobPath) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetUploadJobPath) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetUploadJobPath) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetUploadJobPath) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetUploadJobPath) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetUploadJobPath) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetUploadJobPath) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetUploadJobPath) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetUploadJobPath) 

# GetWorkflow
<a name="API_connect-customer-profiles_GetWorkflow"></a>

Get details of specified workflow.

## Request Syntax
<a name="API_connect-customer-profiles_GetWorkflow_RequestSyntax"></a>

```
GET /domains/DomainName/workflows/WorkflowId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetWorkflow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_GetWorkflow_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetWorkflow-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [WorkflowId](#API_connect-customer-profiles_GetWorkflow_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetWorkflow-request-uri-WorkflowId"></a>
Unique identifier for the workflow.  
Pattern: `[a-f0-9]{32}`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetWorkflow_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_GetWorkflow_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Attributes": { 
      "AppflowIntegration": { 
         "ConnectorProfileName": "string",
         "RoleArn": "string",
         "SourceConnectorType": "string"
      }
   },
   "ErrorDescription": "string",
   "LastUpdatedAt": number,
   "Metrics": { 
      "AppflowIntegration": { 
         "RecordsProcessed": number,
         "StepsCompleted": number,
         "TotalSteps": number
      }
   },
   "StartDate": number,
   "Status": "string",
   "WorkflowId": "string",
   "WorkflowType": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetWorkflow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Attributes](#API_connect-customer-profiles_GetWorkflow_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetWorkflow-response-Attributes"></a>
Attributes provided for workflow execution.  
Type: [WorkflowAttributes](API_connect-customer-profiles_WorkflowAttributes.md) object

 ** [ErrorDescription](#API_connect-customer-profiles_GetWorkflow_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetWorkflow-response-ErrorDescription"></a>
Workflow error messages during execution (if any).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [LastUpdatedAt](#API_connect-customer-profiles_GetWorkflow_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetWorkflow-response-LastUpdatedAt"></a>
The timestamp that represents when workflow execution last updated.  
Type: Timestamp

 ** [Metrics](#API_connect-customer-profiles_GetWorkflow_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetWorkflow-response-Metrics"></a>
Workflow specific execution metrics.  
Type: [WorkflowMetrics](API_connect-customer-profiles_WorkflowMetrics.md) object

 ** [StartDate](#API_connect-customer-profiles_GetWorkflow_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetWorkflow-response-StartDate"></a>
The timestamp that represents when workflow execution started.  
Type: Timestamp

 ** [Status](#API_connect-customer-profiles_GetWorkflow_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetWorkflow-response-Status"></a>
Status of workflow execution.  
Type: String  
Valid Values: `NOT_STARTED | IN_PROGRESS | COMPLETE | FAILED | SPLIT | RETRY | CANCELLED` 

 ** [WorkflowId](#API_connect-customer-profiles_GetWorkflow_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetWorkflow-response-WorkflowId"></a>
Unique identifier for the workflow.  
Type: String  
Pattern: `[a-f0-9]{32}` 

 ** [WorkflowType](#API_connect-customer-profiles_GetWorkflow_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetWorkflow-response-WorkflowType"></a>
The type of workflow. The only supported value is APPFLOW\$1INTEGRATION.  
Type: String  
Valid Values: `APPFLOW_INTEGRATION` 

## Errors
<a name="API_connect-customer-profiles_GetWorkflow_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetWorkflow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetWorkflow) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetWorkflow) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetWorkflow) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetWorkflow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetWorkflow) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetWorkflow) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetWorkflow) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetWorkflow) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetWorkflow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetWorkflow) 

# GetWorkflowSteps
<a name="API_connect-customer-profiles_GetWorkflowSteps"></a>

Get granular list of steps in workflow.

## Request Syntax
<a name="API_connect-customer-profiles_GetWorkflowSteps_RequestSyntax"></a>

```
GET /domains/DomainName/workflows/WorkflowId/steps?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_GetWorkflowSteps_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_GetWorkflowSteps_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetWorkflowSteps-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [MaxResults](#API_connect-customer-profiles_GetWorkflowSteps_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetWorkflowSteps-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_GetWorkflowSteps_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetWorkflowSteps-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [WorkflowId](#API_connect-customer-profiles_GetWorkflowSteps_RequestSyntax) **   <a name="connect-connect-customer-profiles_GetWorkflowSteps-request-uri-WorkflowId"></a>
Unique identifier for the workflow.  
Pattern: `[a-f0-9]{32}`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_GetWorkflowSteps_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_GetWorkflowSteps_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "AppflowIntegration": { 
            "BatchRecordsEndTime": "string",
            "BatchRecordsStartTime": "string",
            "CreatedAt": number,
            "ExecutionMessage": "string",
            "FlowName": "string",
            "LastUpdatedAt": number,
            "RecordsProcessed": number,
            "Status": "string"
         }
      }
   ],
   "NextToken": "string",
   "WorkflowId": "string",
   "WorkflowType": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_GetWorkflowSteps_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_connect-customer-profiles_GetWorkflowSteps_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetWorkflowSteps-response-Items"></a>
List containing workflow step details.  
Type: Array of [WorkflowStepItem](API_connect-customer-profiles_WorkflowStepItem.md) objects

 ** [NextToken](#API_connect-customer-profiles_GetWorkflowSteps_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetWorkflowSteps-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [WorkflowId](#API_connect-customer-profiles_GetWorkflowSteps_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetWorkflowSteps-response-WorkflowId"></a>
Unique identifier for the workflow.  
Type: String  
Pattern: `[a-f0-9]{32}` 

 ** [WorkflowType](#API_connect-customer-profiles_GetWorkflowSteps_ResponseSyntax) **   <a name="connect-connect-customer-profiles_GetWorkflowSteps-response-WorkflowType"></a>
The type of workflow. The only supported value is APPFLOW\$1INTEGRATION.  
Type: String  
Valid Values: `APPFLOW_INTEGRATION` 

## Errors
<a name="API_connect-customer-profiles_GetWorkflowSteps_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_GetWorkflowSteps_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/GetWorkflowSteps) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/GetWorkflowSteps) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/GetWorkflowSteps) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/GetWorkflowSteps) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/GetWorkflowSteps) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/GetWorkflowSteps) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/GetWorkflowSteps) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/GetWorkflowSteps) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/GetWorkflowSteps) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/GetWorkflowSteps) 

# ListAccountIntegrations
<a name="API_connect-customer-profiles_ListAccountIntegrations"></a>

Lists all of the integrations associated to a specific URI in the AWS account.

## Request Syntax
<a name="API_connect-customer-profiles_ListAccountIntegrations_RequestSyntax"></a>

```
POST /integrations?include-hidden=IncludeHidden&max-results=MaxResults&next-token=NextToken HTTP/1.1
Content-type: application/json

{
   "Uri": "string"
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListAccountIntegrations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [IncludeHidden](#API_connect-customer-profiles_ListAccountIntegrations_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListAccountIntegrations-request-uri-IncludeHidden"></a>
Boolean to indicate if hidden integration should be returned. Defaults to `False`.

 ** [MaxResults](#API_connect-customer-profiles_ListAccountIntegrations_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListAccountIntegrations-request-uri-MaxResults"></a>
The maximum number of objects returned per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_ListAccountIntegrations_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListAccountIntegrations-request-uri-NextToken"></a>
The pagination token from the previous ListAccountIntegrations API call.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Request Body
<a name="API_connect-customer-profiles_ListAccountIntegrations_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Uri](#API_connect-customer-profiles_ListAccountIntegrations_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListAccountIntegrations-request-Uri"></a>
The URI of the S3 bucket or any other type of data source.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_ListAccountIntegrations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "CreatedAt": number,
         "DomainName": "string",
         "EventTriggerNames": [ "string" ],
         "IsUnstructured": boolean,
         "LastUpdatedAt": number,
         "ObjectTypeName": "string",
         "ObjectTypeNames": { 
            "string" : "string" 
         },
         "RoleArn": "string",
         "Scope": "string",
         "Tags": { 
            "string" : "string" 
         },
         "Uri": "string",
         "WorkflowId": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListAccountIntegrations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_connect-customer-profiles_ListAccountIntegrations_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListAccountIntegrations-response-Items"></a>
The list of ListAccountIntegration instances.  
Type: Array of [ListIntegrationItem](API_connect-customer-profiles_ListIntegrationItem.md) objects

 ** [NextToken](#API_connect-customer-profiles_ListAccountIntegrations_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListAccountIntegrations-response-NextToken"></a>
The pagination token from the previous ListAccountIntegrations API call.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_connect-customer-profiles_ListAccountIntegrations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_ListAccountIntegrations_Examples"></a>

### Example
<a name="API_connect-customer-profiles_ListAccountIntegrations_Example_1"></a>

This example illustrates one usage of ListAccountIntegrations.

#### Sample Request
<a name="API_connect-customer-profiles_ListAccountIntegrations_Example_1_Request"></a>

```
POST /integrations?max-results=10&next-token={NextToken} HTTP/1.1

{
   "Uri": "arn:aws:sqs:us-east-1:123456789012:URIOfIntegration1"
}
```

#### Sample Response
<a name="API_connect-customer-profiles_ListAccountIntegrations_Example_1_Response"></a>

```
Content-type: application/json
{
   "Items": [ 
      { 
         "CreatedAt": 1479249799770,
         "DomainName": "ExampleDomainName",
         "LastUpdatedAt": 1479249799770,
         "ObjectTypeName": "MyCustomObject",
         "Uri": "arn:aws:flow:us-east-1:123456789012:URIOfIntegration1"
      }
   ],
   "NextToken": "e17145a2-916b-42a2-b4d3-0267fEXAMPLE"
}
```

## See Also
<a name="API_connect-customer-profiles_ListAccountIntegrations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListAccountIntegrations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListAccountIntegrations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListAccountIntegrations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListAccountIntegrations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListAccountIntegrations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListAccountIntegrations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListAccountIntegrations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListAccountIntegrations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListAccountIntegrations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListAccountIntegrations) 

# ListCalculatedAttributeDefinitions
<a name="API_connect-customer-profiles_ListCalculatedAttributeDefinitions"></a>

Lists calculated attribute definitions for Customer Profiles

## Request Syntax
<a name="API_connect-customer-profiles_ListCalculatedAttributeDefinitions_RequestSyntax"></a>

```
GET /domains/DomainName/calculated-attributes?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListCalculatedAttributeDefinitions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_ListCalculatedAttributeDefinitions_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListCalculatedAttributeDefinitions-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [MaxResults](#API_connect-customer-profiles_ListCalculatedAttributeDefinitions_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListCalculatedAttributeDefinitions-request-uri-MaxResults"></a>
The maximum number of calculated attribute definitions returned per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_ListCalculatedAttributeDefinitions_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListCalculatedAttributeDefinitions-request-uri-NextToken"></a>
The pagination token from the previous call to ListCalculatedAttributeDefinitions.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Request Body
<a name="API_connect-customer-profiles_ListCalculatedAttributeDefinitions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_ListCalculatedAttributeDefinitions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "CalculatedAttributeName": "string",
         "CreatedAt": number,
         "Description": "string",
         "DisplayName": "string",
         "LastUpdatedAt": number,
         "Status": "string",
         "Tags": { 
            "string" : "string" 
         },
         "UseHistoricalData": boolean
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListCalculatedAttributeDefinitions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_connect-customer-profiles_ListCalculatedAttributeDefinitions_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListCalculatedAttributeDefinitions-response-Items"></a>
The list of calculated attribute definitions.  
Type: Array of [ListCalculatedAttributeDefinitionItem](API_connect-customer-profiles_ListCalculatedAttributeDefinitionItem.md) objects

 ** [NextToken](#API_connect-customer-profiles_ListCalculatedAttributeDefinitions_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListCalculatedAttributeDefinitions-response-NextToken"></a>
The pagination token from the previous call to ListCalculatedAttributeDefinitions.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_connect-customer-profiles_ListCalculatedAttributeDefinitions_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_ListCalculatedAttributeDefinitions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListCalculatedAttributeDefinitions) 

# ListCalculatedAttributesForProfile
<a name="API_connect-customer-profiles_ListCalculatedAttributesForProfile"></a>

Retrieve a list of calculated attributes for a customer profile.

## Request Syntax
<a name="API_connect-customer-profiles_ListCalculatedAttributesForProfile_RequestSyntax"></a>

```
GET /domains/DomainName/profile/ProfileId/calculated-attributes?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListCalculatedAttributesForProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_ListCalculatedAttributesForProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListCalculatedAttributesForProfile-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [MaxResults](#API_connect-customer-profiles_ListCalculatedAttributesForProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListCalculatedAttributesForProfile-request-uri-MaxResults"></a>
The maximum number of calculated attributes returned per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_ListCalculatedAttributesForProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListCalculatedAttributesForProfile-request-uri-NextToken"></a>
The pagination token from the previous call to ListCalculatedAttributesForProfile.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [ProfileId](#API_connect-customer-profiles_ListCalculatedAttributesForProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListCalculatedAttributesForProfile-request-uri-ProfileId"></a>
The unique identifier of a customer profile.  
Pattern: `[a-f0-9]{32}`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_ListCalculatedAttributesForProfile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_ListCalculatedAttributesForProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "CalculatedAttributeName": "string",
         "DisplayName": "string",
         "IsDataPartial": "string",
         "LastObjectTimestamp": number,
         "Value": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListCalculatedAttributesForProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_connect-customer-profiles_ListCalculatedAttributesForProfile_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListCalculatedAttributesForProfile-response-Items"></a>
The list of calculated attributes.  
Type: Array of [ListCalculatedAttributeForProfileItem](API_connect-customer-profiles_ListCalculatedAttributeForProfileItem.md) objects

 ** [NextToken](#API_connect-customer-profiles_ListCalculatedAttributesForProfile_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListCalculatedAttributesForProfile-response-NextToken"></a>
The pagination token from the previous call to ListCalculatedAttributesForProfile.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_connect-customer-profiles_ListCalculatedAttributesForProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_ListCalculatedAttributesForProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListCalculatedAttributesForProfile) 

# ListDomainLayouts
<a name="API_connect-customer-profiles_ListDomainLayouts"></a>

Lists the existing layouts that can be used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

## Request Syntax
<a name="API_connect-customer-profiles_ListDomainLayouts_RequestSyntax"></a>

```
GET /domains/DomainName/layouts?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListDomainLayouts_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_ListDomainLayouts_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListDomainLayouts-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [MaxResults](#API_connect-customer-profiles_ListDomainLayouts_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListDomainLayouts-request-uri-MaxResults"></a>
The maximum number of objects returned per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_ListDomainLayouts_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListDomainLayouts-request-uri-NextToken"></a>
Identifies the next page of results to return.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Request Body
<a name="API_connect-customer-profiles_ListDomainLayouts_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_ListDomainLayouts_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "CreatedAt": number,
         "Description": "string",
         "DisplayName": "string",
         "IsDefault": boolean,
         "LastUpdatedAt": number,
         "LayoutDefinitionName": "string",
         "LayoutType": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListDomainLayouts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_connect-customer-profiles_ListDomainLayouts_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListDomainLayouts-response-Items"></a>
Contains summary information about an EventStream.  
Type: Array of [LayoutItem](API_connect-customer-profiles_LayoutItem.md) objects

 ** [NextToken](#API_connect-customer-profiles_ListDomainLayouts_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListDomainLayouts-response-NextToken"></a>
Identifies the next page of results to return.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_connect-customer-profiles_ListDomainLayouts_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_ListDomainLayouts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListDomainLayouts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListDomainLayouts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListDomainLayouts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListDomainLayouts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListDomainLayouts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListDomainLayouts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListDomainLayouts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListDomainLayouts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListDomainLayouts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListDomainLayouts) 

# ListDomainObjectTypes
<a name="API_connect-customer-profiles_ListDomainObjectTypes"></a>

List all DomainObjectType(s) in a Customer Profiles domain. 

## Request Syntax
<a name="API_connect-customer-profiles_ListDomainObjectTypes_RequestSyntax"></a>

```
GET /domains/DomainName/domain-object-types?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListDomainObjectTypes_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_ListDomainObjectTypes_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListDomainObjectTypes-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [MaxResults](#API_connect-customer-profiles_ListDomainObjectTypes_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListDomainObjectTypes-request-uri-MaxResults"></a>
The maximum number of domain object types returned per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_ListDomainObjectTypes_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListDomainObjectTypes-request-uri-NextToken"></a>
The pagination token from the previous call to ListDomainObjectTypes.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Request Body
<a name="API_connect-customer-profiles_ListDomainObjectTypes_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_ListDomainObjectTypes_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "CreatedAt": number,
         "Description": "string",
         "LastUpdatedAt": number,
         "ObjectTypeName": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListDomainObjectTypes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_connect-customer-profiles_ListDomainObjectTypes_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListDomainObjectTypes-response-Items"></a>
The list of domain object types.  
Type: Array of [DomainObjectTypesListItem](API_connect-customer-profiles_DomainObjectTypesListItem.md) objects

 ** [NextToken](#API_connect-customer-profiles_ListDomainObjectTypes_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListDomainObjectTypes-response-NextToken"></a>
The pagination token from the previous call to ListDomainObjectTypes.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_connect-customer-profiles_ListDomainObjectTypes_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_ListDomainObjectTypes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListDomainObjectTypes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListDomainObjectTypes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListDomainObjectTypes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListDomainObjectTypes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListDomainObjectTypes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListDomainObjectTypes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListDomainObjectTypes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListDomainObjectTypes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListDomainObjectTypes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListDomainObjectTypes) 

# ListDomains
<a name="API_connect-customer-profiles_ListDomains"></a>

Returns a list of all the domains for an AWS account that have been created.

## Request Syntax
<a name="API_connect-customer-profiles_ListDomains_RequestSyntax"></a>

```
GET /domains?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListDomains_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_connect-customer-profiles_ListDomains_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListDomains-request-uri-MaxResults"></a>
The maximum number of objects returned per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_ListDomains_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListDomains-request-uri-NextToken"></a>
The pagination token from the previous ListDomain API call.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Request Body
<a name="API_connect-customer-profiles_ListDomains_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_ListDomains_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "CreatedAt": number,
         "DomainName": "string",
         "LastUpdatedAt": number,
         "Tags": { 
            "string" : "string" 
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListDomains_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_connect-customer-profiles_ListDomains_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListDomains-response-Items"></a>
The list of ListDomains instances.  
Type: Array of [ListDomainItem](API_connect-customer-profiles_ListDomainItem.md) objects

 ** [NextToken](#API_connect-customer-profiles_ListDomains_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListDomains-response-NextToken"></a>
The pagination token from the previous ListDomains API call.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_connect-customer-profiles_ListDomains_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_ListDomains_Examples"></a>

### Example
<a name="API_connect-customer-profiles_ListDomains_Example_1"></a>

This example illustrates one usage of ListDomains.

#### Sample Request
<a name="API_connect-customer-profiles_ListDomains_Example_1_Request"></a>

```
GET /v1/domains?max-results={MaxResults} //First call
```

#### Sample Request
<a name="API_connect-customer-profiles_ListDomains_Example_1_Request"></a>

```
GET /v1/domains?next-token={NextToken};max-results={MaxResults} //Subsequent calls
```

#### Sample Response
<a name="API_connect-customer-profiles_ListDomains_Example_1_Response"></a>

```
Content-type: application/json 
{ 
   "NextToken": "fcc66dce-8356-4ddb-9f20-911c0EXAMPLE", 
   "Items": [
       {
         "CreatedAt": 1479249799770, 
         "LastUpdatedAt": 1479249799770, 
         "Name": "ExampleDomain1"
       },
       {
         "CreatedAt": 1479249799770, 
         "LastUpdatedAt": 1479249799770, 
         "Name": "ExampleDomain2" 
       }
   ]
}
```

## See Also
<a name="API_connect-customer-profiles_ListDomains_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListDomains) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListDomains) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListDomains) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListDomains) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListDomains) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListDomains) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListDomains) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListDomains) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListDomains) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListDomains) 

# ListEventStreams
<a name="API_connect-customer-profiles_ListEventStreams"></a>

Returns a list of all the event streams in a specific domain.

## Request Syntax
<a name="API_connect-customer-profiles_ListEventStreams_RequestSyntax"></a>

```
GET /domains/DomainName/event-streams?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListEventStreams_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_ListEventStreams_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListEventStreams-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [MaxResults](#API_connect-customer-profiles_ListEventStreams_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListEventStreams-request-uri-MaxResults"></a>
The maximum number of objects returned per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_ListEventStreams_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListEventStreams-request-uri-NextToken"></a>
Identifies the next page of results to return.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Request Body
<a name="API_connect-customer-profiles_ListEventStreams_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_ListEventStreams_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "DestinationSummary": { 
            "Status": "string",
            "UnhealthySince": number,
            "Uri": "string"
         },
         "DomainName": "string",
         "EventStreamArn": "string",
         "EventStreamName": "string",
         "State": "string",
         "StoppedSince": number,
         "Tags": { 
            "string" : "string" 
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListEventStreams_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_connect-customer-profiles_ListEventStreams_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListEventStreams-response-Items"></a>
Contains summary information about an EventStream.  
Type: Array of [EventStreamSummary](API_connect-customer-profiles_EventStreamSummary.md) objects

 ** [NextToken](#API_connect-customer-profiles_ListEventStreams_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListEventStreams-response-NextToken"></a>
Identifies the next page of results to return.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_connect-customer-profiles_ListEventStreams_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_ListEventStreams_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListEventStreams) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListEventStreams) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListEventStreams) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListEventStreams) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListEventStreams) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListEventStreams) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListEventStreams) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListEventStreams) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListEventStreams) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListEventStreams) 

# ListEventTriggers
<a name="API_connect-customer-profiles_ListEventTriggers"></a>

List all Event Triggers under a domain.

## Request Syntax
<a name="API_connect-customer-profiles_ListEventTriggers_RequestSyntax"></a>

```
GET /domains/DomainName/event-triggers?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListEventTriggers_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_ListEventTriggers_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListEventTriggers-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [MaxResults](#API_connect-customer-profiles_ListEventTriggers_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListEventTriggers-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_ListEventTriggers_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListEventTriggers-request-uri-NextToken"></a>
The pagination token to use with ListEventTriggers.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Request Body
<a name="API_connect-customer-profiles_ListEventTriggers_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_ListEventTriggers_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "CreatedAt": number,
         "Description": "string",
         "EventTriggerName": "string",
         "LastUpdatedAt": number,
         "ObjectTypeName": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListEventTriggers_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_connect-customer-profiles_ListEventTriggers_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListEventTriggers-response-Items"></a>
The list of Event Triggers.  
Type: Array of [EventTriggerSummaryItem](API_connect-customer-profiles_EventTriggerSummaryItem.md) objects

 ** [NextToken](#API_connect-customer-profiles_ListEventTriggers_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListEventTriggers-response-NextToken"></a>
The pagination token from the previous call to ListEventTriggers.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_connect-customer-profiles_ListEventTriggers_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_ListEventTriggers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListEventTriggers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListEventTriggers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListEventTriggers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListEventTriggers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListEventTriggers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListEventTriggers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListEventTriggers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListEventTriggers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListEventTriggers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListEventTriggers) 

# ListIdentityResolutionJobs
<a name="API_connect-customer-profiles_ListIdentityResolutionJobs"></a>

Lists all of the Identity Resolution Jobs in your domain. The response sorts the list by `JobStartTime`.

## Request Syntax
<a name="API_connect-customer-profiles_ListIdentityResolutionJobs_RequestSyntax"></a>

```
GET /domains/DomainName/identity-resolution-jobs?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListIdentityResolutionJobs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_ListIdentityResolutionJobs_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListIdentityResolutionJobs-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [MaxResults](#API_connect-customer-profiles_ListIdentityResolutionJobs_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListIdentityResolutionJobs-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_ListIdentityResolutionJobs_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListIdentityResolutionJobs-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Request Body
<a name="API_connect-customer-profiles_ListIdentityResolutionJobs_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_ListIdentityResolutionJobs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "IdentityResolutionJobsList": [ 
      { 
         "DomainName": "string",
         "ExportingLocation": { 
            "S3Exporting": { 
               "S3BucketName": "string",
               "S3KeyName": "string"
            }
         },
         "JobEndTime": number,
         "JobId": "string",
         "JobStartTime": number,
         "JobStats": { 
            "NumberOfMatchesFound": number,
            "NumberOfMergesDone": number,
            "NumberOfProfilesReviewed": number
         },
         "Message": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListIdentityResolutionJobs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [IdentityResolutionJobsList](#API_connect-customer-profiles_ListIdentityResolutionJobs_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListIdentityResolutionJobs-response-IdentityResolutionJobsList"></a>
A list of Identity Resolution Jobs.  
Type: Array of [IdentityResolutionJob](API_connect-customer-profiles_IdentityResolutionJob.md) objects

 ** [NextToken](#API_connect-customer-profiles_ListIdentityResolutionJobs_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListIdentityResolutionJobs-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_connect-customer-profiles_ListIdentityResolutionJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_ListIdentityResolutionJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListIdentityResolutionJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListIdentityResolutionJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListIdentityResolutionJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListIdentityResolutionJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListIdentityResolutionJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListIdentityResolutionJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListIdentityResolutionJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListIdentityResolutionJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListIdentityResolutionJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListIdentityResolutionJobs) 

# ListIntegrations
<a name="API_connect-customer-profiles_ListIntegrations"></a>

Lists all of the integrations in your domain.

## Request Syntax
<a name="API_connect-customer-profiles_ListIntegrations_RequestSyntax"></a>

```
GET /domains/DomainName/integrations?include-hidden=IncludeHidden&max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListIntegrations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_ListIntegrations_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListIntegrations-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [IncludeHidden](#API_connect-customer-profiles_ListIntegrations_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListIntegrations-request-uri-IncludeHidden"></a>
Boolean to indicate if hidden integration should be returned. Defaults to `False`.

 ** [MaxResults](#API_connect-customer-profiles_ListIntegrations_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListIntegrations-request-uri-MaxResults"></a>
The maximum number of objects returned per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_ListIntegrations_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListIntegrations-request-uri-NextToken"></a>
The pagination token from the previous ListIntegrations API call.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Request Body
<a name="API_connect-customer-profiles_ListIntegrations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_ListIntegrations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "CreatedAt": number,
         "DomainName": "string",
         "EventTriggerNames": [ "string" ],
         "IsUnstructured": boolean,
         "LastUpdatedAt": number,
         "ObjectTypeName": "string",
         "ObjectTypeNames": { 
            "string" : "string" 
         },
         "RoleArn": "string",
         "Scope": "string",
         "Tags": { 
            "string" : "string" 
         },
         "Uri": "string",
         "WorkflowId": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListIntegrations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_connect-customer-profiles_ListIntegrations_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListIntegrations-response-Items"></a>
The list of ListIntegrations instances.  
Type: Array of [ListIntegrationItem](API_connect-customer-profiles_ListIntegrationItem.md) objects

 ** [NextToken](#API_connect-customer-profiles_ListIntegrations_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListIntegrations-response-NextToken"></a>
The pagination token from the previous ListIntegrations API call.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_connect-customer-profiles_ListIntegrations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_ListIntegrations_Examples"></a>

### Example
<a name="API_connect-customer-profiles_ListIntegrations_Example_1"></a>

This example illustrates one usage of ListIntegrations.

#### Sample Request
<a name="API_connect-customer-profiles_ListIntegrations_Example_1_Request"></a>

```
GET /domains/{DomainName}/integrations?max-results={MaxResults}&next-token={NextToken} HTTP/1.1
```

#### Sample Response
<a name="API_connect-customer-profiles_ListIntegrations_Example_1_Response"></a>

```
Content-type: application/json
{
   "Items": [ 
      { 
         "CreatedAt": 1479249799770,
         "DomainName": "ExampleDomainName",
         "LastUpdatedAt": 1479249799770,
         "ObjectTypeName": "SalesForce-Account",
         "Uri": "arn:aws:flow:us-east-1:123456789012:URIOfIntegration1"
      },
      { 
         "CreatedAt": 1479249799770,
         "DomainName": "ExampleDomainName2",
         "LastUpdatedAt": 1479249799770,
         "ObjectTypeName": "MyCustomObjectName",
         "Uri": "arn:aws:flow:us-east-1:123456789012:URIOfIntegration2"
      }
   ],
   "NextToken": "e17145a2-916b-42a2-b4d3-0267fEXAMPLE"
}
```

## See Also
<a name="API_connect-customer-profiles_ListIntegrations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListIntegrations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListIntegrations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListIntegrations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListIntegrations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListIntegrations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListIntegrations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListIntegrations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListIntegrations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListIntegrations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListIntegrations) 

# ListObjectTypeAttributes
<a name="API_connect-customer-profiles_ListObjectTypeAttributes"></a>

Fetch the possible attribute values given the attribute name.

## Request Syntax
<a name="API_connect-customer-profiles_ListObjectTypeAttributes_RequestSyntax"></a>

```
GET /domains/DomainName/object-types/ObjectTypeName/attributes?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListObjectTypeAttributes_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_ListObjectTypeAttributes_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListObjectTypeAttributes-request-uri-DomainName"></a>
The unique identifier of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [MaxResults](#API_connect-customer-profiles_ListObjectTypeAttributes_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListObjectTypeAttributes-request-uri-MaxResults"></a>
The maximum number of objects returned per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_ListObjectTypeAttributes_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListObjectTypeAttributes-request-uri-NextToken"></a>
The pagination token from the previous call.   
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [ObjectTypeName](#API_connect-customer-profiles_ListObjectTypeAttributes_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListObjectTypeAttributes-request-uri-ObjectTypeName"></a>
The name of the profile object type.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_ListObjectTypeAttributes_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_ListObjectTypeAttributes_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "AttributeName": "string",
         "LastUpdatedAt": number
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListObjectTypeAttributes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_connect-customer-profiles_ListObjectTypeAttributes_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListObjectTypeAttributes-response-Items"></a>
The items returned as part of the response.  
Type: Array of [ListObjectTypeAttributeItem](API_connect-customer-profiles_ListObjectTypeAttributeItem.md) objects

 ** [NextToken](#API_connect-customer-profiles_ListObjectTypeAttributes_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListObjectTypeAttributes-response-NextToken"></a>
The pagination token from the previous call.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_connect-customer-profiles_ListObjectTypeAttributes_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_ListObjectTypeAttributes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListObjectTypeAttributes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListObjectTypeAttributes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListObjectTypeAttributes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListObjectTypeAttributes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListObjectTypeAttributes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListObjectTypeAttributes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListObjectTypeAttributes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListObjectTypeAttributes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListObjectTypeAttributes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListObjectTypeAttributes) 

# ListObjectTypeAttributeValues
<a name="API_connect-customer-profiles_ListObjectTypeAttributeValues"></a>

The ListObjectTypeAttributeValues API provides access to the most recent distinct values for any specified attribute, making it valuable for real-time data validation and consistency checks within your object types. This API works across domain, supporting both custom and standard object types. The API accepts the object type name, attribute name, and domain name as input parameters and returns values up to the storage limit of approximately 350KB.

## Request Syntax
<a name="API_connect-customer-profiles_ListObjectTypeAttributeValues_RequestSyntax"></a>

```
GET /domains/DomainName/object-types/ObjectTypeName/attributes/AttributeName/values?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListObjectTypeAttributeValues_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AttributeName](#API_connect-customer-profiles_ListObjectTypeAttributeValues_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListObjectTypeAttributeValues-request-uri-AttributeName"></a>
The attribute name.  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

 ** [DomainName](#API_connect-customer-profiles_ListObjectTypeAttributeValues_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListObjectTypeAttributeValues-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [MaxResults](#API_connect-customer-profiles_ListObjectTypeAttributeValues_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListObjectTypeAttributeValues-request-uri-MaxResults"></a>
The maximum number of objects returned per page. Valid Range: Minimum value of 1. Maximum value of 100. If not provided default as 100.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_ListObjectTypeAttributeValues_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListObjectTypeAttributeValues-request-uri-NextToken"></a>
The pagination token from the previous call.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [ObjectTypeName](#API_connect-customer-profiles_ListObjectTypeAttributeValues_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListObjectTypeAttributeValues-request-uri-ObjectTypeName"></a>
The unique name of the domain object type.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_ListObjectTypeAttributeValues_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_ListObjectTypeAttributeValues_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "LastUpdatedAt": number,
         "Value": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListObjectTypeAttributeValues_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_connect-customer-profiles_ListObjectTypeAttributeValues_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListObjectTypeAttributeValues-response-Items"></a>
A list of unique attribute values sorted on the basis of LastUpdatedAt.   
Type: Array of [ListObjectTypeAttributeValuesItem](API_connect-customer-profiles_ListObjectTypeAttributeValuesItem.md) objects

 ** [NextToken](#API_connect-customer-profiles_ListObjectTypeAttributeValues_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListObjectTypeAttributeValues-response-NextToken"></a>
The pagination token from the previous call to call ListObjectTypeAttributeValues.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_connect-customer-profiles_ListObjectTypeAttributeValues_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_ListObjectTypeAttributeValues_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListObjectTypeAttributeValues) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListObjectTypeAttributeValues) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListObjectTypeAttributeValues) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListObjectTypeAttributeValues) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListObjectTypeAttributeValues) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListObjectTypeAttributeValues) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListObjectTypeAttributeValues) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListObjectTypeAttributeValues) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListObjectTypeAttributeValues) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListObjectTypeAttributeValues) 

# ListProfileAttributeValues
<a name="API_connect-customer-profiles_ListProfileAttributeValues"></a>

Fetch the possible attribute values given the attribute name.

## Request Syntax
<a name="API_connect-customer-profiles_ListProfileAttributeValues_RequestSyntax"></a>

```
GET /domains/DomainName/profile-attributes/AttributeName/values HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListProfileAttributeValues_RequestParameters"></a>

The request uses the following URI parameters.

 ** [AttributeName](#API_connect-customer-profiles_ListProfileAttributeValues_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListProfileAttributeValues-request-uri-AttributeName"></a>
The attribute name.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

 ** [DomainName](#API_connect-customer-profiles_ListProfileAttributeValues_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListProfileAttributeValues-request-uri-DomainName"></a>
The unique identifier of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_ListProfileAttributeValues_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_ListProfileAttributeValues_ResponseSyntax"></a>

```
HTTP/1.1 StatusCode
Content-type: application/json

{
   "AttributeName": "string",
   "DomainName": "string",
   "Items": [ 
      { 
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListProfileAttributeValues_ResponseElements"></a>

If the action is successful, the service sends back the following HTTP response.

 ** [StatusCode](#API_connect-customer-profiles_ListProfileAttributeValues_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListProfileAttributeValues-response-StatusCode"></a>
The status code for the response.

The following data is returned in JSON format by the service.

 ** [AttributeName](#API_connect-customer-profiles_ListProfileAttributeValues_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListProfileAttributeValues-response-AttributeName"></a>
The attribute name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [DomainName](#API_connect-customer-profiles_ListProfileAttributeValues_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListProfileAttributeValues-response-DomainName"></a>
The name of the domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [Items](#API_connect-customer-profiles_ListProfileAttributeValues_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListProfileAttributeValues-response-Items"></a>
The items returned as part of the response.  
Type: Array of [AttributeValueItem](API_connect-customer-profiles_AttributeValueItem.md) objects

## Errors
<a name="API_connect-customer-profiles_ListProfileAttributeValues_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_ListProfileAttributeValues_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListProfileAttributeValues) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListProfileAttributeValues) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListProfileAttributeValues) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListProfileAttributeValues) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListProfileAttributeValues) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListProfileAttributeValues) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListProfileAttributeValues) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListProfileAttributeValues) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListProfileAttributeValues) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListProfileAttributeValues) 

# ListProfileHistoryRecords
<a name="API_connect-customer-profiles_ListProfileHistoryRecords"></a>

Returns a list of history records for a specific profile, for a specific domain.

## Request Syntax
<a name="API_connect-customer-profiles_ListProfileHistoryRecords_RequestSyntax"></a>

```
POST /domains/DomainName/profiles/history-records?max-results=MaxResults&next-token=NextToken HTTP/1.1
Content-type: application/json

{
   "ActionType": "string",
   "ObjectTypeName": "string",
   "PerformedBy": "string",
   "ProfileId": "string"
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListProfileHistoryRecords_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_ListProfileHistoryRecords_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListProfileHistoryRecords-request-uri-DomainName"></a>
The unique name of the domain for which to return profile history records.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [MaxResults](#API_connect-customer-profiles_ListProfileHistoryRecords_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListProfileHistoryRecords-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_ListProfileHistoryRecords_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListProfileHistoryRecords-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Request Body
<a name="API_connect-customer-profiles_ListProfileHistoryRecords_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ActionType](#API_connect-customer-profiles_ListProfileHistoryRecords_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListProfileHistoryRecords-request-ActionType"></a>
Applies a filter to include profile history records only with the specified `ActionType` value in the response.  
Type: String  
Valid Values: `ADDED_PROFILE_KEY | DELETED_PROFILE_KEY | CREATED | UPDATED | INGESTED | DELETED_BY_CUSTOMER | EXPIRED | MERGED | DELETED_BY_MERGE`   
Required: No

 ** [ObjectTypeName](#API_connect-customer-profiles_ListProfileHistoryRecords_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListProfileHistoryRecords-request-ObjectTypeName"></a>
Applies a filter to include profile history records only with the specified `ObjectTypeName` value in the response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: No

 ** [PerformedBy](#API_connect-customer-profiles_ListProfileHistoryRecords_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListProfileHistoryRecords-request-PerformedBy"></a>
Applies a filter to include profile history records only with the specified `PerformedBy` value in the response. The `PerformedBy` value can be the Amazon Resource Name (ARN) of the person or service principal who performed the action.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [ProfileId](#API_connect-customer-profiles_ListProfileHistoryRecords_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListProfileHistoryRecords-request-ProfileId"></a>
The identifier of the profile to be taken.  
Type: String  
Pattern: `[a-f0-9]{32}`   
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_ListProfileHistoryRecords_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ProfileHistoryRecords": [ 
      { 
         "ActionType": "string",
         "CreatedAt": number,
         "Id": "string",
         "LastUpdatedAt": number,
         "ObjectTypeName": "string",
         "PerformedBy": "string",
         "ProfileObjectUniqueKey": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListProfileHistoryRecords_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_connect-customer-profiles_ListProfileHistoryRecords_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListProfileHistoryRecords-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [ProfileHistoryRecords](#API_connect-customer-profiles_ListProfileHistoryRecords_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListProfileHistoryRecords-response-ProfileHistoryRecords"></a>
The list of profile history records.  
Type: Array of [ProfileHistoryRecord](API_connect-customer-profiles_ProfileHistoryRecord.md) objects

## Errors
<a name="API_connect-customer-profiles_ListProfileHistoryRecords_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_ListProfileHistoryRecords_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListProfileHistoryRecords) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListProfileHistoryRecords) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListProfileHistoryRecords) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListProfileHistoryRecords) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListProfileHistoryRecords) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListProfileHistoryRecords) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListProfileHistoryRecords) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListProfileHistoryRecords) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListProfileHistoryRecords) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListProfileHistoryRecords) 

# ListProfileObjects
<a name="API_connect-customer-profiles_ListProfileObjects"></a>

Returns a list of objects associated with a profile of a given ProfileObjectType.

## Request Syntax
<a name="API_connect-customer-profiles_ListProfileObjects_RequestSyntax"></a>

```
POST /domains/DomainName/profiles/objects?max-results=MaxResults&next-token=NextToken HTTP/1.1
Content-type: application/json

{
   "ObjectFilter": { 
      "KeyName": "string",
      "Values": [ "string" ]
   },
   "ObjectTypeName": "string",
   "ProfileId": "string"
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListProfileObjects_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_ListProfileObjects_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListProfileObjects-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [MaxResults](#API_connect-customer-profiles_ListProfileObjects_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListProfileObjects-request-uri-MaxResults"></a>
The maximum number of objects returned per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_ListProfileObjects_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListProfileObjects-request-uri-NextToken"></a>
The pagination token from the previous call to ListProfileObjects.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Request Body
<a name="API_connect-customer-profiles_ListProfileObjects_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [ObjectFilter](#API_connect-customer-profiles_ListProfileObjects_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListProfileObjects-request-ObjectFilter"></a>
Applies a filter to the response to include profile objects with the specified index values.  
Type: [ObjectFilter](API_connect-customer-profiles_ObjectFilter.md) object  
Required: No

 ** [ObjectTypeName](#API_connect-customer-profiles_ListProfileObjects_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListProfileObjects-request-ObjectTypeName"></a>
The name of the profile object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: Yes

 ** [ProfileId](#API_connect-customer-profiles_ListProfileObjects_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListProfileObjects-request-ProfileId"></a>
The unique identifier of a customer profile.  
Type: String  
Pattern: `[a-f0-9]{32}`   
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_ListProfileObjects_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "Object": "string",
         "ObjectTypeName": "string",
         "ProfileObjectUniqueKey": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListProfileObjects_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_connect-customer-profiles_ListProfileObjects_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListProfileObjects-response-Items"></a>
The list of ListProfileObject instances.  
Type: Array of [ListProfileObjectsItem](API_connect-customer-profiles_ListProfileObjectsItem.md) objects

 ** [NextToken](#API_connect-customer-profiles_ListProfileObjects_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListProfileObjects-response-NextToken"></a>
The pagination token from the previous call to ListProfileObjects.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_connect-customer-profiles_ListProfileObjects_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_ListProfileObjects_Examples"></a>

### Example 1: List raw Contact Record objects
<a name="API_connect-customer-profiles_ListProfileObjects_Example_1"></a>

This example illustrates one usage of ListProfileObjects.

#### Sample Request
<a name="API_connect-customer-profiles_ListProfileObjects_Example_1_Request"></a>

```
POST /domains/ExampleDomainName/profiles/objects?max-results=10&next-token=nextToken
Content-type: application/json

{
   "ObjectTypeName": "MyCustomObject",
   "ProfileId": "3991a7d959d248bba82546b2dEXAMPLE"
}
```

#### Sample Response
<a name="API_connect-customer-profiles_ListProfileObjects_Example_1_Response"></a>

```
Content-type: application/json
{
   "Items": [ 
      { 
         "Object": "{\"firstName\": \"John\",\n       \"lastName\": \"Smith\",\n       \"isAlive\": true,\n       \"age\": 27,\n       \"address\": {\"streetAddress\": \"21 2nd Street\",\"city\": \"New York\",\"state\": \"NY\",\"postalCode\": \"10021-3100\"},\n       \"phoneNumbers\": [{\"type\": \"home\",\"number\": \"212 555-1234\"},\n                        {\"type\": \"office\",\"number\": \"646 555-4567\"}],\n       \"children\": [],\n       \"spouse\": null}",
         "ObjectTypeName": "MyCustomObject",
         "ProfileObjectUniqueKey": "UniqueKeyOfTheProfileObject"
      },
      { 
         "Object": "{\"firstName\": \"John\",\n       \"lastName\": \"Smith\",\n       \"isAlive\": true,\n       \"age\": 27,\n       \"address\": {\"streetAddress\": \"21 2nd Street\",\"city\": \"New York\",\"state\": \"NY\",\"postalCode\": \"10021-3100\"},\n       \"phoneNumbers\": [{\"type\": \"home\",\"number\": \"212 555-1234\"},\n                        {\"type\": \"office\",\"number\": \"646 555-4567\"}],\n       \"children\": [],\n       \"spouse\": null}",
         "ObjectTypeName": "MyCustomObject",
         "ProfileObjectUniqueKey": "UniqueKeyOfTheProfileObject"
      }
   ],
   "NextToken": "e17145a2-916b-42a2-b4d3-0267fEXAMPLE"
}
```

### Example 2: Filter Standard Asset Objects
<a name="API_connect-customer-profiles_ListProfileObjects_Example_2"></a>

This example illustrates one usage of ListProfileObjects.

#### Sample Request
<a name="API_connect-customer-profiles_ListProfileObjects_Example_2_Request"></a>

```
POST /domains/ExampleDomainName/profiles/objects?max-results=10&next-token=nextToken
Content-type: application/json

{
   "ObjectTypeName": "_asset",
   "ProfileId": "3991a7d959d248bba82546b2dEXAMPLE",
   "ObjectFilter": {
      "KeyName": "_assetId",
      "Values": [ "991a7d959d248bba82546b2dEXAMPLE2" ]
   }
}
```

#### Sample Response
<a name="API_connect-customer-profiles_ListProfileObjects_Example_2_Response"></a>

```
Content-type: application/json
{
   "Items": [
      {
         "Object": "{\"AssetId\": \"991a7d959d248bba82546b2dEXAMPLE2\",\n       \"AssetName\": \"MyAsset\",\n       \"SerialNumber\": \"123\",\n       \"ModelNumber\": \"1\",\n        \"ModelName\": \"name\",\n        \"ProductSKU\": \"21\",\n        \"PurchaseDate\": \"07-04-2021\",\n        \"UsageEndDate\": \"07-04-2021\",\n        \"Status\": \"Delivered\",\n        \"Price\": \"10\",\n        \"Quantity\": \"5\",\n        \"Description\": \"This is an asset\",\n        \"Location\": \"Office\",\n        \"AdditionalInformation\": \"None\",\n        \"DataSource\": \"Salesforce-Asset\",\n        \"Attributes\": {} }",
         "ObjectTypeName": "_asset",
         "ProfileObjectUniqueKey": "UniqueKeyOfTheProfileObject"
      }
   ],
   "NextToken": "e17145a2-916b-42a2-b4d3-0267fEXAMPLE"
}
```

## See Also
<a name="API_connect-customer-profiles_ListProfileObjects_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListProfileObjects) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListProfileObjects) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListProfileObjects) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListProfileObjects) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListProfileObjects) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListProfileObjects) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListProfileObjects) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListProfileObjects) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListProfileObjects) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListProfileObjects) 

# ListProfileObjectTypes
<a name="API_connect-customer-profiles_ListProfileObjectTypes"></a>

Lists all of the templates available within the service.

## Request Syntax
<a name="API_connect-customer-profiles_ListProfileObjectTypes_RequestSyntax"></a>

```
GET /domains/DomainName/object-types?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListProfileObjectTypes_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_ListProfileObjectTypes_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListProfileObjectTypes-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [MaxResults](#API_connect-customer-profiles_ListProfileObjectTypes_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListProfileObjectTypes-request-uri-MaxResults"></a>
The maximum number of objects returned per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_ListProfileObjectTypes_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListProfileObjectTypes-request-uri-NextToken"></a>
Identifies the next page of results to return.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Request Body
<a name="API_connect-customer-profiles_ListProfileObjectTypes_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_ListProfileObjectTypes_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "CreatedAt": number,
         "Description": "string",
         "LastUpdatedAt": number,
         "MaxAvailableProfileObjectCount": number,
         "MaxProfileObjectCount": number,
         "ObjectTypeName": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListProfileObjectTypes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_connect-customer-profiles_ListProfileObjectTypes_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListProfileObjectTypes-response-Items"></a>
The list of ListProfileObjectTypes instances.  
Type: Array of [ListProfileObjectTypeItem](API_connect-customer-profiles_ListProfileObjectTypeItem.md) objects

 ** [NextToken](#API_connect-customer-profiles_ListProfileObjectTypes_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListProfileObjectTypes-response-NextToken"></a>
Identifies the next page of results to return.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_connect-customer-profiles_ListProfileObjectTypes_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_ListProfileObjectTypes_Examples"></a>

### Example
<a name="API_connect-customer-profiles_ListProfileObjectTypes_Example_1"></a>

This example illustrates one usage of ListProfileObjectTypes.

#### Sample Request
<a name="API_connect-customer-profiles_ListProfileObjectTypes_Example_1_Request"></a>

```
GET /domains/ExampleDomainName/object-types?max-results=10&next-token=nextToken HTTP/1.1
```

#### Sample Response
<a name="API_connect-customer-profiles_ListProfileObjectTypes_Example_1_Response"></a>

```
Content-type: application/json
{
   "Items": [ 
      { 
         "CreatedAt": 1479249799770,
         "Description": "Example Description 1",
         "LastUpdatedAt": 1479249799770,
         "ObjectTypeName": "MyCustomObjectType"
      },
      { 
         "CreatedAt": 147924988889,
         "Description": "Example Description 2",
         "LastUpdatedAt": 147924988889,
         "ObjectTypeName": "AnotherCustomObjectType"
      }
   ],
   "NextToken": "e17145a2-916b-42a2-b4d3-0267fEXAMPLE"
}
```

## See Also
<a name="API_connect-customer-profiles_ListProfileObjectTypes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListProfileObjectTypes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListProfileObjectTypes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListProfileObjectTypes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListProfileObjectTypes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListProfileObjectTypes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListProfileObjectTypes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListProfileObjectTypes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListProfileObjectTypes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListProfileObjectTypes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListProfileObjectTypes) 

# ListProfileObjectTypeTemplates
<a name="API_connect-customer-profiles_ListProfileObjectTypeTemplates"></a>

Lists all of the template information for object types.

## Request Syntax
<a name="API_connect-customer-profiles_ListProfileObjectTypeTemplates_RequestSyntax"></a>

```
GET /templates?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListProfileObjectTypeTemplates_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_connect-customer-profiles_ListProfileObjectTypeTemplates_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListProfileObjectTypeTemplates-request-uri-MaxResults"></a>
The maximum number of objects returned per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_ListProfileObjectTypeTemplates_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListProfileObjectTypeTemplates-request-uri-NextToken"></a>
The pagination token from the previous ListObjectTypeTemplates API call.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Request Body
<a name="API_connect-customer-profiles_ListProfileObjectTypeTemplates_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_ListProfileObjectTypeTemplates_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "SourceName": "string",
         "SourceObject": "string",
         "TemplateId": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListProfileObjectTypeTemplates_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_connect-customer-profiles_ListProfileObjectTypeTemplates_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListProfileObjectTypeTemplates-response-Items"></a>
The list of ListProfileObjectType template instances.  
Type: Array of [ListProfileObjectTypeTemplateItem](API_connect-customer-profiles_ListProfileObjectTypeTemplateItem.md) objects

 ** [NextToken](#API_connect-customer-profiles_ListProfileObjectTypeTemplates_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListProfileObjectTypeTemplates-response-NextToken"></a>
The pagination token from the previous ListObjectTypeTemplates API call.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_connect-customer-profiles_ListProfileObjectTypeTemplates_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_ListProfileObjectTypeTemplates_Examples"></a>

### Example
<a name="API_connect-customer-profiles_ListProfileObjectTypeTemplates_Example_1"></a>

This example illustrates one usage of ListProfileObjectTypeTemplates.

#### Sample Request
<a name="API_connect-customer-profiles_ListProfileObjectTypeTemplates_Example_1_Request"></a>

```
GET /templates?max-results={MaxResults}&next-token={NextToken} HTTP/1.1
```

#### Sample Response
<a name="API_connect-customer-profiles_ListProfileObjectTypeTemplates_Example_1_Response"></a>

```
Content-type: application/json
{
   "Items": [ 
      { 
         "SourceName": "Salesforce-account",
         "SourceObject": "<JSON represented by GetProfileObjectTypeTemplate API>",
         "TemplateId": "Salesforce-Account"
      },
      { 
         "SourceName": "Another-source",
         "SourceObject": "<JSON represented by GetProfileObjectTypeTemplate API>",
         "TemplateId": "MyCustomTemplateId"
      }
   ],
   "NextToken": "e17145a2-916b-42a2-b4d3-0267fEXAMPLE"
}
```

## See Also
<a name="API_connect-customer-profiles_ListProfileObjectTypeTemplates_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListProfileObjectTypeTemplates) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListProfileObjectTypeTemplates) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListProfileObjectTypeTemplates) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListProfileObjectTypeTemplates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListProfileObjectTypeTemplates) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListProfileObjectTypeTemplates) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListProfileObjectTypeTemplates) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListProfileObjectTypeTemplates) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListProfileObjectTypeTemplates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListProfileObjectTypeTemplates) 

# ListRecommenderRecipes
<a name="API_connect-customer-profiles_ListRecommenderRecipes"></a>

Returns a list of available recommender recipes that can be used to create recommenders.

## Request Syntax
<a name="API_connect-customer-profiles_ListRecommenderRecipes_RequestSyntax"></a>

```
GET /recommender-recipes?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListRecommenderRecipes_RequestParameters"></a>

The request uses the following URI parameters.

 ** [MaxResults](#API_connect-customer-profiles_ListRecommenderRecipes_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListRecommenderRecipes-request-uri-MaxResults"></a>
The maximum number of recommender recipes to return in the response. The default value is 100.  
Valid Range: Minimum value of 10. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_ListRecommenderRecipes_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListRecommenderRecipes-request-uri-NextToken"></a>
A token received from a previous ListRecommenderRecipes call to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Request Body
<a name="API_connect-customer-profiles_ListRecommenderRecipes_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_ListRecommenderRecipes_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "RecommenderRecipes": [ 
      { 
         "description": "string",
         "name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListRecommenderRecipes_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_connect-customer-profiles_ListRecommenderRecipes_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListRecommenderRecipes-response-NextToken"></a>
A token to retrieve the next page of results. Null if there are no more results to retrieve.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [RecommenderRecipes](#API_connect-customer-profiles_ListRecommenderRecipes_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListRecommenderRecipes-response-RecommenderRecipes"></a>
A list of available recommender recipes and their properties.  
Type: Array of [RecommenderRecipe](API_connect-customer-profiles_RecommenderRecipe.md) objects

## Errors
<a name="API_connect-customer-profiles_ListRecommenderRecipes_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_ListRecommenderRecipes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListRecommenderRecipes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListRecommenderRecipes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListRecommenderRecipes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListRecommenderRecipes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListRecommenderRecipes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListRecommenderRecipes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListRecommenderRecipes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListRecommenderRecipes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListRecommenderRecipes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListRecommenderRecipes) 

# ListRecommenders
<a name="API_connect-customer-profiles_ListRecommenders"></a>

Returns a list of recommenders in the specified domain.

## Request Syntax
<a name="API_connect-customer-profiles_ListRecommenders_RequestSyntax"></a>

```
GET /domains/DomainName/recommenders?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListRecommenders_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_ListRecommenders_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListRecommenders-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [MaxResults](#API_connect-customer-profiles_ListRecommenders_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListRecommenders-request-uri-MaxResults"></a>
The maximum number of recommenders to return in the response. The default value is 100.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_ListRecommenders_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListRecommenders-request-uri-NextToken"></a>
A token received from a previous ListRecommenders call to retrieve the next page of results.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Request Body
<a name="API_connect-customer-profiles_ListRecommenders_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_ListRecommenders_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Recommenders": [ 
      { 
         "CreatedAt": number,
         "Description": "string",
         "FailureReason": "string",
         "LastUpdatedAt": number,
         "LatestRecommenderUpdate": { 
            "CreatedAt": number,
            "FailureReason": "string",
            "LastUpdatedAt": number,
            "RecommenderConfig": { 
               "EventsConfig": { 
                  "EventParametersList": [ 
                     { 
                        "EventType": "string",
                        "EventValueThreshold": number
                     }
                  ]
               },
               "TrainingFrequency": number
            },
            "Status": "string"
         },
         "RecipeName": "string",
         "RecommenderConfig": { 
            "EventsConfig": { 
               "EventParametersList": [ 
                  { 
                     "EventType": "string",
                     "EventValueThreshold": number
                  }
               ]
            },
            "TrainingFrequency": number
         },
         "RecommenderName": "string",
         "Status": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ]
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListRecommenders_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_connect-customer-profiles_ListRecommenders_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListRecommenders-response-NextToken"></a>
A token to retrieve the next page of results. Null if there are no more results to retrieve.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [Recommenders](#API_connect-customer-profiles_ListRecommenders_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListRecommenders-response-Recommenders"></a>
A list of recommenders and their properties in the specified domain.  
Type: Array of [RecommenderSummary](API_connect-customer-profiles_RecommenderSummary.md) objects

## Errors
<a name="API_connect-customer-profiles_ListRecommenders_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_ListRecommenders_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListRecommenders) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListRecommenders) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListRecommenders) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListRecommenders) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListRecommenders) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListRecommenders) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListRecommenders) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListRecommenders) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListRecommenders) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListRecommenders) 

# ListRuleBasedMatches
<a name="API_connect-customer-profiles_ListRuleBasedMatches"></a>

Returns a set of `MatchIds` that belong to the given domain.

## Request Syntax
<a name="API_connect-customer-profiles_ListRuleBasedMatches_RequestSyntax"></a>

```
GET /domains/DomainName/profiles/ruleBasedMatches?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListRuleBasedMatches_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_ListRuleBasedMatches_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListRuleBasedMatches-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [MaxResults](#API_connect-customer-profiles_ListRuleBasedMatches_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListRuleBasedMatches-request-uri-MaxResults"></a>
The maximum number of `MatchIds` returned per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_ListRuleBasedMatches_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListRuleBasedMatches-request-uri-NextToken"></a>
The pagination token from the previous `ListRuleBasedMatches` API call.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Request Body
<a name="API_connect-customer-profiles_ListRuleBasedMatches_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_ListRuleBasedMatches_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "MatchIds": [ "string" ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListRuleBasedMatches_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [MatchIds](#API_connect-customer-profiles_ListRuleBasedMatches_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListRuleBasedMatches-response-MatchIds"></a>
The list of `MatchIds` for the given domain.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [NextToken](#API_connect-customer-profiles_ListRuleBasedMatches_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListRuleBasedMatches-response-NextToken"></a>
The pagination token from the previous `ListRuleBasedMatches` API call.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_connect-customer-profiles_ListRuleBasedMatches_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_ListRuleBasedMatches_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListRuleBasedMatches) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListRuleBasedMatches) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListRuleBasedMatches) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListRuleBasedMatches) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListRuleBasedMatches) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListRuleBasedMatches) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListRuleBasedMatches) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListRuleBasedMatches) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListRuleBasedMatches) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListRuleBasedMatches) 

# ListSegmentDefinitions
<a name="API_connect-customer-profiles_ListSegmentDefinitions"></a>

Lists all segment definitions under a domain.

## Request Syntax
<a name="API_connect-customer-profiles_ListSegmentDefinitions_RequestSyntax"></a>

```
GET /domains/DomainName/segment-definitions?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListSegmentDefinitions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_ListSegmentDefinitions_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListSegmentDefinitions-request-uri-DomainName"></a>
The unique identifier of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [MaxResults](#API_connect-customer-profiles_ListSegmentDefinitions_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListSegmentDefinitions-request-uri-MaxResults"></a>
The maximum number of objects returned per page.  
Valid Range: Minimum value of 1. Maximum value of 500.

 ** [NextToken](#API_connect-customer-profiles_ListSegmentDefinitions_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListSegmentDefinitions-request-uri-NextToken"></a>
The pagination token from the previous call.   
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Request Body
<a name="API_connect-customer-profiles_ListSegmentDefinitions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_ListSegmentDefinitions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "CreatedAt": number,
         "Description": "string",
         "DisplayName": "string",
         "SegmentDefinitionArn": "string",
         "SegmentDefinitionName": "string",
         "SegmentType": "string",
         "Tags": { 
            "string" : "string" 
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListSegmentDefinitions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_connect-customer-profiles_ListSegmentDefinitions_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListSegmentDefinitions-response-Items"></a>
List of segment definitions.  
Type: Array of [SegmentDefinitionItem](API_connect-customer-profiles_SegmentDefinitionItem.md) objects

 ** [NextToken](#API_connect-customer-profiles_ListSegmentDefinitions_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListSegmentDefinitions-response-NextToken"></a>
The pagination token from the previous call.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_connect-customer-profiles_ListSegmentDefinitions_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_ListSegmentDefinitions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListSegmentDefinitions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListSegmentDefinitions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListSegmentDefinitions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListSegmentDefinitions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListSegmentDefinitions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListSegmentDefinitions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListSegmentDefinitions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListSegmentDefinitions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListSegmentDefinitions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListSegmentDefinitions) 

# ListTagsForResource
<a name="API_connect-customer-profiles_ListTagsForResource"></a>

Displays the tags associated with an Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.

## Request Syntax
<a name="API_connect-customer-profiles_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/resourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_connect-customer-profiles_ListTagsForResource_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListTagsForResource-request-uri-resourceArn"></a>
The ARN of the resource for which you want to view tags.  
Length Constraints: Maximum length of 256.  
Pattern: `^arn:[a-z0-9]{1,10}:profile`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tags](#API_connect-customer-profiles_ListTagsForResource_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListTagsForResource-response-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_connect-customer-profiles_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

## See Also
<a name="API_connect-customer-profiles_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListTagsForResource) 

# ListUploadJobs
<a name="API_connect-customer-profiles_ListUploadJobs"></a>

This API retrieves a list of upload jobs for the specified domain. 

## Request Syntax
<a name="API_connect-customer-profiles_ListUploadJobs_RequestSyntax"></a>

```
GET /domains/DomainName/upload-jobs?max-results=MaxResults&next-token=NextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListUploadJobs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_ListUploadJobs_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListUploadJobs-request-uri-DomainName"></a>
The unique name of the domain to list upload jobs for.   
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [MaxResults](#API_connect-customer-profiles_ListUploadJobs_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListUploadJobs-request-uri-MaxResults"></a>
The maximum number of upload jobs to return per page.   
Valid Range: Minimum value of 1. Maximum value of 500.

 ** [NextToken](#API_connect-customer-profiles_ListUploadJobs_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListUploadJobs-request-uri-NextToken"></a>
The pagination token from the previous call to retrieve the next page of results.   
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Request Body
<a name="API_connect-customer-profiles_ListUploadJobs_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_ListUploadJobs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "CompletedAt": number,
         "CreatedAt": number,
         "DataExpiry": number,
         "DisplayName": "string",
         "JobId": "string",
         "Status": "string",
         "StatusReason": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListUploadJobs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_connect-customer-profiles_ListUploadJobs_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListUploadJobs-response-Items"></a>
The list of upload jobs for the specified domain.   
Type: Array of [UploadJobItem](API_connect-customer-profiles_UploadJobItem.md) objects

 ** [NextToken](#API_connect-customer-profiles_ListUploadJobs_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListUploadJobs-response-NextToken"></a>
The pagination token to use to retrieve the next page of results.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_connect-customer-profiles_ListUploadJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_ListUploadJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListUploadJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListUploadJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListUploadJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListUploadJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListUploadJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListUploadJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListUploadJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListUploadJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListUploadJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListUploadJobs) 

# ListWorkflows
<a name="API_connect-customer-profiles_ListWorkflows"></a>

Query to list all workflows.

## Request Syntax
<a name="API_connect-customer-profiles_ListWorkflows_RequestSyntax"></a>

```
POST /domains/DomainName/workflows?max-results=MaxResults&next-token=NextToken HTTP/1.1
Content-type: application/json

{
   "QueryEndDate": number,
   "QueryStartDate": number,
   "Status": "string",
   "WorkflowType": "string"
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_ListWorkflows_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_ListWorkflows_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListWorkflows-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [MaxResults](#API_connect-customer-profiles_ListWorkflows_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListWorkflows-request-uri-MaxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_ListWorkflows_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListWorkflows-request-uri-NextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Request Body
<a name="API_connect-customer-profiles_ListWorkflows_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [QueryEndDate](#API_connect-customer-profiles_ListWorkflows_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListWorkflows-request-QueryEndDate"></a>
Retrieve workflows ended after timestamp.  
Type: Timestamp  
Required: No

 ** [QueryStartDate](#API_connect-customer-profiles_ListWorkflows_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListWorkflows-request-QueryStartDate"></a>
Retrieve workflows started after timestamp.  
Type: Timestamp  
Required: No

 ** [Status](#API_connect-customer-profiles_ListWorkflows_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListWorkflows-request-Status"></a>
Status of workflow execution.  
Type: String  
Valid Values: `NOT_STARTED | IN_PROGRESS | COMPLETE | FAILED | SPLIT | RETRY | CANCELLED`   
Required: No

 ** [WorkflowType](#API_connect-customer-profiles_ListWorkflows_RequestSyntax) **   <a name="connect-connect-customer-profiles_ListWorkflows-request-WorkflowType"></a>
The type of workflow. The only supported value is APPFLOW\$1INTEGRATION.  
Type: String  
Valid Values: `APPFLOW_INTEGRATION`   
Required: No

## Response Syntax
<a name="API_connect-customer-profiles_ListWorkflows_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "CreatedAt": number,
         "LastUpdatedAt": number,
         "Status": "string",
         "StatusDescription": "string",
         "WorkflowId": "string",
         "WorkflowType": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_ListWorkflows_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_connect-customer-profiles_ListWorkflows_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListWorkflows-response-Items"></a>
List containing workflow details.  
Type: Array of [ListWorkflowsItem](API_connect-customer-profiles_ListWorkflowsItem.md) objects

 ** [NextToken](#API_connect-customer-profiles_ListWorkflows_ResponseSyntax) **   <a name="connect-connect-customer-profiles_ListWorkflows-response-NextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_connect-customer-profiles_ListWorkflows_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_ListWorkflows_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/ListWorkflows) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/ListWorkflows) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/ListWorkflows) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/ListWorkflows) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/ListWorkflows) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/ListWorkflows) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/ListWorkflows) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/ListWorkflows) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/ListWorkflows) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/ListWorkflows) 

# MergeProfiles
<a name="API_connect-customer-profiles_MergeProfiles"></a>

Runs an AWS Lambda job that does the following:

1. All the profileKeys in the `ProfileToBeMerged` will be moved to the main profile.

1. All the objects in the `ProfileToBeMerged` will be moved to the main profile.

1. All the `ProfileToBeMerged` will be deleted at the end.

1. All the profileKeys in the `ProfileIdsToBeMerged` will be moved to the main profile.

1. Standard fields are merged as follows:

   1. Fields are always "union"-ed if there are no conflicts in standard fields or attributeKeys.

   1. When there are conflicting fields:

      1. If no `SourceProfileIds` entry is specified, the main Profile value is always taken. 

      1. If a `SourceProfileIds` entry is specified, the specified profileId is always taken, even if it is a NULL value.

You can use MergeProfiles together with [GetMatches](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html), which returns potentially matching profiles, or use it with the results of another matching system. After profiles have been merged, they cannot be separated (unmerged).

## Request Syntax
<a name="API_connect-customer-profiles_MergeProfiles_RequestSyntax"></a>

```
POST /domains/DomainName/profiles/objects/merge HTTP/1.1
Content-type: application/json

{
   "FieldSourceProfileIds": { 
      "AccountNumber": "string",
      "AdditionalInformation": "string",
      "Address": "string",
      "Attributes": { 
         "string" : "string" 
      },
      "BillingAddress": "string",
      "BirthDate": "string",
      "BusinessEmailAddress": "string",
      "BusinessName": "string",
      "BusinessPhoneNumber": "string",
      "EmailAddress": "string",
      "EngagementPreferences": "string",
      "FirstName": "string",
      "Gender": "string",
      "HomePhoneNumber": "string",
      "LastName": "string",
      "MailingAddress": "string",
      "MiddleName": "string",
      "MobilePhoneNumber": "string",
      "PartyType": "string",
      "PersonalEmailAddress": "string",
      "PhoneNumber": "string",
      "ProfileType": "string",
      "ShippingAddress": "string"
   },
   "MainProfileId": "string",
   "ProfileIdsToBeMerged": [ "string" ]
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_MergeProfiles_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_MergeProfiles_RequestSyntax) **   <a name="connect-connect-customer-profiles_MergeProfiles-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_MergeProfiles_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [FieldSourceProfileIds](#API_connect-customer-profiles_MergeProfiles_RequestSyntax) **   <a name="connect-connect-customer-profiles_MergeProfiles-request-FieldSourceProfileIds"></a>
The identifiers of the fields in the profile that has the information you want to apply to the merge. For example, say you want to merge EmailAddress from Profile1 into MainProfile. This would be the identifier of the EmailAddress field in Profile1.   
Type: [FieldSourceProfileIds](API_connect-customer-profiles_FieldSourceProfileIds.md) object  
Required: No

 ** [MainProfileId](#API_connect-customer-profiles_MergeProfiles_RequestSyntax) **   <a name="connect-connect-customer-profiles_MergeProfiles-request-MainProfileId"></a>
The identifier of the profile to be taken.  
Type: String  
Pattern: `[a-f0-9]{32}`   
Required: Yes

 ** [ProfileIdsToBeMerged](#API_connect-customer-profiles_MergeProfiles_RequestSyntax) **   <a name="connect-connect-customer-profiles_MergeProfiles-request-ProfileIdsToBeMerged"></a>
The identifier of the profile to be merged into MainProfileId.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Pattern: `[a-f0-9]{32}`   
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_MergeProfiles_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Message": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_MergeProfiles_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Message](#API_connect-customer-profiles_MergeProfiles_ResponseSyntax) **   <a name="connect-connect-customer-profiles_MergeProfiles-response-Message"></a>
A message that indicates the merge request is complete.  
Type: String

## Errors
<a name="API_connect-customer-profiles_MergeProfiles_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_MergeProfiles_Examples"></a>

### Example 1
<a name="API_connect-customer-profiles_MergeProfiles_Example_1"></a>

Fields are always "union"-ed if there are no conflicts in standard fields or attributeKeys.

```
MainProfile: {
    "FirstName": "Jane"
}

ProfileToBeMerged1: {
    "LastName": "Doe"
}

ProfileToBeMerged2: {
    "MiddleName": "None"
}
   
mergeOf(MainProfile, [ProfileToBeMerged1, ProfileToBeMerged2] // Yields a MainProfile that looks like the following:
    MainProfile: {
       "FirstName": "Jane",
       "LastName": "Doe",
       "MiddleName": "None"
   }
```

### Example 2
<a name="API_connect-customer-profiles_MergeProfiles_Example_2"></a>

When there are conflicting fields, if no SourceProfileIds entry is specified, the main Profile value is always taken.

```
MainProfile: {
    "FirstName": "Jane"
}

ProfileToBeMerged1: {
    "LastName": "Doe"
}

ProfileToBeMerged2: {
    "FirstName": "Jorge" // Note that this has conflict with MainProfile
}

mergeOf(MainProfile, [ProfileToBeMerged1, ProfileToBeMerged2] // Yields a MainProfile that looks like the following:
    MainProfile: {
       "FirstName": "Jane", // "Jane" stays as that is what MainProfile is
       "LastName": "Doe"
   }
```

### Example 3
<a name="API_connect-customer-profiles_MergeProfiles_Example_3"></a>

When there are conflicting fields, if a SourceProfileIds entry is specified, the specified profileId is always taken, even if it is a NULL value.

```
MainProfile: {
    "FirstName": "Jane"
}

ProfileToBeMerged1: {
    "LastName": "Doe"
}

ProfileToBeMerged2: {
    "FirstName": "Jorge" // Note that this has conflict with MainProfile
}

SourceProfileIds: {
    "FirstName": "secondaryProfile2"
}

mergeOf(MainProfile, [ProfileToBeMerged1, ProfileToBeMerged2] // Yields a MainProfile that looks like the following:
    MainProfile: {
       "FirstName": "Jorge", // "Jorge" gets picked because SourceProfileIds is specified
       "LastName": "Doe"
}
```

## See Also
<a name="API_connect-customer-profiles_MergeProfiles_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/MergeProfiles) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/MergeProfiles) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/MergeProfiles) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/MergeProfiles) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/MergeProfiles) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/MergeProfiles) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/MergeProfiles) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/MergeProfiles) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/MergeProfiles) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/MergeProfiles) 

# PutDomainObjectType
<a name="API_connect-customer-profiles_PutDomainObjectType"></a>

Create/Update a DomainObjectType in a Customer Profiles domain. To create a new DomainObjectType, Data Store needs to be enabled on the Domain.

## Request Syntax
<a name="API_connect-customer-profiles_PutDomainObjectType_RequestSyntax"></a>

```
PUT /domains/DomainName/domain-object-types/ObjectTypeName HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "EncryptionKey": "string",
   "Fields": { 
      "string" : { 
         "ContentType": "string",
         "FeatureType": "string",
         "Source": "string",
         "Target": "string"
      }
   },
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_PutDomainObjectType_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_PutDomainObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutDomainObjectType-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [ObjectTypeName](#API_connect-customer-profiles_PutDomainObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutDomainObjectType-request-uri-ObjectTypeName"></a>
The unique name of the domain object type.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_PutDomainObjectType_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_connect-customer-profiles_PutDomainObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutDomainObjectType-request-Description"></a>
The description of the domain object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10000.  
Required: No

 ** [EncryptionKey](#API_connect-customer-profiles_PutDomainObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutDomainObjectType-request-EncryptionKey"></a>
The customer provided KMS key used to encrypt this type of domain object.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [Fields](#API_connect-customer-profiles_PutDomainObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutDomainObjectType-request-Fields"></a>
A map of field names to their corresponding domain object type field definitions.  
Type: String to [DomainObjectTypeField](API_connect-customer-profiles_DomainObjectTypeField.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Key Pattern: `^[a-zA-Z0-9_.-]+$`   
Required: Yes

 ** [Tags](#API_connect-customer-profiles_PutDomainObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutDomainObjectType-request-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_connect-customer-profiles_PutDomainObjectType_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": number,
   "Description": "string",
   "EncryptionKey": "string",
   "Fields": { 
      "string" : { 
         "ContentType": "string",
         "FeatureType": "string",
         "Source": "string",
         "Target": "string"
      }
   },
   "LastUpdatedAt": number,
   "ObjectTypeName": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-customer-profiles_PutDomainObjectType_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreatedAt](#API_connect-customer-profiles_PutDomainObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutDomainObjectType-response-CreatedAt"></a>
The timestamp of when the domain object type was created.  
Type: Timestamp

 ** [Description](#API_connect-customer-profiles_PutDomainObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutDomainObjectType-response-Description"></a>
The description of the domain object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10000.

 ** [EncryptionKey](#API_connect-customer-profiles_PutDomainObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutDomainObjectType-response-EncryptionKey"></a>
The customer provided KMS key used to encrypt this type of domain object.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.

 ** [Fields](#API_connect-customer-profiles_PutDomainObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutDomainObjectType-response-Fields"></a>
A map of field names to their corresponding domain object type field definitions.  
Type: String to [DomainObjectTypeField](API_connect-customer-profiles_DomainObjectTypeField.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Key Pattern: `^[a-zA-Z0-9_.-]+$` 

 ** [LastUpdatedAt](#API_connect-customer-profiles_PutDomainObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutDomainObjectType-response-LastUpdatedAt"></a>
The timestamp of when the domain object type was most recently edited.  
Type: Timestamp

 ** [ObjectTypeName](#API_connect-customer-profiles_PutDomainObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutDomainObjectType-response-ObjectTypeName"></a>
The unique name of the domain object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` 

 ** [Tags](#API_connect-customer-profiles_PutDomainObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutDomainObjectType-response-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_connect-customer-profiles_PutDomainObjectType_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_PutDomainObjectType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/PutDomainObjectType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/PutDomainObjectType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/PutDomainObjectType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/PutDomainObjectType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/PutDomainObjectType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/PutDomainObjectType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/PutDomainObjectType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/PutDomainObjectType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/PutDomainObjectType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/PutDomainObjectType) 

# PutIntegration
<a name="API_connect-customer-profiles_PutIntegration"></a>

Adds an integration between the service and a third-party service, which includes Amazon AppFlow and Amazon Connect.

An integration can belong to only one domain.

To add or remove tags on an existing Integration, see [ TagResource ](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html)/[ UntagResource](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html).

## Request Syntax
<a name="API_connect-customer-profiles_PutIntegration_RequestSyntax"></a>

```
PUT /domains/DomainName/integrations HTTP/1.1
Content-type: application/json

{
   "EventTriggerNames": [ "string" ],
   "FlowDefinition": { 
      "Description": "string",
      "FlowName": "string",
      "KmsArn": "string",
      "SourceFlowConfig": { 
         "ConnectorProfileName": "string",
         "ConnectorType": "string",
         "IncrementalPullConfig": { 
            "DatetimeTypeFieldName": "string"
         },
         "SourceConnectorProperties": { 
            "Marketo": { 
               "Object": "string"
            },
            "S3": { 
               "BucketName": "string",
               "BucketPrefix": "string"
            },
            "Salesforce": { 
               "EnableDynamicFieldUpdate": boolean,
               "IncludeDeletedRecords": boolean,
               "Object": "string"
            },
            "ServiceNow": { 
               "Object": "string"
            },
            "Zendesk": { 
               "Object": "string"
            }
         }
      },
      "Tasks": [ 
         { 
            "ConnectorOperator": { 
               "Marketo": "string",
               "S3": "string",
               "Salesforce": "string",
               "ServiceNow": "string",
               "Zendesk": "string"
            },
            "DestinationField": "string",
            "SourceFields": [ "string" ],
            "TaskProperties": { 
               "string" : "string" 
            },
            "TaskType": "string"
         }
      ],
      "TriggerConfig": { 
         "TriggerProperties": { 
            "Scheduled": { 
               "DataPullMode": "string",
               "FirstExecutionFrom": number,
               "ScheduleEndTime": number,
               "ScheduleExpression": "string",
               "ScheduleOffset": number,
               "ScheduleStartTime": number,
               "Timezone": "string"
            }
         },
         "TriggerType": "string"
      }
   },
   "ObjectTypeName": "string",
   "ObjectTypeNames": { 
      "string" : "string" 
   },
   "RoleArn": "string",
   "Scope": "string",
   "Tags": { 
      "string" : "string" 
   },
   "Uri": "string"
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_PutIntegration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_PutIntegration_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutIntegration-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_PutIntegration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [EventTriggerNames](#API_connect-customer-profiles_PutIntegration_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutIntegration-request-EventTriggerNames"></a>
A list of unique names for active event triggers associated with the integration.  
Type: Array of strings  
Array Members: Fixed number of 1 item.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: No

 ** [FlowDefinition](#API_connect-customer-profiles_PutIntegration_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutIntegration-request-FlowDefinition"></a>
The configuration that controls how Customer Profiles retrieves data from the source.  
Type: [FlowDefinition](API_connect-customer-profiles_FlowDefinition.md) object  
Required: No

 ** [ObjectTypeName](#API_connect-customer-profiles_PutIntegration_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutIntegration-request-ObjectTypeName"></a>
The name of the profile object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: No

 ** [ObjectTypeNames](#API_connect-customer-profiles_PutIntegration_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutIntegration-request-ObjectTypeNames"></a>
A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an `ObjectTypeName` (template) used to ingest the event. It supports the following event types: `SegmentIdentify`, `ShopifyCreateCustomers`, `ShopifyUpdateCustomers`, `ShopifyCreateDraftOrders`, `ShopifyUpdateDraftOrders`, `ShopifyCreateOrders`, and `ShopifyUpdatedOrders`.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 255.  
Value Length Constraints: Minimum length of 1. Maximum length of 255.  
Value Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: No

 ** [RoleArn](#API_connect-customer-profiles_PutIntegration_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutIntegration-request-RoleArn"></a>
The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make Customer Profiles requests on your behalf.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `arn:aws:iam:.*:[0-9]+:.*`   
Required: No

 ** [Scope](#API_connect-customer-profiles_PutIntegration_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutIntegration-request-Scope"></a>
Specifies whether the integration applies to profile level data (associated with profiles) or domain level data (not associated with any specific profile). The default value is PROFILE.  
Type: String  
Valid Values: `PROFILE | DOMAIN`   
Required: No

 ** [Tags](#API_connect-customer-profiles_PutIntegration_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutIntegration-request-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Required: No

 ** [Uri](#API_connect-customer-profiles_PutIntegration_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutIntegration-request-Uri"></a>
The URI of the S3 bucket or any other type of data source.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

## Response Syntax
<a name="API_connect-customer-profiles_PutIntegration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": number,
   "DomainName": "string",
   "EventTriggerNames": [ "string" ],
   "IsUnstructured": boolean,
   "LastUpdatedAt": number,
   "ObjectTypeName": "string",
   "ObjectTypeNames": { 
      "string" : "string" 
   },
   "RoleArn": "string",
   "Scope": "string",
   "Tags": { 
      "string" : "string" 
   },
   "Uri": "string",
   "WorkflowId": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_PutIntegration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreatedAt](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutIntegration-response-CreatedAt"></a>
The timestamp of when the domain was created.  
Type: Timestamp

 ** [DomainName](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutIntegration-response-DomainName"></a>
The unique name of the domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [EventTriggerNames](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutIntegration-response-EventTriggerNames"></a>
A list of unique names for active event triggers associated with the integration. This list would be empty if no Event Trigger is associated with the integration.  
Type: Array of strings  
Array Members: Fixed number of 1 item.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [IsUnstructured](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutIntegration-response-IsUnstructured"></a>
Boolean that shows if the Flow that's associated with the Integration is created in Amazon Appflow, or with ObjectTypeName equals \$1unstructured via API/CLI in flowDefinition.  
Type: Boolean

 ** [LastUpdatedAt](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutIntegration-response-LastUpdatedAt"></a>
The timestamp of when the domain was most recently edited.  
Type: Timestamp

 ** [ObjectTypeName](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutIntegration-response-ObjectTypeName"></a>
The name of the profile object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` 

 ** [ObjectTypeNames](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutIntegration-response-ObjectTypeNames"></a>
A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an `ObjectTypeName` (template) used to ingest the event. It supports the following event types: `SegmentIdentify`, `ShopifyCreateCustomers`, `ShopifyUpdateCustomers`, `ShopifyCreateDraftOrders`, `ShopifyUpdateDraftOrders`, `ShopifyCreateOrders`, and `ShopifyUpdatedOrders`.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 255.  
Value Length Constraints: Minimum length of 1. Maximum length of 255.  
Value Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` 

 ** [RoleArn](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutIntegration-response-RoleArn"></a>
The Amazon Resource Name (ARN) of the IAM role. The Integration uses this role to make Customer Profiles requests on your behalf.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `arn:aws:iam:.*:[0-9]+:.*` 

 ** [Scope](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutIntegration-response-Scope"></a>
Specifies whether the integration applies to profile level data (associated with profiles) or domain level data (not associated with any specific profile). The default value is PROFILE.  
Type: String  
Valid Values: `PROFILE | DOMAIN` 

 ** [Tags](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutIntegration-response-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

 ** [Uri](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutIntegration-response-Uri"></a>
The URI of the S3 bucket or any other type of data source.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [WorkflowId](#API_connect-customer-profiles_PutIntegration_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutIntegration-response-WorkflowId"></a>
Unique identifier for the workflow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_connect-customer-profiles_PutIntegration_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_PutIntegration_Examples"></a>

### Example
<a name="API_connect-customer-profiles_PutIntegration_Example_1"></a>

This example illustrates one usage of PutIntegration.

#### Sample Request
<a name="API_connect-customer-profiles_PutIntegration_Example_1_Request"></a>

```
PUT /domains/ExampleDomainName/integrations HTTP/1.1

Content-type: application/json
{
   "ObjectTypeName": "MyCustomObject",
   "Uri": "arn:aws:flow:us-east-1:123456789012:URIOfIntegration1"
}
```

#### Sample Response
<a name="API_connect-customer-profiles_PutIntegration_Example_1_Response"></a>

```
Content-type: application/json
{
   "CreatedAt": 1479249799770,
    "DomainName": "ExampleDomainName",
    "LastUpdatedAt": 1479249799770,
    "ObjectTypeName": "MyCustomObject",
    "Uri": "arn:aws:flow:us-east-1:123456789012:URIOfIntegration1"
}
```

## See Also
<a name="API_connect-customer-profiles_PutIntegration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/PutIntegration) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/PutIntegration) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/PutIntegration) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/PutIntegration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/PutIntegration) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/PutIntegration) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/PutIntegration) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/PutIntegration) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/PutIntegration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/PutIntegration) 

# PutProfileObject
<a name="API_connect-customer-profiles_PutProfileObject"></a>

Adds additional objects to customer profiles of a given ObjectType.

When adding a specific profile object, like a Contact Record, an inferred profile can get created if it is not mapped to an existing profile. The resulting profile will only have a phone number populated in the standard ProfileObject. Any additional Contact Records with the same phone number will be mapped to the same inferred profile.

When a ProfileObject is created and if a ProfileObjectType already exists for the ProfileObject, it will provide data to a standard profile depending on the ProfileObjectType definition.

PutProfileObject needs an ObjectType, which can be created using PutProfileObjectType.

## Request Syntax
<a name="API_connect-customer-profiles_PutProfileObject_RequestSyntax"></a>

```
PUT /domains/DomainName/profiles/objects HTTP/1.1
Content-type: application/json

{
   "Object": "string",
   "ObjectTypeName": "string"
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_PutProfileObject_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_PutProfileObject_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObject-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_PutProfileObject_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Object](#API_connect-customer-profiles_PutProfileObject_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObject-request-Object"></a>
A string that is serialized from a JSON object.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256000.  
Required: Yes

 ** [ObjectTypeName](#API_connect-customer-profiles_PutProfileObject_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObject-request-ObjectTypeName"></a>
The name of the profile object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_PutProfileObject_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ProfileObjectUniqueKey": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_PutProfileObject_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProfileObjectUniqueKey](#API_connect-customer-profiles_PutProfileObject_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObject-response-ProfileObjectUniqueKey"></a>
The unique identifier of the profile object generated by the service.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_connect-customer-profiles_PutProfileObject_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_PutProfileObject_Examples"></a>

### Example 1: For a custom object
<a name="API_connect-customer-profiles_PutProfileObject_Example_1"></a>

This example illustrates one usage of PutProfileObject.

#### Sample Request
<a name="API_connect-customer-profiles_PutProfileObject_Example_1_Request"></a>

```
PUT /domains/ExampleDomainName/profiles/objects HTTP/1.1
Content-type: application/json

{
   "Object": "{\"firstName\": \"John\",\n       \"lastName\": \"Smith\",\n       \"isAlive\": true,\n       \"age\": 27,\n       \"address\": {\"streetAddress\": \"21 2nd Street\",\"city\": \"New York\",\"state\": \"NY\",\"postalCode\": \"10021-3100\"},\n       \"phoneNumbers\": [{\"type\": \"home\",\"number\": \"212 555-1234\"},\n                        {\"type\": \"office\",\"number\": \"646 555-4567\"}],\n       \"children\": [],\n       \"spouse\": null}",
   "ObjectTypeName": "MyCustomObjectName"
}
```

#### Sample Response
<a name="API_connect-customer-profiles_PutProfileObject_Example_1_Response"></a>

```
Content-type: application/json
{
   "ProfileObjectUniqueKey": "HashValueOfUniqueKeyOfTheProfileObject"
}
```

### Example 2: For a pre-defined object, like a Contact Record
<a name="API_connect-customer-profiles_PutProfileObject_Example_2"></a>

This example illustrates one usage of PutProfileObject.

#### Sample Request
<a name="API_connect-customer-profiles_PutProfileObject_Example_2_Request"></a>

```
PUT /domains/ExampleDomainName/profiles/objects HTTP/1.1
Content-type: application/json

{
   "Object": "{\n    \"mediaStreams\": [\n        {\n            \"type\": \"AUDIO\"\n        }\n    ],\n    \"queue\": null,\n    \"preDisconnectState\": null,\n    \"references\": null,\n    \"contactReferences\": null,\n    \"initialContactId\": null,\n    \"previousContactData\": null,\n    \"recordings\": null,\n    \"contactDetails\": null,\n    \"initialContactFlowId\": \"e1b44e46-a457-4230-a896-64473a2dbe7d\",\n    \"channel\": \"VOICE\",\n    \"attributes\": null,\n    \"customerEndpoint\": {\n        \"address\": null,\n        \"type\": \"VOIP\",\n        \"arn\": null\n    },\n    \"transferInfo\": null,\n    \"initiationMethod\": \"API\",\n    \"nextContactData\": null,\n    \"contactId\": \"9a3394ee-a0c4-448a-a329-9a148e53d8cd\",\n    \"initiationTimestamp\": 1603319514474,\n    \"connectedToSystemTimestamp\": 1603319517218,\n    \"disconnectTimestamp\": 1603319517000,\n    \"agentConnectionAttempts\": 0,\n    \"agent\": null,\n    \"systemEndpoint\": {\n        \"address\": \"e1b44e46-a457-4230-a896-64473a2dbe7d\",\n        \"type\": \"CONTACT_FLOW\",\n        \"arn\": null\n    },\n    \"instanceARN\": \"arn:aws:connect:us-west-2:941081270797:instance/fb129b8c-4a2f-4561-859b-cc190fa047b1\",\n    \"lastUpdateTimestamp\": 1603319579763,\n    \"disconnectReason\": \"CUSTOMER_DISCONNECT\",\n    \"awsaccountId\": \"941081270797\",\n    \"awscontactTraceRecordFormatVersion\": \"2019-01-23\"\n}",
   "ObjectTypeName": "CTR"
}
```

#### Sample Response
<a name="API_connect-customer-profiles_PutProfileObject_Example_2_Response"></a>

```
Content-type: application/json
{
   "ProfileObjectUniqueKey": "HashValueOfTheCTRContactId"
}
```

## See Also
<a name="API_connect-customer-profiles_PutProfileObject_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/PutProfileObject) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/PutProfileObject) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/PutProfileObject) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/PutProfileObject) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/PutProfileObject) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/PutProfileObject) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/PutProfileObject) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/PutProfileObject) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/PutProfileObject) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/PutProfileObject) 

# PutProfileObjectType
<a name="API_connect-customer-profiles_PutProfileObjectType"></a>

Defines a ProfileObjectType.

To add or remove tags on an existing ObjectType, see [ TagResource](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html)/[UntagResource](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html).

## Request Syntax
<a name="API_connect-customer-profiles_PutProfileObjectType_RequestSyntax"></a>

```
PUT /domains/DomainName/object-types/ObjectTypeName HTTP/1.1
Content-type: application/json

{
   "AllowProfileCreation": boolean,
   "Description": "string",
   "EncryptionKey": "string",
   "ExpirationDays": number,
   "Fields": { 
      "string" : { 
         "ContentType": "string",
         "Source": "string",
         "Target": "string"
      }
   },
   "Keys": { 
      "string" : [ 
         { 
            "FieldNames": [ "string" ],
            "StandardIdentifiers": [ "string" ]
         }
      ]
   },
   "MaxProfileObjectCount": number,
   "SourceLastUpdatedTimestampFormat": "string",
   "Tags": { 
      "string" : "string" 
   },
   "TemplateId": "string"
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_PutProfileObjectType_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [ObjectTypeName](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-request-uri-ObjectTypeName"></a>
The name of the profile object type.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_PutProfileObjectType_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AllowProfileCreation](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-request-AllowProfileCreation"></a>
Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is `FALSE`. If the AllowProfileCreation flag is set to `FALSE`, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to `TRUE`, and if no match is found, then the service creates a new standard profile.  
Type: Boolean  
Required: No

 ** [Description](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-request-Description"></a>
Description of the profile object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: Yes

 ** [EncryptionKey](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-request-EncryptionKey"></a>
The customer-provided key to encrypt the profile object that will be created in this profile object type.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [ExpirationDays](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-request-ExpirationDays"></a>
The number of days until the data in the object expires.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1098.  
Required: No

 ** [Fields](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-request-Fields"></a>
A map of the name and ObjectType field.  
Type: String to [ObjectTypeField](API_connect-customer-profiles_ObjectTypeField.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Key Pattern: `^[a-zA-Z0-9_.-]+$`   
Required: No

 ** [Keys](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-request-Keys"></a>
A list of unique keys that can be used to map data to the profile.  
Type: String to array of [ObjectTypeKey](API_connect-customer-profiles_ObjectTypeKey.md) objects map  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Key Pattern: `^[a-zA-Z0-9_-]+$`   
Required: No

 ** [MaxProfileObjectCount](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-request-MaxProfileObjectCount"></a>
The amount of profile object max count assigned to the object type  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [SourceLastUpdatedTimestampFormat](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-request-SourceLastUpdatedTimestampFormat"></a>
The format of your `sourceLastUpdatedTimestamp` that was previously set up.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [Tags](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-request-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Required: No

 ** [TemplateId](#API_connect-customer-profiles_PutProfileObjectType_RequestSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-request-TemplateId"></a>
A unique identifier for the object template. For some attributes in the request, the service will use the default value from the object template when TemplateId is present. If these attributes are present in the request, the service may return a `BadRequestException`. These attributes include: AllowProfileCreation, SourceLastUpdatedTimestampFormat, Fields, and Keys. For example, if AllowProfileCreation is set to true when TemplateId is set, the service may return a `BadRequestException`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: No

## Response Syntax
<a name="API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AllowProfileCreation": boolean,
   "CreatedAt": number,
   "Description": "string",
   "EncryptionKey": "string",
   "ExpirationDays": number,
   "Fields": { 
      "string" : { 
         "ContentType": "string",
         "Source": "string",
         "Target": "string"
      }
   },
   "Keys": { 
      "string" : [ 
         { 
            "FieldNames": [ "string" ],
            "StandardIdentifiers": [ "string" ]
         }
      ]
   },
   "LastUpdatedAt": number,
   "MaxAvailableProfileObjectCount": number,
   "MaxProfileObjectCount": number,
   "ObjectTypeName": "string",
   "SourceLastUpdatedTimestampFormat": "string",
   "Tags": { 
      "string" : "string" 
   },
   "TemplateId": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_PutProfileObjectType_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AllowProfileCreation](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-response-AllowProfileCreation"></a>
Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type. The default is `FALSE`. If the AllowProfileCreation flag is set to `FALSE`, then the service tries to fetch a standard profile and associate this object with the profile. If it is set to `TRUE`, and if no match is found, then the service creates a new standard profile.  
Type: Boolean

 ** [CreatedAt](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-response-CreatedAt"></a>
The timestamp of when the domain was created.  
Type: Timestamp

 ** [Description](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-response-Description"></a>
Description of the profile object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.

 ** [EncryptionKey](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-response-EncryptionKey"></a>
The customer-provided key to encrypt the profile object that will be created in this profile object type.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.

 ** [ExpirationDays](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-response-ExpirationDays"></a>
The number of days until the data in the object expires.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1098.

 ** [Fields](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-response-Fields"></a>
A map of the name and ObjectType field.  
Type: String to [ObjectTypeField](API_connect-customer-profiles_ObjectTypeField.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Key Pattern: `^[a-zA-Z0-9_.-]+$` 

 ** [Keys](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-response-Keys"></a>
A list of unique keys that can be used to map data to the profile.  
Type: String to array of [ObjectTypeKey](API_connect-customer-profiles_ObjectTypeKey.md) objects map  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Key Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [LastUpdatedAt](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-response-LastUpdatedAt"></a>
The timestamp of when the domain was most recently edited.  
Type: Timestamp

 ** [MaxAvailableProfileObjectCount](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-response-MaxAvailableProfileObjectCount"></a>
The amount of provisioned profile object max count available.  
Type: Integer  
Valid Range: Minimum value of 0.

 ** [MaxProfileObjectCount](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-response-MaxProfileObjectCount"></a>
The amount of profile object max count assigned to the object type.  
Type: Integer  
Valid Range: Minimum value of 1.

 ** [ObjectTypeName](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-response-ObjectTypeName"></a>
The name of the profile object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` 

 ** [SourceLastUpdatedTimestampFormat](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-response-SourceLastUpdatedTimestampFormat"></a>
The format of your `sourceLastUpdatedTimestamp` that was previously set up in fields that were parsed using [SimpleDateFormat](https://docs.oracle.com/javase/10/docs/api/java/text/SimpleDateFormat.html). If you have `sourceLastUpdatedTimestamp` in your field, you must set up `sourceLastUpdatedTimestampFormat`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

 ** [Tags](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-response-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

 ** [TemplateId](#API_connect-customer-profiles_PutProfileObjectType_ResponseSyntax) **   <a name="connect-connect-customer-profiles_PutProfileObjectType-response-TemplateId"></a>
A unique identifier for the object template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

## Errors
<a name="API_connect-customer-profiles_PutProfileObjectType_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_PutProfileObjectType_Examples"></a>

### Example 1
<a name="API_connect-customer-profiles_PutProfileObjectType_Example_1"></a>

In the request, replace the `Fields` and `Keys` request parameters with your own. If specifying a `TemplateId`, replace it with your own `TemplateId` value. You must either specify both `Fields` and `Keys`, or you can specify `TemplateId`. You can't include all three.

#### Sample Request
<a name="API_connect-customer-profiles_PutProfileObjectType_Example_1_Request"></a>

```
PUT /domains/ExampleDomainName/object-types/CustomProfileObjectTypeName HTTP/1.1


{
   "Description": "Internal ERP System",
   "EncryptionKey": "arn:aws:kms:us-east-1:123456789012:key/1988472d-6b77-4bb6-ae39-efce5EXAMPLE",
   "AllowProfileCreation": false,
   "ExpirationDays": 1000,
   "Fields": { 
      "email" : { 
         "ContentType": "EMAIL_ADDRESS",
         "Source": "_source.email",
         "Target": "_profile.BusinessEmail"
      },
      "phone" : { 
         "ContentType": "PHONE_NUMBER",
         "Source": "_source.phone",
         "Target": "_profile.BusinessPhoneNumber"
      },
      "loyaltyPoints" : { 
         "ContentType": "NUMBER",
         "Source": "_source.loyaltypoints",
         "Target": "_profile.Attributes.loyaltypoints"
      }
   },
   "Keys": { 
      "_email" : [ 
         { 
            "FieldNames": [ "email" ],
            "StandardIdentifiers": [ "PROFILE", "UNIQUE" ]
         }
      ],
      "loyaltypoints" : [ 
         { 
            "FieldNames": [ "loyaltyPoints" ],
            "StandardIdentifiers": [ "PROFILE"]
         }
      ]
   },
   "TemplateId": "MyTemplateId"
}
```

#### Sample Response
<a name="API_connect-customer-profiles_PutProfileObjectType_Example_1_Response"></a>

```
Content-type: application/json
{
   "CreatedAt": 1479249799770,
   "Description": "Internal ERP System",
   "EncryptionKey": "arn:aws:kms:us-east-1:123456789012:key/1988472d-6b77-4bb6-ae39-efce5EXAMPLE",
   "AllowProfileCreation": "FALSE",
   "ExpirationDays": 100,
   "Fields": { 
      "email" : { 
         "ContentType": "EMAIL_ADDRESS",
         "Source": "_source.email",
         "Target": "_profile.BusinessEmailAddress"
      },
      "phone" : { 
         "ContentType": "PHONE_NUMBER",
         "Source": "_source.phone",
         "Target": "_profile.BusinessPhoneNumber"
      },
      "loyaltyPoints" : { 
         "ContentType": "NUMBER",
         "Source": "_source.loyaltypoints",
         "Target": "_profile.Attributes.loyaltypoints"
      }
   },
   "Keys": { 
      "email" : [ 
         { 
            "FieldNames": [ "email" ],
            "StandardIdentifiers": [ "PROFILE", "UNIQUE" ]
         }
      ],
      "loyaltypoints" : [ 
         { 
            "FieldNames": [ "loyaltyPoints" ],
            "StandardIdentifiers": [ "PROFILE"]
         }
      ]
   },
   "LastUpdatedAt": 1479249799770,
   "ObjectTypeName": "CustomProfileObjectTypeName",
   "TemplateId": "MyTemplateId"
}
```

### Example 2
<a name="API_connect-customer-profiles_PutProfileObjectType_Example_2"></a>

This example illustrates one usage of PutProfileObjectType.

#### Sample Request
<a name="API_connect-customer-profiles_PutProfileObjectType_Example_2_Request"></a>

```
PUT /domains/ExampleDomainName/object-types/CTR HTTP/1.1
Content-type: application/json
{
   "Description": "CTR",
   "TemplateId": "CTR-NoInferred"
}
```

### Example 2.5
<a name="API_connect-customer-profiles_PutProfileObjectType_Example_3"></a>

This command associates Contact Records with already existing profiles with the same phone number. In the example below, replace `ExampleDomainName` with your domain name, and replace the description with your desired description.

#### Sample Request
<a name="API_connect-customer-profiles_PutProfileObjectType_Example_3_Request"></a>

```
aws profile put-object-type --domain-name ExampleDomainName --object-type-name CTR --description "CTR" --template-id "CTR-NoInferred"
```

## See Also
<a name="API_connect-customer-profiles_PutProfileObjectType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/PutProfileObjectType) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/PutProfileObjectType) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/PutProfileObjectType) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/PutProfileObjectType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/PutProfileObjectType) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/PutProfileObjectType) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/PutProfileObjectType) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/PutProfileObjectType) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/PutProfileObjectType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/PutProfileObjectType) 

# SearchProfiles
<a name="API_connect-customer-profiles_SearchProfiles"></a>

Searches for profiles within a specific domain using one or more predefined search keys (e.g., \$1fullName, \$1phone, \$1email, \$1account, etc.) and/or custom-defined search keys. A search key is a data type pair that consists of a `KeyName` and `Values` list.

This operation supports searching for profiles with a minimum of 1 key-value(s) pair and up to 5 key-value(s) pairs using either `AND` or `OR` logic.

## Request Syntax
<a name="API_connect-customer-profiles_SearchProfiles_RequestSyntax"></a>

```
POST /domains/DomainName/profiles/search?max-results=MaxResults&next-token=NextToken HTTP/1.1
Content-type: application/json

{
   "AdditionalSearchKeys": [ 
      { 
         "KeyName": "string",
         "Values": [ "string" ]
      }
   ],
   "KeyName": "string",
   "LogicalOperator": "string",
   "Values": [ "string" ]
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_SearchProfiles_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_SearchProfiles_RequestSyntax) **   <a name="connect-connect-customer-profiles_SearchProfiles-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [MaxResults](#API_connect-customer-profiles_SearchProfiles_RequestSyntax) **   <a name="connect-connect-customer-profiles_SearchProfiles-request-uri-MaxResults"></a>
The maximum number of objects returned per page.  
The default is 20 if this parameter is not included in the request.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [NextToken](#API_connect-customer-profiles_SearchProfiles_RequestSyntax) **   <a name="connect-connect-customer-profiles_SearchProfiles-request-uri-NextToken"></a>
The pagination token from the previous SearchProfiles API call.  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Request Body
<a name="API_connect-customer-profiles_SearchProfiles_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AdditionalSearchKeys](#API_connect-customer-profiles_SearchProfiles_RequestSyntax) **   <a name="connect-connect-customer-profiles_SearchProfiles-request-AdditionalSearchKeys"></a>
A list of `AdditionalSearchKey` objects that are each searchable identifiers of a profile. Each `AdditionalSearchKey` object contains a `KeyName` and a list of `Values` associated with that specific key (i.e., a key-value(s) pair). These additional search keys will be used in conjunction with the `LogicalOperator` and the required `KeyName` and `Values` parameters to search for profiles that satisfy the search criteria.   
Type: Array of [AdditionalSearchKey](API_connect-customer-profiles_AdditionalSearchKey.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 4 items.  
Required: No

 ** [KeyName](#API_connect-customer-profiles_SearchProfiles_RequestSyntax) **   <a name="connect-connect-customer-profiles_SearchProfiles-request-KeyName"></a>
A searchable identifier of a customer profile. The predefined keys you can use to search include: \$1account, \$1profileId, \$1assetId, \$1caseId, \$1orderId, \$1fullName, \$1phone, \$1email, \$1ctrContactId, \$1marketoLeadId, \$1salesforceAccountId, \$1salesforceContactId, \$1salesforceAssetId, \$1zendeskUserId, \$1zendeskExternalId, \$1zendeskTicketId, \$1serviceNowSystemId, \$1serviceNowIncidentId, \$1segmentUserId, \$1shopifyCustomerId, \$1shopifyOrderId.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [LogicalOperator](#API_connect-customer-profiles_SearchProfiles_RequestSyntax) **   <a name="connect-connect-customer-profiles_SearchProfiles-request-LogicalOperator"></a>
Relationship between all specified search keys that will be used to search for profiles. This includes the required `KeyName` and `Values` parameters as well as any key-value(s) pairs specified in the `AdditionalSearchKeys` list.  
This parameter influences which profiles will be returned in the response in the following manner:  
+  `AND` - The response only includes profiles that match all of the search keys.
+  `OR` - The response includes profiles that match at least one of the search keys.
The `OR` relationship is the default behavior if this parameter is not included in the request.  
Type: String  
Valid Values: `AND | OR`   
Required: No

 ** [Values](#API_connect-customer-profiles_SearchProfiles_RequestSyntax) **   <a name="connect-connect-customer-profiles_SearchProfiles-request-Values"></a>
A list of key values.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_SearchProfiles_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "AccountNumber": "string",
         "AdditionalInformation": "string",
         "Address": { 
            "Address1": "string",
            "Address2": "string",
            "Address3": "string",
            "Address4": "string",
            "City": "string",
            "Country": "string",
            "County": "string",
            "PostalCode": "string",
            "Province": "string",
            "State": "string"
         },
         "Attributes": { 
            "string" : "string" 
         },
         "BillingAddress": { 
            "Address1": "string",
            "Address2": "string",
            "Address3": "string",
            "Address4": "string",
            "City": "string",
            "Country": "string",
            "County": "string",
            "PostalCode": "string",
            "Province": "string",
            "State": "string"
         },
         "BirthDate": "string",
         "BusinessEmailAddress": "string",
         "BusinessName": "string",
         "BusinessPhoneNumber": "string",
         "EmailAddress": "string",
         "EngagementPreferences": { 
            "Email": [ 
               { 
                  "ContactType": "string",
                  "KeyName": "string",
                  "KeyValue": "string",
                  "ProfileId": "string"
               }
            ],
            "Phone": [ 
               { 
                  "ContactType": "string",
                  "KeyName": "string",
                  "KeyValue": "string",
                  "ProfileId": "string"
               }
            ]
         },
         "FirstName": "string",
         "FoundByItems": [ 
            { 
               "KeyName": "string",
               "Values": [ "string" ]
            }
         ],
         "Gender": "string",
         "GenderString": "string",
         "HomePhoneNumber": "string",
         "LastName": "string",
         "MailingAddress": { 
            "Address1": "string",
            "Address2": "string",
            "Address3": "string",
            "Address4": "string",
            "City": "string",
            "Country": "string",
            "County": "string",
            "PostalCode": "string",
            "Province": "string",
            "State": "string"
         },
         "MiddleName": "string",
         "MobilePhoneNumber": "string",
         "PartyType": "string",
         "PartyTypeString": "string",
         "PersonalEmailAddress": "string",
         "PhoneNumber": "string",
         "ProfileId": "string",
         "ProfileType": "string",
         "ShippingAddress": { 
            "Address1": "string",
            "Address2": "string",
            "Address3": "string",
            "Address4": "string",
            "City": "string",
            "Country": "string",
            "County": "string",
            "PostalCode": "string",
            "Province": "string",
            "State": "string"
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_SearchProfiles_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Items](#API_connect-customer-profiles_SearchProfiles_ResponseSyntax) **   <a name="connect-connect-customer-profiles_SearchProfiles-response-Items"></a>
The list of Profiles matching the search criteria.  
Type: Array of [Profile](API_connect-customer-profiles_Profile.md) objects

 ** [NextToken](#API_connect-customer-profiles_SearchProfiles_ResponseSyntax) **   <a name="connect-connect-customer-profiles_SearchProfiles-response-NextToken"></a>
The pagination token from the previous SearchProfiles API call.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_connect-customer-profiles_SearchProfiles_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_SearchProfiles_Examples"></a>

### Example 1
<a name="API_connect-customer-profiles_SearchProfiles_Example_1"></a>

This example illustrates one usage of SearchProfiles.

#### Sample Request
<a name="API_connect-customer-profiles_SearchProfiles_Example_1_Request"></a>

```
POST /domains/ExampleDomainName/profiles/search?max-results=10&next-token=nextTokenString HTTP/1.1
Content-type: application/json

{
   "KeyName": "_phone",
   "Values": ["555-333-7777"]
}
```

#### Sample Response
<a name="API_connect-customer-profiles_SearchProfiles_Example_1_Response"></a>

```
Content-type: application/json 
{
  "NextToken": "5231b533-ba17-4787-98a3-f2df3EXAMPLE",
  "Items":[
    {
        "ProfileId" : "3991a7d95sd248bba82546b2dEXAMPLE",
        "AccountNumber": "ACCT12344",
        "Address": { 
            "Address1": "123 Sample St",
            "Address2": "Apt 4",
            "Address3": "",
            "Address4": "",
            "City": "Seattle",
            "Country": "USA",
            "County": "King",
            "PostalCode": "98011",
            "Province": "",
            "State": "WA"
        },
        "Attributes": { 
            "SSN" : "123-44-3433",
            "LoyaltyPoints" : "4000" 
        },
        "BillingAddress": { 
            "Address1": "789 Sample St",
            "Address2": "Apt 1",
            "Address3": "",
            "Address4": "",
            "City": "Seattle",
            "Country": "USA",
            "County": "King",
            "PostalCode": "98011",
            "Province": "",
            "State": "WA"
        },
        "BirthDate": "07/12/1980",
        "BusinessEmailAddress": "example@amazon.com",
        "BusinessName": "My Awesome Company",
        "BusinessPhoneNumber": "555-334-3389",
        "EmailAddress": "example@gmail.com",
        "FirstName": "John",
        "Gender": "MALE",
        "HomePhoneNumber": "555-334-3344",
        "LastName": "Doe",
        "MailingAddress": { 
            "Address1": "234 Home St",
            "Address2": "Apt 5",
            "Address3": "",
            "Address4": "",
            "City": "Seattle",
            "Country": "USA",
            "County": "King",
            "PostalCode": "98011",
            "Province": "",
            "State": "WA"
        },
        "AdditionalInformation": "High Profile Customer",
        "MiddleName": "",
        "MobilePhoneNumber": "555-333-7777",
        "PartyType": "INDIVIDUAL",
        "PersonalEmailAddress": "email1@gmail.com",
        "PhoneNumber": "",
        "ShippingAddress": { 
            "Address1": "555 A St",
            "Address2": "Suite 100",
            "Address3": "",
            "Address4": "",
            "City": "Seattle",
            "Country": "USA",
            "County": "King",
            "PostalCode": "98011",
            "Province": "",
            "State": "WA"
        }
  },
  {
        "ProfileId" : "ef30fad550894e0a95f9d64cbEXAMPLE",
        "AccountNumber": "ACCT12344",
        "Address": { 
            "Address1": "123 Sample St",
            "Address2": "Apt 4",
            "Address3": "",
            "Address4": "",
            "City": "Seattle",
            "Country": "USA",
            "County": "King",
            "PostalCode": "98011",
            "Province": "",
            "State": "WA"
        },
        "Attributes": { 
            "SSN" : "123-44-3433",
            "LoyaltyPoints" : "4000" 
        },
        "BillingAddress": { 
            "Address1": "789 Sample St",
            "Address2": "Apt 1",
            "Address3": "",
            "Address4": "",
            "City": "Seattle",
            "Country": "USA",
            "County": "King",
            "PostalCode": "98011",
            "Province": "",
            "State": "WA"
        },
        "BirthDate": "07/12/1980",
        "BusinessEmailAddress": "example@amazon.com",
        "BusinessName": "My Awesome Company",
        "BusinessPhoneNumber": "555-334-3389",
        "EmailAddress": "example@gmail.com",
        "FirstName": "John",
        "Gender": "MALE",
        "HomePhoneNumber": "555-334-3344",
        "LastName": "Doe",
        "MailingAddress": { 
            "Address1": "234 Home St",
            "Address2": "Apt 5",
            "Address3": "",
            "Address4": "",
            "City": "Seattle",
            "Country": "USA",
            "County": "King",
            "PostalCode": "98011",
            "Province": "",
            "State": "WA"
        },
        "AdditionalInformation": "High Profile Customer",
        "MiddleName": "",
        "MobilePhoneNumber": "555-333-7777",
        "PartyType": "INDIVIDUAL",
        "PersonalEmailAddress": "email1@gmail.com",
        "PhoneNumber": "",
        "ShippingAddress": { 
            "Address1": "555 A St",
            "Address2": "Suite 100",
            "Address3": "",
            "Address4": "",
            "City": "Seattle",
            "Country": "USA",
            "County": "King",
            "PostalCode": "98011",
            "Province": "",
            "State": "WA"
        }
  }
 ]
}
```

### Example 2
<a name="API_connect-customer-profiles_SearchProfiles_Example_2"></a>

This example illustrates one usage of SearchProfiles.

#### Sample Request
<a name="API_connect-customer-profiles_SearchProfiles_Example_2_Request"></a>

```
POST /domains/ExampleDomainName/profiles/search?max-results=10&next-token=nextTokenString HTTP/1.1
Content-type: application/json

{
   "KeyName": "_email",
   "Values": ["email1@gmail.com"]
}
```

#### Sample Response
<a name="API_connect-customer-profiles_SearchProfiles_Example_2_Response"></a>

```
Content-type: application/json 
{
  "NextToken": "5231b533-ba17-4787-98a3-f2df3EXAMPLE",
  "Items":[
    {
        "ProfileId" : "ef30fad55099ee0a95f9d64cbEXAMPLE",
        "AccountNumber": "ACCT12344",
        "Address": { 
            "Address1": "123 Sample St",
            "Address2": "Apt 4",
            "Address3": "",
            "Address4": "",
            "City": "Seattle",
            "Country": "USA",
            "County": "King",
            "PostalCode": "98011",
            "Province": "",
            "State": "WA"
        },
        "Attributes": { 
            "SSN" : "123-44-3433",
            "LoyaltyPoints" : "4000" 
        },
        "BillingAddress": { 
            "Address1": "789 Sample St",
            "Address2": "Apt 1",
            "Address3": "",
            "Address4": "",
            "City": "Seattle",
            "Country": "USA",
            "County": "King",
            "PostalCode": "98011",
            "Province": "",
            "State": "WA"
        },
        "BirthDate": "07/12/1980",
        "BusinessEmailAddress": "example@amazon.com",
        "BusinessName": "My Awesome Company",
        "BusinessPhoneNumber": "555-334-3389",
        "EmailAddress": "example@gmail.com",
        "FirstName": "John",
        "Gender": "MALE",
        "HomePhoneNumber": "555-334-3344",
        "LastName": "Doe",
        "MailingAddress": { 
            "Address1": "234 Home St",
            "Address2": "Apt 5",
            "Address3": "",
            "Address4": "",
            "City": "Seattle",
            "Country": "USA",
            "County": "King",
            "PostalCode": "98011",
            "Province": "",
            "State": "WA"
        },
        "AdditionalInformation": "High Profile Customer",
        "MiddleName": "",
        "MobilePhoneNumber": "555-333-7777",
        "PartyType": "INDIVIDUAL",
        "PersonalEmailAddress": "email5@gmail.com",
        "PhoneNumber": "",
        "ShippingAddress": { 
            "Address1": "555 A St",
            "Address2": "Suite 100",
            "Address3": "",
            "Address4": "",
            "City": "Seattle",
            "Country": "USA",
            "County": "King",
            "PostalCode": "98011",
            "Province": "",
            "State": "WA"
        }
  },
  {
        "ProfileId" : "3991a7d959d238bba82546b2dEXAMPLE",
        "AccountNumber": "ACCT12344",
        "Address": { 
            "Address1": "123 Sample St",
            "Address2": "Apt 4",
            "Address3": "",
            "Address4": "",
            "City": "Seattle",
            "Country": "USA",
            "County": "King",
            "PostalCode": "98011",
            "Province": "",
            "State": "WA"
        },
        "Attributes": { 
            "SSN" : "123-44-3433",
            "LoyaltyPoints" : "4000" 
        },
        "BillingAddress": { 
            "Address1": "789 Sample St",
            "Address2": "Apt 1",
            "Address3": "",
            "Address4": "",
            "City": "Seattle",
            "Country": "USA",
            "County": "King",
            "PostalCode": "98011",
            "Province": "",
            "State": "WA"
        },
        "BirthDate": "07/12/1980",
        "BusinessEmailAddress": "example@amazon.com",
        "BusinessName": "My Awesome Company",
        "BusinessPhoneNumber": "555-334-3389",
        "EmailAddress": "example@gmail.com",
        "FirstName": "John",
        "Gender": "MALE",
        "HomePhoneNumber": "555-334-3344",
        "LastName": "Doe",
        "MailingAddress": { 
            "Address1": "234 Home St",
            "Address2": "Apt 5",
            "Address3": "",
            "Address4": "",
            "City": "Seattle",
            "Country": "USA",
            "County": "King",
            "PostalCode": "98011",
            "Province": "",
            "State": "WA"
        },
        "AdditionalInformation": "High Profile Customer",
        "MiddleName": "",
        "MobilePhoneNumber": "555-333-7777",
        "PartyType": "INDIVIDUAL",
        "PersonalEmailAddress": "email1@gmail.com",
        "PhoneNumber": "",
        "ShippingAddress": { 
            "Address1": "555 A St",
            "Address2": "Suite 100",
            "Address3": "",
            "Address4": "",
            "City": "Seattle",
            "Country": "USA",
            "County": "King",
            "PostalCode": "98011",
            "Province": "",
            "State": "WA"
        }
  }
 ]
}
```

## See Also
<a name="API_connect-customer-profiles_SearchProfiles_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/SearchProfiles) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/SearchProfiles) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/SearchProfiles) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/SearchProfiles) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/SearchProfiles) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/SearchProfiles) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/SearchProfiles) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/SearchProfiles) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/SearchProfiles) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/SearchProfiles) 

# StartRecommender
<a name="API_connect-customer-profiles_StartRecommender"></a>

Starts a recommender that was previously stopped. Starting a recommender resumes its ability to generate recommendations.

## Request Syntax
<a name="API_connect-customer-profiles_StartRecommender_RequestSyntax"></a>

```
PUT /domains/DomainName/recommenders/RecommenderName/start HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_StartRecommender_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_StartRecommender_RequestSyntax) **   <a name="connect-connect-customer-profiles_StartRecommender-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [RecommenderName](#API_connect-customer-profiles_StartRecommender_RequestSyntax) **   <a name="connect-connect-customer-profiles_StartRecommender-request-uri-RecommenderName"></a>
The name of the recommender to start.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_StartRecommender_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_StartRecommender_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-customer-profiles_StartRecommender_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-customer-profiles_StartRecommender_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_StartRecommender_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/StartRecommender) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/StartRecommender) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/StartRecommender) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/StartRecommender) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/StartRecommender) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/StartRecommender) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/StartRecommender) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/StartRecommender) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/StartRecommender) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/StartRecommender) 

# StartUploadJob
<a name="API_connect-customer-profiles_StartUploadJob"></a>

This API starts the processing of an upload job to ingest profile data. 

## Request Syntax
<a name="API_connect-customer-profiles_StartUploadJob_RequestSyntax"></a>

```
PUT /domains/DomainName/upload-jobs/JobId HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_StartUploadJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_StartUploadJob_RequestSyntax) **   <a name="connect-connect-customer-profiles_StartUploadJob-request-uri-DomainName"></a>
The unique name of the domain containing the upload job to start.   
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [JobId](#API_connect-customer-profiles_StartUploadJob_RequestSyntax) **   <a name="connect-connect-customer-profiles_StartUploadJob-request-uri-JobId"></a>
The unique identifier of the upload job to start.   
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_StartUploadJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_StartUploadJob_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-customer-profiles_StartUploadJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-customer-profiles_StartUploadJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_StartUploadJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/StartUploadJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/StartUploadJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/StartUploadJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/StartUploadJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/StartUploadJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/StartUploadJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/StartUploadJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/StartUploadJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/StartUploadJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/StartUploadJob) 

# StopRecommender
<a name="API_connect-customer-profiles_StopRecommender"></a>

Stops a recommender, suspending its ability to generate recommendations. The recommender can be restarted later using StartRecommender.

## Request Syntax
<a name="API_connect-customer-profiles_StopRecommender_RequestSyntax"></a>

```
PUT /domains/DomainName/recommenders/RecommenderName/stop HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_StopRecommender_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_StopRecommender_RequestSyntax) **   <a name="connect-connect-customer-profiles_StopRecommender-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [RecommenderName](#API_connect-customer-profiles_StopRecommender_RequestSyntax) **   <a name="connect-connect-customer-profiles_StopRecommender-request-uri-RecommenderName"></a>
The name of the recommender to stop.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_StopRecommender_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_StopRecommender_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-customer-profiles_StopRecommender_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-customer-profiles_StopRecommender_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_StopRecommender_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/StopRecommender) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/StopRecommender) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/StopRecommender) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/StopRecommender) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/StopRecommender) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/StopRecommender) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/StopRecommender) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/StopRecommender) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/StopRecommender) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/StopRecommender) 

# StopUploadJob
<a name="API_connect-customer-profiles_StopUploadJob"></a>

This API stops the processing of an upload job. 

## Request Syntax
<a name="API_connect-customer-profiles_StopUploadJob_RequestSyntax"></a>

```
PUT /domains/DomainName/upload-jobs/JobId/stop HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_StopUploadJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_StopUploadJob_RequestSyntax) **   <a name="connect-connect-customer-profiles_StopUploadJob-request-uri-DomainName"></a>
The unique name of the domain containing the upload job to stop.   
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [JobId](#API_connect-customer-profiles_StopUploadJob_RequestSyntax) **   <a name="connect-connect-customer-profiles_StopUploadJob-request-uri-JobId"></a>
The unique identifier of the upload job to stop.   
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_StopUploadJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_StopUploadJob_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-customer-profiles_StopUploadJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-customer-profiles_StopUploadJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_StopUploadJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/StopUploadJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/StopUploadJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/StopUploadJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/StopUploadJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/StopUploadJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/StopUploadJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/StopUploadJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/StopUploadJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/StopUploadJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/StopUploadJob) 

# TagResource
<a name="API_connect-customer-profiles_TagResource"></a>

Assigns one or more tags (key-value pairs) to the specified Amazon Connect Customer Profiles resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource.

## Request Syntax
<a name="API_connect-customer-profiles_TagResource_RequestSyntax"></a>

```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_connect-customer-profiles_TagResource_RequestSyntax) **   <a name="connect-connect-customer-profiles_TagResource-request-uri-resourceArn"></a>
The ARN of the resource that you're adding tags to.  
Length Constraints: Maximum length of 256.  
Pattern: `^arn:[a-z0-9]{1,10}:profile`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [tags](#API_connect-customer-profiles_TagResource_RequestSyntax) **   <a name="connect-connect-customer-profiles_TagResource-request-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Required: Yes

## Response Syntax
<a name="API_connect-customer-profiles_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-customer-profiles_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-customer-profiles_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

## See Also
<a name="API_connect-customer-profiles_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/TagResource) 

# UntagResource
<a name="API_connect-customer-profiles_UntagResource"></a>

Removes one or more tags from the specified Amazon Connect Customer Profiles resource. In Connect Customer Profiles, domains, profile object types, and integrations can be tagged.

## Request Syntax
<a name="API_connect-customer-profiles_UntagResource_RequestSyntax"></a>

```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_connect-customer-profiles_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_connect-customer-profiles_UntagResource_RequestSyntax) **   <a name="connect-connect-customer-profiles_UntagResource-request-uri-resourceArn"></a>
The ARN of the resource from which you are removing tags.  
Length Constraints: Maximum length of 256.  
Pattern: `^arn:[a-z0-9]{1,10}:profile`   
Required: Yes

 ** [tagKeys](#API_connect-customer-profiles_UntagResource_RequestSyntax) **   <a name="connect-connect-customer-profiles_UntagResource-request-uri-tagKeys"></a>
The list of tag keys to remove from the resource.  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_connect-customer-profiles_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_connect-customer-profiles_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-customer-profiles_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

## See Also
<a name="API_connect-customer-profiles_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/UntagResource) 

# UpdateCalculatedAttributeDefinition
<a name="API_connect-customer-profiles_UpdateCalculatedAttributeDefinition"></a>

Updates an existing calculated attribute definition. When updating the Conditions, note that increasing the date range of a calculated attribute will not trigger inclusion of historical data greater than the current date range.

## Request Syntax
<a name="API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_RequestSyntax"></a>

```
PUT /domains/DomainName/calculated-attributes/CalculatedAttributeName HTTP/1.1
Content-type: application/json

{
   "Conditions": { 
      "ObjectCount": number,
      "Range": { 
         "TimestampFormat": "string",
         "TimestampSource": "string",
         "Unit": "string",
         "Value": number,
         "ValueRange": { 
            "End": number,
            "Start": number
         }
      },
      "Threshold": { 
         "Operator": "string",
         "Value": "string"
      }
   },
   "Description": "string",
   "DisplayName": "string"
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_RequestParameters"></a>

The request uses the following URI parameters.

 ** [CalculatedAttributeName](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateCalculatedAttributeDefinition-request-uri-CalculatedAttributeName"></a>
The unique name of the calculated attribute.  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: Yes

 ** [DomainName](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateCalculatedAttributeDefinition-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Conditions](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateCalculatedAttributeDefinition-request-Conditions"></a>
The conditions including range, object count, and threshold for the calculated attribute.  
Type: [Conditions](API_connect-customer-profiles_Conditions.md) object  
Required: No

 ** [Description](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateCalculatedAttributeDefinition-request-Description"></a>
The description of the calculated attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: No

 ** [DisplayName](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateCalculatedAttributeDefinition-request-DisplayName"></a>
The display name of the calculated attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$`   
Required: No

## Response Syntax
<a name="API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "AttributeDetails": { 
      "Attributes": [ 
         { 
            "Name": "string"
         }
      ],
      "Expression": "string"
   },
   "CalculatedAttributeName": "string",
   "Conditions": { 
      "ObjectCount": number,
      "Range": { 
         "TimestampFormat": "string",
         "TimestampSource": "string",
         "Unit": "string",
         "Value": number,
         "ValueRange": { 
            "End": number,
            "Start": number
         }
      },
      "Threshold": { 
         "Operator": "string",
         "Value": "string"
      }
   },
   "CreatedAt": number,
   "Description": "string",
   "DisplayName": "string",
   "LastUpdatedAt": number,
   "Readiness": { 
      "Message": "string",
      "ProgressPercentage": number
   },
   "Statistic": "string",
   "Status": "string",
   "Tags": { 
      "string" : "string" 
   },
   "UseHistoricalData": boolean
}
```

## Response Elements
<a name="API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AttributeDetails](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateCalculatedAttributeDefinition-response-AttributeDetails"></a>
The mathematical expression and a list of attribute items specified in that expression.  
Type: [AttributeDetails](API_connect-customer-profiles_AttributeDetails.md) object

 ** [CalculatedAttributeName](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateCalculatedAttributeDefinition-response-CalculatedAttributeName"></a>
The unique name of the calculated attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` 

 ** [Conditions](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateCalculatedAttributeDefinition-response-Conditions"></a>
The conditions including range, object count, and threshold for the calculated attribute.  
Type: [Conditions](API_connect-customer-profiles_Conditions.md) object

 ** [CreatedAt](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateCalculatedAttributeDefinition-response-CreatedAt"></a>
The timestamp of when the calculated attribute definition was created.  
Type: Timestamp

 ** [Description](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateCalculatedAttributeDefinition-response-Description"></a>
The description of the calculated attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.

 ** [DisplayName](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateCalculatedAttributeDefinition-response-DisplayName"></a>
The display name of the calculated attribute.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$` 

 ** [LastUpdatedAt](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateCalculatedAttributeDefinition-response-LastUpdatedAt"></a>
The timestamp of when the calculated attribute definition was most recently edited.  
Type: Timestamp

 ** [Readiness](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateCalculatedAttributeDefinition-response-Readiness"></a>
Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected.  
Type: [Readiness](API_connect-customer-profiles_Readiness.md) object

 ** [Statistic](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateCalculatedAttributeDefinition-response-Statistic"></a>
The aggregation operation to perform for the calculated attribute.  
Type: String  
Valid Values: `FIRST_OCCURRENCE | LAST_OCCURRENCE | COUNT | SUM | MINIMUM | MAXIMUM | AVERAGE | MAX_OCCURRENCE` 

 ** [Status](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateCalculatedAttributeDefinition-response-Status"></a>
Status of the Calculated Attribute creation (whether all historical data has been indexed.)  
Type: String  
Valid Values: `PREPARING | IN_PROGRESS | COMPLETED | FAILED` 

 ** [Tags](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateCalculatedAttributeDefinition-response-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

 ** [UseHistoricalData](#API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateCalculatedAttributeDefinition-response-UseHistoricalData"></a>
Whether historical data ingested before the Calculated Attribute was created should be included in calculations.  
Type: Boolean

## Errors
<a name="API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_UpdateCalculatedAttributeDefinition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/UpdateCalculatedAttributeDefinition) 

# UpdateDomain
<a name="API_connect-customer-profiles_UpdateDomain"></a>

Updates the properties of a domain, including creating or selecting a dead letter queue or an encryption key.

After a domain is created, the name can’t be changed.

Use this API or [CreateDomain](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_CreateDomain.html) to enable [identity resolution](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html): set `Matching` to true.

To prevent cross-service impersonation when you call this API, see [Cross-service confused deputy prevention](https://docs.aws.amazon.com/connect/latest/adminguide/cross-service-confused-deputy-prevention.html) for sample policies that you should apply. 

To add or remove tags on an existing Domain, see [TagResource](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_TagResource.html)/[UntagResource](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_UntagResource.html).

## Request Syntax
<a name="API_connect-customer-profiles_UpdateDomain_RequestSyntax"></a>

```
PUT /domains/DomainName HTTP/1.1
Content-type: application/json

{
   "DataStore": { 
      "Enabled": boolean
   },
   "DeadLetterQueueUrl": "string",
   "DefaultEncryptionKey": "string",
   "DefaultExpirationDays": number,
   "Matching": { 
      "AutoMerging": { 
         "ConflictResolution": { 
            "ConflictResolvingModel": "string",
            "SourceName": "string"
         },
         "Consolidation": { 
            "MatchingAttributesList": [ 
               [ "string" ]
            ]
         },
         "Enabled": boolean,
         "MinAllowedConfidenceScoreForMerging": number
      },
      "Enabled": boolean,
      "ExportingConfig": { 
         "S3Exporting": { 
            "S3BucketName": "string",
            "S3KeyName": "string"
         }
      },
      "JobSchedule": { 
         "DayOfTheWeek": "string",
         "Time": "string"
      }
   },
   "RuleBasedMatching": { 
      "AttributeTypesSelector": { 
         "Address": [ "string" ],
         "AttributeMatchingModel": "string",
         "EmailAddress": [ "string" ],
         "PhoneNumber": [ "string" ]
      },
      "ConflictResolution": { 
         "ConflictResolvingModel": "string",
         "SourceName": "string"
      },
      "Enabled": boolean,
      "ExportingConfig": { 
         "S3Exporting": { 
            "S3BucketName": "string",
            "S3KeyName": "string"
         }
      },
      "MatchingRules": [ 
         { 
            "Rule": [ "string" ]
         }
      ],
      "MaxAllowedRuleLevelForMatching": number,
      "MaxAllowedRuleLevelForMerging": number
   },
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_UpdateDomain_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_UpdateDomain_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomain-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_UpdateDomain_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [DataStore](#API_connect-customer-profiles_UpdateDomain_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomain-request-DataStore"></a>
Set to true to enabled data store for this domain.  
Type: [DataStoreRequest](API_connect-customer-profiles_DataStoreRequest.md) object  
Required: No

 ** [DeadLetterQueueUrl](#API_connect-customer-profiles_UpdateDomain_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomain-request-DeadLetterQueueUrl"></a>
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. If specified as an empty string, it will clear any existing value. You must set up a policy on the DeadLetterQueue for the SendMessage operation to enable Amazon Connect Customer Profiles to send messages to the DeadLetterQueue.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [DefaultEncryptionKey](#API_connect-customer-profiles_UpdateDomain_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomain-request-DefaultEncryptionKey"></a>
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. If specified as an empty string, it will clear any existing value.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [DefaultExpirationDays](#API_connect-customer-profiles_UpdateDomain_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomain-request-DefaultExpirationDays"></a>
The default number of days until the data within the domain expires.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1098.  
Required: No

 ** [Matching](#API_connect-customer-profiles_UpdateDomain_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomain-request-Matching"></a>
The process of matching duplicate profiles. If `Matching` = `true`, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.   
After the Identity Resolution Job completes, use the [GetMatches](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) API to return and review the results. Or, if you have configured `ExportingConfig` in the `MatchingRequest`, you can download the results from S3.  
Type: [MatchingRequest](API_connect-customer-profiles_MatchingRequest.md) object  
Required: No

 ** [RuleBasedMatching](#API_connect-customer-profiles_UpdateDomain_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomain-request-RuleBasedMatching"></a>
The process of matching duplicate profiles using the rule-Based matching. If `RuleBasedMatching` = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the `RuleBasedMatchingRequest`. You can use the `ListRuleBasedMatches` and `GetSimilarProfiles` API to return and review the results. Also, if you have configured `ExportingConfig` in the `RuleBasedMatchingRequest`, you can download the results from S3.  
Type: [RuleBasedMatchingRequest](API_connect-customer-profiles_RuleBasedMatchingRequest.md) object  
Required: No

 ** [Tags](#API_connect-customer-profiles_UpdateDomain_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomain-request-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_connect-customer-profiles_UpdateDomain_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": number,
   "DataStore": { 
      "Enabled": boolean,
      "Readiness": { 
         "Message": "string",
         "ProgressPercentage": number
      }
   },
   "DeadLetterQueueUrl": "string",
   "DefaultEncryptionKey": "string",
   "DefaultExpirationDays": number,
   "DomainName": "string",
   "LastUpdatedAt": number,
   "Matching": { 
      "AutoMerging": { 
         "ConflictResolution": { 
            "ConflictResolvingModel": "string",
            "SourceName": "string"
         },
         "Consolidation": { 
            "MatchingAttributesList": [ 
               [ "string" ]
            ]
         },
         "Enabled": boolean,
         "MinAllowedConfidenceScoreForMerging": number
      },
      "Enabled": boolean,
      "ExportingConfig": { 
         "S3Exporting": { 
            "S3BucketName": "string",
            "S3KeyName": "string"
         }
      },
      "JobSchedule": { 
         "DayOfTheWeek": "string",
         "Time": "string"
      }
   },
   "RuleBasedMatching": { 
      "AttributeTypesSelector": { 
         "Address": [ "string" ],
         "AttributeMatchingModel": "string",
         "EmailAddress": [ "string" ],
         "PhoneNumber": [ "string" ]
      },
      "ConflictResolution": { 
         "ConflictResolvingModel": "string",
         "SourceName": "string"
      },
      "Enabled": boolean,
      "ExportingConfig": { 
         "S3Exporting": { 
            "S3BucketName": "string",
            "S3KeyName": "string"
         }
      },
      "MatchingRules": [ 
         { 
            "Rule": [ "string" ]
         }
      ],
      "MaxAllowedRuleLevelForMatching": number,
      "MaxAllowedRuleLevelForMerging": number,
      "Status": "string"
   },
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-customer-profiles_UpdateDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreatedAt](#API_connect-customer-profiles_UpdateDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomain-response-CreatedAt"></a>
The timestamp of when the domain was created.  
Type: Timestamp

 ** [DataStore](#API_connect-customer-profiles_UpdateDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomain-response-DataStore"></a>
The data store.  
Type: [DataStoreResponse](API_connect-customer-profiles_DataStoreResponse.md) object

 ** [DeadLetterQueueUrl](#API_connect-customer-profiles_UpdateDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomain-response-DeadLetterQueueUrl"></a>
The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.

 ** [DefaultEncryptionKey](#API_connect-customer-profiles_UpdateDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomain-response-DefaultEncryptionKey"></a>
The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.

 ** [DefaultExpirationDays](#API_connect-customer-profiles_UpdateDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomain-response-DefaultExpirationDays"></a>
The default number of days until the data within the domain expires.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 1098.

 ** [DomainName](#API_connect-customer-profiles_UpdateDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomain-response-DomainName"></a>
The unique name of the domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [LastUpdatedAt](#API_connect-customer-profiles_UpdateDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomain-response-LastUpdatedAt"></a>
The timestamp of when the domain was most recently edited.  
Type: Timestamp

 ** [Matching](#API_connect-customer-profiles_UpdateDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomain-response-Matching"></a>
The process of matching duplicate profiles. If `Matching` = `true`, Amazon Connect Customer Profiles starts a weekly batch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains.   
After the Identity Resolution Job completes, use the [GetMatches](https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_GetMatches.html) API to return and review the results. Or, if you have configured `ExportingConfig` in the `MatchingRequest`, you can download the results from S3.  
Type: [MatchingResponse](API_connect-customer-profiles_MatchingResponse.md) object

 ** [RuleBasedMatching](#API_connect-customer-profiles_UpdateDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomain-response-RuleBasedMatching"></a>
The process of matching duplicate profiles using the rule-Based matching. If `RuleBasedMatching` = true, Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the `RuleBasedMatchingRequest`. You can use the `ListRuleBasedMatches` and `GetSimilarProfiles` API to return and review the results. Also, if you have configured `ExportingConfig` in the `RuleBasedMatchingRequest`, you can download the results from S3.  
Type: [RuleBasedMatchingResponse](API_connect-customer-profiles_RuleBasedMatchingResponse.md) object

 ** [Tags](#API_connect-customer-profiles_UpdateDomain_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomain-response-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_connect-customer-profiles_UpdateDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_UpdateDomain_Examples"></a>

### Example
<a name="API_connect-customer-profiles_UpdateDomain_Example_1"></a>

This example illustrates one usage of UpdateDomain.

#### Sample Request
<a name="API_connect-customer-profiles_UpdateDomain_Example_1_Request"></a>

```
PUT /v1/domains/ExampleDomainName

Content-type: application/json 
{ 
   "DeadLetterQueueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/DLQName", 
   "DefaultEncryptionKey":"arn:aws:kms:us-east-1:123456789012:key/1988472d-6b77-4bb6-ae39-efce5EXAMPLE", 
   "DefaultExpirationDays": 200
}
```

#### Sample Response
<a name="API_connect-customer-profiles_UpdateDomain_Example_1_Response"></a>

```
Content-type: application/json 
{ 
   "DeadLetterQueueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/DLQName", 
   "CreatedAt": 1579249799770, 
   "DefaultEncryptionKey":"arn:aws:kms:us-east-1:123456789012:key/1988472d-6b77-4bb6-ae39-efce5EXAMPLE", 
   "DefaultExpirationDays": 200,   
   "LastUpdatedAt":1579249799770, 
   "DomainName": "ExampleDomainName"
}
```

## See Also
<a name="API_connect-customer-profiles_UpdateDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/UpdateDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/UpdateDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/UpdateDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/UpdateDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/UpdateDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/UpdateDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/UpdateDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/UpdateDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/UpdateDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/UpdateDomain) 

# UpdateDomainLayout
<a name="API_connect-customer-profiles_UpdateDomainLayout"></a>

Updates the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

## Request Syntax
<a name="API_connect-customer-profiles_UpdateDomainLayout_RequestSyntax"></a>

```
PUT /domains/DomainName/layouts/LayoutDefinitionName HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "DisplayName": "string",
   "IsDefault": boolean,
   "Layout": "string",
   "LayoutType": "string"
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_UpdateDomainLayout_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_UpdateDomainLayout_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomainLayout-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [LayoutDefinitionName](#API_connect-customer-profiles_UpdateDomainLayout_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomainLayout-request-uri-LayoutDefinitionName"></a>
The unique name of the layout.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_UpdateDomainLayout_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_connect-customer-profiles_UpdateDomainLayout_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomainLayout-request-Description"></a>
The description of the layout  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: No

 ** [DisplayName](#API_connect-customer-profiles_UpdateDomainLayout_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomainLayout-request-DisplayName"></a>
The display name of the layout  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$`   
Required: No

 ** [IsDefault](#API_connect-customer-profiles_UpdateDomainLayout_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomainLayout-request-IsDefault"></a>
If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console.  
Type: Boolean  
Required: No

 ** [Layout](#API_connect-customer-profiles_UpdateDomainLayout_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomainLayout-request-Layout"></a>
A customizable layout that can be used to view data under a Customer Profiles domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000000.  
Required: No

 ** [LayoutType](#API_connect-customer-profiles_UpdateDomainLayout_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomainLayout-request-LayoutType"></a>
The type of layout that can be used to view data under a Customer Profiles domain.  
Type: String  
Valid Values: `PROFILE_EXPLORER`   
Required: No

## Response Syntax
<a name="API_connect-customer-profiles_UpdateDomainLayout_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": number,
   "Description": "string",
   "DisplayName": "string",
   "IsDefault": boolean,
   "LastUpdatedAt": number,
   "Layout": "string",
   "LayoutDefinitionName": "string",
   "LayoutType": "string",
   "Tags": { 
      "string" : "string" 
   },
   "Version": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_UpdateDomainLayout_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreatedAt](#API_connect-customer-profiles_UpdateDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomainLayout-response-CreatedAt"></a>
The timestamp of when the layout was created.  
Type: Timestamp

 ** [Description](#API_connect-customer-profiles_UpdateDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomainLayout-response-Description"></a>
The description of the layout  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.

 ** [DisplayName](#API_connect-customer-profiles_UpdateDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomainLayout-response-DisplayName"></a>
The display name of the layout  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-\s]*$` 

 ** [IsDefault](#API_connect-customer-profiles_UpdateDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomainLayout-response-IsDefault"></a>
If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console.  
Type: Boolean

 ** [LastUpdatedAt](#API_connect-customer-profiles_UpdateDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomainLayout-response-LastUpdatedAt"></a>
The timestamp of when the layout was most recently updated.  
Type: Timestamp

 ** [Layout](#API_connect-customer-profiles_UpdateDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomainLayout-response-Layout"></a>
A customizable layout that can be used to view data under a Customer Profiles domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2000000.

 ** [LayoutDefinitionName](#API_connect-customer-profiles_UpdateDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomainLayout-response-LayoutDefinitionName"></a>
The unique name of the layout.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [LayoutType](#API_connect-customer-profiles_UpdateDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomainLayout-response-LayoutType"></a>
The type of layout that can be used to view data under a Customer Profiles domain.  
Type: String  
Valid Values: `PROFILE_EXPLORER` 

 ** [Tags](#API_connect-customer-profiles_UpdateDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomainLayout-response-Tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

 ** [Version](#API_connect-customer-profiles_UpdateDomainLayout_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateDomainLayout-response-Version"></a>
The version used to create layout.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.

## Errors
<a name="API_connect-customer-profiles_UpdateDomainLayout_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_UpdateDomainLayout_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/UpdateDomainLayout) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/UpdateDomainLayout) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/UpdateDomainLayout) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/UpdateDomainLayout) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/UpdateDomainLayout) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/UpdateDomainLayout) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/UpdateDomainLayout) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/UpdateDomainLayout) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/UpdateDomainLayout) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/UpdateDomainLayout) 

# UpdateEventTrigger
<a name="API_connect-customer-profiles_UpdateEventTrigger"></a>

Update the properties of an Event Trigger.

## Request Syntax
<a name="API_connect-customer-profiles_UpdateEventTrigger_RequestSyntax"></a>

```
PUT /domains/DomainName/event-triggers/EventTriggerName HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "EventTriggerConditions": [ 
      { 
         "EventTriggerDimensions": [ 
            { 
               "ObjectAttributes": [ 
                  { 
                     "ComparisonOperator": "string",
                     "FieldName": "string",
                     "Source": "string",
                     "Values": [ "string" ]
                  }
               ]
            }
         ],
         "LogicalOperator": "string"
      }
   ],
   "EventTriggerLimits": { 
      "EventExpiration": number,
      "Periods": [ 
         { 
            "MaxInvocationsPerProfile": number,
            "Unit": "string",
            "Unlimited": boolean,
            "Value": number
         }
      ]
   },
   "ObjectTypeName": "string",
   "SegmentFilter": "string"
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_UpdateEventTrigger_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_UpdateEventTrigger_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateEventTrigger-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [EventTriggerName](#API_connect-customer-profiles_UpdateEventTrigger_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateEventTrigger-request-uri-EventTriggerName"></a>
The unique name of the event trigger.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_UpdateEventTrigger_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_connect-customer-profiles_UpdateEventTrigger_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateEventTrigger-request-Description"></a>
The description of the event trigger.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: No

 ** [EventTriggerConditions](#API_connect-customer-profiles_UpdateEventTrigger_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateEventTrigger-request-EventTriggerConditions"></a>
A list of conditions that determine when an event should trigger the destination.  
Type: Array of [EventTriggerCondition](API_connect-customer-profiles_EventTriggerCondition.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Required: No

 ** [EventTriggerLimits](#API_connect-customer-profiles_UpdateEventTrigger_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateEventTrigger-request-EventTriggerLimits"></a>
Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.  
Type: [EventTriggerLimits](API_connect-customer-profiles_EventTriggerLimits.md) object  
Required: No

 ** [ObjectTypeName](#API_connect-customer-profiles_UpdateEventTrigger_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateEventTrigger-request-ObjectTypeName"></a>
The unique name of the object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$`   
Required: No

 ** [SegmentFilter](#API_connect-customer-profiles_UpdateEventTrigger_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateEventTrigger-request-SegmentFilter"></a>
The destination is triggered only for profiles that meet the criteria of a segment definition.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: No

## Response Syntax
<a name="API_connect-customer-profiles_UpdateEventTrigger_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": number,
   "Description": "string",
   "EventTriggerConditions": [ 
      { 
         "EventTriggerDimensions": [ 
            { 
               "ObjectAttributes": [ 
                  { 
                     "ComparisonOperator": "string",
                     "FieldName": "string",
                     "Source": "string",
                     "Values": [ "string" ]
                  }
               ]
            }
         ],
         "LogicalOperator": "string"
      }
   ],
   "EventTriggerLimits": { 
      "EventExpiration": number,
      "Periods": [ 
         { 
            "MaxInvocationsPerProfile": number,
            "Unit": "string",
            "Unlimited": boolean,
            "Value": number
         }
      ]
   },
   "EventTriggerName": "string",
   "LastUpdatedAt": number,
   "ObjectTypeName": "string",
   "SegmentFilter": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_connect-customer-profiles_UpdateEventTrigger_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [CreatedAt](#API_connect-customer-profiles_UpdateEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateEventTrigger-response-CreatedAt"></a>
The timestamp of when the event trigger was created.  
Type: Timestamp

 ** [Description](#API_connect-customer-profiles_UpdateEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateEventTrigger-response-Description"></a>
The description of the event trigger.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.

 ** [EventTriggerConditions](#API_connect-customer-profiles_UpdateEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateEventTrigger-response-EventTriggerConditions"></a>
A list of conditions that determine when an event should trigger the destination.  
Type: Array of [EventTriggerCondition](API_connect-customer-profiles_EventTriggerCondition.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 5 items.

 ** [EventTriggerLimits](#API_connect-customer-profiles_UpdateEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateEventTrigger-response-EventTriggerLimits"></a>
Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.  
Type: [EventTriggerLimits](API_connect-customer-profiles_EventTriggerLimits.md) object

 ** [EventTriggerName](#API_connect-customer-profiles_UpdateEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateEventTrigger-response-EventTriggerName"></a>
The unique name of the event trigger.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [LastUpdatedAt](#API_connect-customer-profiles_UpdateEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateEventTrigger-response-LastUpdatedAt"></a>
The timestamp of when the event trigger was most recently updated.  
Type: Timestamp

 ** [ObjectTypeName](#API_connect-customer-profiles_UpdateEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateEventTrigger-response-ObjectTypeName"></a>
The unique name of the object type.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z_][a-zA-Z_0-9-]*$` 

 ** [SegmentFilter](#API_connect-customer-profiles_UpdateEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateEventTrigger-response-SegmentFilter"></a>
The destination is triggered only for profiles that meet the criteria of a segment definition.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

 ** [Tags](#API_connect-customer-profiles_UpdateEventTrigger_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateEventTrigger-response-Tags"></a>
An array of key-value pairs to apply to this resource.  
Type: String to string map  
Map Entries: Maximum number of 50 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^(?!aws:)[a-zA-Z+-=._:/]+$`   
Value Length Constraints: Maximum length of 256.

## Errors
<a name="API_connect-customer-profiles_UpdateEventTrigger_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_UpdateEventTrigger_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/UpdateEventTrigger) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/UpdateEventTrigger) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/UpdateEventTrigger) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/UpdateEventTrigger) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/UpdateEventTrigger) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/UpdateEventTrigger) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/UpdateEventTrigger) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/UpdateEventTrigger) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/UpdateEventTrigger) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/UpdateEventTrigger) 

# UpdateProfile
<a name="API_connect-customer-profiles_UpdateProfile"></a>

Updates the properties of a profile. The ProfileId is required for updating a customer profile.

When calling the UpdateProfile API, specifying an empty string value means that any existing value will be removed. Not specifying a string value means that any value already there will be kept.

## Request Syntax
<a name="API_connect-customer-profiles_UpdateProfile_RequestSyntax"></a>

```
PUT /domains/DomainName/profiles HTTP/1.1
Content-type: application/json

{
   "AccountNumber": "string",
   "AdditionalInformation": "string",
   "Address": { 
      "Address1": "string",
      "Address2": "string",
      "Address3": "string",
      "Address4": "string",
      "City": "string",
      "Country": "string",
      "County": "string",
      "PostalCode": "string",
      "Province": "string",
      "State": "string"
   },
   "Attributes": { 
      "string" : "string" 
   },
   "BillingAddress": { 
      "Address1": "string",
      "Address2": "string",
      "Address3": "string",
      "Address4": "string",
      "City": "string",
      "Country": "string",
      "County": "string",
      "PostalCode": "string",
      "Province": "string",
      "State": "string"
   },
   "BirthDate": "string",
   "BusinessEmailAddress": "string",
   "BusinessName": "string",
   "BusinessPhoneNumber": "string",
   "EmailAddress": "string",
   "EngagementPreferences": { 
      "Email": [ 
         { 
            "ContactType": "string",
            "KeyName": "string",
            "KeyValue": "string",
            "ProfileId": "string"
         }
      ],
      "Phone": [ 
         { 
            "ContactType": "string",
            "KeyName": "string",
            "KeyValue": "string",
            "ProfileId": "string"
         }
      ]
   },
   "FirstName": "string",
   "Gender": "string",
   "GenderString": "string",
   "HomePhoneNumber": "string",
   "LastName": "string",
   "MailingAddress": { 
      "Address1": "string",
      "Address2": "string",
      "Address3": "string",
      "Address4": "string",
      "City": "string",
      "Country": "string",
      "County": "string",
      "PostalCode": "string",
      "Province": "string",
      "State": "string"
   },
   "MiddleName": "string",
   "MobilePhoneNumber": "string",
   "PartyType": "string",
   "PartyTypeString": "string",
   "PersonalEmailAddress": "string",
   "PhoneNumber": "string",
   "ProfileId": "string",
   "ProfileType": "string",
   "ShippingAddress": { 
      "Address1": "string",
      "Address2": "string",
      "Address3": "string",
      "Address4": "string",
      "City": "string",
      "Country": "string",
      "County": "string",
      "PostalCode": "string",
      "Province": "string",
      "State": "string"
   }
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_UpdateProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_UpdateProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [AccountNumber](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-AccountNumber"></a>
An account number that you have assigned to the customer.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [AdditionalInformation](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-AdditionalInformation"></a>
Any additional information relevant to the customer’s profile.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1000.  
Required: No

 ** [Address](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-Address"></a>
A generic address associated with the customer that is not mailing, shipping, or billing.  
Type: [UpdateAddress](API_connect-customer-profiles_UpdateAddress.md) object  
Required: No

 ** [Attributes](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-Attributes"></a>
A key value pair of attributes of a customer profile.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 255.  
Value Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [BillingAddress](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-BillingAddress"></a>
The customer’s billing address.  
Type: [UpdateAddress](API_connect-customer-profiles_UpdateAddress.md) object  
Required: No

 ** [BirthDate](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-BirthDate"></a>
The customer’s birth date.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [BusinessEmailAddress](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-BusinessEmailAddress"></a>
The customer’s business email address.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [BusinessName](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-BusinessName"></a>
The name of the customer’s business.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [BusinessPhoneNumber](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-BusinessPhoneNumber"></a>
The customer’s business phone number.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [EmailAddress](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-EmailAddress"></a>
The customer’s email address, which has not been specified as a personal or business address.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [EngagementPreferences](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-EngagementPreferences"></a>
Object that defines users preferred methods of engagement.  
Type: [EngagementPreferences](API_connect-customer-profiles_EngagementPreferences.md) object  
Required: No

 ** [FirstName](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-FirstName"></a>
The customer’s first name.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [Gender](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-Gender"></a>
 *This parameter has been deprecated.*   
The gender with which the customer identifies.   
Type: String  
Valid Values: `MALE | FEMALE | UNSPECIFIED`   
Required: No

 ** [GenderString](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-GenderString"></a>
An alternative to `Gender` which accepts any string as input.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [HomePhoneNumber](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-HomePhoneNumber"></a>
The customer’s home phone number.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [LastName](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-LastName"></a>
The customer’s last name.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [MailingAddress](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-MailingAddress"></a>
The customer’s mailing address.  
Type: [UpdateAddress](API_connect-customer-profiles_UpdateAddress.md) object  
Required: No

 ** [MiddleName](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-MiddleName"></a>
The customer’s middle name.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [MobilePhoneNumber](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-MobilePhoneNumber"></a>
The customer’s mobile phone number.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [PartyType](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-PartyType"></a>
 *This parameter has been deprecated.*   
The type of profile used to describe the customer.  
Type: String  
Valid Values: `INDIVIDUAL | BUSINESS | OTHER`   
Required: No

 ** [PartyTypeString](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-PartyTypeString"></a>
An alternative to `PartyType` which accepts any string as input.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [PersonalEmailAddress](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-PersonalEmailAddress"></a>
The customer’s personal email address.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [PhoneNumber](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-PhoneNumber"></a>
The customer’s phone number, which has not been specified as a mobile, home, or business number.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** [ProfileId](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-ProfileId"></a>
The unique identifier of a customer profile.  
Type: String  
Pattern: `[a-f0-9]{32}`   
Required: Yes

 ** [ProfileType](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-ProfileType"></a>
Determines the type of the profile.  
Type: String  
Valid Values: `ACCOUNT_PROFILE | PROFILE`   
Required: No

 ** [ShippingAddress](#API_connect-customer-profiles_UpdateProfile_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-request-ShippingAddress"></a>
The customer’s shipping address.  
Type: [UpdateAddress](API_connect-customer-profiles_UpdateAddress.md) object  
Required: No

## Response Syntax
<a name="API_connect-customer-profiles_UpdateProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ProfileId": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_UpdateProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ProfileId](#API_connect-customer-profiles_UpdateProfile_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateProfile-response-ProfileId"></a>
The unique identifier of a customer profile.  
Type: String  
Pattern: `[a-f0-9]{32}` 

## Errors
<a name="API_connect-customer-profiles_UpdateProfile_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## Examples
<a name="API_connect-customer-profiles_UpdateProfile_Examples"></a>

### Example
<a name="API_connect-customer-profiles_UpdateProfile_Example_1"></a>

This example illustrates one usage of UpdateProfile.

#### Sample Request
<a name="API_connect-customer-profiles_UpdateProfile_Example_1_Request"></a>

```
PUT /domains/ExampleDomainName/profiles HTTP/1.1

Content-type: application/json
{
   "ProfileId" : "3991a7d95sd248bba82546b2dEXAMPLE",
   "AccountNumber": "ACCT12344",
   "Address": { 
      "Address1": "444 B St",
      "Address2": "Apt 8",
      "Address3": "",
      "Address4": "",
      "City": "Seattle",
      "Country": "USA",
      "County": "King",
      "PostalCode": "98011",
      "Province": "",
      "State": "WA"
   },
   "Attributes": { 
      "SSN" : "123-44-3433",
      "LoyaltyPoints" : "3000" 
   },
   "BillingAddress": { 
      "Address1": "789 Sample St",
      "Address2": "Apt 1",
      "Address3": "",
      "Address4": "",
      "City": "Seattle",
      "Country": "USA",
      "County": "King",
      "PostalCode": "98011",
      "Province": "",
      "State": "WA"
   },
   "BirthDate": "07/12/1980",
   "BusinessEmailAddress": "example@amazon.com",
   "BusinessName": "My Awesome Company",
   "BusinessPhoneNumber": "555-334-3389",
   "EmailAddress": "example@gmail.com",
   "FirstName": "John",
   "Gender": "MALE",
   "HomePhoneNumber": "555-334-3344",
   "LastName": "Doe",
   "MailingAddress": { 
      "Address1": "234 Home St",
      "Address2": "Apt 5",
      "Address3": "",
      "Address4": "",
      "City": "Seattle",
      "Country": "USA",
      "County": "King",
      "PostalCode": "98011",
      "Province": "",
      "State": "WA"
   },
   "AdditionalInformation": "High Profile Customer",
   "MiddleName": "",
   "MobilePhoneNumber": "555-334-7777",
   "PartyType": "INDIVIDUAL",
   "PersonalEmailAddress": "email1@gmail.com",
   "PhoneNumber": "",
   "ShippingAddress": { 
      "Address1": "555 A St",
      "Address2": "Suite 100",
      "Address3": "",
      "Address4": "",
      "City": "Seattle",
      "Country": "USA",
      "County": "King",
      "PostalCode": "98011",
      "Province": "",
      "State": "WA"
   }
}
```

#### Sample Response
<a name="API_connect-customer-profiles_UpdateProfile_Example_1_Response"></a>

```
Content-type: application/json
{
   "ProfileId" : "3991a7d95sd248bba82546b2dEXAMPLE"
}
```

## See Also
<a name="API_connect-customer-profiles_UpdateProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/UpdateProfile) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/UpdateProfile) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/UpdateProfile) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/UpdateProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/UpdateProfile) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/UpdateProfile) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/UpdateProfile) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/UpdateProfile) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/UpdateProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/UpdateProfile) 

# UpdateRecommender
<a name="API_connect-customer-profiles_UpdateRecommender"></a>

Updates the properties of an existing recommender, allowing you to modify its configuration and description.

## Request Syntax
<a name="API_connect-customer-profiles_UpdateRecommender_RequestSyntax"></a>

```
PATCH /domains/DomainName/recommenders/RecommenderName HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "RecommenderConfig": { 
      "EventsConfig": { 
         "EventParametersList": [ 
            { 
               "EventType": "string",
               "EventValueThreshold": number
            }
         ]
      },
      "TrainingFrequency": number
   }
}
```

## URI Request Parameters
<a name="API_connect-customer-profiles_UpdateRecommender_RequestParameters"></a>

The request uses the following URI parameters.

 ** [DomainName](#API_connect-customer-profiles_UpdateRecommender_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateRecommender-request-uri-DomainName"></a>
The unique name of the domain.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

 ** [RecommenderName](#API_connect-customer-profiles_UpdateRecommender_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateRecommender-request-uri-RecommenderName"></a>
The name of the recommender to update.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$`   
Required: Yes

## Request Body
<a name="API_connect-customer-profiles_UpdateRecommender_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [Description](#API_connect-customer-profiles_UpdateRecommender_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateRecommender-request-Description"></a>
The new description to assign to the recommender.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1000.  
Required: No

 ** [RecommenderConfig](#API_connect-customer-profiles_UpdateRecommender_RequestSyntax) **   <a name="connect-connect-customer-profiles_UpdateRecommender-request-RecommenderConfig"></a>
The new configuration settings to apply to the recommender, including updated parameters and settings that define its behavior.  
Type: [RecommenderConfig](API_connect-customer-profiles_RecommenderConfig.md) object  
Required: No

## Response Syntax
<a name="API_connect-customer-profiles_UpdateRecommender_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "RecommenderName": "string"
}
```

## Response Elements
<a name="API_connect-customer-profiles_UpdateRecommender_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [RecommenderName](#API_connect-customer-profiles_UpdateRecommender_ResponseSyntax) **   <a name="connect-connect-customer-profiles_UpdateRecommender-response-RecommenderName"></a>
The name of the recommender that was updated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9_-]+$` 

## Errors
<a name="API_connect-customer-profiles_UpdateRecommender_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** BadRequestException **   
The input you provided is invalid.  
HTTP Status Code: 400

 ** InternalServerException **   
An internal service error occurred.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The requested resource does not exist, or access was denied.  
HTTP Status Code: 404

 ** ThrottlingException **   
You exceeded the maximum number of requests.  
HTTP Status Code: 429

## See Also
<a name="API_connect-customer-profiles_UpdateRecommender_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/customer-profiles-2020-08-15/UpdateRecommender) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/customer-profiles-2020-08-15/UpdateRecommender) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/customer-profiles-2020-08-15/UpdateRecommender) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/customer-profiles-2020-08-15/UpdateRecommender) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/customer-profiles-2020-08-15/UpdateRecommender) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/customer-profiles-2020-08-15/UpdateRecommender) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/customer-profiles-2020-08-15/UpdateRecommender) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/customer-profiles-2020-08-15/UpdateRecommender) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/customer-profiles-2020-08-15/UpdateRecommender) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/customer-profiles-2020-08-15/UpdateRecommender) 

# Amazon Q Connect
<a name="API_Operations_Amazon_Q_Connect"></a>

The following actions are supported by Amazon Q Connect:
+  [ActivateMessageTemplate](API_amazon-q-connect_ActivateMessageTemplate.md) 
+  [CreateAIAgent](API_amazon-q-connect_CreateAIAgent.md) 
+  [CreateAIAgentVersion](API_amazon-q-connect_CreateAIAgentVersion.md) 
+  [CreateAIGuardrail](API_amazon-q-connect_CreateAIGuardrail.md) 
+  [CreateAIGuardrailVersion](API_amazon-q-connect_CreateAIGuardrailVersion.md) 
+  [CreateAIPrompt](API_amazon-q-connect_CreateAIPrompt.md) 
+  [CreateAIPromptVersion](API_amazon-q-connect_CreateAIPromptVersion.md) 
+  [CreateAssistant](API_amazon-q-connect_CreateAssistant.md) 
+  [CreateAssistantAssociation](API_amazon-q-connect_CreateAssistantAssociation.md) 
+  [CreateContent](API_amazon-q-connect_CreateContent.md) 
+  [CreateContentAssociation](API_amazon-q-connect_CreateContentAssociation.md) 
+  [CreateKnowledgeBase](API_amazon-q-connect_CreateKnowledgeBase.md) 
+  [CreateMessageTemplate](API_amazon-q-connect_CreateMessageTemplate.md) 
+  [CreateMessageTemplateAttachment](API_amazon-q-connect_CreateMessageTemplateAttachment.md) 
+  [CreateMessageTemplateVersion](API_amazon-q-connect_CreateMessageTemplateVersion.md) 
+  [CreateQuickResponse](API_amazon-q-connect_CreateQuickResponse.md) 
+  [CreateSession](API_amazon-q-connect_CreateSession.md) 
+  [DeactivateMessageTemplate](API_amazon-q-connect_DeactivateMessageTemplate.md) 
+  [DeleteAIAgent](API_amazon-q-connect_DeleteAIAgent.md) 
+  [DeleteAIAgentVersion](API_amazon-q-connect_DeleteAIAgentVersion.md) 
+  [DeleteAIGuardrail](API_amazon-q-connect_DeleteAIGuardrail.md) 
+  [DeleteAIGuardrailVersion](API_amazon-q-connect_DeleteAIGuardrailVersion.md) 
+  [DeleteAIPrompt](API_amazon-q-connect_DeleteAIPrompt.md) 
+  [DeleteAIPromptVersion](API_amazon-q-connect_DeleteAIPromptVersion.md) 
+  [DeleteAssistant](API_amazon-q-connect_DeleteAssistant.md) 
+  [DeleteAssistantAssociation](API_amazon-q-connect_DeleteAssistantAssociation.md) 
+  [DeleteContent](API_amazon-q-connect_DeleteContent.md) 
+  [DeleteContentAssociation](API_amazon-q-connect_DeleteContentAssociation.md) 
+  [DeleteImportJob](API_amazon-q-connect_DeleteImportJob.md) 
+  [DeleteKnowledgeBase](API_amazon-q-connect_DeleteKnowledgeBase.md) 
+  [DeleteMessageTemplate](API_amazon-q-connect_DeleteMessageTemplate.md) 
+  [DeleteMessageTemplateAttachment](API_amazon-q-connect_DeleteMessageTemplateAttachment.md) 
+  [DeleteQuickResponse](API_amazon-q-connect_DeleteQuickResponse.md) 
+  [GetAIAgent](API_amazon-q-connect_GetAIAgent.md) 
+  [GetAIGuardrail](API_amazon-q-connect_GetAIGuardrail.md) 
+  [GetAIPrompt](API_amazon-q-connect_GetAIPrompt.md) 
+  [GetAssistant](API_amazon-q-connect_GetAssistant.md) 
+  [GetAssistantAssociation](API_amazon-q-connect_GetAssistantAssociation.md) 
+  [GetContent](API_amazon-q-connect_GetContent.md) 
+  [GetContentAssociation](API_amazon-q-connect_GetContentAssociation.md) 
+  [GetContentSummary](API_amazon-q-connect_GetContentSummary.md) 
+  [GetImportJob](API_amazon-q-connect_GetImportJob.md) 
+  [GetKnowledgeBase](API_amazon-q-connect_GetKnowledgeBase.md) 
+  [GetMessageTemplate](API_amazon-q-connect_GetMessageTemplate.md) 
+  [GetNextMessage](API_amazon-q-connect_GetNextMessage.md) 
+  [GetQuickResponse](API_amazon-q-connect_GetQuickResponse.md) 
+  [GetRecommendations](API_amazon-q-connect_GetRecommendations.md) 
+  [GetSession](API_amazon-q-connect_GetSession.md) 
+  [ListAIAgents](API_amazon-q-connect_ListAIAgents.md) 
+  [ListAIAgentVersions](API_amazon-q-connect_ListAIAgentVersions.md) 
+  [ListAIGuardrails](API_amazon-q-connect_ListAIGuardrails.md) 
+  [ListAIGuardrailVersions](API_amazon-q-connect_ListAIGuardrailVersions.md) 
+  [ListAIPrompts](API_amazon-q-connect_ListAIPrompts.md) 
+  [ListAIPromptVersions](API_amazon-q-connect_ListAIPromptVersions.md) 
+  [ListAssistantAssociations](API_amazon-q-connect_ListAssistantAssociations.md) 
+  [ListAssistants](API_amazon-q-connect_ListAssistants.md) 
+  [ListContentAssociations](API_amazon-q-connect_ListContentAssociations.md) 
+  [ListContents](API_amazon-q-connect_ListContents.md) 
+  [ListImportJobs](API_amazon-q-connect_ListImportJobs.md) 
+  [ListKnowledgeBases](API_amazon-q-connect_ListKnowledgeBases.md) 
+  [ListMessages](API_amazon-q-connect_ListMessages.md) 
+  [ListMessageTemplates](API_amazon-q-connect_ListMessageTemplates.md) 
+  [ListMessageTemplateVersions](API_amazon-q-connect_ListMessageTemplateVersions.md) 
+  [ListQuickResponses](API_amazon-q-connect_ListQuickResponses.md) 
+  [ListSpans](API_amazon-q-connect_ListSpans.md) 
+  [ListTagsForResource](API_amazon-q-connect_ListTagsForResource.md) 
+  [NotifyRecommendationsReceived](API_amazon-q-connect_NotifyRecommendationsReceived.md) 
+  [PutFeedback](API_amazon-q-connect_PutFeedback.md) 
+  [QueryAssistant](API_amazon-q-connect_QueryAssistant.md) 
+  [RemoveAssistantAIAgent](API_amazon-q-connect_RemoveAssistantAIAgent.md) 
+  [RemoveKnowledgeBaseTemplateUri](API_amazon-q-connect_RemoveKnowledgeBaseTemplateUri.md) 
+  [RenderMessageTemplate](API_amazon-q-connect_RenderMessageTemplate.md) 
+  [Retrieve](API_amazon-q-connect_Retrieve.md) 
+  [SearchContent](API_amazon-q-connect_SearchContent.md) 
+  [SearchMessageTemplates](API_amazon-q-connect_SearchMessageTemplates.md) 
+  [SearchQuickResponses](API_amazon-q-connect_SearchQuickResponses.md) 
+  [SearchSessions](API_amazon-q-connect_SearchSessions.md) 
+  [SendMessage](API_amazon-q-connect_SendMessage.md) 
+  [StartContentUpload](API_amazon-q-connect_StartContentUpload.md) 
+  [StartImportJob](API_amazon-q-connect_StartImportJob.md) 
+  [TagResource](API_amazon-q-connect_TagResource.md) 
+  [UntagResource](API_amazon-q-connect_UntagResource.md) 
+  [UpdateAIAgent](API_amazon-q-connect_UpdateAIAgent.md) 
+  [UpdateAIGuardrail](API_amazon-q-connect_UpdateAIGuardrail.md) 
+  [UpdateAIPrompt](API_amazon-q-connect_UpdateAIPrompt.md) 
+  [UpdateAssistantAIAgent](API_amazon-q-connect_UpdateAssistantAIAgent.md) 
+  [UpdateContent](API_amazon-q-connect_UpdateContent.md) 
+  [UpdateKnowledgeBaseTemplateUri](API_amazon-q-connect_UpdateKnowledgeBaseTemplateUri.md) 
+  [UpdateMessageTemplate](API_amazon-q-connect_UpdateMessageTemplate.md) 
+  [UpdateMessageTemplateMetadata](API_amazon-q-connect_UpdateMessageTemplateMetadata.md) 
+  [UpdateQuickResponse](API_amazon-q-connect_UpdateQuickResponse.md) 
+  [UpdateSession](API_amazon-q-connect_UpdateSession.md) 
+  [UpdateSessionData](API_amazon-q-connect_UpdateSessionData.md) 

# ActivateMessageTemplate
<a name="API_amazon-q-connect_ActivateMessageTemplate"></a>

Activates a specific version of the Amazon Q in Connect message template. After the version is activated, the previous active version will be deactivated automatically. You can use the `$ACTIVE_VERSION` qualifier later to reference the version that is in active status.

## Request Syntax
<a name="API_amazon-q-connect_ActivateMessageTemplate_RequestSyntax"></a>

```
POST /knowledgeBases/knowledgeBaseId/messageTemplates/messageTemplateId/activate HTTP/1.1
Content-type: application/json

{
   "versionNumber": number
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_ActivateMessageTemplate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_ActivateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_ActivateMessageTemplate-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [messageTemplateId](#API_amazon-q-connect_ActivateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_ActivateMessageTemplate-request-uri-messageTemplateId"></a>
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_ActivateMessageTemplate_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [versionNumber](#API_amazon-q-connect_ActivateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_ActivateMessageTemplate-request-versionNumber"></a>
The version number of the message template version to activate.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: Yes

## Response Syntax
<a name="API_amazon-q-connect_ActivateMessageTemplate_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "messageTemplateArn": "string",
   "messageTemplateId": "string",
   "versionNumber": number
}
```

## Response Elements
<a name="API_amazon-q-connect_ActivateMessageTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [messageTemplateArn](#API_amazon-q-connect_ActivateMessageTemplate_ResponseSyntax) **   <a name="connect-amazon-q-connect_ActivateMessageTemplate-response-messageTemplateArn"></a>
The Amazon Resource Name (ARN) of the message template.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}` 

 ** [messageTemplateId](#API_amazon-q-connect_ActivateMessageTemplate_ResponseSyntax) **   <a name="connect-amazon-q-connect_ActivateMessageTemplate-response-messageTemplateId"></a>
The identifier of the message template.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [versionNumber](#API_amazon-q-connect_ActivateMessageTemplate_ResponseSyntax) **   <a name="connect-amazon-q-connect_ActivateMessageTemplate-response-versionNumber"></a>
The version number of the message template version that is activated.  
Type: Long  
Valid Range: Minimum value of 1.

## Errors
<a name="API_amazon-q-connect_ActivateMessageTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_ActivateMessageTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/ActivateMessageTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/ActivateMessageTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ActivateMessageTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/ActivateMessageTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ActivateMessageTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/ActivateMessageTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/ActivateMessageTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/ActivateMessageTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/ActivateMessageTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ActivateMessageTemplate) 

# CreateAIAgent
<a name="API_amazon-q-connect_CreateAIAgent"></a>

Creates an Amazon Q in Connect AI Agent.

## Request Syntax
<a name="API_amazon-q-connect_CreateAIAgent_RequestSyntax"></a>

```
POST /assistants/assistantId/aiagents HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "configuration": { ... },
   "description": "string",
   "name": "string",
   "tags": { 
      "string" : "string" 
   },
   "type": "string",
   "visibilityStatus": "string"
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_CreateAIAgent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_CreateAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIAgent-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_CreateAIAgent_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_amazon-q-connect_CreateAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIAgent-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)..  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [configuration](#API_amazon-q-connect_CreateAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIAgent-request-configuration"></a>
The configuration of the AI Agent.  
Type: [AIAgentConfiguration](API_amazon-q-connect_AIAgentConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [description](#API_amazon-q-connect_CreateAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIAgent-request-description"></a>
The description of the AI Agent.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** [name](#API_amazon-q-connect_CreateAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIAgent-request-name"></a>
The name of the AI Agent.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** [tags](#API_amazon-q-connect_CreateAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIAgent-request-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [type](#API_amazon-q-connect_CreateAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIAgent-request-type"></a>
The type of the AI Agent.  
Type: String  
Valid Values: `MANUAL_SEARCH | ANSWER_RECOMMENDATION | SELF_SERVICE | EMAIL_RESPONSE | EMAIL_OVERVIEW | EMAIL_GENERATIVE_ANSWER | ORCHESTRATION | NOTE_TAKING | CASE_SUMMARIZATION`   
Required: Yes

 ** [visibilityStatus](#API_amazon-q-connect_CreateAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIAgent-request-visibilityStatus"></a>
The visibility status of the AI Agent.  
Type: String  
Valid Values: `SAVED | PUBLISHED`   
Required: Yes

## Response Syntax
<a name="API_amazon-q-connect_CreateAIAgent_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "aiAgent": { 
      "aiAgentArn": "string",
      "aiAgentId": "string",
      "assistantArn": "string",
      "assistantId": "string",
      "configuration": { ... },
      "description": "string",
      "modifiedTime": number,
      "name": "string",
      "origin": "string",
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "type": "string",
      "visibilityStatus": "string"
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_CreateAIAgent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [aiAgent](#API_amazon-q-connect_CreateAIAgent_ResponseSyntax) **   <a name="connect-amazon-q-connect_CreateAIAgent-response-aiAgent"></a>
The data of the created AI Agent.  
Type: [AIAgentData](API_amazon-q-connect_AIAgentData.md) object

## Errors
<a name="API_amazon-q-connect_CreateAIAgent_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.  
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_CreateAIAgent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/CreateAIAgent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/CreateAIAgent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/CreateAIAgent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/CreateAIAgent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/CreateAIAgent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/CreateAIAgent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/CreateAIAgent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/CreateAIAgent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/CreateAIAgent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/CreateAIAgent) 

# CreateAIAgentVersion
<a name="API_amazon-q-connect_CreateAIAgentVersion"></a>

Creates and Amazon Q in Connect AI Agent version.

## Request Syntax
<a name="API_amazon-q-connect_CreateAIAgentVersion_RequestSyntax"></a>

```
POST /assistants/assistantId/aiagents/aiAgentId/versions HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "modifiedTime": number
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_CreateAIAgentVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aiAgentId](#API_amazon-q-connect_CreateAIAgentVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIAgentVersion-request-uri-aiAgentId"></a>
The identifier of the Amazon Q in Connect AI Agent.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** [assistantId](#API_amazon-q-connect_CreateAIAgentVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIAgentVersion-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_CreateAIAgentVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_amazon-q-connect_CreateAIAgentVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIAgentVersion-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)..  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [modifiedTime](#API_amazon-q-connect_CreateAIAgentVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIAgentVersion-request-modifiedTime"></a>
The modification time of the AI Agent should be tracked for version creation. This field should be specified to avoid version creation when simultaneous update to the underlying AI Agent are possible. The value should be the modifiedTime returned from the request to create or update an AI Agent so that version creation can fail if an update to the AI Agent post the specified modification time has been made.  
Type: Timestamp  
Required: No

## Response Syntax
<a name="API_amazon-q-connect_CreateAIAgentVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "aiAgent": { 
      "aiAgentArn": "string",
      "aiAgentId": "string",
      "assistantArn": "string",
      "assistantId": "string",
      "configuration": { ... },
      "description": "string",
      "modifiedTime": number,
      "name": "string",
      "origin": "string",
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "type": "string",
      "visibilityStatus": "string"
   },
   "versionNumber": number
}
```

## Response Elements
<a name="API_amazon-q-connect_CreateAIAgentVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [aiAgent](#API_amazon-q-connect_CreateAIAgentVersion_ResponseSyntax) **   <a name="connect-amazon-q-connect_CreateAIAgentVersion-response-aiAgent"></a>
The data of the AI Agent version.  
Type: [AIAgentData](API_amazon-q-connect_AIAgentData.md) object

 ** [versionNumber](#API_amazon-q-connect_CreateAIAgentVersion_ResponseSyntax) **   <a name="connect-amazon-q-connect_CreateAIAgentVersion-response-versionNumber"></a>
The version number of the AI Agent version.  
Type: Long  
Valid Range: Minimum value of 1.

## Errors
<a name="API_amazon-q-connect_CreateAIAgentVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.  
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_CreateAIAgentVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/CreateAIAgentVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/CreateAIAgentVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/CreateAIAgentVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/CreateAIAgentVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/CreateAIAgentVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/CreateAIAgentVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/CreateAIAgentVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/CreateAIAgentVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/CreateAIAgentVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/CreateAIAgentVersion) 

# CreateAIGuardrail
<a name="API_amazon-q-connect_CreateAIGuardrail"></a>

Creates an Amazon Q in Connect AI Guardrail.

## Request Syntax
<a name="API_amazon-q-connect_CreateAIGuardrail_RequestSyntax"></a>

```
POST /assistants/assistantId/aiguardrails HTTP/1.1
Content-type: application/json

{
   "blockedInputMessaging": "string",
   "blockedOutputsMessaging": "string",
   "clientToken": "string",
   "contentPolicyConfig": { 
      "filtersConfig": [ 
         { 
            "inputStrength": "string",
            "outputStrength": "string",
            "type": "string"
         }
      ]
   },
   "contextualGroundingPolicyConfig": { 
      "filtersConfig": [ 
         { 
            "threshold": number,
            "type": "string"
         }
      ]
   },
   "description": "string",
   "name": "string",
   "sensitiveInformationPolicyConfig": { 
      "piiEntitiesConfig": [ 
         { 
            "action": "string",
            "type": "string"
         }
      ],
      "regexesConfig": [ 
         { 
            "action": "string",
            "description": "string",
            "name": "string",
            "pattern": "string"
         }
      ]
   },
   "tags": { 
      "string" : "string" 
   },
   "topicPolicyConfig": { 
      "topicsConfig": [ 
         { 
            "definition": "string",
            "examples": [ "string" ],
            "name": "string",
            "type": "string"
         }
      ]
   },
   "visibilityStatus": "string",
   "wordPolicyConfig": { 
      "managedWordListsConfig": [ 
         { 
            "type": "string"
         }
      ],
      "wordsConfig": [ 
         { 
            "text": "string"
         }
      ]
   }
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_CreateAIGuardrail_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_CreateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIGuardrail-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_CreateAIGuardrail_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [blockedInputMessaging](#API_amazon-q-connect_CreateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIGuardrail-request-blockedInputMessaging"></a>
The message to return when the AI Guardrail blocks a prompt.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [blockedOutputsMessaging](#API_amazon-q-connect_CreateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIGuardrail-request-blockedOutputsMessaging"></a>
The message to return when the AI Guardrail blocks a model response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [clientToken](#API_amazon-q-connect_CreateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIGuardrail-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)..  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [contentPolicyConfig](#API_amazon-q-connect_CreateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIGuardrail-request-contentPolicyConfig"></a>
The content filter policies to configure for the AI Guardrail.  
Type: [AIGuardrailContentPolicyConfig](API_amazon-q-connect_AIGuardrailContentPolicyConfig.md) object  
Required: No

 ** [contextualGroundingPolicyConfig](#API_amazon-q-connect_CreateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIGuardrail-request-contextualGroundingPolicyConfig"></a>
The contextual grounding policy configuration used to create an AI Guardrail.  
Type: [AIGuardrailContextualGroundingPolicyConfig](API_amazon-q-connect_AIGuardrailContextualGroundingPolicyConfig.md) object  
Required: No

 ** [description](#API_amazon-q-connect_CreateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIGuardrail-request-description"></a>
A description of the AI Guardrail.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: No

 ** [name](#API_amazon-q-connect_CreateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIGuardrail-request-name"></a>
The name of the AI Guardrail.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** [sensitiveInformationPolicyConfig](#API_amazon-q-connect_CreateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIGuardrail-request-sensitiveInformationPolicyConfig"></a>
The sensitive information policy to configure for the AI Guardrail.  
Type: [AIGuardrailSensitiveInformationPolicyConfig](API_amazon-q-connect_AIGuardrailSensitiveInformationPolicyConfig.md) object  
Required: No

 ** [tags](#API_amazon-q-connect_CreateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIGuardrail-request-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [topicPolicyConfig](#API_amazon-q-connect_CreateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIGuardrail-request-topicPolicyConfig"></a>
The topic policies to configure for the AI Guardrail.  
Type: [AIGuardrailTopicPolicyConfig](API_amazon-q-connect_AIGuardrailTopicPolicyConfig.md) object  
Required: No

 ** [visibilityStatus](#API_amazon-q-connect_CreateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIGuardrail-request-visibilityStatus"></a>
The visibility status of the AI Guardrail.  
Type: String  
Valid Values: `SAVED | PUBLISHED`   
Required: Yes

 ** [wordPolicyConfig](#API_amazon-q-connect_CreateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIGuardrail-request-wordPolicyConfig"></a>
The word policy you configure for the AI Guardrail.  
Type: [AIGuardrailWordPolicyConfig](API_amazon-q-connect_AIGuardrailWordPolicyConfig.md) object  
Required: No

## Response Syntax
<a name="API_amazon-q-connect_CreateAIGuardrail_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "aiGuardrail": { 
      "aiGuardrailArn": "string",
      "aiGuardrailId": "string",
      "assistantArn": "string",
      "assistantId": "string",
      "blockedInputMessaging": "string",
      "blockedOutputsMessaging": "string",
      "contentPolicyConfig": { 
         "filtersConfig": [ 
            { 
               "inputStrength": "string",
               "outputStrength": "string",
               "type": "string"
            }
         ]
      },
      "contextualGroundingPolicyConfig": { 
         "filtersConfig": [ 
            { 
               "threshold": number,
               "type": "string"
            }
         ]
      },
      "description": "string",
      "modifiedTime": number,
      "name": "string",
      "sensitiveInformationPolicyConfig": { 
         "piiEntitiesConfig": [ 
            { 
               "action": "string",
               "type": "string"
            }
         ],
         "regexesConfig": [ 
            { 
               "action": "string",
               "description": "string",
               "name": "string",
               "pattern": "string"
            }
         ]
      },
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "topicPolicyConfig": { 
         "topicsConfig": [ 
            { 
               "definition": "string",
               "examples": [ "string" ],
               "name": "string",
               "type": "string"
            }
         ]
      },
      "visibilityStatus": "string",
      "wordPolicyConfig": { 
         "managedWordListsConfig": [ 
            { 
               "type": "string"
            }
         ],
         "wordsConfig": [ 
            { 
               "text": "string"
            }
         ]
      }
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_CreateAIGuardrail_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [aiGuardrail](#API_amazon-q-connect_CreateAIGuardrail_ResponseSyntax) **   <a name="connect-amazon-q-connect_CreateAIGuardrail-response-aiGuardrail"></a>
The data of the AI Guardrail.  
Type: [AIGuardrailData](API_amazon-q-connect_AIGuardrailData.md) object

## Errors
<a name="API_amazon-q-connect_CreateAIGuardrail_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.  
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_CreateAIGuardrail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/CreateAIGuardrail) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/CreateAIGuardrail) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/CreateAIGuardrail) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/CreateAIGuardrail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/CreateAIGuardrail) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/CreateAIGuardrail) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/CreateAIGuardrail) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/CreateAIGuardrail) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/CreateAIGuardrail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/CreateAIGuardrail) 

# CreateAIGuardrailVersion
<a name="API_amazon-q-connect_CreateAIGuardrailVersion"></a>

Creates an Amazon Q in Connect AI Guardrail version.

## Request Syntax
<a name="API_amazon-q-connect_CreateAIGuardrailVersion_RequestSyntax"></a>

```
POST /assistants/assistantId/aiguardrails/aiGuardrailId/versions HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "modifiedTime": number
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_CreateAIGuardrailVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aiGuardrailId](#API_amazon-q-connect_CreateAIGuardrailVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIGuardrailVersion-request-uri-aiGuardrailId"></a>
The identifier of the Amazon Q in Connect AI Guardrail.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** [assistantId](#API_amazon-q-connect_CreateAIGuardrailVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIGuardrailVersion-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_CreateAIGuardrailVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_amazon-q-connect_CreateAIGuardrailVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIGuardrailVersion-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)..  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [modifiedTime](#API_amazon-q-connect_CreateAIGuardrailVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIGuardrailVersion-request-modifiedTime"></a>
The time the AI Guardrail was last modified.  
Type: Timestamp  
Required: No

## Response Syntax
<a name="API_amazon-q-connect_CreateAIGuardrailVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "aiGuardrail": { 
      "aiGuardrailArn": "string",
      "aiGuardrailId": "string",
      "assistantArn": "string",
      "assistantId": "string",
      "blockedInputMessaging": "string",
      "blockedOutputsMessaging": "string",
      "contentPolicyConfig": { 
         "filtersConfig": [ 
            { 
               "inputStrength": "string",
               "outputStrength": "string",
               "type": "string"
            }
         ]
      },
      "contextualGroundingPolicyConfig": { 
         "filtersConfig": [ 
            { 
               "threshold": number,
               "type": "string"
            }
         ]
      },
      "description": "string",
      "modifiedTime": number,
      "name": "string",
      "sensitiveInformationPolicyConfig": { 
         "piiEntitiesConfig": [ 
            { 
               "action": "string",
               "type": "string"
            }
         ],
         "regexesConfig": [ 
            { 
               "action": "string",
               "description": "string",
               "name": "string",
               "pattern": "string"
            }
         ]
      },
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "topicPolicyConfig": { 
         "topicsConfig": [ 
            { 
               "definition": "string",
               "examples": [ "string" ],
               "name": "string",
               "type": "string"
            }
         ]
      },
      "visibilityStatus": "string",
      "wordPolicyConfig": { 
         "managedWordListsConfig": [ 
            { 
               "type": "string"
            }
         ],
         "wordsConfig": [ 
            { 
               "text": "string"
            }
         ]
      }
   },
   "versionNumber": number
}
```

## Response Elements
<a name="API_amazon-q-connect_CreateAIGuardrailVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [aiGuardrail](#API_amazon-q-connect_CreateAIGuardrailVersion_ResponseSyntax) **   <a name="connect-amazon-q-connect_CreateAIGuardrailVersion-response-aiGuardrail"></a>
The data of the AI Guardrail version.  
Type: [AIGuardrailData](API_amazon-q-connect_AIGuardrailData.md) object

 ** [versionNumber](#API_amazon-q-connect_CreateAIGuardrailVersion_ResponseSyntax) **   <a name="connect-amazon-q-connect_CreateAIGuardrailVersion-response-versionNumber"></a>
The version number of the AI Guardrail version.  
Type: Long  
Valid Range: Minimum value of 1.

## Errors
<a name="API_amazon-q-connect_CreateAIGuardrailVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.  
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_CreateAIGuardrailVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/CreateAIGuardrailVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/CreateAIGuardrailVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/CreateAIGuardrailVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/CreateAIGuardrailVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/CreateAIGuardrailVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/CreateAIGuardrailVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/CreateAIGuardrailVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/CreateAIGuardrailVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/CreateAIGuardrailVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/CreateAIGuardrailVersion) 

# CreateAIPrompt
<a name="API_amazon-q-connect_CreateAIPrompt"></a>

Creates an Amazon Q in Connect AI Prompt.

## Request Syntax
<a name="API_amazon-q-connect_CreateAIPrompt_RequestSyntax"></a>

```
POST /assistants/assistantId/aiprompts HTTP/1.1
Content-type: application/json

{
   "apiFormat": "string",
   "clientToken": "string",
   "description": "string",
   "inferenceConfiguration": { ... },
   "modelId": "string",
   "name": "string",
   "tags": { 
      "string" : "string" 
   },
   "templateConfiguration": { ... },
   "templateType": "string",
   "type": "string",
   "visibilityStatus": "string"
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_CreateAIPrompt_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_CreateAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIPrompt-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_CreateAIPrompt_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [apiFormat](#API_amazon-q-connect_CreateAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIPrompt-request-apiFormat"></a>
The API Format of the AI Prompt.  
Recommended values: `MESSAGES | TEXT_COMPLETIONS`   
The values `ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS` will be deprecated.
Type: String  
Valid Values: `ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS | MESSAGES | TEXT_COMPLETIONS`   
Required: Yes

 ** [clientToken](#API_amazon-q-connect_CreateAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIPrompt-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)..  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [description](#API_amazon-q-connect_CreateAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIPrompt-request-description"></a>
The description of the AI Prompt.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** [inferenceConfiguration](#API_amazon-q-connect_CreateAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIPrompt-request-inferenceConfiguration"></a>
The inference configuration for the AI Prompt being created.  
Type: [AIPromptInferenceConfiguration](API_amazon-q-connect_AIPromptInferenceConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [modelId](#API_amazon-q-connect_CreateAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIPrompt-request-modelId"></a>
The identifier of the model used for this AI Prompt.  
For information about which models are supported in each AWS Region, see [Supported models for system/custom prompts](https://docs.aws.amazon.com/connect/latest/adminguide/create-ai-prompts.html#cli-create-aiprompt).
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** [name](#API_amazon-q-connect_CreateAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIPrompt-request-name"></a>
The name of the AI Prompt.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** [tags](#API_amazon-q-connect_CreateAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIPrompt-request-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [templateConfiguration](#API_amazon-q-connect_CreateAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIPrompt-request-templateConfiguration"></a>
The configuration of the prompt template for this AI Prompt.  
Type: [AIPromptTemplateConfiguration](API_amazon-q-connect_AIPromptTemplateConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [templateType](#API_amazon-q-connect_CreateAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIPrompt-request-templateType"></a>
The type of the prompt template for this AI Prompt.  
Type: String  
Valid Values: `TEXT`   
Required: Yes

 ** [type](#API_amazon-q-connect_CreateAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIPrompt-request-type"></a>
The type of this AI Prompt.  
Type: String  
Valid Values: `ANSWER_GENERATION | INTENT_LABELING_GENERATION | QUERY_REFORMULATION | SELF_SERVICE_PRE_PROCESSING | SELF_SERVICE_ANSWER_GENERATION | EMAIL_RESPONSE | EMAIL_OVERVIEW | EMAIL_GENERATIVE_ANSWER | EMAIL_QUERY_REFORMULATION | ORCHESTRATION | NOTE_TAKING | CASE_SUMMARIZATION`   
Required: Yes

 ** [visibilityStatus](#API_amazon-q-connect_CreateAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIPrompt-request-visibilityStatus"></a>
The visibility status of the AI Prompt.  
Type: String  
Valid Values: `SAVED | PUBLISHED`   
Required: Yes

## Response Syntax
<a name="API_amazon-q-connect_CreateAIPrompt_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "aiPrompt": { 
      "aiPromptArn": "string",
      "aiPromptId": "string",
      "apiFormat": "string",
      "assistantArn": "string",
      "assistantId": "string",
      "description": "string",
      "inferenceConfiguration": { ... },
      "modelId": "string",
      "modifiedTime": number,
      "name": "string",
      "origin": "string",
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "templateConfiguration": { ... },
      "templateType": "string",
      "type": "string",
      "visibilityStatus": "string"
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_CreateAIPrompt_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [aiPrompt](#API_amazon-q-connect_CreateAIPrompt_ResponseSyntax) **   <a name="connect-amazon-q-connect_CreateAIPrompt-response-aiPrompt"></a>
The data of the AI Prompt.  
Type: [AIPromptData](API_amazon-q-connect_AIPromptData.md) object

## Errors
<a name="API_amazon-q-connect_CreateAIPrompt_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.  
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_CreateAIPrompt_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/CreateAIPrompt) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/CreateAIPrompt) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/CreateAIPrompt) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/CreateAIPrompt) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/CreateAIPrompt) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/CreateAIPrompt) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/CreateAIPrompt) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/CreateAIPrompt) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/CreateAIPrompt) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/CreateAIPrompt) 

# CreateAIPromptVersion
<a name="API_amazon-q-connect_CreateAIPromptVersion"></a>

Creates an Amazon Q in Connect AI Prompt version.

## Request Syntax
<a name="API_amazon-q-connect_CreateAIPromptVersion_RequestSyntax"></a>

```
POST /assistants/assistantId/aiprompts/aiPromptId/versions HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "modifiedTime": number
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_CreateAIPromptVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aiPromptId](#API_amazon-q-connect_CreateAIPromptVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIPromptVersion-request-uri-aiPromptId"></a>
The identifier of the Amazon Q in Connect AI prompt.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** [assistantId](#API_amazon-q-connect_CreateAIPromptVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIPromptVersion-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_CreateAIPromptVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_amazon-q-connect_CreateAIPromptVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIPromptVersion-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)..  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [modifiedTime](#API_amazon-q-connect_CreateAIPromptVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAIPromptVersion-request-modifiedTime"></a>
The time the AI Prompt was last modified.  
Type: Timestamp  
Required: No

## Response Syntax
<a name="API_amazon-q-connect_CreateAIPromptVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "aiPrompt": { 
      "aiPromptArn": "string",
      "aiPromptId": "string",
      "apiFormat": "string",
      "assistantArn": "string",
      "assistantId": "string",
      "description": "string",
      "inferenceConfiguration": { ... },
      "modelId": "string",
      "modifiedTime": number,
      "name": "string",
      "origin": "string",
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "templateConfiguration": { ... },
      "templateType": "string",
      "type": "string",
      "visibilityStatus": "string"
   },
   "versionNumber": number
}
```

## Response Elements
<a name="API_amazon-q-connect_CreateAIPromptVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [aiPrompt](#API_amazon-q-connect_CreateAIPromptVersion_ResponseSyntax) **   <a name="connect-amazon-q-connect_CreateAIPromptVersion-response-aiPrompt"></a>
The data of the AI Prompt version.  
Type: [AIPromptData](API_amazon-q-connect_AIPromptData.md) object

 ** [versionNumber](#API_amazon-q-connect_CreateAIPromptVersion_ResponseSyntax) **   <a name="connect-amazon-q-connect_CreateAIPromptVersion-response-versionNumber"></a>
The version number of the AI Prompt version.  
Type: Long  
Valid Range: Minimum value of 1.

## Errors
<a name="API_amazon-q-connect_CreateAIPromptVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.  
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_CreateAIPromptVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/CreateAIPromptVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/CreateAIPromptVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/CreateAIPromptVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/CreateAIPromptVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/CreateAIPromptVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/CreateAIPromptVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/CreateAIPromptVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/CreateAIPromptVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/CreateAIPromptVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/CreateAIPromptVersion) 

# CreateAssistant
<a name="API_amazon-q-connect_CreateAssistant"></a>

Creates an Amazon Q in Connect assistant.

## Request Syntax
<a name="API_amazon-q-connect_CreateAssistant_RequestSyntax"></a>

```
POST /assistants HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "name": "string",
   "serverSideEncryptionConfiguration": { 
      "kmsKeyId": "string"
   },
   "tags": { 
      "string" : "string" 
   },
   "type": "string"
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_CreateAssistant_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_amazon-q-connect_CreateAssistant_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_amazon-q-connect_CreateAssistant_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAssistant-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [description](#API_amazon-q-connect_CreateAssistant_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAssistant-request-description"></a>
The description of the assistant.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** [name](#API_amazon-q-connect_CreateAssistant_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAssistant-request-name"></a>
The name of the assistant.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** [serverSideEncryptionConfiguration](#API_amazon-q-connect_CreateAssistant_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAssistant-request-serverSideEncryptionConfiguration"></a>
The configuration information for the customer managed key used for encryption.   
The customer managed key must have a policy that allows `kms:CreateGrant`, ` kms:DescribeKey`, `kms:Decrypt`, and `kms:GenerateDataKey*` permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow `kms:Decrypt`, `kms:GenerateDataKey*`, and `kms:DescribeKey` permissions to the `connect.amazonaws.com` service principal.   
For more information about setting up a customer managed key for Amazon Q in Connect, see [Enable Amazon Q in Connect for your instance](https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html).  
Type: [ServerSideEncryptionConfiguration](API_amazon-q-connect_ServerSideEncryptionConfiguration.md) object  
Required: No

 ** [tags](#API_amazon-q-connect_CreateAssistant_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAssistant-request-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [type](#API_amazon-q-connect_CreateAssistant_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAssistant-request-type"></a>
The type of assistant.  
Type: String  
Valid Values: `AGENT`   
Required: Yes

## Response Syntax
<a name="API_amazon-q-connect_CreateAssistant_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assistant": { 
      "aiAgentConfiguration": { 
         "string" : { 
            "aiAgentId": "string"
         }
      },
      "assistantArn": "string",
      "assistantId": "string",
      "capabilityConfiguration": { 
         "type": "string"
      },
      "description": "string",
      "integrationConfiguration": { 
         "topicIntegrationArn": "string"
      },
      "name": "string",
      "orchestratorConfigurationList": [ 
         { 
            "aiAgentId": "string",
            "orchestratorUseCase": "string"
         }
      ],
      "serverSideEncryptionConfiguration": { 
         "kmsKeyId": "string"
      },
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "type": "string"
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_CreateAssistant_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assistant](#API_amazon-q-connect_CreateAssistant_ResponseSyntax) **   <a name="connect-amazon-q-connect_CreateAssistant-response-assistant"></a>
Information about the assistant.  
Type: [AssistantData](API_amazon-q-connect_AssistantData.md) object

## Errors
<a name="API_amazon-q-connect_CreateAssistant_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ServiceQuotaExceededException **   
You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.  
HTTP Status Code: 402

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_CreateAssistant_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/CreateAssistant) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/CreateAssistant) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/CreateAssistant) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/CreateAssistant) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/CreateAssistant) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/CreateAssistant) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/CreateAssistant) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/CreateAssistant) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/CreateAssistant) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/CreateAssistant) 

# CreateAssistantAssociation
<a name="API_amazon-q-connect_CreateAssistantAssociation"></a>

Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.

## Request Syntax
<a name="API_amazon-q-connect_CreateAssistantAssociation_RequestSyntax"></a>

```
POST /assistants/assistantId/associations HTTP/1.1
Content-type: application/json

{
   "association": { ... },
   "associationType": "string",
   "clientToken": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_CreateAssistantAssociation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_CreateAssistantAssociation_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAssistantAssociation-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_CreateAssistantAssociation_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [association](#API_amazon-q-connect_CreateAssistantAssociation_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAssistantAssociation-request-association"></a>
The identifier of the associated resource.  
Type: [AssistantAssociationInputData](API_amazon-q-connect_AssistantAssociationInputData.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [associationType](#API_amazon-q-connect_CreateAssistantAssociation_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAssistantAssociation-request-associationType"></a>
The type of association.  
Type: String  
Valid Values: `KNOWLEDGE_BASE | EXTERNAL_BEDROCK_KNOWLEDGE_BASE`   
Required: Yes

 ** [clientToken](#API_amazon-q-connect_CreateAssistantAssociation_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAssistantAssociation-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [tags](#API_amazon-q-connect_CreateAssistantAssociation_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateAssistantAssociation-request-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_amazon-q-connect_CreateAssistantAssociation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assistantAssociation": { 
      "assistantArn": "string",
      "assistantAssociationArn": "string",
      "assistantAssociationId": "string",
      "assistantId": "string",
      "associationData": { ... },
      "associationType": "string",
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_CreateAssistantAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assistantAssociation](#API_amazon-q-connect_CreateAssistantAssociation_ResponseSyntax) **   <a name="connect-amazon-q-connect_CreateAssistantAssociation-response-assistantAssociation"></a>
The assistant association.  
Type: [AssistantAssociationData](API_amazon-q-connect_AssistantAssociationData.md) object

## Errors
<a name="API_amazon-q-connect_CreateAssistantAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.  
HTTP Status Code: 402

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_CreateAssistantAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/CreateAssistantAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/CreateAssistantAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/CreateAssistantAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/CreateAssistantAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/CreateAssistantAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/CreateAssistantAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/CreateAssistantAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/CreateAssistantAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/CreateAssistantAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/CreateAssistantAssociation) 

# CreateContent
<a name="API_amazon-q-connect_CreateContent"></a>

Creates Amazon Q in Connect content. Before to calling this API, use [StartContentUpload](https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html) to upload an asset.

## Request Syntax
<a name="API_amazon-q-connect_CreateContent_RequestSyntax"></a>

```
POST /knowledgeBases/knowledgeBaseId/contents HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "metadata": { 
      "string" : "string" 
   },
   "name": "string",
   "overrideLinkOutUri": "string",
   "tags": { 
      "string" : "string" 
   },
   "title": "string",
   "uploadId": "string"
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_CreateContent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_CreateContent_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateContent-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. This should not be a QUICK\$1RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_CreateContent_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_amazon-q-connect_CreateContent_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateContent-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [metadata](#API_amazon-q-connect_CreateContent_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateContent-request-metadata"></a>
A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 10 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 4096.  
Value Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [name](#API_amazon-q-connect_CreateContent_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateContent-request-name"></a>
The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the [SearchContent](https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_SearchContent.html) API.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** [overrideLinkOutUri](#API_amazon-q-connect_CreateContent_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateContent-request-overrideLinkOutUri"></a>
The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [tags](#API_amazon-q-connect_CreateContent_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateContent-request-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [title](#API_amazon-q-connect_CreateContent_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateContent-request-title"></a>
The title of the content. If not set, the title is equal to the name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [uploadId](#API_amazon-q-connect_CreateContent_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateContent-request-uploadId"></a>
A pointer to the uploaded asset. This value is returned by [StartContentUpload](https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1200.  
Required: Yes

## Response Syntax
<a name="API_amazon-q-connect_CreateContent_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "content": { 
      "contentArn": "string",
      "contentId": "string",
      "contentType": "string",
      "knowledgeBaseArn": "string",
      "knowledgeBaseId": "string",
      "linkOutUri": "string",
      "metadata": { 
         "string" : "string" 
      },
      "name": "string",
      "revisionId": "string",
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "title": "string",
      "url": "string",
      "urlExpiry": number
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_CreateContent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [content](#API_amazon-q-connect_CreateContent_ResponseSyntax) **   <a name="connect-amazon-q-connect_CreateContent-response-content"></a>
The content.  
Type: [ContentData](API_amazon-q-connect_ContentData.md) object

## Errors
<a name="API_amazon-q-connect_CreateContent_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.  
HTTP Status Code: 402

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_CreateContent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/CreateContent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/CreateContent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/CreateContent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/CreateContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/CreateContent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/CreateContent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/CreateContent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/CreateContent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/CreateContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/CreateContent) 

# CreateContentAssociation
<a name="API_amazon-q-connect_CreateContentAssociation"></a>

Creates an association between a content resource in a knowledge base and [step-by-step guides](https://docs.aws.amazon.com/connect/latest/adminguide/step-by-step-guided-experiences.html). Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides. 

After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step-by-step guide that you have associated with the content.

Note the following limitations:
+ You can create only one content association for each content resource in a knowledge base.
+ You can associate a step-by-step guide with multiple content resources.

For more information, see [Integrate Amazon Q in Connect with step-by-step guides](https://docs.aws.amazon.com/connect/latest/adminguide/integrate-q-with-guides.html) in the *Amazon Connect Administrator Guide*. 

## Request Syntax
<a name="API_amazon-q-connect_CreateContentAssociation_RequestSyntax"></a>

```
POST /knowledgeBases/knowledgeBaseId/contents/contentId/associations HTTP/1.1
Content-type: application/json

{
   "association": { ... },
   "associationType": "string",
   "clientToken": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_CreateContentAssociation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [contentId](#API_amazon-q-connect_CreateContentAssociation_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateContentAssociation-request-uri-contentId"></a>
The identifier of the content.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [knowledgeBaseId](#API_amazon-q-connect_CreateContentAssociation_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateContentAssociation-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_CreateContentAssociation_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [association](#API_amazon-q-connect_CreateContentAssociation_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateContentAssociation-request-association"></a>
The identifier of the associated resource.  
Type: [ContentAssociationContents](API_amazon-q-connect_ContentAssociationContents.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [associationType](#API_amazon-q-connect_CreateContentAssociation_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateContentAssociation-request-associationType"></a>
The type of association.  
Type: String  
Valid Values: `AMAZON_CONNECT_GUIDE`   
Required: Yes

 ** [clientToken](#API_amazon-q-connect_CreateContentAssociation_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateContentAssociation-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [tags](#API_amazon-q-connect_CreateContentAssociation_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateContentAssociation-request-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_amazon-q-connect_CreateContentAssociation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "contentAssociation": { 
      "associationData": { ... },
      "associationType": "string",
      "contentArn": "string",
      "contentAssociationArn": "string",
      "contentAssociationId": "string",
      "contentId": "string",
      "knowledgeBaseArn": "string",
      "knowledgeBaseId": "string",
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_CreateContentAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [contentAssociation](#API_amazon-q-connect_CreateContentAssociation_ResponseSyntax) **   <a name="connect-amazon-q-connect_CreateContentAssociation-response-contentAssociation"></a>
The association between Amazon Q in Connect content and another resource.  
Type: [ContentAssociationData](API_amazon-q-connect_ContentAssociationData.md) object

## Errors
<a name="API_amazon-q-connect_CreateContentAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.  
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_CreateContentAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/CreateContentAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/CreateContentAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/CreateContentAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/CreateContentAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/CreateContentAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/CreateContentAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/CreateContentAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/CreateContentAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/CreateContentAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/CreateContentAssociation) 

# CreateKnowledgeBase
<a name="API_amazon-q-connect_CreateKnowledgeBase"></a>

Creates a knowledge base.

**Note**  
When using this API, you cannot reuse [Amazon AppIntegrations](https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html) DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an `InvalidRequestException` error.   
For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:  
Call [DeleteKnowledgeBase](https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_DeleteKnowledgeBase.html).
Call [DeleteDataIntegration](https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html).
Call [CreateDataIntegration](https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) to recreate the DataIntegration or a create different one.
Call CreateKnowledgeBase.

## Request Syntax
<a name="API_amazon-q-connect_CreateKnowledgeBase_RequestSyntax"></a>

```
POST /knowledgeBases HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "knowledgeBaseType": "string",
   "name": "string",
   "renderingConfiguration": { 
      "templateUri": "string"
   },
   "serverSideEncryptionConfiguration": { 
      "kmsKeyId": "string"
   },
   "sourceConfiguration": { ... },
   "tags": { 
      "string" : "string" 
   },
   "vectorIngestionConfiguration": { 
      "chunkingConfiguration": { 
         "chunkingStrategy": "string",
         "fixedSizeChunkingConfiguration": { 
            "maxTokens": number,
            "overlapPercentage": number
         },
         "hierarchicalChunkingConfiguration": { 
            "levelConfigurations": [ 
               { 
                  "maxTokens": number
               }
            ],
            "overlapTokens": number
         },
         "semanticChunkingConfiguration": { 
            "breakpointPercentileThreshold": number,
            "bufferSize": number,
            "maxTokens": number
         }
      },
      "parsingConfiguration": { 
         "bedrockFoundationModelConfiguration": { 
            "modelArn": "string",
            "parsingPrompt": { 
               "parsingPromptText": "string"
            }
         },
         "parsingStrategy": "string"
      }
   }
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_CreateKnowledgeBase_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_amazon-q-connect_CreateKnowledgeBase_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_amazon-q-connect_CreateKnowledgeBase_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateKnowledgeBase-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [description](#API_amazon-q-connect_CreateKnowledgeBase_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateKnowledgeBase-request-description"></a>
The description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** [knowledgeBaseType](#API_amazon-q-connect_CreateKnowledgeBase_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateKnowledgeBase-request-knowledgeBaseType"></a>
The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.   
Type: String  
Valid Values: `EXTERNAL | CUSTOM | QUICK_RESPONSES | MESSAGE_TEMPLATES | MANAGED`   
Required: Yes

 ** [name](#API_amazon-q-connect_CreateKnowledgeBase_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateKnowledgeBase-request-name"></a>
The name of the knowledge base.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** [renderingConfiguration](#API_amazon-q-connect_CreateKnowledgeBase_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateKnowledgeBase-request-renderingConfiguration"></a>
Information about how to render the content.  
Type: [RenderingConfiguration](API_amazon-q-connect_RenderingConfiguration.md) object  
Required: No

 ** [serverSideEncryptionConfiguration](#API_amazon-q-connect_CreateKnowledgeBase_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateKnowledgeBase-request-serverSideEncryptionConfiguration"></a>
The configuration information for the customer managed key used for encryption.   
This KMS key must have a policy that allows `kms:CreateGrant`, `kms:DescribeKey`, `kms:Decrypt`, and `kms:GenerateDataKey*` permissions to the IAM identity using the key to invoke Amazon Q in Connect.  
For more information about setting up a customer managed key for Amazon Q in Connect, see [Enable Amazon Q in Connect for your instance](https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html).  
Type: [ServerSideEncryptionConfiguration](API_amazon-q-connect_ServerSideEncryptionConfiguration.md) object  
Required: No

 ** [sourceConfiguration](#API_amazon-q-connect_CreateKnowledgeBase_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateKnowledgeBase-request-sourceConfiguration"></a>
The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases.  
Type: [SourceConfiguration](API_amazon-q-connect_SourceConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [tags](#API_amazon-q-connect_CreateKnowledgeBase_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateKnowledgeBase-request-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

 ** [vectorIngestionConfiguration](#API_amazon-q-connect_CreateKnowledgeBase_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateKnowledgeBase-request-vectorIngestionConfiguration"></a>
Contains details about how to ingest the documents in a data source.  
Type: [VectorIngestionConfiguration](API_amazon-q-connect_VectorIngestionConfiguration.md) object  
Required: No

## Response Syntax
<a name="API_amazon-q-connect_CreateKnowledgeBase_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "knowledgeBase": { 
      "description": "string",
      "ingestionFailureReasons": [ "string" ],
      "ingestionStatus": "string",
      "knowledgeBaseArn": "string",
      "knowledgeBaseId": "string",
      "knowledgeBaseType": "string",
      "lastContentModificationTime": number,
      "name": "string",
      "renderingConfiguration": { 
         "templateUri": "string"
      },
      "serverSideEncryptionConfiguration": { 
         "kmsKeyId": "string"
      },
      "sourceConfiguration": { ... },
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "vectorIngestionConfiguration": { 
         "chunkingConfiguration": { 
            "chunkingStrategy": "string",
            "fixedSizeChunkingConfiguration": { 
               "maxTokens": number,
               "overlapPercentage": number
            },
            "hierarchicalChunkingConfiguration": { 
               "levelConfigurations": [ 
                  { 
                     "maxTokens": number
                  }
               ],
               "overlapTokens": number
            },
            "semanticChunkingConfiguration": { 
               "breakpointPercentileThreshold": number,
               "bufferSize": number,
               "maxTokens": number
            }
         },
         "parsingConfiguration": { 
            "bedrockFoundationModelConfiguration": { 
               "modelArn": "string",
               "parsingPrompt": { 
                  "parsingPromptText": "string"
               }
            },
            "parsingStrategy": "string"
         }
      }
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_CreateKnowledgeBase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [knowledgeBase](#API_amazon-q-connect_CreateKnowledgeBase_ResponseSyntax) **   <a name="connect-amazon-q-connect_CreateKnowledgeBase-response-knowledgeBase"></a>
The knowledge base.  
Type: [KnowledgeBaseData](API_amazon-q-connect_KnowledgeBaseData.md) object

## Errors
<a name="API_amazon-q-connect_CreateKnowledgeBase_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ServiceQuotaExceededException **   
You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.  
HTTP Status Code: 402

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_CreateKnowledgeBase_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/CreateKnowledgeBase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/CreateKnowledgeBase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/CreateKnowledgeBase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/CreateKnowledgeBase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/CreateKnowledgeBase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/CreateKnowledgeBase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/CreateKnowledgeBase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/CreateKnowledgeBase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/CreateKnowledgeBase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/CreateKnowledgeBase) 

# CreateMessageTemplate
<a name="API_amazon-q-connect_CreateMessageTemplate"></a>

Creates an Amazon Q in Connect message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the `$LATEST` qualifier to reference the created message template.

## Request Syntax
<a name="API_amazon-q-connect_CreateMessageTemplate_RequestSyntax"></a>

```
POST /knowledgeBases/knowledgeBaseId/messageTemplates HTTP/1.1
Content-type: application/json

{
   "channelSubtype": "string",
   "clientToken": "string",
   "content": { ... },
   "defaultAttributes": { 
      "agentAttributes": { 
         "firstName": "string",
         "lastName": "string"
      },
      "customAttributes": { 
         "string" : "string" 
      },
      "customerProfileAttributes": { 
         "accountNumber": "string",
         "additionalInformation": "string",
         "address1": "string",
         "address2": "string",
         "address3": "string",
         "address4": "string",
         "billingAddress1": "string",
         "billingAddress2": "string",
         "billingAddress3": "string",
         "billingAddress4": "string",
         "billingCity": "string",
         "billingCountry": "string",
         "billingCounty": "string",
         "billingPostalCode": "string",
         "billingProvince": "string",
         "billingState": "string",
         "birthDate": "string",
         "businessEmailAddress": "string",
         "businessName": "string",
         "businessPhoneNumber": "string",
         "city": "string",
         "country": "string",
         "county": "string",
         "custom": { 
            "string" : "string" 
         },
         "emailAddress": "string",
         "firstName": "string",
         "gender": "string",
         "homePhoneNumber": "string",
         "lastName": "string",
         "mailingAddress1": "string",
         "mailingAddress2": "string",
         "mailingAddress3": "string",
         "mailingAddress4": "string",
         "mailingCity": "string",
         "mailingCountry": "string",
         "mailingCounty": "string",
         "mailingPostalCode": "string",
         "mailingProvince": "string",
         "mailingState": "string",
         "middleName": "string",
         "mobilePhoneNumber": "string",
         "partyType": "string",
         "phoneNumber": "string",
         "postalCode": "string",
         "profileARN": "string",
         "profileId": "string",
         "province": "string",
         "shippingAddress1": "string",
         "shippingAddress2": "string",
         "shippingAddress3": "string",
         "shippingAddress4": "string",
         "shippingCity": "string",
         "shippingCountry": "string",
         "shippingCounty": "string",
         "shippingPostalCode": "string",
         "shippingProvince": "string",
         "shippingState": "string",
         "state": "string"
      },
      "systemAttributes": { 
         "customerEndpoint": { 
            "address": "string"
         },
         "name": "string",
         "systemEndpoint": { 
            "address": "string"
         }
      }
   },
   "description": "string",
   "groupingConfiguration": { 
      "criteria": "string",
      "values": [ "string" ]
   },
   "language": "string",
   "name": "string",
   "sourceConfiguration": { ... },
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_CreateMessageTemplate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_CreateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplate-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_CreateMessageTemplate_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [channelSubtype](#API_amazon-q-connect_CreateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplate-request-channelSubtype"></a>
The channel subtype this message template applies to.  
Type: String  
Valid Values: `EMAIL | SMS | WHATSAPP | PUSH`   
Required: Yes

 ** [clientToken](#API_amazon-q-connect_CreateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplate-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [content](#API_amazon-q-connect_CreateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplate-request-content"></a>
The content of the message template.  
Type: [MessageTemplateContentProvider](API_amazon-q-connect_MessageTemplateContentProvider.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [defaultAttributes](#API_amazon-q-connect_CreateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplate-request-defaultAttributes"></a>
An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.  
Type: [MessageTemplateAttributes](API_amazon-q-connect_MessageTemplateAttributes.md) object  
Required: No

 ** [description](#API_amazon-q-connect_CreateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplate-request-description"></a>
The description of the message template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** [groupingConfiguration](#API_amazon-q-connect_CreateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplate-request-groupingConfiguration"></a>
The configuration information of the grouping of Amazon Q in Connect users.  
Type: [GroupingConfiguration](API_amazon-q-connect_GroupingConfiguration.md) object  
Required: No

 ** [language](#API_amazon-q-connect_CreateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplate-request-language"></a>
The language code value for the language in which the quick response is written. The supported language codes include `de_DE`, `en_US`, `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`, `zh_CN`, `zh_TW`   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 5.  
Required: No

 ** [name](#API_amazon-q-connect_CreateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplate-request-name"></a>
The name of the message template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** [sourceConfiguration](#API_amazon-q-connect_CreateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplate-request-sourceConfiguration"></a>
The source configuration of the message template. Only set this argument for WHATSAPP channel subtype.  
Type: [MessageTemplateSourceConfiguration](API_amazon-q-connect_MessageTemplateSourceConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [tags](#API_amazon-q-connect_CreateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplate-request-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_amazon-q-connect_CreateMessageTemplate_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "messageTemplate": { 
      "attributeTypes": [ "string" ],
      "channel": "string",
      "channelSubtype": "string",
      "content": { ... },
      "createdTime": "string",
      "defaultAttributes": { 
         "agentAttributes": { 
            "firstName": "string",
            "lastName": "string"
         },
         "customAttributes": { 
            "string" : "string" 
         },
         "customerProfileAttributes": { 
            "accountNumber": "string",
            "additionalInformation": "string",
            "address1": "string",
            "address2": "string",
            "address3": "string",
            "address4": "string",
            "billingAddress1": "string",
            "billingAddress2": "string",
            "billingAddress3": "string",
            "billingAddress4": "string",
            "billingCity": "string",
            "billingCountry": "string",
            "billingCounty": "string",
            "billingPostalCode": "string",
            "billingProvince": "string",
            "billingState": "string",
            "birthDate": "string",
            "businessEmailAddress": "string",
            "businessName": "string",
            "businessPhoneNumber": "string",
            "city": "string",
            "country": "string",
            "county": "string",
            "custom": { 
               "string" : "string" 
            },
            "emailAddress": "string",
            "firstName": "string",
            "gender": "string",
            "homePhoneNumber": "string",
            "lastName": "string",
            "mailingAddress1": "string",
            "mailingAddress2": "string",
            "mailingAddress3": "string",
            "mailingAddress4": "string",
            "mailingCity": "string",
            "mailingCountry": "string",
            "mailingCounty": "string",
            "mailingPostalCode": "string",
            "mailingProvince": "string",
            "mailingState": "string",
            "middleName": "string",
            "mobilePhoneNumber": "string",
            "partyType": "string",
            "phoneNumber": "string",
            "postalCode": "string",
            "profileARN": "string",
            "profileId": "string",
            "province": "string",
            "shippingAddress1": "string",
            "shippingAddress2": "string",
            "shippingAddress3": "string",
            "shippingAddress4": "string",
            "shippingCity": "string",
            "shippingCountry": "string",
            "shippingCounty": "string",
            "shippingPostalCode": "string",
            "shippingProvince": "string",
            "shippingState": "string",
            "state": "string"
         },
         "systemAttributes": { 
            "customerEndpoint": { 
               "address": "string"
            },
            "name": "string",
            "systemEndpoint": { 
               "address": "string"
            }
         }
      },
      "description": "string",
      "groupingConfiguration": { 
         "criteria": "string",
         "values": [ "string" ]
      },
      "knowledgeBaseArn": "string",
      "knowledgeBaseId": "string",
      "language": "string",
      "lastModifiedBy": "string",
      "lastModifiedTime": "string",
      "messageTemplateArn": "string",
      "messageTemplateContentSha256": "string",
      "messageTemplateId": "string",
      "name": "string",
      "sourceConfigurationSummary": { ... },
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_CreateMessageTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [messageTemplate](#API_amazon-q-connect_CreateMessageTemplate_ResponseSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplate-response-messageTemplate"></a>
The message template.  
Type: [MessageTemplateData](API_amazon-q-connect_MessageTemplateData.md) object

## Errors
<a name="API_amazon-q-connect_CreateMessageTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.  
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_CreateMessageTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/CreateMessageTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/CreateMessageTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/CreateMessageTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/CreateMessageTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/CreateMessageTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/CreateMessageTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/CreateMessageTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/CreateMessageTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/CreateMessageTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/CreateMessageTemplate) 

# CreateMessageTemplateAttachment
<a name="API_amazon-q-connect_CreateMessageTemplateAttachment"></a>

Uploads an attachment file to the specified Amazon Q in Connect message template. The name of the message template attachment has to be unique for each message template referenced by the `$LATEST` qualifier. The body of the attachment file should be encoded using base64 encoding. After the file is uploaded, you can use the pre-signed Amazon S3 URL returned in response to download the uploaded file.

## Request Syntax
<a name="API_amazon-q-connect_CreateMessageTemplateAttachment_RequestSyntax"></a>

```
POST /knowledgeBases/knowledgeBaseId/messageTemplates/messageTemplateId/attachments HTTP/1.1
Content-type: application/json

{
   "body": "string",
   "clientToken": "string",
   "contentDisposition": "string",
   "name": "string"
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_CreateMessageTemplateAttachment_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_CreateMessageTemplateAttachment_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplateAttachment-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [messageTemplateId](#API_amazon-q-connect_CreateMessageTemplateAttachment_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplateAttachment-request-uri-messageTemplateId"></a>
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_CreateMessageTemplateAttachment_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [body](#API_amazon-q-connect_CreateMessageTemplateAttachment_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplateAttachment-request-body"></a>
The body of the attachment file being uploaded. It should be encoded using base64 encoding.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: Yes

 ** [clientToken](#API_amazon-q-connect_CreateMessageTemplateAttachment_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplateAttachment-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [contentDisposition](#API_amazon-q-connect_CreateMessageTemplateAttachment_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplateAttachment-request-contentDisposition"></a>
The presentation information for the attachment file.  
Type: String  
Valid Values: `ATTACHMENT`   
Required: Yes

 ** [name](#API_amazon-q-connect_CreateMessageTemplateAttachment_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplateAttachment-request-name"></a>
The name of the attachment file being uploaded. The name should include the file extension.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\p{L}\p{M}\p{N}_\s&@()+,;=\-]+\.[A-Za-z0-9]+`   
Required: Yes

## Response Syntax
<a name="API_amazon-q-connect_CreateMessageTemplateAttachment_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "attachment": { 
      "attachmentId": "string",
      "contentDisposition": "string",
      "name": "string",
      "uploadedTime": "string",
      "url": "string",
      "urlExpiry": "string"
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_CreateMessageTemplateAttachment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [attachment](#API_amazon-q-connect_CreateMessageTemplateAttachment_ResponseSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplateAttachment-response-attachment"></a>
The message template attachment.  
Type: [MessageTemplateAttachment](API_amazon-q-connect_MessageTemplateAttachment.md) object

## Errors
<a name="API_amazon-q-connect_CreateMessageTemplateAttachment_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.  
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_CreateMessageTemplateAttachment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/CreateMessageTemplateAttachment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/CreateMessageTemplateAttachment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/CreateMessageTemplateAttachment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/CreateMessageTemplateAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/CreateMessageTemplateAttachment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/CreateMessageTemplateAttachment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/CreateMessageTemplateAttachment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/CreateMessageTemplateAttachment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/CreateMessageTemplateAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/CreateMessageTemplateAttachment) 

# CreateMessageTemplateVersion
<a name="API_amazon-q-connect_CreateMessageTemplateVersion"></a>

Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template. Versions are immutable and monotonically increasing. Once a version is created, you can reference a specific version of the message template by passing in `<message-template-id>:<versionNumber>` as the message template identifier. An error is displayed if the supplied `messageTemplateContentSha256` is different from the `messageTemplateContentSha256` of the message template with `$LATEST` qualifier. If multiple `CreateMessageTemplateVersion` requests are made while the message template remains the same, only the first invocation creates a new version and the succeeding requests will return the same response as the first invocation.

## Request Syntax
<a name="API_amazon-q-connect_CreateMessageTemplateVersion_RequestSyntax"></a>

```
POST /knowledgeBases/knowledgeBaseId/messageTemplates/messageTemplateId/versions HTTP/1.1
Content-type: application/json

{
   "messageTemplateContentSha256": "string"
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_CreateMessageTemplateVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_CreateMessageTemplateVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplateVersion-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [messageTemplateId](#API_amazon-q-connect_CreateMessageTemplateVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplateVersion-request-uri-messageTemplateId"></a>
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_CreateMessageTemplateVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [messageTemplateContentSha256](#API_amazon-q-connect_CreateMessageTemplateVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplateVersion-request-messageTemplateContentSha256"></a>
The checksum value of the message template content that is referenced by the `$LATEST` qualifier. It can be returned in `MessageTemplateData` or `ExtendedMessageTemplateData`. It’s calculated by content, language, `defaultAttributes` and `Attachments` of the message template. If not supplied, the message template version will be created based on the message template content that is referenced by the `$LATEST` qualifier by default.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9]+`   
Required: No

## Response Syntax
<a name="API_amazon-q-connect_CreateMessageTemplateVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "messageTemplate": { 
      "attachments": [ 
         { 
            "attachmentId": "string",
            "contentDisposition": "string",
            "name": "string",
            "uploadedTime": "string",
            "url": "string",
            "urlExpiry": "string"
         }
      ],
      "attributeTypes": [ "string" ],
      "channel": "string",
      "channelSubtype": "string",
      "content": { ... },
      "createdTime": "string",
      "defaultAttributes": { 
         "agentAttributes": { 
            "firstName": "string",
            "lastName": "string"
         },
         "customAttributes": { 
            "string" : "string" 
         },
         "customerProfileAttributes": { 
            "accountNumber": "string",
            "additionalInformation": "string",
            "address1": "string",
            "address2": "string",
            "address3": "string",
            "address4": "string",
            "billingAddress1": "string",
            "billingAddress2": "string",
            "billingAddress3": "string",
            "billingAddress4": "string",
            "billingCity": "string",
            "billingCountry": "string",
            "billingCounty": "string",
            "billingPostalCode": "string",
            "billingProvince": "string",
            "billingState": "string",
            "birthDate": "string",
            "businessEmailAddress": "string",
            "businessName": "string",
            "businessPhoneNumber": "string",
            "city": "string",
            "country": "string",
            "county": "string",
            "custom": { 
               "string" : "string" 
            },
            "emailAddress": "string",
            "firstName": "string",
            "gender": "string",
            "homePhoneNumber": "string",
            "lastName": "string",
            "mailingAddress1": "string",
            "mailingAddress2": "string",
            "mailingAddress3": "string",
            "mailingAddress4": "string",
            "mailingCity": "string",
            "mailingCountry": "string",
            "mailingCounty": "string",
            "mailingPostalCode": "string",
            "mailingProvince": "string",
            "mailingState": "string",
            "middleName": "string",
            "mobilePhoneNumber": "string",
            "partyType": "string",
            "phoneNumber": "string",
            "postalCode": "string",
            "profileARN": "string",
            "profileId": "string",
            "province": "string",
            "shippingAddress1": "string",
            "shippingAddress2": "string",
            "shippingAddress3": "string",
            "shippingAddress4": "string",
            "shippingCity": "string",
            "shippingCountry": "string",
            "shippingCounty": "string",
            "shippingPostalCode": "string",
            "shippingProvince": "string",
            "shippingState": "string",
            "state": "string"
         },
         "systemAttributes": { 
            "customerEndpoint": { 
               "address": "string"
            },
            "name": "string",
            "systemEndpoint": { 
               "address": "string"
            }
         }
      },
      "description": "string",
      "groupingConfiguration": { 
         "criteria": "string",
         "values": [ "string" ]
      },
      "isActive": boolean,
      "knowledgeBaseArn": "string",
      "knowledgeBaseId": "string",
      "language": "string",
      "lastModifiedBy": "string",
      "lastModifiedTime": "string",
      "messageTemplateArn": "string",
      "messageTemplateContentSha256": "string",
      "messageTemplateId": "string",
      "name": "string",
      "sourceConfigurationSummary": { ... },
      "tags": { 
         "string" : "string" 
      },
      "versionNumber": number
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_CreateMessageTemplateVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [messageTemplate](#API_amazon-q-connect_CreateMessageTemplateVersion_ResponseSyntax) **   <a name="connect-amazon-q-connect_CreateMessageTemplateVersion-response-messageTemplate"></a>
The message template.  
Type: [ExtendedMessageTemplateData](API_amazon-q-connect_ExtendedMessageTemplateData.md) object

## Errors
<a name="API_amazon-q-connect_CreateMessageTemplateVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.  
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_CreateMessageTemplateVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/CreateMessageTemplateVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/CreateMessageTemplateVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/CreateMessageTemplateVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/CreateMessageTemplateVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/CreateMessageTemplateVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/CreateMessageTemplateVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/CreateMessageTemplateVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/CreateMessageTemplateVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/CreateMessageTemplateVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/CreateMessageTemplateVersion) 

# CreateQuickResponse
<a name="API_amazon-q-connect_CreateQuickResponse"></a>

Creates an Amazon Q in Connect quick response.

## Request Syntax
<a name="API_amazon-q-connect_CreateQuickResponse_RequestSyntax"></a>

```
POST /knowledgeBases/knowledgeBaseId/quickResponses HTTP/1.1
Content-type: application/json

{
   "channels": [ "string" ],
   "clientToken": "string",
   "content": { ... },
   "contentType": "string",
   "description": "string",
   "groupingConfiguration": { 
      "criteria": "string",
      "values": [ "string" ]
   },
   "isActive": boolean,
   "language": "string",
   "name": "string",
   "shortcutKey": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_CreateQuickResponse_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_CreateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateQuickResponse-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_CreateQuickResponse_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [channels](#API_amazon-q-connect_CreateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateQuickResponse-request-channels"></a>
The Amazon Connect channels this quick response applies to.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Required: No

 ** [clientToken](#API_amazon-q-connect_CreateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateQuickResponse-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [content](#API_amazon-q-connect_CreateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateQuickResponse-request-content"></a>
The content of the quick response.  
Type: [QuickResponseDataProvider](API_amazon-q-connect_QuickResponseDataProvider.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [contentType](#API_amazon-q-connect_CreateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateQuickResponse-request-contentType"></a>
The media type of the quick response content.  
+ Use `application/x.quickresponse;format=plain` for a quick response written in plain text.
+ Use `application/x.quickresponse;format=markdown` for a quick response written in richtext.
Type: String  
Pattern: `(application/x\.quickresponse;format=(plain|markdown))`   
Required: No

 ** [description](#API_amazon-q-connect_CreateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateQuickResponse-request-description"></a>
The description of the quick response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [groupingConfiguration](#API_amazon-q-connect_CreateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateQuickResponse-request-groupingConfiguration"></a>
The configuration information of the user groups that the quick response is accessible to.  
Type: [GroupingConfiguration](API_amazon-q-connect_GroupingConfiguration.md) object  
Required: No

 ** [isActive](#API_amazon-q-connect_CreateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateQuickResponse-request-isActive"></a>
Whether the quick response is active.  
Type: Boolean  
Required: No

 ** [language](#API_amazon-q-connect_CreateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateQuickResponse-request-language"></a>
The language code value for the language in which the quick response is written. The supported language codes include `de_DE`, `en_US`, `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`, `zh_CN`, `zh_TW`   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 5.  
Required: No

 ** [name](#API_amazon-q-connect_CreateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateQuickResponse-request-name"></a>
The name of the quick response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: Yes

 ** [shortcutKey](#API_amazon-q-connect_CreateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateQuickResponse-request-shortcutKey"></a>
The shortcut key of the quick response. The value should be unique across the knowledge base.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Required: No

 ** [tags](#API_amazon-q-connect_CreateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateQuickResponse-request-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_amazon-q-connect_CreateQuickResponse_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "quickResponse": { 
      "channels": [ "string" ],
      "contents": { 
         "markdown": { ... },
         "plainText": { ... }
      },
      "contentType": "string",
      "createdTime": number,
      "description": "string",
      "groupingConfiguration": { 
         "criteria": "string",
         "values": [ "string" ]
      },
      "isActive": boolean,
      "knowledgeBaseArn": "string",
      "knowledgeBaseId": "string",
      "language": "string",
      "lastModifiedBy": "string",
      "lastModifiedTime": number,
      "name": "string",
      "quickResponseArn": "string",
      "quickResponseId": "string",
      "shortcutKey": "string",
      "status": "string",
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_CreateQuickResponse_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [quickResponse](#API_amazon-q-connect_CreateQuickResponse_ResponseSyntax) **   <a name="connect-amazon-q-connect_CreateQuickResponse-response-quickResponse"></a>
The quick response.  
Type: [QuickResponseData](API_amazon-q-connect_QuickResponseData.md) object

## Errors
<a name="API_amazon-q-connect_CreateQuickResponse_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.  
HTTP Status Code: 402

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_CreateQuickResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/CreateQuickResponse) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/CreateQuickResponse) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/CreateQuickResponse) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/CreateQuickResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/CreateQuickResponse) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/CreateQuickResponse) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/CreateQuickResponse) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/CreateQuickResponse) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/CreateQuickResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/CreateQuickResponse) 

# CreateSession
<a name="API_amazon-q-connect_CreateSession"></a>

Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

## Request Syntax
<a name="API_amazon-q-connect_CreateSession_RequestSyntax"></a>

```
POST /assistants/assistantId/sessions HTTP/1.1
Content-type: application/json

{
   "aiAgentConfiguration": { 
      "string" : { 
         "aiAgentId": "string"
      }
   },
   "clientToken": "string",
   "contactArn": "string",
   "description": "string",
   "name": "string",
   "orchestratorConfigurationList": [ 
      { 
         "aiAgentId": "string",
         "orchestratorUseCase": "string"
      }
   ],
   "removeOrchestratorConfigurationList": boolean,
   "tagFilter": { ... },
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_CreateSession_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_CreateSession_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateSession-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_CreateSession_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [aiAgentConfiguration](#API_amazon-q-connect_CreateSession_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateSession-request-aiAgentConfiguration"></a>
The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.  
Type: String to [AIAgentConfigurationData](API_amazon-q-connect_AIAgentConfigurationData.md) object map  
Valid Keys: `MANUAL_SEARCH | ANSWER_RECOMMENDATION | SELF_SERVICE | EMAIL_RESPONSE | EMAIL_OVERVIEW | EMAIL_GENERATIVE_ANSWER | ORCHESTRATION | NOTE_TAKING | CASE_SUMMARIZATION`   
Required: No

 ** [clientToken](#API_amazon-q-connect_CreateSession_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateSession-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [contactArn](#API_amazon-q-connect_CreateSession_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateSession-request-contactArn"></a>
The Amazon Resource Name (ARN) of the email contact in Amazon Connect. Used to retrieve email content and establish session context for AI-powered email assistance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+`   
Required: No

 ** [description](#API_amazon-q-connect_CreateSession_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateSession-request-description"></a>
The description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** [name](#API_amazon-q-connect_CreateSession_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateSession-request-name"></a>
The name of the session.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: Yes

 ** [orchestratorConfigurationList](#API_amazon-q-connect_CreateSession_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateSession-request-orchestratorConfigurationList"></a>
The list of orchestrator configurations for the session being created.  
Type: Array of [OrchestratorConfigurationEntry](API_amazon-q-connect_OrchestratorConfigurationEntry.md) objects  
Required: No

 ** [removeOrchestratorConfigurationList](#API_amazon-q-connect_CreateSession_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateSession-request-removeOrchestratorConfigurationList"></a>
The list of orchestrator configurations to remove from the session.  
Type: Boolean  
Required: No

 ** [tagFilter](#API_amazon-q-connect_CreateSession_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateSession-request-tagFilter"></a>
An object that can be used to specify Tag conditions.   
Type: [TagFilter](API_amazon-q-connect_TagFilter.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [tags](#API_amazon-q-connect_CreateSession_RequestSyntax) **   <a name="connect-amazon-q-connect_CreateSession-request-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: No

## Response Syntax
<a name="API_amazon-q-connect_CreateSession_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "session": { 
      "aiAgentConfiguration": { 
         "string" : { 
            "aiAgentId": "string"
         }
      },
      "description": "string",
      "integrationConfiguration": { 
         "topicIntegrationArn": "string"
      },
      "name": "string",
      "orchestratorConfigurationList": [ 
         { 
            "aiAgentId": "string",
            "orchestratorUseCase": "string"
         }
      ],
      "origin": "string",
      "sessionArn": "string",
      "sessionId": "string",
      "tagFilter": { ... },
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_CreateSession_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [session](#API_amazon-q-connect_CreateSession_ResponseSyntax) **   <a name="connect-amazon-q-connect_CreateSession-response-session"></a>
The session.  
Type: [SessionData](API_amazon-q-connect_SessionData.md) object

## Errors
<a name="API_amazon-q-connect_CreateSession_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** DependencyFailedException **   
The request failed because it depends on another request that failed.  
HTTP Status Code: 424

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_CreateSession_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/CreateSession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/CreateSession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/CreateSession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/CreateSession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/CreateSession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/CreateSession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/CreateSession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/CreateSession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/CreateSession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/CreateSession) 

# DeactivateMessageTemplate
<a name="API_amazon-q-connect_DeactivateMessageTemplate"></a>

Deactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the `$ACTIVE_VERSION` qualifier to reference the version in active status.

## Request Syntax
<a name="API_amazon-q-connect_DeactivateMessageTemplate_RequestSyntax"></a>

```
POST /knowledgeBases/knowledgeBaseId/messageTemplates/messageTemplateId/deactivate HTTP/1.1
Content-type: application/json

{
   "versionNumber": number
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_DeactivateMessageTemplate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_DeactivateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_DeactivateMessageTemplate-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [messageTemplateId](#API_amazon-q-connect_DeactivateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_DeactivateMessageTemplate-request-uri-messageTemplateId"></a>
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_DeactivateMessageTemplate_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [versionNumber](#API_amazon-q-connect_DeactivateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_DeactivateMessageTemplate-request-versionNumber"></a>
The version number of the message template version to deactivate.  
Type: Long  
Valid Range: Minimum value of 1.  
Required: Yes

## Response Syntax
<a name="API_amazon-q-connect_DeactivateMessageTemplate_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "messageTemplateArn": "string",
   "messageTemplateId": "string",
   "versionNumber": number
}
```

## Response Elements
<a name="API_amazon-q-connect_DeactivateMessageTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [messageTemplateArn](#API_amazon-q-connect_DeactivateMessageTemplate_ResponseSyntax) **   <a name="connect-amazon-q-connect_DeactivateMessageTemplate-response-messageTemplateArn"></a>
The Amazon Resource Name (ARN) of the message template.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}` 

 ** [messageTemplateId](#API_amazon-q-connect_DeactivateMessageTemplate_ResponseSyntax) **   <a name="connect-amazon-q-connect_DeactivateMessageTemplate-response-messageTemplateId"></a>
The identifier of the message template.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [versionNumber](#API_amazon-q-connect_DeactivateMessageTemplate_ResponseSyntax) **   <a name="connect-amazon-q-connect_DeactivateMessageTemplate-response-versionNumber"></a>
The version number of the message template version that has been deactivated.  
Type: Long  
Valid Range: Minimum value of 1.

## Errors
<a name="API_amazon-q-connect_DeactivateMessageTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_DeactivateMessageTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/DeactivateMessageTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/DeactivateMessageTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/DeactivateMessageTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/DeactivateMessageTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/DeactivateMessageTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/DeactivateMessageTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/DeactivateMessageTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/DeactivateMessageTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/DeactivateMessageTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/DeactivateMessageTemplate) 

# DeleteAIAgent
<a name="API_amazon-q-connect_DeleteAIAgent"></a>

Deletes an Amazon Q in Connect AI Agent.

## Request Syntax
<a name="API_amazon-q-connect_DeleteAIAgent_RequestSyntax"></a>

```
DELETE /assistants/assistantId/aiagents/aiAgentId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_DeleteAIAgent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aiAgentId](#API_amazon-q-connect_DeleteAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteAIAgent-request-uri-aiAgentId"></a>
The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** [assistantId](#API_amazon-q-connect_DeleteAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteAIAgent-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_DeleteAIAgent_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_DeleteAIAgent_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_amazon-q-connect_DeleteAIAgent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_amazon-q-connect_DeleteAIAgent_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_DeleteAIAgent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/DeleteAIAgent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/DeleteAIAgent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/DeleteAIAgent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/DeleteAIAgent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/DeleteAIAgent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/DeleteAIAgent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/DeleteAIAgent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/DeleteAIAgent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/DeleteAIAgent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/DeleteAIAgent) 

# DeleteAIAgentVersion
<a name="API_amazon-q-connect_DeleteAIAgentVersion"></a>

Deletes an Amazon Q in Connect AI Agent Version.

## Request Syntax
<a name="API_amazon-q-connect_DeleteAIAgentVersion_RequestSyntax"></a>

```
DELETE /assistants/assistantId/aiagents/aiAgentId/versions/versionNumber HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_DeleteAIAgentVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aiAgentId](#API_amazon-q-connect_DeleteAIAgentVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteAIAgentVersion-request-uri-aiAgentId"></a>
The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** [assistantId](#API_amazon-q-connect_DeleteAIAgentVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteAIAgentVersion-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [versionNumber](#API_amazon-q-connect_DeleteAIAgentVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteAIAgentVersion-request-uri-versionNumber"></a>
The version number of the AI Agent version.  
Valid Range: Minimum value of 1.  
Required: Yes

## Request Body
<a name="API_amazon-q-connect_DeleteAIAgentVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_DeleteAIAgentVersion_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_amazon-q-connect_DeleteAIAgentVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_amazon-q-connect_DeleteAIAgentVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_DeleteAIAgentVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/DeleteAIAgentVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/DeleteAIAgentVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/DeleteAIAgentVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/DeleteAIAgentVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/DeleteAIAgentVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/DeleteAIAgentVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/DeleteAIAgentVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/DeleteAIAgentVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/DeleteAIAgentVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/DeleteAIAgentVersion) 

# DeleteAIGuardrail
<a name="API_amazon-q-connect_DeleteAIGuardrail"></a>

Deletes an Amazon Q in Connect AI Guardrail.

## Request Syntax
<a name="API_amazon-q-connect_DeleteAIGuardrail_RequestSyntax"></a>

```
DELETE /assistants/assistantId/aiguardrails/aiGuardrailId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_DeleteAIGuardrail_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aiGuardrailId](#API_amazon-q-connect_DeleteAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteAIGuardrail-request-uri-aiGuardrailId"></a>
The identifier of the Amazon Q in Connect AI Guardrail. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** [assistantId](#API_amazon-q-connect_DeleteAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteAIGuardrail-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_DeleteAIGuardrail_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_DeleteAIGuardrail_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_amazon-q-connect_DeleteAIGuardrail_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_amazon-q-connect_DeleteAIGuardrail_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_DeleteAIGuardrail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/DeleteAIGuardrail) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/DeleteAIGuardrail) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/DeleteAIGuardrail) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/DeleteAIGuardrail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/DeleteAIGuardrail) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/DeleteAIGuardrail) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/DeleteAIGuardrail) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/DeleteAIGuardrail) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/DeleteAIGuardrail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/DeleteAIGuardrail) 

# DeleteAIGuardrailVersion
<a name="API_amazon-q-connect_DeleteAIGuardrailVersion"></a>

Delete and Amazon Q in Connect AI Guardrail version.

## Request Syntax
<a name="API_amazon-q-connect_DeleteAIGuardrailVersion_RequestSyntax"></a>

```
DELETE /assistants/assistantId/aiguardrails/aiGuardrailId/versions/versionNumber HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_DeleteAIGuardrailVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aiGuardrailId](#API_amazon-q-connect_DeleteAIGuardrailVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteAIGuardrailVersion-request-uri-aiGuardrailId"></a>
The identifier of the Amazon Q in Connect AI Guardrail.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** [assistantId](#API_amazon-q-connect_DeleteAIGuardrailVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteAIGuardrailVersion-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [versionNumber](#API_amazon-q-connect_DeleteAIGuardrailVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteAIGuardrailVersion-request-uri-versionNumber"></a>
The version number of the AI Guardrail version to be deleted.  
Valid Range: Minimum value of 1.  
Required: Yes

## Request Body
<a name="API_amazon-q-connect_DeleteAIGuardrailVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_DeleteAIGuardrailVersion_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_amazon-q-connect_DeleteAIGuardrailVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_amazon-q-connect_DeleteAIGuardrailVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_DeleteAIGuardrailVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/DeleteAIGuardrailVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/DeleteAIGuardrailVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/DeleteAIGuardrailVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/DeleteAIGuardrailVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/DeleteAIGuardrailVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/DeleteAIGuardrailVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/DeleteAIGuardrailVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/DeleteAIGuardrailVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/DeleteAIGuardrailVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/DeleteAIGuardrailVersion) 

# DeleteAIPrompt
<a name="API_amazon-q-connect_DeleteAIPrompt"></a>

Deletes an Amazon Q in Connect AI Prompt.

## Request Syntax
<a name="API_amazon-q-connect_DeleteAIPrompt_RequestSyntax"></a>

```
DELETE /assistants/assistantId/aiprompts/aiPromptId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_DeleteAIPrompt_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aiPromptId](#API_amazon-q-connect_DeleteAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteAIPrompt-request-uri-aiPromptId"></a>
The identifier of the Amazon Q in Connect AI prompt. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** [assistantId](#API_amazon-q-connect_DeleteAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteAIPrompt-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_DeleteAIPrompt_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_DeleteAIPrompt_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_amazon-q-connect_DeleteAIPrompt_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_amazon-q-connect_DeleteAIPrompt_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_DeleteAIPrompt_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/DeleteAIPrompt) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/DeleteAIPrompt) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/DeleteAIPrompt) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/DeleteAIPrompt) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/DeleteAIPrompt) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/DeleteAIPrompt) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/DeleteAIPrompt) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/DeleteAIPrompt) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/DeleteAIPrompt) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/DeleteAIPrompt) 

# DeleteAIPromptVersion
<a name="API_amazon-q-connect_DeleteAIPromptVersion"></a>

Delete and Amazon Q in Connect AI Prompt version.

## Request Syntax
<a name="API_amazon-q-connect_DeleteAIPromptVersion_RequestSyntax"></a>

```
DELETE /assistants/assistantId/aiprompts/aiPromptId/versions/versionNumber HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_DeleteAIPromptVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aiPromptId](#API_amazon-q-connect_DeleteAIPromptVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteAIPromptVersion-request-uri-aiPromptId"></a>
The identifier of the Amazon Q in Connect AI prompt.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** [assistantId](#API_amazon-q-connect_DeleteAIPromptVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteAIPromptVersion-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [versionNumber](#API_amazon-q-connect_DeleteAIPromptVersion_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteAIPromptVersion-request-uri-versionNumber"></a>
The version number of the AI Prompt version to be deleted.  
Valid Range: Minimum value of 1.  
Required: Yes

## Request Body
<a name="API_amazon-q-connect_DeleteAIPromptVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_DeleteAIPromptVersion_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_amazon-q-connect_DeleteAIPromptVersion_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_amazon-q-connect_DeleteAIPromptVersion_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_DeleteAIPromptVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/DeleteAIPromptVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/DeleteAIPromptVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/DeleteAIPromptVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/DeleteAIPromptVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/DeleteAIPromptVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/DeleteAIPromptVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/DeleteAIPromptVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/DeleteAIPromptVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/DeleteAIPromptVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/DeleteAIPromptVersion) 

# DeleteAssistant
<a name="API_amazon-q-connect_DeleteAssistant"></a>

Deletes an assistant.

## Request Syntax
<a name="API_amazon-q-connect_DeleteAssistant_RequestSyntax"></a>

```
DELETE /assistants/assistantId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_DeleteAssistant_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_DeleteAssistant_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteAssistant-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_DeleteAssistant_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_DeleteAssistant_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_amazon-q-connect_DeleteAssistant_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_amazon-q-connect_DeleteAssistant_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_DeleteAssistant_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/DeleteAssistant) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/DeleteAssistant) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/DeleteAssistant) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/DeleteAssistant) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/DeleteAssistant) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/DeleteAssistant) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/DeleteAssistant) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/DeleteAssistant) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/DeleteAssistant) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/DeleteAssistant) 

# DeleteAssistantAssociation
<a name="API_amazon-q-connect_DeleteAssistantAssociation"></a>

Deletes an assistant association.

## Request Syntax
<a name="API_amazon-q-connect_DeleteAssistantAssociation_RequestSyntax"></a>

```
DELETE /assistants/assistantId/associations/assistantAssociationId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_DeleteAssistantAssociation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantAssociationId](#API_amazon-q-connect_DeleteAssistantAssociation_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteAssistantAssociation-request-uri-assistantAssociationId"></a>
The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [assistantId](#API_amazon-q-connect_DeleteAssistantAssociation_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteAssistantAssociation-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_DeleteAssistantAssociation_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_DeleteAssistantAssociation_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_amazon-q-connect_DeleteAssistantAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_amazon-q-connect_DeleteAssistantAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_DeleteAssistantAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/DeleteAssistantAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/DeleteAssistantAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/DeleteAssistantAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/DeleteAssistantAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/DeleteAssistantAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/DeleteAssistantAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/DeleteAssistantAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/DeleteAssistantAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/DeleteAssistantAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/DeleteAssistantAssociation) 

# DeleteContent
<a name="API_amazon-q-connect_DeleteContent"></a>

Deletes the content.

## Request Syntax
<a name="API_amazon-q-connect_DeleteContent_RequestSyntax"></a>

```
DELETE /knowledgeBases/knowledgeBaseId/contents/contentId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_DeleteContent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [contentId](#API_amazon-q-connect_DeleteContent_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteContent-request-uri-contentId"></a>
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [knowledgeBaseId](#API_amazon-q-connect_DeleteContent_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteContent-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_DeleteContent_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_DeleteContent_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_amazon-q-connect_DeleteContent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_amazon-q-connect_DeleteContent_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_DeleteContent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/DeleteContent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/DeleteContent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/DeleteContent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/DeleteContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/DeleteContent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/DeleteContent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/DeleteContent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/DeleteContent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/DeleteContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/DeleteContent) 

# DeleteContentAssociation
<a name="API_amazon-q-connect_DeleteContentAssociation"></a>

Deletes the content association. 

For more information about content associations--what they are and when they are used--see [Integrate Amazon Q in Connect with step-by-step guides](https://docs.aws.amazon.com/connect/latest/adminguide/integrate-q-with-guides.html) in the *Amazon Connect Administrator Guide*. 

## Request Syntax
<a name="API_amazon-q-connect_DeleteContentAssociation_RequestSyntax"></a>

```
DELETE /knowledgeBases/knowledgeBaseId/contents/contentId/associations/contentAssociationId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_DeleteContentAssociation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [contentAssociationId](#API_amazon-q-connect_DeleteContentAssociation_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteContentAssociation-request-uri-contentAssociationId"></a>
The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [contentId](#API_amazon-q-connect_DeleteContentAssociation_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteContentAssociation-request-uri-contentId"></a>
The identifier of the content.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [knowledgeBaseId](#API_amazon-q-connect_DeleteContentAssociation_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteContentAssociation-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_DeleteContentAssociation_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_DeleteContentAssociation_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_amazon-q-connect_DeleteContentAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_amazon-q-connect_DeleteContentAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_DeleteContentAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/DeleteContentAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/DeleteContentAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/DeleteContentAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/DeleteContentAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/DeleteContentAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/DeleteContentAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/DeleteContentAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/DeleteContentAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/DeleteContentAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/DeleteContentAssociation) 

# DeleteImportJob
<a name="API_amazon-q-connect_DeleteImportJob"></a>

Deletes the quick response import job.

## Request Syntax
<a name="API_amazon-q-connect_DeleteImportJob_RequestSyntax"></a>

```
DELETE /knowledgeBases/knowledgeBaseId/importJobs/importJobId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_DeleteImportJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [importJobId](#API_amazon-q-connect_DeleteImportJob_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteImportJob-request-uri-importJobId"></a>
The identifier of the import job to be deleted.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** [knowledgeBaseId](#API_amazon-q-connect_DeleteImportJob_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteImportJob-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_DeleteImportJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_DeleteImportJob_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_amazon-q-connect_DeleteImportJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_amazon-q-connect_DeleteImportJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_DeleteImportJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/DeleteImportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/DeleteImportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/DeleteImportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/DeleteImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/DeleteImportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/DeleteImportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/DeleteImportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/DeleteImportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/DeleteImportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/DeleteImportJob) 

# DeleteKnowledgeBase
<a name="API_amazon-q-connect_DeleteKnowledgeBase"></a>

Deletes the knowledge base.

**Note**  
When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the [Amazon AppIntegrations](https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html) DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See [DeleteDataIntegration](https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html) and [CreateDataIntegration](https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html) in the *Amazon AppIntegrations API Reference*.

## Request Syntax
<a name="API_amazon-q-connect_DeleteKnowledgeBase_RequestSyntax"></a>

```
DELETE /knowledgeBases/knowledgeBaseId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_DeleteKnowledgeBase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_DeleteKnowledgeBase_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteKnowledgeBase-request-uri-knowledgeBaseId"></a>
The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_DeleteKnowledgeBase_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_DeleteKnowledgeBase_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_amazon-q-connect_DeleteKnowledgeBase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_amazon-q-connect_DeleteKnowledgeBase_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_DeleteKnowledgeBase_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/DeleteKnowledgeBase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/DeleteKnowledgeBase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/DeleteKnowledgeBase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/DeleteKnowledgeBase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/DeleteKnowledgeBase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/DeleteKnowledgeBase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/DeleteKnowledgeBase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/DeleteKnowledgeBase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/DeleteKnowledgeBase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/DeleteKnowledgeBase) 

# DeleteMessageTemplate
<a name="API_amazon-q-connect_DeleteMessageTemplate"></a>

Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request. You can provide the message template identifier as `<message-template-id>:<versionNumber>` to delete a specific version of the message template. If it is not supplied, the message template and all available versions will be deleted.

## Request Syntax
<a name="API_amazon-q-connect_DeleteMessageTemplate_RequestSyntax"></a>

```
DELETE /knowledgeBases/knowledgeBaseId/messageTemplates/messageTemplateId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_DeleteMessageTemplate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_DeleteMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteMessageTemplate-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [messageTemplateId](#API_amazon-q-connect_DeleteMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteMessageTemplate-request-uri-messageTemplateId"></a>
The identifier of the message template. Can be either the ID or the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_DeleteMessageTemplate_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_DeleteMessageTemplate_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_amazon-q-connect_DeleteMessageTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_amazon-q-connect_DeleteMessageTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_DeleteMessageTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/DeleteMessageTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/DeleteMessageTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/DeleteMessageTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/DeleteMessageTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/DeleteMessageTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/DeleteMessageTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/DeleteMessageTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/DeleteMessageTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/DeleteMessageTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/DeleteMessageTemplate) 

# DeleteMessageTemplateAttachment
<a name="API_amazon-q-connect_DeleteMessageTemplateAttachment"></a>

Deletes the attachment file from the Amazon Q in Connect message template that is referenced by `$LATEST` qualifier. Attachments on available message template versions will remain unchanged.

## Request Syntax
<a name="API_amazon-q-connect_DeleteMessageTemplateAttachment_RequestSyntax"></a>

```
DELETE /knowledgeBases/knowledgeBaseId/messageTemplates/messageTemplateId/attachments/attachmentId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_DeleteMessageTemplateAttachment_RequestParameters"></a>

The request uses the following URI parameters.

 ** [attachmentId](#API_amazon-q-connect_DeleteMessageTemplateAttachment_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteMessageTemplateAttachment-request-uri-attachmentId"></a>
The identifier of the attachment file.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** [knowledgeBaseId](#API_amazon-q-connect_DeleteMessageTemplateAttachment_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteMessageTemplateAttachment-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [messageTemplateId](#API_amazon-q-connect_DeleteMessageTemplateAttachment_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteMessageTemplateAttachment-request-uri-messageTemplateId"></a>
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_DeleteMessageTemplateAttachment_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_DeleteMessageTemplateAttachment_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_amazon-q-connect_DeleteMessageTemplateAttachment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_amazon-q-connect_DeleteMessageTemplateAttachment_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_DeleteMessageTemplateAttachment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/DeleteMessageTemplateAttachment) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/DeleteMessageTemplateAttachment) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/DeleteMessageTemplateAttachment) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/DeleteMessageTemplateAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/DeleteMessageTemplateAttachment) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/DeleteMessageTemplateAttachment) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/DeleteMessageTemplateAttachment) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/DeleteMessageTemplateAttachment) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/DeleteMessageTemplateAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/DeleteMessageTemplateAttachment) 

# DeleteQuickResponse
<a name="API_amazon-q-connect_DeleteQuickResponse"></a>

Deletes a quick response.

## Request Syntax
<a name="API_amazon-q-connect_DeleteQuickResponse_RequestSyntax"></a>

```
DELETE /knowledgeBases/knowledgeBaseId/quickResponses/quickResponseId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_DeleteQuickResponse_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_DeleteQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteQuickResponse-request-uri-knowledgeBaseId"></a>
The knowledge base from which the quick response is deleted. The identifier of the knowledge base.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [quickResponseId](#API_amazon-q-connect_DeleteQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_DeleteQuickResponse-request-uri-quickResponseId"></a>
The identifier of the quick response to delete.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_DeleteQuickResponse_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_DeleteQuickResponse_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_amazon-q-connect_DeleteQuickResponse_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_amazon-q-connect_DeleteQuickResponse_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_DeleteQuickResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/DeleteQuickResponse) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/DeleteQuickResponse) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/DeleteQuickResponse) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/DeleteQuickResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/DeleteQuickResponse) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/DeleteQuickResponse) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/DeleteQuickResponse) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/DeleteQuickResponse) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/DeleteQuickResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/DeleteQuickResponse) 

# GetAIAgent
<a name="API_amazon-q-connect_GetAIAgent"></a>

Gets an Amazon Q in Connect AI Agent.

## Request Syntax
<a name="API_amazon-q-connect_GetAIAgent_RequestSyntax"></a>

```
GET /assistants/assistantId/aiagents/aiAgentId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_GetAIAgent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aiAgentId](#API_amazon-q-connect_GetAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_GetAIAgent-request-uri-aiAgentId"></a>
The identifier of the Amazon Q in Connect AI Agent (with or without a version qualifier). Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** [assistantId](#API_amazon-q-connect_GetAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_GetAIAgent-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_GetAIAgent_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_GetAIAgent_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "aiAgent": { 
      "aiAgentArn": "string",
      "aiAgentId": "string",
      "assistantArn": "string",
      "assistantId": "string",
      "configuration": { ... },
      "description": "string",
      "modifiedTime": number,
      "name": "string",
      "origin": "string",
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "type": "string",
      "visibilityStatus": "string"
   },
   "versionNumber": number
}
```

## Response Elements
<a name="API_amazon-q-connect_GetAIAgent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [aiAgent](#API_amazon-q-connect_GetAIAgent_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetAIAgent-response-aiAgent"></a>
The data of the AI Agent.  
Type: [AIAgentData](API_amazon-q-connect_AIAgentData.md) object

 ** [versionNumber](#API_amazon-q-connect_GetAIAgent_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetAIAgent-response-versionNumber"></a>
The version number of the AI Agent version (returned if an AI Agent version was specified via use of a qualifier for the `aiAgentId` on the request).   
Type: Long  
Valid Range: Minimum value of 1.

## Errors
<a name="API_amazon-q-connect_GetAIAgent_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_GetAIAgent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/GetAIAgent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/GetAIAgent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GetAIAgent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/GetAIAgent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GetAIAgent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/GetAIAgent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/GetAIAgent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/GetAIAgent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/GetAIAgent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GetAIAgent) 

# GetAIGuardrail
<a name="API_amazon-q-connect_GetAIGuardrail"></a>

Gets the Amazon Q in Connect AI Guardrail.

## Request Syntax
<a name="API_amazon-q-connect_GetAIGuardrail_RequestSyntax"></a>

```
GET /assistants/assistantId/aiguardrails/aiGuardrailId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_GetAIGuardrail_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aiGuardrailId](#API_amazon-q-connect_GetAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_GetAIGuardrail-request-uri-aiGuardrailId"></a>
The identifier of the Amazon Q in Connect AI Guardrail.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** [assistantId](#API_amazon-q-connect_GetAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_GetAIGuardrail-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_GetAIGuardrail_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_GetAIGuardrail_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "aiGuardrail": { 
      "aiGuardrailArn": "string",
      "aiGuardrailId": "string",
      "assistantArn": "string",
      "assistantId": "string",
      "blockedInputMessaging": "string",
      "blockedOutputsMessaging": "string",
      "contentPolicyConfig": { 
         "filtersConfig": [ 
            { 
               "inputStrength": "string",
               "outputStrength": "string",
               "type": "string"
            }
         ]
      },
      "contextualGroundingPolicyConfig": { 
         "filtersConfig": [ 
            { 
               "threshold": number,
               "type": "string"
            }
         ]
      },
      "description": "string",
      "modifiedTime": number,
      "name": "string",
      "sensitiveInformationPolicyConfig": { 
         "piiEntitiesConfig": [ 
            { 
               "action": "string",
               "type": "string"
            }
         ],
         "regexesConfig": [ 
            { 
               "action": "string",
               "description": "string",
               "name": "string",
               "pattern": "string"
            }
         ]
      },
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "topicPolicyConfig": { 
         "topicsConfig": [ 
            { 
               "definition": "string",
               "examples": [ "string" ],
               "name": "string",
               "type": "string"
            }
         ]
      },
      "visibilityStatus": "string",
      "wordPolicyConfig": { 
         "managedWordListsConfig": [ 
            { 
               "type": "string"
            }
         ],
         "wordsConfig": [ 
            { 
               "text": "string"
            }
         ]
      }
   },
   "versionNumber": number
}
```

## Response Elements
<a name="API_amazon-q-connect_GetAIGuardrail_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [aiGuardrail](#API_amazon-q-connect_GetAIGuardrail_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetAIGuardrail-response-aiGuardrail"></a>
The data of the AI Guardrail.  
Type: [AIGuardrailData](API_amazon-q-connect_AIGuardrailData.md) object

 ** [versionNumber](#API_amazon-q-connect_GetAIGuardrail_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetAIGuardrail-response-versionNumber"></a>
The version number of the AI Guardrail version (returned if an AI Guardrail version was specified via use of a qualifier for the `aiGuardrailId` on the request).   
Type: Long  
Valid Range: Minimum value of 1.

## Errors
<a name="API_amazon-q-connect_GetAIGuardrail_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_GetAIGuardrail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/GetAIGuardrail) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/GetAIGuardrail) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GetAIGuardrail) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/GetAIGuardrail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GetAIGuardrail) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/GetAIGuardrail) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/GetAIGuardrail) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/GetAIGuardrail) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/GetAIGuardrail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GetAIGuardrail) 

# GetAIPrompt
<a name="API_amazon-q-connect_GetAIPrompt"></a>

Gets and Amazon Q in Connect AI Prompt.

## Request Syntax
<a name="API_amazon-q-connect_GetAIPrompt_RequestSyntax"></a>

```
GET /assistants/assistantId/aiprompts/aiPromptId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_GetAIPrompt_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aiPromptId](#API_amazon-q-connect_GetAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_GetAIPrompt-request-uri-aiPromptId"></a>
The identifier of the Amazon Q in Connect AI prompt.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** [assistantId](#API_amazon-q-connect_GetAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_GetAIPrompt-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_GetAIPrompt_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_GetAIPrompt_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "aiPrompt": { 
      "aiPromptArn": "string",
      "aiPromptId": "string",
      "apiFormat": "string",
      "assistantArn": "string",
      "assistantId": "string",
      "description": "string",
      "inferenceConfiguration": { ... },
      "modelId": "string",
      "modifiedTime": number,
      "name": "string",
      "origin": "string",
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "templateConfiguration": { ... },
      "templateType": "string",
      "type": "string",
      "visibilityStatus": "string"
   },
   "versionNumber": number
}
```

## Response Elements
<a name="API_amazon-q-connect_GetAIPrompt_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [aiPrompt](#API_amazon-q-connect_GetAIPrompt_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetAIPrompt-response-aiPrompt"></a>
The data of the AI Prompt.  
Type: [AIPromptData](API_amazon-q-connect_AIPromptData.md) object

 ** [versionNumber](#API_amazon-q-connect_GetAIPrompt_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetAIPrompt-response-versionNumber"></a>
The version number of the AI Prompt version (returned if an AI Prompt version was specified via use of a qualifier for the `aiPromptId` on the request).   
Type: Long  
Valid Range: Minimum value of 1.

## Errors
<a name="API_amazon-q-connect_GetAIPrompt_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_GetAIPrompt_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/GetAIPrompt) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/GetAIPrompt) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GetAIPrompt) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/GetAIPrompt) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GetAIPrompt) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/GetAIPrompt) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/GetAIPrompt) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/GetAIPrompt) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/GetAIPrompt) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GetAIPrompt) 

# GetAssistant
<a name="API_amazon-q-connect_GetAssistant"></a>

Retrieves information about an assistant.

## Request Syntax
<a name="API_amazon-q-connect_GetAssistant_RequestSyntax"></a>

```
GET /assistants/assistantId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_GetAssistant_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_GetAssistant_RequestSyntax) **   <a name="connect-amazon-q-connect_GetAssistant-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_GetAssistant_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_GetAssistant_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assistant": { 
      "aiAgentConfiguration": { 
         "string" : { 
            "aiAgentId": "string"
         }
      },
      "assistantArn": "string",
      "assistantId": "string",
      "capabilityConfiguration": { 
         "type": "string"
      },
      "description": "string",
      "integrationConfiguration": { 
         "topicIntegrationArn": "string"
      },
      "name": "string",
      "orchestratorConfigurationList": [ 
         { 
            "aiAgentId": "string",
            "orchestratorUseCase": "string"
         }
      ],
      "serverSideEncryptionConfiguration": { 
         "kmsKeyId": "string"
      },
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "type": "string"
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_GetAssistant_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assistant](#API_amazon-q-connect_GetAssistant_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetAssistant-response-assistant"></a>
Information about the assistant.  
Type: [AssistantData](API_amazon-q-connect_AssistantData.md) object

## Errors
<a name="API_amazon-q-connect_GetAssistant_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_GetAssistant_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/GetAssistant) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/GetAssistant) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GetAssistant) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/GetAssistant) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GetAssistant) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/GetAssistant) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/GetAssistant) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/GetAssistant) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/GetAssistant) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GetAssistant) 

# GetAssistantAssociation
<a name="API_amazon-q-connect_GetAssistantAssociation"></a>

Retrieves information about an assistant association.

## Request Syntax
<a name="API_amazon-q-connect_GetAssistantAssociation_RequestSyntax"></a>

```
GET /assistants/assistantId/associations/assistantAssociationId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_GetAssistantAssociation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantAssociationId](#API_amazon-q-connect_GetAssistantAssociation_RequestSyntax) **   <a name="connect-amazon-q-connect_GetAssistantAssociation-request-uri-assistantAssociationId"></a>
The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [assistantId](#API_amazon-q-connect_GetAssistantAssociation_RequestSyntax) **   <a name="connect-amazon-q-connect_GetAssistantAssociation-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_GetAssistantAssociation_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_GetAssistantAssociation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assistantAssociation": { 
      "assistantArn": "string",
      "assistantAssociationArn": "string",
      "assistantAssociationId": "string",
      "assistantId": "string",
      "associationData": { ... },
      "associationType": "string",
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_GetAssistantAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assistantAssociation](#API_amazon-q-connect_GetAssistantAssociation_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetAssistantAssociation-response-assistantAssociation"></a>
The assistant association.  
Type: [AssistantAssociationData](API_amazon-q-connect_AssistantAssociationData.md) object

## Errors
<a name="API_amazon-q-connect_GetAssistantAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_GetAssistantAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/GetAssistantAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/GetAssistantAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GetAssistantAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/GetAssistantAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GetAssistantAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/GetAssistantAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/GetAssistantAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/GetAssistantAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/GetAssistantAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GetAssistantAssociation) 

# GetContent
<a name="API_amazon-q-connect_GetContent"></a>

Retrieves content, including a pre-signed URL to download the content.

## Request Syntax
<a name="API_amazon-q-connect_GetContent_RequestSyntax"></a>

```
GET /knowledgeBases/knowledgeBaseId/contents/contentId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_GetContent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [contentId](#API_amazon-q-connect_GetContent_RequestSyntax) **   <a name="connect-amazon-q-connect_GetContent-request-uri-contentId"></a>
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [knowledgeBaseId](#API_amazon-q-connect_GetContent_RequestSyntax) **   <a name="connect-amazon-q-connect_GetContent-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. This should not be a QUICK\$1RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_GetContent_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_GetContent_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "content": { 
      "contentArn": "string",
      "contentId": "string",
      "contentType": "string",
      "knowledgeBaseArn": "string",
      "knowledgeBaseId": "string",
      "linkOutUri": "string",
      "metadata": { 
         "string" : "string" 
      },
      "name": "string",
      "revisionId": "string",
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "title": "string",
      "url": "string",
      "urlExpiry": number
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_GetContent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [content](#API_amazon-q-connect_GetContent_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetContent-response-content"></a>
The content.  
Type: [ContentData](API_amazon-q-connect_ContentData.md) object

## Errors
<a name="API_amazon-q-connect_GetContent_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_GetContent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/GetContent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/GetContent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GetContent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/GetContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GetContent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/GetContent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/GetContent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/GetContent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/GetContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GetContent) 

# GetContentAssociation
<a name="API_amazon-q-connect_GetContentAssociation"></a>

Returns the content association.

For more information about content associations--what they are and when they are used--see [Integrate Amazon Q in Connect with step-by-step guides](https://docs.aws.amazon.com/connect/latest/adminguide/integrate-q-with-guides.html) in the *Amazon Connect Administrator Guide*.

## Request Syntax
<a name="API_amazon-q-connect_GetContentAssociation_RequestSyntax"></a>

```
GET /knowledgeBases/knowledgeBaseId/contents/contentId/associations/contentAssociationId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_GetContentAssociation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [contentAssociationId](#API_amazon-q-connect_GetContentAssociation_RequestSyntax) **   <a name="connect-amazon-q-connect_GetContentAssociation-request-uri-contentAssociationId"></a>
The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [contentId](#API_amazon-q-connect_GetContentAssociation_RequestSyntax) **   <a name="connect-amazon-q-connect_GetContentAssociation-request-uri-contentId"></a>
The identifier of the content.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [knowledgeBaseId](#API_amazon-q-connect_GetContentAssociation_RequestSyntax) **   <a name="connect-amazon-q-connect_GetContentAssociation-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_GetContentAssociation_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_GetContentAssociation_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "contentAssociation": { 
      "associationData": { ... },
      "associationType": "string",
      "contentArn": "string",
      "contentAssociationArn": "string",
      "contentAssociationId": "string",
      "contentId": "string",
      "knowledgeBaseArn": "string",
      "knowledgeBaseId": "string",
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_GetContentAssociation_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [contentAssociation](#API_amazon-q-connect_GetContentAssociation_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetContentAssociation-response-contentAssociation"></a>
The association between Amazon Q in Connect content and another resource.  
Type: [ContentAssociationData](API_amazon-q-connect_ContentAssociationData.md) object

## Errors
<a name="API_amazon-q-connect_GetContentAssociation_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_GetContentAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/GetContentAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/GetContentAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GetContentAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/GetContentAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GetContentAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/GetContentAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/GetContentAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/GetContentAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/GetContentAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GetContentAssociation) 

# GetContentSummary
<a name="API_amazon-q-connect_GetContentSummary"></a>

Retrieves summary information about the content.

## Request Syntax
<a name="API_amazon-q-connect_GetContentSummary_RequestSyntax"></a>

```
GET /knowledgeBases/knowledgeBaseId/contents/contentId/summary HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_GetContentSummary_RequestParameters"></a>

The request uses the following URI parameters.

 ** [contentId](#API_amazon-q-connect_GetContentSummary_RequestSyntax) **   <a name="connect-amazon-q-connect_GetContentSummary-request-uri-contentId"></a>
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [knowledgeBaseId](#API_amazon-q-connect_GetContentSummary_RequestSyntax) **   <a name="connect-amazon-q-connect_GetContentSummary-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_GetContentSummary_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_GetContentSummary_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "contentSummary": { 
      "contentArn": "string",
      "contentId": "string",
      "contentType": "string",
      "knowledgeBaseArn": "string",
      "knowledgeBaseId": "string",
      "metadata": { 
         "string" : "string" 
      },
      "name": "string",
      "revisionId": "string",
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "title": "string"
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_GetContentSummary_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [contentSummary](#API_amazon-q-connect_GetContentSummary_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetContentSummary-response-contentSummary"></a>
The content summary.  
Type: [ContentSummary](API_amazon-q-connect_ContentSummary.md) object

## Errors
<a name="API_amazon-q-connect_GetContentSummary_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_GetContentSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/GetContentSummary) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/GetContentSummary) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GetContentSummary) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/GetContentSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GetContentSummary) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/GetContentSummary) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/GetContentSummary) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/GetContentSummary) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/GetContentSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GetContentSummary) 

# GetImportJob
<a name="API_amazon-q-connect_GetImportJob"></a>

Retrieves the started import job.

## Request Syntax
<a name="API_amazon-q-connect_GetImportJob_RequestSyntax"></a>

```
GET /knowledgeBases/knowledgeBaseId/importJobs/importJobId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_GetImportJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [importJobId](#API_amazon-q-connect_GetImportJob_RequestSyntax) **   <a name="connect-amazon-q-connect_GetImportJob-request-uri-importJobId"></a>
The identifier of the import job to retrieve.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** [knowledgeBaseId](#API_amazon-q-connect_GetImportJob_RequestSyntax) **   <a name="connect-amazon-q-connect_GetImportJob-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base that the import job belongs to.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_GetImportJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_GetImportJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "importJob": { 
      "createdTime": number,
      "externalSourceConfiguration": { 
         "configuration": { ... },
         "source": "string"
      },
      "failedRecordReport": "string",
      "importJobId": "string",
      "importJobType": "string",
      "knowledgeBaseArn": "string",
      "knowledgeBaseId": "string",
      "lastModifiedTime": number,
      "metadata": { 
         "string" : "string" 
      },
      "status": "string",
      "uploadId": "string",
      "url": "string",
      "urlExpiry": number
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_GetImportJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [importJob](#API_amazon-q-connect_GetImportJob_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetImportJob-response-importJob"></a>
The import job.  
Type: [ImportJobData](API_amazon-q-connect_ImportJobData.md) object

## Errors
<a name="API_amazon-q-connect_GetImportJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_GetImportJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/GetImportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/GetImportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GetImportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/GetImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GetImportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/GetImportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/GetImportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/GetImportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/GetImportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GetImportJob) 

# GetKnowledgeBase
<a name="API_amazon-q-connect_GetKnowledgeBase"></a>

Retrieves information about the knowledge base.

## Request Syntax
<a name="API_amazon-q-connect_GetKnowledgeBase_RequestSyntax"></a>

```
GET /knowledgeBases/knowledgeBaseId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_GetKnowledgeBase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_GetKnowledgeBase_RequestSyntax) **   <a name="connect-amazon-q-connect_GetKnowledgeBase-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_GetKnowledgeBase_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_GetKnowledgeBase_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "knowledgeBase": { 
      "description": "string",
      "ingestionFailureReasons": [ "string" ],
      "ingestionStatus": "string",
      "knowledgeBaseArn": "string",
      "knowledgeBaseId": "string",
      "knowledgeBaseType": "string",
      "lastContentModificationTime": number,
      "name": "string",
      "renderingConfiguration": { 
         "templateUri": "string"
      },
      "serverSideEncryptionConfiguration": { 
         "kmsKeyId": "string"
      },
      "sourceConfiguration": { ... },
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "vectorIngestionConfiguration": { 
         "chunkingConfiguration": { 
            "chunkingStrategy": "string",
            "fixedSizeChunkingConfiguration": { 
               "maxTokens": number,
               "overlapPercentage": number
            },
            "hierarchicalChunkingConfiguration": { 
               "levelConfigurations": [ 
                  { 
                     "maxTokens": number
                  }
               ],
               "overlapTokens": number
            },
            "semanticChunkingConfiguration": { 
               "breakpointPercentileThreshold": number,
               "bufferSize": number,
               "maxTokens": number
            }
         },
         "parsingConfiguration": { 
            "bedrockFoundationModelConfiguration": { 
               "modelArn": "string",
               "parsingPrompt": { 
                  "parsingPromptText": "string"
               }
            },
            "parsingStrategy": "string"
         }
      }
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_GetKnowledgeBase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [knowledgeBase](#API_amazon-q-connect_GetKnowledgeBase_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetKnowledgeBase-response-knowledgeBase"></a>
The knowledge base.  
Type: [KnowledgeBaseData](API_amazon-q-connect_KnowledgeBaseData.md) object

## Errors
<a name="API_amazon-q-connect_GetKnowledgeBase_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_GetKnowledgeBase_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/GetKnowledgeBase) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/GetKnowledgeBase) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GetKnowledgeBase) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/GetKnowledgeBase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GetKnowledgeBase) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/GetKnowledgeBase) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/GetKnowledgeBase) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/GetKnowledgeBase) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/GetKnowledgeBase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GetKnowledgeBase) 

# GetMessageTemplate
<a name="API_amazon-q-connect_GetMessageTemplate"></a>

Retrieves the Amazon Q in Connect message template. The message template identifier can contain an optional qualifier, for example, `<message-template-id>:<qualifier>`, which is either an actual version number or an Amazon Q Connect managed qualifier `$ACTIVE_VERSION` \$1 `$LATEST`. If it is not supplied, then `$LATEST` is assumed implicitly.

## Request Syntax
<a name="API_amazon-q-connect_GetMessageTemplate_RequestSyntax"></a>

```
GET /knowledgeBases/knowledgeBaseId/messageTemplates/messageTemplateId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_GetMessageTemplate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_GetMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_GetMessageTemplate-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [messageTemplateId](#API_amazon-q-connect_GetMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_GetMessageTemplate-request-uri-messageTemplateId"></a>
The identifier of the message template. Can be either the ID or the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_GetMessageTemplate_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_GetMessageTemplate_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "messageTemplate": { 
      "attachments": [ 
         { 
            "attachmentId": "string",
            "contentDisposition": "string",
            "name": "string",
            "uploadedTime": "string",
            "url": "string",
            "urlExpiry": "string"
         }
      ],
      "attributeTypes": [ "string" ],
      "channel": "string",
      "channelSubtype": "string",
      "content": { ... },
      "createdTime": "string",
      "defaultAttributes": { 
         "agentAttributes": { 
            "firstName": "string",
            "lastName": "string"
         },
         "customAttributes": { 
            "string" : "string" 
         },
         "customerProfileAttributes": { 
            "accountNumber": "string",
            "additionalInformation": "string",
            "address1": "string",
            "address2": "string",
            "address3": "string",
            "address4": "string",
            "billingAddress1": "string",
            "billingAddress2": "string",
            "billingAddress3": "string",
            "billingAddress4": "string",
            "billingCity": "string",
            "billingCountry": "string",
            "billingCounty": "string",
            "billingPostalCode": "string",
            "billingProvince": "string",
            "billingState": "string",
            "birthDate": "string",
            "businessEmailAddress": "string",
            "businessName": "string",
            "businessPhoneNumber": "string",
            "city": "string",
            "country": "string",
            "county": "string",
            "custom": { 
               "string" : "string" 
            },
            "emailAddress": "string",
            "firstName": "string",
            "gender": "string",
            "homePhoneNumber": "string",
            "lastName": "string",
            "mailingAddress1": "string",
            "mailingAddress2": "string",
            "mailingAddress3": "string",
            "mailingAddress4": "string",
            "mailingCity": "string",
            "mailingCountry": "string",
            "mailingCounty": "string",
            "mailingPostalCode": "string",
            "mailingProvince": "string",
            "mailingState": "string",
            "middleName": "string",
            "mobilePhoneNumber": "string",
            "partyType": "string",
            "phoneNumber": "string",
            "postalCode": "string",
            "profileARN": "string",
            "profileId": "string",
            "province": "string",
            "shippingAddress1": "string",
            "shippingAddress2": "string",
            "shippingAddress3": "string",
            "shippingAddress4": "string",
            "shippingCity": "string",
            "shippingCountry": "string",
            "shippingCounty": "string",
            "shippingPostalCode": "string",
            "shippingProvince": "string",
            "shippingState": "string",
            "state": "string"
         },
         "systemAttributes": { 
            "customerEndpoint": { 
               "address": "string"
            },
            "name": "string",
            "systemEndpoint": { 
               "address": "string"
            }
         }
      },
      "description": "string",
      "groupingConfiguration": { 
         "criteria": "string",
         "values": [ "string" ]
      },
      "isActive": boolean,
      "knowledgeBaseArn": "string",
      "knowledgeBaseId": "string",
      "language": "string",
      "lastModifiedBy": "string",
      "lastModifiedTime": "string",
      "messageTemplateArn": "string",
      "messageTemplateContentSha256": "string",
      "messageTemplateId": "string",
      "name": "string",
      "sourceConfigurationSummary": { ... },
      "tags": { 
         "string" : "string" 
      },
      "versionNumber": number
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_GetMessageTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [messageTemplate](#API_amazon-q-connect_GetMessageTemplate_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetMessageTemplate-response-messageTemplate"></a>
The message template.  
Type: [ExtendedMessageTemplateData](API_amazon-q-connect_ExtendedMessageTemplateData.md) object

## Errors
<a name="API_amazon-q-connect_GetMessageTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_GetMessageTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/GetMessageTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/GetMessageTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GetMessageTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/GetMessageTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GetMessageTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/GetMessageTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/GetMessageTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/GetMessageTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/GetMessageTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GetMessageTemplate) 

# GetNextMessage
<a name="API_amazon-q-connect_GetNextMessage"></a>

Retrieves next message on an Amazon Q in Connect session.

## Request Syntax
<a name="API_amazon-q-connect_GetNextMessage_RequestSyntax"></a>

```
GET /assistants/assistantId/sessions/sessionId/messages/next?nextMessageToken=nextMessageToken HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_GetNextMessage_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_GetNextMessage_RequestSyntax) **   <a name="connect-amazon-q-connect_GetNextMessage-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [nextMessageToken](#API_amazon-q-connect_GetNextMessage_RequestSyntax) **   <a name="connect-amazon-q-connect_GetNextMessage-request-uri-nextMessageToken"></a>
The token for the next message. Use the value returned in the SendMessage or previous response in the next request to retrieve the next message.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

 ** [sessionId](#API_amazon-q-connect_GetNextMessage_RequestSyntax) **   <a name="connect-amazon-q-connect_GetNextMessage-request-uri-sessionId"></a>
The identifier of the Amazon Q in Connect session.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_GetNextMessage_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_GetNextMessage_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "chunkedResponseTerminated": boolean,
   "conversationSessionData": [ 
      { 
         "key": "string",
         "value": { ... }
      }
   ],
   "conversationState": { 
      "reason": "string",
      "status": "string"
   },
   "nextMessageToken": "string",
   "requestMessageId": "string",
   "response": { 
      "messageId": "string",
      "participant": "string",
      "timestamp": number,
      "value": { ... }
   },
   "type": "string"
}
```

## Response Elements
<a name="API_amazon-q-connect_GetNextMessage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [chunkedResponseTerminated](#API_amazon-q-connect_GetNextMessage_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetNextMessage-response-chunkedResponseTerminated"></a>
Indicates whether the chunked response has been terminated.  
Type: Boolean

 ** [conversationSessionData](#API_amazon-q-connect_GetNextMessage_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetNextMessage-response-conversationSessionData"></a>
The conversation data stored on an Amazon Q in Connect Session.  
Type: Array of [RuntimeSessionData](API_amazon-q-connect_RuntimeSessionData.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.

 ** [conversationState](#API_amazon-q-connect_GetNextMessage_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetNextMessage-response-conversationState"></a>
The state of current conversation.  
Type: [ConversationState](API_amazon-q-connect_ConversationState.md) object

 ** [nextMessageToken](#API_amazon-q-connect_GetNextMessage_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetNextMessage-response-nextMessageToken"></a>
The token for the next message.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [requestMessageId](#API_amazon-q-connect_GetNextMessage_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetNextMessage-response-requestMessageId"></a>
The identifier of the submitted message.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [response](#API_amazon-q-connect_GetNextMessage_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetNextMessage-response-response"></a>
The message response to the requested message.  
Type: [MessageOutput](API_amazon-q-connect_MessageOutput.md) object

 ** [type](#API_amazon-q-connect_GetNextMessage_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetNextMessage-response-type"></a>
The type of message response.  
Type: String  
Valid Values: `TEXT` 

## Errors
<a name="API_amazon-q-connect_GetNextMessage_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnprocessableContentException **   
The server has a failure of processing the message  
HTTP Status Code: 422

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_GetNextMessage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/GetNextMessage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/GetNextMessage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GetNextMessage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/GetNextMessage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GetNextMessage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/GetNextMessage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/GetNextMessage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/GetNextMessage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/GetNextMessage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GetNextMessage) 

# GetQuickResponse
<a name="API_amazon-q-connect_GetQuickResponse"></a>

Retrieves the quick response.

## Request Syntax
<a name="API_amazon-q-connect_GetQuickResponse_RequestSyntax"></a>

```
GET /knowledgeBases/knowledgeBaseId/quickResponses/quickResponseId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_GetQuickResponse_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_GetQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_GetQuickResponse-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. This should be a QUICK\$1RESPONSES type knowledge base.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [quickResponseId](#API_amazon-q-connect_GetQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_GetQuickResponse-request-uri-quickResponseId"></a>
The identifier of the quick response.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_GetQuickResponse_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_GetQuickResponse_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "quickResponse": { 
      "channels": [ "string" ],
      "contents": { 
         "markdown": { ... },
         "plainText": { ... }
      },
      "contentType": "string",
      "createdTime": number,
      "description": "string",
      "groupingConfiguration": { 
         "criteria": "string",
         "values": [ "string" ]
      },
      "isActive": boolean,
      "knowledgeBaseArn": "string",
      "knowledgeBaseId": "string",
      "language": "string",
      "lastModifiedBy": "string",
      "lastModifiedTime": number,
      "name": "string",
      "quickResponseArn": "string",
      "quickResponseId": "string",
      "shortcutKey": "string",
      "status": "string",
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_GetQuickResponse_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [quickResponse](#API_amazon-q-connect_GetQuickResponse_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetQuickResponse-response-quickResponse"></a>
The quick response.  
Type: [QuickResponseData](API_amazon-q-connect_QuickResponseData.md) object

## Errors
<a name="API_amazon-q-connect_GetQuickResponse_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_GetQuickResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/GetQuickResponse) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/GetQuickResponse) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GetQuickResponse) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/GetQuickResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GetQuickResponse) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/GetQuickResponse) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/GetQuickResponse) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/GetQuickResponse) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/GetQuickResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GetQuickResponse) 

# GetRecommendations
<a name="API_amazon-q-connect_GetRecommendations"></a>

**Important**  
This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use [NotifyRecommendationsReceived](https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_NotifyRecommendationsReceived.html). This API supports long-polling behavior with the `waitTimeSeconds` parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use [QueryAssistant](https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_QueryAssistant.html).

## Request Syntax
<a name="API_amazon-q-connect_GetRecommendations_RequestSyntax"></a>

```
GET /assistants/assistantId/sessions/sessionId/recommendations?maxResults=maxResults&nextChunkToken=nextChunkToken&recommendationType=recommendationType&waitTimeSeconds=waitTimeSeconds HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_GetRecommendations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_GetRecommendations_RequestSyntax) **   <a name="connect-amazon-q-connect_GetRecommendations-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [maxResults](#API_amazon-q-connect_GetRecommendations_RequestSyntax) **   <a name="connect-amazon-q-connect_GetRecommendations-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextChunkToken](#API_amazon-q-connect_GetRecommendations_RequestSyntax) **   <a name="connect-amazon-q-connect_GetRecommendations-request-uri-nextChunkToken"></a>
The token for the next set of chunks. Use the value returned in the previous response in the next request to retrieve the next set of chunks.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [recommendationType](#API_amazon-q-connect_GetRecommendations_RequestSyntax) **   <a name="connect-amazon-q-connect_GetRecommendations-request-uri-recommendationType"></a>
The type of recommendation being requested.  
Valid Values: `KNOWLEDGE_CONTENT | GENERATIVE_RESPONSE | GENERATIVE_ANSWER | DETECTED_INTENT | GENERATIVE_ANSWER_CHUNK | BLOCKED_GENERATIVE_ANSWER_CHUNK | INTENT_ANSWER_CHUNK | BLOCKED_INTENT_ANSWER_CHUNK | EMAIL_RESPONSE_CHUNK | EMAIL_OVERVIEW_CHUNK | EMAIL_GENERATIVE_ANSWER_CHUNK | CASE_SUMMARIZATION_CHUNK | BLOCKED_CASE_SUMMARIZATION_CHUNK | SUGGESTED_MESSAGE | NOTES_CHUNK | BLOCKED_NOTES_CHUNK` 

 ** [sessionId](#API_amazon-q-connect_GetRecommendations_RequestSyntax) **   <a name="connect-amazon-q-connect_GetRecommendations-request-uri-sessionId"></a>
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [waitTimeSeconds](#API_amazon-q-connect_GetRecommendations_RequestSyntax) **   <a name="connect-amazon-q-connect_GetRecommendations-request-uri-waitTimeSeconds"></a>
The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than `WaitTimeSeconds`. If no messages are available and the wait time expires, the call returns successfully with an empty list.  
Valid Range: Minimum value of 0. Maximum value of 20.

## Request Body
<a name="API_amazon-q-connect_GetRecommendations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_GetRecommendations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "recommendations": [ 
      { 
         "data": { 
            "details": { ... },
            "reference": { ... }
         },
         "document": { 
            "contentReference": { 
               "contentArn": "string",
               "contentId": "string",
               "knowledgeBaseArn": "string",
               "knowledgeBaseId": "string",
               "referenceType": "string",
               "sourceURL": "string"
            },
            "excerpt": { 
               "highlights": [ 
                  { 
                     "beginOffsetInclusive": number,
                     "endOffsetExclusive": number
                  }
               ],
               "text": "string"
            },
            "title": { 
               "highlights": [ 
                  { 
                     "beginOffsetInclusive": number,
                     "endOffsetExclusive": number
                  }
               ],
               "text": "string"
            }
         },
         "recommendationId": "string",
         "relevanceLevel": "string",
         "relevanceScore": number,
         "type": "string"
      }
   ],
   "triggers": [ 
      { 
         "data": { ... },
         "id": "string",
         "recommendationIds": [ "string" ],
         "source": "string",
         "type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_amazon-q-connect_GetRecommendations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [recommendations](#API_amazon-q-connect_GetRecommendations_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetRecommendations-response-recommendations"></a>
The recommendations.  
Type: Array of [RecommendationData](API_amazon-q-connect_RecommendationData.md) objects

 ** [triggers](#API_amazon-q-connect_GetRecommendations_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetRecommendations-response-triggers"></a>
The triggers corresponding to recommendations.  
Type: Array of [RecommendationTrigger](API_amazon-q-connect_RecommendationTrigger.md) objects

## Errors
<a name="API_amazon-q-connect_GetRecommendations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_GetRecommendations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/GetRecommendations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/GetRecommendations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GetRecommendations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/GetRecommendations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GetRecommendations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/GetRecommendations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/GetRecommendations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/GetRecommendations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/GetRecommendations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GetRecommendations) 

# GetSession
<a name="API_amazon-q-connect_GetSession"></a>

Retrieves information for a specified session.

## Request Syntax
<a name="API_amazon-q-connect_GetSession_RequestSyntax"></a>

```
GET /assistants/assistantId/sessions/sessionId HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_GetSession_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_GetSession_RequestSyntax) **   <a name="connect-amazon-q-connect_GetSession-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [sessionId](#API_amazon-q-connect_GetSession_RequestSyntax) **   <a name="connect-amazon-q-connect_GetSession-request-uri-sessionId"></a>
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_GetSession_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_GetSession_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "session": { 
      "aiAgentConfiguration": { 
         "string" : { 
            "aiAgentId": "string"
         }
      },
      "description": "string",
      "integrationConfiguration": { 
         "topicIntegrationArn": "string"
      },
      "name": "string",
      "orchestratorConfigurationList": [ 
         { 
            "aiAgentId": "string",
            "orchestratorUseCase": "string"
         }
      ],
      "origin": "string",
      "sessionArn": "string",
      "sessionId": "string",
      "tagFilter": { ... },
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_GetSession_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [session](#API_amazon-q-connect_GetSession_ResponseSyntax) **   <a name="connect-amazon-q-connect_GetSession-response-session"></a>
The session.  
Type: [SessionData](API_amazon-q-connect_SessionData.md) object

## Errors
<a name="API_amazon-q-connect_GetSession_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_GetSession_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/GetSession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/GetSession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/GetSession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/GetSession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/GetSession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/GetSession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/GetSession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/GetSession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/GetSession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/GetSession) 

# ListAIAgents
<a name="API_amazon-q-connect_ListAIAgents"></a>

Lists AI Agents.

## Request Syntax
<a name="API_amazon-q-connect_ListAIAgents_RequestSyntax"></a>

```
GET /assistants/assistantId/aiagents?maxResults=maxResults&nextToken=nextToken&origin=origin HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_ListAIAgents_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_ListAIAgents_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIAgents-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [maxResults](#API_amazon-q-connect_ListAIAgents_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIAgents-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_amazon-q-connect_ListAIAgents_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIAgents-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [origin](#API_amazon-q-connect_ListAIAgents_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIAgents-request-uri-origin"></a>
The origin of the AI Agents to be listed. `SYSTEM` for a default AI Agent created by Q in Connect or `CUSTOMER` for an AI Agent created by calling AI Agent creation APIs.   
Valid Values: `SYSTEM | CUSTOMER` 

## Request Body
<a name="API_amazon-q-connect_ListAIAgents_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_ListAIAgents_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "aiAgentSummaries": [ 
      { 
         "aiAgentArn": "string",
         "aiAgentId": "string",
         "assistantArn": "string",
         "assistantId": "string",
         "configuration": { ... },
         "description": "string",
         "modifiedTime": number,
         "name": "string",
         "origin": "string",
         "status": "string",
         "tags": { 
            "string" : "string" 
         },
         "type": "string",
         "visibilityStatus": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_amazon-q-connect_ListAIAgents_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [aiAgentSummaries](#API_amazon-q-connect_ListAIAgents_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListAIAgents-response-aiAgentSummaries"></a>
The summaries of AI Agents.  
Type: Array of [AIAgentSummary](API_amazon-q-connect_AIAgentSummary.md) objects

 ** [nextToken](#API_amazon-q-connect_ListAIAgents_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListAIAgents-response-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_amazon-q-connect_ListAIAgents_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_ListAIAgents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/ListAIAgents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/ListAIAgents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ListAIAgents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/ListAIAgents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ListAIAgents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/ListAIAgents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/ListAIAgents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/ListAIAgents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/ListAIAgents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ListAIAgents) 

# ListAIAgentVersions
<a name="API_amazon-q-connect_ListAIAgentVersions"></a>

List AI Agent versions.

## Request Syntax
<a name="API_amazon-q-connect_ListAIAgentVersions_RequestSyntax"></a>

```
GET /assistants/assistantId/aiagents/aiAgentId/versions?maxResults=maxResults&nextToken=nextToken&origin=origin HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_ListAIAgentVersions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aiAgentId](#API_amazon-q-connect_ListAIAgentVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIAgentVersions-request-uri-aiAgentId"></a>
The identifier of the Amazon Q in Connect AI Agent for which versions are to be listed.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** [assistantId](#API_amazon-q-connect_ListAIAgentVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIAgentVersions-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [maxResults](#API_amazon-q-connect_ListAIAgentVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIAgentVersions-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_amazon-q-connect_ListAIAgentVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIAgentVersions-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [origin](#API_amazon-q-connect_ListAIAgentVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIAgentVersions-request-uri-origin"></a>
The origin of the AI Agent versions to be listed. `SYSTEM` for a default AI Agent created by Q in Connect or `CUSTOMER` for an AI Agent created by calling AI Agent creation APIs.   
Valid Values: `SYSTEM | CUSTOMER` 

## Request Body
<a name="API_amazon-q-connect_ListAIAgentVersions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_ListAIAgentVersions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "aiAgentVersionSummaries": [ 
      { 
         "aiAgentSummary": { 
            "aiAgentArn": "string",
            "aiAgentId": "string",
            "assistantArn": "string",
            "assistantId": "string",
            "configuration": { ... },
            "description": "string",
            "modifiedTime": number,
            "name": "string",
            "origin": "string",
            "status": "string",
            "tags": { 
               "string" : "string" 
            },
            "type": "string",
            "visibilityStatus": "string"
         },
         "versionNumber": number
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_amazon-q-connect_ListAIAgentVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [aiAgentVersionSummaries](#API_amazon-q-connect_ListAIAgentVersions_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListAIAgentVersions-response-aiAgentVersionSummaries"></a>
The summaries of AI Agent versions.  
Type: Array of [AIAgentVersionSummary](API_amazon-q-connect_AIAgentVersionSummary.md) objects

 ** [nextToken](#API_amazon-q-connect_ListAIAgentVersions_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListAIAgentVersions-response-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_amazon-q-connect_ListAIAgentVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_ListAIAgentVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/ListAIAgentVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/ListAIAgentVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ListAIAgentVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/ListAIAgentVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ListAIAgentVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/ListAIAgentVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/ListAIAgentVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/ListAIAgentVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/ListAIAgentVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ListAIAgentVersions) 

# ListAIGuardrails
<a name="API_amazon-q-connect_ListAIGuardrails"></a>

Lists the AI Guardrails available on the Amazon Q in Connect assistant.

## Request Syntax
<a name="API_amazon-q-connect_ListAIGuardrails_RequestSyntax"></a>

```
GET /assistants/assistantId/aiguardrails?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_ListAIGuardrails_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_ListAIGuardrails_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIGuardrails-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [maxResults](#API_amazon-q-connect_ListAIGuardrails_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIGuardrails-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_amazon-q-connect_ListAIGuardrails_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIGuardrails-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Request Body
<a name="API_amazon-q-connect_ListAIGuardrails_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_ListAIGuardrails_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "aiGuardrailSummaries": [ 
      { 
         "aiGuardrailArn": "string",
         "aiGuardrailId": "string",
         "assistantArn": "string",
         "assistantId": "string",
         "description": "string",
         "modifiedTime": number,
         "name": "string",
         "status": "string",
         "tags": { 
            "string" : "string" 
         },
         "visibilityStatus": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_amazon-q-connect_ListAIGuardrails_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [aiGuardrailSummaries](#API_amazon-q-connect_ListAIGuardrails_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListAIGuardrails-response-aiGuardrailSummaries"></a>
The summaries of the AI Guardrails.  
Type: Array of [AIGuardrailSummary](API_amazon-q-connect_AIGuardrailSummary.md) objects

 ** [nextToken](#API_amazon-q-connect_ListAIGuardrails_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListAIGuardrails-response-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_amazon-q-connect_ListAIGuardrails_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_ListAIGuardrails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/ListAIGuardrails) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/ListAIGuardrails) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ListAIGuardrails) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/ListAIGuardrails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ListAIGuardrails) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/ListAIGuardrails) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/ListAIGuardrails) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/ListAIGuardrails) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/ListAIGuardrails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ListAIGuardrails) 

# ListAIGuardrailVersions
<a name="API_amazon-q-connect_ListAIGuardrailVersions"></a>

Lists AI Guardrail versions.

## Request Syntax
<a name="API_amazon-q-connect_ListAIGuardrailVersions_RequestSyntax"></a>

```
GET /assistants/assistantId/aiguardrails/aiGuardrailId/versions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_ListAIGuardrailVersions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aiGuardrailId](#API_amazon-q-connect_ListAIGuardrailVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIGuardrailVersions-request-uri-aiGuardrailId"></a>
The identifier of the Amazon Q in Connect AI Guardrail for which versions are to be listed.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** [assistantId](#API_amazon-q-connect_ListAIGuardrailVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIGuardrailVersions-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [maxResults](#API_amazon-q-connect_ListAIGuardrailVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIGuardrailVersions-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_amazon-q-connect_ListAIGuardrailVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIGuardrailVersions-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Request Body
<a name="API_amazon-q-connect_ListAIGuardrailVersions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_ListAIGuardrailVersions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "aiGuardrailVersionSummaries": [ 
      { 
         "aiGuardrailSummary": { 
            "aiGuardrailArn": "string",
            "aiGuardrailId": "string",
            "assistantArn": "string",
            "assistantId": "string",
            "description": "string",
            "modifiedTime": number,
            "name": "string",
            "status": "string",
            "tags": { 
               "string" : "string" 
            },
            "visibilityStatus": "string"
         },
         "versionNumber": number
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_amazon-q-connect_ListAIGuardrailVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [aiGuardrailVersionSummaries](#API_amazon-q-connect_ListAIGuardrailVersions_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListAIGuardrailVersions-response-aiGuardrailVersionSummaries"></a>
The summaries of the AI Guardrail versions.  
Type: Array of [AIGuardrailVersionSummary](API_amazon-q-connect_AIGuardrailVersionSummary.md) objects

 ** [nextToken](#API_amazon-q-connect_ListAIGuardrailVersions_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListAIGuardrailVersions-response-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_amazon-q-connect_ListAIGuardrailVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_ListAIGuardrailVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/ListAIGuardrailVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/ListAIGuardrailVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ListAIGuardrailVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/ListAIGuardrailVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ListAIGuardrailVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/ListAIGuardrailVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/ListAIGuardrailVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/ListAIGuardrailVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/ListAIGuardrailVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ListAIGuardrailVersions) 

# ListAIPrompts
<a name="API_amazon-q-connect_ListAIPrompts"></a>

Lists the AI Prompts available on the Amazon Q in Connect assistant.

## Request Syntax
<a name="API_amazon-q-connect_ListAIPrompts_RequestSyntax"></a>

```
GET /assistants/assistantId/aiprompts?maxResults=maxResults&nextToken=nextToken&origin=origin HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_ListAIPrompts_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_ListAIPrompts_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIPrompts-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [maxResults](#API_amazon-q-connect_ListAIPrompts_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIPrompts-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_amazon-q-connect_ListAIPrompts_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIPrompts-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [origin](#API_amazon-q-connect_ListAIPrompts_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIPrompts-request-uri-origin"></a>
The origin of the AI Prompts to be listed. `SYSTEM` for a default AI Agent created by Q in Connect or `CUSTOMER` for an AI Agent created by calling AI Agent creation APIs.   
Valid Values: `SYSTEM | CUSTOMER` 

## Request Body
<a name="API_amazon-q-connect_ListAIPrompts_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_ListAIPrompts_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "aiPromptSummaries": [ 
      { 
         "aiPromptArn": "string",
         "aiPromptId": "string",
         "apiFormat": "string",
         "assistantArn": "string",
         "assistantId": "string",
         "description": "string",
         "modelId": "string",
         "modifiedTime": number,
         "name": "string",
         "origin": "string",
         "status": "string",
         "tags": { 
            "string" : "string" 
         },
         "templateType": "string",
         "type": "string",
         "visibilityStatus": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_amazon-q-connect_ListAIPrompts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [aiPromptSummaries](#API_amazon-q-connect_ListAIPrompts_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListAIPrompts-response-aiPromptSummaries"></a>
The summaries of the AI Prompts.  
Type: Array of [AIPromptSummary](API_amazon-q-connect_AIPromptSummary.md) objects

 ** [nextToken](#API_amazon-q-connect_ListAIPrompts_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListAIPrompts-response-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_amazon-q-connect_ListAIPrompts_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_ListAIPrompts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/ListAIPrompts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/ListAIPrompts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ListAIPrompts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/ListAIPrompts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ListAIPrompts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/ListAIPrompts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/ListAIPrompts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/ListAIPrompts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/ListAIPrompts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ListAIPrompts) 

# ListAIPromptVersions
<a name="API_amazon-q-connect_ListAIPromptVersions"></a>

Lists AI Prompt versions.

## Request Syntax
<a name="API_amazon-q-connect_ListAIPromptVersions_RequestSyntax"></a>

```
GET /assistants/assistantId/aiprompts/aiPromptId/versions?maxResults=maxResults&nextToken=nextToken&origin=origin HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_ListAIPromptVersions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aiPromptId](#API_amazon-q-connect_ListAIPromptVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIPromptVersions-request-uri-aiPromptId"></a>
The identifier of the Amazon Q in Connect AI prompt for which versions are to be listed.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** [assistantId](#API_amazon-q-connect_ListAIPromptVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIPromptVersions-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [maxResults](#API_amazon-q-connect_ListAIPromptVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIPromptVersions-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_amazon-q-connect_ListAIPromptVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIPromptVersions-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [origin](#API_amazon-q-connect_ListAIPromptVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAIPromptVersions-request-uri-origin"></a>
The origin of the AI Prompt versions to be listed. `SYSTEM` for a default AI Agent created by Q in Connect or `CUSTOMER` for an AI Agent created by calling AI Agent creation APIs.   
Valid Values: `SYSTEM | CUSTOMER` 

## Request Body
<a name="API_amazon-q-connect_ListAIPromptVersions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_ListAIPromptVersions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "aiPromptVersionSummaries": [ 
      { 
         "aiPromptSummary": { 
            "aiPromptArn": "string",
            "aiPromptId": "string",
            "apiFormat": "string",
            "assistantArn": "string",
            "assistantId": "string",
            "description": "string",
            "modelId": "string",
            "modifiedTime": number,
            "name": "string",
            "origin": "string",
            "status": "string",
            "tags": { 
               "string" : "string" 
            },
            "templateType": "string",
            "type": "string",
            "visibilityStatus": "string"
         },
         "versionNumber": number
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_amazon-q-connect_ListAIPromptVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [aiPromptVersionSummaries](#API_amazon-q-connect_ListAIPromptVersions_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListAIPromptVersions-response-aiPromptVersionSummaries"></a>
The summaries of the AI Prompt versions.  
Type: Array of [AIPromptVersionSummary](API_amazon-q-connect_AIPromptVersionSummary.md) objects

 ** [nextToken](#API_amazon-q-connect_ListAIPromptVersions_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListAIPromptVersions-response-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_amazon-q-connect_ListAIPromptVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_ListAIPromptVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/ListAIPromptVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/ListAIPromptVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ListAIPromptVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/ListAIPromptVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ListAIPromptVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/ListAIPromptVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/ListAIPromptVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/ListAIPromptVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/ListAIPromptVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ListAIPromptVersions) 

# ListAssistantAssociations
<a name="API_amazon-q-connect_ListAssistantAssociations"></a>

Lists information about assistant associations.

## Request Syntax
<a name="API_amazon-q-connect_ListAssistantAssociations_RequestSyntax"></a>

```
GET /assistants/assistantId/associations?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_ListAssistantAssociations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_ListAssistantAssociations_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAssistantAssociations-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [maxResults](#API_amazon-q-connect_ListAssistantAssociations_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAssistantAssociations-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_amazon-q-connect_ListAssistantAssociations_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAssistantAssociations-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Request Body
<a name="API_amazon-q-connect_ListAssistantAssociations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_ListAssistantAssociations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assistantAssociationSummaries": [ 
      { 
         "assistantArn": "string",
         "assistantAssociationArn": "string",
         "assistantAssociationId": "string",
         "assistantId": "string",
         "associationData": { ... },
         "associationType": "string",
         "tags": { 
            "string" : "string" 
         }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_amazon-q-connect_ListAssistantAssociations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assistantAssociationSummaries](#API_amazon-q-connect_ListAssistantAssociations_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListAssistantAssociations-response-assistantAssociationSummaries"></a>
Summary information about assistant associations.  
Type: Array of [AssistantAssociationSummary](API_amazon-q-connect_AssistantAssociationSummary.md) objects

 ** [nextToken](#API_amazon-q-connect_ListAssistantAssociations_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListAssistantAssociations-response-nextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_amazon-q-connect_ListAssistantAssociations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_ListAssistantAssociations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/ListAssistantAssociations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/ListAssistantAssociations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ListAssistantAssociations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/ListAssistantAssociations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ListAssistantAssociations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/ListAssistantAssociations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/ListAssistantAssociations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/ListAssistantAssociations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/ListAssistantAssociations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ListAssistantAssociations) 

# ListAssistants
<a name="API_amazon-q-connect_ListAssistants"></a>

Lists information about assistants.

## Request Syntax
<a name="API_amazon-q-connect_ListAssistants_RequestSyntax"></a>

```
GET /assistants?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_ListAssistants_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_amazon-q-connect_ListAssistants_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAssistants-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_amazon-q-connect_ListAssistants_RequestSyntax) **   <a name="connect-amazon-q-connect_ListAssistants-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Request Body
<a name="API_amazon-q-connect_ListAssistants_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_ListAssistants_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assistantSummaries": [ 
      { 
         "aiAgentConfiguration": { 
            "string" : { 
               "aiAgentId": "string"
            }
         },
         "assistantArn": "string",
         "assistantId": "string",
         "capabilityConfiguration": { 
            "type": "string"
         },
         "description": "string",
         "integrationConfiguration": { 
            "topicIntegrationArn": "string"
         },
         "name": "string",
         "orchestratorConfigurationList": [ 
            { 
               "aiAgentId": "string",
               "orchestratorUseCase": "string"
            }
         ],
         "serverSideEncryptionConfiguration": { 
            "kmsKeyId": "string"
         },
         "status": "string",
         "tags": { 
            "string" : "string" 
         },
         "type": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_amazon-q-connect_ListAssistants_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assistantSummaries](#API_amazon-q-connect_ListAssistants_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListAssistants-response-assistantSummaries"></a>
Information about the assistants.  
Type: Array of [AssistantSummary](API_amazon-q-connect_AssistantSummary.md) objects

 ** [nextToken](#API_amazon-q-connect_ListAssistants_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListAssistants-response-nextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_amazon-q-connect_ListAssistants_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_ListAssistants_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/ListAssistants) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/ListAssistants) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ListAssistants) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/ListAssistants) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ListAssistants) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/ListAssistants) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/ListAssistants) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/ListAssistants) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/ListAssistants) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ListAssistants) 

# ListContentAssociations
<a name="API_amazon-q-connect_ListContentAssociations"></a>

Lists the content associations.

For more information about content associations--what they are and when they are used--see [Integrate Amazon Q in Connect with step-by-step guides](https://docs.aws.amazon.com/connect/latest/adminguide/integrate-q-with-guides.html) in the *Amazon Connect Administrator Guide*.

## Request Syntax
<a name="API_amazon-q-connect_ListContentAssociations_RequestSyntax"></a>

```
GET /knowledgeBases/knowledgeBaseId/contents/contentId/associations?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_ListContentAssociations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [contentId](#API_amazon-q-connect_ListContentAssociations_RequestSyntax) **   <a name="connect-amazon-q-connect_ListContentAssociations-request-uri-contentId"></a>
The identifier of the content.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [knowledgeBaseId](#API_amazon-q-connect_ListContentAssociations_RequestSyntax) **   <a name="connect-amazon-q-connect_ListContentAssociations-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [maxResults](#API_amazon-q-connect_ListContentAssociations_RequestSyntax) **   <a name="connect-amazon-q-connect_ListContentAssociations-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_amazon-q-connect_ListContentAssociations_RequestSyntax) **   <a name="connect-amazon-q-connect_ListContentAssociations-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Request Body
<a name="API_amazon-q-connect_ListContentAssociations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_ListContentAssociations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "contentAssociationSummaries": [ 
      { 
         "associationData": { ... },
         "associationType": "string",
         "contentArn": "string",
         "contentAssociationArn": "string",
         "contentAssociationId": "string",
         "contentId": "string",
         "knowledgeBaseArn": "string",
         "knowledgeBaseId": "string",
         "tags": { 
            "string" : "string" 
         }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_amazon-q-connect_ListContentAssociations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [contentAssociationSummaries](#API_amazon-q-connect_ListContentAssociations_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListContentAssociations-response-contentAssociationSummaries"></a>
Summary information about content associations.  
Type: Array of [ContentAssociationSummary](API_amazon-q-connect_ContentAssociationSummary.md) objects

 ** [nextToken](#API_amazon-q-connect_ListContentAssociations_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListContentAssociations-response-nextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_amazon-q-connect_ListContentAssociations_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_ListContentAssociations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/ListContentAssociations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/ListContentAssociations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ListContentAssociations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/ListContentAssociations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ListContentAssociations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/ListContentAssociations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/ListContentAssociations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/ListContentAssociations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/ListContentAssociations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ListContentAssociations) 

# ListContents
<a name="API_amazon-q-connect_ListContents"></a>

Lists the content.

## Request Syntax
<a name="API_amazon-q-connect_ListContents_RequestSyntax"></a>

```
GET /knowledgeBases/knowledgeBaseId/contents?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_ListContents_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_ListContents_RequestSyntax) **   <a name="connect-amazon-q-connect_ListContents-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. This should not be a QUICK\$1RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [maxResults](#API_amazon-q-connect_ListContents_RequestSyntax) **   <a name="connect-amazon-q-connect_ListContents-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_amazon-q-connect_ListContents_RequestSyntax) **   <a name="connect-amazon-q-connect_ListContents-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Request Body
<a name="API_amazon-q-connect_ListContents_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_ListContents_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "contentSummaries": [ 
      { 
         "contentArn": "string",
         "contentId": "string",
         "contentType": "string",
         "knowledgeBaseArn": "string",
         "knowledgeBaseId": "string",
         "metadata": { 
            "string" : "string" 
         },
         "name": "string",
         "revisionId": "string",
         "status": "string",
         "tags": { 
            "string" : "string" 
         },
         "title": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_amazon-q-connect_ListContents_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [contentSummaries](#API_amazon-q-connect_ListContents_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListContents-response-contentSummaries"></a>
Information about the content.  
Type: Array of [ContentSummary](API_amazon-q-connect_ContentSummary.md) objects

 ** [nextToken](#API_amazon-q-connect_ListContents_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListContents-response-nextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_amazon-q-connect_ListContents_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_ListContents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/ListContents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/ListContents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ListContents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/ListContents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ListContents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/ListContents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/ListContents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/ListContents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/ListContents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ListContents) 

# ListImportJobs
<a name="API_amazon-q-connect_ListImportJobs"></a>

Lists information about import jobs.

## Request Syntax
<a name="API_amazon-q-connect_ListImportJobs_RequestSyntax"></a>

```
GET /knowledgeBases/knowledgeBaseId/importJobs?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_ListImportJobs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_ListImportJobs_RequestSyntax) **   <a name="connect-amazon-q-connect_ListImportJobs-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [maxResults](#API_amazon-q-connect_ListImportJobs_RequestSyntax) **   <a name="connect-amazon-q-connect_ListImportJobs-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_amazon-q-connect_ListImportJobs_RequestSyntax) **   <a name="connect-amazon-q-connect_ListImportJobs-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.

## Request Body
<a name="API_amazon-q-connect_ListImportJobs_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_ListImportJobs_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "importJobSummaries": [ 
      { 
         "createdTime": number,
         "externalSourceConfiguration": { 
            "configuration": { ... },
            "source": "string"
         },
         "importJobId": "string",
         "importJobType": "string",
         "knowledgeBaseArn": "string",
         "knowledgeBaseId": "string",
         "lastModifiedTime": number,
         "metadata": { 
            "string" : "string" 
         },
         "status": "string",
         "uploadId": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_amazon-q-connect_ListImportJobs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [importJobSummaries](#API_amazon-q-connect_ListImportJobs_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListImportJobs-response-importJobSummaries"></a>
Summary information about the import jobs.  
Type: Array of [ImportJobSummary](API_amazon-q-connect_ImportJobSummary.md) objects

 ** [nextToken](#API_amazon-q-connect_ListImportJobs_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListImportJobs-response-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.

## Errors
<a name="API_amazon-q-connect_ListImportJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_ListImportJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/ListImportJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/ListImportJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ListImportJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/ListImportJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ListImportJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/ListImportJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/ListImportJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/ListImportJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/ListImportJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ListImportJobs) 

# ListKnowledgeBases
<a name="API_amazon-q-connect_ListKnowledgeBases"></a>

Lists the knowledge bases.

## Request Syntax
<a name="API_amazon-q-connect_ListKnowledgeBases_RequestSyntax"></a>

```
GET /knowledgeBases?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_ListKnowledgeBases_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_amazon-q-connect_ListKnowledgeBases_RequestSyntax) **   <a name="connect-amazon-q-connect_ListKnowledgeBases-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_amazon-q-connect_ListKnowledgeBases_RequestSyntax) **   <a name="connect-amazon-q-connect_ListKnowledgeBases-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.

## Request Body
<a name="API_amazon-q-connect_ListKnowledgeBases_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_ListKnowledgeBases_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "knowledgeBaseSummaries": [ 
      { 
         "description": "string",
         "knowledgeBaseArn": "string",
         "knowledgeBaseId": "string",
         "knowledgeBaseType": "string",
         "name": "string",
         "renderingConfiguration": { 
            "templateUri": "string"
         },
         "serverSideEncryptionConfiguration": { 
            "kmsKeyId": "string"
         },
         "sourceConfiguration": { ... },
         "status": "string",
         "tags": { 
            "string" : "string" 
         },
         "vectorIngestionConfiguration": { 
            "chunkingConfiguration": { 
               "chunkingStrategy": "string",
               "fixedSizeChunkingConfiguration": { 
                  "maxTokens": number,
                  "overlapPercentage": number
               },
               "hierarchicalChunkingConfiguration": { 
                  "levelConfigurations": [ 
                     { 
                        "maxTokens": number
                     }
                  ],
                  "overlapTokens": number
               },
               "semanticChunkingConfiguration": { 
                  "breakpointPercentileThreshold": number,
                  "bufferSize": number,
                  "maxTokens": number
               }
            },
            "parsingConfiguration": { 
               "bedrockFoundationModelConfiguration": { 
                  "modelArn": "string",
                  "parsingPrompt": { 
                     "parsingPromptText": "string"
                  }
               },
               "parsingStrategy": "string"
            }
         }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_amazon-q-connect_ListKnowledgeBases_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [knowledgeBaseSummaries](#API_amazon-q-connect_ListKnowledgeBases_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListKnowledgeBases-response-knowledgeBaseSummaries"></a>
Information about the knowledge bases.  
Type: Array of [KnowledgeBaseSummary](API_amazon-q-connect_KnowledgeBaseSummary.md) objects

 ** [nextToken](#API_amazon-q-connect_ListKnowledgeBases_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListKnowledgeBases-response-nextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.

## Errors
<a name="API_amazon-q-connect_ListKnowledgeBases_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_ListKnowledgeBases_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/ListKnowledgeBases) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/ListKnowledgeBases) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ListKnowledgeBases) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/ListKnowledgeBases) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ListKnowledgeBases) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/ListKnowledgeBases) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/ListKnowledgeBases) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/ListKnowledgeBases) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/ListKnowledgeBases) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ListKnowledgeBases) 

# ListMessages
<a name="API_amazon-q-connect_ListMessages"></a>

Lists messages on an Amazon Q in Connect session.

## Request Syntax
<a name="API_amazon-q-connect_ListMessages_RequestSyntax"></a>

```
GET /assistants/assistantId/sessions/sessionId/messages?filter=filter&maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_ListMessages_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_ListMessages_RequestSyntax) **   <a name="connect-amazon-q-connect_ListMessages-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [filter](#API_amazon-q-connect_ListMessages_RequestSyntax) **   <a name="connect-amazon-q-connect_ListMessages-request-uri-filter"></a>
The filter criteria for listing messages.  
Valid Values: `ALL | TEXT_ONLY` 

 ** [maxResults](#API_amazon-q-connect_ListMessages_RequestSyntax) **   <a name="connect-amazon-q-connect_ListMessages-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_amazon-q-connect_ListMessages_RequestSyntax) **   <a name="connect-amazon-q-connect_ListMessages-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [sessionId](#API_amazon-q-connect_ListMessages_RequestSyntax) **   <a name="connect-amazon-q-connect_ListMessages-request-uri-sessionId"></a>
The identifier of the Amazon Q in Connect session.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_ListMessages_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_ListMessages_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "messages": [ 
      { 
         "messageId": "string",
         "participant": "string",
         "timestamp": number,
         "value": { ... }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_amazon-q-connect_ListMessages_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [messages](#API_amazon-q-connect_ListMessages_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListMessages-response-messages"></a>
The message information.  
Type: Array of [MessageOutput](API_amazon-q-connect_MessageOutput.md) objects

 ** [nextToken](#API_amazon-q-connect_ListMessages_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListMessages-response-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_amazon-q-connect_ListMessages_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_ListMessages_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/ListMessages) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/ListMessages) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ListMessages) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/ListMessages) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ListMessages) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/ListMessages) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/ListMessages) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/ListMessages) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/ListMessages) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ListMessages) 

# ListMessageTemplates
<a name="API_amazon-q-connect_ListMessageTemplates"></a>

Lists all the available Amazon Q in Connect message templates for the specified knowledge base.

## Request Syntax
<a name="API_amazon-q-connect_ListMessageTemplates_RequestSyntax"></a>

```
GET /knowledgeBases/knowledgeBaseId/messageTemplates?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_ListMessageTemplates_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_ListMessageTemplates_RequestSyntax) **   <a name="connect-amazon-q-connect_ListMessageTemplates-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [maxResults](#API_amazon-q-connect_ListMessageTemplates_RequestSyntax) **   <a name="connect-amazon-q-connect_ListMessageTemplates-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_amazon-q-connect_ListMessageTemplates_RequestSyntax) **   <a name="connect-amazon-q-connect_ListMessageTemplates-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Request Body
<a name="API_amazon-q-connect_ListMessageTemplates_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_ListMessageTemplates_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "messageTemplateSummaries": [ 
      { 
         "activeVersionNumber": number,
         "channel": "string",
         "channelSubtype": "string",
         "createdTime": "string",
         "description": "string",
         "knowledgeBaseArn": "string",
         "knowledgeBaseId": "string",
         "lastModifiedBy": "string",
         "lastModifiedTime": "string",
         "messageTemplateArn": "string",
         "messageTemplateId": "string",
         "name": "string",
         "sourceConfiguration": { ... },
         "tags": { 
            "string" : "string" 
         }
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_amazon-q-connect_ListMessageTemplates_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [messageTemplateSummaries](#API_amazon-q-connect_ListMessageTemplates_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListMessageTemplates-response-messageTemplateSummaries"></a>
Summary information about the message template.  
Type: Array of [MessageTemplateSummary](API_amazon-q-connect_MessageTemplateSummary.md) objects

 ** [nextToken](#API_amazon-q-connect_ListMessageTemplates_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListMessageTemplates-response-nextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_amazon-q-connect_ListMessageTemplates_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_ListMessageTemplates_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/ListMessageTemplates) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/ListMessageTemplates) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ListMessageTemplates) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/ListMessageTemplates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ListMessageTemplates) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/ListMessageTemplates) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/ListMessageTemplates) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/ListMessageTemplates) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/ListMessageTemplates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ListMessageTemplates) 

# ListMessageTemplateVersions
<a name="API_amazon-q-connect_ListMessageTemplateVersions"></a>

Lists all the available versions for the specified Amazon Q in Connect message template.

## Request Syntax
<a name="API_amazon-q-connect_ListMessageTemplateVersions_RequestSyntax"></a>

```
GET /knowledgeBases/knowledgeBaseId/messageTemplates/messageTemplateId/versions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_ListMessageTemplateVersions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_ListMessageTemplateVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListMessageTemplateVersions-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [maxResults](#API_amazon-q-connect_ListMessageTemplateVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListMessageTemplateVersions-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [messageTemplateId](#API_amazon-q-connect_ListMessageTemplateVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListMessageTemplateVersions-request-uri-messageTemplateId"></a>
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** [nextToken](#API_amazon-q-connect_ListMessageTemplateVersions_RequestSyntax) **   <a name="connect-amazon-q-connect_ListMessageTemplateVersions-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Request Body
<a name="API_amazon-q-connect_ListMessageTemplateVersions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_ListMessageTemplateVersions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "messageTemplateVersionSummaries": [ 
      { 
         "channel": "string",
         "channelSubtype": "string",
         "isActive": boolean,
         "knowledgeBaseArn": "string",
         "knowledgeBaseId": "string",
         "messageTemplateArn": "string",
         "messageTemplateId": "string",
         "name": "string",
         "versionNumber": number
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_amazon-q-connect_ListMessageTemplateVersions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [messageTemplateVersionSummaries](#API_amazon-q-connect_ListMessageTemplateVersions_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListMessageTemplateVersions-response-messageTemplateVersionSummaries"></a>
Summary information about the versions of a message template.  
Type: Array of [MessageTemplateVersionSummary](API_amazon-q-connect_MessageTemplateVersionSummary.md) objects

 ** [nextToken](#API_amazon-q-connect_ListMessageTemplateVersions_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListMessageTemplateVersions-response-nextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_amazon-q-connect_ListMessageTemplateVersions_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_ListMessageTemplateVersions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/ListMessageTemplateVersions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/ListMessageTemplateVersions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ListMessageTemplateVersions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/ListMessageTemplateVersions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ListMessageTemplateVersions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/ListMessageTemplateVersions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/ListMessageTemplateVersions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/ListMessageTemplateVersions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/ListMessageTemplateVersions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ListMessageTemplateVersions) 

# ListQuickResponses
<a name="API_amazon-q-connect_ListQuickResponses"></a>

Lists information about quick response.

## Request Syntax
<a name="API_amazon-q-connect_ListQuickResponses_RequestSyntax"></a>

```
GET /knowledgeBases/knowledgeBaseId/quickResponses?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_ListQuickResponses_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_ListQuickResponses_RequestSyntax) **   <a name="connect-amazon-q-connect_ListQuickResponses-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [maxResults](#API_amazon-q-connect_ListQuickResponses_RequestSyntax) **   <a name="connect-amazon-q-connect_ListQuickResponses-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_amazon-q-connect_ListQuickResponses_RequestSyntax) **   <a name="connect-amazon-q-connect_ListQuickResponses-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.

## Request Body
<a name="API_amazon-q-connect_ListQuickResponses_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_ListQuickResponses_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "quickResponseSummaries": [ 
      { 
         "channels": [ "string" ],
         "contentType": "string",
         "createdTime": number,
         "description": "string",
         "isActive": boolean,
         "knowledgeBaseArn": "string",
         "knowledgeBaseId": "string",
         "lastModifiedBy": "string",
         "lastModifiedTime": number,
         "name": "string",
         "quickResponseArn": "string",
         "quickResponseId": "string",
         "status": "string",
         "tags": { 
            "string" : "string" 
         }
      }
   ]
}
```

## Response Elements
<a name="API_amazon-q-connect_ListQuickResponses_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_amazon-q-connect_ListQuickResponses_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListQuickResponses-response-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.

 ** [quickResponseSummaries](#API_amazon-q-connect_ListQuickResponses_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListQuickResponses-response-quickResponseSummaries"></a>
Summary information about the quick responses.  
Type: Array of [QuickResponseSummary](API_amazon-q-connect_QuickResponseSummary.md) objects

## Errors
<a name="API_amazon-q-connect_ListQuickResponses_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_ListQuickResponses_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/ListQuickResponses) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/ListQuickResponses) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ListQuickResponses) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/ListQuickResponses) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ListQuickResponses) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/ListQuickResponses) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/ListQuickResponses) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/ListQuickResponses) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/ListQuickResponses) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ListQuickResponses) 

# ListSpans
<a name="API_amazon-q-connect_ListSpans"></a>

Retrieves AI agent execution traces for a session, providing granular visibility into agent orchestration flows, LLM interactions, and tool invocations.

## Request Syntax
<a name="API_amazon-q-connect_ListSpans_RequestSyntax"></a>

```
GET /assistants/assistantId/sessions/sessionId/spans?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_ListSpans_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_ListSpans_RequestSyntax) **   <a name="connect-amazon-q-connect_ListSpans-request-uri-assistantId"></a>
UUID or ARN of the Connect AI Assistant resource  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [maxResults](#API_amazon-q-connect_ListSpans_RequestSyntax) **   <a name="connect-amazon-q-connect_ListSpans-request-uri-maxResults"></a>
Maximum number of spans to return per page  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_amazon-q-connect_ListSpans_RequestSyntax) **   <a name="connect-amazon-q-connect_ListSpans-request-uri-nextToken"></a>
Pagination token for retrieving the next page of results  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [sessionId](#API_amazon-q-connect_ListSpans_RequestSyntax) **   <a name="connect-amazon-q-connect_ListSpans-request-uri-sessionId"></a>
UUID or ARN of the Connect AI Session resource  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_ListSpans_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_ListSpans_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "spans": [ 
      { 
         "assistantId": "string",
         "attributes": { 
            "agentId": "string",
            "aiAgentArn": "string",
            "aiAgentId": "string",
            "aiAgentInvoker": "string",
            "aiAgentName": "string",
            "aiAgentOrchestratorUseCase": "string",
            "aiAgentType": "string",
            "aiAgentVersion": number,
            "cacheReadInputTokens": number,
            "cacheWriteInputTokens": number,
            "contactId": "string",
            "errorType": "string",
            "initialContactId": "string",
            "inputMessages": [ 
               { 
                  "messageId": "string",
                  "participant": "string",
                  "timestamp": number,
                  "values": [ 
                     { ... }
                  ]
               }
            ],
            "instanceArn": "string",
            "operationName": "string",
            "outputMessages": [ 
               { 
                  "messageId": "string",
                  "participant": "string",
                  "timestamp": number,
                  "values": [ 
                     { ... }
                  ]
               }
            ],
            "promptArn": "string",
            "promptId": "string",
            "promptName": "string",
            "promptType": "string",
            "promptVersion": number,
            "providerName": "string",
            "requestMaxTokens": number,
            "requestModel": "string",
            "responseFinishReasons": [ "string" ],
            "responseModel": "string",
            "sessionName": "string",
            "systemInstructions": [ 
               { ... }
            ],
            "temperature": number,
            "topP": number,
            "usageInputTokens": number,
            "usageOutputTokens": number,
            "usageTotalTokens": number
         },
         "endTimestamp": number,
         "parentSpanId": "string",
         "requestId": "string",
         "sessionId": "string",
         "spanId": "string",
         "spanName": "string",
         "spanType": "string",
         "startTimestamp": number,
         "status": "string"
      }
   ]
}
```

## Response Elements
<a name="API_amazon-q-connect_ListSpans_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_amazon-q-connect_ListSpans_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListSpans-response-nextToken"></a>
Pagination token for retrieving additional results  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [spans](#API_amazon-q-connect_ListSpans_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListSpans-response-spans"></a>
Array of span objects for the session  
Type: Array of [Span](API_amazon-q-connect_Span.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 100 items.

## Errors
<a name="API_amazon-q-connect_ListSpans_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_ListSpans_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/ListSpans) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/ListSpans) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ListSpans) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/ListSpans) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ListSpans) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/ListSpans) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/ListSpans) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/ListSpans) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/ListSpans) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ListSpans) 

# ListTagsForResource
<a name="API_amazon-q-connect_ListTagsForResource"></a>

Lists the tags for the specified resource.

## Request Syntax
<a name="API_amazon-q-connect_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/resourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_amazon-q-connect_ListTagsForResource_RequestSyntax) **   <a name="connect-amazon-q-connect_ListTagsForResource-request-uri-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource.  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [tags](#API_amazon-q-connect_ListTagsForResource_ResponseSyntax) **   <a name="connect-amazon-q-connect_ListTagsForResource-response-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.

## Errors
<a name="API_amazon-q-connect_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

## See Also
<a name="API_amazon-q-connect_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/ListTagsForResource) 

# NotifyRecommendationsReceived
<a name="API_amazon-q-connect_NotifyRecommendationsReceived"></a>

Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with [GetRecommendations](https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html) and a `waitTimeSeconds` input for long-polling behavior and avoiding duplicate recommendations.

## Request Syntax
<a name="API_amazon-q-connect_NotifyRecommendationsReceived_RequestSyntax"></a>

```
POST /assistants/assistantId/sessions/sessionId/recommendations/notify HTTP/1.1
Content-type: application/json

{
   "recommendationIds": [ "string" ]
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_NotifyRecommendationsReceived_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_NotifyRecommendationsReceived_RequestSyntax) **   <a name="connect-amazon-q-connect_NotifyRecommendationsReceived-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [sessionId](#API_amazon-q-connect_NotifyRecommendationsReceived_RequestSyntax) **   <a name="connect-amazon-q-connect_NotifyRecommendationsReceived-request-uri-sessionId"></a>
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_NotifyRecommendationsReceived_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [recommendationIds](#API_amazon-q-connect_NotifyRecommendationsReceived_RequestSyntax) **   <a name="connect-amazon-q-connect_NotifyRecommendationsReceived-request-recommendationIds"></a>
The identifiers of the recommendations.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 25 items.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: Yes

## Response Syntax
<a name="API_amazon-q-connect_NotifyRecommendationsReceived_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "errors": [ 
      { 
         "message": "string",
         "recommendationId": "string"
      }
   ],
   "recommendationIds": [ "string" ]
}
```

## Response Elements
<a name="API_amazon-q-connect_NotifyRecommendationsReceived_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [errors](#API_amazon-q-connect_NotifyRecommendationsReceived_ResponseSyntax) **   <a name="connect-amazon-q-connect_NotifyRecommendationsReceived-response-errors"></a>
The identifiers of recommendations that are causing errors.  
Type: Array of [NotifyRecommendationsReceivedError](API_amazon-q-connect_NotifyRecommendationsReceivedError.md) objects

 ** [recommendationIds](#API_amazon-q-connect_NotifyRecommendationsReceived_ResponseSyntax) **   <a name="connect-amazon-q-connect_NotifyRecommendationsReceived-response-recommendationIds"></a>
The identifiers of the recommendations.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 25 items.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_amazon-q-connect_NotifyRecommendationsReceived_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_NotifyRecommendationsReceived_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/NotifyRecommendationsReceived) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/NotifyRecommendationsReceived) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/NotifyRecommendationsReceived) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/NotifyRecommendationsReceived) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/NotifyRecommendationsReceived) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/NotifyRecommendationsReceived) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/NotifyRecommendationsReceived) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/NotifyRecommendationsReceived) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/NotifyRecommendationsReceived) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/NotifyRecommendationsReceived) 

# PutFeedback
<a name="API_amazon-q-connect_PutFeedback"></a>

Provides feedback against the specified assistant for the specified target. This API only supports generative targets.

## Request Syntax
<a name="API_amazon-q-connect_PutFeedback_RequestSyntax"></a>

```
PUT /assistants/assistantId/feedback HTTP/1.1
Content-type: application/json

{
   "contentFeedback": { ... },
   "targetId": "string",
   "targetType": "string"
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_PutFeedback_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_PutFeedback_RequestSyntax) **   <a name="connect-amazon-q-connect_PutFeedback-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_PutFeedback_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [contentFeedback](#API_amazon-q-connect_PutFeedback_RequestSyntax) **   <a name="connect-amazon-q-connect_PutFeedback-request-contentFeedback"></a>
Information about the feedback provided.  
Type: [ContentFeedbackData](API_amazon-q-connect_ContentFeedbackData.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: Yes

 ** [targetId](#API_amazon-q-connect_PutFeedback_RequestSyntax) **   <a name="connect-amazon-q-connect_PutFeedback-request-targetId"></a>
The identifier of the feedback target.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`   
Required: Yes

 ** [targetType](#API_amazon-q-connect_PutFeedback_RequestSyntax) **   <a name="connect-amazon-q-connect_PutFeedback-request-targetType"></a>
The type of the feedback target.  
Type: String  
Valid Values: `RECOMMENDATION | RESULT`   
Required: Yes

## Response Syntax
<a name="API_amazon-q-connect_PutFeedback_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assistantArn": "string",
   "assistantId": "string",
   "contentFeedback": { ... },
   "targetId": "string",
   "targetType": "string"
}
```

## Response Elements
<a name="API_amazon-q-connect_PutFeedback_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assistantArn](#API_amazon-q-connect_PutFeedback_ResponseSyntax) **   <a name="connect-amazon-q-connect_PutFeedback-response-assistantArn"></a>
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}` 

 ** [assistantId](#API_amazon-q-connect_PutFeedback_ResponseSyntax) **   <a name="connect-amazon-q-connect_PutFeedback-response-assistantId"></a>
The identifier of the Amazon Q in Connect assistant.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [contentFeedback](#API_amazon-q-connect_PutFeedback_ResponseSyntax) **   <a name="connect-amazon-q-connect_PutFeedback-response-contentFeedback"></a>
Information about the feedback provided.  
Type: [ContentFeedbackData](API_amazon-q-connect_ContentFeedbackData.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [targetId](#API_amazon-q-connect_PutFeedback_ResponseSyntax) **   <a name="connect-amazon-q-connect_PutFeedback-response-targetId"></a>
The identifier of the feedback target.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

 ** [targetType](#API_amazon-q-connect_PutFeedback_ResponseSyntax) **   <a name="connect-amazon-q-connect_PutFeedback-response-targetType"></a>
The type of the feedback target.  
Type: String  
Valid Values: `RECOMMENDATION | RESULT` 

## Errors
<a name="API_amazon-q-connect_PutFeedback_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_PutFeedback_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/PutFeedback) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/PutFeedback) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/PutFeedback) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/PutFeedback) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/PutFeedback) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/PutFeedback) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/PutFeedback) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/PutFeedback) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/PutFeedback) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/PutFeedback) 

# QueryAssistant
<a name="API_amazon-q-connect_QueryAssistant"></a>

**Important**  
This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use [GetRecommendations](https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html). 

## Request Syntax
<a name="API_amazon-q-connect_QueryAssistant_RequestSyntax"></a>

```
POST /assistants/assistantId/query HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string",
   "overrideKnowledgeBaseSearchType": "string",
   "queryCondition": [ 
      { ... }
   ],
   "queryInputData": { ... },
   "queryText": "string",
   "sessionId": "string"
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_QueryAssistant_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_QueryAssistant_RequestSyntax) **   <a name="connect-amazon-q-connect_QueryAssistant-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_QueryAssistant_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [maxResults](#API_amazon-q-connect_QueryAssistant_RequestSyntax) **   <a name="connect-amazon-q-connect_QueryAssistant-request-maxResults"></a>
The maximum number of results to return per page.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [nextToken](#API_amazon-q-connect_QueryAssistant_RequestSyntax) **   <a name="connect-amazon-q-connect_QueryAssistant-request-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [overrideKnowledgeBaseSearchType](#API_amazon-q-connect_QueryAssistant_RequestSyntax) **   <a name="connect-amazon-q-connect_QueryAssistant-request-overrideKnowledgeBaseSearchType"></a>
The search type to be used against the Knowledge Base for this request. The values can be `SEMANTIC` which uses vector embeddings or `HYBRID` which use vector embeddings and raw text.  
Type: String  
Valid Values: `HYBRID | SEMANTIC`   
Required: No

 ** [queryCondition](#API_amazon-q-connect_QueryAssistant_RequestSyntax) **   <a name="connect-amazon-q-connect_QueryAssistant-request-queryCondition"></a>
Information about how to query content.  
Type: Array of [QueryCondition](API_amazon-q-connect_QueryCondition.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 1 item.  
Required: No

 ** [queryInputData](#API_amazon-q-connect_QueryAssistant_RequestSyntax) **   <a name="connect-amazon-q-connect_QueryAssistant-request-queryInputData"></a>
Information about the query.  
Type: [QueryInputData](API_amazon-q-connect_QueryInputData.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [queryText](#API_amazon-q-connect_QueryAssistant_RequestSyntax) **   <a name="connect-amazon-q-connect_QueryAssistant-request-queryText"></a>
The text to search for.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 512.  
Required: No

 ** [sessionId](#API_amazon-q-connect_QueryAssistant_RequestSyntax) **   <a name="connect-amazon-q-connect_QueryAssistant-request-sessionId"></a>
The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: No

## Response Syntax
<a name="API_amazon-q-connect_QueryAssistant_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "results": [ 
      { 
         "data": { 
            "details": { ... },
            "reference": { ... }
         },
         "document": { 
            "contentReference": { 
               "contentArn": "string",
               "contentId": "string",
               "knowledgeBaseArn": "string",
               "knowledgeBaseId": "string",
               "referenceType": "string",
               "sourceURL": "string"
            },
            "excerpt": { 
               "highlights": [ 
                  { 
                     "beginOffsetInclusive": number,
                     "endOffsetExclusive": number
                  }
               ],
               "text": "string"
            },
            "title": { 
               "highlights": [ 
                  { 
                     "beginOffsetInclusive": number,
                     "endOffsetExclusive": number
                  }
               ],
               "text": "string"
            }
         },
         "relevanceScore": number,
         "resultId": "string",
         "type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_amazon-q-connect_QueryAssistant_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_amazon-q-connect_QueryAssistant_ResponseSyntax) **   <a name="connect-amazon-q-connect_QueryAssistant-response-nextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [results](#API_amazon-q-connect_QueryAssistant_ResponseSyntax) **   <a name="connect-amazon-q-connect_QueryAssistant-response-results"></a>
The results of the query.  
Type: Array of [ResultData](API_amazon-q-connect_ResultData.md) objects

## Errors
<a name="API_amazon-q-connect_QueryAssistant_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** RequestTimeoutException **   
The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_QueryAssistant_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/QueryAssistant) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/QueryAssistant) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/QueryAssistant) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/QueryAssistant) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/QueryAssistant) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/QueryAssistant) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/QueryAssistant) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/QueryAssistant) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/QueryAssistant) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/QueryAssistant) 

# RemoveAssistantAIAgent
<a name="API_amazon-q-connect_RemoveAssistantAIAgent"></a>

Removes the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.

## Request Syntax
<a name="API_amazon-q-connect_RemoveAssistantAIAgent_RequestSyntax"></a>

```
DELETE /assistants/assistantId/aiagentConfiguration?aiAgentType=aiAgentType&orchestratorUseCase=orchestratorUseCase HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_RemoveAssistantAIAgent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aiAgentType](#API_amazon-q-connect_RemoveAssistantAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_RemoveAssistantAIAgent-request-uri-aiAgentType"></a>
The type of the AI Agent being removed for use by default from the Amazon Q in Connect Assistant.  
Valid Values: `MANUAL_SEARCH | ANSWER_RECOMMENDATION | SELF_SERVICE | EMAIL_RESPONSE | EMAIL_OVERVIEW | EMAIL_GENERATIVE_ANSWER | ORCHESTRATION | NOTE_TAKING | CASE_SUMMARIZATION`   
Required: Yes

 ** [assistantId](#API_amazon-q-connect_RemoveAssistantAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_RemoveAssistantAIAgent-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [orchestratorUseCase](#API_amazon-q-connect_RemoveAssistantAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_RemoveAssistantAIAgent-request-uri-orchestratorUseCase"></a>
The orchestrator use case for the AI Agent being removed.  
Length Constraints: Minimum length of 1. Maximum length of 4096.

## Request Body
<a name="API_amazon-q-connect_RemoveAssistantAIAgent_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_RemoveAssistantAIAgent_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_amazon-q-connect_RemoveAssistantAIAgent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_amazon-q-connect_RemoveAssistantAIAgent_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_RemoveAssistantAIAgent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/RemoveAssistantAIAgent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/RemoveAssistantAIAgent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/RemoveAssistantAIAgent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/RemoveAssistantAIAgent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/RemoveAssistantAIAgent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/RemoveAssistantAIAgent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/RemoveAssistantAIAgent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/RemoveAssistantAIAgent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/RemoveAssistantAIAgent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/RemoveAssistantAIAgent) 

# RemoveKnowledgeBaseTemplateUri
<a name="API_amazon-q-connect_RemoveKnowledgeBaseTemplateUri"></a>

Removes a URI template from a knowledge base.

## Request Syntax
<a name="API_amazon-q-connect_RemoveKnowledgeBaseTemplateUri_RequestSyntax"></a>

```
DELETE /knowledgeBases/knowledgeBaseId/templateUri HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_RemoveKnowledgeBaseTemplateUri_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_RemoveKnowledgeBaseTemplateUri_RequestSyntax) **   <a name="connect-amazon-q-connect_RemoveKnowledgeBaseTemplateUri-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_RemoveKnowledgeBaseTemplateUri_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_RemoveKnowledgeBaseTemplateUri_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_amazon-q-connect_RemoveKnowledgeBaseTemplateUri_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_amazon-q-connect_RemoveKnowledgeBaseTemplateUri_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_RemoveKnowledgeBaseTemplateUri_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/RemoveKnowledgeBaseTemplateUri) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/RemoveKnowledgeBaseTemplateUri) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/RemoveKnowledgeBaseTemplateUri) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/RemoveKnowledgeBaseTemplateUri) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/RemoveKnowledgeBaseTemplateUri) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/RemoveKnowledgeBaseTemplateUri) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/RemoveKnowledgeBaseTemplateUri) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/RemoveKnowledgeBaseTemplateUri) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/RemoveKnowledgeBaseTemplateUri) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/RemoveKnowledgeBaseTemplateUri) 

# RenderMessageTemplate
<a name="API_amazon-q-connect_RenderMessageTemplate"></a>

Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content. For any variable present in the message template, if the attribute value is neither provided in the attribute request parameter nor the default attribute of the message template, the rendered message content will keep the variable placeholder as it is and return the attribute keys that are missing.

## Request Syntax
<a name="API_amazon-q-connect_RenderMessageTemplate_RequestSyntax"></a>

```
POST /knowledgeBases/knowledgeBaseId/messageTemplates/messageTemplateId/render HTTP/1.1
Content-type: application/json

{
   "attributes": { 
      "agentAttributes": { 
         "firstName": "string",
         "lastName": "string"
      },
      "customAttributes": { 
         "string" : "string" 
      },
      "customerProfileAttributes": { 
         "accountNumber": "string",
         "additionalInformation": "string",
         "address1": "string",
         "address2": "string",
         "address3": "string",
         "address4": "string",
         "billingAddress1": "string",
         "billingAddress2": "string",
         "billingAddress3": "string",
         "billingAddress4": "string",
         "billingCity": "string",
         "billingCountry": "string",
         "billingCounty": "string",
         "billingPostalCode": "string",
         "billingProvince": "string",
         "billingState": "string",
         "birthDate": "string",
         "businessEmailAddress": "string",
         "businessName": "string",
         "businessPhoneNumber": "string",
         "city": "string",
         "country": "string",
         "county": "string",
         "custom": { 
            "string" : "string" 
         },
         "emailAddress": "string",
         "firstName": "string",
         "gender": "string",
         "homePhoneNumber": "string",
         "lastName": "string",
         "mailingAddress1": "string",
         "mailingAddress2": "string",
         "mailingAddress3": "string",
         "mailingAddress4": "string",
         "mailingCity": "string",
         "mailingCountry": "string",
         "mailingCounty": "string",
         "mailingPostalCode": "string",
         "mailingProvince": "string",
         "mailingState": "string",
         "middleName": "string",
         "mobilePhoneNumber": "string",
         "partyType": "string",
         "phoneNumber": "string",
         "postalCode": "string",
         "profileARN": "string",
         "profileId": "string",
         "province": "string",
         "shippingAddress1": "string",
         "shippingAddress2": "string",
         "shippingAddress3": "string",
         "shippingAddress4": "string",
         "shippingCity": "string",
         "shippingCountry": "string",
         "shippingCounty": "string",
         "shippingPostalCode": "string",
         "shippingProvince": "string",
         "shippingState": "string",
         "state": "string"
      },
      "systemAttributes": { 
         "customerEndpoint": { 
            "address": "string"
         },
         "name": "string",
         "systemEndpoint": { 
            "address": "string"
         }
      }
   }
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_RenderMessageTemplate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_RenderMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_RenderMessageTemplate-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [messageTemplateId](#API_amazon-q-connect_RenderMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_RenderMessageTemplate-request-uri-messageTemplateId"></a>
The identifier of the message template. Can be either the ID or the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_RenderMessageTemplate_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [attributes](#API_amazon-q-connect_RenderMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_RenderMessageTemplate-request-attributes"></a>
An object that specifies the values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the value for that variable.  
Type: [MessageTemplateAttributes](API_amazon-q-connect_MessageTemplateAttributes.md) object  
Required: Yes

## Response Syntax
<a name="API_amazon-q-connect_RenderMessageTemplate_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "attachments": [ 
      { 
         "attachmentId": "string",
         "contentDisposition": "string",
         "name": "string",
         "uploadedTime": "string",
         "url": "string",
         "urlExpiry": "string"
      }
   ],
   "attributesNotInterpolated": [ "string" ],
   "content": { ... },
   "sourceConfigurationSummary": { ... }
}
```

## Response Elements
<a name="API_amazon-q-connect_RenderMessageTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [attachments](#API_amazon-q-connect_RenderMessageTemplate_ResponseSyntax) **   <a name="connect-amazon-q-connect_RenderMessageTemplate-response-attachments"></a>
The message template attachments.  
Type: Array of [MessageTemplateAttachment](API_amazon-q-connect_MessageTemplateAttachment.md) objects

 ** [attributesNotInterpolated](#API_amazon-q-connect_RenderMessageTemplate_ResponseSyntax) **   <a name="connect-amazon-q-connect_RenderMessageTemplate-response-attributesNotInterpolated"></a>
The attribute keys that are not resolved.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 32767.

 ** [content](#API_amazon-q-connect_RenderMessageTemplate_ResponseSyntax) **   <a name="connect-amazon-q-connect_RenderMessageTemplate-response-content"></a>
The content of the message template.  
Type: [MessageTemplateContentProvider](API_amazon-q-connect_MessageTemplateContentProvider.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

 ** [sourceConfigurationSummary](#API_amazon-q-connect_RenderMessageTemplate_ResponseSyntax) **   <a name="connect-amazon-q-connect_RenderMessageTemplate-response-sourceConfigurationSummary"></a>
The source configuration of the message template.  
Type: [MessageTemplateSourceConfigurationSummary](API_amazon-q-connect_MessageTemplateSourceConfigurationSummary.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.

## Errors
<a name="API_amazon-q-connect_RenderMessageTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_RenderMessageTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/RenderMessageTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/RenderMessageTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/RenderMessageTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/RenderMessageTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/RenderMessageTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/RenderMessageTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/RenderMessageTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/RenderMessageTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/RenderMessageTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/RenderMessageTemplate) 

# Retrieve
<a name="API_amazon-q-connect_Retrieve"></a>

Retrieves content from knowledge sources based on a query.

## Request Syntax
<a name="API_amazon-q-connect_Retrieve_RequestSyntax"></a>

```
POST /assistants/assistantId/retrieve HTTP/1.1
Content-type: application/json

{
   "retrievalConfiguration": { 
      "filter": { ... },
      "knowledgeSource": { ... },
      "numberOfResults": number,
      "overrideKnowledgeBaseSearchType": "string"
   },
   "retrievalQuery": "string"
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_Retrieve_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_Retrieve_RequestSyntax) **   <a name="connect-amazon-q-connect_Retrieve-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant for content retrieval.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_Retrieve_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [retrievalConfiguration](#API_amazon-q-connect_Retrieve_RequestSyntax) **   <a name="connect-amazon-q-connect_Retrieve-request-retrievalConfiguration"></a>
The configuration for the content retrieval operation.  
Type: [RetrievalConfiguration](API_amazon-q-connect_RetrievalConfiguration.md) object  
Required: Yes

 ** [retrievalQuery](#API_amazon-q-connect_Retrieve_RequestSyntax) **   <a name="connect-amazon-q-connect_Retrieve-request-retrievalQuery"></a>
The query for content retrieval.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

## Response Syntax
<a name="API_amazon-q-connect_Retrieve_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "results": [ 
      { 
         "associationId": "string",
         "contentText": "string",
         "referenceType": "string",
         "sourceId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_amazon-q-connect_Retrieve_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [results](#API_amazon-q-connect_Retrieve_ResponseSyntax) **   <a name="connect-amazon-q-connect_Retrieve-response-results"></a>
The results of the content retrieval operation.  
Type: Array of [RetrieveResult](API_amazon-q-connect_RetrieveResult.md) objects

## Errors
<a name="API_amazon-q-connect_Retrieve_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** DependencyFailedException **   
The request failed because it depends on another request that failed.  
HTTP Status Code: 424

 ** RequestTimeoutException **   
The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.  
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_Retrieve_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/Retrieve) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/Retrieve) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/Retrieve) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/Retrieve) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/Retrieve) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/Retrieve) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/Retrieve) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/Retrieve) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/Retrieve) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/Retrieve) 

# SearchContent
<a name="API_amazon-q-connect_SearchContent"></a>

Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.

## Request Syntax
<a name="API_amazon-q-connect_SearchContent_RequestSyntax"></a>

```
POST /knowledgeBases/knowledgeBaseId/search?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "searchExpression": { 
      "filters": [ 
         { 
            "field": "string",
            "operator": "string",
            "value": "string"
         }
      ]
   }
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_SearchContent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_SearchContent_RequestSyntax) **   <a name="connect-amazon-q-connect_SearchContent-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. This should not be a QUICK\$1RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [maxResults](#API_amazon-q-connect_SearchContent_RequestSyntax) **   <a name="connect-amazon-q-connect_SearchContent-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_amazon-q-connect_SearchContent_RequestSyntax) **   <a name="connect-amazon-q-connect_SearchContent-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Request Body
<a name="API_amazon-q-connect_SearchContent_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [searchExpression](#API_amazon-q-connect_SearchContent_RequestSyntax) **   <a name="connect-amazon-q-connect_SearchContent-request-searchExpression"></a>
The search expression to filter results.  
Type: [SearchExpression](API_amazon-q-connect_SearchExpression.md) object  
Required: Yes

## Response Syntax
<a name="API_amazon-q-connect_SearchContent_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "contentSummaries": [ 
      { 
         "contentArn": "string",
         "contentId": "string",
         "contentType": "string",
         "knowledgeBaseArn": "string",
         "knowledgeBaseId": "string",
         "metadata": { 
            "string" : "string" 
         },
         "name": "string",
         "revisionId": "string",
         "status": "string",
         "tags": { 
            "string" : "string" 
         },
         "title": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_amazon-q-connect_SearchContent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [contentSummaries](#API_amazon-q-connect_SearchContent_ResponseSyntax) **   <a name="connect-amazon-q-connect_SearchContent-response-contentSummaries"></a>
Summary information about the content.  
Type: Array of [ContentSummary](API_amazon-q-connect_ContentSummary.md) objects

 ** [nextToken](#API_amazon-q-connect_SearchContent_ResponseSyntax) **   <a name="connect-amazon-q-connect_SearchContent-response-nextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_amazon-q-connect_SearchContent_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_SearchContent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/SearchContent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/SearchContent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SearchContent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/SearchContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SearchContent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/SearchContent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/SearchContent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/SearchContent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/SearchContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SearchContent) 

# SearchMessageTemplates
<a name="API_amazon-q-connect_SearchMessageTemplates"></a>

Searches for Amazon Q in Connect message templates in the specified knowledge base.

## Request Syntax
<a name="API_amazon-q-connect_SearchMessageTemplates_RequestSyntax"></a>

```
POST /knowledgeBases/knowledgeBaseId/search/messageTemplates?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "searchExpression": { 
      "filters": [ 
         { 
            "includeNoExistence": boolean,
            "name": "string",
            "operator": "string",
            "values": [ "string" ]
         }
      ],
      "orderOnField": { 
         "name": "string",
         "order": "string"
      },
      "queries": [ 
         { 
            "allowFuzziness": boolean,
            "name": "string",
            "operator": "string",
            "priority": "string",
            "values": [ "string" ]
         }
      ]
   }
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_SearchMessageTemplates_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_SearchMessageTemplates_RequestSyntax) **   <a name="connect-amazon-q-connect_SearchMessageTemplates-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [maxResults](#API_amazon-q-connect_SearchMessageTemplates_RequestSyntax) **   <a name="connect-amazon-q-connect_SearchMessageTemplates-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_amazon-q-connect_SearchMessageTemplates_RequestSyntax) **   <a name="connect-amazon-q-connect_SearchMessageTemplates-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Request Body
<a name="API_amazon-q-connect_SearchMessageTemplates_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [searchExpression](#API_amazon-q-connect_SearchMessageTemplates_RequestSyntax) **   <a name="connect-amazon-q-connect_SearchMessageTemplates-request-searchExpression"></a>
The search expression for querying the message template.  
Type: [MessageTemplateSearchExpression](API_amazon-q-connect_MessageTemplateSearchExpression.md) object  
Required: Yes

## Response Syntax
<a name="API_amazon-q-connect_SearchMessageTemplates_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "results": [ 
      { 
         "channel": "string",
         "channelSubtype": "string",
         "createdTime": "string",
         "description": "string",
         "groupingConfiguration": { 
            "criteria": "string",
            "values": [ "string" ]
         },
         "isActive": boolean,
         "knowledgeBaseArn": "string",
         "knowledgeBaseId": "string",
         "language": "string",
         "lastModifiedBy": "string",
         "lastModifiedTime": "string",
         "messageTemplateArn": "string",
         "messageTemplateId": "string",
         "name": "string",
         "sourceConfigurationSummary": { ... },
         "tags": { 
            "string" : "string" 
         },
         "versionNumber": number
      }
   ]
}
```

## Response Elements
<a name="API_amazon-q-connect_SearchMessageTemplates_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_amazon-q-connect_SearchMessageTemplates_ResponseSyntax) **   <a name="connect-amazon-q-connect_SearchMessageTemplates-response-nextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [results](#API_amazon-q-connect_SearchMessageTemplates_ResponseSyntax) **   <a name="connect-amazon-q-connect_SearchMessageTemplates-response-results"></a>
The results of the message template search.  
Type: Array of [MessageTemplateSearchResultData](API_amazon-q-connect_MessageTemplateSearchResultData.md) objects

## Errors
<a name="API_amazon-q-connect_SearchMessageTemplates_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_SearchMessageTemplates_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/SearchMessageTemplates) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/SearchMessageTemplates) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SearchMessageTemplates) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/SearchMessageTemplates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SearchMessageTemplates) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/SearchMessageTemplates) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/SearchMessageTemplates) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/SearchMessageTemplates) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/SearchMessageTemplates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SearchMessageTemplates) 

# SearchQuickResponses
<a name="API_amazon-q-connect_SearchQuickResponses"></a>

Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.

## Request Syntax
<a name="API_amazon-q-connect_SearchQuickResponses_RequestSyntax"></a>

```
POST /knowledgeBases/knowledgeBaseId/search/quickResponses?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "attributes": { 
      "string" : "string" 
   },
   "searchExpression": { 
      "filters": [ 
         { 
            "includeNoExistence": boolean,
            "name": "string",
            "operator": "string",
            "values": [ "string" ]
         }
      ],
      "orderOnField": { 
         "name": "string",
         "order": "string"
      },
      "queries": [ 
         { 
            "allowFuzziness": boolean,
            "name": "string",
            "operator": "string",
            "priority": "string",
            "values": [ "string" ]
         }
      ]
   }
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_SearchQuickResponses_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_SearchQuickResponses_RequestSyntax) **   <a name="connect-amazon-q-connect_SearchQuickResponses-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. This should be a QUICK\$1RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [maxResults](#API_amazon-q-connect_SearchQuickResponses_RequestSyntax) **   <a name="connect-amazon-q-connect_SearchQuickResponses-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_amazon-q-connect_SearchQuickResponses_RequestSyntax) **   <a name="connect-amazon-q-connect_SearchQuickResponses-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 4096.

## Request Body
<a name="API_amazon-q-connect_SearchQuickResponses_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [attributes](#API_amazon-q-connect_SearchQuickResponses_RequestSyntax) **   <a name="connect-amazon-q-connect_SearchQuickResponses-request-attributes"></a>
The [user-defined Amazon Connect contact attributes](https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes) to be resolved when search results are returned.  
Type: String to string map  
Required: No

 ** [searchExpression](#API_amazon-q-connect_SearchQuickResponses_RequestSyntax) **   <a name="connect-amazon-q-connect_SearchQuickResponses-request-searchExpression"></a>
The search expression for querying the quick response.  
Type: [QuickResponseSearchExpression](API_amazon-q-connect_QuickResponseSearchExpression.md) object  
Required: Yes

## Response Syntax
<a name="API_amazon-q-connect_SearchQuickResponses_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "results": [ 
      { 
         "attributesInterpolated": [ "string" ],
         "attributesNotInterpolated": [ "string" ],
         "channels": [ "string" ],
         "contents": { 
            "markdown": { ... },
            "plainText": { ... }
         },
         "contentType": "string",
         "createdTime": number,
         "description": "string",
         "groupingConfiguration": { 
            "criteria": "string",
            "values": [ "string" ]
         },
         "isActive": boolean,
         "knowledgeBaseArn": "string",
         "knowledgeBaseId": "string",
         "language": "string",
         "lastModifiedBy": "string",
         "lastModifiedTime": number,
         "name": "string",
         "quickResponseArn": "string",
         "quickResponseId": "string",
         "shortcutKey": "string",
         "status": "string",
         "tags": { 
            "string" : "string" 
         }
      }
   ]
}
```

## Response Elements
<a name="API_amazon-q-connect_SearchQuickResponses_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_amazon-q-connect_SearchQuickResponses_ResponseSyntax) **   <a name="connect-amazon-q-connect_SearchQuickResponses-response-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.

 ** [results](#API_amazon-q-connect_SearchQuickResponses_ResponseSyntax) **   <a name="connect-amazon-q-connect_SearchQuickResponses-response-results"></a>
The results of the quick response search.  
Type: Array of [QuickResponseSearchResultData](API_amazon-q-connect_QuickResponseSearchResultData.md) objects

## Errors
<a name="API_amazon-q-connect_SearchQuickResponses_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** RequestTimeoutException **   
The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_SearchQuickResponses_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/SearchQuickResponses) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/SearchQuickResponses) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SearchQuickResponses) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/SearchQuickResponses) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SearchQuickResponses) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/SearchQuickResponses) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/SearchQuickResponses) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/SearchQuickResponses) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/SearchQuickResponses) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SearchQuickResponses) 

# SearchSessions
<a name="API_amazon-q-connect_SearchSessions"></a>

Searches for sessions.

## Request Syntax
<a name="API_amazon-q-connect_SearchSessions_RequestSyntax"></a>

```
POST /assistants/assistantId/searchSessions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "searchExpression": { 
      "filters": [ 
         { 
            "field": "string",
            "operator": "string",
            "value": "string"
         }
      ]
   }
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_SearchSessions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_SearchSessions_RequestSyntax) **   <a name="connect-amazon-q-connect_SearchSessions-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [maxResults](#API_amazon-q-connect_SearchSessions_RequestSyntax) **   <a name="connect-amazon-q-connect_SearchSessions-request-uri-maxResults"></a>
The maximum number of results to return per page.  
Valid Range: Minimum value of 1. Maximum value of 100.

 ** [nextToken](#API_amazon-q-connect_SearchSessions_RequestSyntax) **   <a name="connect-amazon-q-connect_SearchSessions-request-uri-nextToken"></a>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Request Body
<a name="API_amazon-q-connect_SearchSessions_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [searchExpression](#API_amazon-q-connect_SearchSessions_RequestSyntax) **   <a name="connect-amazon-q-connect_SearchSessions-request-searchExpression"></a>
The search expression to filter results.  
Type: [SearchExpression](API_amazon-q-connect_SearchExpression.md) object  
Required: Yes

## Response Syntax
<a name="API_amazon-q-connect_SearchSessions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "sessionSummaries": [ 
      { 
         "assistantArn": "string",
         "assistantId": "string",
         "sessionArn": "string",
         "sessionId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_amazon-q-connect_SearchSessions_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [nextToken](#API_amazon-q-connect_SearchSessions_ResponseSyntax) **   <a name="connect-amazon-q-connect_SearchSessions-response-nextToken"></a>
If there are additional results, this is the token for the next set of results.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [sessionSummaries](#API_amazon-q-connect_SearchSessions_ResponseSyntax) **   <a name="connect-amazon-q-connect_SearchSessions-response-sessionSummaries"></a>
Summary information about the sessions.  
Type: Array of [SessionSummary](API_amazon-q-connect_SessionSummary.md) objects

## Errors
<a name="API_amazon-q-connect_SearchSessions_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_SearchSessions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/SearchSessions) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/SearchSessions) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SearchSessions) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/SearchSessions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SearchSessions) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/SearchSessions) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/SearchSessions) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/SearchSessions) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/SearchSessions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SearchSessions) 

# SendMessage
<a name="API_amazon-q-connect_SendMessage"></a>

Submits a message to the Amazon Q in Connect session.

## Request Syntax
<a name="API_amazon-q-connect_SendMessage_RequestSyntax"></a>

```
POST /assistants/assistantId/sessions/sessionId/message HTTP/1.1
Content-type: application/json

{
   "aiAgentId": "string",
   "clientToken": "string",
   "configuration": { 
      "generateChunkedMessage": boolean,
      "generateFillerMessage": boolean
   },
   "conversationContext": { 
      "selfServiceConversationHistory": [ 
         { 
            "botResponse": "string",
            "inputTranscript": "string",
            "timestamp": number,
            "turnNumber": number
         }
      ]
   },
   "message": { 
      "value": { ... }
   },
   "metadata": { 
      "string" : "string" 
   },
   "orchestratorUseCase": "string",
   "type": "string"
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_SendMessage_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_SendMessage_RequestSyntax) **   <a name="connect-amazon-q-connect_SendMessage-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [sessionId](#API_amazon-q-connect_SendMessage_RequestSyntax) **   <a name="connect-amazon-q-connect_SendMessage-request-uri-sessionId"></a>
The identifier of the Amazon Q in Connect session.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_SendMessage_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [aiAgentId](#API_amazon-q-connect_SendMessage_RequestSyntax) **   <a name="connect-amazon-q-connect_SendMessage-request-aiAgentId"></a>
The identifier of the AI Agent to use for processing the message.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: No

 ** [clientToken](#API_amazon-q-connect_SendMessage_RequestSyntax) **   <a name="connect-amazon-q-connect_SendMessage-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field.For more information about idempotency, see Making retries safe with idempotent APIs.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [configuration](#API_amazon-q-connect_SendMessage_RequestSyntax) **   <a name="connect-amazon-q-connect_SendMessage-request-configuration"></a>
The configuration of the [SendMessage](https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_SendMessage.html) request.  
Type: [MessageConfiguration](API_amazon-q-connect_MessageConfiguration.md) object  
Required: No

 ** [conversationContext](#API_amazon-q-connect_SendMessage_RequestSyntax) **   <a name="connect-amazon-q-connect_SendMessage-request-conversationContext"></a>
The conversation context before the Amazon Q in Connect session.  
Type: [ConversationContext](API_amazon-q-connect_ConversationContext.md) object  
Required: No

 ** [message](#API_amazon-q-connect_SendMessage_RequestSyntax) **   <a name="connect-amazon-q-connect_SendMessage-request-message"></a>
The message data to submit to the Amazon Q in Connect session.  
Type: [MessageInput](API_amazon-q-connect_MessageInput.md) object  
Required: Yes

 ** [metadata](#API_amazon-q-connect_SendMessage_RequestSyntax) **   <a name="connect-amazon-q-connect_SendMessage-request-metadata"></a>
Additional metadata for the message.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 4096.  
Value Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [orchestratorUseCase](#API_amazon-q-connect_SendMessage_RequestSyntax) **   <a name="connect-amazon-q-connect_SendMessage-request-orchestratorUseCase"></a>
The orchestrator use case for message processing.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [type](#API_amazon-q-connect_SendMessage_RequestSyntax) **   <a name="connect-amazon-q-connect_SendMessage-request-type"></a>
The message type.  
Type: String  
Valid Values: `TEXT`   
Required: Yes

## Response Syntax
<a name="API_amazon-q-connect_SendMessage_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "configuration": { 
      "generateChunkedMessage": boolean,
      "generateFillerMessage": boolean
   },
   "nextMessageToken": "string",
   "requestMessageId": "string"
}
```

## Response Elements
<a name="API_amazon-q-connect_SendMessage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [configuration](#API_amazon-q-connect_SendMessage_ResponseSyntax) **   <a name="connect-amazon-q-connect_SendMessage-response-configuration"></a>
The configuration of the [SendMessage](https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_SendMessage.html) request.  
Type: [MessageConfiguration](API_amazon-q-connect_MessageConfiguration.md) object

 ** [nextMessageToken](#API_amazon-q-connect_SendMessage_ResponseSyntax) **   <a name="connect-amazon-q-connect_SendMessage-response-nextMessageToken"></a>
The token for the next message, used by GetNextMessage.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [requestMessageId](#API_amazon-q-connect_SendMessage_ResponseSyntax) **   <a name="connect-amazon-q-connect_SendMessage-response-requestMessageId"></a>
The identifier of the submitted message.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

## Errors
<a name="API_amazon-q-connect_SendMessage_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** DependencyFailedException **   
The request failed because it depends on another request that failed.  
HTTP Status Code: 424

 ** RequestTimeoutException **   
The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.  
HTTP Status Code: 408

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.  
HTTP Status Code: 402

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_SendMessage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/SendMessage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/SendMessage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/SendMessage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/SendMessage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/SendMessage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/SendMessage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/SendMessage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/SendMessage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/SendMessage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/SendMessage) 

# StartContentUpload
<a name="API_amazon-q-connect_StartContentUpload"></a>

Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use [CreateContent](https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_CreateContent.html) to finalize the content creation process or [UpdateContent](https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_UpdateContent.html) to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.

## Request Syntax
<a name="API_amazon-q-connect_StartContentUpload_RequestSyntax"></a>

```
POST /knowledgeBases/knowledgeBaseId/upload HTTP/1.1
Content-type: application/json

{
   "contentType": "string",
   "presignedUrlTimeToLive": number
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_StartContentUpload_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_StartContentUpload_RequestSyntax) **   <a name="connect-amazon-q-connect_StartContentUpload-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_StartContentUpload_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [contentType](#API_amazon-q-connect_StartContentUpload_RequestSyntax) **   <a name="connect-amazon-q-connect_StartContentUpload-request-contentType"></a>
The type of content to upload.  
Type: String  
Pattern: `(text/(plain|html|csv))|(application/(pdf|vnd\.openxmlformats-officedocument\.wordprocessingml\.document))|(application/x\.wisdom-json;source=(salesforce|servicenow|zendesk))`   
Required: Yes

 ** [presignedUrlTimeToLive](#API_amazon-q-connect_StartContentUpload_RequestSyntax) **   <a name="connect-amazon-q-connect_StartContentUpload-request-presignedUrlTimeToLive"></a>
The expected expiration time of the generated presigned URL, specified in minutes.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 60.  
Required: No

## Response Syntax
<a name="API_amazon-q-connect_StartContentUpload_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "headersToInclude": { 
      "string" : "string" 
   },
   "uploadId": "string",
   "url": "string",
   "urlExpiry": number
}
```

## Response Elements
<a name="API_amazon-q-connect_StartContentUpload_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [headersToInclude](#API_amazon-q-connect_StartContentUpload_ResponseSyntax) **   <a name="connect-amazon-q-connect_StartContentUpload-response-headersToInclude"></a>
The headers to include in the upload.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 4096.  
Value Length Constraints: Minimum length of 1. Maximum length of 4096.

 ** [uploadId](#API_amazon-q-connect_StartContentUpload_ResponseSyntax) **   <a name="connect-amazon-q-connect_StartContentUpload-response-uploadId"></a>
The identifier of the upload.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1200.

 ** [url](#API_amazon-q-connect_StartContentUpload_ResponseSyntax) **   <a name="connect-amazon-q-connect_StartContentUpload-response-url"></a>
The URL of the upload.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.

 ** [urlExpiry](#API_amazon-q-connect_StartContentUpload_ResponseSyntax) **   <a name="connect-amazon-q-connect_StartContentUpload-response-urlExpiry"></a>
The expiration time of the URL as an epoch timestamp.  
Type: Timestamp

## Errors
<a name="API_amazon-q-connect_StartContentUpload_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_StartContentUpload_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/StartContentUpload) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/StartContentUpload) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/StartContentUpload) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/StartContentUpload) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/StartContentUpload) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/StartContentUpload) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/StartContentUpload) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/StartContentUpload) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/StartContentUpload) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/StartContentUpload) 

# StartImportJob
<a name="API_amazon-q-connect_StartImportJob"></a>

Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. Before calling this API, use [StartContentUpload](https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html) to upload an asset that contains the resource data.
+ For importing Amazon Q in Connect quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see [Import quick responses](https://docs.aws.amazon.com/console/connect/quick-responses/add-data).

## Request Syntax
<a name="API_amazon-q-connect_StartImportJob_RequestSyntax"></a>

```
POST /knowledgeBases/knowledgeBaseId/importJobs HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "externalSourceConfiguration": { 
      "configuration": { ... },
      "source": "string"
   },
   "importJobType": "string",
   "metadata": { 
      "string" : "string" 
   },
   "uploadId": "string"
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_StartImportJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_StartImportJob_RequestSyntax) **   <a name="connect-amazon-q-connect_StartImportJob-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
+ For importing Amazon Q in Connect quick responses, this should be a `QUICK_RESPONSES` type knowledge base.
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_StartImportJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_amazon-q-connect_StartImportJob_RequestSyntax) **   <a name="connect-amazon-q-connect_StartImportJob-request-clientToken"></a>
The tags used to organize, track, or control access for this resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [externalSourceConfiguration](#API_amazon-q-connect_StartImportJob_RequestSyntax) **   <a name="connect-amazon-q-connect_StartImportJob-request-externalSourceConfiguration"></a>
The configuration information of the external source that the resource data are imported from.  
Type: [ExternalSourceConfiguration](API_amazon-q-connect_ExternalSourceConfiguration.md) object  
Required: No

 ** [importJobType](#API_amazon-q-connect_StartImportJob_RequestSyntax) **   <a name="connect-amazon-q-connect_StartImportJob-request-importJobType"></a>
The type of the import job.  
+ For importing quick response resource, set the value to `QUICK_RESPONSES`.
Type: String  
Valid Values: `QUICK_RESPONSES`   
Required: Yes

 ** [metadata](#API_amazon-q-connect_StartImportJob_RequestSyntax) **   <a name="connect-amazon-q-connect_StartImportJob-request-metadata"></a>
The metadata fields of the imported Amazon Q in Connect resources.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 10 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 4096.  
Value Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [uploadId](#API_amazon-q-connect_StartImportJob_RequestSyntax) **   <a name="connect-amazon-q-connect_StartImportJob-request-uploadId"></a>
A pointer to the uploaded asset. This value is returned by [StartContentUpload](https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1200.  
Required: Yes

## Response Syntax
<a name="API_amazon-q-connect_StartImportJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "importJob": { 
      "createdTime": number,
      "externalSourceConfiguration": { 
         "configuration": { ... },
         "source": "string"
      },
      "failedRecordReport": "string",
      "importJobId": "string",
      "importJobType": "string",
      "knowledgeBaseArn": "string",
      "knowledgeBaseId": "string",
      "lastModifiedTime": number,
      "metadata": { 
         "string" : "string" 
      },
      "status": "string",
      "uploadId": "string",
      "url": "string",
      "urlExpiry": number
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_StartImportJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [importJob](#API_amazon-q-connect_StartImportJob_ResponseSyntax) **   <a name="connect-amazon-q-connect_StartImportJob-response-importJob"></a>
The import job.  
Type: [ImportJobData](API_amazon-q-connect_ImportJobData.md) object

## Errors
<a name="API_amazon-q-connect_StartImportJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ServiceQuotaExceededException **   
You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.  
HTTP Status Code: 402

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_StartImportJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/StartImportJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/StartImportJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/StartImportJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/StartImportJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/StartImportJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/StartImportJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/StartImportJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/StartImportJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/StartImportJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/StartImportJob) 

# TagResource
<a name="API_amazon-q-connect_TagResource"></a>

Adds the specified tags to the specified resource.

## Request Syntax
<a name="API_amazon-q-connect_TagResource_RequestSyntax"></a>

```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_amazon-q-connect_TagResource_RequestSyntax) **   <a name="connect-amazon-q-connect_TagResource-request-uri-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource.  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [tags](#API_amazon-q-connect_TagResource_RequestSyntax) **   <a name="connect-amazon-q-connect_TagResource-request-tags"></a>
The tags used to organize, track, or control access for this resource.  
Type: String to string map  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Value Length Constraints: Minimum length of 1. Maximum length of 256.  
Required: Yes

## Response Syntax
<a name="API_amazon-q-connect_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_amazon-q-connect_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_amazon-q-connect_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** TooManyTagsException **   
Amazon Q in Connect throws this exception if you have too many tags in your tag set.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/TagResource) 

# UntagResource
<a name="API_amazon-q-connect_UntagResource"></a>

Removes the specified tags from the specified resource.

## Request Syntax
<a name="API_amazon-q-connect_UntagResource_RequestSyntax"></a>

```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_amazon-q-connect_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_amazon-q-connect_UntagResource_RequestSyntax) **   <a name="connect-amazon-q-connect_UntagResource-request-uri-resourceArn"></a>
The Amazon Resource Name (ARN) of the resource.  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [tagKeys](#API_amazon-q-connect_UntagResource_RequestSyntax) **   <a name="connect-amazon-q-connect_UntagResource-request-uri-tagKeys"></a>
The tag keys.  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `(?!aws:)[a-zA-Z+-=._:/]+`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_amazon-q-connect_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_amazon-q-connect_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_amazon-q-connect_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

## See Also
<a name="API_amazon-q-connect_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/UntagResource) 

# UpdateAIAgent
<a name="API_amazon-q-connect_UpdateAIAgent"></a>

Updates an AI Agent.

## Request Syntax
<a name="API_amazon-q-connect_UpdateAIAgent_RequestSyntax"></a>

```
POST /assistants/assistantId/aiagents/aiAgentId HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "configuration": { ... },
   "description": "string",
   "visibilityStatus": "string"
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_UpdateAIAgent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aiAgentId](#API_amazon-q-connect_UpdateAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIAgent-request-uri-aiAgentId"></a>
The identifier of the Amazon Q in Connect AI Agent.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** [assistantId](#API_amazon-q-connect_UpdateAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIAgent-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_UpdateAIAgent_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_amazon-q-connect_UpdateAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIAgent-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)..  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [configuration](#API_amazon-q-connect_UpdateAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIAgent-request-configuration"></a>
The configuration of the Amazon Q in Connect AI Agent.  
Type: [AIAgentConfiguration](API_amazon-q-connect_AIAgentConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [description](#API_amazon-q-connect_UpdateAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIAgent-request-description"></a>
The description of the Amazon Q in Connect AI Agent.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** [visibilityStatus](#API_amazon-q-connect_UpdateAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIAgent-request-visibilityStatus"></a>
The visbility status of the Amazon Q in Connect AI Agent.  
Type: String  
Valid Values: `SAVED | PUBLISHED`   
Required: Yes

## Response Syntax
<a name="API_amazon-q-connect_UpdateAIAgent_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "aiAgent": { 
      "aiAgentArn": "string",
      "aiAgentId": "string",
      "assistantArn": "string",
      "assistantId": "string",
      "configuration": { ... },
      "description": "string",
      "modifiedTime": number,
      "name": "string",
      "origin": "string",
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "type": "string",
      "visibilityStatus": "string"
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_UpdateAIAgent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [aiAgent](#API_amazon-q-connect_UpdateAIAgent_ResponseSyntax) **   <a name="connect-amazon-q-connect_UpdateAIAgent-response-aiAgent"></a>
The data of the updated Amazon Q in Connect AI Agent.  
Type: [AIAgentData](API_amazon-q-connect_AIAgentData.md) object

## Errors
<a name="API_amazon-q-connect_UpdateAIAgent_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_UpdateAIAgent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/UpdateAIAgent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/UpdateAIAgent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/UpdateAIAgent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/UpdateAIAgent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/UpdateAIAgent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/UpdateAIAgent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/UpdateAIAgent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/UpdateAIAgent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/UpdateAIAgent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/UpdateAIAgent) 

# UpdateAIGuardrail
<a name="API_amazon-q-connect_UpdateAIGuardrail"></a>

Updates an AI Guardrail.

## Request Syntax
<a name="API_amazon-q-connect_UpdateAIGuardrail_RequestSyntax"></a>

```
POST /assistants/assistantId/aiguardrails/aiGuardrailId HTTP/1.1
Content-type: application/json

{
   "blockedInputMessaging": "string",
   "blockedOutputsMessaging": "string",
   "clientToken": "string",
   "contentPolicyConfig": { 
      "filtersConfig": [ 
         { 
            "inputStrength": "string",
            "outputStrength": "string",
            "type": "string"
         }
      ]
   },
   "contextualGroundingPolicyConfig": { 
      "filtersConfig": [ 
         { 
            "threshold": number,
            "type": "string"
         }
      ]
   },
   "description": "string",
   "sensitiveInformationPolicyConfig": { 
      "piiEntitiesConfig": [ 
         { 
            "action": "string",
            "type": "string"
         }
      ],
      "regexesConfig": [ 
         { 
            "action": "string",
            "description": "string",
            "name": "string",
            "pattern": "string"
         }
      ]
   },
   "topicPolicyConfig": { 
      "topicsConfig": [ 
         { 
            "definition": "string",
            "examples": [ "string" ],
            "name": "string",
            "type": "string"
         }
      ]
   },
   "visibilityStatus": "string",
   "wordPolicyConfig": { 
      "managedWordListsConfig": [ 
         { 
            "type": "string"
         }
      ],
      "wordsConfig": [ 
         { 
            "text": "string"
         }
      ]
   }
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_UpdateAIGuardrail_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aiGuardrailId](#API_amazon-q-connect_UpdateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIGuardrail-request-uri-aiGuardrailId"></a>
The identifier of the Amazon Q in Connect AI Guardrail.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** [assistantId](#API_amazon-q-connect_UpdateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIGuardrail-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_UpdateAIGuardrail_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [blockedInputMessaging](#API_amazon-q-connect_UpdateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIGuardrail-request-blockedInputMessaging"></a>
The message to return when the AI Guardrail blocks a prompt.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [blockedOutputsMessaging](#API_amazon-q-connect_UpdateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIGuardrail-request-blockedOutputsMessaging"></a>
The message to return when the AI Guardrail blocks a model response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 500.  
Required: Yes

 ** [clientToken](#API_amazon-q-connect_UpdateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIGuardrail-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)..  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [contentPolicyConfig](#API_amazon-q-connect_UpdateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIGuardrail-request-contentPolicyConfig"></a>
The content filter policies to configure for the AI Guardrail.  
Type: [AIGuardrailContentPolicyConfig](API_amazon-q-connect_AIGuardrailContentPolicyConfig.md) object  
Required: No

 ** [contextualGroundingPolicyConfig](#API_amazon-q-connect_UpdateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIGuardrail-request-contextualGroundingPolicyConfig"></a>
The contextual grounding policy configuration used to create an AI Guardrail.  
Type: [AIGuardrailContextualGroundingPolicyConfig](API_amazon-q-connect_AIGuardrailContextualGroundingPolicyConfig.md) object  
Required: No

 ** [description](#API_amazon-q-connect_UpdateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIGuardrail-request-description"></a>
A description of the AI Guardrail.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: No

 ** [sensitiveInformationPolicyConfig](#API_amazon-q-connect_UpdateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIGuardrail-request-sensitiveInformationPolicyConfig"></a>
The sensitive information policy to configure for the AI Guardrail.  
Type: [AIGuardrailSensitiveInformationPolicyConfig](API_amazon-q-connect_AIGuardrailSensitiveInformationPolicyConfig.md) object  
Required: No

 ** [topicPolicyConfig](#API_amazon-q-connect_UpdateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIGuardrail-request-topicPolicyConfig"></a>
The topic policies to configure for the AI Guardrail.  
Type: [AIGuardrailTopicPolicyConfig](API_amazon-q-connect_AIGuardrailTopicPolicyConfig.md) object  
Required: No

 ** [visibilityStatus](#API_amazon-q-connect_UpdateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIGuardrail-request-visibilityStatus"></a>
The visibility status of the Amazon Q in Connect AI Guardrail.  
Type: String  
Valid Values: `SAVED | PUBLISHED`   
Required: Yes

 ** [wordPolicyConfig](#API_amazon-q-connect_UpdateAIGuardrail_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIGuardrail-request-wordPolicyConfig"></a>
The word policy you configure for the AI Guardrail.  
Type: [AIGuardrailWordPolicyConfig](API_amazon-q-connect_AIGuardrailWordPolicyConfig.md) object  
Required: No

## Response Syntax
<a name="API_amazon-q-connect_UpdateAIGuardrail_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "aiGuardrail": { 
      "aiGuardrailArn": "string",
      "aiGuardrailId": "string",
      "assistantArn": "string",
      "assistantId": "string",
      "blockedInputMessaging": "string",
      "blockedOutputsMessaging": "string",
      "contentPolicyConfig": { 
         "filtersConfig": [ 
            { 
               "inputStrength": "string",
               "outputStrength": "string",
               "type": "string"
            }
         ]
      },
      "contextualGroundingPolicyConfig": { 
         "filtersConfig": [ 
            { 
               "threshold": number,
               "type": "string"
            }
         ]
      },
      "description": "string",
      "modifiedTime": number,
      "name": "string",
      "sensitiveInformationPolicyConfig": { 
         "piiEntitiesConfig": [ 
            { 
               "action": "string",
               "type": "string"
            }
         ],
         "regexesConfig": [ 
            { 
               "action": "string",
               "description": "string",
               "name": "string",
               "pattern": "string"
            }
         ]
      },
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "topicPolicyConfig": { 
         "topicsConfig": [ 
            { 
               "definition": "string",
               "examples": [ "string" ],
               "name": "string",
               "type": "string"
            }
         ]
      },
      "visibilityStatus": "string",
      "wordPolicyConfig": { 
         "managedWordListsConfig": [ 
            { 
               "type": "string"
            }
         ],
         "wordsConfig": [ 
            { 
               "text": "string"
            }
         ]
      }
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_UpdateAIGuardrail_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [aiGuardrail](#API_amazon-q-connect_UpdateAIGuardrail_ResponseSyntax) **   <a name="connect-amazon-q-connect_UpdateAIGuardrail-response-aiGuardrail"></a>
The data of the updated Amazon Q in Connect AI Guardrail.  
Type: [AIGuardrailData](API_amazon-q-connect_AIGuardrailData.md) object

## Errors
<a name="API_amazon-q-connect_UpdateAIGuardrail_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_UpdateAIGuardrail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/UpdateAIGuardrail) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/UpdateAIGuardrail) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/UpdateAIGuardrail) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/UpdateAIGuardrail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/UpdateAIGuardrail) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/UpdateAIGuardrail) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/UpdateAIGuardrail) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/UpdateAIGuardrail) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/UpdateAIGuardrail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/UpdateAIGuardrail) 

# UpdateAIPrompt
<a name="API_amazon-q-connect_UpdateAIPrompt"></a>

Updates an AI Prompt.

## Request Syntax
<a name="API_amazon-q-connect_UpdateAIPrompt_RequestSyntax"></a>

```
POST /assistants/assistantId/aiprompts/aiPromptId HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "inferenceConfiguration": { ... },
   "modelId": "string",
   "templateConfiguration": { ... },
   "visibilityStatus": "string"
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_UpdateAIPrompt_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aiPromptId](#API_amazon-q-connect_UpdateAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIPrompt-request-uri-aiPromptId"></a>
The identifier of the Amazon Q in Connect AI Prompt.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

 ** [assistantId](#API_amazon-q-connect_UpdateAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIPrompt-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_UpdateAIPrompt_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_amazon-q-connect_UpdateAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIPrompt-request-clientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/)..  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [description](#API_amazon-q-connect_UpdateAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIPrompt-request-description"></a>
The description of the Amazon Q in Connect AI Prompt.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** [inferenceConfiguration](#API_amazon-q-connect_UpdateAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIPrompt-request-inferenceConfiguration"></a>
The updated inference configuration for the AI Prompt.  
Type: [AIPromptInferenceConfiguration](API_amazon-q-connect_AIPromptInferenceConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [modelId](#API_amazon-q-connect_UpdateAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIPrompt-request-modelId"></a>
The identifier of the model used for this AI Prompt.  
For information about which models are supported in each AWS Region, see [Supported models for system/custom prompts](https://docs.aws.amazon.com/connect/latest/adminguide/create-ai-prompts.html#cli-create-aiprompt).
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [templateConfiguration](#API_amazon-q-connect_UpdateAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIPrompt-request-templateConfiguration"></a>
The configuration of the prompt template for this AI Prompt.  
Type: [AIPromptTemplateConfiguration](API_amazon-q-connect_AIPromptTemplateConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [visibilityStatus](#API_amazon-q-connect_UpdateAIPrompt_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAIPrompt-request-visibilityStatus"></a>
The visibility status of the Amazon Q in Connect AI prompt.  
Type: String  
Valid Values: `SAVED | PUBLISHED`   
Required: Yes

## Response Syntax
<a name="API_amazon-q-connect_UpdateAIPrompt_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "aiPrompt": { 
      "aiPromptArn": "string",
      "aiPromptId": "string",
      "apiFormat": "string",
      "assistantArn": "string",
      "assistantId": "string",
      "description": "string",
      "inferenceConfiguration": { ... },
      "modelId": "string",
      "modifiedTime": number,
      "name": "string",
      "origin": "string",
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "templateConfiguration": { ... },
      "templateType": "string",
      "type": "string",
      "visibilityStatus": "string"
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_UpdateAIPrompt_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [aiPrompt](#API_amazon-q-connect_UpdateAIPrompt_ResponseSyntax) **   <a name="connect-amazon-q-connect_UpdateAIPrompt-response-aiPrompt"></a>
The data of the updated Amazon Q in Connect AI Prompt.  
Type: [AIPromptData](API_amazon-q-connect_AIPromptData.md) object

## Errors
<a name="API_amazon-q-connect_UpdateAIPrompt_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_UpdateAIPrompt_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/UpdateAIPrompt) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/UpdateAIPrompt) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/UpdateAIPrompt) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/UpdateAIPrompt) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/UpdateAIPrompt) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/UpdateAIPrompt) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/UpdateAIPrompt) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/UpdateAIPrompt) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/UpdateAIPrompt) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/UpdateAIPrompt) 

# UpdateAssistantAIAgent
<a name="API_amazon-q-connect_UpdateAssistantAIAgent"></a>

Updates the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.

## Request Syntax
<a name="API_amazon-q-connect_UpdateAssistantAIAgent_RequestSyntax"></a>

```
POST /assistants/assistantId/aiagentConfiguration HTTP/1.1
Content-type: application/json

{
   "aiAgentType": "string",
   "configuration": { 
      "aiAgentId": "string"
   },
   "orchestratorConfigurationList": [ 
      { 
         "aiAgentId": "string",
         "orchestratorUseCase": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_UpdateAssistantAIAgent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_UpdateAssistantAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAssistantAIAgent-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_UpdateAssistantAIAgent_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [aiAgentType](#API_amazon-q-connect_UpdateAssistantAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAssistantAIAgent-request-aiAgentType"></a>
The type of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.  
Type: String  
Valid Values: `MANUAL_SEARCH | ANSWER_RECOMMENDATION | SELF_SERVICE | EMAIL_RESPONSE | EMAIL_OVERVIEW | EMAIL_GENERATIVE_ANSWER | ORCHESTRATION | NOTE_TAKING | CASE_SUMMARIZATION`   
Required: Yes

 ** [configuration](#API_amazon-q-connect_UpdateAssistantAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAssistantAIAgent-request-configuration"></a>
The configuration of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.  
Type: [AIAgentConfigurationData](API_amazon-q-connect_AIAgentConfigurationData.md) object  
Required: Yes

 ** [orchestratorConfigurationList](#API_amazon-q-connect_UpdateAssistantAIAgent_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateAssistantAIAgent-request-orchestratorConfigurationList"></a>
The updated list of orchestrator configurations for the assistant AI Agent.  
Type: Array of [OrchestratorConfigurationEntry](API_amazon-q-connect_OrchestratorConfigurationEntry.md) objects  
Required: No

## Response Syntax
<a name="API_amazon-q-connect_UpdateAssistantAIAgent_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "assistant": { 
      "aiAgentConfiguration": { 
         "string" : { 
            "aiAgentId": "string"
         }
      },
      "assistantArn": "string",
      "assistantId": "string",
      "capabilityConfiguration": { 
         "type": "string"
      },
      "description": "string",
      "integrationConfiguration": { 
         "topicIntegrationArn": "string"
      },
      "name": "string",
      "orchestratorConfigurationList": [ 
         { 
            "aiAgentId": "string",
            "orchestratorUseCase": "string"
         }
      ],
      "serverSideEncryptionConfiguration": { 
         "kmsKeyId": "string"
      },
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "type": "string"
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_UpdateAssistantAIAgent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [assistant](#API_amazon-q-connect_UpdateAssistantAIAgent_ResponseSyntax) **   <a name="connect-amazon-q-connect_UpdateAssistantAIAgent-response-assistant"></a>
The assistant data.  
Type: [AssistantData](API_amazon-q-connect_AssistantData.md) object

## Errors
<a name="API_amazon-q-connect_UpdateAssistantAIAgent_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_UpdateAssistantAIAgent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/UpdateAssistantAIAgent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/UpdateAssistantAIAgent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/UpdateAssistantAIAgent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/UpdateAssistantAIAgent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/UpdateAssistantAIAgent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/UpdateAssistantAIAgent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/UpdateAssistantAIAgent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/UpdateAssistantAIAgent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/UpdateAssistantAIAgent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/UpdateAssistantAIAgent) 

# UpdateContent
<a name="API_amazon-q-connect_UpdateContent"></a>

Updates information about the content.

## Request Syntax
<a name="API_amazon-q-connect_UpdateContent_RequestSyntax"></a>

```
POST /knowledgeBases/knowledgeBaseId/contents/contentId HTTP/1.1
Content-type: application/json

{
   "metadata": { 
      "string" : "string" 
   },
   "overrideLinkOutUri": "string",
   "removeOverrideLinkOutUri": boolean,
   "revisionId": "string",
   "title": "string",
   "uploadId": "string"
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_UpdateContent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [contentId](#API_amazon-q-connect_UpdateContent_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateContent-request-uri-contentId"></a>
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [knowledgeBaseId](#API_amazon-q-connect_UpdateContent_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateContent-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. This should not be a QUICK\$1RESPONSES type knowledge base. Can be either the ID or the ARN  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_UpdateContent_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [metadata](#API_amazon-q-connect_UpdateContent_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateContent-request-metadata"></a>
A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.  
Type: String to string map  
Map Entries: Minimum number of 0 items. Maximum number of 10 items.  
Key Length Constraints: Minimum length of 1. Maximum length of 4096.  
Value Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [overrideLinkOutUri](#API_amazon-q-connect_UpdateContent_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateContent-request-overrideLinkOutUri"></a>
The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content. To remove an existing `overrideLinkOurUri`, exclude this argument and set `removeOverrideLinkOutUri` to true.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [removeOverrideLinkOutUri](#API_amazon-q-connect_UpdateContent_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateContent-request-removeOverrideLinkOutUri"></a>
Unset the existing `overrideLinkOutUri` if it exists.  
Type: Boolean  
Required: No

 ** [revisionId](#API_amazon-q-connect_UpdateContent_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateContent-request-revisionId"></a>
The `revisionId` of the content resource to update, taken from an earlier call to `GetContent`, `GetContentSummary`, `SearchContent`, or `ListContents`. If included, this argument acts as an optimistic lock to ensure content was not modified since it was last read. If it has been modified, this API throws a `PreconditionFailedException`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: No

 ** [title](#API_amazon-q-connect_UpdateContent_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateContent-request-title"></a>
The title of the content.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [uploadId](#API_amazon-q-connect_UpdateContent_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateContent-request-uploadId"></a>
A pointer to the uploaded asset. This value is returned by [StartContentUpload](https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html).   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1200.  
Required: No

## Response Syntax
<a name="API_amazon-q-connect_UpdateContent_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "content": { 
      "contentArn": "string",
      "contentId": "string",
      "contentType": "string",
      "knowledgeBaseArn": "string",
      "knowledgeBaseId": "string",
      "linkOutUri": "string",
      "metadata": { 
         "string" : "string" 
      },
      "name": "string",
      "revisionId": "string",
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "title": "string",
      "url": "string",
      "urlExpiry": number
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_UpdateContent_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [content](#API_amazon-q-connect_UpdateContent_ResponseSyntax) **   <a name="connect-amazon-q-connect_UpdateContent-response-content"></a>
The content.  
Type: [ContentData](API_amazon-q-connect_ContentData.md) object

## Errors
<a name="API_amazon-q-connect_UpdateContent_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** PreconditionFailedException **   
The provided `revisionId` does not match, indicating the content has been modified since it was last read.  
HTTP Status Code: 412

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_UpdateContent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/UpdateContent) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/UpdateContent) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/UpdateContent) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/UpdateContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/UpdateContent) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/UpdateContent) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/UpdateContent) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/UpdateContent) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/UpdateContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/UpdateContent) 

# UpdateKnowledgeBaseTemplateUri
<a name="API_amazon-q-connect_UpdateKnowledgeBaseTemplateUri"></a>

Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in `${variable}` format; this interpolated by Amazon Q in Connect using ingested content. For example, if you ingest a Salesforce article, it has an `Id` value, and you can set the template URI to `https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view`. 

## Request Syntax
<a name="API_amazon-q-connect_UpdateKnowledgeBaseTemplateUri_RequestSyntax"></a>

```
POST /knowledgeBases/knowledgeBaseId/templateUri HTTP/1.1
Content-type: application/json

{
   "templateUri": "string"
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_UpdateKnowledgeBaseTemplateUri_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_UpdateKnowledgeBaseTemplateUri_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateKnowledgeBaseTemplateUri-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. This should not be a QUICK\$1RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_UpdateKnowledgeBaseTemplateUri_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [templateUri](#API_amazon-q-connect_UpdateKnowledgeBaseTemplateUri_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateKnowledgeBaseTemplateUri-request-templateUri"></a>
The template URI to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4096.  
Required: Yes

## Response Syntax
<a name="API_amazon-q-connect_UpdateKnowledgeBaseTemplateUri_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "knowledgeBase": { 
      "description": "string",
      "ingestionFailureReasons": [ "string" ],
      "ingestionStatus": "string",
      "knowledgeBaseArn": "string",
      "knowledgeBaseId": "string",
      "knowledgeBaseType": "string",
      "lastContentModificationTime": number,
      "name": "string",
      "renderingConfiguration": { 
         "templateUri": "string"
      },
      "serverSideEncryptionConfiguration": { 
         "kmsKeyId": "string"
      },
      "sourceConfiguration": { ... },
      "status": "string",
      "tags": { 
         "string" : "string" 
      },
      "vectorIngestionConfiguration": { 
         "chunkingConfiguration": { 
            "chunkingStrategy": "string",
            "fixedSizeChunkingConfiguration": { 
               "maxTokens": number,
               "overlapPercentage": number
            },
            "hierarchicalChunkingConfiguration": { 
               "levelConfigurations": [ 
                  { 
                     "maxTokens": number
                  }
               ],
               "overlapTokens": number
            },
            "semanticChunkingConfiguration": { 
               "breakpointPercentileThreshold": number,
               "bufferSize": number,
               "maxTokens": number
            }
         },
         "parsingConfiguration": { 
            "bedrockFoundationModelConfiguration": { 
               "modelArn": "string",
               "parsingPrompt": { 
                  "parsingPromptText": "string"
               }
            },
            "parsingStrategy": "string"
         }
      }
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_UpdateKnowledgeBaseTemplateUri_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [knowledgeBase](#API_amazon-q-connect_UpdateKnowledgeBaseTemplateUri_ResponseSyntax) **   <a name="connect-amazon-q-connect_UpdateKnowledgeBaseTemplateUri-response-knowledgeBase"></a>
The knowledge base to update.  
Type: [KnowledgeBaseData](API_amazon-q-connect_KnowledgeBaseData.md) object

## Errors
<a name="API_amazon-q-connect_UpdateKnowledgeBaseTemplateUri_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_UpdateKnowledgeBaseTemplateUri_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/UpdateKnowledgeBaseTemplateUri) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/UpdateKnowledgeBaseTemplateUri) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/UpdateKnowledgeBaseTemplateUri) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/UpdateKnowledgeBaseTemplateUri) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/UpdateKnowledgeBaseTemplateUri) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/UpdateKnowledgeBaseTemplateUri) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/UpdateKnowledgeBaseTemplateUri) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/UpdateKnowledgeBaseTemplateUri) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/UpdateKnowledgeBaseTemplateUri) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/UpdateKnowledgeBaseTemplateUri) 

# UpdateMessageTemplate
<a name="API_amazon-q-connect_UpdateMessageTemplate"></a>

Updates the Amazon Q in Connect message template. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template that is referenced by the `$LATEST` qualifier. Any modification will only apply to the message template that is referenced by the `$LATEST` qualifier. The fields for all available versions will remain unchanged.

## Request Syntax
<a name="API_amazon-q-connect_UpdateMessageTemplate_RequestSyntax"></a>

```
POST /knowledgeBases/knowledgeBaseId/messageTemplates/messageTemplateId HTTP/1.1
Content-type: application/json

{
   "content": { ... },
   "defaultAttributes": { 
      "agentAttributes": { 
         "firstName": "string",
         "lastName": "string"
      },
      "customAttributes": { 
         "string" : "string" 
      },
      "customerProfileAttributes": { 
         "accountNumber": "string",
         "additionalInformation": "string",
         "address1": "string",
         "address2": "string",
         "address3": "string",
         "address4": "string",
         "billingAddress1": "string",
         "billingAddress2": "string",
         "billingAddress3": "string",
         "billingAddress4": "string",
         "billingCity": "string",
         "billingCountry": "string",
         "billingCounty": "string",
         "billingPostalCode": "string",
         "billingProvince": "string",
         "billingState": "string",
         "birthDate": "string",
         "businessEmailAddress": "string",
         "businessName": "string",
         "businessPhoneNumber": "string",
         "city": "string",
         "country": "string",
         "county": "string",
         "custom": { 
            "string" : "string" 
         },
         "emailAddress": "string",
         "firstName": "string",
         "gender": "string",
         "homePhoneNumber": "string",
         "lastName": "string",
         "mailingAddress1": "string",
         "mailingAddress2": "string",
         "mailingAddress3": "string",
         "mailingAddress4": "string",
         "mailingCity": "string",
         "mailingCountry": "string",
         "mailingCounty": "string",
         "mailingPostalCode": "string",
         "mailingProvince": "string",
         "mailingState": "string",
         "middleName": "string",
         "mobilePhoneNumber": "string",
         "partyType": "string",
         "phoneNumber": "string",
         "postalCode": "string",
         "profileARN": "string",
         "profileId": "string",
         "province": "string",
         "shippingAddress1": "string",
         "shippingAddress2": "string",
         "shippingAddress3": "string",
         "shippingAddress4": "string",
         "shippingCity": "string",
         "shippingCountry": "string",
         "shippingCounty": "string",
         "shippingPostalCode": "string",
         "shippingProvince": "string",
         "shippingState": "string",
         "state": "string"
      },
      "systemAttributes": { 
         "customerEndpoint": { 
            "address": "string"
         },
         "name": "string",
         "systemEndpoint": { 
            "address": "string"
         }
      }
   },
   "language": "string",
   "sourceConfiguration": { ... }
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_UpdateMessageTemplate_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_UpdateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateMessageTemplate-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [messageTemplateId](#API_amazon-q-connect_UpdateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateMessageTemplate-request-uri-messageTemplateId"></a>
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_UpdateMessageTemplate_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [content](#API_amazon-q-connect_UpdateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateMessageTemplate-request-content"></a>
The content of the message template.  
Type: [MessageTemplateContentProvider](API_amazon-q-connect_MessageTemplateContentProvider.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [defaultAttributes](#API_amazon-q-connect_UpdateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateMessageTemplate-request-defaultAttributes"></a>
An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.  
Type: [MessageTemplateAttributes](API_amazon-q-connect_MessageTemplateAttributes.md) object  
Required: No

 ** [language](#API_amazon-q-connect_UpdateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateMessageTemplate-request-language"></a>
The language code value for the language in which the quick response is written. The supported language codes include `de_DE`, `en_US`, `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`, `zh_CN`, `zh_TW`   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 5.  
Required: No

 ** [sourceConfiguration](#API_amazon-q-connect_UpdateMessageTemplate_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateMessageTemplate-request-sourceConfiguration"></a>
The source configuration of the message template. Only set this argument for WHATSAPP channel subtype.  
Type: [MessageTemplateSourceConfiguration](API_amazon-q-connect_MessageTemplateSourceConfiguration.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## Response Syntax
<a name="API_amazon-q-connect_UpdateMessageTemplate_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "messageTemplate": { 
      "attributeTypes": [ "string" ],
      "channel": "string",
      "channelSubtype": "string",
      "content": { ... },
      "createdTime": "string",
      "defaultAttributes": { 
         "agentAttributes": { 
            "firstName": "string",
            "lastName": "string"
         },
         "customAttributes": { 
            "string" : "string" 
         },
         "customerProfileAttributes": { 
            "accountNumber": "string",
            "additionalInformation": "string",
            "address1": "string",
            "address2": "string",
            "address3": "string",
            "address4": "string",
            "billingAddress1": "string",
            "billingAddress2": "string",
            "billingAddress3": "string",
            "billingAddress4": "string",
            "billingCity": "string",
            "billingCountry": "string",
            "billingCounty": "string",
            "billingPostalCode": "string",
            "billingProvince": "string",
            "billingState": "string",
            "birthDate": "string",
            "businessEmailAddress": "string",
            "businessName": "string",
            "businessPhoneNumber": "string",
            "city": "string",
            "country": "string",
            "county": "string",
            "custom": { 
               "string" : "string" 
            },
            "emailAddress": "string",
            "firstName": "string",
            "gender": "string",
            "homePhoneNumber": "string",
            "lastName": "string",
            "mailingAddress1": "string",
            "mailingAddress2": "string",
            "mailingAddress3": "string",
            "mailingAddress4": "string",
            "mailingCity": "string",
            "mailingCountry": "string",
            "mailingCounty": "string",
            "mailingPostalCode": "string",
            "mailingProvince": "string",
            "mailingState": "string",
            "middleName": "string",
            "mobilePhoneNumber": "string",
            "partyType": "string",
            "phoneNumber": "string",
            "postalCode": "string",
            "profileARN": "string",
            "profileId": "string",
            "province": "string",
            "shippingAddress1": "string",
            "shippingAddress2": "string",
            "shippingAddress3": "string",
            "shippingAddress4": "string",
            "shippingCity": "string",
            "shippingCountry": "string",
            "shippingCounty": "string",
            "shippingPostalCode": "string",
            "shippingProvince": "string",
            "shippingState": "string",
            "state": "string"
         },
         "systemAttributes": { 
            "customerEndpoint": { 
               "address": "string"
            },
            "name": "string",
            "systemEndpoint": { 
               "address": "string"
            }
         }
      },
      "description": "string",
      "groupingConfiguration": { 
         "criteria": "string",
         "values": [ "string" ]
      },
      "knowledgeBaseArn": "string",
      "knowledgeBaseId": "string",
      "language": "string",
      "lastModifiedBy": "string",
      "lastModifiedTime": "string",
      "messageTemplateArn": "string",
      "messageTemplateContentSha256": "string",
      "messageTemplateId": "string",
      "name": "string",
      "sourceConfigurationSummary": { ... },
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_UpdateMessageTemplate_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [messageTemplate](#API_amazon-q-connect_UpdateMessageTemplate_ResponseSyntax) **   <a name="connect-amazon-q-connect_UpdateMessageTemplate-response-messageTemplate"></a>
The message template.  
Type: [MessageTemplateData](API_amazon-q-connect_MessageTemplateData.md) object

## Errors
<a name="API_amazon-q-connect_UpdateMessageTemplate_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_UpdateMessageTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/UpdateMessageTemplate) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/UpdateMessageTemplate) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/UpdateMessageTemplate) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/UpdateMessageTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/UpdateMessageTemplate) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/UpdateMessageTemplate) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/UpdateMessageTemplate) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/UpdateMessageTemplate) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/UpdateMessageTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/UpdateMessageTemplate) 

# UpdateMessageTemplateMetadata
<a name="API_amazon-q-connect_UpdateMessageTemplateMetadata"></a>

Updates the Amazon Q in Connect message template metadata. Note that any modification to the message template’s name, description and grouping configuration will applied to the message template pointed by the `$LATEST` qualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template.

## Request Syntax
<a name="API_amazon-q-connect_UpdateMessageTemplateMetadata_RequestSyntax"></a>

```
POST /knowledgeBases/knowledgeBaseId/messageTemplates/messageTemplateId/metadata HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "groupingConfiguration": { 
      "criteria": "string",
      "values": [ "string" ]
   },
   "name": "string"
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_UpdateMessageTemplateMetadata_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_UpdateMessageTemplateMetadata_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateMessageTemplateMetadata-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [messageTemplateId](#API_amazon-q-connect_UpdateMessageTemplateMetadata_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateMessageTemplateMetadata-request-uri-messageTemplateId"></a>
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_UpdateMessageTemplateMetadata_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_amazon-q-connect_UpdateMessageTemplateMetadata_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateMessageTemplateMetadata-request-description"></a>
The description of the message template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** [groupingConfiguration](#API_amazon-q-connect_UpdateMessageTemplateMetadata_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateMessageTemplateMetadata-request-groupingConfiguration"></a>
The configuration information of the grouping of Amazon Q in Connect users.  
Type: [GroupingConfiguration](API_amazon-q-connect_GroupingConfiguration.md) object  
Required: No

 ** [name](#API_amazon-q-connect_UpdateMessageTemplateMetadata_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateMessageTemplateMetadata-request-name"></a>
The name of the message template.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

## Response Syntax
<a name="API_amazon-q-connect_UpdateMessageTemplateMetadata_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "messageTemplate": { 
      "attributeTypes": [ "string" ],
      "channel": "string",
      "channelSubtype": "string",
      "content": { ... },
      "createdTime": "string",
      "defaultAttributes": { 
         "agentAttributes": { 
            "firstName": "string",
            "lastName": "string"
         },
         "customAttributes": { 
            "string" : "string" 
         },
         "customerProfileAttributes": { 
            "accountNumber": "string",
            "additionalInformation": "string",
            "address1": "string",
            "address2": "string",
            "address3": "string",
            "address4": "string",
            "billingAddress1": "string",
            "billingAddress2": "string",
            "billingAddress3": "string",
            "billingAddress4": "string",
            "billingCity": "string",
            "billingCountry": "string",
            "billingCounty": "string",
            "billingPostalCode": "string",
            "billingProvince": "string",
            "billingState": "string",
            "birthDate": "string",
            "businessEmailAddress": "string",
            "businessName": "string",
            "businessPhoneNumber": "string",
            "city": "string",
            "country": "string",
            "county": "string",
            "custom": { 
               "string" : "string" 
            },
            "emailAddress": "string",
            "firstName": "string",
            "gender": "string",
            "homePhoneNumber": "string",
            "lastName": "string",
            "mailingAddress1": "string",
            "mailingAddress2": "string",
            "mailingAddress3": "string",
            "mailingAddress4": "string",
            "mailingCity": "string",
            "mailingCountry": "string",
            "mailingCounty": "string",
            "mailingPostalCode": "string",
            "mailingProvince": "string",
            "mailingState": "string",
            "middleName": "string",
            "mobilePhoneNumber": "string",
            "partyType": "string",
            "phoneNumber": "string",
            "postalCode": "string",
            "profileARN": "string",
            "profileId": "string",
            "province": "string",
            "shippingAddress1": "string",
            "shippingAddress2": "string",
            "shippingAddress3": "string",
            "shippingAddress4": "string",
            "shippingCity": "string",
            "shippingCountry": "string",
            "shippingCounty": "string",
            "shippingPostalCode": "string",
            "shippingProvince": "string",
            "shippingState": "string",
            "state": "string"
         },
         "systemAttributes": { 
            "customerEndpoint": { 
               "address": "string"
            },
            "name": "string",
            "systemEndpoint": { 
               "address": "string"
            }
         }
      },
      "description": "string",
      "groupingConfiguration": { 
         "criteria": "string",
         "values": [ "string" ]
      },
      "knowledgeBaseArn": "string",
      "knowledgeBaseId": "string",
      "language": "string",
      "lastModifiedBy": "string",
      "lastModifiedTime": "string",
      "messageTemplateArn": "string",
      "messageTemplateContentSha256": "string",
      "messageTemplateId": "string",
      "name": "string",
      "sourceConfigurationSummary": { ... },
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_UpdateMessageTemplateMetadata_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [messageTemplate](#API_amazon-q-connect_UpdateMessageTemplateMetadata_ResponseSyntax) **   <a name="connect-amazon-q-connect_UpdateMessageTemplateMetadata-response-messageTemplate"></a>
The message template.  
Type: [MessageTemplateData](API_amazon-q-connect_MessageTemplateData.md) object

## Errors
<a name="API_amazon-q-connect_UpdateMessageTemplateMetadata_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** ThrottlingException **   
The throttling limit has been exceeded.  
HTTP Status Code: 429

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_UpdateMessageTemplateMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/UpdateMessageTemplateMetadata) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/UpdateMessageTemplateMetadata) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/UpdateMessageTemplateMetadata) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/UpdateMessageTemplateMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/UpdateMessageTemplateMetadata) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/UpdateMessageTemplateMetadata) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/UpdateMessageTemplateMetadata) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/UpdateMessageTemplateMetadata) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/UpdateMessageTemplateMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/UpdateMessageTemplateMetadata) 

# UpdateQuickResponse
<a name="API_amazon-q-connect_UpdateQuickResponse"></a>

Updates an existing Amazon Q in Connect quick response.

## Request Syntax
<a name="API_amazon-q-connect_UpdateQuickResponse_RequestSyntax"></a>

```
POST /knowledgeBases/knowledgeBaseId/quickResponses/quickResponseId HTTP/1.1
Content-type: application/json

{
   "channels": [ "string" ],
   "content": { ... },
   "contentType": "string",
   "description": "string",
   "groupingConfiguration": { 
      "criteria": "string",
      "values": [ "string" ]
   },
   "isActive": boolean,
   "language": "string",
   "name": "string",
   "removeDescription": boolean,
   "removeGroupingConfiguration": boolean,
   "removeShortcutKey": boolean,
   "shortcutKey": "string"
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_UpdateQuickResponse_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_amazon-q-connect_UpdateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateQuickResponse-request-uri-knowledgeBaseId"></a>
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [quickResponseId](#API_amazon-q-connect_UpdateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateQuickResponse-request-uri-quickResponseId"></a>
The identifier of the quick response.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_UpdateQuickResponse_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [channels](#API_amazon-q-connect_UpdateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateQuickResponse-request-channels"></a>
The Amazon Connect contact channels this quick response applies to. The supported contact channel types include `Chat`.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Required: No

 ** [content](#API_amazon-q-connect_UpdateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateQuickResponse-request-content"></a>
The updated content of the quick response.  
Type: [QuickResponseDataProvider](API_amazon-q-connect_QuickResponseDataProvider.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

 ** [contentType](#API_amazon-q-connect_UpdateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateQuickResponse-request-contentType"></a>
The media type of the quick response content.  
+ Use `application/x.quickresponse;format=plain` for quick response written in plain text.
+ Use `application/x.quickresponse;format=markdown` for quick response written in richtext.
Type: String  
Pattern: `(application/x\.quickresponse;format=(plain|markdown))`   
Required: No

 ** [description](#API_amazon-q-connect_UpdateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateQuickResponse-request-description"></a>
The updated description of the quick response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Required: No

 ** [groupingConfiguration](#API_amazon-q-connect_UpdateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateQuickResponse-request-groupingConfiguration"></a>
The updated grouping configuration of the quick response.  
Type: [GroupingConfiguration](API_amazon-q-connect_GroupingConfiguration.md) object  
Required: No

 ** [isActive](#API_amazon-q-connect_UpdateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateQuickResponse-request-isActive"></a>
Whether the quick response is active.   
Type: Boolean  
Required: No

 ** [language](#API_amazon-q-connect_UpdateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateQuickResponse-request-language"></a>
The language code value for the language in which the quick response is written. The supported language codes include `de_DE`, `en_US`, `es_ES`, `fr_FR`, `id_ID`, `it_IT`, `ja_JP`, `ko_KR`, `pt_BR`, `zh_CN`, `zh_TW`   
Type: String  
Length Constraints: Minimum length of 2. Maximum length of 5.  
Required: No

 ** [name](#API_amazon-q-connect_UpdateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateQuickResponse-request-name"></a>
The name of the quick response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Required: No

 ** [removeDescription](#API_amazon-q-connect_UpdateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateQuickResponse-request-removeDescription"></a>
Whether to remove the description from the quick response.  
Type: Boolean  
Required: No

 ** [removeGroupingConfiguration](#API_amazon-q-connect_UpdateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateQuickResponse-request-removeGroupingConfiguration"></a>
Whether to remove the grouping configuration of the quick response.  
Type: Boolean  
Required: No

 ** [removeShortcutKey](#API_amazon-q-connect_UpdateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateQuickResponse-request-removeShortcutKey"></a>
Whether to remove the shortcut key of the quick response.  
Type: Boolean  
Required: No

 ** [shortcutKey](#API_amazon-q-connect_UpdateQuickResponse_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateQuickResponse-request-shortcutKey"></a>
The shortcut key of the quick response. The value should be unique across the knowledge base.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10.  
Required: No

## Response Syntax
<a name="API_amazon-q-connect_UpdateQuickResponse_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "quickResponse": { 
      "channels": [ "string" ],
      "contents": { 
         "markdown": { ... },
         "plainText": { ... }
      },
      "contentType": "string",
      "createdTime": number,
      "description": "string",
      "groupingConfiguration": { 
         "criteria": "string",
         "values": [ "string" ]
      },
      "isActive": boolean,
      "knowledgeBaseArn": "string",
      "knowledgeBaseId": "string",
      "language": "string",
      "lastModifiedBy": "string",
      "lastModifiedTime": number,
      "name": "string",
      "quickResponseArn": "string",
      "quickResponseId": "string",
      "shortcutKey": "string",
      "status": "string",
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_UpdateQuickResponse_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [quickResponse](#API_amazon-q-connect_UpdateQuickResponse_ResponseSyntax) **   <a name="connect-amazon-q-connect_UpdateQuickResponse-response-quickResponse"></a>
The quick response.  
Type: [QuickResponseData](API_amazon-q-connect_QuickResponseData.md) object

## Errors
<a name="API_amazon-q-connect_UpdateQuickResponse_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ConflictException **   
The request could not be processed because of conflict in the current state of the resource. For example, if you're using a `Create` API (such as `CreateAssistant`) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.  
HTTP Status Code: 409

 ** PreconditionFailedException **   
The provided `revisionId` does not match, indicating the content has been modified since it was last read.  
HTTP Status Code: 412

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_UpdateQuickResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/UpdateQuickResponse) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/UpdateQuickResponse) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/UpdateQuickResponse) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/UpdateQuickResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/UpdateQuickResponse) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/UpdateQuickResponse) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/UpdateQuickResponse) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/UpdateQuickResponse) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/UpdateQuickResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/UpdateQuickResponse) 

# UpdateSession
<a name="API_amazon-q-connect_UpdateSession"></a>

Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

## Request Syntax
<a name="API_amazon-q-connect_UpdateSession_RequestSyntax"></a>

```
POST /assistants/assistantId/sessions/sessionId HTTP/1.1
Content-type: application/json

{
   "aiAgentConfiguration": { 
      "string" : { 
         "aiAgentId": "string"
      }
   },
   "description": "string",
   "orchestratorConfigurationList": [ 
      { 
         "aiAgentId": "string",
         "orchestratorUseCase": "string"
      }
   ],
   "removeOrchestratorConfigurationList": boolean,
   "tagFilter": { ... }
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_UpdateSession_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_UpdateSession_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateSession-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [sessionId](#API_amazon-q-connect_UpdateSession_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateSession-request-uri-sessionId"></a>
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_UpdateSession_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [aiAgentConfiguration](#API_amazon-q-connect_UpdateSession_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateSession-request-aiAgentConfiguration"></a>
The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.  
Type: String to [AIAgentConfigurationData](API_amazon-q-connect_AIAgentConfigurationData.md) object map  
Valid Keys: `MANUAL_SEARCH | ANSWER_RECOMMENDATION | SELF_SERVICE | EMAIL_RESPONSE | EMAIL_OVERVIEW | EMAIL_GENERATIVE_ANSWER | ORCHESTRATION | NOTE_TAKING | CASE_SUMMARIZATION`   
Required: No

 ** [description](#API_amazon-q-connect_UpdateSession_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateSession-request-description"></a>
The description.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `[a-zA-Z0-9\s_.,-]+.*`   
Required: No

 ** [orchestratorConfigurationList](#API_amazon-q-connect_UpdateSession_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateSession-request-orchestratorConfigurationList"></a>
The updated list of orchestrator configurations for the session.  
Type: Array of [OrchestratorConfigurationEntry](API_amazon-q-connect_OrchestratorConfigurationEntry.md) objects  
Required: No

 ** [removeOrchestratorConfigurationList](#API_amazon-q-connect_UpdateSession_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateSession-request-removeOrchestratorConfigurationList"></a>
The list of orchestrator configurations to remove from the session.  
Type: Boolean  
Required: No

 ** [tagFilter](#API_amazon-q-connect_UpdateSession_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateSession-request-tagFilter"></a>
An object that can be used to specify Tag conditions.  
Type: [TagFilter](API_amazon-q-connect_TagFilter.md) object  
 **Note: **This object is a Union. Only one member of this object can be specified or returned.  
Required: No

## Response Syntax
<a name="API_amazon-q-connect_UpdateSession_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "session": { 
      "aiAgentConfiguration": { 
         "string" : { 
            "aiAgentId": "string"
         }
      },
      "description": "string",
      "integrationConfiguration": { 
         "topicIntegrationArn": "string"
      },
      "name": "string",
      "orchestratorConfigurationList": [ 
         { 
            "aiAgentId": "string",
            "orchestratorUseCase": "string"
         }
      ],
      "origin": "string",
      "sessionArn": "string",
      "sessionId": "string",
      "tagFilter": { ... },
      "tags": { 
         "string" : "string" 
      }
   }
}
```

## Response Elements
<a name="API_amazon-q-connect_UpdateSession_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [session](#API_amazon-q-connect_UpdateSession_ResponseSyntax) **   <a name="connect-amazon-q-connect_UpdateSession-response-session"></a>
Information about the session.  
Type: [SessionData](API_amazon-q-connect_SessionData.md) object

## Errors
<a name="API_amazon-q-connect_UpdateSession_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_UpdateSession_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/UpdateSession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/UpdateSession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/UpdateSession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/UpdateSession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/UpdateSession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/UpdateSession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/UpdateSession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/UpdateSession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/UpdateSession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/UpdateSession) 

# UpdateSessionData
<a name="API_amazon-q-connect_UpdateSessionData"></a>

Updates the data stored on an Amazon Q in Connect Session.

## Request Syntax
<a name="API_amazon-q-connect_UpdateSessionData_RequestSyntax"></a>

```
PATCH /assistants/assistantId/sessions/sessionId/data HTTP/1.1
Content-type: application/json

{
   "data": [ 
      { 
         "key": "string",
         "value": { ... }
      }
   ],
   "namespace": "string"
}
```

## URI Request Parameters
<a name="API_amazon-q-connect_UpdateSessionData_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assistantId](#API_amazon-q-connect_UpdateSessionData_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateSessionData-request-uri-assistantId"></a>
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

 ** [sessionId](#API_amazon-q-connect_UpdateSessionData_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateSessionData-request-uri-sessionId"></a>
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}`   
Required: Yes

## Request Body
<a name="API_amazon-q-connect_UpdateSessionData_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [data](#API_amazon-q-connect_UpdateSessionData_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateSessionData-request-data"></a>
The data stored on the Amazon Q in Connect Session.  
Type: Array of [RuntimeSessionData](API_amazon-q-connect_RuntimeSessionData.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.  
Required: Yes

 ** [namespace](#API_amazon-q-connect_UpdateSessionData_RequestSyntax) **   <a name="connect-amazon-q-connect_UpdateSessionData-request-namespace"></a>
The namespace into which the session data is stored. Supported namespaces are: Custom  
Type: String  
Valid Values: `Custom`   
Required: No

## Response Syntax
<a name="API_amazon-q-connect_UpdateSessionData_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "data": [ 
      { 
         "key": "string",
         "value": { ... }
      }
   ],
   "namespace": "string",
   "sessionArn": "string",
   "sessionId": "string"
}
```

## Response Elements
<a name="API_amazon-q-connect_UpdateSessionData_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [data](#API_amazon-q-connect_UpdateSessionData_ResponseSyntax) **   <a name="connect-amazon-q-connect_UpdateSessionData-response-data"></a>
Data stored in the session.  
Type: Array of [RuntimeSessionData](API_amazon-q-connect_RuntimeSessionData.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 50 items.

 ** [namespace](#API_amazon-q-connect_UpdateSessionData_ResponseSyntax) **   <a name="connect-amazon-q-connect_UpdateSessionData-response-namespace"></a>
The namespace into which the session data is stored. Supported namespaces are: Custom  
Type: String  
Valid Values: `Custom` 

 ** [sessionArn](#API_amazon-q-connect_UpdateSessionData_ResponseSyntax) **   <a name="connect-amazon-q-connect_UpdateSessionData-response-sessionArn"></a>
The Amazon Resource Name (ARN) of the session.  
Type: String  
Pattern: `arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}` 

 ** [sessionId](#API_amazon-q-connect_UpdateSessionData_ResponseSyntax) **   <a name="connect-amazon-q-connect_UpdateSessionData-response-sessionId"></a>
The identifier of the session.  
Type: String  
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` 

## Errors
<a name="API_amazon-q-connect_UpdateSessionData_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient access to perform this action.  
HTTP Status Code: 403

 ** ResourceNotFoundException **   
The specified resource does not exist.    
 ** resourceName **   
The specified resource name.
HTTP Status Code: 404

 ** UnauthorizedException **   
You do not have permission to perform this action.  
HTTP Status Code: 401

 ** ValidationException **   
The input fails to satisfy the constraints specified by a service.  
HTTP Status Code: 400

## See Also
<a name="API_amazon-q-connect_UpdateSessionData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/qconnect-2020-10-19/UpdateSessionData) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/qconnect-2020-10-19/UpdateSessionData) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qconnect-2020-10-19/UpdateSessionData) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qconnect-2020-10-19/UpdateSessionData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qconnect-2020-10-19/UpdateSessionData) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qconnect-2020-10-19/UpdateSessionData) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qconnect-2020-10-19/UpdateSessionData) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qconnect-2020-10-19/UpdateSessionData) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/qconnect-2020-10-19/UpdateSessionData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qconnect-2020-10-19/UpdateSessionData) 

# Amazon Voice ID
<a name="API_Operations_Amazon_Voice_ID"></a>

The following actions are supported by Amazon Voice ID:
+  [AssociateFraudster](API_connect-voice-id_AssociateFraudster.md) 
+  [CreateDomain](API_connect-voice-id_CreateDomain.md) 
+  [CreateWatchlist](API_connect-voice-id_CreateWatchlist.md) 
+  [DeleteDomain](API_connect-voice-id_DeleteDomain.md) 
+  [DeleteFraudster](API_connect-voice-id_DeleteFraudster.md) 
+  [DeleteSpeaker](API_connect-voice-id_DeleteSpeaker.md) 
+  [DeleteWatchlist](API_connect-voice-id_DeleteWatchlist.md) 
+  [DescribeDomain](API_connect-voice-id_DescribeDomain.md) 
+  [DescribeFraudster](API_connect-voice-id_DescribeFraudster.md) 
+  [DescribeFraudsterRegistrationJob](API_connect-voice-id_DescribeFraudsterRegistrationJob.md) 
+  [DescribeSpeaker](API_connect-voice-id_DescribeSpeaker.md) 
+  [DescribeSpeakerEnrollmentJob](API_connect-voice-id_DescribeSpeakerEnrollmentJob.md) 
+  [DescribeWatchlist](API_connect-voice-id_DescribeWatchlist.md) 
+  [DisassociateFraudster](API_connect-voice-id_DisassociateFraudster.md) 
+  [EvaluateSession](API_connect-voice-id_EvaluateSession.md) 
+  [ListDomains](API_connect-voice-id_ListDomains.md) 
+  [ListFraudsterRegistrationJobs](API_connect-voice-id_ListFraudsterRegistrationJobs.md) 
+  [ListFraudsters](API_connect-voice-id_ListFraudsters.md) 
+  [ListSpeakerEnrollmentJobs](API_connect-voice-id_ListSpeakerEnrollmentJobs.md) 
+  [ListSpeakers](API_connect-voice-id_ListSpeakers.md) 
+  [ListTagsForResource](API_connect-voice-id_ListTagsForResource.md) 
+  [ListWatchlists](API_connect-voice-id_ListWatchlists.md) 
+  [OptOutSpeaker](API_connect-voice-id_OptOutSpeaker.md) 
+  [StartFraudsterRegistrationJob](API_connect-voice-id_StartFraudsterRegistrationJob.md) 
+  [StartSpeakerEnrollmentJob](API_connect-voice-id_StartSpeakerEnrollmentJob.md) 
+  [TagResource](API_connect-voice-id_TagResource.md) 
+  [UntagResource](API_connect-voice-id_UntagResource.md) 
+  [UpdateDomain](API_connect-voice-id_UpdateDomain.md) 
+  [UpdateWatchlist](API_connect-voice-id_UpdateWatchlist.md) 

# AssociateFraudster
<a name="API_connect-voice-id_AssociateFraudster"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Associates the fraudsters with the watchlist specified in the same domain. 

## Request Syntax
<a name="API_connect-voice-id_AssociateFraudster_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "FraudsterId": "string",
   "WatchlistId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_AssociateFraudster_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_AssociateFraudster_RequestSyntax) **   <a name="connect-connect-voice-id_AssociateFraudster-request-DomainId"></a>
The identifier of the domain that contains the fraudster.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [FraudsterId](#API_connect-voice-id_AssociateFraudster_RequestSyntax) **   <a name="connect-connect-voice-id_AssociateFraudster-request-FraudsterId"></a>
The identifier of the fraudster to be associated with the watchlist.  
Type: String  
Length Constraints: Fixed length of 25.  
Pattern: `id#[a-zA-Z0-9]{22}`   
Required: Yes

 ** [WatchlistId](#API_connect-voice-id_AssociateFraudster_RequestSyntax) **   <a name="connect-connect-voice-id_AssociateFraudster-request-WatchlistId"></a>
The identifier of the watchlist you want to associate with the fraudster.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_AssociateFraudster_ResponseSyntax"></a>

```
{
   "Fraudster": { 
      "CreatedAt": number,
      "DomainId": "string",
      "GeneratedFraudsterId": "string",
      "WatchlistIds": [ "string" ]
   }
}
```

## Response Elements
<a name="API_connect-voice-id_AssociateFraudster_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Fraudster](#API_connect-voice-id_AssociateFraudster_ResponseSyntax) **   <a name="connect-connect-voice-id_AssociateFraudster-response-Fraudster"></a>
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).
Contains all the information about a fraudster.  
Type: [Fraudster](API_connect-voice-id_Fraudster.md) object

## Errors
<a name="API_connect-voice-id_AssociateFraudster_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** ConflictException **   
The request failed due to a conflict. Check the `ConflictType` and error message for more details.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The request exceeded the service quota. Refer to [Voice ID Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) and try your request again.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_AssociateFraudster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/AssociateFraudster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/AssociateFraudster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/AssociateFraudster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/AssociateFraudster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/AssociateFraudster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/AssociateFraudster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/AssociateFraudster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/AssociateFraudster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/AssociateFraudster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/AssociateFraudster) 

# CreateDomain
<a name="API_connect-voice-id_CreateDomain"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints. Every domain is created with a default watchlist that fraudsters can be a part of.

## Request Syntax
<a name="API_connect-voice-id_CreateDomain_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "Description": "string",
   "Name": "string",
   "ServerSideEncryptionConfiguration": { 
      "KmsKeyId": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_connect-voice-id_CreateDomain_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_connect-voice-id_CreateDomain_RequestSyntax) **   <a name="connect-connect-voice-id_CreateDomain-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-_]+`   
Required: No

 ** [Description](#API_connect-voice-id_CreateDomain_RequestSyntax) **   <a name="connect-connect-voice-id_CreateDomain-request-Description"></a>
A brief description of this domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)`   
Required: No

 ** [Name](#API_connect-voice-id_CreateDomain_RequestSyntax) **   <a name="connect-connect-voice-id_CreateDomain-request-Name"></a>
The name of the domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [ServerSideEncryptionConfiguration](#API_connect-voice-id_CreateDomain_RequestSyntax) **   <a name="connect-connect-voice-id_CreateDomain-request-ServerSideEncryptionConfiguration"></a>
The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Refer to [ Amazon Connect Voice ID encryption at rest](https://docs.aws.amazon.com/connect/latest/adminguide/encryption-at-rest.html#encryption-at-rest-voiceid) for more details on how the KMS key is used.   
Type: [ServerSideEncryptionConfiguration](API_connect-voice-id_ServerSideEncryptionConfiguration.md) object  
Required: Yes

 ** [Tags](#API_connect-voice-id_CreateDomain_RequestSyntax) **   <a name="connect-connect-voice-id_CreateDomain-request-Tags"></a>
A list of tags you want added to the domain.  
Type: Array of [Tag](API_connect-voice-id_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: No

## Response Syntax
<a name="API_connect-voice-id_CreateDomain_ResponseSyntax"></a>

```
{
   "Domain": { 
      "Arn": "string",
      "CreatedAt": number,
      "Description": "string",
      "DomainId": "string",
      "DomainStatus": "string",
      "Name": "string",
      "ServerSideEncryptionConfiguration": { 
         "KmsKeyId": "string"
      },
      "ServerSideEncryptionUpdateDetails": { 
         "Message": "string",
         "OldKmsKeyId": "string",
         "UpdateStatus": "string"
      },
      "UpdatedAt": number,
      "WatchlistDetails": { 
         "DefaultWatchlistId": "string"
      }
   }
}
```

## Response Elements
<a name="API_connect-voice-id_CreateDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Domain](#API_connect-voice-id_CreateDomain_ResponseSyntax) **   <a name="connect-connect-voice-id_CreateDomain-response-Domain"></a>
Information about the newly created domain.  
Type: [Domain](API_connect-voice-id_Domain.md) object

## Errors
<a name="API_connect-voice-id_CreateDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** ConflictException **   
The request failed due to a conflict. Check the `ConflictType` and error message for more details.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The request exceeded the service quota. Refer to [Voice ID Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) and try your request again.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_CreateDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/CreateDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/CreateDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/CreateDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/CreateDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/CreateDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/CreateDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/CreateDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/CreateDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/CreateDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/CreateDomain) 

# CreateWatchlist
<a name="API_connect-voice-id_CreateWatchlist"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Creates a watchlist that fraudsters can be a part of.

## Request Syntax
<a name="API_connect-voice-id_CreateWatchlist_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "Description": "string",
   "DomainId": "string",
   "Name": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_CreateWatchlist_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_connect-voice-id_CreateWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_CreateWatchlist-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-_]+`   
Required: No

 ** [Description](#API_connect-voice-id_CreateWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_CreateWatchlist-request-Description"></a>
A brief description of this watchlist.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)`   
Required: No

 ** [DomainId](#API_connect-voice-id_CreateWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_CreateWatchlist-request-DomainId"></a>
The identifier of the domain that contains the watchlist.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [Name](#API_connect-voice-id_CreateWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_CreateWatchlist-request-Name"></a>
The name of the watchlist.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_CreateWatchlist_ResponseSyntax"></a>

```
{
   "Watchlist": { 
      "CreatedAt": number,
      "DefaultWatchlist": boolean,
      "Description": "string",
      "DomainId": "string",
      "Name": "string",
      "UpdatedAt": number,
      "WatchlistId": "string"
   }
}
```

## Response Elements
<a name="API_connect-voice-id_CreateWatchlist_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Watchlist](#API_connect-voice-id_CreateWatchlist_ResponseSyntax) **   <a name="connect-connect-voice-id_CreateWatchlist-response-Watchlist"></a>
Information about the newly created watchlist.  
Type: [Watchlist](API_connect-voice-id_Watchlist.md) object

## Errors
<a name="API_connect-voice-id_CreateWatchlist_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** ConflictException **   
The request failed due to a conflict. Check the `ConflictType` and error message for more details.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The request exceeded the service quota. Refer to [Voice ID Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) and try your request again.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_CreateWatchlist_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/CreateWatchlist) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/CreateWatchlist) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/CreateWatchlist) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/CreateWatchlist) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/CreateWatchlist) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/CreateWatchlist) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/CreateWatchlist) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/CreateWatchlist) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/CreateWatchlist) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/CreateWatchlist) 

# DeleteDomain
<a name="API_connect-voice-id_DeleteDomain"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Deletes the specified domain from Voice ID.

## Request Syntax
<a name="API_connect-voice-id_DeleteDomain_RequestSyntax"></a>

```
{
   "DomainId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_DeleteDomain_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_DeleteDomain_RequestSyntax) **   <a name="connect-connect-voice-id_DeleteDomain-request-DomainId"></a>
The identifier of the domain you want to delete.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

## Response Elements
<a name="API_connect-voice-id_DeleteDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-voice-id_DeleteDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** ConflictException **   
The request failed due to a conflict. Check the `ConflictType` and error message for more details.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_DeleteDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/DeleteDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/DeleteDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DeleteDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/DeleteDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DeleteDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/DeleteDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/DeleteDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/DeleteDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/DeleteDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DeleteDomain) 

# DeleteFraudster
<a name="API_connect-voice-id_DeleteFraudster"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of.

## Request Syntax
<a name="API_connect-voice-id_DeleteFraudster_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "FraudsterId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_DeleteFraudster_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_DeleteFraudster_RequestSyntax) **   <a name="connect-connect-voice-id_DeleteFraudster-request-DomainId"></a>
The identifier of the domain that contains the fraudster.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [FraudsterId](#API_connect-voice-id_DeleteFraudster_RequestSyntax) **   <a name="connect-connect-voice-id_DeleteFraudster-request-FraudsterId"></a>
The identifier of the fraudster you want to delete.  
Type: String  
Length Constraints: Fixed length of 25.  
Pattern: `id#[a-zA-Z0-9]{22}`   
Required: Yes

## Response Elements
<a name="API_connect-voice-id_DeleteFraudster_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-voice-id_DeleteFraudster_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** ConflictException **   
The request failed due to a conflict. Check the `ConflictType` and error message for more details.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_DeleteFraudster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/DeleteFraudster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/DeleteFraudster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DeleteFraudster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/DeleteFraudster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DeleteFraudster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/DeleteFraudster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/DeleteFraudster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/DeleteFraudster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/DeleteFraudster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DeleteFraudster) 

# DeleteSpeaker
<a name="API_connect-voice-id_DeleteSpeaker"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Deletes the specified speaker from Voice ID.

## Request Syntax
<a name="API_connect-voice-id_DeleteSpeaker_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "SpeakerId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_DeleteSpeaker_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_DeleteSpeaker_RequestSyntax) **   <a name="connect-connect-voice-id_DeleteSpeaker-request-DomainId"></a>
The identifier of the domain that contains the speaker.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [SpeakerId](#API_connect-voice-id_DeleteSpeaker_RequestSyntax) **   <a name="connect-connect-voice-id_DeleteSpeaker-request-SpeakerId"></a>
The identifier of the speaker you want to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `(id#[a-zA-Z0-9]{22}|[a-zA-Z0-9][a-zA-Z0-9_-]*)`   
Required: Yes

## Response Elements
<a name="API_connect-voice-id_DeleteSpeaker_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-voice-id_DeleteSpeaker_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** ConflictException **   
The request failed due to a conflict. Check the `ConflictType` and error message for more details.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_DeleteSpeaker_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/DeleteSpeaker) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/DeleteSpeaker) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DeleteSpeaker) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/DeleteSpeaker) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DeleteSpeaker) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/DeleteSpeaker) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/DeleteSpeaker) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/DeleteSpeaker) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/DeleteSpeaker) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DeleteSpeaker) 

# DeleteWatchlist
<a name="API_connect-voice-id_DeleteWatchlist"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Deletes the specified watchlist from Voice ID. This API throws an exception when there are fraudsters in the watchlist that you are trying to delete. You must delete the fraudsters, and then delete the watchlist. Every domain has a default watchlist which cannot be deleted. 

## Request Syntax
<a name="API_connect-voice-id_DeleteWatchlist_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "WatchlistId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_DeleteWatchlist_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_DeleteWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_DeleteWatchlist-request-DomainId"></a>
The identifier of the domain that contains the watchlist.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [WatchlistId](#API_connect-voice-id_DeleteWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_DeleteWatchlist-request-WatchlistId"></a>
The identifier of the watchlist to be deleted.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

## Response Elements
<a name="API_connect-voice-id_DeleteWatchlist_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-voice-id_DeleteWatchlist_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** ConflictException **   
The request failed due to a conflict. Check the `ConflictType` and error message for more details.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_DeleteWatchlist_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/DeleteWatchlist) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/DeleteWatchlist) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DeleteWatchlist) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/DeleteWatchlist) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DeleteWatchlist) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/DeleteWatchlist) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/DeleteWatchlist) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/DeleteWatchlist) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/DeleteWatchlist) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DeleteWatchlist) 

# DescribeDomain
<a name="API_connect-voice-id_DescribeDomain"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Describes the specified domain.

## Request Syntax
<a name="API_connect-voice-id_DescribeDomain_RequestSyntax"></a>

```
{
   "DomainId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_DescribeDomain_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_DescribeDomain_RequestSyntax) **   <a name="connect-connect-voice-id_DescribeDomain-request-DomainId"></a>
The identifier of the domain that you are describing.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_DescribeDomain_ResponseSyntax"></a>

```
{
   "Domain": { 
      "Arn": "string",
      "CreatedAt": number,
      "Description": "string",
      "DomainId": "string",
      "DomainStatus": "string",
      "Name": "string",
      "ServerSideEncryptionConfiguration": { 
         "KmsKeyId": "string"
      },
      "ServerSideEncryptionUpdateDetails": { 
         "Message": "string",
         "OldKmsKeyId": "string",
         "UpdateStatus": "string"
      },
      "UpdatedAt": number,
      "WatchlistDetails": { 
         "DefaultWatchlistId": "string"
      }
   }
}
```

## Response Elements
<a name="API_connect-voice-id_DescribeDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Domain](#API_connect-voice-id_DescribeDomain_ResponseSyntax) **   <a name="connect-connect-voice-id_DescribeDomain-response-Domain"></a>
Information about the specified domain.  
Type: [Domain](API_connect-voice-id_Domain.md) object

## Errors
<a name="API_connect-voice-id_DescribeDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_DescribeDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/DescribeDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/DescribeDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DescribeDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/DescribeDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DescribeDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/DescribeDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/DescribeDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/DescribeDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/DescribeDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DescribeDomain) 

# DescribeFraudster
<a name="API_connect-voice-id_DescribeFraudster"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Describes the specified fraudster.

## Request Syntax
<a name="API_connect-voice-id_DescribeFraudster_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "FraudsterId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_DescribeFraudster_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_DescribeFraudster_RequestSyntax) **   <a name="connect-connect-voice-id_DescribeFraudster-request-DomainId"></a>
The identifier of the domain that contains the fraudster.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [FraudsterId](#API_connect-voice-id_DescribeFraudster_RequestSyntax) **   <a name="connect-connect-voice-id_DescribeFraudster-request-FraudsterId"></a>
The identifier of the fraudster you are describing.  
Type: String  
Length Constraints: Fixed length of 25.  
Pattern: `id#[a-zA-Z0-9]{22}`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_DescribeFraudster_ResponseSyntax"></a>

```
{
   "Fraudster": { 
      "CreatedAt": number,
      "DomainId": "string",
      "GeneratedFraudsterId": "string",
      "WatchlistIds": [ "string" ]
   }
}
```

## Response Elements
<a name="API_connect-voice-id_DescribeFraudster_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Fraudster](#API_connect-voice-id_DescribeFraudster_ResponseSyntax) **   <a name="connect-connect-voice-id_DescribeFraudster-response-Fraudster"></a>
Information about the specified fraudster.  
Type: [Fraudster](API_connect-voice-id_Fraudster.md) object

## Errors
<a name="API_connect-voice-id_DescribeFraudster_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_DescribeFraudster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/DescribeFraudster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/DescribeFraudster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DescribeFraudster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/DescribeFraudster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DescribeFraudster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/DescribeFraudster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/DescribeFraudster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/DescribeFraudster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/DescribeFraudster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DescribeFraudster) 

# DescribeFraudsterRegistrationJob
<a name="API_connect-voice-id_DescribeFraudsterRegistrationJob"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Describes the specified fraudster registration job.

## Request Syntax
<a name="API_connect-voice-id_DescribeFraudsterRegistrationJob_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "JobId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_DescribeFraudsterRegistrationJob_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_DescribeFraudsterRegistrationJob_RequestSyntax) **   <a name="connect-connect-voice-id_DescribeFraudsterRegistrationJob-request-DomainId"></a>
The identifier of the domain that contains the fraudster registration job.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [JobId](#API_connect-voice-id_DescribeFraudsterRegistrationJob_RequestSyntax) **   <a name="connect-connect-voice-id_DescribeFraudsterRegistrationJob-request-JobId"></a>
The identifier of the fraudster registration job you are describing.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_DescribeFraudsterRegistrationJob_ResponseSyntax"></a>

```
{
   "Job": { 
      "CreatedAt": number,
      "DataAccessRoleArn": "string",
      "DomainId": "string",
      "EndedAt": number,
      "FailureDetails": { 
         "Message": "string",
         "StatusCode": number
      },
      "InputDataConfig": { 
         "S3Uri": "string"
      },
      "JobId": "string",
      "JobName": "string",
      "JobProgress": { 
         "PercentComplete": number
      },
      "JobStatus": "string",
      "OutputDataConfig": { 
         "KmsKeyId": "string",
         "S3Uri": "string"
      },
      "RegistrationConfig": { 
         "DuplicateRegistrationAction": "string",
         "FraudsterSimilarityThreshold": number,
         "WatchlistIds": [ "string" ]
      }
   }
}
```

## Response Elements
<a name="API_connect-voice-id_DescribeFraudsterRegistrationJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Job](#API_connect-voice-id_DescribeFraudsterRegistrationJob_ResponseSyntax) **   <a name="connect-connect-voice-id_DescribeFraudsterRegistrationJob-response-Job"></a>
Contains details about the specified fraudster registration job.  
Type: [FraudsterRegistrationJob](API_connect-voice-id_FraudsterRegistrationJob.md) object

## Errors
<a name="API_connect-voice-id_DescribeFraudsterRegistrationJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_DescribeFraudsterRegistrationJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/DescribeFraudsterRegistrationJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/DescribeFraudsterRegistrationJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DescribeFraudsterRegistrationJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/DescribeFraudsterRegistrationJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DescribeFraudsterRegistrationJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/DescribeFraudsterRegistrationJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/DescribeFraudsterRegistrationJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/DescribeFraudsterRegistrationJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/DescribeFraudsterRegistrationJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DescribeFraudsterRegistrationJob) 

# DescribeSpeaker
<a name="API_connect-voice-id_DescribeSpeaker"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Describes the specified speaker.

## Request Syntax
<a name="API_connect-voice-id_DescribeSpeaker_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "SpeakerId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_DescribeSpeaker_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_DescribeSpeaker_RequestSyntax) **   <a name="connect-connect-voice-id_DescribeSpeaker-request-DomainId"></a>
The identifier of the domain that contains the speaker.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [SpeakerId](#API_connect-voice-id_DescribeSpeaker_RequestSyntax) **   <a name="connect-connect-voice-id_DescribeSpeaker-request-SpeakerId"></a>
The identifier of the speaker you are describing.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `(id#[a-zA-Z0-9]{22}|[a-zA-Z0-9][a-zA-Z0-9_-]*)`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_DescribeSpeaker_ResponseSyntax"></a>

```
{
   "Speaker": { 
      "CreatedAt": number,
      "CustomerSpeakerId": "string",
      "DomainId": "string",
      "GeneratedSpeakerId": "string",
      "LastAccessedAt": number,
      "Status": "string",
      "UpdatedAt": number
   }
}
```

## Response Elements
<a name="API_connect-voice-id_DescribeSpeaker_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Speaker](#API_connect-voice-id_DescribeSpeaker_ResponseSyntax) **   <a name="connect-connect-voice-id_DescribeSpeaker-response-Speaker"></a>
Information about the specified speaker.  
Type: [Speaker](API_connect-voice-id_Speaker.md) object

## Errors
<a name="API_connect-voice-id_DescribeSpeaker_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_DescribeSpeaker_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/DescribeSpeaker) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/DescribeSpeaker) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DescribeSpeaker) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/DescribeSpeaker) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DescribeSpeaker) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/DescribeSpeaker) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/DescribeSpeaker) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/DescribeSpeaker) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/DescribeSpeaker) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DescribeSpeaker) 

# DescribeSpeakerEnrollmentJob
<a name="API_connect-voice-id_DescribeSpeakerEnrollmentJob"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Describes the specified speaker enrollment job.

## Request Syntax
<a name="API_connect-voice-id_DescribeSpeakerEnrollmentJob_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "JobId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_DescribeSpeakerEnrollmentJob_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_DescribeSpeakerEnrollmentJob_RequestSyntax) **   <a name="connect-connect-voice-id_DescribeSpeakerEnrollmentJob-request-DomainId"></a>
The identifier of the domain that contains the speaker enrollment job.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [JobId](#API_connect-voice-id_DescribeSpeakerEnrollmentJob_RequestSyntax) **   <a name="connect-connect-voice-id_DescribeSpeakerEnrollmentJob-request-JobId"></a>
The identifier of the speaker enrollment job you are describing.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_DescribeSpeakerEnrollmentJob_ResponseSyntax"></a>

```
{
   "Job": { 
      "CreatedAt": number,
      "DataAccessRoleArn": "string",
      "DomainId": "string",
      "EndedAt": number,
      "EnrollmentConfig": { 
         "ExistingEnrollmentAction": "string",
         "FraudDetectionConfig": { 
            "FraudDetectionAction": "string",
            "RiskThreshold": number,
            "WatchlistIds": [ "string" ]
         }
      },
      "FailureDetails": { 
         "Message": "string",
         "StatusCode": number
      },
      "InputDataConfig": { 
         "S3Uri": "string"
      },
      "JobId": "string",
      "JobName": "string",
      "JobProgress": { 
         "PercentComplete": number
      },
      "JobStatus": "string",
      "OutputDataConfig": { 
         "KmsKeyId": "string",
         "S3Uri": "string"
      }
   }
}
```

## Response Elements
<a name="API_connect-voice-id_DescribeSpeakerEnrollmentJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Job](#API_connect-voice-id_DescribeSpeakerEnrollmentJob_ResponseSyntax) **   <a name="connect-connect-voice-id_DescribeSpeakerEnrollmentJob-response-Job"></a>
Contains details about the specified speaker enrollment job.  
Type: [SpeakerEnrollmentJob](API_connect-voice-id_SpeakerEnrollmentJob.md) object

## Errors
<a name="API_connect-voice-id_DescribeSpeakerEnrollmentJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_DescribeSpeakerEnrollmentJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob) 

# DescribeWatchlist
<a name="API_connect-voice-id_DescribeWatchlist"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Describes the specified watchlist.

## Request Syntax
<a name="API_connect-voice-id_DescribeWatchlist_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "WatchlistId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_DescribeWatchlist_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_DescribeWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_DescribeWatchlist-request-DomainId"></a>
The identifier of the domain that contains the watchlist.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [WatchlistId](#API_connect-voice-id_DescribeWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_DescribeWatchlist-request-WatchlistId"></a>
The identifier of the watchlist that you are describing.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_DescribeWatchlist_ResponseSyntax"></a>

```
{
   "Watchlist": { 
      "CreatedAt": number,
      "DefaultWatchlist": boolean,
      "Description": "string",
      "DomainId": "string",
      "Name": "string",
      "UpdatedAt": number,
      "WatchlistId": "string"
   }
}
```

## Response Elements
<a name="API_connect-voice-id_DescribeWatchlist_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Watchlist](#API_connect-voice-id_DescribeWatchlist_ResponseSyntax) **   <a name="connect-connect-voice-id_DescribeWatchlist-response-Watchlist"></a>
Information about the specified watchlist.  
Type: [Watchlist](API_connect-voice-id_Watchlist.md) object

## Errors
<a name="API_connect-voice-id_DescribeWatchlist_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_DescribeWatchlist_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/DescribeWatchlist) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/DescribeWatchlist) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DescribeWatchlist) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/DescribeWatchlist) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DescribeWatchlist) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/DescribeWatchlist) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/DescribeWatchlist) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/DescribeWatchlist) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/DescribeWatchlist) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DescribeWatchlist) 

# DisassociateFraudster
<a name="API_connect-voice-id_DisassociateFraudster"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Disassociates the fraudsters from the watchlist specified. Voice ID always expects a fraudster to be a part of at least one watchlist. If you try to disassociate a fraudster from its only watchlist, a `ValidationException` is thrown. 

## Request Syntax
<a name="API_connect-voice-id_DisassociateFraudster_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "FraudsterId": "string",
   "WatchlistId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_DisassociateFraudster_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_DisassociateFraudster_RequestSyntax) **   <a name="connect-connect-voice-id_DisassociateFraudster-request-DomainId"></a>
The identifier of the domain that contains the fraudster.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [FraudsterId](#API_connect-voice-id_DisassociateFraudster_RequestSyntax) **   <a name="connect-connect-voice-id_DisassociateFraudster-request-FraudsterId"></a>
The identifier of the fraudster to be disassociated from the watchlist.  
Type: String  
Length Constraints: Fixed length of 25.  
Pattern: `id#[a-zA-Z0-9]{22}`   
Required: Yes

 ** [WatchlistId](#API_connect-voice-id_DisassociateFraudster_RequestSyntax) **   <a name="connect-connect-voice-id_DisassociateFraudster-request-WatchlistId"></a>
The identifier of the watchlist that you want to disassociate from the fraudster.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_DisassociateFraudster_ResponseSyntax"></a>

```
{
   "Fraudster": { 
      "CreatedAt": number,
      "DomainId": "string",
      "GeneratedFraudsterId": "string",
      "WatchlistIds": [ "string" ]
   }
}
```

## Response Elements
<a name="API_connect-voice-id_DisassociateFraudster_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Fraudster](#API_connect-voice-id_DisassociateFraudster_ResponseSyntax) **   <a name="connect-connect-voice-id_DisassociateFraudster-response-Fraudster"></a>
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).
Contains all the information about a fraudster.  
Type: [Fraudster](API_connect-voice-id_Fraudster.md) object

## Errors
<a name="API_connect-voice-id_DisassociateFraudster_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** ConflictException **   
The request failed due to a conflict. Check the `ConflictType` and error message for more details.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_DisassociateFraudster_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/DisassociateFraudster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/DisassociateFraudster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/DisassociateFraudster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/DisassociateFraudster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/DisassociateFraudster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/DisassociateFraudster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/DisassociateFraudster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/DisassociateFraudster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/DisassociateFraudster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/DisassociateFraudster) 

# EvaluateSession
<a name="API_connect-voice-id_EvaluateSession"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.

## Request Syntax
<a name="API_connect-voice-id_EvaluateSession_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "SessionNameOrId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_EvaluateSession_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_EvaluateSession_RequestSyntax) **   <a name="connect-connect-voice-id_EvaluateSession-request-DomainId"></a>
The identifier of the domain where the session started.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [SessionNameOrId](#API_connect-voice-id_EvaluateSession_RequestSyntax) **   <a name="connect-connect-voice-id_EvaluateSession-request-SessionNameOrId"></a>
The session identifier, or name of the session, that you want to evaluate. In Voice ID integration, this is the Contact-Id.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Pattern: `(id#[a-zA-Z0-9]{22}|[a-zA-Z0-9][a-zA-Z0-9_-]*)`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_EvaluateSession_ResponseSyntax"></a>

```
{
   "AuthenticationResult": { 
      "AudioAggregationEndedAt": number,
      "AudioAggregationStartedAt": number,
      "AuthenticationResultId": "string",
      "Configuration": { 
         "AcceptanceThreshold": number
      },
      "CustomerSpeakerId": "string",
      "Decision": "string",
      "GeneratedSpeakerId": "string",
      "Score": number
   },
   "DomainId": "string",
   "FraudDetectionResult": { 
      "AudioAggregationEndedAt": number,
      "AudioAggregationStartedAt": number,
      "Configuration": { 
         "RiskThreshold": number,
         "WatchlistId": "string"
      },
      "Decision": "string",
      "FraudDetectionResultId": "string",
      "Reasons": [ "string" ],
      "RiskDetails": { 
         "KnownFraudsterRisk": { 
            "GeneratedFraudsterId": "string",
            "RiskScore": number
         },
         "VoiceSpoofingRisk": { 
            "RiskScore": number
         }
      }
   },
   "SessionId": "string",
   "SessionName": "string",
   "StreamingStatus": "string"
}
```

## Response Elements
<a name="API_connect-voice-id_EvaluateSession_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AuthenticationResult](#API_connect-voice-id_EvaluateSession_ResponseSyntax) **   <a name="connect-connect-voice-id_EvaluateSession-response-AuthenticationResult"></a>
Details resulting from the authentication process, such as authentication decision and authentication score.  
Type: [AuthenticationResult](API_connect-voice-id_AuthenticationResult.md) object

 ** [DomainId](#API_connect-voice-id_EvaluateSession_ResponseSyntax) **   <a name="connect-connect-voice-id_EvaluateSession-response-DomainId"></a>
The identifier of the domain that contains the session.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}` 

 ** [FraudDetectionResult](#API_connect-voice-id_EvaluateSession_ResponseSyntax) **   <a name="connect-connect-voice-id_EvaluateSession-response-FraudDetectionResult"></a>
Details resulting from the fraud detection process, such as fraud detection decision and risk score.  
Type: [FraudDetectionResult](API_connect-voice-id_FraudDetectionResult.md) object

 ** [SessionId](#API_connect-voice-id_EvaluateSession_ResponseSyntax) **   <a name="connect-connect-voice-id_EvaluateSession-response-SessionId"></a>
The service-generated identifier of the session.  
Type: String  
Length Constraints: Fixed length of 25.  
Pattern: `id#[a-zA-Z0-9]{22}` 

 ** [SessionName](#API_connect-voice-id_EvaluateSession_ResponseSyntax) **   <a name="connect-connect-voice-id_EvaluateSession-response-SessionName"></a>
The client-provided name of the session.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*` 

 ** [StreamingStatus](#API_connect-voice-id_EvaluateSession_ResponseSyntax) **   <a name="connect-connect-voice-id_EvaluateSession-response-StreamingStatus"></a>
The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is `NOT_ENOUGH_SPEECH`. In this situation, if the `StreamingStatus` is `ONGOING/PENDING_CONFIGURATION`, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remains `NOT_ENOUGH_SPEECH` even after `StreamingStatus` is `ENDED`, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.  
Type: String  
Valid Values: `PENDING_CONFIGURATION | ONGOING | ENDED` 

## Errors
<a name="API_connect-voice-id_EvaluateSession_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** ConflictException **   
The request failed due to a conflict. Check the `ConflictType` and error message for more details.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_EvaluateSession_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/EvaluateSession) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/EvaluateSession) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/EvaluateSession) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/EvaluateSession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/EvaluateSession) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/EvaluateSession) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/EvaluateSession) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/EvaluateSession) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/EvaluateSession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/EvaluateSession) 

# ListDomains
<a name="API_connect-voice-id_ListDomains"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Lists all the domains in the AWS account. 

## Request Syntax
<a name="API_connect-voice-id_ListDomains_RequestSyntax"></a>

```
{
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_ListDomains_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [MaxResults](#API_connect-voice-id_ListDomains_RequestSyntax) **   <a name="connect-connect-voice-id_ListDomains-request-MaxResults"></a>
The maximum number of results that are returned per call. You can use `NextToken` to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 10.  
Required: No

 ** [NextToken](#API_connect-voice-id_ListDomains_RequestSyntax) **   <a name="connect-connect-voice-id_ListDomains-request-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

## Response Syntax
<a name="API_connect-voice-id_ListDomains_ResponseSyntax"></a>

```
{
   "DomainSummaries": [ 
      { 
         "Arn": "string",
         "CreatedAt": number,
         "Description": "string",
         "DomainId": "string",
         "DomainStatus": "string",
         "Name": "string",
         "ServerSideEncryptionConfiguration": { 
            "KmsKeyId": "string"
         },
         "ServerSideEncryptionUpdateDetails": { 
            "Message": "string",
            "OldKmsKeyId": "string",
            "UpdateStatus": "string"
         },
         "UpdatedAt": number,
         "WatchlistDetails": { 
            "DefaultWatchlistId": "string"
         }
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-voice-id_ListDomains_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DomainSummaries](#API_connect-voice-id_ListDomains_ResponseSyntax) **   <a name="connect-connect-voice-id_ListDomains-response-DomainSummaries"></a>
A list containing details about each domain in the AWS account.  
Type: Array of [DomainSummary](API_connect-voice-id_DomainSummary.md) objects

 ** [NextToken](#API_connect-voice-id_ListDomains_ResponseSyntax) **   <a name="connect-connect-voice-id_ListDomains-response-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.  
Type: String  
Length Constraints: Minimum length of 1.

## Errors
<a name="API_connect-voice-id_ListDomains_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_ListDomains_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/ListDomains) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/ListDomains) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/ListDomains) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/ListDomains) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/ListDomains) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/ListDomains) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/ListDomains) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/ListDomains) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/ListDomains) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/ListDomains) 

# ListFraudsterRegistrationJobs
<a name="API_connect-voice-id_ListFraudsterRegistrationJobs"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Lists all the fraudster registration jobs in the domain with the given `JobStatus`. If `JobStatus` is not provided, this lists all fraudster registration jobs in the given domain. 

## Request Syntax
<a name="API_connect-voice-id_ListFraudsterRegistrationJobs_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "JobStatus": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_ListFraudsterRegistrationJobs_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_ListFraudsterRegistrationJobs_RequestSyntax) **   <a name="connect-connect-voice-id_ListFraudsterRegistrationJobs-request-DomainId"></a>
The identifier of the domain that contains the fraudster registration Jobs.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [JobStatus](#API_connect-voice-id_ListFraudsterRegistrationJobs_RequestSyntax) **   <a name="connect-connect-voice-id_ListFraudsterRegistrationJobs-request-JobStatus"></a>
Provides the status of your fraudster registration job.  
Type: String  
Valid Values: `SUBMITTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | FAILED`   
Required: No

 ** [MaxResults](#API_connect-voice-id_ListFraudsterRegistrationJobs_RequestSyntax) **   <a name="connect-connect-voice-id_ListFraudsterRegistrationJobs-request-MaxResults"></a>
The maximum number of results that are returned per call. You can use `NextToken` to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_connect-voice-id_ListFraudsterRegistrationJobs_RequestSyntax) **   <a name="connect-connect-voice-id_ListFraudsterRegistrationJobs-request-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

## Response Syntax
<a name="API_connect-voice-id_ListFraudsterRegistrationJobs_ResponseSyntax"></a>

```
{
   "JobSummaries": [ 
      { 
         "CreatedAt": number,
         "DomainId": "string",
         "EndedAt": number,
         "FailureDetails": { 
            "Message": "string",
            "StatusCode": number
         },
         "JobId": "string",
         "JobName": "string",
         "JobProgress": { 
            "PercentComplete": number
         },
         "JobStatus": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-voice-id_ListFraudsterRegistrationJobs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [JobSummaries](#API_connect-voice-id_ListFraudsterRegistrationJobs_ResponseSyntax) **   <a name="connect-connect-voice-id_ListFraudsterRegistrationJobs-response-JobSummaries"></a>
A list containing details about each specified fraudster registration job.  
Type: Array of [FraudsterRegistrationJobSummary](API_connect-voice-id_FraudsterRegistrationJobSummary.md) objects

 ** [NextToken](#API_connect-voice-id_ListFraudsterRegistrationJobs_ResponseSyntax) **   <a name="connect-connect-voice-id_ListFraudsterRegistrationJobs-response-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.  
Type: String  
Length Constraints: Minimum length of 1.

## Errors
<a name="API_connect-voice-id_ListFraudsterRegistrationJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_ListFraudsterRegistrationJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/ListFraudsterRegistrationJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/ListFraudsterRegistrationJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/ListFraudsterRegistrationJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/ListFraudsterRegistrationJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/ListFraudsterRegistrationJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/ListFraudsterRegistrationJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/ListFraudsterRegistrationJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/ListFraudsterRegistrationJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/ListFraudsterRegistrationJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/ListFraudsterRegistrationJobs) 

# ListFraudsters
<a name="API_connect-voice-id_ListFraudsters"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Lists all fraudsters in a specified watchlist or domain.

## Request Syntax
<a name="API_connect-voice-id_ListFraudsters_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "WatchlistId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_ListFraudsters_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_ListFraudsters_RequestSyntax) **   <a name="connect-connect-voice-id_ListFraudsters-request-DomainId"></a>
The identifier of the domain.   
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [MaxResults](#API_connect-voice-id_ListFraudsters_RequestSyntax) **   <a name="connect-connect-voice-id_ListFraudsters-request-MaxResults"></a>
The maximum number of results that are returned per call. You can use `NextToken` to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_connect-voice-id_ListFraudsters_RequestSyntax) **   <a name="connect-connect-voice-id_ListFraudsters-request-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

 ** [WatchlistId](#API_connect-voice-id_ListFraudsters_RequestSyntax) **   <a name="connect-connect-voice-id_ListFraudsters-request-WatchlistId"></a>
The identifier of the watchlist. If provided, all fraudsters in the watchlist are listed. If not provided, all fraudsters in the domain are listed.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: No

## Response Syntax
<a name="API_connect-voice-id_ListFraudsters_ResponseSyntax"></a>

```
{
   "FraudsterSummaries": [ 
      { 
         "CreatedAt": number,
         "DomainId": "string",
         "GeneratedFraudsterId": "string",
         "WatchlistIds": [ "string" ]
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-voice-id_ListFraudsters_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FraudsterSummaries](#API_connect-voice-id_ListFraudsters_ResponseSyntax) **   <a name="connect-connect-voice-id_ListFraudsters-response-FraudsterSummaries"></a>
A list that contains details about each fraudster in the AWS account.   
Type: Array of [FraudsterSummary](API_connect-voice-id_FraudsterSummary.md) objects

 ** [NextToken](#API_connect-voice-id_ListFraudsters_ResponseSyntax) **   <a name="connect-connect-voice-id_ListFraudsters-response-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.   
Type: String  
Length Constraints: Minimum length of 1.

## Errors
<a name="API_connect-voice-id_ListFraudsters_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_ListFraudsters_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/ListFraudsters) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/ListFraudsters) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/ListFraudsters) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/ListFraudsters) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/ListFraudsters) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/ListFraudsters) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/ListFraudsters) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/ListFraudsters) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/ListFraudsters) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/ListFraudsters) 

# ListSpeakerEnrollmentJobs
<a name="API_connect-voice-id_ListSpeakerEnrollmentJobs"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Lists all the speaker enrollment jobs in the domain with the specified `JobStatus`. If `JobStatus` is not provided, this lists all jobs with all possible speaker enrollment job statuses.

## Request Syntax
<a name="API_connect-voice-id_ListSpeakerEnrollmentJobs_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "JobStatus": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_ListSpeakerEnrollmentJobs_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_ListSpeakerEnrollmentJobs_RequestSyntax) **   <a name="connect-connect-voice-id_ListSpeakerEnrollmentJobs-request-DomainId"></a>
The identifier of the domain that contains the speaker enrollment jobs.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [JobStatus](#API_connect-voice-id_ListSpeakerEnrollmentJobs_RequestSyntax) **   <a name="connect-connect-voice-id_ListSpeakerEnrollmentJobs-request-JobStatus"></a>
Provides the status of your speaker enrollment Job.  
Type: String  
Valid Values: `SUBMITTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | FAILED`   
Required: No

 ** [MaxResults](#API_connect-voice-id_ListSpeakerEnrollmentJobs_RequestSyntax) **   <a name="connect-connect-voice-id_ListSpeakerEnrollmentJobs-request-MaxResults"></a>
The maximum number of results that are returned per call. You can use `NextToken` to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_connect-voice-id_ListSpeakerEnrollmentJobs_RequestSyntax) **   <a name="connect-connect-voice-id_ListSpeakerEnrollmentJobs-request-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

## Response Syntax
<a name="API_connect-voice-id_ListSpeakerEnrollmentJobs_ResponseSyntax"></a>

```
{
   "JobSummaries": [ 
      { 
         "CreatedAt": number,
         "DomainId": "string",
         "EndedAt": number,
         "FailureDetails": { 
            "Message": "string",
            "StatusCode": number
         },
         "JobId": "string",
         "JobName": "string",
         "JobProgress": { 
            "PercentComplete": number
         },
         "JobStatus": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_connect-voice-id_ListSpeakerEnrollmentJobs_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [JobSummaries](#API_connect-voice-id_ListSpeakerEnrollmentJobs_ResponseSyntax) **   <a name="connect-connect-voice-id_ListSpeakerEnrollmentJobs-response-JobSummaries"></a>
A list containing details about each specified speaker enrollment job.  
Type: Array of [SpeakerEnrollmentJobSummary](API_connect-voice-id_SpeakerEnrollmentJobSummary.md) objects

 ** [NextToken](#API_connect-voice-id_ListSpeakerEnrollmentJobs_ResponseSyntax) **   <a name="connect-connect-voice-id_ListSpeakerEnrollmentJobs-response-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.   
Type: String  
Length Constraints: Minimum length of 1.

## Errors
<a name="API_connect-voice-id_ListSpeakerEnrollmentJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_ListSpeakerEnrollmentJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/ListSpeakerEnrollmentJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/ListSpeakerEnrollmentJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/ListSpeakerEnrollmentJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/ListSpeakerEnrollmentJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/ListSpeakerEnrollmentJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/ListSpeakerEnrollmentJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/ListSpeakerEnrollmentJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/ListSpeakerEnrollmentJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/ListSpeakerEnrollmentJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/ListSpeakerEnrollmentJobs) 

# ListSpeakers
<a name="API_connect-voice-id_ListSpeakers"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Lists all speakers in a specified domain.

## Request Syntax
<a name="API_connect-voice-id_ListSpeakers_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_ListSpeakers_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_ListSpeakers_RequestSyntax) **   <a name="connect-connect-voice-id_ListSpeakers-request-DomainId"></a>
The identifier of the domain.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [MaxResults](#API_connect-voice-id_ListSpeakers_RequestSyntax) **   <a name="connect-connect-voice-id_ListSpeakers-request-MaxResults"></a>
The maximum number of results that are returned per call. You can use `NextToken` to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_connect-voice-id_ListSpeakers_RequestSyntax) **   <a name="connect-connect-voice-id_ListSpeakers-request-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

## Response Syntax
<a name="API_connect-voice-id_ListSpeakers_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "SpeakerSummaries": [ 
      { 
         "CreatedAt": number,
         "CustomerSpeakerId": "string",
         "DomainId": "string",
         "GeneratedSpeakerId": "string",
         "LastAccessedAt": number,
         "Status": "string",
         "UpdatedAt": number
      }
   ]
}
```

## Response Elements
<a name="API_connect-voice-id_ListSpeakers_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_connect-voice-id_ListSpeakers_ResponseSyntax) **   <a name="connect-connect-voice-id_ListSpeakers-response-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.   
Type: String  
Length Constraints: Minimum length of 1.

 ** [SpeakerSummaries](#API_connect-voice-id_ListSpeakers_ResponseSyntax) **   <a name="connect-connect-voice-id_ListSpeakers-response-SpeakerSummaries"></a>
A list containing details about each speaker in the AWS account.   
Type: Array of [SpeakerSummary](API_connect-voice-id_SpeakerSummary.md) objects

## Errors
<a name="API_connect-voice-id_ListSpeakers_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_ListSpeakers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/ListSpeakers) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/ListSpeakers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/ListSpeakers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/ListSpeakers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/ListSpeakers) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/ListSpeakers) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/ListSpeakers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/ListSpeakers) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/ListSpeakers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/ListSpeakers) 

# ListTagsForResource
<a name="API_connect-voice-id_ListTagsForResource"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Lists all tags associated with a specified Voice ID resource.

## Request Syntax
<a name="API_connect-voice-id_ListTagsForResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_ListTagsForResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceArn](#API_connect-voice-id_ListTagsForResource_RequestSyntax) **   <a name="connect-connect-voice-id_ListTagsForResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the Voice ID resource for which you want to list the tags.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:aws(-[^:]+)?:voiceid.+:[0-9]{12}:domain/[a-zA-Z0-9]{22}`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_ListTagsForResource_ResponseSyntax"></a>

```
{
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-voice-id_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Tags](#API_connect-voice-id_ListTagsForResource_ResponseSyntax) **   <a name="connect-connect-voice-id_ListTagsForResource-response-Tags"></a>
The list of tags associated with the specified resource.  
Type: Array of [Tag](API_connect-voice-id_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.

## Errors
<a name="API_connect-voice-id_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/ListTagsForResource) 

# ListWatchlists
<a name="API_connect-voice-id_ListWatchlists"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Lists all watchlists in a specified domain.

## Request Syntax
<a name="API_connect-voice-id_ListWatchlists_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "MaxResults": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_ListWatchlists_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_ListWatchlists_RequestSyntax) **   <a name="connect-connect-voice-id_ListWatchlists-request-DomainId"></a>
The identifier of the domain.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [MaxResults](#API_connect-voice-id_ListWatchlists_RequestSyntax) **   <a name="connect-connect-voice-id_ListWatchlists-request-MaxResults"></a>
The maximum number of results that are returned per call. You can use `NextToken` to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_connect-voice-id_ListWatchlists_RequestSyntax) **   <a name="connect-connect-voice-id_ListWatchlists-request-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.   
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 8192.  
Pattern: `\p{ASCII}{0,8192}`   
Required: No

## Response Syntax
<a name="API_connect-voice-id_ListWatchlists_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "WatchlistSummaries": [ 
      { 
         "CreatedAt": number,
         "DefaultWatchlist": boolean,
         "Description": "string",
         "DomainId": "string",
         "Name": "string",
         "UpdatedAt": number,
         "WatchlistId": "string"
      }
   ]
}
```

## Response Elements
<a name="API_connect-voice-id_ListWatchlists_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_connect-voice-id_ListWatchlists_ResponseSyntax) **   <a name="connect-connect-voice-id_ListWatchlists-response-NextToken"></a>
If `NextToken` is returned, there are more results available. The value of `NextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.   
Type: String  
Length Constraints: Minimum length of 1.

 ** [WatchlistSummaries](#API_connect-voice-id_ListWatchlists_ResponseSyntax) **   <a name="connect-connect-voice-id_ListWatchlists-response-WatchlistSummaries"></a>
A list that contains details about each watchlist in the AWS account.   
Type: Array of [WatchlistSummary](API_connect-voice-id_WatchlistSummary.md) objects

## Errors
<a name="API_connect-voice-id_ListWatchlists_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_ListWatchlists_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/ListWatchlists) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/ListWatchlists) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/ListWatchlists) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/ListWatchlists) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/ListWatchlists) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/ListWatchlists) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/ListWatchlists) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/ListWatchlists) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/ListWatchlists) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/ListWatchlists) 

# OptOutSpeaker
<a name="API_connect-voice-id_OptOutSpeaker"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Opts out a speaker from Voice ID. A speaker can be opted out regardless of whether or not they already exist in Voice ID. If they don't yet exist, a new speaker is created in an opted out state. If they already exist, their existing status is overridden and they are opted out. Enrollment and evaluation authentication requests are rejected for opted out speakers, and opted out speakers have no voice embeddings stored in Voice ID.

## Request Syntax
<a name="API_connect-voice-id_OptOutSpeaker_RequestSyntax"></a>

```
{
   "DomainId": "string",
   "SpeakerId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_OptOutSpeaker_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DomainId](#API_connect-voice-id_OptOutSpeaker_RequestSyntax) **   <a name="connect-connect-voice-id_OptOutSpeaker-request-DomainId"></a>
The identifier of the domain that contains the speaker.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [SpeakerId](#API_connect-voice-id_OptOutSpeaker_RequestSyntax) **   <a name="connect-connect-voice-id_OptOutSpeaker-request-SpeakerId"></a>
The identifier of the speaker you want opted-out.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `(id#[a-zA-Z0-9]{22}|[a-zA-Z0-9][a-zA-Z0-9_-]*)`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_OptOutSpeaker_ResponseSyntax"></a>

```
{
   "Speaker": { 
      "CreatedAt": number,
      "CustomerSpeakerId": "string",
      "DomainId": "string",
      "GeneratedSpeakerId": "string",
      "LastAccessedAt": number,
      "Status": "string",
      "UpdatedAt": number
   }
}
```

## Response Elements
<a name="API_connect-voice-id_OptOutSpeaker_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Speaker](#API_connect-voice-id_OptOutSpeaker_ResponseSyntax) **   <a name="connect-connect-voice-id_OptOutSpeaker-response-Speaker"></a>
Details about the opted-out speaker.  
Type: [Speaker](API_connect-voice-id_Speaker.md) object

## Errors
<a name="API_connect-voice-id_OptOutSpeaker_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** ConflictException **   
The request failed due to a conflict. Check the `ConflictType` and error message for more details.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The request exceeded the service quota. Refer to [Voice ID Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) and try your request again.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_OptOutSpeaker_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/OptOutSpeaker) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/OptOutSpeaker) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/OptOutSpeaker) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/OptOutSpeaker) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/OptOutSpeaker) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/OptOutSpeaker) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/OptOutSpeaker) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/OptOutSpeaker) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/OptOutSpeaker) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/OptOutSpeaker) 

# StartFraudsterRegistrationJob
<a name="API_connect-voice-id_StartFraudsterRegistrationJob"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Starts a new batch fraudster registration job using provided details.

## Request Syntax
<a name="API_connect-voice-id_StartFraudsterRegistrationJob_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "DataAccessRoleArn": "string",
   "DomainId": "string",
   "InputDataConfig": { 
      "S3Uri": "string"
   },
   "JobName": "string",
   "OutputDataConfig": { 
      "KmsKeyId": "string",
      "S3Uri": "string"
   },
   "RegistrationConfig": { 
      "DuplicateRegistrationAction": "string",
      "FraudsterSimilarityThreshold": number,
      "WatchlistIds": [ "string" ]
   }
}
```

## Request Parameters
<a name="API_connect-voice-id_StartFraudsterRegistrationJob_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_connect-voice-id_StartFraudsterRegistrationJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartFraudsterRegistrationJob-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-_]+`   
Required: No

 ** [DataAccessRoleArn](#API_connect-voice-id_StartFraudsterRegistrationJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartFraudsterRegistrationJob-request-DataAccessRoleArn"></a>
The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the Job output file. Refer to the [Create and edit a fraudster watchlist](https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-fraudster-watchlist.html) documentation for the permissions needed in this role.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+`   
Required: Yes

 ** [DomainId](#API_connect-voice-id_StartFraudsterRegistrationJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartFraudsterRegistrationJob-request-DomainId"></a>
The identifier of the domain that contains the fraudster registration job and in which the fraudsters are registered.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [InputDataConfig](#API_connect-voice-id_StartFraudsterRegistrationJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartFraudsterRegistrationJob-request-InputDataConfig"></a>
The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration requests.  
Type: [InputDataConfig](API_connect-voice-id_InputDataConfig.md) object  
Required: Yes

 ** [JobName](#API_connect-voice-id_StartFraudsterRegistrationJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartFraudsterRegistrationJob-request-JobName"></a>
The name of the new fraudster registration job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

 ** [OutputDataConfig](#API_connect-voice-id_StartFraudsterRegistrationJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartFraudsterRegistrationJob-request-OutputDataConfig"></a>
The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS key ID to encrypt the file.  
Type: [OutputDataConfig](API_connect-voice-id_OutputDataConfig.md) object  
Required: Yes

 ** [RegistrationConfig](#API_connect-voice-id_StartFraudsterRegistrationJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartFraudsterRegistrationJob-request-RegistrationConfig"></a>
The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster.   
Type: [RegistrationConfig](API_connect-voice-id_RegistrationConfig.md) object  
Required: No

## Response Syntax
<a name="API_connect-voice-id_StartFraudsterRegistrationJob_ResponseSyntax"></a>

```
{
   "Job": { 
      "CreatedAt": number,
      "DataAccessRoleArn": "string",
      "DomainId": "string",
      "EndedAt": number,
      "FailureDetails": { 
         "Message": "string",
         "StatusCode": number
      },
      "InputDataConfig": { 
         "S3Uri": "string"
      },
      "JobId": "string",
      "JobName": "string",
      "JobProgress": { 
         "PercentComplete": number
      },
      "JobStatus": "string",
      "OutputDataConfig": { 
         "KmsKeyId": "string",
         "S3Uri": "string"
      },
      "RegistrationConfig": { 
         "DuplicateRegistrationAction": "string",
         "FraudsterSimilarityThreshold": number,
         "WatchlistIds": [ "string" ]
      }
   }
}
```

## Response Elements
<a name="API_connect-voice-id_StartFraudsterRegistrationJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Job](#API_connect-voice-id_StartFraudsterRegistrationJob_ResponseSyntax) **   <a name="connect-connect-voice-id_StartFraudsterRegistrationJob-response-Job"></a>
Details about the started fraudster registration job.  
Type: [FraudsterRegistrationJob](API_connect-voice-id_FraudsterRegistrationJob.md) object

## Errors
<a name="API_connect-voice-id_StartFraudsterRegistrationJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** ConflictException **   
The request failed due to a conflict. Check the `ConflictType` and error message for more details.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The request exceeded the service quota. Refer to [Voice ID Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) and try your request again.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_StartFraudsterRegistrationJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/StartFraudsterRegistrationJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/StartFraudsterRegistrationJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/StartFraudsterRegistrationJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/StartFraudsterRegistrationJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/StartFraudsterRegistrationJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/StartFraudsterRegistrationJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/StartFraudsterRegistrationJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/StartFraudsterRegistrationJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/StartFraudsterRegistrationJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/StartFraudsterRegistrationJob) 

# StartSpeakerEnrollmentJob
<a name="API_connect-voice-id_StartSpeakerEnrollmentJob"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Starts a new batch speaker enrollment job using specified details.

## Request Syntax
<a name="API_connect-voice-id_StartSpeakerEnrollmentJob_RequestSyntax"></a>

```
{
   "ClientToken": "string",
   "DataAccessRoleArn": "string",
   "DomainId": "string",
   "EnrollmentConfig": { 
      "ExistingEnrollmentAction": "string",
      "FraudDetectionConfig": { 
         "FraudDetectionAction": "string",
         "RiskThreshold": number,
         "WatchlistIds": [ "string" ]
      }
   },
   "InputDataConfig": { 
      "S3Uri": "string"
   },
   "JobName": "string",
   "OutputDataConfig": { 
      "KmsKeyId": "string",
      "S3Uri": "string"
   }
}
```

## Request Parameters
<a name="API_connect-voice-id_StartSpeakerEnrollmentJob_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ClientToken](#API_connect-voice-id_StartSpeakerEnrollmentJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartSpeakerEnrollmentJob-request-ClientToken"></a>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs](https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/).  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-_]+`   
Required: No

 ** [DataAccessRoleArn](#API_connect-voice-id_StartSpeakerEnrollmentJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartSpeakerEnrollmentJob-request-DataAccessRoleArn"></a>
The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the job output file. Refer to [Batch enrollment using audio data from prior calls](https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-batch-enrollment.html) for the permissions needed in this role.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+`   
Required: Yes

 ** [DomainId](#API_connect-voice-id_StartSpeakerEnrollmentJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartSpeakerEnrollmentJob-request-DomainId"></a>
The identifier of the domain that contains the speaker enrollment job and in which the speakers are enrolled.   
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [EnrollmentConfig](#API_connect-voice-id_StartSpeakerEnrollmentJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartSpeakerEnrollmentJob-request-EnrollmentConfig"></a>
The enrollment config that contains details such as the action to take when a speaker is already enrolled in Voice ID or when a speaker is identified as a fraudster.  
Type: [EnrollmentConfig](API_connect-voice-id_EnrollmentConfig.md) object  
Required: No

 ** [InputDataConfig](#API_connect-voice-id_StartSpeakerEnrollmentJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartSpeakerEnrollmentJob-request-InputDataConfig"></a>
The input data config containing the S3 location for the input manifest file that contains the list of speaker enrollment requests.  
Type: [InputDataConfig](API_connect-voice-id_InputDataConfig.md) object  
Required: Yes

 ** [JobName](#API_connect-voice-id_StartSpeakerEnrollmentJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartSpeakerEnrollmentJob-request-JobName"></a>
A name for your speaker enrollment job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

 ** [OutputDataConfig](#API_connect-voice-id_StartSpeakerEnrollmentJob_RequestSyntax) **   <a name="connect-connect-voice-id_StartSpeakerEnrollmentJob-request-OutputDataConfig"></a>
The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS key ID to encrypt the file.  
Type: [OutputDataConfig](API_connect-voice-id_OutputDataConfig.md) object  
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_StartSpeakerEnrollmentJob_ResponseSyntax"></a>

```
{
   "Job": { 
      "CreatedAt": number,
      "DataAccessRoleArn": "string",
      "DomainId": "string",
      "EndedAt": number,
      "EnrollmentConfig": { 
         "ExistingEnrollmentAction": "string",
         "FraudDetectionConfig": { 
            "FraudDetectionAction": "string",
            "RiskThreshold": number,
            "WatchlistIds": [ "string" ]
         }
      },
      "FailureDetails": { 
         "Message": "string",
         "StatusCode": number
      },
      "InputDataConfig": { 
         "S3Uri": "string"
      },
      "JobId": "string",
      "JobName": "string",
      "JobProgress": { 
         "PercentComplete": number
      },
      "JobStatus": "string",
      "OutputDataConfig": { 
         "KmsKeyId": "string",
         "S3Uri": "string"
      }
   }
}
```

## Response Elements
<a name="API_connect-voice-id_StartSpeakerEnrollmentJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Job](#API_connect-voice-id_StartSpeakerEnrollmentJob_ResponseSyntax) **   <a name="connect-connect-voice-id_StartSpeakerEnrollmentJob-response-Job"></a>
Details about the started speaker enrollment job.  
Type: [SpeakerEnrollmentJob](API_connect-voice-id_SpeakerEnrollmentJob.md) object

## Errors
<a name="API_connect-voice-id_StartSpeakerEnrollmentJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** ConflictException **   
The request failed due to a conflict. Check the `ConflictType` and error message for more details.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ServiceQuotaExceededException **   
The request exceeded the service quota. Refer to [Voice ID Service Quotas](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) and try your request again.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_StartSpeakerEnrollmentJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/StartSpeakerEnrollmentJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/StartSpeakerEnrollmentJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/StartSpeakerEnrollmentJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/StartSpeakerEnrollmentJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/StartSpeakerEnrollmentJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/StartSpeakerEnrollmentJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/StartSpeakerEnrollmentJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/StartSpeakerEnrollmentJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/StartSpeakerEnrollmentJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/StartSpeakerEnrollmentJob) 

# TagResource
<a name="API_connect-voice-id_TagResource"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Tags a Voice ID resource with the provided list of tags.

## Request Syntax
<a name="API_connect-voice-id_TagResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_connect-voice-id_TagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceArn](#API_connect-voice-id_TagResource_RequestSyntax) **   <a name="connect-connect-voice-id_TagResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the Voice ID resource you want to tag.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:aws(-[^:]+)?:voiceid.+:[0-9]{12}:domain/[a-zA-Z0-9]{22}`   
Required: Yes

 ** [Tags](#API_connect-voice-id_TagResource_RequestSyntax) **   <a name="connect-connect-voice-id_TagResource-request-Tags"></a>
The list of tags to assign to the specified resource.  
Type: Array of [Tag](API_connect-voice-id_Tag.md) objects  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Required: Yes

## Response Elements
<a name="API_connect-voice-id_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-voice-id_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** ConflictException **   
The request failed due to a conflict. Check the `ConflictType` and error message for more details.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/TagResource) 

# UntagResource
<a name="API_connect-voice-id_UntagResource"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Removes specified tags from a specified Amazon Connect Voice ID resource.

## Request Syntax
<a name="API_connect-voice-id_UntagResource_RequestSyntax"></a>

```
{
   "ResourceArn": "string",
   "TagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_connect-voice-id_UntagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceArn](#API_connect-voice-id_UntagResource_RequestSyntax) **   <a name="connect-connect-voice-id_UntagResource-request-ResourceArn"></a>
The Amazon Resource Name (ARN) of the Voice ID resource you want to remove tags from.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:aws(-[^:]+)?:voiceid.+:[0-9]{12}:domain/[a-zA-Z0-9]{22}`   
Required: Yes

 ** [TagKeys](#API_connect-voice-id_UntagResource_RequestSyntax) **   <a name="connect-connect-voice-id_UntagResource-request-TagKeys"></a>
The list of tag keys you want to remove from the specified resource.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 200 items.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`   
Required: Yes

## Response Elements
<a name="API_connect-voice-id_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_connect-voice-id_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** ConflictException **   
The request failed due to a conflict. Check the `ConflictType` and error message for more details.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/UntagResource) 

# UpdateDomain
<a name="API_connect-voice-id_UpdateDomain"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Updates the specified domain. This API has clobber behavior, and clears and replaces all attributes. If an optional field, such as 'Description' is not provided, it is removed from the domain.

## Request Syntax
<a name="API_connect-voice-id_UpdateDomain_RequestSyntax"></a>

```
{
   "Description": "string",
   "DomainId": "string",
   "Name": "string",
   "ServerSideEncryptionConfiguration": { 
      "KmsKeyId": "string"
   }
}
```

## Request Parameters
<a name="API_connect-voice-id_UpdateDomain_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Description](#API_connect-voice-id_UpdateDomain_RequestSyntax) **   <a name="connect-connect-voice-id_UpdateDomain-request-Description"></a>
A brief description about this domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)`   
Required: No

 ** [DomainId](#API_connect-voice-id_UpdateDomain_RequestSyntax) **   <a name="connect-connect-voice-id_UpdateDomain-request-DomainId"></a>
The identifier of the domain to be updated.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [Name](#API_connect-voice-id_UpdateDomain_RequestSyntax) **   <a name="connect-connect-voice-id_UpdateDomain-request-Name"></a>
The name of the domain.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: Yes

 ** [ServerSideEncryptionConfiguration](#API_connect-voice-id_UpdateDomain_RequestSyntax) **   <a name="connect-connect-voice-id_UpdateDomain-request-ServerSideEncryptionConfiguration"></a>
The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Changing the domain's associated KMS key immediately triggers an asynchronous process to remove dependency on the old KMS key, such that the domain's data can only be accessed using the new KMS key. The domain's `ServerSideEncryptionUpdateDetails` contains the details for this process.  
Type: [ServerSideEncryptionConfiguration](API_connect-voice-id_ServerSideEncryptionConfiguration.md) object  
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_UpdateDomain_ResponseSyntax"></a>

```
{
   "Domain": { 
      "Arn": "string",
      "CreatedAt": number,
      "Description": "string",
      "DomainId": "string",
      "DomainStatus": "string",
      "Name": "string",
      "ServerSideEncryptionConfiguration": { 
         "KmsKeyId": "string"
      },
      "ServerSideEncryptionUpdateDetails": { 
         "Message": "string",
         "OldKmsKeyId": "string",
         "UpdateStatus": "string"
      },
      "UpdatedAt": number,
      "WatchlistDetails": { 
         "DefaultWatchlistId": "string"
      }
   }
}
```

## Response Elements
<a name="API_connect-voice-id_UpdateDomain_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Domain](#API_connect-voice-id_UpdateDomain_ResponseSyntax) **   <a name="connect-connect-voice-id_UpdateDomain-response-Domain"></a>
Details about the updated domain  
Type: [Domain](API_connect-voice-id_Domain.md) object

## Errors
<a name="API_connect-voice-id_UpdateDomain_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** ConflictException **   
The request failed due to a conflict. Check the `ConflictType` and error message for more details.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_UpdateDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/UpdateDomain) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/UpdateDomain) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/UpdateDomain) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/UpdateDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/UpdateDomain) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/UpdateDomain) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/UpdateDomain) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/UpdateDomain) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/UpdateDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/UpdateDomain) 

# UpdateWatchlist
<a name="API_connect-voice-id_UpdateWatchlist"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Updates the specified watchlist. Every domain has a default watchlist which cannot be updated. 

## Request Syntax
<a name="API_connect-voice-id_UpdateWatchlist_RequestSyntax"></a>

```
{
   "Description": "string",
   "DomainId": "string",
   "Name": "string",
   "WatchlistId": "string"
}
```

## Request Parameters
<a name="API_connect-voice-id_UpdateWatchlist_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Description](#API_connect-voice-id_UpdateWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_UpdateWatchlist-request-Description"></a>
A brief description about this watchlist.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)`   
Required: No

 ** [DomainId](#API_connect-voice-id_UpdateWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_UpdateWatchlist-request-DomainId"></a>
The identifier of the domain that contains the watchlist.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

 ** [Name](#API_connect-voice-id_UpdateWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_UpdateWatchlist-request-Name"></a>
The name of the watchlist.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

 ** [WatchlistId](#API_connect-voice-id_UpdateWatchlist_RequestSyntax) **   <a name="connect-connect-voice-id_UpdateWatchlist-request-WatchlistId"></a>
The identifier of the watchlist to be updated.  
Type: String  
Length Constraints: Fixed length of 22.  
Pattern: `[a-zA-Z0-9]{22}`   
Required: Yes

## Response Syntax
<a name="API_connect-voice-id_UpdateWatchlist_ResponseSyntax"></a>

```
{
   "Watchlist": { 
      "CreatedAt": number,
      "DefaultWatchlist": boolean,
      "Description": "string",
      "DomainId": "string",
      "Name": "string",
      "UpdatedAt": number,
      "WatchlistId": "string"
   }
}
```

## Response Elements
<a name="API_connect-voice-id_UpdateWatchlist_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Watchlist](#API_connect-voice-id_UpdateWatchlist_ResponseSyntax) **   <a name="connect-connect-voice-id_UpdateWatchlist-response-Watchlist"></a>
Details about the updated watchlist.  
Type: [Watchlist](API_connect-voice-id_Watchlist.md) object

## Errors
<a name="API_connect-voice-id_UpdateWatchlist_Errors"></a>

For information about the errors that are common to all actions, see [Common Errors](CommonErrors.md).

 ** AccessDeniedException **   
You do not have sufficient permissions to perform this action. Check the error message and try again.  
HTTP Status Code: 400

 ** ConflictException **   
The request failed due to a conflict. Check the `ConflictType` and error message for more details.    
 ** ConflictType **   
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:  
+  `DOMAIN_NOT_ACTIVE`: The domain is not active.
+  `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the speaker ID after an enrollment has been requested.
+  `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for this session.
+  `SPEAKER_NOT_SET`: You must set the speaker ID before requesting an enrollment.
+  `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted out speaker.
+  `CONCURRENT_CHANGES`: The request could not be processed as the resource was modified by another request during execution.
HTTP Status Code: 400

 ** InternalServerException **   
The request failed due to an unknown error on the server side.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The specified resource cannot be found. Check the `ResourceType` and error message for more details.    
 ** ResourceType **   
The type of resource which cannot not be found. Possible types are `BATCH_JOB`, `COMPLIANCE_CONSENT`, `DOMAIN`, `FRAUDSTER`, `SESSION` and `SPEAKER`.
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please slow down your request rate. Refer to [ Amazon Connect Voice ID Service API throttling quotas ](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) and try your request again.  
HTTP Status Code: 400

 ** ValidationException **   
The request failed one or more validations; check the error message for more details.  
HTTP Status Code: 400

## See Also
<a name="API_connect-voice-id_UpdateWatchlist_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/voice-id-2021-09-27/UpdateWatchlist) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/voice-id-2021-09-27/UpdateWatchlist) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/voice-id-2021-09-27/UpdateWatchlist) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/voice-id-2021-09-27/UpdateWatchlist) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/voice-id-2021-09-27/UpdateWatchlist) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/voice-id-2021-09-27/UpdateWatchlist) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/voice-id-2021-09-27/UpdateWatchlist) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/voice-id-2021-09-27/UpdateWatchlist) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/voice-id-2021-09-27/UpdateWatchlist) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/voice-id-2021-09-27/UpdateWatchlist)