cloudworker-proxy
Version:
An api gateway for cloudflare workers
818 lines • 93.9 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Connect extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Connect.Types.ClientConfiguration)
config: Config & Connect.Types.ClientConfiguration;
/**
* Associates a set of queues with a routing profile.
*/
associateRoutingProfileQueues(params: Connect.Types.AssociateRoutingProfileQueuesRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Associates a set of queues with a routing profile.
*/
associateRoutingProfileQueues(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates a contact flow for the specified Amazon Connect instance.
*/
createContactFlow(params: Connect.Types.CreateContactFlowRequest, callback?: (err: AWSError, data: Connect.Types.CreateContactFlowResponse) => void): Request<Connect.Types.CreateContactFlowResponse, AWSError>;
/**
* Creates a contact flow for the specified Amazon Connect instance.
*/
createContactFlow(callback?: (err: AWSError, data: Connect.Types.CreateContactFlowResponse) => void): Request<Connect.Types.CreateContactFlowResponse, AWSError>;
/**
* Creates a new routing profile.
*/
createRoutingProfile(params: Connect.Types.CreateRoutingProfileRequest, callback?: (err: AWSError, data: Connect.Types.CreateRoutingProfileResponse) => void): Request<Connect.Types.CreateRoutingProfileResponse, AWSError>;
/**
* Creates a new routing profile.
*/
createRoutingProfile(callback?: (err: AWSError, data: Connect.Types.CreateRoutingProfileResponse) => void): Request<Connect.Types.CreateRoutingProfileResponse, AWSError>;
/**
* Creates a user account for the specified Amazon Connect instance. For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.
*/
createUser(params: Connect.Types.CreateUserRequest, callback?: (err: AWSError, data: Connect.Types.CreateUserResponse) => void): Request<Connect.Types.CreateUserResponse, AWSError>;
/**
* Creates a user account for the specified Amazon Connect instance. For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.
*/
createUser(callback?: (err: AWSError, data: Connect.Types.CreateUserResponse) => void): Request<Connect.Types.CreateUserResponse, AWSError>;
/**
* 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.
*/
deleteUser(params: Connect.Types.DeleteUserRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
deleteUser(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Describes the specified contact flow.
*/
describeContactFlow(params: Connect.Types.DescribeContactFlowRequest, callback?: (err: AWSError, data: Connect.Types.DescribeContactFlowResponse) => void): Request<Connect.Types.DescribeContactFlowResponse, AWSError>;
/**
* Describes the specified contact flow.
*/
describeContactFlow(callback?: (err: AWSError, data: Connect.Types.DescribeContactFlowResponse) => void): Request<Connect.Types.DescribeContactFlowResponse, AWSError>;
/**
* Describes the specified routing profile.
*/
describeRoutingProfile(params: Connect.Types.DescribeRoutingProfileRequest, callback?: (err: AWSError, data: Connect.Types.DescribeRoutingProfileResponse) => void): Request<Connect.Types.DescribeRoutingProfileResponse, AWSError>;
/**
* Describes the specified routing profile.
*/
describeRoutingProfile(callback?: (err: AWSError, data: Connect.Types.DescribeRoutingProfileResponse) => void): Request<Connect.Types.DescribeRoutingProfileResponse, AWSError>;
/**
* Describes the specified user account. You can find the instance ID in the 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.
*/
describeUser(params: Connect.Types.DescribeUserRequest, callback?: (err: AWSError, data: Connect.Types.DescribeUserResponse) => void): Request<Connect.Types.DescribeUserResponse, AWSError>;
/**
* Describes the specified user account. You can find the instance ID in the 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.
*/
describeUser(callback?: (err: AWSError, data: Connect.Types.DescribeUserResponse) => void): Request<Connect.Types.DescribeUserResponse, AWSError>;
/**
* Describes the specified hierarchy group.
*/
describeUserHierarchyGroup(params: Connect.Types.DescribeUserHierarchyGroupRequest, callback?: (err: AWSError, data: Connect.Types.DescribeUserHierarchyGroupResponse) => void): Request<Connect.Types.DescribeUserHierarchyGroupResponse, AWSError>;
/**
* Describes the specified hierarchy group.
*/
describeUserHierarchyGroup(callback?: (err: AWSError, data: Connect.Types.DescribeUserHierarchyGroupResponse) => void): Request<Connect.Types.DescribeUserHierarchyGroupResponse, AWSError>;
/**
* Describes the hierarchy structure of the specified Amazon Connect instance.
*/
describeUserHierarchyStructure(params: Connect.Types.DescribeUserHierarchyStructureRequest, callback?: (err: AWSError, data: Connect.Types.DescribeUserHierarchyStructureResponse) => void): Request<Connect.Types.DescribeUserHierarchyStructureResponse, AWSError>;
/**
* Describes the hierarchy structure of the specified Amazon Connect instance.
*/
describeUserHierarchyStructure(callback?: (err: AWSError, data: Connect.Types.DescribeUserHierarchyStructureResponse) => void): Request<Connect.Types.DescribeUserHierarchyStructureResponse, AWSError>;
/**
* Disassociates a set of queues from a routing profile.
*/
disassociateRoutingProfileQueues(params: Connect.Types.DisassociateRoutingProfileQueuesRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Disassociates a set of queues from a routing profile.
*/
disassociateRoutingProfileQueues(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Retrieves the contact attributes for the specified contact.
*/
getContactAttributes(params: Connect.Types.GetContactAttributesRequest, callback?: (err: AWSError, data: Connect.Types.GetContactAttributesResponse) => void): Request<Connect.Types.GetContactAttributesResponse, AWSError>;
/**
* Retrieves the contact attributes for the specified contact.
*/
getContactAttributes(callback?: (err: AWSError, data: Connect.Types.GetContactAttributesResponse) => void): Request<Connect.Types.GetContactAttributesResponse, AWSError>;
/**
* 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.
*/
getCurrentMetricData(params: Connect.Types.GetCurrentMetricDataRequest, callback?: (err: AWSError, data: Connect.Types.GetCurrentMetricDataResponse) => void): Request<Connect.Types.GetCurrentMetricDataResponse, AWSError>;
/**
* 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.
*/
getCurrentMetricData(callback?: (err: AWSError, data: Connect.Types.GetCurrentMetricDataResponse) => void): Request<Connect.Types.GetCurrentMetricDataResponse, AWSError>;
/**
* Retrieves a token for federation.
*/
getFederationToken(params: Connect.Types.GetFederationTokenRequest, callback?: (err: AWSError, data: Connect.Types.GetFederationTokenResponse) => void): Request<Connect.Types.GetFederationTokenResponse, AWSError>;
/**
* Retrieves a token for federation.
*/
getFederationToken(callback?: (err: AWSError, data: Connect.Types.GetFederationTokenResponse) => void): Request<Connect.Types.GetFederationTokenResponse, AWSError>;
/**
* 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.
*/
getMetricData(params: Connect.Types.GetMetricDataRequest, callback?: (err: AWSError, data: Connect.Types.GetMetricDataResponse) => void): Request<Connect.Types.GetMetricDataResponse, AWSError>;
/**
* 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.
*/
getMetricData(callback?: (err: AWSError, data: Connect.Types.GetMetricDataResponse) => void): Request<Connect.Types.GetMetricDataResponse, AWSError>;
/**
* Provides information about the contact flows for the specified Amazon Connect instance. For more information about contact flows, see Contact Flows in the Amazon Connect Administrator Guide.
*/
listContactFlows(params: Connect.Types.ListContactFlowsRequest, callback?: (err: AWSError, data: Connect.Types.ListContactFlowsResponse) => void): Request<Connect.Types.ListContactFlowsResponse, AWSError>;
/**
* Provides information about the contact flows for the specified Amazon Connect instance. For more information about contact flows, see Contact Flows in the Amazon Connect Administrator Guide.
*/
listContactFlows(callback?: (err: AWSError, data: Connect.Types.ListContactFlowsResponse) => void): Request<Connect.Types.ListContactFlowsResponse, AWSError>;
/**
* Provides information about the hours of operation for the specified Amazon Connect instance. For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.
*/
listHoursOfOperations(params: Connect.Types.ListHoursOfOperationsRequest, callback?: (err: AWSError, data: Connect.Types.ListHoursOfOperationsResponse) => void): Request<Connect.Types.ListHoursOfOperationsResponse, AWSError>;
/**
* Provides information about the hours of operation for the specified Amazon Connect instance. For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.
*/
listHoursOfOperations(callback?: (err: AWSError, data: Connect.Types.ListHoursOfOperationsResponse) => void): Request<Connect.Types.ListHoursOfOperationsResponse, AWSError>;
/**
* Provides information about the phone numbers for the specified Amazon Connect instance. For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
*/
listPhoneNumbers(params: Connect.Types.ListPhoneNumbersRequest, callback?: (err: AWSError, data: Connect.Types.ListPhoneNumbersResponse) => void): Request<Connect.Types.ListPhoneNumbersResponse, AWSError>;
/**
* Provides information about the phone numbers for the specified Amazon Connect instance. For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
*/
listPhoneNumbers(callback?: (err: AWSError, data: Connect.Types.ListPhoneNumbersResponse) => void): Request<Connect.Types.ListPhoneNumbersResponse, AWSError>;
/**
* Provides information about the prompts for the specified Amazon Connect instance.
*/
listPrompts(params: Connect.Types.ListPromptsRequest, callback?: (err: AWSError, data: Connect.Types.ListPromptsResponse) => void): Request<Connect.Types.ListPromptsResponse, AWSError>;
/**
* Provides information about the prompts for the specified Amazon Connect instance.
*/
listPrompts(callback?: (err: AWSError, data: Connect.Types.ListPromptsResponse) => void): Request<Connect.Types.ListPromptsResponse, AWSError>;
/**
* Provides information about the queues for the specified Amazon Connect instance. For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.
*/
listQueues(params: Connect.Types.ListQueuesRequest, callback?: (err: AWSError, data: Connect.Types.ListQueuesResponse) => void): Request<Connect.Types.ListQueuesResponse, AWSError>;
/**
* Provides information about the queues for the specified Amazon Connect instance. For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.
*/
listQueues(callback?: (err: AWSError, data: Connect.Types.ListQueuesResponse) => void): Request<Connect.Types.ListQueuesResponse, AWSError>;
/**
* List the queues associated with a routing profile.
*/
listRoutingProfileQueues(params: Connect.Types.ListRoutingProfileQueuesRequest, callback?: (err: AWSError, data: Connect.Types.ListRoutingProfileQueuesResponse) => void): Request<Connect.Types.ListRoutingProfileQueuesResponse, AWSError>;
/**
* List the queues associated with a routing profile.
*/
listRoutingProfileQueues(callback?: (err: AWSError, data: Connect.Types.ListRoutingProfileQueuesResponse) => void): Request<Connect.Types.ListRoutingProfileQueuesResponse, AWSError>;
/**
* Provides summary information about the routing profiles for the specified Amazon Connect instance. For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.
*/
listRoutingProfiles(params: Connect.Types.ListRoutingProfilesRequest, callback?: (err: AWSError, data: Connect.Types.ListRoutingProfilesResponse) => void): Request<Connect.Types.ListRoutingProfilesResponse, AWSError>;
/**
* Provides summary information about the routing profiles for the specified Amazon Connect instance. For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.
*/
listRoutingProfiles(callback?: (err: AWSError, data: Connect.Types.ListRoutingProfilesResponse) => void): Request<Connect.Types.ListRoutingProfilesResponse, AWSError>;
/**
* Provides summary information about the security profiles for the specified Amazon Connect instance. For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.
*/
listSecurityProfiles(params: Connect.Types.ListSecurityProfilesRequest, callback?: (err: AWSError, data: Connect.Types.ListSecurityProfilesResponse) => void): Request<Connect.Types.ListSecurityProfilesResponse, AWSError>;
/**
* Provides summary information about the security profiles for the specified Amazon Connect instance. For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.
*/
listSecurityProfiles(callback?: (err: AWSError, data: Connect.Types.ListSecurityProfilesResponse) => void): Request<Connect.Types.ListSecurityProfilesResponse, AWSError>;
/**
* Lists the tags for the specified resource. For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
*/
listTagsForResource(params: Connect.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Connect.Types.ListTagsForResourceResponse) => void): Request<Connect.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the tags for the specified resource. For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
*/
listTagsForResource(callback?: (err: AWSError, data: Connect.Types.ListTagsForResourceResponse) => void): Request<Connect.Types.ListTagsForResourceResponse, AWSError>;
/**
* Provides summary information about the hierarchy groups for the specified Amazon Connect instance. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
*/
listUserHierarchyGroups(params: Connect.Types.ListUserHierarchyGroupsRequest, callback?: (err: AWSError, data: Connect.Types.ListUserHierarchyGroupsResponse) => void): Request<Connect.Types.ListUserHierarchyGroupsResponse, AWSError>;
/**
* Provides summary information about the hierarchy groups for the specified Amazon Connect instance. For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
*/
listUserHierarchyGroups(callback?: (err: AWSError, data: Connect.Types.ListUserHierarchyGroupsResponse) => void): Request<Connect.Types.ListUserHierarchyGroupsResponse, AWSError>;
/**
* Provides summary information about the users for the specified Amazon Connect instance.
*/
listUsers(params: Connect.Types.ListUsersRequest, callback?: (err: AWSError, data: Connect.Types.ListUsersResponse) => void): Request<Connect.Types.ListUsersResponse, AWSError>;
/**
* Provides summary information about the users for the specified Amazon Connect instance.
*/
listUsers(callback?: (err: AWSError, data: Connect.Types.ListUsersResponse) => void): Request<Connect.Types.ListUsersResponse, AWSError>;
/**
* When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call. Only voice recordings are supported at this time.
*/
resumeContactRecording(params: Connect.Types.ResumeContactRecordingRequest, callback?: (err: AWSError, data: Connect.Types.ResumeContactRecordingResponse) => void): Request<Connect.Types.ResumeContactRecordingResponse, AWSError>;
/**
* When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call. Only voice recordings are supported at this time.
*/
resumeContactRecording(callback?: (err: AWSError, data: Connect.Types.ResumeContactRecordingResponse) => void): Request<Connect.Types.ResumeContactRecordingResponse, AWSError>;
/**
* Initiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service. When a new chat contact is successfully created, clients need to subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS. A 429 error occurs in two situations: API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception from the API Gateway. The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException. For more information about how chat works, see Chat in the Amazon Connect Administrator Guide.
*/
startChatContact(params: Connect.Types.StartChatContactRequest, callback?: (err: AWSError, data: Connect.Types.StartChatContactResponse) => void): Request<Connect.Types.StartChatContactResponse, AWSError>;
/**
* Initiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service. When a new chat contact is successfully created, clients need to subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS. A 429 error occurs in two situations: API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception from the API Gateway. The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException. For more information about how chat works, see Chat in the Amazon Connect Administrator Guide.
*/
startChatContact(callback?: (err: AWSError, data: Connect.Types.StartChatContactResponse) => void): Request<Connect.Types.StartChatContactResponse, AWSError>;
/**
* This API starts recording the contact when the agent joins the call. StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording. You can use this API to override the recording behavior configured in the Set recording behavior block. Only voice recordings are supported at this time.
*/
startContactRecording(params: Connect.Types.StartContactRecordingRequest, callback?: (err: AWSError, data: Connect.Types.StartContactRecordingResponse) => void): Request<Connect.Types.StartContactRecordingResponse, AWSError>;
/**
* This API starts recording the contact when the agent joins the call. StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording. You can use this API to override the recording behavior configured in the Set recording behavior block. Only voice recordings are supported at this time.
*/
startContactRecording(callback?: (err: AWSError, data: Connect.Types.StartContactRecordingResponse) => void): Request<Connect.Types.StartContactRecordingResponse, AWSError>;
/**
* This API places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact flow that's specified (in ContactFlowId). Agents are not involved in initiating the outbound API (that is, dialing the contact). If the contact flow places an outbound call to a contact, and then puts the contact in queue, that's when the call is routed to the agent, like any other inbound case. There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails. UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
*/
startOutboundVoiceContact(params: Connect.Types.StartOutboundVoiceContactRequest, callback?: (err: AWSError, data: Connect.Types.StartOutboundVoiceContactResponse) => void): Request<Connect.Types.StartOutboundVoiceContactResponse, AWSError>;
/**
* This API places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact flow that's specified (in ContactFlowId). Agents are not involved in initiating the outbound API (that is, dialing the contact). If the contact flow places an outbound call to a contact, and then puts the contact in queue, that's when the call is routed to the agent, like any other inbound case. There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails. UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
*/
startOutboundVoiceContact(callback?: (err: AWSError, data: Connect.Types.StartOutboundVoiceContactResponse) => void): Request<Connect.Types.StartOutboundVoiceContactResponse, AWSError>;
/**
* Ends the specified contact.
*/
stopContact(params: Connect.Types.StopContactRequest, callback?: (err: AWSError, data: Connect.Types.StopContactResponse) => void): Request<Connect.Types.StopContactResponse, AWSError>;
/**
* Ends the specified contact.
*/
stopContact(callback?: (err: AWSError, data: Connect.Types.StopContactResponse) => void): Request<Connect.Types.StopContactResponse, AWSError>;
/**
* When a contact is being recorded, this API stops recording the call. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording. Only voice recordings are supported at this time.
*/
stopContactRecording(params: Connect.Types.StopContactRecordingRequest, callback?: (err: AWSError, data: Connect.Types.StopContactRecordingResponse) => void): Request<Connect.Types.StopContactRecordingResponse, AWSError>;
/**
* When a contact is being recorded, this API stops recording the call. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording. Only voice recordings are supported at this time.
*/
stopContactRecording(callback?: (err: AWSError, data: Connect.Types.StopContactRecordingResponse) => void): Request<Connect.Types.StopContactRecordingResponse, AWSError>;
/**
* When a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording. The period of time that the recording is suspended is filled with silence in the final recording. Only voice recordings are supported at this time.
*/
suspendContactRecording(params: Connect.Types.SuspendContactRecordingRequest, callback?: (err: AWSError, data: Connect.Types.SuspendContactRecordingResponse) => void): Request<Connect.Types.SuspendContactRecordingResponse, AWSError>;
/**
* When a contact is being recorded, this API suspends recording the call. For example, you might suspend the call recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording. The period of time that the recording is suspended is filled with silence in the final recording. Only voice recordings are supported at this time.
*/
suspendContactRecording(callback?: (err: AWSError, data: Connect.Types.SuspendContactRecordingResponse) => void): Request<Connect.Types.SuspendContactRecordingResponse, AWSError>;
/**
* Adds the specified tags to the specified resource. The supported resource type is users. For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
*/
tagResource(params: Connect.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds the specified tags to the specified resource. The supported resource type is users. For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
*/
tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes the specified tags from the specified resource.
*/
untagResource(params: Connect.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes the specified tags from the specified resource.
*/
untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates or updates the contact attributes associated with the specified contact. You can add or update attributes for both ongoing and completed contacts. For example, you can update the customer's name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or identifying abusive callers. Contact attributes are available in Amazon Connect for 24 months, and are then deleted. Important: You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.
*/
updateContactAttributes(params: Connect.Types.UpdateContactAttributesRequest, callback?: (err: AWSError, data: Connect.Types.UpdateContactAttributesResponse) => void): Request<Connect.Types.UpdateContactAttributesResponse, AWSError>;
/**
* Creates or updates the contact attributes associated with the specified contact. You can add or update attributes for both ongoing and completed contacts. For example, you can update the customer's name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or identifying abusive callers. Contact attributes are available in Amazon Connect for 24 months, and are then deleted. Important: You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.
*/
updateContactAttributes(callback?: (err: AWSError, data: Connect.Types.UpdateContactAttributesResponse) => void): Request<Connect.Types.UpdateContactAttributesResponse, AWSError>;
/**
* Updates the specified contact flow.
*/
updateContactFlowContent(params: Connect.Types.UpdateContactFlowContentRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the specified contact flow.
*/
updateContactFlowContent(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* The name of the contact flow.
*/
updateContactFlowName(params: Connect.Types.UpdateContactFlowNameRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* The name of the contact flow.
*/
updateContactFlowName(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
*/
updateRoutingProfileConcurrency(params: Connect.Types.UpdateRoutingProfileConcurrencyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.
*/
updateRoutingProfileConcurrency(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the default outbound queue of a routing profile.
*/
updateRoutingProfileDefaultOutboundQueue(params: Connect.Types.UpdateRoutingProfileDefaultOutboundQueueRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the default outbound queue of a routing profile.
*/
updateRoutingProfileDefaultOutboundQueue(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided.
*/
updateRoutingProfileName(params: Connect.Types.UpdateRoutingProfileNameRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided.
*/
updateRoutingProfileName(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the properties associated with a set of queues for a routing profile.
*/
updateRoutingProfileQueues(params: Connect.Types.UpdateRoutingProfileQueuesRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the properties associated with a set of queues for a routing profile.
*/
updateRoutingProfileQueues(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Assigns the specified hierarchy group to the specified user.
*/
updateUserHierarchy(params: Connect.Types.UpdateUserHierarchyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Assigns the specified hierarchy group to the specified user.
*/
updateUserHierarchy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the identity information for the specified user. Someone with the ability to invoke UpdateUserIndentityInfo can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. We strongly recommend limiting who has the ability to invoke UpdateUserIndentityInfo. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.
*/
updateUserIdentityInfo(params: Connect.Types.UpdateUserIdentityInfoRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the identity information for the specified user. Someone with the ability to invoke UpdateUserIndentityInfo can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. We strongly recommend limiting who has the ability to invoke UpdateUserIndentityInfo. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.
*/
updateUserIdentityInfo(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the phone configuration settings for the specified user.
*/
updateUserPhoneConfig(params: Connect.Types.UpdateUserPhoneConfigRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the phone configuration settings for the specified user.
*/
updateUserPhoneConfig(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Assigns the specified routing profile to the specified user.
*/
updateUserRoutingProfile(params: Connect.Types.UpdateUserRoutingProfileRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Assigns the specified routing profile to the specified user.
*/
updateUserRoutingProfile(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Assigns the specified security profiles to the specified user.
*/
updateUserSecurityProfiles(params: Connect.Types.UpdateUserSecurityProfilesRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Assigns the specified security profiles to the specified user.
*/
updateUserSecurityProfiles(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
}
declare namespace Connect {
export type ARN = string;
export type AfterContactWorkTimeLimit = number;
export type AgentFirstName = string;
export type AgentLastName = string;
export type AgentUsername = string;
export interface AssociateRoutingProfileQueuesRequest {
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
/**
* The identifier of the routing profile.
*/
RoutingProfileId: RoutingProfileId;
/**
* The queues to associate with this routing profile.
*/
QueueConfigs: RoutingProfileQueueConfigList;
}
export type AttributeName = string;
export type AttributeValue = string;
export type Attributes = {[key: string]: AttributeValue};
export type AutoAccept = boolean;
export type Channel = "VOICE"|"CHAT"|string;
export type Channels = Channel[];
export type ChatContent = string;
export type ChatContentType = string;
export interface ChatMessage {
/**
* The type of the content. Supported types are text/plain.
*/
ContentType: ChatContentType;
/**
* The content of the chat message.
*/
Content: ChatContent;
}
export type ClientToken = string;
export type Comparison = "LT"|string;
export type Concurrency = number;
export interface ContactFlow {
/**
* The Amazon Resource Name (ARN) of the contact flow.
*/
Arn?: ARN;
/**
* The identifier of the contact flow.
*/
Id?: ContactFlowId;
/**
* The name of the contact flow.
*/
Name?: ContactFlowName;
/**
* The type of the contact flow. For descriptions of the available types, see Choose a Contact Flow Type in the Amazon Connect Administrator Guide.
*/
Type?: ContactFlowType;
/**
* The description of the contact flow.
*/
Description?: ContactFlowDescription;
/**
* The content of the contact flow.
*/
Content?: ContactFlowContent;
/**
* One or more tags.
*/
Tags?: TagMap;
}
export type ContactFlowContent = string;
export type ContactFlowDescription = string;
export type ContactFlowId = string;
export type ContactFlowName = string;
export interface ContactFlowSummary {
/**
* The identifier of the contact flow.
*/
Id?: ContactFlowId;
/**
* The Amazon Resource Name (ARN) of the contact flow.
*/
Arn?: ARN;
/**
* The name of the contact flow.
*/
Name?: ContactFlowName;
/**
* The type of contact flow.
*/
ContactFlowType?: ContactFlowType;
}
export type ContactFlowSummaryList = ContactFlowSummary[];
export type ContactFlowType = "CONTACT_FLOW"|"CUSTOMER_QUEUE"|"CUSTOMER_HOLD"|"CUSTOMER_WHISPER"|"AGENT_HOLD"|"AGENT_WHISPER"|"OUTBOUND_WHISPER"|"AGENT_TRANSFER"|"QUEUE_TRANSFER"|string;
export type ContactFlowTypes = ContactFlowType[];
export type ContactId = string;
export interface CreateContactFlowRequest {
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
/**
* The name of the contact flow.
*/
Name: ContactFlowName;
/**
* The type of the contact flow. For descriptions of the available types, see Choose a Contact Flow Type in the Amazon Connect Administrator Guide.
*/
Type: ContactFlowType;
/**
* The description of the contact flow.
*/
Description?: ContactFlowDescription;
/**
* The content of the contact flow.
*/
Content: ContactFlowContent;
/**
* One or more tags.
*/
Tags?: TagMap;
}
export interface CreateContactFlowResponse {
/**
* The identifier of the contact flow.
*/
ContactFlowId?: ContactFlowId;
/**
* The Amazon Resource Name (ARN) of the contact flow.
*/
ContactFlowArn?: ARN;
}
export interface CreateRoutingProfileRequest {
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
/**
* The name of the routing profile. Must not be more than 127 characters.
*/
Name: RoutingProfileName;
/**
* Description of the routing profile. Must not be more than 250 characters.
*/
Description: RoutingProfileDescription;
/**
* The default outbound queue for the routing profile.
*/
DefaultOutboundQueueId: QueueId;
/**
* The inbound queues associated with the routing profile. If no queue is added, the agent can only make outbound calls.
*/
QueueConfigs?: RoutingProfileQueueConfigList;
/**
* The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.
*/
MediaConcurrencies: MediaConcurrencies;
/**
* One or more tags.
*/
Tags?: TagMap;
}
export interface CreateRoutingProfileResponse {
/**
* The Amazon Resource Name (ARN) of the routing profile.
*/
RoutingProfileArn?: ARN;
/**
* The identifier of the routing profile.
*/
RoutingProfileId?: RoutingProfileId;
}
export interface CreateUserRequest {
/**
* 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: AgentUsername;
/**
* 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.
*/
Password?: Password;
/**
* The information about the identity of the user.
*/
IdentityInfo?: UserIdentityInfo;
/**
* The phone settings for the user.
*/
PhoneConfig: UserPhoneConfig;
/**
* 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.
*/
DirectoryUserId?: DirectoryUserId;
/**
* The identifier of the security profile for the user.
*/
SecurityProfileIds: SecurityProfileIds;
/**
* The identifier of the routing profile for the user.
*/
RoutingProfileId: RoutingProfileId;
/**
* The identifier of the hierarchy group for the user.
*/
HierarchyGroupId?: HierarchyGroupId;
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
/**
* One or more tags.
*/
Tags?: TagMap;
}
export interface CreateUserResponse {
/**
* The identifier of the user account.
*/
UserId?: UserId;
/**
* The Amazon Resource Name (ARN) of the user account.
*/
UserArn?: ARN;
}
export interface Credentials {
/**
* An access token generated for a federated user to access Amazon Connect.
*/
AccessToken?: SecurityToken;
/**
* A token generated with an expiration time for the session a user is logged in to Amazon Connect.
*/
AccessTokenExpiration?: timestamp;
/**
* Renews a token generated for a user to access the Amazon Connect instance.
*/
RefreshToken?: SecurityToken;
/**
* Renews the expiration timer for a generated token.
*/
RefreshTokenExpiration?: timestamp;
}
export interface CurrentMetric {
/**
* The name of the metric.
*/
Name?: CurrentMetricName;
/**
* The unit for the metric.
*/
Unit?: Unit;
}
export interface CurrentMetricData {
/**
* Information about the metric.
*/
Metric?: CurrentMetric;
/**
* The value of the metric.
*/
Value?: Value;
}
export type CurrentMetricDataCollections = CurrentMetricData[];
export type CurrentMetricName = "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"|string;
export interface CurrentMetricResult {
/**
* The dimensions for the metrics.
*/
Dimensions?: Dimensions;
/**
* The set of metrics.
*/
Collections?: CurrentMetricDataCollections;
}
export type CurrentMetricResults = CurrentMetricResult[];
export type CurrentMetrics = CurrentMetric[];
export type Delay = number;
export interface DeleteUserRequest {
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
/**
* The identifier of the user.
*/
UserId: UserId;
}
export interface DescribeContactFlowRequest {
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
/**
* The identifier of the contact flow.
*/
ContactFlowId: ContactFlowId;
}
export interface DescribeContactFlowResponse {
/**
* Information about the contact flow.
*/
ContactFlow?: ContactFlow;
}
export interface DescribeRoutingProfileRequest {
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
/**
* The identifier of the routing profile.
*/
RoutingProfileId: RoutingProfileId;
}
export interface DescribeRoutingProfileResponse {
/**
* The routing profile.
*/
RoutingProfile?: RoutingProfile;
}
export interface DescribeUserHierarchyGroupRequest {
/**
* The identifier of the hierarchy group.
*/
HierarchyGroupId: HierarchyGroupId;
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
}
export interface DescribeUserHierarchyGroupResponse {
/**
* Information about the hierarchy group.
*/
HierarchyGroup?: HierarchyGroup;
}
export interface DescribeUserHierarchyStructureRequest {
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
}
export interface DescribeUserHierarchyStructureResponse {
/**
* Information about the hierarchy structure.
*/
HierarchyStructure?: HierarchyStructure;
}
export interface DescribeUserRequest {
/**
* The identifier of the user account.
*/
UserId: UserId;
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
}
export interface DescribeUserResponse {
/**
* Information about the user account and configuration settings.
*/
User?: User;
}
export interface Dimensions {
/**
* Information about the queue for which metrics are returned.
*/
Queue?: QueueReference;
/**
* The channel used for grouping and filters.
*/
Channel?: Channel;
}
export type DirectoryUserId = string;
export interface DisassociateRoutingProfileQueuesRequest {
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
/**
* The identifier of the routing profile.
*/
RoutingProfileId: RoutingProfileId;
/**
* The queues to disassociate from this routing profile.
*/
QueueReferences: RoutingProfileQueueReferenceList;
}
export type DisplayName = string;
export type Email = string;
export interface Filters {
/**
* The queues to use to filter the metrics. You can specify up to 100 queues per request.
*/
Queues?: Queues;
/**
* The channel to use to filter the metrics.
*/
Channels?: Channels;
}
export interface GetContactAttributesRequest {
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
/**
* The identifier of the initial contact.
*/
InitialContactId: ContactId;
}
export interface GetContactAttributesResponse {
/**
* Information about the attributes.
*/
Attributes?: Attributes;
}
export interface GetCurrentMetricDataRequest {
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
/**
* 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. Both VOICE and CHAT channels are supported.
*/
Filters: Filters;
/**
* The groupi