Amazon Connect Service 2017-08-08
- Client: Aws\Connect\ConnectClient
- Service ID: connect
- Version: 2017-08-08
This page describes the parameters and results for the operations of the Amazon Connect Service (2017-08-08), and shows how to use the Aws\Connect\ConnectClient object to call the described operations. This documentation is specific to the 2017-08-08 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- ActivateEvaluationForm ( array $params = [] )
- Activates an evaluation form in the specified Amazon Connect instance.
- AssociateAnalyticsDataSet ( array $params = [] )
- Associates the specified dataset for a Amazon Connect instance with the target account.
- AssociateApprovedOrigin ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- AssociateBot ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- AssociateDefaultVocabulary ( array $params = [] )
- Associates an existing vocabulary as the default.
- AssociateFlow ( array $params = [] )
- Associates a connect resource to a flow.
- AssociateInstanceStorageConfig ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- AssociateLambdaFunction ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- AssociateLexBot ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- AssociatePhoneNumberContactFlow ( array $params = [] )
- Associates a flow with a phone number claimed to your Amazon Connect instance.
- AssociateQueueQuickConnects ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- AssociateRoutingProfileQueues ( array $params = [] )
- Associates a set of queues with a routing profile.
- AssociateSecurityKey ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- AssociateTrafficDistributionGroupUser ( array $params = [] )
- Associates an agent with a traffic distribution group.
- AssociateUserProficiencies ( array $params = [] )
- >Associates a set of proficiencies with a user.
- BatchAssociateAnalyticsDataSet ( array $params = [] )
- Associates a list of analytics datasets for a given Amazon Connect instance to a target account.
- BatchDisassociateAnalyticsDataSet ( array $params = [] )
- Removes a list of analytics datasets associated with a given Amazon Connect instance.
- BatchGetAttachedFileMetadata ( array $params = [] )
- Allows you to retrieve metadata about multiple attached files on an associated resource.
- BatchGetFlowAssociation ( array $params = [] )
- Retrieve the flow associations for the given resources.
- BatchPutContact ( array $params = [] )
- Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API.
- ClaimPhoneNumber ( array $params = [] )
- Claims an available phone number to your Amazon Connect instance or traffic distribution group.
- CompleteAttachedFileUpload ( array $params = [] )
- Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
- CreateAgentStatus ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- CreateContact ( array $params = [] )
- Creates a new contact.
- CreateContactFlow ( array $params = [] )
- Creates a flow for the specified Amazon Connect instance.
- CreateContactFlowModule ( array $params = [] )
- Creates a flow module for the specified Amazon Connect instance.
- CreateContactFlowVersion ( array $params = [] )
- Publishes a new version of the flow provided.
- CreateEmailAddress ( array $params = [] )
- Create new email address in the specified Amazon Connect instance.
- CreateEvaluationForm ( array $params = [] )
- Creates an evaluation form in the specified Amazon Connect instance.
- CreateHoursOfOperation ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- CreateHoursOfOperationOverride ( array $params = [] )
- Creates an hours of operation override in an Amazon Connect hours of operation resource
- CreateInstance ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- CreateIntegrationAssociation ( array $params = [] )
- Creates an Amazon Web Services resource association with an Amazon Connect instance.
- CreateParticipant ( array $params = [] )
- Adds a new participant into an on-going chat contact.
- CreatePersistentContactAssociation ( array $params = [] )
- Enables rehydration of chats for the lifespan of a contact.
- CreatePredefinedAttribute ( array $params = [] )
- Creates a new predefined attribute for the specified Amazon Connect instance.
- CreatePrompt ( array $params = [] )
- Creates a prompt.
- CreatePushNotificationRegistration ( array $params = [] )
- Creates registration for a device token and a chat contact to receive real-time push notifications.
- CreateQueue ( array $params = [] )
- Creates a new queue for the specified Amazon Connect instance.
- CreateQuickConnect ( array $params = [] )
- Creates a quick connect for the specified Amazon Connect instance.
- CreateRoutingProfile ( array $params = [] )
- Creates a new routing profile.
- CreateRule ( array $params = [] )
- Creates a rule for the specified Amazon Connect instance.
- CreateSecurityProfile ( array $params = [] )
- Creates a security profile.
- CreateTaskTemplate ( array $params = [] )
- Creates a new task template in the specified Amazon Connect instance.
- CreateTrafficDistributionGroup ( array $params = [] )
- Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
- CreateUseCase ( array $params = [] )
- Creates a use case for an integration association.
- CreateUser ( array $params = [] )
- Creates a user account for the specified Amazon Connect instance.
- CreateUserHierarchyGroup ( array $params = [] )
- Creates a new user hierarchy group.
- CreateView ( array $params = [] )
- Creates a new view with the possible status of SAVED or PUBLISHED.
- CreateViewVersion ( array $params = [] )
- Publishes a new version of the view identifier.
- CreateVocabulary ( array $params = [] )
- Creates a custom vocabulary associated with your Amazon Connect instance.
- DeactivateEvaluationForm ( array $params = [] )
- Deactivates an evaluation form in the specified Amazon Connect instance.
- DeleteAttachedFile ( array $params = [] )
- Deletes an attached file along with the underlying S3 Object.
- DeleteContactEvaluation ( array $params = [] )
- Deletes a contact evaluation in the specified Amazon Connect instance.
- DeleteContactFlow ( array $params = [] )
- Deletes a flow for the specified Amazon Connect instance.
- DeleteContactFlowModule ( array $params = [] )
- Deletes the specified flow module.
- DeleteEmailAddress ( array $params = [] )
- Deletes email address from the specified Amazon Connect instance.
- DeleteEvaluationForm ( array $params = [] )
- Deletes an evaluation form in the specified Amazon Connect instance.
- DeleteHoursOfOperation ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- DeleteHoursOfOperationOverride ( array $params = [] )
- Deletes an hours of operation override in an Amazon Connect hours of operation resource
- DeleteInstance ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- DeleteIntegrationAssociation ( array $params = [] )
- Deletes an Amazon Web Services resource association from an Amazon Connect instance.
- DeletePredefinedAttribute ( array $params = [] )
- Deletes a predefined attribute from the specified Amazon Connect instance.
- DeletePrompt ( array $params = [] )
- Deletes a prompt.
- DeletePushNotificationRegistration ( array $params = [] )
- Deletes registration for a device token and a chat contact.
- DeleteQueue ( array $params = [] )
- Deletes a queue.
- DeleteQuickConnect ( array $params = [] )
- Deletes a quick connect.
- DeleteRoutingProfile ( array $params = [] )
- Deletes a routing profile.
- DeleteRule ( array $params = [] )
- Deletes a rule for the specified Amazon Connect instance.
- DeleteSecurityProfile ( array $params = [] )
- Deletes a security profile.
- DeleteTaskTemplate ( array $params = [] )
- Deletes the task template.
- DeleteTrafficDistributionGroup ( array $params = [] )
- Deletes a traffic distribution group.
- DeleteUseCase ( array $params = [] )
- Deletes a use case from an integration association.
- DeleteUser ( array $params = [] )
- Deletes a user account from the specified Amazon Connect instance.
- DeleteUserHierarchyGroup ( array $params = [] )
- Deletes an existing user hierarchy group.
- DeleteView ( array $params = [] )
- Deletes the view entirely.
- DeleteViewVersion ( array $params = [] )
- Deletes the particular version specified in ViewVersion identifier.
- DeleteVocabulary ( array $params = [] )
- Deletes the vocabulary that has the given identifier.
- DescribeAgentStatus ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- DescribeAuthenticationProfile ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- DescribeContact ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- DescribeContactEvaluation ( array $params = [] )
- Describes a contact evaluation in the specified Amazon Connect instance.
- DescribeContactFlow ( array $params = [] )
- Describes the specified flow.
- DescribeContactFlowModule ( array $params = [] )
- Describes the specified flow module.
- DescribeEmailAddress ( array $params = [] )
- Describe email address form the specified Amazon Connect instance.
- DescribeEvaluationForm ( array $params = [] )
- Describes an evaluation form in the specified Amazon Connect instance.
- DescribeHoursOfOperation ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- DescribeHoursOfOperationOverride ( array $params = [] )
- Describes the hours of operation override.
- DescribeInstance ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- DescribeInstanceAttribute ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- DescribeInstanceStorageConfig ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- DescribePhoneNumber ( array $params = [] )
- Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
- DescribePredefinedAttribute ( array $params = [] )
- Describes a predefined attribute for the specified Amazon Connect instance.
- DescribePrompt ( array $params = [] )
- Describes the prompt.
- DescribeQueue ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- DescribeQuickConnect ( array $params = [] )
- Describes the quick connect.
- DescribeRoutingProfile ( array $params = [] )
- Describes the specified routing profile.
- DescribeRule ( array $params = [] )
- Describes a rule for the specified Amazon Connect instance.
- DescribeSecurityProfile ( array $params = [] )
- Gets basic information about the security profile.
- DescribeTrafficDistributionGroup ( array $params = [] )
- Gets details and status of a traffic distribution group.
- DescribeUser ( array $params = [] )
- Describes the specified user.
- DescribeUserHierarchyGroup ( array $params = [] )
- Describes the specified hierarchy group.
- DescribeUserHierarchyStructure ( array $params = [] )
- Describes the hierarchy structure of the specified Amazon Connect instance.
- DescribeView ( array $params = [] )
- Retrieves the view for the specified Amazon Connect instance and view identifier.
- DescribeVocabulary ( array $params = [] )
- Describes the specified vocabulary.
- DisassociateAnalyticsDataSet ( array $params = [] )
- Removes the dataset ID associated with a given Amazon Connect instance.
- DisassociateApprovedOrigin ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- DisassociateBot ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- DisassociateFlow ( array $params = [] )
- Disassociates a connect resource from a flow.
- DisassociateInstanceStorageConfig ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- DisassociateLambdaFunction ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- DisassociateLexBot ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- DisassociatePhoneNumberContactFlow ( array $params = [] )
- Removes the flow association from a phone number claimed to your Amazon Connect instance.
- DisassociateQueueQuickConnects ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- DisassociateRoutingProfileQueues ( array $params = [] )
- Disassociates a set of queues from a routing profile.
- DisassociateSecurityKey ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- DisassociateTrafficDistributionGroupUser ( array $params = [] )
- Disassociates an agent from a traffic distribution group.
- DisassociateUserProficiencies ( array $params = [] )
- Disassociates a set of proficiencies from a user.
- DismissUserContact ( array $params = [] )
- 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.
- GetAttachedFile ( array $params = [] )
- Provides a pre-signed URL for download of an approved attached file.
- GetContactAttributes ( array $params = [] )
- Retrieves the contact attributes for the specified contact.
- GetCurrentMetricData ( array $params = [] )
- Gets the real-time metric data from the specified Amazon Connect instance.
- GetCurrentUserData ( array $params = [] )
- Gets the real-time active user data from the specified Amazon Connect instance.
- GetEffectiveHoursOfOperations ( array $params = [] )
- Get the hours of operations with the effective override applied.
- GetFederationToken ( array $params = [] )
- Supports SAML sign-in for Amazon Connect.
- GetFlowAssociation ( array $params = [] )
- Retrieves the flow associated for a given resource.
- GetMetricData ( array $params = [] )
- Gets historical metric data from the specified Amazon Connect instance.
- GetMetricDataV2 ( array $params = [] )
- Gets metric data from the specified Amazon Connect instance.
- GetPromptFile ( array $params = [] )
- Gets the prompt file.
- GetTaskTemplate ( array $params = [] )
- Gets details about a specific task template in the specified Amazon Connect instance.
- GetTrafficDistribution ( array $params = [] )
- Retrieves the current traffic distribution for a given traffic distribution group.
- ImportPhoneNumber ( array $params = [] )
- Imports a claimed phone number from an external service, such as Amazon Web Services End User Messaging, into an Amazon Connect instance.
- ListAgentStatuses ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- ListAnalyticsDataAssociations ( array $params = [] )
- Lists the association status of requested dataset ID for a given Amazon Connect instance.
- ListApprovedOrigins ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- ListAssociatedContacts ( array $params = [] )
- Provides information about contact tree, a list of associated contacts with a unique identifier.
- ListAuthenticationProfiles ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- ListBots ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- ListContactEvaluations ( array $params = [] )
- Lists contact evaluations in the specified Amazon Connect instance.
- ListContactFlowModules ( array $params = [] )
- Provides information about the flow modules for the specified Amazon Connect instance.
- ListContactFlowVersions ( array $params = [] )
- Returns all the available versions for the specified Amazon Connect instance and flow identifier.
- ListContactFlows ( array $params = [] )
- Provides information about the flows for the specified Amazon Connect instance.
- ListContactReferences ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- ListDefaultVocabularies ( array $params = [] )
- Lists the default vocabularies for the specified Amazon Connect instance.
- ListEvaluationFormVersions ( array $params = [] )
- Lists versions of an evaluation form in the specified Amazon Connect instance.
- ListEvaluationForms ( array $params = [] )
- Lists evaluation forms in the specified Amazon Connect instance.
- ListFlowAssociations ( array $params = [] )
- List the flow association based on the filters.
- ListHoursOfOperationOverrides ( array $params = [] )
- List the hours of operation overrides.
- ListHoursOfOperations ( array $params = [] )
- Provides information about the hours of operation for the specified Amazon Connect instance.
- ListInstanceAttributes ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- ListInstanceStorageConfigs ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- ListInstances ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- ListIntegrationAssociations ( array $params = [] )
- Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.
- ListLambdaFunctions ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- ListLexBots ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- ListPhoneNumbers ( array $params = [] )
- Provides information about the phone numbers for the specified Amazon Connect instance.
- ListPhoneNumbersV2 ( array $params = [] )
- Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group.
- ListPredefinedAttributes ( array $params = [] )
- Lists predefined attributes for the specified Amazon Connect instance.
- ListPrompts ( array $params = [] )
- Provides information about the prompts for the specified Amazon Connect instance.
- ListQueueQuickConnects ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- ListQueues ( array $params = [] )
- Provides information about the queues for the specified Amazon Connect instance.
- ListQuickConnects ( array $params = [] )
- Provides information about the quick connects for the specified Amazon Connect instance.
- ListRealtimeContactAnalysisSegmentsV2 ( array $params = [] )
- Provides a list of analysis segments for a real-time analysis session.
- ListRoutingProfileQueues ( array $params = [] )
- Lists the queues associated with a routing profile.
- ListRoutingProfiles ( array $params = [] )
- Provides summary information about the routing profiles for the specified Amazon Connect instance.
- ListRules ( array $params = [] )
- List all rules for the specified Amazon Connect instance.
- ListSecurityKeys ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- ListSecurityProfileApplications ( array $params = [] )
- Returns a list of third-party applications in a specific security profile.
- ListSecurityProfilePermissions ( array $params = [] )
- Lists the permissions granted to a security profile.
- ListSecurityProfiles ( array $params = [] )
- Provides summary information about the security profiles for the specified Amazon Connect instance.
- ListTagsForResource ( array $params = [] )
- Lists the tags for the specified resource.
- ListTaskTemplates ( array $params = [] )
- Lists task templates for the specified Amazon Connect instance.
- ListTrafficDistributionGroupUsers ( array $params = [] )
- Lists traffic distribution group users.
- ListTrafficDistributionGroups ( array $params = [] )
- Lists traffic distribution groups.
- ListUseCases ( array $params = [] )
- Lists the use cases for the integration association.
- ListUserHierarchyGroups ( array $params = [] )
- Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
- ListUserProficiencies ( array $params = [] )
- Lists proficiencies associated with a user.
- ListUsers ( array $params = [] )
- Provides summary information about the users for the specified Amazon Connect instance.
- ListViewVersions ( array $params = [] )
- Returns all the available versions for the specified Amazon Connect instance and view identifier.
- ListViews ( array $params = [] )
- Returns views in the given instance.
- MonitorContact ( array $params = [] )
- Initiates silent monitoring of a contact.
- PauseContact ( array $params = [] )
- Allows pausing an ongoing task contact.
- PutUserStatus ( array $params = [] )
- Changes the current status of a user or agent in Amazon Connect.
- ReleasePhoneNumber ( array $params = [] )
- Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group.
- ReplicateInstance ( array $params = [] )
- Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions.
- ResumeContact ( array $params = [] )
- Allows resuming a task contact in a paused state.
- ResumeContactRecording ( array $params = [] )
- 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.
- SearchAgentStatuses ( array $params = [] )
- Searches AgentStatuses in an Amazon Connect instance, with optional filtering.
- SearchAvailablePhoneNumbers ( array $params = [] )
- Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.
- SearchContactFlowModules ( array $params = [] )
- Searches the flow modules in an Amazon Connect instance, with optional filtering.
- SearchContactFlows ( array $params = [] )
- Searches the flows in an Amazon Connect instance, with optional filtering.
- SearchContacts ( array $params = [] )
- Searches contacts in an Amazon Connect instance.
- SearchEmailAddresses ( array $params = [] )
- Searches email address in an instance, with optional filtering.
- SearchHoursOfOperationOverrides ( array $params = [] )
- Searches the hours of operation overrides.
- SearchHoursOfOperations ( array $params = [] )
- Searches the hours of operation in an Amazon Connect instance, with optional filtering.
- SearchPredefinedAttributes ( array $params = [] )
- Searches predefined attributes that meet certain criteria.
- SearchPrompts ( array $params = [] )
- Searches prompts in an Amazon Connect instance, with optional filtering.
- SearchQueues ( array $params = [] )
- Searches queues in an Amazon Connect instance, with optional filtering.
- SearchQuickConnects ( array $params = [] )
- Searches quick connects in an Amazon Connect instance, with optional filtering.
- SearchResourceTags ( array $params = [] )
- Searches tags used in an Amazon Connect instance using optional search criteria.
- SearchRoutingProfiles ( array $params = [] )
- Searches routing profiles in an Amazon Connect instance, with optional filtering.
- SearchSecurityProfiles ( array $params = [] )
- Searches security profiles in an Amazon Connect instance, with optional filtering.
- SearchUserHierarchyGroups ( array $params = [] )
- Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering.
- SearchUsers ( array $params = [] )
- Searches users in an Amazon Connect instance, with optional filtering.
- SearchVocabularies ( array $params = [] )
- Searches for vocabularies within a specific Amazon Connect instance using State, NameStartsWith, and LanguageCode.
- SendChatIntegrationEvent ( array $params = [] )
- Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect.
- SendOutboundEmail ( array $params = [] )
- Send outbound email for outbound campaigns.
- StartAttachedFileUpload ( array $params = [] )
- Provides a pre-signed Amazon S3 URL in response for uploading your content.
- StartChatContact ( array $params = [] )
- Initiates a flow to start a new chat for the customer.
- StartContactEvaluation ( array $params = [] )
- Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact.
- StartContactRecording ( array $params = [] )
- Starts recording the contact: If the API is called before the agent joins the call, recording starts when the agent joins the call.
- StartContactStreaming ( array $params = [] )
- Initiates real-time message streaming for a new chat contact.
- StartEmailContact ( array $params = [] )
- Creates an inbound email contact and initiates a flow to start the email contact for the customer.
- StartOutboundChatContact ( array $params = [] )
- Initiates a new outbound SMS contact to a customer.
- StartOutboundEmailContact ( array $params = [] )
- Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer.
- StartOutboundVoiceContact ( array $params = [] )
- Places an outbound call to a contact, and then initiates the flow.
- StartScreenSharing ( array $params = [] )
- Starts screen sharing for a contact.
- StartTaskContact ( array $params = [] )
- Initiates a flow to start a new task contact.
- StartWebRTCContact ( array $params = [] )
- Places an inbound in-app, web, or video call to a contact, and then initiates the flow.
- StopContact ( array $params = [] )
- Ends the specified contact.
- StopContactRecording ( array $params = [] )
- Stops recording a call when a contact is being recorded.
- StopContactStreaming ( array $params = [] )
- Ends message streaming on a specified contact.
- SubmitContactEvaluation ( array $params = [] )
- Submits a contact evaluation in the specified Amazon Connect instance.
- SuspendContactRecording ( array $params = [] )
- When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both.
- TagContact ( array $params = [] )
- Adds the specified tags to the contact resource.
- TagResource ( array $params = [] )
- Adds the specified tags to the specified resource.
- TransferContact ( array $params = [] )
- Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created.
- UntagContact ( array $params = [] )
- Removes the specified tags from the contact resource.
- UntagResource ( array $params = [] )
- Removes the specified tags from the specified resource.
- UpdateAgentStatus ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- UpdateAuthenticationProfile ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- UpdateContact ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- UpdateContactAttributes ( array $params = [] )
- Creates or updates user-defined contact attributes associated with the specified contact.
- UpdateContactEvaluation ( array $params = [] )
- Updates details about a contact evaluation in the specified Amazon Connect instance.
- UpdateContactFlowContent ( array $params = [] )
- Updates the specified flow.
- UpdateContactFlowMetadata ( array $params = [] )
- Updates metadata about specified flow.
- UpdateContactFlowModuleContent ( array $params = [] )
- Updates specified flow module for the specified Amazon Connect instance.
- UpdateContactFlowModuleMetadata ( array $params = [] )
- Updates metadata about specified flow module.
- UpdateContactFlowName ( array $params = [] )
- The name of the flow.
- UpdateContactRoutingData ( array $params = [] )
- Updates routing priority and age on the contact (QueuePriority and QueueTimeAdjustmentInSeconds).
- UpdateContactSchedule ( array $params = [] )
- Updates the scheduled time of a task contact that is already scheduled.
- UpdateEmailAddressMetadata ( array $params = [] )
- Updates an email address metadata.
- UpdateEvaluationForm ( array $params = [] )
- Updates details about a specific evaluation form version in the specified Amazon Connect instance.
- UpdateHoursOfOperation ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- UpdateHoursOfOperationOverride ( array $params = [] )
- Update the hours of operation override.
- UpdateInstanceAttribute ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- UpdateInstanceStorageConfig ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- UpdateParticipantRoleConfig ( array $params = [] )
- Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness.
- UpdatePhoneNumber ( array $params = [] )
- 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 Amazon Web Services Region.
- UpdatePhoneNumberMetadata ( array $params = [] )
- Updates a phone number’s metadata.
- UpdatePredefinedAttribute ( array $params = [] )
- Updates a predefined attribute for the specified Amazon Connect instance.
- UpdatePrompt ( array $params = [] )
- Updates a prompt.
- UpdateQueueHoursOfOperation ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- UpdateQueueMaxContacts ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- UpdateQueueName ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- UpdateQueueOutboundCallerConfig ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- UpdateQueueOutboundEmailConfig ( array $params = [] )
- Updates the outbound email address Id for a specified queue.
- UpdateQueueStatus ( array $params = [] )
- This API is in preview release for Amazon Connect and is subject to change.
- UpdateQuickConnectConfig ( array $params = [] )
- Updates the configuration settings for the specified quick connect.
- UpdateQuickConnectName ( array $params = [] )
- Updates the name and description of a quick connect.
- UpdateRoutingProfileAgentAvailabilityTimer ( array $params = [] )
- Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.
- UpdateRoutingProfileConcurrency ( array $params = [] )
- Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
- UpdateRoutingProfileDefaultOutboundQueue ( array $params = [] )
- Updates the default outbound queue of a routing profile.
- UpdateRoutingProfileName ( array $params = [] )
- Updates the name and description of a routing profile.
- UpdateRoutingProfileQueues ( array $params = [] )
- Updates the properties associated with a set of queues for a routing profile.
- UpdateRule ( array $params = [] )
- Updates a rule for the specified Amazon Connect instance.
- UpdateSecurityProfile ( array $params = [] )
- Updates a security profile.
- UpdateTaskTemplate ( array $params = [] )
- Updates details about a specific task template in the specified Amazon Connect instance.
- UpdateTrafficDistribution ( array $params = [] )
- Updates the traffic distribution for a given traffic distribution group.
- UpdateUserHierarchy ( array $params = [] )
- Assigns the specified hierarchy group to the specified user.
- UpdateUserHierarchyGroupName ( array $params = [] )
- Updates the name of the user hierarchy group.
- UpdateUserHierarchyStructure ( array $params = [] )
- Updates the user hierarchy structure: add, remove, and rename user hierarchy levels.
- UpdateUserIdentityInfo ( array $params = [] )
- Updates the identity information for the specified user.
- UpdateUserPhoneConfig ( array $params = [] )
- Updates the phone configuration settings for the specified user.
- UpdateUserProficiencies ( array $params = [] )
- Updates the properties associated with the proficiencies of a user.
- UpdateUserRoutingProfile ( array $params = [] )
- Assigns the specified routing profile to the specified user.
- UpdateUserSecurityProfiles ( array $params = [] )
- Assigns the specified security profiles to the specified user.
- UpdateViewContent ( array $params = [] )
- Updates the view content of the given view identifier in the specified Amazon Connect instance.
- UpdateViewMetadata ( array $params = [] )
- Updates the view metadata.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- GetCurrentMetricData
- GetCurrentUserData
- GetMetricData
- GetMetricDataV2
- ListAgentStatuses
- ListApprovedOrigins
- ListAuthenticationProfiles
- ListBots
- ListContactEvaluations
- ListContactFlowModules
- ListContactFlowVersions
- ListContactFlows
- ListContactReferences
- ListDefaultVocabularies
- ListEvaluationFormVersions
- ListEvaluationForms
- ListFlowAssociations
- ListHoursOfOperationOverrides
- ListHoursOfOperations
- ListInstanceAttributes
- ListInstanceStorageConfigs
- ListInstances
- ListIntegrationAssociations
- ListLambdaFunctions
- ListLexBots
- ListPhoneNumbers
- ListPhoneNumbersV2
- ListPredefinedAttributes
- ListPrompts
- ListQueueQuickConnects
- ListQueues
- ListQuickConnects
- ListRealtimeContactAnalysisSegmentsV2
- ListRoutingProfileQueues
- ListRoutingProfiles
- ListRules
- ListSecurityKeys
- ListSecurityProfileApplications
- ListSecurityProfilePermissions
- ListSecurityProfiles
- ListTaskTemplates
- ListTrafficDistributionGroupUsers
- ListTrafficDistributionGroups
- ListUseCases
- ListUserHierarchyGroups
- ListUserProficiencies
- ListUsers
- ListViewVersions
- ListViews
- SearchAgentStatuses
- SearchAvailablePhoneNumbers
- SearchContactFlowModules
- SearchContactFlows
- SearchContacts
- SearchHoursOfOperationOverrides
- SearchHoursOfOperations
- SearchPredefinedAttributes
- SearchPrompts
- SearchQueues
- SearchQuickConnects
- SearchResourceTags
- SearchRoutingProfiles
- SearchSecurityProfiles
- SearchUserHierarchyGroups
- SearchUsers
- SearchVocabularies
Operations
ActivateEvaluationForm
$result = $client->activateEvaluationForm
([/* ... */]); $promise = $client->activateEvaluationFormAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->activateEvaluationForm([ 'EvaluationFormId' => '<string>', // REQUIRED 'EvaluationFormVersion' => <integer>, // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- EvaluationFormId
-
- Required: Yes
- Type: string
The unique identifier for the evaluation form.
- EvaluationFormVersion
-
- Required: Yes
- Type: int
The version of the evaluation form to activate. If the version property is not provided, the latest version of the evaluation form is activated.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[ 'EvaluationFormArn' => '<string>', 'EvaluationFormId' => '<string>', 'EvaluationFormVersion' => <integer>, ]
Result Details
Members
- EvaluationFormArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the evaluation form resource.
- EvaluationFormId
-
- Required: Yes
- Type: string
The unique identifier for the evaluation form.
- EvaluationFormVersion
-
- Required: Yes
- Type: int
A version of the evaluation form.
Errors
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ResourceConflictException:
A resource already has that name.
AssociateAnalyticsDataSet
$result = $client->associateAnalyticsDataSet
([/* ... */]); $promise = $client->associateAnalyticsDataSetAsync
([/* ... */]);
Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call.
Parameter Syntax
$result = $client->associateAnalyticsDataSet([ 'DataSetId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'TargetAccountId' => '<string>', ]);
Parameter Details
Members
- DataSetId
-
- Required: Yes
- Type: string
The identifier of the dataset to associate with the target account.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- TargetAccountId
-
- Type: string
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 Amazon Web Services account that has the Amazon Connect instance.
Result Syntax
[ 'DataSetId' => '<string>', 'ResourceShareArn' => '<string>', 'ResourceShareId' => '<string>', 'TargetAccountId' => '<string>', ]
Result Details
Members
- DataSetId
-
- Type: string
The identifier of the dataset that was associated.
- ResourceShareArn
-
- Type: string
The Amazon Resource Name (ARN) of the Resource Access Manager share.
- ResourceShareId
-
- Type: string
The Resource Access Manager share ID that is generated.
- TargetAccountId
-
- Type: string
The identifier of the target account.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
AssociateApprovedOrigin
$result = $client->associateApprovedOrigin
([/* ... */]); $promise = $client->associateApprovedOriginAsync
([/* ... */]);
This API is in preview release for Amazon Connect and is subject to change.
Associates an approved origin to an Amazon Connect instance.
Parameter Syntax
$result = $client->associateApprovedOrigin([ 'InstanceId' => '<string>', // REQUIRED 'Origin' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Origin
-
- Required: Yes
- Type: string
The domain to add to your allow list.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource was not found.
- ResourceConflictException:
A resource already has that name.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ServiceQuotaExceededException:
The service quota has been exceeded.
- ThrottlingException:
The throttling limit has been exceeded.
AssociateBot
$result = $client->associateBot
([/* ... */]); $promise = $client->associateBotAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->associateBot([ 'InstanceId' => '<string>', // REQUIRED 'LexBot' => [ 'LexRegion' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED ], 'LexV2Bot' => [ 'AliasArn' => '<string>', ], ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- LexBot
-
- Type: LexBot structure
Configuration information of an Amazon Lex bot.
- LexV2Bot
-
- Type: LexV2Bot structure
The Amazon Lex V2 bot to associate with the instance.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource was not found.
- ResourceConflictException:
A resource already has that name.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- LimitExceededException:
The allowed limit for the resource has been exceeded.
- ServiceQuotaExceededException:
The service quota has been exceeded.
- ThrottlingException:
The throttling limit has been exceeded.
AssociateDefaultVocabulary
$result = $client->associateDefaultVocabulary
([/* ... */]); $promise = $client->associateDefaultVocabularyAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->associateDefaultVocabulary([ 'InstanceId' => '<string>', // REQUIRED 'LanguageCode' => '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 'VocabularyId' => '<string>', ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- LanguageCode
-
- Required: Yes
- Type: string
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
- VocabularyId
-
- Type: string
The identifier of the custom vocabulary. If this is empty, the default is set to none.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ThrottlingException:
The throttling limit has been exceeded.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
AssociateFlow
$result = $client->associateFlow
([/* ... */]); $promise = $client->associateFlowAsync
([/* ... */]);
Associates a connect resource to a flow.
Parameter Syntax
$result = $client->associateFlow([ 'FlowId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'ResourceId' => '<string>', // REQUIRED 'ResourceType' => 'SMS_PHONE_NUMBER|INBOUND_EMAIL|OUTBOUND_EMAIL|ANALYTICS_CONNECTOR|WHATSAPP_MESSAGING_PHONE_NUMBER', // REQUIRED ]);
Parameter Details
Members
- FlowId
-
- Required: Yes
- Type: string
The identifier of the flow.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- ResourceId
-
- Required: Yes
- Type: string
The identifier of the resource.
-
Amazon Web Services End User Messaging SMS phone number ARN when using
SMS_PHONE_NUMBER
-
Amazon Web Services End User Messaging Social phone number ARN when using
WHATSAPP_MESSAGING_PHONE_NUMBER
- ResourceType
-
- Required: Yes
- Type: string
A valid resource type.
Result Syntax
[]
Result Details
Errors
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ThrottlingException:
The throttling limit has been exceeded.
AssociateInstanceStorageConfig
$result = $client->associateInstanceStorageConfig
([/* ... */]); $promise = $client->associateInstanceStorageConfigAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->associateInstanceStorageConfig([ 'InstanceId' => '<string>', // REQUIRED 'ResourceType' => '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 'StorageConfig' => [ // REQUIRED 'AssociationId' => '<string>', 'KinesisFirehoseConfig' => [ 'FirehoseArn' => '<string>', // REQUIRED ], 'KinesisStreamConfig' => [ 'StreamArn' => '<string>', // REQUIRED ], 'KinesisVideoStreamConfig' => [ 'EncryptionConfig' => [ // REQUIRED 'EncryptionType' => 'KMS', // REQUIRED 'KeyId' => '<string>', // REQUIRED ], 'Prefix' => '<string>', // REQUIRED 'RetentionPeriodHours' => <integer>, // REQUIRED ], 'S3Config' => [ 'BucketName' => '<string>', // REQUIRED 'BucketPrefix' => '<string>', // REQUIRED 'EncryptionConfig' => [ 'EncryptionType' => 'KMS', // REQUIRED 'KeyId' => '<string>', // REQUIRED ], ], 'StorageType' => 'S3|KINESIS_VIDEO_STREAM|KINESIS_STREAM|KINESIS_FIREHOSE', // REQUIRED ], ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- ResourceType
-
- Required: Yes
- Type: string
A valid resource type. To enable streaming for real-time analysis of contacts, 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. UseREAL_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 toREAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS
. - StorageConfig
-
- Required: Yes
- Type: InstanceStorageConfig structure
A valid storage type.
Result Syntax
[ 'AssociationId' => '<string>', ]
Result Details
Members
- AssociationId
-
- Type: string
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
Errors
- ResourceNotFoundException:
The specified resource was not found.
- ResourceConflictException:
A resource already has that name.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ThrottlingException:
The throttling limit has been exceeded.
AssociateLambdaFunction
$result = $client->associateLambdaFunction
([/* ... */]); $promise = $client->associateLambdaFunctionAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->associateLambdaFunction([ 'FunctionArn' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- FunctionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource was not found.
- ResourceConflictException:
A resource already has that name.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ServiceQuotaExceededException:
The service quota has been exceeded.
- ThrottlingException:
The throttling limit has been exceeded.
AssociateLexBot
$result = $client->associateLexBot
([/* ... */]); $promise = $client->associateLexBotAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->associateLexBot([ 'InstanceId' => '<string>', // REQUIRED 'LexBot' => [ // REQUIRED 'LexRegion' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED ], ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- LexBot
-
- Required: Yes
- Type: LexBot structure
The Amazon Lex bot to associate with the instance.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource was not found.
- ResourceConflictException:
A resource already has that name.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ServiceQuotaExceededException:
The service quota has been exceeded.
- ThrottlingException:
The throttling limit has been exceeded.
AssociatePhoneNumberContactFlow
$result = $client->associatePhoneNumberContactFlow
([/* ... */]); $promise = $client->associatePhoneNumberContactFlowAsync
([/* ... */]);
Associates a flow with a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the 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 Amazon Web Services 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
.
Parameter Syntax
$result = $client->associatePhoneNumberContactFlow([ 'ContactFlowId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'PhoneNumberId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ContactFlowId
-
- Required: Yes
- Type: string
The identifier of the flow.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- PhoneNumberId
-
- Required: Yes
- Type: string
A unique identifier for the phone number.
Result Syntax
[]
Result Details
Errors
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
AssociateQueueQuickConnects
$result = $client->associateQueueQuickConnects
([/* ... */]); $promise = $client->associateQueueQuickConnectsAsync
([/* ... */]);
This API is in preview release for Amazon Connect and is subject to change.
Associates a set of quick connects with a queue.
Parameter Syntax
$result = $client->associateQueueQuickConnects([ 'InstanceId' => '<string>', // REQUIRED 'QueueId' => '<string>', // REQUIRED 'QuickConnectIds' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- QueueId
-
- Required: Yes
- Type: string
The identifier for the queue.
- QuickConnectIds
-
- Required: Yes
- Type: Array of strings
The quick connects to associate with this queue.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- LimitExceededException:
The allowed limit for the resource has been exceeded.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
AssociateRoutingProfileQueues
$result = $client->associateRoutingProfileQueues
([/* ... */]); $promise = $client->associateRoutingProfileQueuesAsync
([/* ... */]);
Associates a set of queues with a routing profile.
Parameter Syntax
$result = $client->associateRoutingProfileQueues([ 'InstanceId' => '<string>', // REQUIRED 'QueueConfigs' => [ // REQUIRED [ 'Delay' => <integer>, // REQUIRED 'Priority' => <integer>, // REQUIRED 'QueueReference' => [ // REQUIRED 'Channel' => 'VOICE|CHAT|TASK|EMAIL', // REQUIRED 'QueueId' => '<string>', // REQUIRED ], ], // ... ], 'RoutingProfileId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- QueueConfigs
-
- Required: Yes
- Type: Array of RoutingProfileQueueConfig structures
The queues to associate with this routing profile.
- RoutingProfileId
-
- Required: Yes
- Type: string
The identifier of the routing profile.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
AssociateSecurityKey
$result = $client->associateSecurityKey
([/* ... */]); $promise = $client->associateSecurityKeyAsync
([/* ... */]);
This API is in preview release for Amazon Connect and is subject to change.
Associates a security key to the instance.
Parameter Syntax
$result = $client->associateSecurityKey([ 'InstanceId' => '<string>', // REQUIRED 'Key' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Key
-
- Required: Yes
- Type: string
A valid security key in PEM format as a String.
Result Syntax
[ 'AssociationId' => '<string>', ]
Result Details
Members
- AssociationId
-
- Type: string
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
Errors
- ResourceNotFoundException:
The specified resource was not found.
- ResourceConflictException:
A resource already has that name.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ServiceQuotaExceededException:
The service quota has been exceeded.
- ThrottlingException:
The throttling limit has been exceeded.
AssociateTrafficDistributionGroupUser
$result = $client->associateTrafficDistributionGroupUser
([/* ... */]); $promise = $client->associateTrafficDistributionGroupUserAsync
([/* ... */]);
Associates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
Parameter Syntax
$result = $client->associateTrafficDistributionGroupUser([ 'InstanceId' => '<string>', // REQUIRED 'TrafficDistributionGroupId' => '<string>', // REQUIRED 'UserId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- TrafficDistributionGroupId
-
- Required: Yes
- Type: string
The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.
- UserId
-
- Required: Yes
- Type: string
The identifier of the user account. This can be the ID or the ARN of the user.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- ThrottlingException:
The throttling limit has been exceeded.
- ResourceNotFoundException:
The specified resource was not found.
- ResourceConflictException:
A resource already has that name.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
AssociateUserProficiencies
$result = $client->associateUserProficiencies
([/* ... */]); $promise = $client->associateUserProficienciesAsync
([/* ... */]);
>Associates a set of proficiencies with a user.
Parameter Syntax
$result = $client->associateUserProficiencies([ 'InstanceId' => '<string>', // REQUIRED 'UserId' => '<string>', // REQUIRED 'UserProficiencies' => [ // REQUIRED [ 'AttributeName' => '<string>', // REQUIRED 'AttributeValue' => '<string>', // REQUIRED 'Level' => <float>, // REQUIRED ], // ... ], ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN of the instance).
- UserId
-
- Required: Yes
- Type: string
The identifier of the user account.
- UserProficiencies
-
- Required: Yes
- Type: Array of UserProficiency structures
The proficiencies to associate with the user.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
BatchAssociateAnalyticsDataSet
$result = $client->batchAssociateAnalyticsDataSet
([/* ... */]); $promise = $client->batchAssociateAnalyticsDataSetAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->batchAssociateAnalyticsDataSet([ 'DataSetIds' => ['<string>', ...], // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'TargetAccountId' => '<string>', ]);
Parameter Details
Members
- DataSetIds
-
- Required: Yes
- Type: Array of strings
An array of dataset identifiers to associate.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- TargetAccountId
-
- Type: string
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 Amazon Web Services account that has the Amazon Connect instance.
Result Syntax
[ 'Created' => [ [ 'DataSetId' => '<string>', 'ResourceShareArn' => '<string>', 'ResourceShareId' => '<string>', 'TargetAccountId' => '<string>', ], // ... ], 'Errors' => [ [ 'ErrorCode' => '<string>', 'ErrorMessage' => '<string>', ], // ... ], ]
Result Details
Members
- Created
-
- Type: Array of AnalyticsDataAssociationResult structures
Information about associations that are successfully created:
DataSetId
,TargetAccountId
,ResourceShareId
,ResourceShareArn
. - Errors
-
- Type: Array of ErrorResult structures
A list of errors for datasets that aren't successfully associated with the target account.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
BatchDisassociateAnalyticsDataSet
$result = $client->batchDisassociateAnalyticsDataSet
([/* ... */]); $promise = $client->batchDisassociateAnalyticsDataSetAsync
([/* ... */]);
Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
Parameter Syntax
$result = $client->batchDisassociateAnalyticsDataSet([ 'DataSetIds' => ['<string>', ...], // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'TargetAccountId' => '<string>', ]);
Parameter Details
Members
- DataSetIds
-
- Required: Yes
- Type: Array of strings
An array of associated dataset identifiers to remove.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- TargetAccountId
-
- Type: string
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 Amazon Web Services account that has the Amazon Connect instance.
Result Syntax
[ 'Deleted' => ['<string>', ...], 'Errors' => [ [ 'ErrorCode' => '<string>', 'ErrorMessage' => '<string>', ], // ... ], ]
Result Details
Members
- Deleted
-
- Type: Array of strings
An array of successfully disassociated dataset identifiers.
- Errors
-
- Type: Array of ErrorResult structures
A list of errors for any datasets not successfully removed.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
BatchGetAttachedFileMetadata
$result = $client->batchGetAttachedFileMetadata
([/* ... */]); $promise = $client->batchGetAttachedFileMetadataAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->batchGetAttachedFileMetadata([ 'AssociatedResourceArn' => '<string>', // REQUIRED 'FileIds' => ['<string>', ...], // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AssociatedResourceArn
-
- Required: Yes
- Type: string
- FileIds
-
- Required: Yes
- Type: Array of strings
The unique identifiers of the attached file resource.
- InstanceId
-
- Required: Yes
- Type: string
The unique identifier of the Connect instance.
Result Syntax
[ 'Errors' => [ [ 'ErrorCode' => '<string>', 'ErrorMessage' => '<string>', 'FileId' => '<string>', ], // ... ], 'Files' => [ [ 'AssociatedResourceArn' => '<string>', 'CreatedBy' => [ 'AWSIdentityArn' => '<string>', 'ConnectUserArn' => '<string>', ], 'CreationTime' => '<string>', 'FileArn' => '<string>', 'FileId' => '<string>', 'FileName' => '<string>', 'FileSizeInBytes' => <integer>, 'FileStatus' => 'APPROVED|REJECTED|PROCESSING|FAILED', 'FileUseCaseType' => 'EMAIL_MESSAGE|ATTACHMENT', 'Tags' => ['<string>', ...], ], // ... ], ]
Result Details
Members
- Errors
-
- Type: Array of AttachedFileError structures
List of errors of attached files that could not be retrieved.
- Files
-
- Type: Array of AttachedFile structures
List of attached files that were successfully retrieved.
Errors
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- InvalidRequestException:
The request is not valid.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
BatchGetFlowAssociation
$result = $client->batchGetFlowAssociation
([/* ... */]); $promise = $client->batchGetFlowAssociationAsync
([/* ... */]);
Retrieve the flow associations for the given resources.
Parameter Syntax
$result = $client->batchGetFlowAssociation([ 'InstanceId' => '<string>', // REQUIRED 'ResourceIds' => ['<string>', ...], // REQUIRED 'ResourceType' => 'WHATSAPP_MESSAGING_PHONE_NUMBER|VOICE_PHONE_NUMBER|INBOUND_EMAIL|OUTBOUND_EMAIL|ANALYTICS_CONNECTOR', ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- ResourceIds
-
- Required: Yes
- Type: Array of strings
A list of resource identifiers to retrieve flow associations.
-
Amazon Web Services End User Messaging SMS phone number ARN when using
SMS_PHONE_NUMBER
-
Amazon Web Services End User Messaging Social phone number ARN when using
WHATSAPP_MESSAGING_PHONE_NUMBER
- ResourceType
-
- Type: string
The type of resource association.
Result Syntax
[ 'FlowAssociationSummaryList' => [ [ 'FlowId' => '<string>', 'ResourceId' => '<string>', 'ResourceType' => 'WHATSAPP_MESSAGING_PHONE_NUMBER|VOICE_PHONE_NUMBER|INBOUND_EMAIL|OUTBOUND_EMAIL|ANALYTICS_CONNECTOR', ], // ... ], ]
Result Details
Members
- FlowAssociationSummaryList
-
- Type: Array of FlowAssociationSummary structures
Information about flow associations.
Errors
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ThrottlingException:
The throttling limit has been exceeded.
BatchPutContact
$result = $client->batchPutContact
([/* ... */]); $promise = $client->batchPutContactAsync
([/* ... */]);
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 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.
Parameter Syntax
$result = $client->batchPutContact([ 'ClientToken' => '<string>', 'ContactDataRequestList' => [ // REQUIRED [ 'Attributes' => ['<string>', ...], 'Campaign' => [ 'CampaignId' => '<string>', ], 'CustomerEndpoint' => [ 'Address' => '<string>', 'Type' => 'TELEPHONE_NUMBER|VOIP|CONTACT_FLOW|CONNECT_PHONENUMBER_ARN|EMAIL_ADDRESS', ], 'QueueId' => '<string>', 'RequestIdentifier' => '<string>', 'SystemEndpoint' => [ 'Address' => '<string>', 'Type' => 'TELEPHONE_NUMBER|VOIP|CONTACT_FLOW|CONNECT_PHONENUMBER_ARN|EMAIL_ADDRESS', ], ], // ... ], 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ClientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
- ContactDataRequestList
-
- Required: Yes
- Type: Array of ContactDataRequest structures
List of individual contact requests.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[ 'FailedRequestList' => [ [ 'FailureReasonCode' => 'INVALID_ATTRIBUTE_KEY|INVALID_CUSTOMER_ENDPOINT|INVALID_SYSTEM_ENDPOINT|INVALID_QUEUE|MISSING_CAMPAIGN|MISSING_CUSTOMER_ENDPOINT|MISSING_QUEUE_ID_AND_SYSTEM_ENDPOINT|REQUEST_THROTTLED|IDEMPOTENCY_EXCEPTION|INTERNAL_ERROR', 'FailureReasonMessage' => '<string>', 'RequestIdentifier' => '<string>', ], // ... ], 'SuccessfulRequestList' => [ [ 'ContactId' => '<string>', 'RequestIdentifier' => '<string>', ], // ... ], ]
Result Details
Members
- FailedRequestList
-
- Type: Array of FailedRequest structures
List of requests for which contact creation failed.
- SuccessfulRequestList
-
- Type: Array of SuccessfulRequest structures
List of requests for which contact was successfully created.
Errors
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- ResourceNotFoundException:
The specified resource was not found.
- LimitExceededException:
The allowed limit for the resource has been exceeded.
- IdempotencyException:
An entity with the same name already exists.
ClaimPhoneNumber
$result = $client->claimPhoneNumber
([/* ... */]); $promise = $client->claimPhoneNumberAsync
([/* ... */]);
Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services 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 and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.
You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber 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 Amazon Web Services support ticket.
Parameter Syntax
$result = $client->claimPhoneNumber([ 'ClientToken' => '<string>', 'InstanceId' => '<string>', 'PhoneNumber' => '<string>', // REQUIRED 'PhoneNumberDescription' => '<string>', 'Tags' => ['<string>', ...], 'TargetArn' => '<string>', ]);
Parameter Details
Members
- ClientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see 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}$
- InstanceId
-
- Type: string
The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter
InstanceId
orTargetArn
. - PhoneNumber
-
- Required: Yes
- Type: string
The phone number you want to claim. Phone numbers are formatted
[+] [country code] [subscriber number including area code]
. - PhoneNumberDescription
-
- Type: string
The description of the phone number.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
- TargetArn
-
- Type: string
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
orTargetArn
.
Result Syntax
[ 'PhoneNumberArn' => '<string>', 'PhoneNumberId' => '<string>', ]
Result Details
Members
- PhoneNumberArn
-
- Type: string
The Amazon Resource Name (ARN) of the phone number.
- PhoneNumberId
-
- Type: string
A unique identifier for the phone number.
Errors
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- IdempotencyException:
An entity with the same name already exists.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
CompleteAttachedFileUpload
$result = $client->completeAttachedFileUpload
([/* ... */]); $promise = $client->completeAttachedFileUploadAsync
([/* ... */]);
Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
Parameter Syntax
$result = $client->completeAttachedFileUpload([ 'AssociatedResourceArn' => '<string>', // REQUIRED 'FileId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AssociatedResourceArn
-
- Required: Yes
- Type: string
- FileId
-
- Required: Yes
- Type: string
The unique identifier of the attached file resource.
- InstanceId
-
- Required: Yes
- Type: string
The unique identifier of the Amazon Connect instance.
Result Syntax
[]
Result Details
Errors
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- InvalidRequestException:
The request is not valid.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
CreateAgentStatus
$result = $client->createAgentStatus
([/* ... */]); $promise = $client->createAgentStatusAsync
([/* ... */]);
This API is in preview release for Amazon Connect and is subject to change.
Creates an agent status for the specified Amazon Connect instance.
Parameter Syntax
$result = $client->createAgentStatus([ 'Description' => '<string>', 'DisplayOrder' => <integer>, 'InstanceId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'State' => 'ENABLED|DISABLED', // REQUIRED 'Tags' => ['<string>', ...], ]);
Parameter Details
Members
- Description
-
- Type: string
The description of the status.
- DisplayOrder
-
- Type: int
The display order of the status.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Name
-
- Required: Yes
- Type: string
The name of the status.
- State
-
- Required: Yes
- Type: string
The state of the status.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Result Syntax
[ 'AgentStatusARN' => '<string>', 'AgentStatusId' => '<string>', ]
Result Details
Members
- AgentStatusARN
-
- Type: string
The Amazon Resource Name (ARN) of the agent status.
- AgentStatusId
-
- Type: string
The identifier of the agent status.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- DuplicateResourceException:
A resource with the specified name already exists.
- ResourceNotFoundException:
The specified resource was not found.
- LimitExceededException:
The allowed limit for the resource has been exceeded.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
CreateContact
$result = $client->createContact
([/* ... */]); $promise = $client->createContactAsync
([/* ... */]);
Creates a new contact.
Parameter Syntax
$result = $client->createContact([ 'Attributes' => ['<string>', ...], 'Channel' => 'VOICE|CHAT|TASK|EMAIL', // REQUIRED 'ClientToken' => '<string>', 'Description' => '<string>', 'ExpiryDurationInMinutes' => <integer>, 'InitiateAs' => 'CONNECTED_TO_USER', 'InitiationMethod' => 'INBOUND|OUTBOUND|TRANSFER|QUEUE_TRANSFER|CALLBACK|API|DISCONNECT|MONITOR|EXTERNAL_OUTBOUND|WEBRTC_API|AGENT_REPLY|FLOW', // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'Name' => '<string>', 'References' => [ '<ReferenceKey>' => [ 'Arn' => '<string>', 'Status' => 'AVAILABLE|DELETED|APPROVED|REJECTED|PROCESSING|FAILED', 'StatusReason' => '<string>', 'Type' => 'URL|ATTACHMENT|CONTACT_ANALYSIS|NUMBER|STRING|DATE|EMAIL|EMAIL_MESSAGE', // REQUIRED 'Value' => '<string>', ], // ... ], 'RelatedContactId' => '<string>', 'SegmentAttributes' => [ '<SegmentAttributeName>' => [ 'ValueInteger' => <integer>, 'ValueMap' => [ '<SegmentAttributeName>' => [...], // RECURSIVE // ... ], 'ValueString' => '<string>', ], // ... ], 'UserInfo' => [ 'UserId' => '<string>', ], ]);
Parameter Details
Members
- Attributes
-
- Type: Associative array of custom strings keys (AttributeName) to strings
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.
- Channel
-
- Required: Yes
- Type: string
The channel for the contact
- ClientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
- Description
-
- Type: string
A description of the contact.
- ExpiryDurationInMinutes
-
- Type: int
Number of minutes the contact will be active for before expiring
- InitiateAs
-
- Type: string
Initial state of the contact when it's created
- InitiationMethod
-
- Required: Yes
- Type: string
Indicates how the contact was initiated.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Name
-
- Type: string
The name of a the contact.
- References
-
- Type: Associative array of custom strings keys (ReferenceKey) to Reference structures
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 | NUMBER | STRING | DATE | EMAIL | ATTACHMENT.
- RelatedContactId
-
- Type: string
The identifier of the contact in this instance of Amazon Connect.
- SegmentAttributes
-
- Type: Associative array of custom strings keys (SegmentAttributeName) to SegmentAttributeValue structures
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 _.
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 {"connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger": 135}}}}
. - UserInfo
-
- Type: UserInfo structure
User details for the contact
Result Syntax
[ 'ContactArn' => '<string>', 'ContactId' => '<string>', ]
Result Details
Members
- ContactArn
-
- Type: string
The Amazon Resource Name (ARN) of the created contact.
- ContactId
-
- Type: string
The identifier of the contact in this instance of Amazon Connect.
Errors
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- IdempotencyException:
An entity with the same name already exists.
- ConflictException:
Operation cannot be performed at this time as there is a conflict with another operation or contact state.
- ServiceQuotaExceededException:
The service quota has been exceeded.
CreateContactFlow
$result = $client->createContactFlow
([/* ... */]); $promise = $client->createContactFlowAsync
([/* ... */]);
Creates a flow for the specified Amazon Connect instance.
You can also create and update flows using the Amazon Connect Flow language.
Parameter Syntax
$result = $client->createContactFlow([ 'Content' => '<string>', // REQUIRED 'Description' => '<string>', 'InstanceId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Status' => 'PUBLISHED|SAVED', 'Tags' => ['<string>', ...], 'Type' => 'CONTACT_FLOW|CUSTOMER_QUEUE|CUSTOMER_HOLD|CUSTOMER_WHISPER|AGENT_HOLD|AGENT_WHISPER|OUTBOUND_WHISPER|AGENT_TRANSFER|QUEUE_TRANSFER', // REQUIRED ]);
Parameter Details
Members
- Content
-
- Required: Yes
- Type: string
The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
Length Constraints: Minimum length of 1. Maximum length of 256000.
- Description
-
- Type: string
The description of the flow.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance.
- Name
-
- Required: Yes
- Type: string
The name of the flow.
- Status
-
- Type: string
Indicates the flow status as either
SAVED
orPUBLISHED
. ThePUBLISHED
status will initiate validation on the content. theSAVED
status does not initiate validation of the content.SAVED
|PUBLISHED
. - Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
- Type
-
- Required: Yes
- Type: string
The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
Result Syntax
[ 'ContactFlowArn' => '<string>', 'ContactFlowId' => '<string>', 'FlowContentSha256' => '<string>', ]
Result Details
Members
- ContactFlowArn
-
- Type: string
The Amazon Resource Name (ARN) of the flow.
- ContactFlowId
-
- Type: string
The identifier of the flow.
- FlowContentSha256
-
- Type: string
Indicates the checksum value of the flow content.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidContactFlowException:
The flow is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- DuplicateResourceException:
A resource with the specified name already exists.
- LimitExceededException:
The allowed limit for the resource has been exceeded.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
CreateContactFlowModule
$result = $client->createContactFlowModule
([/* ... */]); $promise = $client->createContactFlowModuleAsync
([/* ... */]);
Creates a flow module for the specified Amazon Connect instance.
Parameter Syntax
$result = $client->createContactFlowModule([ 'ClientToken' => '<string>', 'Content' => '<string>', // REQUIRED 'Description' => '<string>', 'InstanceId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Tags' => ['<string>', ...], ]);
Parameter Details
Members
- ClientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
- Content
-
- Required: Yes
- Type: string
The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.
- Description
-
- Type: string
The description of the flow module.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Name
-
- Required: Yes
- Type: string
The name of the flow module.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Result Syntax
[ 'Arn' => '<string>', 'Id' => '<string>', ]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) of the flow module.
- Id
-
- Type: string
The identifier of the flow module.
Errors
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- InvalidRequestException:
The request is not valid.
- InvalidContactFlowModuleException:
The problems with the module. Please fix before trying again.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- DuplicateResourceException:
A resource with the specified name already exists.
- LimitExceededException:
The allowed limit for the resource has been exceeded.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- IdempotencyException:
An entity with the same name already exists.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
CreateContactFlowVersion
$result = $client->createContactFlowVersion
([/* ... */]); $promise = $client->createContactFlowVersionAsync
([/* ... */]);
Publishes a new version of the flow provided. Versions are immutable and monotonically increasing. If a version of the same flow content already exists, no new version is created and instead the existing version number is returned. 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
.
Parameter Syntax
$result = $client->createContactFlowVersion([ 'ContactFlowId' => '<string>', // REQUIRED 'Description' => '<string>', 'FlowContentSha256' => '<string>', 'InstanceId' => '<string>', // REQUIRED 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <integer || string || DateTime>, ]);
Parameter Details
Members
- ContactFlowId
-
- Required: Yes
- Type: string
The identifier of the flow.
- Description
-
- Type: string
The description of the flow version.
- FlowContentSha256
-
- Type: string
Indicates the checksum value of the flow content.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance.
- LastModifiedRegion
-
- Type: string
The Amazon Web Services Region where this resource was last modified.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Amazon Web Services Region where this resource was last modified.
Result Syntax
[ 'ContactFlowArn' => '<string>', 'Version' => <integer>, ]
Result Details
Members
- ContactFlowArn
-
- Type: string
The Amazon Resource Name (ARN) of the flow.
- Version
-
- Type: long (int|float)
The identifier of the flow version.
Errors
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ResourceNotFoundException:
The specified resource was not found.
- LimitExceededException:
The allowed limit for the resource has been exceeded.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- InvalidRequestException:
The request is not valid.
- ThrottlingException:
The throttling limit has been exceeded.
CreateEmailAddress
$result = $client->createEmailAddress
([/* ... */]); $promise = $client->createEmailAddressAsync
([/* ... */]);
Create new email address in the specified Amazon Connect instance. For more information about email addresses, see Create email addresses in the Amazon Connect Administrator Guide.
Parameter Syntax
$result = $client->createEmailAddress([ 'ClientToken' => '<string>', 'Description' => '<string>', 'DisplayName' => '<string>', 'EmailAddress' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'Tags' => ['<string>', ...], ]);
Parameter Details
Members
- ClientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
- Description
-
- Type: string
The description of the email address.
- DisplayName
-
- Type: string
The display name of email address
- EmailAddress
-
- Required: Yes
- Type: string
The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Result Syntax
[ 'EmailAddressArn' => '<string>', 'EmailAddressId' => '<string>', ]
Result Details
Members
- EmailAddressArn
-
- Type: string
The Amazon Resource Name (ARN) of the email address.
- EmailAddressId
-
- Type: string
The identifier of the email address.
Errors
- InvalidParameterException:
One or more of the specified parameters are not valid.
- InvalidRequestException:
The request is not valid.
- ServiceQuotaExceededException:
The service quota has been exceeded.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- IdempotencyException:
An entity with the same name already exists.
- DuplicateResourceException:
A resource with the specified name already exists.
- ResourceConflictException:
A resource already has that name.
CreateEvaluationForm
$result = $client->createEvaluationForm
([/* ... */]); $promise = $client->createEvaluationFormAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createEvaluationForm([ 'ClientToken' => '<string>', 'Description' => '<string>', 'InstanceId' => '<string>', // REQUIRED 'Items' => [ // REQUIRED [ 'Question' => [ 'Instructions' => '<string>', 'NotApplicableEnabled' => true || false, 'QuestionType' => 'TEXT|SINGLESELECT|NUMERIC', // REQUIRED 'QuestionTypeProperties' => [ 'Numeric' => [ 'Automation' => [ 'PropertyValue' => [ 'Label' => 'OVERALL_CUSTOMER_SENTIMENT_SCORE|OVERALL_AGENT_SENTIMENT_SCORE|NON_TALK_TIME|NON_TALK_TIME_PERCENTAGE|NUMBER_OF_INTERRUPTIONS|CONTACT_DURATION|AGENT_INTERACTION_DURATION|CUSTOMER_HOLD_TIME', // REQUIRED ], ], 'MaxValue' => <integer>, // REQUIRED 'MinValue' => <integer>, // REQUIRED 'Options' => [ [ 'AutomaticFail' => true || false, 'MaxValue' => <integer>, // REQUIRED 'MinValue' => <integer>, // REQUIRED 'Score' => <integer>, ], // ... ], ], 'SingleSelect' => [ 'Automation' => [ 'DefaultOptionRefId' => '<string>', 'Options' => [ // REQUIRED [ 'RuleCategory' => [ 'Category' => '<string>', // REQUIRED 'Condition' => 'PRESENT|NOT_PRESENT', // REQUIRED 'OptionRefId' => '<string>', // REQUIRED ], ], // ... ], ], 'DisplayAs' => 'DROPDOWN|RADIO', 'Options' => [ // REQUIRED [ 'AutomaticFail' => true || false, 'RefId' => '<string>', // REQUIRED 'Score' => <integer>, 'Text' => '<string>', // REQUIRED ], // ... ], ], ], 'RefId' => '<string>', // REQUIRED 'Title' => '<string>', // REQUIRED 'Weight' => <float>, ], 'Section' => [ 'Instructions' => '<string>', 'Items' => [...], // REQUIRED, RECURSIVE 'RefId' => '<string>', // REQUIRED 'Title' => '<string>', // REQUIRED 'Weight' => <float>, ], ], // ... ], 'ScoringStrategy' => [ 'Mode' => 'QUESTION_ONLY|SECTION_ONLY', // REQUIRED 'Status' => 'ENABLED|DISABLED', // REQUIRED ], 'Title' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ClientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
- Description
-
- Type: string
The description of the evaluation form.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Items
-
- Required: Yes
- Type: Array of EvaluationFormItem structures
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.
- ScoringStrategy
-
- Type: EvaluationFormScoringStrategy structure
A scoring strategy of the evaluation form.
- Title
-
- Required: Yes
- Type: string
A title of the evaluation form.
Result Syntax
[ 'EvaluationFormArn' => '<string>', 'EvaluationFormId' => '<string>', ]
Result Details
Members
- EvaluationFormArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the evaluation form resource.
- EvaluationFormId
-
- Required: Yes
- Type: string
The unique identifier for the evaluation form.
Errors
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- ServiceQuotaExceededException:
The service quota has been exceeded.
- ResourceConflictException:
A resource already has that name.
CreateHoursOfOperation
$result = $client->createHoursOfOperation
([/* ... */]); $promise = $client->createHoursOfOperationAsync
([/* ... */]);
This API is in preview release for Amazon Connect and is subject to change.
Creates hours of operation.
Parameter Syntax
$result = $client->createHoursOfOperation([ 'Config' => [ // REQUIRED [ 'Day' => 'SUNDAY|MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY', // REQUIRED 'EndTime' => [ // REQUIRED 'Hours' => <integer>, // REQUIRED 'Minutes' => <integer>, // REQUIRED ], 'StartTime' => [ // REQUIRED 'Hours' => <integer>, // REQUIRED 'Minutes' => <integer>, // REQUIRED ], ], // ... ], 'Description' => '<string>', 'InstanceId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Tags' => ['<string>', ...], 'TimeZone' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Config
-
- Required: Yes
- Type: Array of HoursOfOperationConfig structures
Configuration information for the hours of operation: day, start time, and end time.
- Description
-
- Type: string
The description of the hours of operation.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Name
-
- Required: Yes
- Type: string
The name of the hours of operation.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
- TimeZone
-
- Required: Yes
- Type: string
The time zone of the hours of operation.
Result Syntax
[ 'HoursOfOperationArn' => '<string>', 'HoursOfOperationId' => '<string>', ]
Result Details
Members
- HoursOfOperationArn
-
- Type: string
The Amazon Resource Name (ARN) for the hours of operation.
- HoursOfOperationId
-
- Type: string
The identifier for the hours of operation.
Errors
- DuplicateResourceException:
A resource with the specified name already exists.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- LimitExceededException:
The allowed limit for the resource has been exceeded.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
CreateHoursOfOperationOverride
$result = $client->createHoursOfOperationOverride
([/* ... */]); $promise = $client->createHoursOfOperationOverrideAsync
([/* ... */]);
Creates an hours of operation override in an Amazon Connect hours of operation resource
Parameter Syntax
$result = $client->createHoursOfOperationOverride([ 'Config' => [ // REQUIRED [ 'Day' => 'SUNDAY|MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY', 'EndTime' => [ 'Hours' => <integer>, // REQUIRED 'Minutes' => <integer>, // REQUIRED ], 'StartTime' => [ 'Hours' => <integer>, // REQUIRED 'Minutes' => <integer>, // REQUIRED ], ], // ... ], 'Description' => '<string>', 'EffectiveFrom' => '<string>', // REQUIRED 'EffectiveTill' => '<string>', // REQUIRED 'HoursOfOperationId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Config
-
- Required: Yes
- Type: Array of HoursOfOperationOverrideConfig structures
Configuration information for the hours of operation override: day, start time, and end time.
- Description
-
- Type: string
The description of the hours of operation override.
- EffectiveFrom
-
- Required: Yes
- Type: string
The date from when the hours of operation override would be effective.
- EffectiveTill
-
- Required: Yes
- Type: string
The date until when the hours of operation override would be effective.
- HoursOfOperationId
-
- Required: Yes
- Type: string
The identifier for the hours of operation
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance.
- Name
-
- Required: Yes
- Type: string
The name of the hours of operation override.
Result Syntax
[ 'HoursOfOperationOverrideId' => '<string>', ]
Result Details
Members
- HoursOfOperationOverrideId
-
- Type: string
The identifier for the hours of operation override.
Errors
- DuplicateResourceException:
A resource with the specified name already exists.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- LimitExceededException:
The allowed limit for the resource has been exceeded.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
CreateInstance
$result = $client->createInstance
([/* ... */]); $promise = $client->createInstanceAsync
([/* ... */]);
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 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.
Parameter Syntax
$result = $client->createInstance([ 'ClientToken' => '<string>', 'DirectoryId' => '<string>', 'IdentityManagementType' => 'SAML|CONNECT_MANAGED|EXISTING_DIRECTORY', // REQUIRED 'InboundCallsEnabled' => true || false, // REQUIRED 'InstanceAlias' => '<string>', 'OutboundCallsEnabled' => true || false, // REQUIRED 'Tags' => ['<string>', ...], ]);
Parameter Details
Members
- ClientToken
-
- Type: string
The idempotency token.
- DirectoryId
-
- Type: string
The identifier for the directory.
- IdentityManagementType
-
- Required: Yes
- Type: string
The type of identity management for your Amazon Connect users.
- InboundCallsEnabled
-
- Required: Yes
- Type: boolean
Your contact center handles incoming contacts.
- InstanceAlias
-
- Type: string
The name for your instance.
- OutboundCallsEnabled
-
- Required: Yes
- Type: boolean
Your contact center allows outbound calls.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource. For example,
{ "tags": {"key1":"value1", "key2":"value2"} }
.
Result Syntax
[ 'Arn' => '<string>', 'Id' => '<string>', ]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) of the instance.
- Id
-
- Type: string
The identifier for the instance.
Errors
- InvalidRequestException:
The request is not valid.
- ServiceQuotaExceededException:
The service quota has been exceeded.
- ThrottlingException:
The throttling limit has been exceeded.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
CreateIntegrationAssociation
$result = $client->createIntegrationAssociation
([/* ... */]); $promise = $client->createIntegrationAssociationAsync
([/* ... */]);
Creates an Amazon Web Services resource association with an Amazon Connect instance.
Parameter Syntax
$result = $client->createIntegrationAssociation([ 'InstanceId' => '<string>', // REQUIRED 'IntegrationArn' => '<string>', // REQUIRED 'IntegrationType' => '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', // REQUIRED 'SourceApplicationName' => '<string>', 'SourceApplicationUrl' => '<string>', 'SourceType' => 'SALESFORCE|ZENDESK|CASES', 'Tags' => ['<string>', ...], ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- IntegrationArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the integration.
When integrating with Amazon Web Services End User Messaging, the Amazon Connect and Amazon Web Services End User Messaging instances must be in the same account.
- IntegrationType
-
- Required: Yes
- Type: string
The type of information to be ingested.
- SourceApplicationName
-
- Type: string
The name of the external application. This field is only required for the EVENT integration type.
- SourceApplicationUrl
-
- Type: string
The URL for the external application. This field is only required for the EVENT integration type.
- SourceType
-
- Type: string
The type of the data source. This field is only required for the EVENT integration type.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Result Syntax
[ 'IntegrationAssociationArn' => '<string>', 'IntegrationAssociationId' => '<string>', ]
Result Details
Members
- IntegrationAssociationArn
-
- Type: string
The Amazon Resource Name (ARN) for the association.
- IntegrationAssociationId
-
- Type: string
The identifier for the integration association.
Errors
- DuplicateResourceException:
A resource with the specified name already exists.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- ThrottlingException:
The throttling limit has been exceeded.
CreateParticipant
$result = $client->createParticipant
([/* ... */]); $promise = $client->createParticipantAsync
([/* ... */]);
Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.
Parameter Syntax
$result = $client->createParticipant([ 'ClientToken' => '<string>', 'ContactId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'ParticipantDetails' => [ // REQUIRED 'DisplayName' => '<string>', 'ParticipantRole' => 'AGENT|CUSTOMER|SYSTEM|CUSTOM_BOT|SUPERVISOR', ], ]);
Parameter Details
Members
- ClientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
- ContactId
-
- Required: Yes
- Type: string
The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- ParticipantDetails
-
- Required: Yes
- Type: ParticipantDetailsToAdd structure
Information identifying the participant.
The only Valid value for
ParticipantRole
isCUSTOM_BOT
.DisplayName
is Required.
Result Syntax
[ 'ParticipantCredentials' => [ 'Expiry' => '<string>', 'ParticipantToken' => '<string>', ], 'ParticipantId' => '<string>', ]
Result Details
Members
- ParticipantCredentials
-
- Type: ParticipantTokenCredentials structure
The token used by the chat participant to call
CreateParticipantConnection
. The participant token is valid for the lifetime of a chat participant. - ParticipantId
-
- Type: string
The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.
Errors
- InvalidRequestException:
The request is not valid.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ServiceQuotaExceededException:
The service quota has been exceeded.
- ThrottlingException:
The throttling limit has been exceeded.
CreatePersistentContactAssociation
$result = $client->createPersistentContactAssociation
([/* ... */]); $promise = $client->createPersistentContactAssociationAsync
([/* ... */]);
Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see Enable persistent chat in the Amazon Connect Administrator Guide.
Parameter Syntax
$result = $client->createPersistentContactAssociation([ 'ClientToken' => '<string>', 'InitialContactId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'RehydrationType' => 'ENTIRE_PAST_SESSION|FROM_SEGMENT', // REQUIRED 'SourceContactId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ClientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
- InitialContactId
-
- Required: Yes
- Type: string
This is the contactId of the current contact that the
CreatePersistentContactAssociation
API is being called from. - InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- RehydrationType
-
- Required: Yes
- Type: string
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 theinitialContactId
of the past ended chat session in thesourceContactId
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 thesourceContactId
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_SEGMENT"
-
-
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_PAST_SESSION"
-
-
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.
-
-
- SourceContactId
-
- Required: Yes
- Type: string
The contactId from which a persistent chat session must be started.
Result Syntax
[ 'ContinuedFromContactId' => '<string>', ]
Result Details
Members
- ContinuedFromContactId
-
- Type: string
The contactId from which a persistent chat session is started. This field is populated only for persistent chat.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
CreatePredefinedAttribute
$result = $client->createPredefinedAttribute
([/* ... */]); $promise = $client->createPredefinedAttributeAsync
([/* ... */]);
Creates a new predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
Parameter Syntax
$result = $client->createPredefinedAttribute([ 'InstanceId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Values' => [ // REQUIRED 'StringList' => ['<string>', ...], ], ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Name
-
- Required: Yes
- Type: string
The name of the predefined attribute.
- Values
-
- Required: Yes
- Type: PredefinedAttributeValues structure
The values of the predefined attribute.
Result Syntax
[]
Result Details
Errors
- DuplicateResourceException:
A resource with the specified name already exists.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- LimitExceededException:
The allowed limit for the resource has been exceeded.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
CreatePrompt
$result = $client->createPrompt
([/* ... */]); $promise = $client->createPromptAsync
([/* ... */]);
Creates a prompt. For more information about prompts, such as supported file types and maximum length, see Create prompts in the Amazon Connect Administrator Guide.
Parameter Syntax
$result = $client->createPrompt([ 'Description' => '<string>', 'InstanceId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'S3Uri' => '<string>', // REQUIRED 'Tags' => ['<string>', ...], ]);
Parameter Details
Members
- Description
-
- Type: string
The description of the prompt.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Name
-
- Required: Yes
- Type: string
The name of the prompt.
- S3Uri
-
- Required: Yes
- Type: string
The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the GetPromptFile API instead of providing S3 URIs.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Result Syntax
[ 'PromptARN' => '<string>', 'PromptId' => '<string>', ]
Result Details
Members
- PromptARN
-
- Type: string
The Amazon Resource Name (ARN) of the prompt.
- PromptId
-
- Type: string
A unique identifier for the prompt.
Errors
- DuplicateResourceException:
A resource with the specified name already exists.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- LimitExceededException:
The allowed limit for the resource has been exceeded.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
CreatePushNotificationRegistration
$result = $client->createPushNotificationRegistration
([/* ... */]); $promise = $client->createPushNotificationRegistrationAsync
([/* ... */]);
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 in the Amazon Connect Administrator Guide.
Parameter Syntax
$result = $client->createPushNotificationRegistration([ 'ClientToken' => '<string>', 'ContactConfiguration' => [ // REQUIRED 'ContactId' => '<string>', // REQUIRED 'IncludeRawMessage' => true || false, 'ParticipantRole' => 'AGENT|CUSTOMER|SYSTEM|CUSTOM_BOT|SUPERVISOR', ], 'DeviceToken' => '<string>', // REQUIRED 'DeviceType' => 'GCM|APNS|APNS_SANDBOX', // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'PinpointAppArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ClientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
- ContactConfiguration
-
- Required: Yes
- Type: ContactConfiguration structure
The contact configuration for push notification registration.
- DeviceToken
-
- Required: Yes
- Type: string
The push notification token issued by the Apple or Google gateways.
- DeviceType
-
- Required: Yes
- Type: string
The device type to use when sending the message.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- PinpointAppArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Pinpoint application.
Result Syntax
[ 'RegistrationId' => '<string>', ]
Result Details
Members
- RegistrationId
-
- Required: Yes
- Type: string
The identifier for the registration.
Errors
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- ServiceQuotaExceededException:
The service quota has been exceeded.
CreateQueue
$result = $client->createQueue
([/* ... */]); $promise = $client->createQueueAsync
([/* ... */]);
Creates a new queue for the specified Amazon Connect instance.
-
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 Amazon Web Services 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 aResourceNotFoundException
. -
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 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.
Parameter Syntax
$result = $client->createQueue([ 'Description' => '<string>', 'HoursOfOperationId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'MaxContacts' => <integer>, 'Name' => '<string>', // REQUIRED 'OutboundCallerConfig' => [ 'OutboundCallerIdName' => '<string>', 'OutboundCallerIdNumberId' => '<string>', 'OutboundFlowId' => '<string>', ], 'OutboundEmailConfig' => [ 'OutboundEmailAddressId' => '<string>', ], 'QuickConnectIds' => ['<string>', ...], 'Tags' => ['<string>', ...], ]);
Parameter Details
Members
- Description
-
- Type: string
The description of the queue.
- HoursOfOperationId
-
- Required: Yes
- Type: string
The identifier for the hours of operation.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- MaxContacts
-
- Type: int
The maximum number of contacts that can be in the queue before it is considered full.
- Name
-
- Required: Yes
- Type: string
The name of the queue.
- OutboundCallerConfig
-
- Type: OutboundCallerConfig structure
The outbound caller ID name, number, and outbound whisper flow.
- OutboundEmailConfig
-
- Type: OutboundEmailConfig structure
The outbound email address ID for a specified queue.
- QuickConnectIds
-
- Type: Array of strings
The quick connects available to agents who are working the queue.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Result Syntax
[ 'QueueArn' => '<string>', 'QueueId' => '<string>', ]
Result Details
Members
- QueueArn
-
- Type: string
The Amazon Resource Name (ARN) of the queue.
- QueueId
-
- Type: string
The identifier for the queue.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- DuplicateResourceException:
A resource with the specified name already exists.
- ResourceNotFoundException:
The specified resource was not found.
- LimitExceededException:
The allowed limit for the resource has been exceeded.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
CreateQuickConnect
$result = $client->createQuickConnect
([/* ... */]); $promise = $client->createQuickConnectAsync
([/* ... */]);
Creates a quick connect for the specified Amazon Connect instance.
Parameter Syntax
$result = $client->createQuickConnect([ 'Description' => '<string>', 'InstanceId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'QuickConnectConfig' => [ // REQUIRED 'PhoneConfig' => [ 'PhoneNumber' => '<string>', // REQUIRED ], 'QueueConfig' => [ 'ContactFlowId' => '<string>', // REQUIRED 'QueueId' => '<string>', // REQUIRED ], 'QuickConnectType' => 'USER|QUEUE|PHONE_NUMBER', // REQUIRED 'UserConfig' => [ 'ContactFlowId' => '<string>', // REQUIRED 'UserId' => '<string>', // REQUIRED ], ], 'Tags' => ['<string>', ...], ]);
Parameter Details
Members
- Description
-
- Type: string
The description of the quick connect.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Name
-
- Required: Yes
- Type: string
A unique name of the quick connect.
- QuickConnectConfig
-
- Required: Yes
- Type: QuickConnectConfig structure
Configuration settings for the quick connect.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Result Syntax
[ 'QuickConnectARN' => '<string>', 'QuickConnectId' => '<string>', ]
Result Details
Members
- QuickConnectARN
-
- Type: string
The Amazon Resource Name (ARN) for the quick connect.
- QuickConnectId
-
- Type: string
The identifier for the quick connect.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- DuplicateResourceException:
A resource with the specified name already exists.
- ResourceNotFoundException:
The specified resource was not found.
- LimitExceededException:
The allowed limit for the resource has been exceeded.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
CreateRoutingProfile
$result = $client->createRoutingProfile
([/* ... */]); $promise = $client->createRoutingProfileAsync
([/* ... */]);
Creates a new routing profile.
Parameter Syntax
$result = $client->createRoutingProfile([ 'AgentAvailabilityTimer' => 'TIME_SINCE_LAST_ACTIVITY|TIME_SINCE_LAST_INBOUND', 'DefaultOutboundQueueId' => '<string>', // REQUIRED 'Description' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'MediaConcurrencies' => [ // REQUIRED [ 'Channel' => 'VOICE|CHAT|TASK|EMAIL', // REQUIRED 'Concurrency' => <integer>, // REQUIRED 'CrossChannelBehavior' => [ 'BehaviorType' => 'ROUTE_CURRENT_CHANNEL_ONLY|ROUTE_ANY_CHANNEL', // REQUIRED ], ], // ... ], 'Name' => '<string>', // REQUIRED 'QueueConfigs' => [ [ 'Delay' => <integer>, // REQUIRED 'Priority' => <integer>, // REQUIRED 'QueueReference' => [ // REQUIRED 'Channel' => 'VOICE|CHAT|TASK|EMAIL', // REQUIRED 'QueueId' => '<string>', // REQUIRED ], ], // ... ], 'Tags' => ['<string>', ...], ]);
Parameter Details
Members
- AgentAvailabilityTimer
-
- Type: string
Whether agents with this routing profile will have their routing order calculated based on longest idle time or time since their last inbound contact.
- DefaultOutboundQueueId
-
- Required: Yes
- Type: string
The default outbound queue for the routing profile.
- Description
-
- Required: Yes
- Type: string
Description of the routing profile. Must not be more than 250 characters.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- MediaConcurrencies
-
- Required: Yes
- Type: Array of MediaConcurrency structures
The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.
- Name
-
- Required: Yes
- Type: string
The name of the routing profile. Must not be more than 127 characters.
- QueueConfigs
-
- Type: Array of RoutingProfileQueueConfig structures
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. - Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Result Syntax
[ 'RoutingProfileArn' => '<string>', 'RoutingProfileId' => '<string>', ]
Result Details
Members
- RoutingProfileArn
-
- Type: string
The Amazon Resource Name (ARN) of the routing profile.
- RoutingProfileId
-
- Type: string
The identifier of the routing profile.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- DuplicateResourceException:
A resource with the specified name already exists.
- ResourceNotFoundException:
The specified resource was not found.
- LimitExceededException:
The allowed limit for the resource has been exceeded.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
CreateRule
$result = $client->createRule
([/* ... */]); $promise = $client->createRuleAsync
([/* ... */]);
Creates a rule for the specified Amazon Connect instance.
Use the Rules Function language to code conditions for the rule.
Parameter Syntax
$result = $client->createRule([ 'Actions' => [ // REQUIRED [ 'ActionType' => 'CREATE_TASK|ASSIGN_CONTACT_CATEGORY|GENERATE_EVENTBRIDGE_EVENT|SEND_NOTIFICATION|CREATE_CASE|UPDATE_CASE|END_ASSOCIATED_TASKS|SUBMIT_AUTO_EVALUATION', // REQUIRED 'AssignContactCategoryAction' => [ ], 'CreateCaseAction' => [ 'Fields' => [ // REQUIRED [ 'Id' => '<string>', // REQUIRED 'Value' => [ // REQUIRED 'BooleanValue' => true || false, 'DoubleValue' => <float>, 'EmptyValue' => [ ], 'StringValue' => '<string>', ], ], // ... ], 'TemplateId' => '<string>', // REQUIRED ], 'EndAssociatedTasksAction' => [ ], 'EventBridgeAction' => [ 'Name' => '<string>', // REQUIRED ], 'SendNotificationAction' => [ 'Content' => '<string>', // REQUIRED 'ContentType' => 'PLAIN_TEXT', // REQUIRED 'DeliveryMethod' => 'EMAIL', // REQUIRED 'Recipient' => [ // REQUIRED 'UserIds' => ['<string>', ...], 'UserTags' => ['<string>', ...], ], 'Subject' => '<string>', ], 'SubmitAutoEvaluationAction' => [ 'EvaluationFormId' => '<string>', // REQUIRED ], 'TaskAction' => [ 'ContactFlowId' => '<string>', // REQUIRED 'Description' => '<string>', 'Name' => '<string>', // REQUIRED 'References' => [ '<ReferenceKey>' => [ 'Arn' => '<string>', 'Status' => 'AVAILABLE|DELETED|APPROVED|REJECTED|PROCESSING|FAILED', 'StatusReason' => '<string>', 'Type' => 'URL|ATTACHMENT|CONTACT_ANALYSIS|NUMBER|STRING|DATE|EMAIL|EMAIL_MESSAGE', // REQUIRED 'Value' => '<string>', ], // ... ], ], 'UpdateCaseAction' => [ 'Fields' => [ // REQUIRED [ 'Id' => '<string>', // REQUIRED 'Value' => [ // REQUIRED 'BooleanValue' => true || false, 'DoubleValue' => <float>, 'EmptyValue' => [ ], 'StringValue' => '<string>', ], ], // ... ], ], ], // ... ], 'ClientToken' => '<string>', 'Function' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'PublishStatus' => 'DRAFT|PUBLISHED', // REQUIRED 'TriggerEventSource' => [ // REQUIRED 'EventSourceName' => 'OnPostCallAnalysisAvailable|OnRealTimeCallAnalysisAvailable|OnRealTimeChatAnalysisAvailable|OnPostChatAnalysisAvailable|OnZendeskTicketCreate|OnZendeskTicketStatusUpdate|OnSalesforceCaseCreate|OnContactEvaluationSubmit|OnMetricDataUpdate|OnCaseCreate|OnCaseUpdate', // REQUIRED 'IntegrationAssociationId' => '<string>', ], ]);
Parameter Details
Members
- Actions
-
- Required: Yes
- Type: Array of RuleAction structures
A list of actions to be run when the rule is triggered.
- ClientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
- Function
-
- Required: Yes
- Type: string
The conditions of the rule.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Name
-
- Required: Yes
- Type: string
A unique name for the rule.
- PublishStatus
-
- Required: Yes
- Type: string
The publish status of the rule.
- TriggerEventSource
-
- Required: Yes
- Type: RuleTriggerEventSource structure
The event source to trigger the rule.
Result Syntax
[ 'RuleArn' => '<string>', 'RuleId' => '<string>', ]
Result Details
Members
- RuleArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the rule.
- RuleId
-
- Required: Yes
- Type: string
A unique identifier for the rule.
Errors
- InvalidRequestException:
The request is not valid.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ThrottlingException:
The throttling limit has been exceeded.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- ResourceConflictException:
A resource already has that name.
- ServiceQuotaExceededException:
The service quota has been exceeded.
CreateSecurityProfile
$result = $client->createSecurityProfile
([/* ... */]); $promise = $client->createSecurityProfileAsync
([/* ... */]);
Creates a security profile.
For information about security profiles, see Security Profiles 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.
Parameter Syntax
$result = $client->createSecurityProfile([ 'AllowedAccessControlHierarchyGroupId' => '<string>', 'AllowedAccessControlTags' => ['<string>', ...], 'Applications' => [ [ 'ApplicationPermissions' => ['<string>', ...], 'Namespace' => '<string>', ], // ... ], 'Description' => '<string>', 'HierarchyRestrictedResources' => ['<string>', ...], 'InstanceId' => '<string>', // REQUIRED 'Permissions' => ['<string>', ...], 'SecurityProfileName' => '<string>', // REQUIRED 'TagRestrictedResources' => ['<string>', ...], 'Tags' => ['<string>', ...], ]);
Parameter Details
Members
- AllowedAccessControlHierarchyGroupId
-
- Type: string
The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.
- AllowedAccessControlTags
-
- Type: Associative array of custom strings keys (SecurityProfilePolicyKey) to strings
The list of tags that a security profile uses to restrict access to resources in Amazon Connect.
- Applications
-
- Type: Array of Application structures
A list of third-party applications that the security profile will give access to.
- Description
-
- Type: string
The description of the security profile.
- HierarchyRestrictedResources
-
- Type: Array of strings
The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames:
User
. - InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Permissions
-
- Type: Array of strings
Permissions assigned to the security profile. For a list of valid permissions, see List of security profile permissions.
- SecurityProfileName
-
- Required: Yes
- Type: string
The name of the security profile.
- TagRestrictedResources
-
- Type: Array of strings
The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are acceptable ResourceNames:
User
|SecurityProfile
|Queue
|RoutingProfile
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Result Syntax
[ 'SecurityProfileArn' => '<string>', 'SecurityProfileId' => '<string>', ]
Result Details
Members
- SecurityProfileArn
-
- Type: string
The Amazon Resource Name (ARN) for the security profile.
- SecurityProfileId
-
- Type: string
The identifier for the security profle.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- LimitExceededException:
The allowed limit for the resource has been exceeded.
- DuplicateResourceException:
A resource with the specified name already exists.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
CreateTaskTemplate
$result = $client->createTaskTemplate
([/* ... */]); $promise = $client->createTaskTemplateAsync
([/* ... */]);
Creates a new task template in the specified Amazon Connect instance.
Parameter Syntax
$result = $client->createTaskTemplate([ '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' => [ // REQUIRED [ 'Description' => '<string>', 'Id' => [ // REQUIRED 'Name' => '<string>', ], 'SingleSelectOptions' => ['<string>', ...], 'Type' => 'NAME|DESCRIPTION|SCHEDULED_TIME|QUICK_CONNECT|URL|NUMBER|TEXT|TEXT_AREA|DATE_TIME|BOOLEAN|SINGLE_SELECT|EMAIL|SELF_ASSIGN|EXPIRY_DURATION', ], // ... ], 'InstanceId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'SelfAssignFlowId' => '<string>', 'Status' => 'ACTIVE|INACTIVE', ]);
Parameter Details
Members
- ClientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
- Constraints
-
- Type: TaskTemplateConstraints structure
Constraints that are applicable to the fields listed.
- ContactFlowId
-
- Type: string
The identifier of the flow that runs by default when a task is created by referencing this template.
- Defaults
-
- Type: TaskTemplateDefaults structure
The default values for fields when a task is created by referencing this template.
- Description
-
- Type: string
The description of the task template.
- Fields
-
- Required: Yes
- Type: Array of TaskTemplateField structures
Fields that are part of the template.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Name
-
- Required: Yes
- Type: string
The name of the task template.
- SelfAssignFlowId
-
- Type: string
The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.
- Status
-
- Type: string
Marks a template as
ACTIVE
orINACTIVE
for a task to refer to it. Tasks can only be created fromACTIVE
templates. If a template is marked asINACTIVE
, then a task that refers to this template cannot be created.
Result Syntax
[ 'Arn' => '<string>', 'Id' => '<string>', ]
Result Details
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the task template resource.
- Id
-
- Required: Yes
- Type: string
The identifier of the task template resource.
Errors
- PropertyValidationException:
The property is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- ServiceQuotaExceededException:
The service quota has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
CreateTrafficDistributionGroup
$result = $client->createTrafficDistributionGroup
([/* ... */]); $promise = $client->createTrafficDistributionGroupAsync
([/* ... */]);
Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
The SignInConfig
distribution is available only on a default TrafficDistributionGroup
(see the IsDefault
parameter in the TrafficDistributionGroup 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 in the Amazon Connect Administrator Guide.
Parameter Syntax
$result = $client->createTrafficDistributionGroup([ 'ClientToken' => '<string>', 'Description' => '<string>', 'InstanceId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Tags' => ['<string>', ...], ]);
Parameter Details
Members
- ClientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
- Description
-
- Type: string
A description for the traffic distribution group.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance that has been replicated. You can find the
instanceId
in the ARN of the instance. - Name
-
- Required: Yes
- Type: string
The name for the traffic distribution group.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Result Syntax
[ 'Arn' => '<string>', 'Id' => '<string>', ]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) of the traffic distribution group.
- Id
-
- Type: string
The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.
Errors
- InvalidRequestException:
The request is not valid.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- ServiceQuotaExceededException:
The service quota has been exceeded.
- ThrottlingException:
The throttling limit has been exceeded.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ResourceConflictException:
A resource already has that name.
- ResourceNotReadyException:
The resource is not ready.
CreateUseCase
$result = $client->createUseCase
([/* ... */]); $promise = $client->createUseCaseAsync
([/* ... */]);
Creates a use case for an integration association.
Parameter Syntax
$result = $client->createUseCase([ 'InstanceId' => '<string>', // REQUIRED 'IntegrationAssociationId' => '<string>', // REQUIRED 'Tags' => ['<string>', ...], 'UseCaseType' => 'RULES_EVALUATION|CONNECT_CAMPAIGNS', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- IntegrationAssociationId
-
- Required: Yes
- Type: string
The identifier for the integration association.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
- UseCaseType
-
- Required: Yes
- Type: string
The type of use case to associate to the integration association. Each integration association can have only one of each use case type.
Result Syntax
[ 'UseCaseArn' => '<string>', 'UseCaseId' => '<string>', ]
Result Details
Members
- UseCaseArn
-
- Type: string
The Amazon Resource Name (ARN) for the use case.
- UseCaseId
-
- Type: string
The identifier of the use case.
Errors
- DuplicateResourceException:
A resource with the specified name already exists.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- ThrottlingException:
The throttling limit has been exceeded.
CreateUser
$result = $client->createUser
([/* ... */]); $promise = $client->createUserAsync
([/* ... */]);
Creates a user account for the specified Amazon Connect instance.
Certain UserIdentityInfo parameters are required in some situations. For example, Email
is required if you are using SAML for identity management. FirstName
and LastName
are required if you are using Amazon Connect or SAML for identity management.
For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.
Parameter Syntax
$result = $client->createUser([ 'DirectoryUserId' => '<string>', 'HierarchyGroupId' => '<string>', 'IdentityInfo' => [ 'Email' => '<string>', 'FirstName' => '<string>', 'LastName' => '<string>', 'Mobile' => '<string>', 'SecondaryEmail' => '<string>', ], 'InstanceId' => '<string>', // REQUIRED 'Password' => '<string>', 'PhoneConfig' => [ // REQUIRED 'AfterContactWorkTimeLimit' => <integer>, 'AutoAccept' => true || false, 'DeskPhoneNumber' => '<string>', 'PhoneType' => 'SOFT_PHONE|DESK_PHONE', // REQUIRED ], 'RoutingProfileId' => '<string>', // REQUIRED 'SecurityProfileIds' => ['<string>', ...], // REQUIRED 'Tags' => ['<string>', ...], 'Username' => '<string>', // REQUIRED ]);
Parameter Details
Members
- DirectoryUserId
-
- Type: string
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.
- HierarchyGroupId
-
- Type: string
The identifier of the hierarchy group for the user.
- IdentityInfo
-
- Type: UserIdentityInfo structure
The information about the identity of the user.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Password
-
- Type: string
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.
- PhoneConfig
-
- Required: Yes
- Type: UserPhoneConfig structure
The phone settings for the user.
- RoutingProfileId
-
- Required: Yes
- Type: string
The identifier of the routing profile for the user.
- SecurityProfileIds
-
- Required: Yes
- Type: Array of strings
The identifier of the security profile for the user.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
- Username
-
- Required: Yes
- Type: string
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_-.\@]+.
Username can include @ only if used in an email format. For example:
-
Correct: testuser
-
Correct: testuser@example.com
-
Incorrect: testuser@example
Result Syntax
[ 'UserArn' => '<string>', 'UserId' => '<string>', ]
Result Details
Members
- UserArn
-
- Type: string
The Amazon Resource Name (ARN) of the user account.
- UserId
-
- Type: string
The identifier of the user account.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- LimitExceededException:
The allowed limit for the resource has been exceeded.
- DuplicateResourceException:
A resource with the specified name already exists.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
CreateUserHierarchyGroup
$result = $client->createUserHierarchyGroup
([/* ... */]); $promise = $client->createUserHierarchyGroupAsync
([/* ... */]);
Creates a new user hierarchy group.
Parameter Syntax
$result = $client->createUserHierarchyGroup([ 'InstanceId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'ParentGroupId' => '<string>', 'Tags' => ['<string>', ...], ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Name
-
- Required: Yes
- Type: string
The name of the user hierarchy group. Must not be more than 100 characters.
- ParentGroupId
-
- Type: string
The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Result Syntax
[ 'HierarchyGroupArn' => '<string>', 'HierarchyGroupId' => '<string>', ]
Result Details
Members
- HierarchyGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the hierarchy group.
- HierarchyGroupId
-
- Type: string
The identifier of the hierarchy group.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- DuplicateResourceException:
A resource with the specified name already exists.
- LimitExceededException:
The allowed limit for the resource has been exceeded.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
CreateView
$result = $client->createView
([/* ... */]); $promise = $client->createViewAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createView([ 'ClientToken' => '<string>', 'Content' => [ // REQUIRED 'Actions' => ['<string>', ...], 'Template' => '<string>', ], 'Description' => '<string>', 'InstanceId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Status' => 'PUBLISHED|SAVED', // REQUIRED 'Tags' => ['<string>', ...], ]);
Parameter Details
Members
- ClientToken
-
- Type: string
A unique Id for each create view request to avoid duplicate view creation. For example, the view is idempotent ClientToken is provided.
- Content
-
- Required: Yes
- Type: ViewInputContent structure
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.
- Description
-
- Type: string
The description of the view.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- Name
-
- Required: Yes
- Type: string
The name of the view.
- Status
-
- Required: Yes
- Type: string
Indicates the view status as either
SAVED
orPUBLISHED
. ThePUBLISHED
status will initiate validation on the content. - Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
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, { "tags": {"key1":"value1", "key2":"value2"} }.
Result Syntax
[ 'View' => [ 'Arn' => '<string>', 'Content' => [ 'Actions' => ['<string>', ...], 'InputSchema' => '<string>', 'Template' => '<string>', ], 'CreatedTime' => <DateTime>, 'Description' => '<string>', 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', 'Status' => 'PUBLISHED|SAVED', 'Tags' => ['<string>', ...], 'Type' => 'CUSTOMER_MANAGED|AWS_MANAGED', 'Version' => <integer>, 'VersionDescription' => '<string>', 'ViewContentSha256' => '<string>', ], ]
Result Details
Members
- View
-
- Type: View structure
A view resource object. Contains metadata and content necessary to render the view.
Errors
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- DuplicateResourceException:
A resource with the specified name already exists.
- ServiceQuotaExceededException:
The service quota has been exceeded.
- TooManyRequestsException:
Displayed when rate-related API limits are exceeded.
- ResourceInUseException:
That resource is already in use. Please try another.
CreateViewVersion
$result = $client->createViewVersion
([/* ... */]); $promise = $client->createViewVersionAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createViewVersion([ 'InstanceId' => '<string>', // REQUIRED 'VersionDescription' => '<string>', 'ViewContentSha256' => '<string>', 'ViewId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- VersionDescription
-
- Type: string
The description for the version being published.
- ViewContentSha256
-
- Type: string
Indicates the checksum value of the latest published view content.
- ViewId
-
- Required: Yes
- Type: string
The identifier of the view. Both
ViewArn
andViewId
can be used.
Result Syntax
[ 'View' => [ 'Arn' => '<string>', 'Content' => [ 'Actions' => ['<string>', ...], 'InputSchema' => '<string>', 'Template' => '<string>', ], 'CreatedTime' => <DateTime>, 'Description' => '<string>', 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', 'Status' => 'PUBLISHED|SAVED', 'Tags' => ['<string>', ...], 'Type' => 'CUSTOMER_MANAGED|AWS_MANAGED', 'Version' => <integer>, 'VersionDescription' => '<string>', 'ViewContentSha256' => '<string>', ], ]
Result Details
Members
- View
-
- Type: View structure
All view data is contained within the View object.
Errors
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- TooManyRequestsException:
Displayed when rate-related API limits are exceeded.
- ServiceQuotaExceededException:
The service quota has been exceeded.
- ResourceInUseException:
That resource is already in use. Please try another.
CreateVocabulary
$result = $client->createVocabulary
([/* ... */]); $promise = $client->createVocabularyAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createVocabulary([ 'ClientToken' => '<string>', 'Content' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'LanguageCode' => '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 'Tags' => ['<string>', ...], 'VocabularyName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ClientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see 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.
- Content
-
- Required: Yes
- Type: string
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
, andDisplayAs
fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see Create a custom vocabulary using a table. - InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- LanguageCode
-
- Required: Yes
- Type: string
The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see What is Amazon Transcribe?
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
- VocabularyName
-
- Required: Yes
- Type: string
A unique name of the custom vocabulary.
Result Syntax
[ 'State' => 'CREATION_IN_PROGRESS|ACTIVE|CREATION_FAILED|DELETE_IN_PROGRESS', 'VocabularyArn' => '<string>', 'VocabularyId' => '<string>', ]
Result Details
Members
- State
-
- Required: Yes
- Type: string
The current state of the custom vocabulary.
- VocabularyArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the custom vocabulary.
- VocabularyId
-
- Required: Yes
- Type: string
The identifier of the custom vocabulary.
Errors
- InvalidRequestException:
The request is not valid.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ThrottlingException:
The throttling limit has been exceeded.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- ResourceConflictException:
A resource already has that name.
- ServiceQuotaExceededException:
The service quota has been exceeded.
DeactivateEvaluationForm
$result = $client->deactivateEvaluationForm
([/* ... */]); $promise = $client->deactivateEvaluationFormAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->deactivateEvaluationForm([ 'EvaluationFormId' => '<string>', // REQUIRED 'EvaluationFormVersion' => <integer>, // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- EvaluationFormId
-
- Required: Yes
- Type: string
The unique identifier for the evaluation form.
- EvaluationFormVersion
-
- Required: Yes
- Type: int
A version of the evaluation form. If the version property is not provided, the latest version of the evaluation form is deactivated.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[ 'EvaluationFormArn' => '<string>', 'EvaluationFormId' => '<string>', 'EvaluationFormVersion' => <integer>, ]
Result Details
Members
- EvaluationFormArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the evaluation form resource.
- EvaluationFormId
-
- Required: Yes
- Type: string
The unique identifier for the evaluation form.
- EvaluationFormVersion
-
- Required: Yes
- Type: int
The version of the deactivated evaluation form resource.
Errors
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ResourceConflictException:
A resource already has that name.
DeleteAttachedFile
$result = $client->deleteAttachedFile
([/* ... */]); $promise = $client->deleteAttachedFileAsync
([/* ... */]);
Deletes an attached file along with the underlying S3 Object.
The attached file is permanently deleted if S3 bucket versioning is not enabled.
Parameter Syntax
$result = $client->deleteAttachedFile([ 'AssociatedResourceArn' => '<string>', // REQUIRED 'FileId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AssociatedResourceArn
-
- Required: Yes
- Type: string
The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
This value must be a valid ARN.
- FileId
-
- Required: Yes
- Type: string
The unique identifier of the attached file resource.
- InstanceId
-
- Required: Yes
- Type: string
The unique identifier of the Connect instance.
Result Syntax
[]
Result Details
Errors
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- InvalidRequestException:
The request is not valid.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
DeleteContactEvaluation
$result = $client->deleteContactEvaluation
([/* ... */]); $promise = $client->deleteContactEvaluationAsync
([/* ... */]);
Deletes a contact evaluation in the specified Amazon Connect instance.
Parameter Syntax
$result = $client->deleteContactEvaluation([ 'EvaluationId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- EvaluationId
-
- Required: Yes
- Type: string
A unique identifier for the contact evaluation.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[]
Result Details
Errors
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ResourceConflictException:
A resource already has that name.
DeleteContactFlow
$result = $client->deleteContactFlow
([/* ... */]); $promise = $client->deleteContactFlowAsync
([/* ... */]);
Deletes a flow for the specified Amazon Connect instance.
Parameter Syntax
$result = $client->deleteContactFlow([ 'ContactFlowId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ContactFlowId
-
- Required: Yes
- Type: string
The identifier of the flow.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[]
Result Details
Errors
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ThrottlingException:
The throttling limit has been exceeded.
DeleteContactFlowModule
$result = $client->deleteContactFlowModule
([/* ... */]); $promise = $client->deleteContactFlowModuleAsync
([/* ... */]);
Deletes the specified flow module.
Parameter Syntax
$result = $client->deleteContactFlowModule([ 'ContactFlowModuleId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ContactFlowModuleId
-
- Required: Yes
- Type: string
The identifier of the flow module.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[]
Result Details
Errors
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DeleteEmailAddress
$result = $client->deleteEmailAddress
([/* ... */]); $promise = $client->deleteEmailAddressAsync
([/* ... */]);
Deletes email address from the specified Amazon Connect instance.
Parameter Syntax
$result = $client->deleteEmailAddress([ 'EmailAddressId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- EmailAddressId
-
- Required: Yes
- Type: string
The identifier of the email address.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- InvalidRequestException:
The request is not valid.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ResourceConflictException:
A resource already has that name.
DeleteEvaluationForm
$result = $client->deleteEvaluationForm
([/* ... */]); $promise = $client->deleteEvaluationFormAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteEvaluationForm([ 'EvaluationFormId' => '<string>', // REQUIRED 'EvaluationFormVersion' => <integer>, 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- EvaluationFormId
-
- Required: Yes
- Type: string
The unique identifier for the evaluation form.
- EvaluationFormVersion
-
- Type: int
The unique identifier for the evaluation form.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[]
Result Details
Errors
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ResourceConflictException:
A resource already has that name.
DeleteHoursOfOperation
$result = $client->deleteHoursOfOperation
([/* ... */]); $promise = $client->deleteHoursOfOperationAsync
([/* ... */]);
This API is in preview release for Amazon Connect and is subject to change.
Deletes an hours of operation.
Parameter Syntax
$result = $client->deleteHoursOfOperation([ 'HoursOfOperationId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- HoursOfOperationId
-
- Required: Yes
- Type: string
The identifier for the hours of operation.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DeleteHoursOfOperationOverride
$result = $client->deleteHoursOfOperationOverride
([/* ... */]); $promise = $client->deleteHoursOfOperationOverrideAsync
([/* ... */]);
Deletes an hours of operation override in an Amazon Connect hours of operation resource
Parameter Syntax
$result = $client->deleteHoursOfOperationOverride([ 'HoursOfOperationId' => '<string>', // REQUIRED 'HoursOfOperationOverrideId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- HoursOfOperationId
-
- Required: Yes
- Type: string
The identifier for the hours of operation.
- HoursOfOperationOverrideId
-
- Required: Yes
- Type: string
The identifier for the hours of operation override.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DeleteInstance
$result = $client->deleteInstance
([/* ... */]); $promise = $client->deleteInstanceAsync
([/* ... */]);
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 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.
Parameter Syntax
$result = $client->deleteInstance([ 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
DeleteIntegrationAssociation
$result = $client->deleteIntegrationAssociation
([/* ... */]); $promise = $client->deleteIntegrationAssociationAsync
([/* ... */]);
Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it.
Parameter Syntax
$result = $client->deleteIntegrationAssociation([ 'InstanceId' => '<string>', // REQUIRED 'IntegrationAssociationId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- IntegrationAssociationId
-
- Required: Yes
- Type: string
The identifier for the integration association.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- ThrottlingException:
The throttling limit has been exceeded.
DeletePredefinedAttribute
$result = $client->deletePredefinedAttribute
([/* ... */]); $promise = $client->deletePredefinedAttributeAsync
([/* ... */]);
Deletes a predefined attribute from the specified Amazon Connect instance.
Parameter Syntax
$result = $client->deletePredefinedAttribute([ 'InstanceId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Name
-
- Required: Yes
- Type: string
The name of the predefined attribute.
Result Syntax
[]
Result Details
Errors
- ResourceInUseException:
That resource is already in use. Please try another.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DeletePrompt
$result = $client->deletePrompt
([/* ... */]); $promise = $client->deletePromptAsync
([/* ... */]);
Deletes a prompt.
Parameter Syntax
$result = $client->deletePrompt([ 'InstanceId' => '<string>', // REQUIRED 'PromptId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- PromptId
-
- Required: Yes
- Type: string
A unique identifier for the prompt.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DeletePushNotificationRegistration
$result = $client->deletePushNotificationRegistration
([/* ... */]); $promise = $client->deletePushNotificationRegistrationAsync
([/* ... */]);
Deletes registration for a device token and a chat contact.
Parameter Syntax
$result = $client->deletePushNotificationRegistration([ 'ContactId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'RegistrationId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ContactId
-
- Required: Yes
- Type: string
The identifier of the contact within the Amazon Connect instance.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- RegistrationId
-
- Required: Yes
- Type: string
The identifier for the registration.
Result Syntax
[]
Result Details
Errors
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
DeleteQueue
$result = $client->deleteQueue
([/* ... */]); $promise = $client->deleteQueueAsync
([/* ... */]);
Deletes a queue. It isn't possible to delete a queue by using the Amazon Connect admin website.
Parameter Syntax
$result = $client->deleteQueue([ 'InstanceId' => '<string>', // REQUIRED 'QueueId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- QueueId
-
- Required: Yes
- Type: string
The identifier for the queue.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ResourceInUseException:
That resource is already in use. Please try another.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DeleteQuickConnect
$result = $client->deleteQuickConnect
([/* ... */]); $promise = $client->deleteQuickConnectAsync
([/* ... */]);
Deletes a quick connect.
After calling DeleteUser, 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.
Parameter Syntax
$result = $client->deleteQuickConnect([ 'InstanceId' => '<string>', // REQUIRED 'QuickConnectId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- QuickConnectId
-
- Required: Yes
- Type: string
The identifier for the quick connect.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DeleteRoutingProfile
$result = $client->deleteRoutingProfile
([/* ... */]); $promise = $client->deleteRoutingProfileAsync
([/* ... */]);
Deletes a routing profile.
Parameter Syntax
$result = $client->deleteRoutingProfile([ 'InstanceId' => '<string>', // REQUIRED 'RoutingProfileId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- RoutingProfileId
-
- Required: Yes
- Type: string
The identifier of the routing profile.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ResourceInUseException:
That resource is already in use. Please try another.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DeleteRule
$result = $client->deleteRule
([/* ... */]); $promise = $client->deleteRuleAsync
([/* ... */]);
Deletes a rule for the specified Amazon Connect instance.
Parameter Syntax
$result = $client->deleteRule([ 'InstanceId' => '<string>', // REQUIRED 'RuleId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- RuleId
-
- Required: Yes
- Type: string
A unique identifier for the rule.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ThrottlingException:
The throttling limit has been exceeded.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
DeleteSecurityProfile
$result = $client->deleteSecurityProfile
([/* ... */]); $promise = $client->deleteSecurityProfileAsync
([/* ... */]);
Deletes a security profile.
Parameter Syntax
$result = $client->deleteSecurityProfile([ 'InstanceId' => '<string>', // REQUIRED 'SecurityProfileId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- SecurityProfileId
-
- Required: Yes
- Type: string
The identifier for the security profle.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- ResourceInUseException:
That resource is already in use. Please try another.
DeleteTaskTemplate
$result = $client->deleteTaskTemplate
([/* ... */]); $promise = $client->deleteTaskTemplateAsync
([/* ... */]);
Deletes the task template.
Parameter Syntax
$result = $client->deleteTaskTemplate([ 'InstanceId' => '<string>', // REQUIRED 'TaskTemplateId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- TaskTemplateId
-
- Required: Yes
- Type: string
A unique identifier for the task template.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DeleteTrafficDistributionGroup
$result = $client->deleteTrafficDistributionGroup
([/* ... */]); $promise = $client->deleteTrafficDistributionGroupAsync
([/* ... */]);
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 in the Amazon Connect Administrator Guide.
Parameter Syntax
$result = $client->deleteTrafficDistributionGroup([ 'TrafficDistributionGroupId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- TrafficDistributionGroupId
-
- Required: Yes
- Type: string
The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- ResourceInUseException:
That resource is already in use. Please try another.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DeleteUseCase
$result = $client->deleteUseCase
([/* ... */]); $promise = $client->deleteUseCaseAsync
([/* ... */]);
Deletes a use case from an integration association.
Parameter Syntax
$result = $client->deleteUseCase([ 'InstanceId' => '<string>', // REQUIRED 'IntegrationAssociationId' => '<string>', // REQUIRED 'UseCaseId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- IntegrationAssociationId
-
- Required: Yes
- Type: string
The identifier for the integration association.
- UseCaseId
-
- Required: Yes
- Type: string
The identifier for the use case.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- ThrottlingException:
The throttling limit has been exceeded.
DeleteUser
$result = $client->deleteUser
([/* ... */]); $promise = $client->deleteUserAsync
([/* ... */]);
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 in the Amazon Connect Administrator Guide.
After calling DeleteUser, 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.
Parameter Syntax
$result = $client->deleteUser([ 'InstanceId' => '<string>', // REQUIRED 'UserId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- UserId
-
- Required: Yes
- Type: string
The identifier of the user.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DeleteUserHierarchyGroup
$result = $client->deleteUserHierarchyGroup
([/* ... */]); $promise = $client->deleteUserHierarchyGroupAsync
([/* ... */]);
Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
Parameter Syntax
$result = $client->deleteUserHierarchyGroup([ 'HierarchyGroupId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- HierarchyGroupId
-
- Required: Yes
- Type: string
The identifier of the hierarchy group.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ResourceInUseException:
That resource is already in use. Please try another.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DeleteView
$result = $client->deleteView
([/* ... */]); $promise = $client->deleteViewAsync
([/* ... */]);
Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases).
Parameter Syntax
$result = $client->deleteView([ 'InstanceId' => '<string>', // REQUIRED 'ViewId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- ViewId
-
- Required: Yes
- Type: string
The identifier of the view. Both
ViewArn
andViewId
can be used.
Result Syntax
[]
Result Details
Errors
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- TooManyRequestsException:
Displayed when rate-related API limits are exceeded.
- ResourceInUseException:
That resource is already in use. Please try another.
DeleteViewVersion
$result = $client->deleteViewVersion
([/* ... */]); $promise = $client->deleteViewVersionAsync
([/* ... */]);
Deletes the particular version specified in ViewVersion
identifier.
Parameter Syntax
$result = $client->deleteViewVersion([ 'InstanceId' => '<string>', // REQUIRED 'ViewId' => '<string>', // REQUIRED 'ViewVersion' => <integer>, // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- ViewId
-
- Required: Yes
- Type: string
The identifier of the view. Both
ViewArn
andViewId
can be used. - ViewVersion
-
- Required: Yes
- Type: int
The version number of the view.
Result Syntax
[]
Result Details
Errors
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- TooManyRequestsException:
Displayed when rate-related API limits are exceeded.
- ResourceInUseException:
That resource is already in use. Please try another.
DeleteVocabulary
$result = $client->deleteVocabulary
([/* ... */]); $promise = $client->deleteVocabularyAsync
([/* ... */]);
Deletes the vocabulary that has the given identifier.
Parameter Syntax
$result = $client->deleteVocabulary([ 'InstanceId' => '<string>', // REQUIRED 'VocabularyId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- VocabularyId
-
- Required: Yes
- Type: string
The identifier of the custom vocabulary.
Result Syntax
[ 'State' => 'CREATION_IN_PROGRESS|ACTIVE|CREATION_FAILED|DELETE_IN_PROGRESS', 'VocabularyArn' => '<string>', 'VocabularyId' => '<string>', ]
Result Details
Members
- State
-
- Required: Yes
- Type: string
The current state of the custom vocabulary.
- VocabularyArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the custom vocabulary.
- VocabularyId
-
- Required: Yes
- Type: string
The identifier of the custom vocabulary.
Errors
- InvalidRequestException:
The request is not valid.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ThrottlingException:
The throttling limit has been exceeded.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- ResourceInUseException:
That resource is already in use. Please try another.
DescribeAgentStatus
$result = $client->describeAgentStatus
([/* ... */]); $promise = $client->describeAgentStatusAsync
([/* ... */]);
This API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
Parameter Syntax
$result = $client->describeAgentStatus([ 'AgentStatusId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AgentStatusId
-
- Required: Yes
- Type: string
The identifier for the agent status.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[ 'AgentStatus' => [ 'AgentStatusARN' => '<string>', 'AgentStatusId' => '<string>', 'Description' => '<string>', 'DisplayOrder' => <integer>, 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', 'State' => 'ENABLED|DISABLED', 'Tags' => ['<string>', ...], 'Type' => 'ROUTABLE|CUSTOM|OFFLINE', ], ]
Result Details
Members
- AgentStatus
-
- Type: AgentStatus structure
The agent status.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DescribeAuthenticationProfile
$result = $client->describeAuthenticationProfile
([/* ... */]); $promise = $client->describeAuthenticationProfileAsync
([/* ... */]);
This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.
Describes the target authentication profile.
Parameter Syntax
$result = $client->describeAuthenticationProfile([ 'AuthenticationProfileId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AuthenticationProfileId
-
- Required: Yes
- Type: string
A unique identifier for the authentication profile.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[ 'AuthenticationProfile' => [ 'AllowedIps' => ['<string>', ...], 'Arn' => '<string>', 'BlockedIps' => ['<string>', ...], 'CreatedTime' => <DateTime>, 'Description' => '<string>', 'Id' => '<string>', 'IsDefault' => true || false, 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'MaxSessionDuration' => <integer>, 'Name' => '<string>', 'PeriodicSessionDuration' => <integer>, ], ]
Result Details
Members
- AuthenticationProfile
-
- Type: AuthenticationProfile structure
The authentication profile object being described.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DescribeContact
$result = $client->describeContact
([/* ... */]); $promise = $client->describeContactAsync
([/* ... */]);
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified contact.
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
Parameter Syntax
$result = $client->describeContact([ 'ContactId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ContactId
-
- Required: Yes
- Type: string
The identifier of the contact.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[ 'Contact' => [ 'AdditionalEmailRecipients' => [ 'CcList' => [ [ 'Address' => '<string>', 'DisplayName' => '<string>', ], // ... ], 'ToList' => [ [ 'Address' => '<string>', 'DisplayName' => '<string>', ], // ... ], ], 'AgentInfo' => [ 'AgentPauseDurationInSeconds' => <integer>, 'Capabilities' => [ 'ScreenShare' => 'SEND', 'Video' => 'SEND', ], 'ConnectedToAgentTimestamp' => <DateTime>, '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>', ], 'AnsweringMachineDetectionStatus' => 'ANSWERED|UNDETECTED|ERROR|HUMAN_ANSWERED|SIT_TONE_DETECTED|SIT_TONE_BUSY|SIT_TONE_INVALID_NUMBER|FAX_MACHINE_DETECTED|VOICEMAIL_BEEP|VOICEMAIL_NO_BEEP|AMD_UNRESOLVED|AMD_UNANSWERED|AMD_ERROR|AMD_NOT_APPLICABLE', 'Arn' => '<string>', 'Campaign' => [ 'CampaignId' => '<string>', ], 'Channel' => 'VOICE|CHAT|TASK|EMAIL', 'ConnectedToSystemTimestamp' => <DateTime>, 'ContactAssociationId' => '<string>', 'Customer' => [ 'Capabilities' => [ 'ScreenShare' => 'SEND', 'Video' => 'SEND', ], 'DeviceInfo' => [ 'OperatingSystem' => '<string>', 'PlatformName' => '<string>', 'PlatformVersion' => '<string>', ], ], 'CustomerEndpoint' => [ 'Address' => '<string>', 'DisplayName' => '<string>', 'Type' => 'TELEPHONE_NUMBER|VOIP|CONTACT_FLOW|CONNECT_PHONENUMBER_ARN|EMAIL_ADDRESS', ], 'CustomerVoiceActivity' => [ 'GreetingEndTimestamp' => <DateTime>, 'GreetingStartTimestamp' => <DateTime>, ], 'Description' => '<string>', 'DisconnectDetails' => [ 'PotentialDisconnectIssue' => '<string>', ], 'DisconnectTimestamp' => <DateTime>, 'Id' => '<string>', 'InitialContactId' => '<string>', 'InitiationMethod' => 'INBOUND|OUTBOUND|TRANSFER|QUEUE_TRANSFER|CALLBACK|API|DISCONNECT|MONITOR|EXTERNAL_OUTBOUND|WEBRTC_API|AGENT_REPLY|FLOW', 'InitiationTimestamp' => <DateTime>, 'LastPausedTimestamp' => <DateTime>, 'LastResumedTimestamp' => <DateTime>, 'LastUpdateTimestamp' => <DateTime>, 'Name' => '<string>', 'PreviousContactId' => '<string>', 'QualityMetrics' => [ 'Agent' => [ 'Audio' => [ 'PotentialQualityIssues' => ['<string>', ...], 'QualityScore' => <float>, ], ], 'Customer' => [ 'Audio' => [ 'PotentialQualityIssues' => ['<string>', ...], 'QualityScore' => <float>, ], ], ], 'QueueInfo' => [ 'EnqueueTimestamp' => <DateTime>, 'Id' => '<string>', ], 'QueuePriority' => <integer>, 'QueueTimeAdjustmentSeconds' => <integer>, 'RelatedContactId' => '<string>', 'RoutingCriteria' => [ 'ActivationTimestamp' => <DateTime>, 'Index' => <integer>, 'Steps' => [ [ 'Expiry' => [ 'DurationInSeconds' => <integer>, 'ExpiryTimestamp' => <DateTime>, ], 'Expression' => [ 'AndExpression' => [ [...], // RECURSIVE // ... ], 'AttributeCondition' => [ 'ComparisonOperator' => '<string>', 'MatchCriteria' => [ 'AgentsCriteria' => [ 'AgentIds' => ['<string>', ...], ], ], 'Name' => '<string>', 'ProficiencyLevel' => <float>, 'Value' => '<string>', ], 'OrExpression' => [ [...], // RECURSIVE // ... ], ], 'Status' => 'ACTIVE|INACTIVE|JOINED|EXPIRED', ], // ... ], ], 'ScheduledTimestamp' => <DateTime>, 'SegmentAttributes' => [ '<SegmentAttributeName>' => [ 'ValueInteger' => <integer>, 'ValueMap' => [ '<SegmentAttributeName>' => [...], // RECURSIVE // ... ], 'ValueString' => '<string>', ], // ... ], 'SystemEndpoint' => [ 'Address' => '<string>', 'DisplayName' => '<string>', 'Type' => 'TELEPHONE_NUMBER|VOIP|CONTACT_FLOW|CONNECT_PHONENUMBER_ARN|EMAIL_ADDRESS', ], 'Tags' => ['<string>', ...], 'TotalPauseCount' => <integer>, 'TotalPauseDurationInSeconds' => <integer>, 'WisdomInfo' => [ 'SessionArn' => '<string>', ], ], ]
Result Details
Members
- Contact
-
- Type: Contact structure
Information about the contact.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ThrottlingException:
The throttling limit has been exceeded.
DescribeContactEvaluation
$result = $client->describeContactEvaluation
([/* ... */]); $promise = $client->describeContactEvaluationAsync
([/* ... */]);
Describes a contact evaluation in the specified Amazon Connect instance.
Parameter Syntax
$result = $client->describeContactEvaluation([ 'EvaluationId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- EvaluationId
-
- Required: Yes
- Type: string
A unique identifier for the contact evaluation.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[ 'Evaluation' => [ 'Answers' => [ '<ResourceId>' => [ 'SystemSuggestedValue' => [ 'NotApplicable' => true || false, 'NumericValue' => <float>, 'StringValue' => '<string>', ], 'Value' => [ 'NotApplicable' => true || false, 'NumericValue' => <float>, 'StringValue' => '<string>', ], ], // ... ], 'CreatedTime' => <DateTime>, 'EvaluationArn' => '<string>', 'EvaluationId' => '<string>', 'LastModifiedTime' => <DateTime>, 'Metadata' => [ 'ContactAgentId' => '<string>', 'ContactId' => '<string>', 'EvaluatorArn' => '<string>', 'Score' => [ 'AutomaticFail' => true || false, 'NotApplicable' => true || false, 'Percentage' => <float>, ], ], 'Notes' => [ '<ResourceId>' => [ 'Value' => '<string>', ], // ... ], 'Scores' => [ '<ResourceId>' => [ 'AutomaticFail' => true || false, 'NotApplicable' => true || false, 'Percentage' => <float>, ], // ... ], 'Status' => 'DRAFT|SUBMITTED', 'Tags' => ['<string>', ...], ], 'EvaluationForm' => [ 'Description' => '<string>', 'EvaluationFormArn' => '<string>', 'EvaluationFormId' => '<string>', 'EvaluationFormVersion' => <integer>, 'Items' => [ [ 'Question' => [ 'Instructions' => '<string>', 'NotApplicableEnabled' => true || false, 'QuestionType' => 'TEXT|SINGLESELECT|NUMERIC', 'QuestionTypeProperties' => [ 'Numeric' => [ 'Automation' => [ 'PropertyValue' => [ 'Label' => 'OVERALL_CUSTOMER_SENTIMENT_SCORE|OVERALL_AGENT_SENTIMENT_SCORE|NON_TALK_TIME|NON_TALK_TIME_PERCENTAGE|NUMBER_OF_INTERRUPTIONS|CONTACT_DURATION|AGENT_INTERACTION_DURATION|CUSTOMER_HOLD_TIME', ], ], 'MaxValue' => <integer>, 'MinValue' => <integer>, 'Options' => [ [ 'AutomaticFail' => true || false, 'MaxValue' => <integer>, 'MinValue' => <integer>, 'Score' => <integer>, ], // ... ], ], 'SingleSelect' => [ 'Automation' => [ 'DefaultOptionRefId' => '<string>', 'Options' => [ [ 'RuleCategory' => [ 'Category' => '<string>', 'Condition' => 'PRESENT|NOT_PRESENT', 'OptionRefId' => '<string>', ], ], // ... ], ], 'DisplayAs' => 'DROPDOWN|RADIO', 'Options' => [ [ 'AutomaticFail' => true || false, 'RefId' => '<string>', 'Score' => <integer>, 'Text' => '<string>', ], // ... ], ], ], 'RefId' => '<string>', 'Title' => '<string>', 'Weight' => <float>, ], 'Section' => [ 'Instructions' => '<string>', 'Items' => [...], // RECURSIVE 'RefId' => '<string>', 'Title' => '<string>', 'Weight' => <float>, ], ], // ... ], 'ScoringStrategy' => [ 'Mode' => 'QUESTION_ONLY|SECTION_ONLY', 'Status' => 'ENABLED|DISABLED', ], 'Title' => '<string>', ], ]
Result Details
Members
- Evaluation
-
- Required: Yes
- Type: Evaluation structure
Information about the evaluation form completed for a specific contact.
- EvaluationForm
-
- Required: Yes
- Type: EvaluationFormContent structure
Information about the evaluation form.
Errors
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DescribeContactFlow
$result = $client->describeContactFlow
([/* ... */]); $promise = $client->describeContactFlowAsync
([/* ... */]);
Describes the specified flow.
You can also create and update flows using the Amazon Connect Flow language.
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.
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
| PUBLISHED
Parameter Syntax
$result = $client->describeContactFlow([ 'ContactFlowId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ContactFlowId
-
- Required: Yes
- Type: string
The identifier of the flow.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance.
Result Syntax
[ 'ContactFlow' => [ 'Arn' => '<string>', 'Content' => '<string>', 'Description' => '<string>', 'FlowContentSha256' => '<string>', 'Id' => '<string>', 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', 'State' => 'ACTIVE|ARCHIVED', 'Status' => 'PUBLISHED|SAVED', 'Tags' => ['<string>', ...], 'Type' => 'CONTACT_FLOW|CUSTOMER_QUEUE|CUSTOMER_HOLD|CUSTOMER_WHISPER|AGENT_HOLD|AGENT_WHISPER|OUTBOUND_WHISPER|AGENT_TRANSFER|QUEUE_TRANSFER', 'Version' => <integer>, 'VersionDescription' => '<string>', ], ]
Result Details
Members
- ContactFlow
-
- Type: ContactFlow structure
Information about the flow.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ContactFlowNotPublishedException:
The flow has not been published.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DescribeContactFlowModule
$result = $client->describeContactFlowModule
([/* ... */]); $promise = $client->describeContactFlowModuleAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeContactFlowModule([ 'ContactFlowModuleId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ContactFlowModuleId
-
- Required: Yes
- Type: string
The identifier of the flow module.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[ 'ContactFlowModule' => [ 'Arn' => '<string>', 'Content' => '<string>', 'Description' => '<string>', 'Id' => '<string>', 'Name' => '<string>', 'State' => 'ACTIVE|ARCHIVED', 'Status' => 'PUBLISHED|SAVED', 'Tags' => ['<string>', ...], ], ]
Result Details
Members
- ContactFlowModule
-
- Type: ContactFlowModule structure
Information about the flow module.
Errors
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DescribeEmailAddress
$result = $client->describeEmailAddress
([/* ... */]); $promise = $client->describeEmailAddressAsync
([/* ... */]);
Describe email address form the specified Amazon Connect instance.
Parameter Syntax
$result = $client->describeEmailAddress([ 'EmailAddressId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- EmailAddressId
-
- Required: Yes
- Type: string
The identifier of the email address.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[ 'CreateTimestamp' => '<string>', 'Description' => '<string>', 'DisplayName' => '<string>', 'EmailAddress' => '<string>', 'EmailAddressArn' => '<string>', 'EmailAddressId' => '<string>', 'ModifiedTimestamp' => '<string>', 'Tags' => ['<string>', ...], ]
Result Details
Members
- CreateTimestamp
-
- Type: string
The email address creation timestamp in ISO 8601 Datetime.
- Description
-
- Type: string
The description of the email address.
- DisplayName
-
- Type: string
The display name of email address
- EmailAddress
-
- Type: string
The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.
- EmailAddressArn
-
- Type: string
The Amazon Resource Name (ARN) of the email address.
- EmailAddressId
-
- Type: string
The identifier of the email address.
- ModifiedTimestamp
-
- Type: string
The email address last modification timestamp in ISO 8601 Datetime.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Errors
- ResourceNotFoundException:
The specified resource was not found.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- ThrottlingException:
The throttling limit has been exceeded.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- InvalidRequestException:
The request is not valid.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DescribeEvaluationForm
$result = $client->describeEvaluationForm
([/* ... */]); $promise = $client->describeEvaluationFormAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeEvaluationForm([ 'EvaluationFormId' => '<string>', // REQUIRED 'EvaluationFormVersion' => <integer>, 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- EvaluationFormId
-
- Required: Yes
- Type: string
A unique identifier for the contact evaluation.
- EvaluationFormVersion
-
- Type: int
A version of the evaluation form.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[ 'EvaluationForm' => [ 'CreatedBy' => '<string>', 'CreatedTime' => <DateTime>, 'Description' => '<string>', 'EvaluationFormArn' => '<string>', 'EvaluationFormId' => '<string>', 'EvaluationFormVersion' => <integer>, 'Items' => [ [ 'Question' => [ 'Instructions' => '<string>', 'NotApplicableEnabled' => true || false, 'QuestionType' => 'TEXT|SINGLESELECT|NUMERIC', 'QuestionTypeProperties' => [ 'Numeric' => [ 'Automation' => [ 'PropertyValue' => [ 'Label' => 'OVERALL_CUSTOMER_SENTIMENT_SCORE|OVERALL_AGENT_SENTIMENT_SCORE|NON_TALK_TIME|NON_TALK_TIME_PERCENTAGE|NUMBER_OF_INTERRUPTIONS|CONTACT_DURATION|AGENT_INTERACTION_DURATION|CUSTOMER_HOLD_TIME', ], ], 'MaxValue' => <integer>, 'MinValue' => <integer>, 'Options' => [ [ 'AutomaticFail' => true || false, 'MaxValue' => <integer>, 'MinValue' => <integer>, 'Score' => <integer>, ], // ... ], ], 'SingleSelect' => [ 'Automation' => [ 'DefaultOptionRefId' => '<string>', 'Options' => [ [ 'RuleCategory' => [ 'Category' => '<string>', 'Condition' => 'PRESENT|NOT_PRESENT', 'OptionRefId' => '<string>', ], ], // ... ], ], 'DisplayAs' => 'DROPDOWN|RADIO', 'Options' => [ [ 'AutomaticFail' => true || false, 'RefId' => '<string>', 'Score' => <integer>, 'Text' => '<string>', ], // ... ], ], ], 'RefId' => '<string>', 'Title' => '<string>', 'Weight' => <float>, ], 'Section' => [ 'Instructions' => '<string>', 'Items' => [...], // RECURSIVE 'RefId' => '<string>', 'Title' => '<string>', 'Weight' => <float>, ], ], // ... ], 'LastModifiedBy' => '<string>', 'LastModifiedTime' => <DateTime>, 'Locked' => true || false, 'ScoringStrategy' => [ 'Mode' => 'QUESTION_ONLY|SECTION_ONLY', 'Status' => 'ENABLED|DISABLED', ], 'Status' => 'DRAFT|ACTIVE', 'Tags' => ['<string>', ...], 'Title' => '<string>', ], ]
Result Details
Members
- EvaluationForm
-
- Required: Yes
- Type: EvaluationForm structure
Information about the evaluation form.
Errors
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DescribeHoursOfOperation
$result = $client->describeHoursOfOperation
([/* ... */]); $promise = $client->describeHoursOfOperationAsync
([/* ... */]);
This API is in preview release for Amazon Connect and is subject to change.
Describes the hours of operation.
Parameter Syntax
$result = $client->describeHoursOfOperation([ 'HoursOfOperationId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- HoursOfOperationId
-
- Required: Yes
- Type: string
The identifier for the hours of operation.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[ 'HoursOfOperation' => [ 'Config' => [ [ 'Day' => 'SUNDAY|MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY', 'EndTime' => [ 'Hours' => <integer>, 'Minutes' => <integer>, ], 'StartTime' => [ 'Hours' => <integer>, 'Minutes' => <integer>, ], ], // ... ], 'Description' => '<string>', 'HoursOfOperationArn' => '<string>', 'HoursOfOperationId' => '<string>', 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', 'Tags' => ['<string>', ...], 'TimeZone' => '<string>', ], ]
Result Details
Members
- HoursOfOperation
-
- Type: HoursOfOperation structure
The hours of operation.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DescribeHoursOfOperationOverride
$result = $client->describeHoursOfOperationOverride
([/* ... */]); $promise = $client->describeHoursOfOperationOverrideAsync
([/* ... */]);
Describes the hours of operation override.
Parameter Syntax
$result = $client->describeHoursOfOperationOverride([ 'HoursOfOperationId' => '<string>', // REQUIRED 'HoursOfOperationOverrideId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- HoursOfOperationId
-
- Required: Yes
- Type: string
The identifier for the hours of operation.
- HoursOfOperationOverrideId
-
- Required: Yes
- Type: string
The identifier for the hours of operation override.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance.
Result Syntax
[ 'HoursOfOperationOverride' => [ 'Config' => [ [ 'Day' => 'SUNDAY|MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY', 'EndTime' => [ 'Hours' => <integer>, 'Minutes' => <integer>, ], 'StartTime' => [ 'Hours' => <integer>, 'Minutes' => <integer>, ], ], // ... ], 'Description' => '<string>', 'EffectiveFrom' => '<string>', 'EffectiveTill' => '<string>', 'HoursOfOperationArn' => '<string>', 'HoursOfOperationId' => '<string>', 'HoursOfOperationOverrideId' => '<string>', 'Name' => '<string>', ], ]
Result Details
Members
- HoursOfOperationOverride
-
- Type: HoursOfOperationOverride structure
Information about the hours of operations override.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DescribeInstance
$result = $client->describeInstance
([/* ... */]); $promise = $client->describeInstanceAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeInstance([ 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[ 'Instance' => [ 'Arn' => '<string>', 'CreatedTime' => <DateTime>, 'Id' => '<string>', 'IdentityManagementType' => 'SAML|CONNECT_MANAGED|EXISTING_DIRECTORY', 'InboundCallsEnabled' => true || false, 'InstanceAccessUrl' => '<string>', 'InstanceAlias' => '<string>', 'InstanceStatus' => 'CREATION_IN_PROGRESS|ACTIVE|CREATION_FAILED', 'OutboundCallsEnabled' => true || false, 'ServiceRole' => '<string>', 'StatusReason' => [ 'Message' => '<string>', ], 'Tags' => ['<string>', ...], ], 'ReplicationConfiguration' => [ 'GlobalSignInEndpoint' => '<string>', 'ReplicationStatusSummaryList' => [ [ 'Region' => '<string>', 'ReplicationStatus' => 'INSTANCE_REPLICATION_COMPLETE|INSTANCE_REPLICATION_IN_PROGRESS|INSTANCE_REPLICATION_FAILED|INSTANCE_REPLICA_DELETING|INSTANCE_REPLICATION_DELETION_FAILED|RESOURCE_REPLICATION_NOT_STARTED', 'ReplicationStatusReason' => '<string>', ], // ... ], 'SourceRegion' => '<string>', ], ]
Result Details
Members
- Instance
-
- Type: Instance structure
The name of the instance.
- ReplicationConfiguration
-
- Type: ReplicationConfiguration structure
Status information about the replication process. This field is included only when you are using the ReplicateInstance API to replicate an Amazon Connect instance across Amazon Web Services Regions. For information about replicating Amazon Connect instances, see Create a replica of your existing Amazon Connect instance in the Amazon Connect Administrator Guide.
Errors
- InvalidRequestException:
The request is not valid.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DescribeInstanceAttribute
$result = $client->describeInstanceAttribute
([/* ... */]); $promise = $client->describeInstanceAttributeAsync
([/* ... */]);
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified instance attribute.
Parameter Syntax
$result = $client->describeInstanceAttribute([ 'AttributeType' => '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', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AttributeType
-
- Required: Yes
- Type: string
The type of attribute.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[ 'Attribute' => [ 'AttributeType' => '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', 'Value' => '<string>', ], ]
Result Details
Members
- Attribute
-
- Type: Attribute structure
The type of attribute.
Errors
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ThrottlingException:
The throttling limit has been exceeded.
DescribeInstanceStorageConfig
$result = $client->describeInstanceStorageConfig
([/* ... */]); $promise = $client->describeInstanceStorageConfigAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeInstanceStorageConfig([ 'AssociationId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'ResourceType' => '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 ]);
Parameter Details
Members
- AssociationId
-
- Required: Yes
- Type: string
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- ResourceType
-
- Required: Yes
- Type: string
A valid resource type.
Result Syntax
[ 'StorageConfig' => [ 'AssociationId' => '<string>', 'KinesisFirehoseConfig' => [ 'FirehoseArn' => '<string>', ], 'KinesisStreamConfig' => [ 'StreamArn' => '<string>', ], 'KinesisVideoStreamConfig' => [ 'EncryptionConfig' => [ 'EncryptionType' => 'KMS', 'KeyId' => '<string>', ], 'Prefix' => '<string>', 'RetentionPeriodHours' => <integer>, ], 'S3Config' => [ 'BucketName' => '<string>', 'BucketPrefix' => '<string>', 'EncryptionConfig' => [ 'EncryptionType' => 'KMS', 'KeyId' => '<string>', ], ], 'StorageType' => 'S3|KINESIS_VIDEO_STREAM|KINESIS_STREAM|KINESIS_FIREHOSE', ], ]
Result Details
Members
- StorageConfig
-
- Type: InstanceStorageConfig structure
A valid storage type.
Errors
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ThrottlingException:
The throttling limit has been exceeded.
DescribePhoneNumber
$result = $client->describePhoneNumber
([/* ... */]); $promise = $client->describePhoneNumberAsync
([/* ... */]);
Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group.
If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was 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 Amazon Web Services 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
.
Parameter Syntax
$result = $client->describePhoneNumber([ 'PhoneNumberId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- PhoneNumberId
-
- Required: Yes
- Type: string
A unique identifier for the phone number.
Result Syntax
[ 'ClaimedPhoneNumberSummary' => [ 'InstanceId' => '<string>', 'PhoneNumber' => '<string>', 'PhoneNumberArn' => '<string>', 'PhoneNumberCountryCode' => 'AF|AL|DZ|AS|AD|AO|AI|AQ|AG|AR|AM|AW|AU|AT|AZ|BS|BH|BD|BB|BY|BE|BZ|BJ|BM|BT|BO|BA|BW|BR|IO|VG|BN|BG|BF|BI|KH|CM|CA|CV|KY|CF|TD|CL|CN|CX|CC|CO|KM|CK|CR|HR|CU|CW|CY|CZ|CD|DK|DJ|DM|DO|TL|EC|EG|SV|GQ|ER|EE|ET|FK|FO|FJ|FI|FR|PF|GA|GM|GE|DE|GH|GI|GR|GL|GD|GU|GT|GG|GN|GW|GY|HT|HN|HK|HU|IS|IN|ID|IR|IQ|IE|IM|IL|IT|CI|JM|JP|JE|JO|KZ|KE|KI|KW|KG|LA|LV|LB|LS|LR|LY|LI|LT|LU|MO|MK|MG|MW|MY|MV|ML|MT|MH|MR|MU|YT|MX|FM|MD|MC|MN|ME|MS|MA|MZ|MM|NA|NR|NP|NL|AN|NC|NZ|NI|NE|NG|NU|KP|MP|NO|OM|PK|PW|PA|PG|PY|PE|PH|PN|PL|PT|PR|QA|CG|RE|RO|RU|RW|BL|SH|KN|LC|MF|PM|VC|WS|SM|ST|SA|SN|RS|SC|SL|SG|SX|SK|SI|SB|SO|ZA|KR|ES|LK|SD|SR|SJ|SZ|SE|CH|SY|TW|TJ|TZ|TH|TG|TK|TO|TT|TN|TR|TM|TC|TV|VI|UG|UA|AE|GB|US|UY|UZ|VU|VA|VE|VN|WF|EH|YE|ZM|ZW', 'PhoneNumberDescription' => '<string>', 'PhoneNumberId' => '<string>', 'PhoneNumberStatus' => [ 'Message' => '<string>', 'Status' => 'CLAIMED|IN_PROGRESS|FAILED', ], 'PhoneNumberType' => 'TOLL_FREE|DID|UIFN|SHARED|THIRD_PARTY_TF|THIRD_PARTY_DID|SHORT_CODE', 'SourcePhoneNumberArn' => '<string>', 'Tags' => ['<string>', ...], 'TargetArn' => '<string>', ], ]
Result Details
Members
- ClaimedPhoneNumberSummary
-
- Type: ClaimedPhoneNumberSummary structure
Information about a phone number that's been claimed to your Amazon Connect instance or traffic distribution group.
Errors
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
DescribePredefinedAttribute
$result = $client->describePredefinedAttribute
([/* ... */]); $promise = $client->describePredefinedAttributeAsync
([/* ... */]);
Describes a predefined attribute for the specified Amazon Connect instance. Predefined attributes are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see Create predefined attributes for routing contacts to agents.
Parameter Syntax
$result = $client->describePredefinedAttribute([ 'InstanceId' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Name
-
- Required: Yes
- Type: string
The name of the predefined attribute.
Result Syntax
[ 'PredefinedAttribute' => [ 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', 'Values' => [ 'StringList' => ['<string>', ...], ], ], ]
Result Details
Members
- PredefinedAttribute
-
- Type: PredefinedAttribute structure
Information about the predefined attribute.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DescribePrompt
$result = $client->describePrompt
([/* ... */]); $promise = $client->describePromptAsync
([/* ... */]);
Describes the prompt.
Parameter Syntax
$result = $client->describePrompt([ 'InstanceId' => '<string>', // REQUIRED 'PromptId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- PromptId
-
- Required: Yes
- Type: string
A unique identifier for the prompt.
Result Syntax
[ 'Prompt' => [ 'Description' => '<string>', 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', 'PromptARN' => '<string>', 'PromptId' => '<string>', 'Tags' => ['<string>', ...], ], ]
Result Details
Members
- Prompt
-
- Type: Prompt structure
Information about the prompt.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DescribeQueue
$result = $client->describeQueue
([/* ... */]); $promise = $client->describeQueueAsync
([/* ... */]);
This API is in preview release for Amazon Connect and is subject to change.
Describes the specified queue.
Parameter Syntax
$result = $client->describeQueue([ 'InstanceId' => '<string>', // REQUIRED 'QueueId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- QueueId
-
- Required: Yes
- Type: string
The identifier for the queue.
Result Syntax
[ 'Queue' => [ 'Description' => '<string>', 'HoursOfOperationId' => '<string>', 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'MaxContacts' => <integer>, 'Name' => '<string>', 'OutboundCallerConfig' => [ 'OutboundCallerIdName' => '<string>', 'OutboundCallerIdNumberId' => '<string>', 'OutboundFlowId' => '<string>', ], 'OutboundEmailConfig' => [ 'OutboundEmailAddressId' => '<string>', ], 'QueueArn' => '<string>', 'QueueId' => '<string>', 'Status' => 'ENABLED|DISABLED', 'Tags' => ['<string>', ...], ], ]
Result Details
Members
- Queue
-
- Type: Queue structure
The name of the queue.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DescribeQuickConnect
$result = $client->describeQuickConnect
([/* ... */]); $promise = $client->describeQuickConnectAsync
([/* ... */]);
Describes the quick connect.
Parameter Syntax
$result = $client->describeQuickConnect([ 'InstanceId' => '<string>', // REQUIRED 'QuickConnectId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- QuickConnectId
-
- Required: Yes
- Type: string
The identifier for the quick connect.
Result Syntax
[ 'QuickConnect' => [ 'Description' => '<string>', 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', 'QuickConnectARN' => '<string>', 'QuickConnectConfig' => [ 'PhoneConfig' => [ 'PhoneNumber' => '<string>', ], 'QueueConfig' => [ 'ContactFlowId' => '<string>', 'QueueId' => '<string>', ], 'QuickConnectType' => 'USER|QUEUE|PHONE_NUMBER', 'UserConfig' => [ 'ContactFlowId' => '<string>', 'UserId' => '<string>', ], ], 'QuickConnectId' => '<string>', 'Tags' => ['<string>', ...], ], ]
Result Details
Members
- QuickConnect
-
- Type: QuickConnect structure
Information about the quick connect.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DescribeRoutingProfile
$result = $client->describeRoutingProfile
([/* ... */]); $promise = $client->describeRoutingProfileAsync
([/* ... */]);
Describes the specified routing profile.
Parameter Syntax
$result = $client->describeRoutingProfile([ 'InstanceId' => '<string>', // REQUIRED 'RoutingProfileId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- RoutingProfileId
-
- Required: Yes
- Type: string
The identifier of the routing profile.
Result Syntax
[ 'RoutingProfile' => [ 'AgentAvailabilityTimer' => 'TIME_SINCE_LAST_ACTIVITY|TIME_SINCE_LAST_INBOUND', 'AssociatedQueueIds' => ['<string>', ...], 'DefaultOutboundQueueId' => '<string>', 'Description' => '<string>', 'InstanceId' => '<string>', 'IsDefault' => true || false, 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'MediaConcurrencies' => [ [ 'Channel' => 'VOICE|CHAT|TASK|EMAIL', 'Concurrency' => <integer>, 'CrossChannelBehavior' => [ 'BehaviorType' => 'ROUTE_CURRENT_CHANNEL_ONLY|ROUTE_ANY_CHANNEL', ], ], // ... ], 'Name' => '<string>', 'NumberOfAssociatedQueues' => <integer>, 'NumberOfAssociatedUsers' => <integer>, 'RoutingProfileArn' => '<string>', 'RoutingProfileId' => '<string>', 'Tags' => ['<string>', ...], ], ]
Result Details
Members
- RoutingProfile
-
- Type: RoutingProfile structure
The routing profile.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DescribeRule
$result = $client->describeRule
([/* ... */]); $promise = $client->describeRuleAsync
([/* ... */]);
Describes a rule for the specified Amazon Connect instance.
Parameter Syntax
$result = $client->describeRule([ 'InstanceId' => '<string>', // REQUIRED 'RuleId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- RuleId
-
- Required: Yes
- Type: string
A unique identifier for the rule.
Result Syntax
[ 'Rule' => [ 'Actions' => [ [ 'ActionType' => 'CREATE_TASK|ASSIGN_CONTACT_CATEGORY|GENERATE_EVENTBRIDGE_EVENT|SEND_NOTIFICATION|CREATE_CASE|UPDATE_CASE|END_ASSOCIATED_TASKS|SUBMIT_AUTO_EVALUATION', 'AssignContactCategoryAction' => [ ], 'CreateCaseAction' => [ 'Fields' => [ [ 'Id' => '<string>', 'Value' => [ 'BooleanValue' => true || false, 'DoubleValue' => <float>, 'EmptyValue' => [ ], 'StringValue' => '<string>', ], ], // ... ], 'TemplateId' => '<string>', ], 'EndAssociatedTasksAction' => [ ], 'EventBridgeAction' => [ 'Name' => '<string>', ], 'SendNotificationAction' => [ 'Content' => '<string>', 'ContentType' => 'PLAIN_TEXT', 'DeliveryMethod' => 'EMAIL', 'Recipient' => [ 'UserIds' => ['<string>', ...], 'UserTags' => ['<string>', ...], ], 'Subject' => '<string>', ], 'SubmitAutoEvaluationAction' => [ 'EvaluationFormId' => '<string>', ], 'TaskAction' => [ 'ContactFlowId' => '<string>', 'Description' => '<string>', 'Name' => '<string>', 'References' => [ '<ReferenceKey>' => [ 'Arn' => '<string>', 'Status' => 'AVAILABLE|DELETED|APPROVED|REJECTED|PROCESSING|FAILED', 'StatusReason' => '<string>', 'Type' => 'URL|ATTACHMENT|CONTACT_ANALYSIS|NUMBER|STRING|DATE|EMAIL|EMAIL_MESSAGE', 'Value' => '<string>', ], // ... ], ], 'UpdateCaseAction' => [ 'Fields' => [ [ 'Id' => '<string>', 'Value' => [ 'BooleanValue' => true || false, 'DoubleValue' => <float>, 'EmptyValue' => [ ], 'StringValue' => '<string>', ], ], // ... ], ], ], // ... ], 'CreatedTime' => <DateTime>, 'Function' => '<string>', 'LastUpdatedBy' => '<string>', 'LastUpdatedTime' => <DateTime>, 'Name' => '<string>', 'PublishStatus' => 'DRAFT|PUBLISHED', 'RuleArn' => '<string>', 'RuleId' => '<string>', 'Tags' => ['<string>', ...], 'TriggerEventSource' => [ 'EventSourceName' => 'OnPostCallAnalysisAvailable|OnRealTimeCallAnalysisAvailable|OnRealTimeChatAnalysisAvailable|OnPostChatAnalysisAvailable|OnZendeskTicketCreate|OnZendeskTicketStatusUpdate|OnSalesforceCaseCreate|OnContactEvaluationSubmit|OnMetricDataUpdate|OnCaseCreate|OnCaseUpdate', 'IntegrationAssociationId' => '<string>', ], ], ]
Result Details
Members
- Rule
-
- Required: Yes
- Type: Rule structure
Information about the rule.
Errors
- InvalidRequestException:
The request is not valid.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ThrottlingException:
The throttling limit has been exceeded.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
DescribeSecurityProfile
$result = $client->describeSecurityProfile
([/* ... */]); $promise = $client->describeSecurityProfileAsync
([/* ... */]);
Gets basic information about the security profile.
For information about security profiles, see Security Profiles 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.
Parameter Syntax
$result = $client->describeSecurityProfile([ 'InstanceId' => '<string>', // REQUIRED 'SecurityProfileId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- SecurityProfileId
-
- Required: Yes
- Type: string
The identifier for the security profle.
Result Syntax
[ 'SecurityProfile' => [ 'AllowedAccessControlHierarchyGroupId' => '<string>', 'AllowedAccessControlTags' => ['<string>', ...], 'Arn' => '<string>', 'Description' => '<string>', 'HierarchyRestrictedResources' => ['<string>', ...], 'Id' => '<string>', 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'OrganizationResourceId' => '<string>', 'SecurityProfileName' => '<string>', 'TagRestrictedResources' => ['<string>', ...], 'Tags' => ['<string>', ...], ], ]
Result Details
Members
- SecurityProfile
-
- Type: SecurityProfile structure
The security profile.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DescribeTrafficDistributionGroup
$result = $client->describeTrafficDistributionGroup
([/* ... */]); $promise = $client->describeTrafficDistributionGroupAsync
([/* ... */]);
Gets details and status of a traffic distribution group.
Parameter Syntax
$result = $client->describeTrafficDistributionGroup([ 'TrafficDistributionGroupId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- TrafficDistributionGroupId
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'TrafficDistributionGroup' => [ 'Arn' => '<string>', 'Description' => '<string>', 'Id' => '<string>', 'InstanceArn' => '<string>', 'IsDefault' => true || false, 'Name' => '<string>', 'Status' => 'CREATION_IN_PROGRESS|ACTIVE|CREATION_FAILED|PENDING_DELETION|DELETION_FAILED|UPDATE_IN_PROGRESS', 'Tags' => ['<string>', ...], ], ]
Result Details
Members
- TrafficDistributionGroup
-
- Type: TrafficDistributionGroup structure
Information about the traffic distribution group.
Errors
- InvalidRequestException:
The request is not valid.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ThrottlingException:
The throttling limit has been exceeded.
DescribeUser
$result = $client->describeUser
([/* ... */]); $promise = $client->describeUserAsync
([/* ... */]);
Describes the specified user. You can find the instance ID in the Amazon Connect console (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.
Parameter Syntax
$result = $client->describeUser([ 'InstanceId' => '<string>', // REQUIRED 'UserId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- UserId
-
- Required: Yes
- Type: string
The identifier of the user account.
Result Syntax
[ 'User' => [ 'Arn' => '<string>', 'DirectoryUserId' => '<string>', 'HierarchyGroupId' => '<string>', 'Id' => '<string>', 'IdentityInfo' => [ 'Email' => '<string>', 'FirstName' => '<string>', 'LastName' => '<string>', 'Mobile' => '<string>', 'SecondaryEmail' => '<string>', ], 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'PhoneConfig' => [ 'AfterContactWorkTimeLimit' => <integer>, 'AutoAccept' => true || false, 'DeskPhoneNumber' => '<string>', 'PhoneType' => 'SOFT_PHONE|DESK_PHONE', ], 'RoutingProfileId' => '<string>', 'SecurityProfileIds' => ['<string>', ...], 'Tags' => ['<string>', ...], 'Username' => '<string>', ], ]
Result Details
Members
- User
-
- Type: User structure
Information about the user account and configuration settings.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DescribeUserHierarchyGroup
$result = $client->describeUserHierarchyGroup
([/* ... */]); $promise = $client->describeUserHierarchyGroupAsync
([/* ... */]);
Describes the specified hierarchy group.
Parameter Syntax
$result = $client->describeUserHierarchyGroup([ 'HierarchyGroupId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- HierarchyGroupId
-
- Required: Yes
- Type: string
The identifier of the hierarchy group.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[ 'HierarchyGroup' => [ 'Arn' => '<string>', 'HierarchyPath' => [ 'LevelFive' => [ 'Arn' => '<string>', 'Id' => '<string>', 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', ], 'LevelFour' => [ 'Arn' => '<string>', 'Id' => '<string>', 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', ], 'LevelOne' => [ 'Arn' => '<string>', 'Id' => '<string>', 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', ], 'LevelThree' => [ 'Arn' => '<string>', 'Id' => '<string>', 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', ], 'LevelTwo' => [ 'Arn' => '<string>', 'Id' => '<string>', 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', ], ], 'Id' => '<string>', 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'LevelId' => '<string>', 'Name' => '<string>', 'Tags' => ['<string>', ...], ], ]
Result Details
Members
- HierarchyGroup
-
- Type: HierarchyGroup structure
Information about the hierarchy group.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DescribeUserHierarchyStructure
$result = $client->describeUserHierarchyStructure
([/* ... */]); $promise = $client->describeUserHierarchyStructureAsync
([/* ... */]);
Describes the hierarchy structure of the specified Amazon Connect instance.
Parameter Syntax
$result = $client->describeUserHierarchyStructure([ 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[ 'HierarchyStructure' => [ 'LevelFive' => [ 'Arn' => '<string>', 'Id' => '<string>', 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', ], 'LevelFour' => [ 'Arn' => '<string>', 'Id' => '<string>', 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', ], 'LevelOne' => [ 'Arn' => '<string>', 'Id' => '<string>', 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', ], 'LevelThree' => [ 'Arn' => '<string>', 'Id' => '<string>', 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', ], 'LevelTwo' => [ 'Arn' => '<string>', 'Id' => '<string>', 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', ], ], ]
Result Details
Members
- HierarchyStructure
-
- Type: HierarchyStructure structure
Information about the hierarchy structure.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DescribeView
$result = $client->describeView
([/* ... */]); $promise = $client->describeViewAsync
([/* ... */]);
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 Amazon Web Services managed views.
Parameter Syntax
$result = $client->describeView([ 'InstanceId' => '<string>', // REQUIRED 'ViewId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- ViewId
-
- Required: Yes
- Type: string
The ViewId of the view. This must be an ARN for Amazon Web Services managed views.
Result Syntax
[ 'View' => [ 'Arn' => '<string>', 'Content' => [ 'Actions' => ['<string>', ...], 'InputSchema' => '<string>', 'Template' => '<string>', ], 'CreatedTime' => <DateTime>, 'Description' => '<string>', 'Id' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', 'Status' => 'PUBLISHED|SAVED', 'Tags' => ['<string>', ...], 'Type' => 'CUSTOMER_MANAGED|AWS_MANAGED', 'Version' => <integer>, 'VersionDescription' => '<string>', 'ViewContentSha256' => '<string>', ], ]
Result Details
Members
- View
-
- Type: View structure
All view data is contained within the View object.
Errors
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- TooManyRequestsException:
Displayed when rate-related API limits are exceeded.
DescribeVocabulary
$result = $client->describeVocabulary
([/* ... */]); $promise = $client->describeVocabularyAsync
([/* ... */]);
Describes the specified vocabulary.
Parameter Syntax
$result = $client->describeVocabulary([ 'InstanceId' => '<string>', // REQUIRED 'VocabularyId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- VocabularyId
-
- Required: Yes
- Type: string
The identifier of the custom vocabulary.
Result Syntax
[ 'Vocabulary' => [ 'Arn' => '<string>', 'Content' => '<string>', 'FailureReason' => '<string>', 'Id' => '<string>', 'LanguageCode' => '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', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', 'State' => 'CREATION_IN_PROGRESS|ACTIVE|CREATION_FAILED|DELETE_IN_PROGRESS', 'Tags' => ['<string>', ...], ], ]
Result Details
Members
- Vocabulary
-
- Required: Yes
- Type: Vocabulary structure
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.
Errors
- InvalidRequestException:
The request is not valid.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ThrottlingException:
The throttling limit has been exceeded.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
DisassociateAnalyticsDataSet
$result = $client->disassociateAnalyticsDataSet
([/* ... */]); $promise = $client->disassociateAnalyticsDataSetAsync
([/* ... */]);
Removes the dataset ID associated with a given Amazon Connect instance.
Parameter Syntax
$result = $client->disassociateAnalyticsDataSet([ 'DataSetId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'TargetAccountId' => '<string>', ]);
Parameter Details
Members
- DataSetId
-
- Required: Yes
- Type: string
The identifier of the dataset to remove.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- TargetAccountId
-
- Type: string
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 Amazon Web Services account that has the Amazon Connect instance.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DisassociateApprovedOrigin
$result = $client->disassociateApprovedOrigin
([/* ... */]); $promise = $client->disassociateApprovedOriginAsync
([/* ... */]);
This API is in preview release for Amazon Connect and is subject to change.
Revokes access to integrated applications from Amazon Connect.
Parameter Syntax
$result = $client->disassociateApprovedOrigin([ 'InstanceId' => '<string>', // REQUIRED 'Origin' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Origin
-
- Required: Yes
- Type: string
The domain URL of the integrated application.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ThrottlingException:
The throttling limit has been exceeded.
DisassociateBot
$result = $client->disassociateBot
([/* ... */]); $promise = $client->disassociateBotAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->disassociateBot([ 'InstanceId' => '<string>', // REQUIRED 'LexBot' => [ 'LexRegion' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED ], 'LexV2Bot' => [ 'AliasArn' => '<string>', ], ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- LexBot
-
- Type: LexBot structure
Configuration information of an Amazon Lex bot.
- LexV2Bot
-
- Type: LexV2Bot structure
The Amazon Lex V2 bot to disassociate from the instance.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- ThrottlingException:
The throttling limit has been exceeded.
DisassociateFlow
$result = $client->disassociateFlow
([/* ... */]); $promise = $client->disassociateFlowAsync
([/* ... */]);
Disassociates a connect resource from a flow.
Parameter Syntax
$result = $client->disassociateFlow([ 'InstanceId' => '<string>', // REQUIRED 'ResourceId' => '<string>', // REQUIRED 'ResourceType' => 'SMS_PHONE_NUMBER|INBOUND_EMAIL|OUTBOUND_EMAIL|ANALYTICS_CONNECTOR|WHATSAPP_MESSAGING_PHONE_NUMBER', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- ResourceId
-
- Required: Yes
- Type: string
The identifier of the resource.
-
Amazon Web Services End User Messaging SMS phone number ARN when using
SMS_PHONE_NUMBER
-
Amazon Web Services End User Messaging Social phone number ARN when using
WHATSAPP_MESSAGING_PHONE_NUMBER
- ResourceType
-
- Required: Yes
- Type: string
A valid resource type.
Result Syntax
[]
Result Details
Errors
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ThrottlingException:
The throttling limit has been exceeded.
DisassociateInstanceStorageConfig
$result = $client->disassociateInstanceStorageConfig
([/* ... */]); $promise = $client->disassociateInstanceStorageConfigAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->disassociateInstanceStorageConfig([ 'AssociationId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'ResourceType' => '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 ]);
Parameter Details
Members
- AssociationId
-
- Required: Yes
- Type: string
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- ResourceType
-
- Required: Yes
- Type: string
A valid resource type.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ThrottlingException:
The throttling limit has been exceeded.
DisassociateLambdaFunction
$result = $client->disassociateLambdaFunction
([/* ... */]); $promise = $client->disassociateLambdaFunctionAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->disassociateLambdaFunction([ 'FunctionArn' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- FunctionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the Lambda function being disassociated.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance..
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ThrottlingException:
The throttling limit has been exceeded.
DisassociateLexBot
$result = $client->disassociateLexBot
([/* ... */]); $promise = $client->disassociateLexBotAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->disassociateLexBot([ 'BotName' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'LexRegion' => '<string>', // REQUIRED ]);
Parameter Details
Members
- BotName
-
- Required: Yes
- Type: string
The name of the Amazon Lex bot. Maximum character limit of 50.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- LexRegion
-
- Required: Yes
- Type: string
The Amazon Web Services Region in which the Amazon Lex bot has been created.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ThrottlingException:
The throttling limit has been exceeded.
DisassociatePhoneNumberContactFlow
$result = $client->disassociatePhoneNumberContactFlow
([/* ... */]); $promise = $client->disassociatePhoneNumberContactFlowAsync
([/* ... */]);
Removes the flow association from a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the 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 Amazon Web Services 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
.
Parameter Syntax
$result = $client->disassociatePhoneNumberContactFlow([ 'InstanceId' => '<string>', // REQUIRED 'PhoneNumberId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- PhoneNumberId
-
- Required: Yes
- Type: string
A unique identifier for the phone number.
Result Syntax
[]
Result Details
Errors
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
DisassociateQueueQuickConnects
$result = $client->disassociateQueueQuickConnects
([/* ... */]); $promise = $client->disassociateQueueQuickConnectsAsync
([/* ... */]);
This API is in preview release for Amazon Connect and is subject to change.
Disassociates a set of quick connects from a queue.
Parameter Syntax
$result = $client->disassociateQueueQuickConnects([ 'InstanceId' => '<string>', // REQUIRED 'QueueId' => '<string>', // REQUIRED 'QuickConnectIds' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- QueueId
-
- Required: Yes
- Type: string
The identifier for the queue.
- QuickConnectIds
-
- Required: Yes
- Type: Array of strings
The quick connects to disassociate from the queue.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DisassociateRoutingProfileQueues
$result = $client->disassociateRoutingProfileQueues
([/* ... */]); $promise = $client->disassociateRoutingProfileQueuesAsync
([/* ... */]);
Disassociates a set of queues from a routing profile.
Parameter Syntax
$result = $client->disassociateRoutingProfileQueues([ 'InstanceId' => '<string>', // REQUIRED 'QueueReferences' => [ // REQUIRED [ 'Channel' => 'VOICE|CHAT|TASK|EMAIL', // REQUIRED 'QueueId' => '<string>', // REQUIRED ], // ... ], 'RoutingProfileId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- QueueReferences
-
- Required: Yes
- Type: Array of RoutingProfileQueueReference structures
The queues to disassociate from this routing profile.
- RoutingProfileId
-
- Required: Yes
- Type: string
The identifier of the routing profile.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DisassociateSecurityKey
$result = $client->disassociateSecurityKey
([/* ... */]); $promise = $client->disassociateSecurityKeyAsync
([/* ... */]);
This API is in preview release for Amazon Connect and is subject to change.
Deletes the specified security key.
Parameter Syntax
$result = $client->disassociateSecurityKey([ 'AssociationId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AssociationId
-
- Required: Yes
- Type: string
The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[]
Result Details
Errors
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ThrottlingException:
The throttling limit has been exceeded.
DisassociateTrafficDistributionGroupUser
$result = $client->disassociateTrafficDistributionGroupUser
([/* ... */]); $promise = $client->disassociateTrafficDistributionGroupUserAsync
([/* ... */]);
Disassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created.
Parameter Syntax
$result = $client->disassociateTrafficDistributionGroupUser([ 'InstanceId' => '<string>', // REQUIRED 'TrafficDistributionGroupId' => '<string>', // REQUIRED 'UserId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- TrafficDistributionGroupId
-
- Required: Yes
- Type: string
The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.
- UserId
-
- Required: Yes
- Type: string
The identifier for the user. This can be the ID or the ARN of the user.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- ThrottlingException:
The throttling limit has been exceeded.
- ResourceNotFoundException:
The specified resource was not found.
- ResourceConflictException:
A resource already has that name.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DisassociateUserProficiencies
$result = $client->disassociateUserProficiencies
([/* ... */]); $promise = $client->disassociateUserProficienciesAsync
([/* ... */]);
Disassociates a set of proficiencies from a user.
Parameter Syntax
$result = $client->disassociateUserProficiencies([ 'InstanceId' => '<string>', // REQUIRED 'UserId' => '<string>', // REQUIRED 'UserProficiencies' => [ // REQUIRED [ 'AttributeName' => '<string>', // REQUIRED 'AttributeValue' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- UserId
-
- Required: Yes
- Type: string
The identifier of the user account.
- UserProficiencies
-
- Required: Yes
- Type: Array of UserProficiencyDisassociate structures
The proficiencies to disassociate from the user.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
DismissUserContact
$result = $client->dismissUserContact
([/* ... */]); $promise = $client->dismissUserContactAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->dismissUserContact([ 'ContactId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'UserId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ContactId
-
- Required: Yes
- Type: string
The identifier of the contact.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
- UserId
-
- Required: Yes
- Type: string
The identifier of the user account.
Result Syntax
[]
Result Details
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
GetAttachedFile
$result = $client->getAttachedFile
([/* ... */]); $promise = $client->getAttachedFileAsync
([/* ... */]);
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
.
Parameter Syntax
$result = $client->getAttachedFile([ 'AssociatedResourceArn' => '<string>', // REQUIRED 'FileId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'UrlExpiryInSeconds' => <integer>, ]);
Parameter Details
Members
- AssociatedResourceArn
-
- Required: Yes
- Type: string
- FileId
-
- Required: Yes
- Type: string
The unique identifier of the attached file resource.
- InstanceId
-
- Required: Yes
- Type: string
The unique identifier of the Amazon Connect instance.
- UrlExpiryInSeconds
-
- Type: int
Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.
Result Syntax
[ 'AssociatedResourceArn' => '<string>', 'CreatedBy' => [ 'AWSIdentityArn' => '<string>', 'ConnectUserArn' => '<string>', ], 'CreationTime' => '<string>', 'DownloadUrlMetadata' => [ 'Url' => '<string>', 'UrlExpiry' => '<string>', ], 'FileArn' => '<string>', 'FileId' => '<string>', 'FileName' => '<string>', 'FileSizeInBytes' => <integer>, 'FileStatus' => 'APPROVED|REJECTED|PROCESSING|FAILED', 'FileUseCaseType' => 'EMAIL_MESSAGE|ATTACHMENT', 'Tags' => ['<string>', ...], ]
Result Details
Members
- AssociatedResourceArn
-
- Type: string
The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource.
- CreatedBy
-
- Type: CreatedByInfo structure
Represents the identity that created the file.
- CreationTime
-
- Type: string
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
. - DownloadUrlMetadata
-
- Type: DownloadUrlMetadata structure
URL and expiry to be used when downloading the attached file.
- FileArn
-
- Type: string
The unique identifier of the attached file resource (ARN).
- FileId
-
- Type: string
The unique identifier of the attached file resource.
- FileName
-
- Type: string
A case-sensitive name of the attached file being uploaded.
- FileSizeInBytes
-
- Required: Yes
- Type: long (int|float)
The size of the attached file in bytes.
- FileStatus
-
- Type: string
The current status of the attached file.
- FileUseCaseType
-
- Type: string
The use case for the file.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource. For example,
{ "Tags": {"key1":"value1", "key2":"value2"} }
.
Errors
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- InvalidRequestException:
The request is not valid.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
GetContactAttributes
$result = $client->getContactAttributes
([/* ... */]); $promise = $client->getContactAttributesAsync
([/* ... */]);
Retrieves the contact attributes for the specified contact.
Parameter Syntax
$result = $client->getContactAttributes([ 'InitialContactId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InitialContactId
-
- Required: Yes
- Type: string
The identifier of the initial contact.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance.
Result Syntax
[ 'Attributes' => ['<string>', ...], ]
Result Details
Members
- Attributes
-
- Type: Associative array of custom strings keys (AttributeName) to strings
Information about the attributes.
Errors
- InvalidRequestException:
The request is not valid.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
GetCurrentMetricData
$result = $client->getCurrentMetricData
([/* ... */]); $promise = $client->getCurrentMetricDataAsync
([/* ... */]);
Gets the real-time metric data from the specified Amazon Connect instance.
For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Parameter Syntax
$result = $client->getCurrentMetricData([ 'CurrentMetrics' => [ // REQUIRED [ 'Name' => 'AGENTS_ONLINE|AGENTS_AVAILABLE|AGENTS_ON_CALL|AGENTS_NON_PRODUCTIVE|AGENTS_AFTER_CONTACT_WORK|AGENTS_ERROR|AGENTS_STAFFED|CONTACTS_IN_QUEUE|OLDEST_CONTACT_AGE|CONTACTS_SCHEDULED|AGENTS_ON_CONTACT|SLOTS_ACTIVE|SLOTS_AVAILABLE', 'Unit' => 'SECONDS|COUNT|PERCENT', ], // ... ], 'Filters' => [ // REQUIRED 'Channels' => ['<string>', ...], 'Queues' => ['<string>', ...], 'RoutingProfiles' => ['<string>', ...], 'RoutingStepExpressions' => ['<string>', ...], ], 'Groupings' => ['<string>', ...], 'InstanceId' => '<string>', // REQUIRED 'MaxResults' => <integer>, 'NextToken' => '<string>', 'SortCriteria' => [ [ 'SortByMetric' => 'AGENTS_ONLINE|AGENTS_AVAILABLE|AGENTS_ON_CALL|AGENTS_NON_PRODUCTIVE|AGENTS_AFTER_CONTACT_WORK|AGENTS_ERROR|AGENTS_STAFFED|CONTACTS_IN_QUEUE|OLDEST_CONTACT_AGE|CONTACTS_SCHEDULED|AGENTS_ON_CONTACT|SLOTS_ACTIVE|SLOTS_AVAILABLE', 'SortOrder' => 'ASCENDING|DESCENDING', ], // ... ], ]);
Parameter Details
Members
- CurrentMetrics
-
- Required: Yes
- Type: Array of CurrentMetric structures
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
- AGENTS_AFTER_CONTACT_WORK
-
Unit: COUNT
Name in real-time metrics report: ACW
- AGENTS_AVAILABLE
-
Unit: COUNT
Name in real-time metrics report: Available
- AGENTS_ERROR
-
Unit: COUNT
Name in real-time metrics report: Error
- AGENTS_NON_PRODUCTIVE
-
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
- AGENTS_ON_CALL
-
Unit: COUNT
Name in real-time metrics report: On contact
- AGENTS_ON_CONTACT
-
Unit: COUNT
Name in real-time metrics report: On contact
- AGENTS_ONLINE
-
Unit: COUNT
Name in real-time metrics report: Online
- AGENTS_STAFFED
-
Unit: COUNT
Name in real-time metrics report: Staffed
- CONTACTS_IN_QUEUE
-
Unit: COUNT
Name in real-time metrics report: In queue
- CONTACTS_SCHEDULED
-
Unit: COUNT
Name in real-time metrics report: Scheduled
- OLDEST_CONTACT_AGE
-
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
}The actual OLDEST_CONTACT_AGE 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, thenOLDEST_CONTACT_AGE
for this queue will be counted starting from 10, not 0.Name in real-time metrics report: Oldest
- SLOTS_ACTIVE
-
Unit: COUNT
Name in real-time metrics report: Active
- SLOTS_AVAILABLE
-
Unit: COUNT
Name in real-time metrics report: Availability
- Filters
-
- Required: Yes
- Type: Filters structure
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
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 the
RoutingStepExpression
filter, you need to pass exactly oneQueueId
. The filter is also case sensitive so when using theRoutingStepExpression
filter, grouping byROUTING_STEP_EXPRESSION
is required.Currently tagging is only supported on the resources that are passed in the filter.
- Groupings
-
- Type: Array of strings
The grouping applied to the metrics returned. For example, when grouped by
QUEUE
, the metrics returned apply to each queue rather than aggregated for all queues.-
If you group by
CHANNEL
, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported. -
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 metricsCONTACTS_SCHEDULED
,CONTACTS_IN_QUEUE
, andOLDEST_CONTACT_AGE
. -
If no
Grouping
is included in the request, a summary of metrics is returned. -
When using the
RoutingStepExpression
filter, group byROUTING_STEP_EXPRESSION
is required.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- MaxResults
-
- Type: int
The maximum number of results to return per page.
- NextToken
-
- Type: string
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.
- SortCriteria
-
- Type: Array of CurrentMetricSortCriteria structures
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
andSLOTS_AVAILABLE
is not supported.
Result Syntax
[ 'ApproximateTotalCount' => <integer>, 'DataSnapshotTime' => <DateTime>, 'MetricResults' => [ [ 'Collections' => [ [ 'Metric' => [ 'Name' => 'AGENTS_ONLINE|AGENTS_AVAILABLE|AGENTS_ON_CALL|AGENTS_NON_PRODUCTIVE|AGENTS_AFTER_CONTACT_WORK|AGENTS_ERROR|AGENTS_STAFFED|CONTACTS_IN_QUEUE|OLDEST_CONTACT_AGE|CONTACTS_SCHEDULED|AGENTS_ON_CONTACT|SLOTS_ACTIVE|SLOTS_AVAILABLE', 'Unit' => 'SECONDS|COUNT|PERCENT', ], 'Value' => <float>, ], // ... ], 'Dimensions' => [ 'Channel' => 'VOICE|CHAT|TASK|EMAIL', 'Queue' => [ 'Arn' => '<string>', 'Id' => '<string>', ], 'RoutingProfile' => [ 'Arn' => '<string>', 'Id' => '<string>', ], 'RoutingStepExpression' => '<string>', ], ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- ApproximateTotalCount
-
- Type: long (int|float)
The total count of the result, regardless of the current page size.
- DataSnapshotTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which the metrics were retrieved and cached for pagination.
- MetricResults
-
- Type: Array of CurrentMetricResult structures
Information about the real-time metrics.
- NextToken
-
- Type: string
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.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ThrottlingException:
The throttling limit has been exceeded.
- ResourceNotFoundException:
The specified resource was not found.
GetCurrentUserData
$result = $client->getCurrentUserData
([/* ... */]); $promise = $client->getCurrentUserDataAsync
([/* ... */]);
Gets the real-time active user data from the specified Amazon Connect instance.
Parameter Syntax
$result = $client->getCurrentUserData([ 'Filters' => [ // REQUIRED 'Agents' => ['<string>', ...], 'ContactFilter' => [ 'ContactStates' => ['<string>', ...], ], 'Queues' => ['<string>', ...], 'RoutingProfiles' => ['<string>', ...], 'UserHierarchyGroups' => ['<string>', ...], ], 'InstanceId' => '<string>', // REQUIRED 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- Filters
-
- Required: Yes
- Type: UserDataFilters structure
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.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- MaxResults
-
- Type: int
The maximum number of results to return per page.
- NextToken
-
- Type: string
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.
Result Syntax
[ 'ApproximateTotalCount' => <integer>, 'NextToken' => '<string>', 'UserDataList' => [ [ 'ActiveSlotsByChannel' => [<integer>, ...], 'AvailableSlotsByChannel' => [<integer>, ...], 'Contacts' => [ [ 'AgentContactState' => 'INCOMING|PENDING|CONNECTING|CONNECTED|CONNECTED_ONHOLD|MISSED|ERROR|ENDED|REJECTED', 'Channel' => 'VOICE|CHAT|TASK|EMAIL', 'ConnectedToAgentTimestamp' => <DateTime>, 'ContactId' => '<string>', 'InitiationMethod' => 'INBOUND|OUTBOUND|TRANSFER|QUEUE_TRANSFER|CALLBACK|API|DISCONNECT|MONITOR|EXTERNAL_OUTBOUND|WEBRTC_API|AGENT_REPLY|FLOW', 'Queue' => [ 'Arn' => '<string>', 'Id' => '<string>', ], 'StateStartTimestamp' => <DateTime>, ], // ... ], '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' => [<integer>, ...], 'NextStatus' => '<string>', 'RoutingProfile' => [ 'Arn' => '<string>', 'Id' => '<string>', ], 'Status' => [ 'StatusArn' => '<string>', 'StatusName' => '<string>', 'StatusStartTimestamp' => <DateTime>, ], 'User' => [ 'Arn' => '<string>', 'Id' => '<string>', ], ], // ... ], ]
Result Details
Members
- ApproximateTotalCount
-
- Type: long (int|float)
The total count of the result, regardless of the current page size.
- NextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
- UserDataList
-
- Type: Array of UserData structures
A list of the user data that is returned.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ThrottlingException:
The throttling limit has been exceeded.
- ResourceNotFoundException:
The specified resource was not found.
GetEffectiveHoursOfOperations
$result = $client->getEffectiveHoursOfOperations
([/* ... */]); $promise = $client->getEffectiveHoursOfOperationsAsync
([/* ... */]);
Get the hours of operations with the effective override applied.
Parameter Syntax
$result = $client->getEffectiveHoursOfOperations([ 'FromDate' => '<string>', // REQUIRED 'HoursOfOperationId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'ToDate' => '<string>', // REQUIRED ]);
Parameter Details
Members
- FromDate
-
- Required: Yes
- Type: string
The Date from when the hours of operation are listed.
- HoursOfOperationId
-
- Required: Yes
- Type: string
The identifier for the hours of operation.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance.
- ToDate
-
- Required: Yes
- Type: string
The Date until when the hours of operation are listed.
Result Syntax
[ 'EffectiveHoursOfOperationList' => [ [ 'Date' => '<string>', 'OperationalHours' => [ [ 'End' => [ 'Hours' => <integer>, 'Minutes' => <integer>, ], 'Start' => [ 'Hours' => <integer>, 'Minutes' => <integer>, ], ], // ... ], ], // ... ], 'TimeZone' => '<string>', ]
Result Details
Members
- EffectiveHoursOfOperationList
-
- Type: Array of EffectiveHoursOfOperations structures
Information about the effective hours of operations
- TimeZone
-
- Type: string
The time zone for the hours of operation.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
GetFederationToken
$result = $client->getFederationToken
([/* ... */]); $promise = $client->getFederationTokenAsync
([/* ... */]);
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.
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
Parameter Syntax
$result = $client->getFederationToken([ 'InstanceId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Result Syntax
[ 'Credentials' => [ 'AccessToken' => '<string>', 'AccessTokenExpiration' => <DateTime>, 'RefreshToken' => '<string>', 'RefreshTokenExpiration' => <DateTime>, ], 'SignInUrl' => '<string>', 'UserArn' => '<string>', 'UserId' => '<string>', ]
Result Details
Members
- Credentials
-
- Type: Credentials structure
The credentials to use for federation.
- SignInUrl
-
- Type: string
The URL to sign into the user's instance.
- UserArn
-
- Type: string
The Amazon Resource Name (ARN) of the user.
- UserId
-
- Type: string
The identifier for the user. This can be the ID or the ARN of the user.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- UserNotFoundException:
No user with the specified credentials was found in the Amazon Connect instance.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- DuplicateResourceException:
A resource with the specified name already exists.
GetFlowAssociation
$result = $client->getFlowAssociation
([/* ... */]); $promise = $client->getFlowAssociationAsync
([/* ... */]);
Retrieves the flow associated for a given resource.
Parameter Syntax
$result = $client->getFlowAssociation([ 'InstanceId' => '<string>', // REQUIRED 'ResourceId' => '<string>', // REQUIRED 'ResourceType' => 'SMS_PHONE_NUMBER|INBOUND_EMAIL|OUTBOUND_EMAIL|ANALYTICS_CONNECTOR|WHATSAPP_MESSAGING_PHONE_NUMBER', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- ResourceId
-
- Required: Yes
- Type: string
The identifier of the resource.
-
Amazon Web Services End User Messaging SMS phone number ARN when using
SMS_PHONE_NUMBER
-
Amazon Web Services End User Messaging Social phone number ARN when using
WHATSAPP_MESSAGING_PHONE_NUMBER
- ResourceType
-
- Required: Yes
- Type: string
A valid resource type.
Result Syntax
[ 'FlowId' => '<string>', 'ResourceId' => '<string>', 'ResourceType' => 'SMS_PHONE_NUMBER|INBOUND_EMAIL|OUTBOUND_EMAIL|ANALYTICS_CONNECTOR|WHATSAPP_MESSAGING_PHONE_NUMBER', ]
Result Details
Members
- FlowId
-
- Type: string
The identifier of the flow.
- ResourceId
-
- Type: string
The identifier of the resource.
- ResourceType
-
- Type: string
A valid resource type.
Errors
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ThrottlingException:
The throttling limit has been exceeded.
GetMetricData
$result = $client->getMetricData
([/* ... */]); $promise = $client->getMetricDataAsync
([/* ... */]);
Gets historical metric data from the specified Amazon Connect instance.
For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
We recommend using the GetMetricDataV2 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.
Parameter Syntax
$result = $client->getMetricData([ 'EndTime' => <integer || string || DateTime>, // REQUIRED 'Filters' => [ // REQUIRED 'Channels' => ['<string>', ...], 'Queues' => ['<string>', ...], 'RoutingProfiles' => ['<string>', ...], 'RoutingStepExpressions' => ['<string>', ...], ], 'Groupings' => ['<string>', ...], 'HistoricalMetrics' => [ // REQUIRED [ 'Name' => 'CONTACTS_QUEUED|CONTACTS_HANDLED|CONTACTS_ABANDONED|CONTACTS_CONSULTED|CONTACTS_AGENT_HUNG_UP_FIRST|CONTACTS_HANDLED_INCOMING|CONTACTS_HANDLED_OUTBOUND|CONTACTS_HOLD_ABANDONS|CONTACTS_TRANSFERRED_IN|CONTACTS_TRANSFERRED_OUT|CONTACTS_TRANSFERRED_IN_FROM_QUEUE|CONTACTS_TRANSFERRED_OUT_FROM_QUEUE|CONTACTS_MISSED|CALLBACK_CONTACTS_HANDLED|API_CONTACTS_HANDLED|OCCUPANCY|HANDLE_TIME|AFTER_CONTACT_WORK_TIME|QUEUED_TIME|ABANDON_TIME|QUEUE_ANSWER_TIME|HOLD_TIME|INTERACTION_TIME|INTERACTION_AND_HOLD_TIME|SERVICE_LEVEL', 'Statistic' => 'SUM|MAX|AVG', 'Threshold' => [ 'Comparison' => 'LT', 'ThresholdValue' => <float>, ], 'Unit' => 'SECONDS|COUNT|PERCENT', ], // ... ], 'InstanceId' => '<string>', // REQUIRED 'MaxResults' => <integer>, 'NextToken' => '<string>', 'StartTime' => <integer || string || DateTime>, // REQUIRED ]);
Parameter Details
Members
- EndTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- Filters
-
- Required: Yes
- Type: Filters structure
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. - Groupings
-
- Type: Array of strings
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.
- HistoricalMetrics
-
- Required: Yes
- Type: Array of HistoricalMetric structures
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 Historical Metrics Definitions in the Amazon Connect Administrator Guide.
This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).
- ABANDON_TIME
-
Unit: SECONDS
Statistic: AVG
- AFTER_CONTACT_WORK_TIME
-
Unit: SECONDS
Statistic: AVG
- API_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
- CALLBACK_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
- CONTACTS_ABANDONED
-
Unit: COUNT
Statistic: SUM
- CONTACTS_AGENT_HUNG_UP_FIRST
-
Unit: COUNT
Statistic: SUM
- CONTACTS_CONSULTED
-
Unit: COUNT
Statistic: SUM
- CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
- CONTACTS_HANDLED_INCOMING
-
Unit: COUNT
Statistic: SUM
- CONTACTS_HANDLED_OUTBOUND
-
Unit: COUNT
Statistic: SUM
- CONTACTS_HOLD_ABANDONS
-
Unit: COUNT
Statistic: SUM
- CONTACTS_MISSED
-
Unit: COUNT
Statistic: SUM
- CONTACTS_QUEUED
-
Unit: COUNT
Statistic: SUM
- CONTACTS_TRANSFERRED_IN
-
Unit: COUNT
Statistic: SUM
- CONTACTS_TRANSFERRED_IN_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
- CONTACTS_TRANSFERRED_OUT
-
Unit: COUNT
Statistic: SUM
- CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
- HANDLE_TIME
-
Unit: SECONDS
Statistic: AVG
- HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
- INTERACTION_AND_HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
- INTERACTION_TIME
-
Unit: SECONDS
Statistic: AVG
- OCCUPANCY
-
Unit: PERCENT
Statistic: AVG
- QUEUE_ANSWER_TIME
-
Unit: SECONDS
Statistic: AVG
- QUEUED_TIME
-
Unit: SECONDS
Statistic: MAX
- SERVICE_LEVEL
-
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: PERCENT
Statistic: AVG
Threshold: For
ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds. ForComparison
, you must enterLT
(for "Less than").
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- MaxResults
-
- Type: int
The maximum number of results to return per page.
- NextToken
-
- Type: string
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
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
Result Syntax
[ 'MetricResults' => [ [ 'Collections' => [ [ 'Metric' => [ 'Name' => 'CONTACTS_QUEUED|CONTACTS_HANDLED|CONTACTS_ABANDONED|CONTACTS_CONSULTED|CONTACTS_AGENT_HUNG_UP_FIRST|CONTACTS_HANDLED_INCOMING|CONTACTS_HANDLED_OUTBOUND|CONTACTS_HOLD_ABANDONS|CONTACTS_TRANSFERRED_IN|CONTACTS_TRANSFERRED_OUT|CONTACTS_TRANSFERRED_IN_FROM_QUEUE|CONTACTS_TRANSFERRED_OUT_FROM_QUEUE|CONTACTS_MISSED|CALLBACK_CONTACTS_HANDLED|API_CONTACTS_HANDLED|OCCUPANCY|HANDLE_TIME|AFTER_CONTACT_WORK_TIME|QUEUED_TIME|ABANDON_TIME|QUEUE_ANSWER_TIME|HOLD_TIME|INTERACTION_TIME|INTERACTION_AND_HOLD_TIME|SERVICE_LEVEL', 'Statistic' => 'SUM|MAX|AVG', 'Threshold' => [ 'Comparison' => 'LT', 'ThresholdValue' => <float>, ], 'Unit' => 'SECONDS|COUNT|PERCENT', ], 'Value' => <float>, ], // ... ], 'Dimensions' => [ 'Channel' => 'VOICE|CHAT|TASK|EMAIL', 'Queue' => [ 'Arn' => '<string>', 'Id' => '<string>', ], 'RoutingProfile' => [ 'Arn' => '<string>', 'Id' => '<string>', ], 'RoutingStepExpression' => '<string>', ], ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- MetricResults
-
- Type: Array of HistoricalMetricResult structures
Information about the historical metrics.
If no grouping is specified, a summary of metric data is returned.
- NextToken
-
- Type: string
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.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ThrottlingException:
The throttling limit has been exceeded.
- ResourceNotFoundException:
The specified resource was not found.
GetMetricDataV2
$result = $client->getMetricDataV2
([/* ... */]); $promise = $client->getMetricDataV2Async
([/* ... */]);
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2
offers more features than GetMetricData, 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 Historical metrics definitions in the Amazon Connect Administrator Guide.
Parameter Syntax
$result = $client->getMetricDataV2([ 'EndTime' => <integer || string || DateTime>, // REQUIRED 'Filters' => [ // REQUIRED [ 'FilterKey' => '<string>', 'FilterValues' => ['<string>', ...], ], // ... ], 'Groupings' => ['<string>', ...], 'Interval' => [ 'IntervalPeriod' => 'FIFTEEN_MIN|THIRTY_MIN|HOUR|DAY|WEEK|TOTAL', 'TimeZone' => '<string>', ], 'MaxResults' => <integer>, 'Metrics' => [ // REQUIRED [ 'MetricFilters' => [ [ 'MetricFilterKey' => '<string>', 'MetricFilterValues' => ['<string>', ...], 'Negate' => true || false, ], // ... ], 'Name' => '<string>', 'Threshold' => [ [ 'Comparison' => '<string>', 'ThresholdValue' => <float>, ], // ... ], ], // ... ], 'NextToken' => '<string>', 'ResourceArn' => '<string>', // REQUIRED 'StartTime' => <integer || string || DateTime>, // REQUIRED ]);
Parameter Details
Members
- EndTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
- Filters
-
- Required: Yes
- Type: Array of FilterV2 structures
The filters to apply to returned metrics. You can filter on the following resources:
-
Agents
-
Campaigns
-
Channels
-
Feature
-
Queues
-
Routing profiles
-
Routing step expression
-
User hierarchy groups
At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.
For metrics for outbound campaigns analytics, you can also use campaigns to satisfy at least one filter requirement.
To filter by phone number, see Create a historical metrics report in the Amazon Connect Administrator Guide.
Note the following limits:
-
Filter keys: A maximum of 5 filter keys are supported in a single request. Valid filter keys:
AGENT
|AGENT_HIERARCHY_LEVEL_ONE
|AGENT_HIERARCHY_LEVEL_TWO
|AGENT_HIERARCHY_LEVEL_THREE
|AGENT_HIERARCHY_LEVEL_FOUR
|AGENT_HIERARCHY_LEVEL_FIVE
|ANSWERING_MACHINE_DETECTION_STATUS
|BOT_ID
|BOT_ALIAS
|BOT_VERSION
|BOT_LOCALE
|BOT_INTENT_NAME
|CAMPAIGN
|CAMPAIGN_DELIVERY_EVENT_TYPE
|CASE_TEMPLATE_ARN
|CASE_STATUS
|CHANNEL
|contact/segmentAttributes/connect:Subtype
|DISCONNECT_REASON
|FEATURE
|FLOW_ACTION_ID
|FLOW_TYPE
|FLOWS_MODULE_RESOURCE_ID
|FLOWS_NEXT_RESOURCE_ID
|FLOWS_NEXT_RESOURCE_QUEUE_ID
|FLOWS_OUTCOME_TYPE
|FLOWS_RESOURCE_ID
|INITIATION_METHOD
|INVOKING_RESOURCE_PUBLISHED_TIMESTAMP
|INVOKING_RESOURCE_TYPE
|PARENT_FLOWS_RESOURCE_ID
|RESOURCE_PUBLISHED_TIMESTAMP
|ROUTING_PROFILE
|ROUTING_STEP_EXPRESSION
|QUEUE
|Q_CONNECT_ENABLED
| -
Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid
filterValue
for the CHANNEL filter key. They do not count towards limitation 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 3 channel filters.contact_lens_conversational_analytics
is a valid filterValue for theFEATURE
filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.connect:Chat
,connect:SMS
,connect:Telephony
, andconnect:WebRTC
are validfilterValue
examples (not exhaustive) for thecontact/segmentAttributes/connect:Subtype filter
key.ROUTING_STEP_EXPRESSION
is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is.Q_CONNECT_ENABLED
. TRUE and FALSE are the only valid filterValues for theQ_CONNECT_ENABLED
filter key.-
TRUE includes all contacts that had Amazon Q in Connect enabled as part of the flow.
-
FALSE includes all contacts that did not have Amazon Q in Connect enabled as part of the flow
This filter is available only for contact record-driven metrics.
Campaign ARNs are valid
filterValues
for theCAMPAIGN
filter key. -
- Groupings
-
- Type: Array of strings
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
|AGENT_HIERARCHY_LEVEL_ONE
|AGENT_HIERARCHY_LEVEL_TWO
|AGENT_HIERARCHY_LEVEL_THREE
|AGENT_HIERARCHY_LEVEL_FOUR
|AGENT_HIERARCHY_LEVEL_FIVE
|ANSWERING_MACHINE_DETECTION_STATUS
|BOT_ID
|BOT_ALIAS
|BOT_VERSION
|BOT_LOCALE
|BOT_INTENT_NAME
|CAMPAIGN
|CAMPAIGN_DELIVERY_EVENT_TYPE
|CASE_TEMPLATE_ARN
|CASE_STATUS
|CHANNEL
|contact/segmentAttributes/connect:Subtype
|DISCONNECT_REASON
|FLOWS_RESOURCE_ID
|FLOWS_MODULE_RESOURCE_ID
|FLOW_ACTION_ID
|FLOW_TYPE
|FLOWS_OUTCOME_TYPE
|INITIATION_METHOD
|INVOKING_RESOURCE_PUBLISHED_TIMESTAMP
|INVOKING_RESOURCE_TYPE
|PARENT_FLOWS_RESOURCE_ID
|Q_CONNECT_ENABLED
|QUEUE
|RESOURCE_PUBLISHED_TIMESTAMP
|ROUTING_PROFILE
|ROUTING_STEP_EXPRESSION
- Interval
-
- Type: IntervalDetails structure
The interval period and timezone to apply to returned metrics.
-
IntervalPeriod
: An aggregated grouping applied to request metrics. ValidIntervalPeriod
values are:FIFTEEN_MIN
|THIRTY_MIN
|HOUR
|DAY
|WEEK
|TOTAL
.For example, if
IntervalPeriod
is selectedTHIRTY_MIN
,StartTime
andEndTime
differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on theTOTAL
interval period.The following list describes restrictions on
StartTime
andEndTime
based on whichIntervalPeriod
is requested.-
FIFTEEN_MIN
: The difference betweenStartTime
andEndTime
must be less than 3 days. -
THIRTY_MIN
: The difference betweenStartTime
andEndTime
must be less than 3 days. -
HOUR
: The difference betweenStartTime
andEndTime
must be less than 3 days. -
DAY
: The difference betweenStartTime
andEndTime
must be less than 35 days. -
WEEK
: The difference betweenStartTime
andEndTime
must be less than 35 days. -
TOTAL
: The difference betweenStartTime
andEndTime
must be less than 35 days.
-
-
TimeZone
: The timezone applied to requested metrics.
- MaxResults
-
- Type: int
The maximum number of results to return per page.
- Metrics
-
- Required: Yes
- Type: Array of MetricV2 structures
The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator Guide.
- ABANDONMENT_RATE
-
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
- AGENT_ADHERENT_TIME
-
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherent time
- AGENT_ANSWER_RATE
-
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent answer rate
- AGENT_NON_ADHERENT_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Non-adherent time
- AGENT_NON_RESPONSE
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent non-response
- AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS
-
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.
- AGENT_OCCUPANCY
-
Unit: Percentage
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Occupancy
- AGENT_SCHEDULE_ADHERENCE
-
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Adherence
- AGENT_SCHEDULED_TIME
-
This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Scheduled time
- AVG_ABANDON_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue abandon time
- AVG_ACTIVE_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average active time
- AVG_AFTER_CONTACT_WORK_TIME
-
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
Feature is a valid filter but not a valid grouping.
- AVG_AGENT_CONNECTING_TIME
-
Unit: Seconds
Valid metric filter key:
INITIATION_METHOD
. For now, this metric only supports the following asINITIATION_METHOD
:INBOUND
|OUTBOUND
|CALLBACK
|API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Average agent API connecting time
The
Negate
key in metric-level filters is not applicable for this metric. - AVG_AGENT_PAUSE_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Average agent pause time
- AVG_BOT_CONVERSATION_TIME
-
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
- AVG_BOT_CONVERSATION_TURNS
-
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
- AVG_CASE_RELATED_CONTACTS
-
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average contacts per case
- AVG_CASE_RESOLUTION_TIME
-
Unit: Seconds
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Average case resolution time
- AVG_CONTACT_DURATION
-
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
Feature is a valid filter but not a valid grouping.
- AVG_CONVERSATION_DURATION
-
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
- AVG_DIALS_PER_MINUTE
-
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
- AVG_FLOW_TIME
-
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
- AVG_GREETING_TIME_AGENT
-
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
- AVG_HANDLE_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
UI name: Average handle time
Feature is a valid filter but not a valid grouping.
- AVG_HOLD_TIME
-
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
Feature is a valid filter but not a valid grouping.
- AVG_HOLD_TIME_ALL_CONTACTS
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
- AVG_HOLDS
-
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
Feature is a valid filter but not a valid grouping.
- AVG_INTERACTION_AND_HOLD_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
- AVG_INTERACTION_TIME
-
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
Feature is a valid filter but not a valid grouping.
- AVG_INTERRUPTIONS_AGENT
-
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
- AVG_INTERRUPTION_TIME_AGENT
-
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
- AVG_NON_TALK_TIME
-
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
- AVG_QUEUE_ANSWER_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average queue answer time
Feature is a valid filter but not a valid grouping.
- AVG_RESOLUTION_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Average resolution time
- AVG_TALK_TIME
-
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
- AVG_TALK_TIME_AGENT
-
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
- AVG_TALK_TIME_CUSTOMER
-
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
- AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION
-
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
- BOT_CONVERSATIONS_COMPLETED
-
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
- BOT_INTENTS_COMPLETED
-
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
- CAMPAIGN_CONTACTS_ABANDONED_AFTER_X
-
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. ForComparison
, you must enterGT
(for Greater than).UI name: Campaign contacts abandoned after X
- CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE
-
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. ForComparison
, you must enterGT
(for Greater than). - CAMPAIGN_INTERACTIONS
-
This metric is available only for outbound campaigns using the email delivery mode.
Unit: Count
Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE
Valid groupings and filters: Campaign
UI name: Campaign interactions
- CAMPAIGN_SEND_ATTEMPTS
-
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
- CASES_CREATED
-
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases created
- CONTACTS_CREATED
-
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
Feature is a valid filter but not a valid grouping.
- CONTACTS_HANDLED
-
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: API contacts handled
Feature is a valid filter but not a valid grouping.
- CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT
-
Unit: Count
Valid metric filter key:
INITIATION_METHOD
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
- CONTACTS_HOLD_ABANDONS
-
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
- CONTACTS_ON_HOLD_AGENT_DISCONNECT
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold agent disconnect
- CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts hold customer disconnect
- CONTACTS_PUT_ON_HOLD
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts put on hold
- CONTACTS_TRANSFERRED_OUT_EXTERNAL
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out external
- CONTACTS_TRANSFERRED_OUT_INTERNAL
-
Unit: Percent
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contacts transferred out internal
- CONTACTS_QUEUED
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Contacts queued
- CONTACTS_QUEUED_BY_ENQUEUE
-
Unit: Count
Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
UI name: Contacts queued (enqueue timestamp)
- CONTACTS_REMOVED_FROM_QUEUE_IN_X
-
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. ForComparison
, you can useLT
(for "Less than") orLTE
(for "Less than equal"). - CONTACTS_RESOLVED_IN_X
-
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. ForComparison
, you can useLT
(for "Less than") orLTE
(for "Less than equal").UI name: Contacts resolved in X
- CONTACTS_TRANSFERRED_OUT
-
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
Feature is a valid filter but not a valid grouping.
- CONTACTS_TRANSFERRED_OUT_BY_AGENT
-
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
- CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
-
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
- CURRENT_CASES
-
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Current cases
- DELIVERY_ATTEMPTS
-
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
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_ATTEMPT_DISPOSITION_RATE
-
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
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.
- FLOWS_OUTCOME
-
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
- FLOWS_STARTED
-
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
- HUMAN_ANSWERED_CALLS
-
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
- MAX_FLOW_TIME
-
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
- MAX_QUEUED_TIME
-
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
- MIN_FLOW_TIME
-
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
- PERCENT_BOT_CONVERSATIONS_OUTCOME
-
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
- PERCENT_BOT_INTENTS_OUTCOME
-
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
- PERCENT_CASES_FIRST_CONTACT_RESOLVED
-
Unit: Percent
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved on first contact
- PERCENT_CONTACTS_STEP_EXPIRED
-
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_CONTACTS_STEP_JOINED
-
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_FLOWS_OUTCOME
-
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.
The
FLOWS_OUTCOME_TYPE
is not a valid grouping. - PERCENT_NON_TALK_TIME
-
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
- PERCENT_TALK_TIME
-
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
- PERCENT_TALK_TIME_AGENT
-
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
- PERCENT_TALK_TIME_CUSTOMER
-
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
- REOPENED_CASE_ACTIONS
-
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases reopened
- RESOLVED_CASE_ACTIONS
-
Unit: Count
Required filter key: CASE_TEMPLATE_ARN
Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
UI name: Cases resolved
- SERVICE_LEVEL
-
You can include up to 20 SERVICE_LEVEL 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. ForComparison
, you can useLT
(for "Less than") orLTE
(for "Less than equal").UI name: Service level X
- STEP_CONTACTS_QUEUED
-
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_AFTER_CONTACT_WORK_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: After contact work time
- SUM_CONNECTING_TIME_AGENT
-
Unit: Seconds
Valid metric filter key:
INITIATION_METHOD
. This metric only supports the following filter keys asINITIATION_METHOD
:INBOUND
|OUTBOUND
|CALLBACK
|API
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent API connecting time
The
Negate
key in metric-level filters is not applicable for this metric. - CONTACTS_ABANDONED
-
Unit: Count
Metric filter:
-
Valid values:
API
|Incoming
|Outbound
|Transfer
|Callback
|Queue_Transfer
|Disconnect
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect
UI name: Contact abandoned
-
- SUM_CONTACTS_ABANDONED_IN_X
-
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. ForComparison
, you can useLT
(for "Less than") orLTE
(for "Less than equal").UI name: Contacts abandoned in X seconds
- SUM_CONTACTS_ANSWERED_IN_X
-
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. ForComparison
, you can useLT
(for "Less than") orLTE
(for "Less than equal").UI name: Contacts answered in X seconds
- SUM_CONTACT_FLOW_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact flow time
- SUM_CONTACT_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent on contact time
- SUM_CONTACTS_DISCONNECTED
-
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
- SUM_ERROR_STATUS_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Error status time
- SUM_HANDLE_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Contact handle time
- SUM_HOLD_TIME
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Customer hold time
- SUM_IDLE_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Agent idle time
- SUM_INTERACTION_AND_HOLD_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect
UI name: Agent interaction and hold time
- SUM_INTERACTION_TIME
-
Unit: Seconds
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
UI name: Agent interaction time
- SUM_NON_PRODUCTIVE_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Non-Productive Time
- SUM_ONLINE_TIME_AGENT
-
Unit: Seconds
Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
UI name: Online time
- SUM_RETRY_CALLBACK_ATTEMPTS
-
Unit: Count
Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect
UI name: Callback attempts
- NextToken
-
- Type: string
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.
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource. This includes the
instanceId
an Amazon Connect instance. - StartTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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.
Result Syntax
[ 'MetricResults' => [ [ 'Collections' => [ [ 'Metric' => [ 'MetricFilters' => [ [ 'MetricFilterKey' => '<string>', 'MetricFilterValues' => ['<string>', ...], 'Negate' => true || false, ], // ... ], 'Name' => '<string>', 'Threshold' => [ [ 'Comparison' => '<string>', 'ThresholdValue' => <float>, ], // ... ], ], 'Value' => <float>, ], // ... ], 'Dimensions' => ['<string>', ...], 'MetricInterval' => [ 'EndTime' => <DateTime>, 'Interval' => 'FIFTEEN_MIN|THIRTY_MIN|HOUR|DAY|WEEK|TOTAL', 'StartTime' => <DateTime>, ], ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- MetricResults
-
- Type: Array of MetricResultV2 structures
Information about the metrics requested in the API request If no grouping is specified, a summary of metric data is returned.
- NextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ThrottlingException:
The throttling limit has been exceeded.
- ResourceNotFoundException:
The specified resource was not found.
GetPromptFile
$result = $client->getPromptFile
([/* ... */]); $promise = $client->getPromptFileAsync
([/* ... */]);
Gets the prompt file.
Parameter Syntax
$result = $client->getPromptFile([ 'InstanceId' => '<string>', // REQUIRED 'PromptId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- PromptId
-
- Required: Yes
- Type: string
A unique identifier for the prompt.
Result Syntax
[ 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'PromptPresignedUrl' => '<string>', ]
Result Details
Members
- LastModifiedRegion
-
- Type: string
The Amazon Web Services Region where this resource was last modified.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when this resource was last modified.
- PromptPresignedUrl
-
- Type: string
A generated URL to the prompt that can be given to an unauthorized user so they can access the prompt in S3.
Errors
- InvalidParameterException:
One or more of the specified parameters are not valid.
- InvalidRequestException:
The request is not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
GetTaskTemplate
$result = $client->getTaskTemplate
([/* ... */]); $promise = $client->getTaskTemplateAsync
([/* ... */]);
Gets details about a specific task template in the specified Amazon Connect instance.
Parameter Syntax
$result = $client->getTaskTemplate([ 'InstanceId' => '<string>', // REQUIRED 'SnapshotVersion' => '<string>', 'TaskTemplateId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- SnapshotVersion
-
- Type: string
The system generated version of a task template that is associated with a task, when the task is created.
- TaskTemplateId
-
- Required: Yes
- Type: string
A unique identifier for the task template.
Result Syntax
[ 'Arn' => '<string>', 'Constraints' => [ 'InvisibleFields' => [ [ 'Id' => [ 'Name' => '<string>', ], ], // ... ], 'ReadOnlyFields' => [ [ 'Id' => [ 'Name' => '<string>', ], ], // ... ], 'RequiredFields' => [ [ 'Id' => [ 'Name' => '<string>', ], ], // ... ], ], 'ContactFlowId' => '<string>', 'CreatedTime' => <DateTime>, 'Defaults' => [ 'DefaultFieldValues' => [ [ 'DefaultValue' => '<string>', 'Id' => [ 'Name' => '<string>', ], ], // ... ], ], 'Description' => '<string>', 'Fields' => [ [ 'Description' => '<string>', 'Id' => [ 'Name' => '<string>', ], 'SingleSelectOptions' => ['<string>', ...], 'Type' => 'NAME|DESCRIPTION|SCHEDULED_TIME|QUICK_CONNECT|URL|NUMBER|TEXT|TEXT_AREA|DATE_TIME|BOOLEAN|SINGLE_SELECT|EMAIL|SELF_ASSIGN|EXPIRY_DURATION', ], // ... ], 'Id' => '<string>', 'InstanceId' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', 'SelfAssignFlowId' => '<string>', 'Status' => 'ACTIVE|INACTIVE', 'Tags' => ['<string>', ...], ]
Result Details
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN).
- Constraints
-
- Type: TaskTemplateConstraints structure
Constraints that are applicable to the fields listed.
- ContactFlowId
-
- Type: string
The identifier of the flow that runs by default when a task is created by referencing this template.
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the task template was created.
- Defaults
-
- Type: TaskTemplateDefaults structure
The default values for fields when a task is created by referencing this template.
- Description
-
- Type: string
The description of the task template.
- Fields
-
- Type: Array of TaskTemplateField structures
Fields that are part of the template.
- Id
-
- Required: Yes
- Type: string
A unique identifier for the task template.
- InstanceId
-
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- LastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the task template was last modified.
- Name
-
- Required: Yes
- Type: string
The name of the task template.
- SelfAssignFlowId
-
- Type: string
ContactFlowId for the flow that will be run if this template is used to create a self-assigned task
- Status
-
- Type: string
Marks a template as
ACTIVE
orINACTIVE
for a task to refer to it. Tasks can only be created fromACTIVE
templates. If a template is marked asINACTIVE
, then a task that refers to this template cannot be created. - Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
GetTrafficDistribution
$result = $client->getTrafficDistribution
([/* ... */]); $promise = $client->getTrafficDistributionAsync
([/* ... */]);
Retrieves the current traffic distribution for a given traffic distribution group.
Parameter Syntax
$result = $client->getTrafficDistribution([ 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'AgentConfig' => [ 'Distributions' => [ [ 'Percentage' => <integer>, 'Region' => '<string>', ], // ... ], ], 'Arn' => '<string>', 'Id' => '<string>', 'SignInConfig' => [ 'Distributions' => [ [ 'Enabled' => true || false, 'Region' => '<string>', ], // ... ], ], 'TelephonyConfig' => [ 'Distributions' => [ [ 'Percentage' => <integer>, 'Region' => '<string>', ], // ... ], ], ]
Result Details
Members
- AgentConfig
-
- Type: AgentConfig structure
The distribution of agents between the instance and its replica(s).
- Arn
-
- Type: string
The Amazon Resource Name (ARN) of the traffic distribution group.
- Id
-
- Type: string
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.
- SignInConfig
-
- Type: SignInConfig structure
The distribution that determines which Amazon Web Services Regions should be used to sign in agents in to both the instance and its replica(s).
- TelephonyConfig
-
- Type: TelephonyConfig structure
The distribution of traffic between the instance and its replicas.
Errors
- InvalidRequestException:
The request is not valid.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- ThrottlingException:
The throttling limit has been exceeded.
ImportPhoneNumber
$result = $client->importPhoneNumber
([/* ... */]); $promise = $client->importPhoneNumberAsync
([/* ... */]);
Imports a claimed phone number from an external service, such as Amazon Web Services End User Messaging, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created.
Call the DescribePhoneNumber 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 Amazon Web Services Support ticket.
Parameter Syntax
$result = $client->importPhoneNumber([ 'ClientToken' => '<string>', 'InstanceId' => '<string>', // REQUIRED 'PhoneNumberDescription' => '<string>', 'SourcePhoneNumberArn' => '<string>', // REQUIRED 'Tags' => ['<string>', ...], ]);
Parameter Details
Members
- ClientToken
-
- Type: string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- PhoneNumberDescription
-
- Type: string
The description of the phone number.
- SourcePhoneNumberArn
-
- Required: Yes
- Type: string
The claimed phone number ARN being imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number to import from Amazon Web Services End User Messaging.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Result Syntax
[ 'PhoneNumberArn' => '<string>', 'PhoneNumberId' => '<string>', ]
Result Details
Members
- PhoneNumberArn
-
- Type: string
The Amazon Resource Name (ARN) of the phone number.
- PhoneNumberId
-
- Type: string
A unique identifier for the phone number.
Errors
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- IdempotencyException:
An entity with the same name already exists.
- AccessDeniedException:
You do not have sufficient permissions to perform this action.
ListAgentStatuses
$result = $client->listAgentStatuses
([/* ... */]); $promise = $client->listAgentStatusesAsync
([/* ... */]);
This API is in preview release for Amazon Connect and is subject to change.
Lists agent statuses.
Parameter Syntax
$result = $client->listAgentStatuses([ 'AgentStatusTypes' => ['<string>', ...], 'InstanceId' => '<string>', // REQUIRED 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- AgentStatusTypes
-
- Type: Array of strings
Available agent status types.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- MaxResults
-
- Type: int
The maximum number of results to return per page.
- NextToken
-
- Type: string
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.
Result Syntax
[ 'AgentStatusSummaryList' => [ [ 'Arn' => '<string>', 'Id' => '<string>', 'LastModifiedRegion' => '<string>', 'LastModifiedTime' => <DateTime>, 'Name' => '<string>', 'Type' => 'ROUTABLE|CUSTOM|OFFLINE', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- AgentStatusSummaryList
-
- Type: Array of AgentStatusSummary structures
A summary of agent statuses.
- NextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
ListAnalyticsDataAssociations
$result = $client->listAnalyticsDataAssociations
([/* ... */]); $promise = $client->listAnalyticsDataAssociationsAsync
([/* ... */]);
Lists the association status of requested dataset ID for a given Amazon Connect instance.
Parameter Syntax
$result = $client->listAnalyticsDataAssociations([ 'DataSetId' => '<string>', 'InstanceId' => '<string>', // REQUIRED 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- DataSetId
-
- Type: string
The identifier of the dataset to get the association status.
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- MaxResults
-
- Type: int
The maximum number of results to return per page.
- NextToken
-
- Type: string
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.
Result Syntax
[ 'NextToken' => '<string>', 'Results' => [ [ 'DataSetId' => '<string>', 'ResourceShareArn' => '<string>', 'ResourceShareId' => '<string>', 'TargetAccountId' => '<string>', ], // ... ], ]
Result Details
Members
- NextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
- Results
-
- Type: Array of AnalyticsDataAssociationResult structures
An array of successful results:
DataSetId
,TargetAccountId
,ResourceShareId
,ResourceShareArn
. This is a paginated API, sonextToken
is given if there are more results to be returned.
Errors
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ResourceNotFoundException:
The specified resource was not found.
- ThrottlingException:
The throttling limit has been exceeded.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
ListApprovedOrigins
$result = $client->listApprovedOrigins
([/* ... */]); $promise = $client->listApprovedOriginsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listApprovedOrigins([ 'InstanceId' => '<string>', // REQUIRED 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- InstanceId
-
- Required: Yes
- Type: string
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- MaxResults
-
- Type: int
The maximum number of results to return per page.
- NextToken
-
- Type: string
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.
Result Syntax
[ 'NextToken' => '<string>', 'Origins' => ['<string>', ...], ]
Result Details
Members
- NextToken
-
- Type: string
If there are additional results, this is the token for the next set of results.
- Origins
-
- Type: Array of strings
The approved origins.
Errors
- ResourceNotFoundException:
The specified resource was not found.
- InternalServiceException:
Request processing failed because of an error or failure with the service.
- InvalidRequestException:
The request is not valid.
- InvalidParameterException:
One or more of the specified parameters are not valid.
- ThrottlingException:
The throttling limit has been exceeded.
ListAssociatedContacts
$result = $client->listAssociatedContacts
([/* ... */]); $promise = $client->listAssociatedContactsAsync
([/* ... */]);
Provides information about contact tree, a list of associated contacts with a unique identifier.
Parameter Syntax
$result = $client->listAssociatedContacts([ 'ContactId' => '<string>', // REQUIRED 'InstanceId' => '<string>', // REQUIRED 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- ContactId
-
- Required: Yes
- Type: string