universal-s3
Version:
Universal S3 SDK for JavaScript, available for Node.js backends
1,145 lines • 53.4 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';
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;
/**
* Creates a user account for the specified Amazon Connect instance.
*/
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.
*/
createUser(callback?: (err: AWSError, data: Connect.Types.CreateUserResponse) => void): Request<Connect.Types.CreateUserResponse, AWSError>;
/**
* Deletes a user account from the specified Amazon Connect instance.
*/
deleteUser(params: Connect.Types.DeleteUserRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a user account from the specified Amazon Connect instance.
*/
deleteUser(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Describes the specified user account.
*/
describeUser(params: Connect.Types.DescribeUserRequest, callback?: (err: AWSError, data: Connect.Types.DescribeUserResponse) => void): Request<Connect.Types.DescribeUserResponse, AWSError>;
/**
* Describes the specified user account.
*/
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>;
/**
* 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 more information, see Real-time Metrics Reports 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 more information, see Real-time Metrics Reports 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 more information, see Historical Metrics Reports 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 more information, see Historical Metrics Reports 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.
*/
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.
*/
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.
*/
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.
*/
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.
*/
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.
*/
listPhoneNumbers(callback?: (err: AWSError, data: Connect.Types.ListPhoneNumbersResponse) => void): Request<Connect.Types.ListPhoneNumbersResponse, AWSError>;
/**
* Provides information about the queues for the specified Amazon Connect instance.
*/
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.
*/
listQueues(callback?: (err: AWSError, data: Connect.Types.ListQueuesResponse) => void): Request<Connect.Types.ListQueuesResponse, AWSError>;
/**
* Provides summary information about the routing profiles for the specified Amazon Connect instance.
*/
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.
*/
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.
*/
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.
*/
listSecurityProfiles(callback?: (err: AWSError, data: Connect.Types.ListSecurityProfilesResponse) => void): Request<Connect.Types.ListSecurityProfilesResponse, AWSError>;
/**
* Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
*/
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.
*/
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>;
/**
* Initiates a contact flow to place an outbound call to a customer. There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.
*/
startOutboundVoiceContact(params: Connect.Types.StartOutboundVoiceContactRequest, callback?: (err: AWSError, data: Connect.Types.StartOutboundVoiceContactResponse) => void): Request<Connect.Types.StartOutboundVoiceContactResponse, AWSError>;
/**
* Initiates a contact flow to place an outbound call to a customer. There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.
*/
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>;
/**
* 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>;
/**
* 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.
*/
updateUserIdentityInfo(params: Connect.Types.UpdateUserIdentityInfoRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the identity information for the specified user.
*/
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 type AttributeName = string;
export type AttributeValue = string;
export type Attributes = {[key: string]: AttributeValue};
export type AutoAccept = boolean;
export type Channel = "VOICE"|string;
export type Channels = Channel[];
export type ClientToken = string;
export type Comparison = "LT"|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 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;
}
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"|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 interface DeleteUserRequest {
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
/**
* The identifier of the user.
*/
UserId: UserId;
}
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 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. The only supported channel is VOICE.
*/
Filters: Filters;
/**
* 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. The only supported channel is VOICE. If no Grouping is included in the request, a summary of metrics is returned.
*/
Groupings?: Groupings;
/**
* The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available: AGENTS_AFTER_CONTACT_WORK Unit: COUNT AGENTS_AVAILABLE Unit: COUNT AGENTS_ERROR Unit: COUNT AGENTS_NON_PRODUCTIVE Unit: COUNT AGENTS_ON_CALL Unit: COUNT AGENTS_ONLINE Unit: COUNT AGENTS_STAFFED Unit: COUNT CONTACTS_IN_QUEUE Unit: COUNT CONTACTS_SCHEDULED Unit: COUNT OLDEST_CONTACT_AGE Unit: SECONDS
*/
CurrentMetrics: CurrentMetrics;
/**
* 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.
*/
NextToken?: NextToken;
/**
* The maximimum number of results to return per page.
*/
MaxResults?: MaxResult100;
}
export interface GetCurrentMetricDataResponse {
/**
* 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.
*/
NextToken?: NextToken;
/**
* Information about the real-time metrics.
*/
MetricResults?: CurrentMetricResults;
/**
* The time at which the metrics were retrieved and cached for pagination.
*/
DataSnapshotTime?: timestamp;
}
export interface GetFederationTokenRequest {
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
}
export interface GetFederationTokenResponse {
/**
* The credentials to use for federation.
*/
Credentials?: Credentials;
}
export interface GetMetricDataRequest {
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
/**
* 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.
*/
StartTime: timestamp;
/**
* 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.
*/
EndTime: timestamp;
/**
* 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. The only supported channel is VOICE.
*/
Filters: Filters;
/**
* 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. The only supported grouping is QUEUE. If no grouping is specified, a summary of metrics for all queues is returned.
*/
Groupings?: Groupings;
/**
* The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available: 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 Unit: PERCENT Statistic: AVG Threshold: Only "Less than" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600
*/
HistoricalMetrics: HistoricalMetrics;
/**
* 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.
*/
NextToken?: NextToken;
/**
* The maximimum number of results to return per page.
*/
MaxResults?: MaxResult100;
}
export interface GetMetricDataResponse {
/**
* 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.
*/
NextToken?: NextToken;
/**
* Information about the historical metrics. If no grouping is specified, a summary of metric data is returned.
*/
MetricResults?: HistoricalMetricResults;
}
export type Grouping = "QUEUE"|"CHANNEL"|string;
export type Groupings = Grouping[];
export interface HierarchyGroup {
/**
* The identifier of the hierarchy group.
*/
Id?: HierarchyGroupId;
/**
* The Amazon Resource Name (ARN) of the hierarchy group.
*/
Arn?: ARN;
/**
* The name of the hierarchy group.
*/
Name?: HierarchyGroupName;
/**
* The identifier of the level in the hierarchy group.
*/
LevelId?: HierarchyLevelId;
/**
* Information about the levels in the hierarchy group.
*/
HierarchyPath?: HierarchyPath;
}
export type HierarchyGroupId = string;
export type HierarchyGroupName = string;
export interface HierarchyGroupSummary {
/**
* The identifier of the hierarchy group.
*/
Id?: HierarchyGroupId;
/**
* The Amazon Resource Name (ARN) of the hierarchy group.
*/
Arn?: ARN;
/**
* The name of the hierarchy group.
*/
Name?: HierarchyGroupName;
}
export type HierarchyGroupSummaryList = HierarchyGroupSummary[];
export interface HierarchyLevel {
/**
* The identifier of the hierarchy level.
*/
Id?: HierarchyLevelId;
/**
* The Amazon Resource Name (ARN) of the hierarchy level.
*/
Arn?: ARN;
/**
* The name of the hierarchy level.
*/
Name?: HierarchyLevelName;
}
export type HierarchyLevelId = string;
export type HierarchyLevelName = string;
export interface HierarchyPath {
/**
* Information about level one.
*/
LevelOne?: HierarchyGroupSummary;
/**
* Information about level two.
*/
LevelTwo?: HierarchyGroupSummary;
/**
* Information about level three.
*/
LevelThree?: HierarchyGroupSummary;
/**
* Information about level four.
*/
LevelFour?: HierarchyGroupSummary;
/**
* Information about level five.
*/
LevelFive?: HierarchyGroupSummary;
}
export interface HierarchyStructure {
/**
* Information about level one.
*/
LevelOne?: HierarchyLevel;
/**
* Information about level two.
*/
LevelTwo?: HierarchyLevel;
/**
* Information about level three.
*/
LevelThree?: HierarchyLevel;
/**
* Information about level four.
*/
LevelFour?: HierarchyLevel;
/**
* Information about level five.
*/
LevelFive?: HierarchyLevel;
}
export interface HistoricalMetric {
/**
* The name of the metric.
*/
Name?: HistoricalMetricName;
/**
* The threshold for the metric, used with service level metrics.
*/
Threshold?: Threshold;
/**
* The statistic for the metric.
*/
Statistic?: Statistic;
/**
* The unit for the metric.
*/
Unit?: Unit;
}
export interface HistoricalMetricData {
/**
* Information about the metric.
*/
Metric?: HistoricalMetric;
/**
* The value of the metric.
*/
Value?: Value;
}
export type HistoricalMetricDataCollections = HistoricalMetricData[];
export type HistoricalMetricName = "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"|string;
export interface HistoricalMetricResult {
/**
* The dimension for the metrics.
*/
Dimensions?: Dimensions;
/**
* The set of metrics.
*/
Collections?: HistoricalMetricDataCollections;
}
export type HistoricalMetricResults = HistoricalMetricResult[];
export type HistoricalMetrics = HistoricalMetric[];
export type HoursOfOperationId = string;
export type HoursOfOperationName = string;
export interface HoursOfOperationSummary {
/**
* The identifier of the hours of operation.
*/
Id?: HoursOfOperationId;
/**
* The Amazon Resource Name (ARN) of the hours of operation.
*/
Arn?: ARN;
/**
* The name of the hours of operation.
*/
Name?: HoursOfOperationName;
}
export type HoursOfOperationSummaryList = HoursOfOperationSummary[];
export type InstanceId = string;
export interface ListContactFlowsRequest {
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
/**
* The type of contact flow.
*/
ContactFlowTypes?: ContactFlowTypes;
/**
* 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.
*/
NextToken?: NextToken;
/**
* The maximimum number of results to return per page.
*/
MaxResults?: MaxResult1000;
}
export interface ListContactFlowsResponse {
/**
* Information about the contact flows.
*/
ContactFlowSummaryList?: ContactFlowSummaryList;
/**
* If there are additional results, this is the token for the next set of results.
*/
NextToken?: NextToken;
}
export interface ListHoursOfOperationsRequest {
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
/**
* 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.
*/
NextToken?: NextToken;
/**
* The maximimum number of results to return per page.
*/
MaxResults?: MaxResult1000;
}
export interface ListHoursOfOperationsResponse {
/**
* Information about the hours of operation.
*/
HoursOfOperationSummaryList?: HoursOfOperationSummaryList;
/**
* If there are additional results, this is the token for the next set of results.
*/
NextToken?: NextToken;
}
export interface ListPhoneNumbersRequest {
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
/**
* The type of phone number.
*/
PhoneNumberTypes?: PhoneNumberTypes;
/**
* The ISO country code.
*/
PhoneNumberCountryCodes?: PhoneNumberCountryCodes;
/**
* 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.
*/
NextToken?: NextToken;
/**
* The maximimum number of results to return per page.
*/
MaxResults?: MaxResult1000;
}
export interface ListPhoneNumbersResponse {
/**
* Information about the phone numbers.
*/
PhoneNumberSummaryList?: PhoneNumberSummaryList;
/**
* If there are additional results, this is the token for the next set of results.
*/
NextToken?: NextToken;
}
export interface ListQueuesRequest {
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
/**
* The type of queue.
*/
QueueTypes?: QueueTypes;
/**
* 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.
*/
NextToken?: NextToken;
/**
* The maximimum number of results to return per page.
*/
MaxResults?: MaxResult1000;
}
export interface ListQueuesResponse {
/**
* Information about the queues.
*/
QueueSummaryList?: QueueSummaryList;
/**
* If there are additional results, this is the token for the next set of results.
*/
NextToken?: NextToken;
}
export interface ListRoutingProfilesRequest {
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
/**
* 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.
*/
NextToken?: NextToken;
/**
* The maximimum number of results to return per page.
*/
MaxResults?: MaxResult1000;
}
export interface ListRoutingProfilesResponse {
/**
* Information about the routing profiles.
*/
RoutingProfileSummaryList?: RoutingProfileSummaryList;
/**
* If there are additional results, this is the token for the next set of results.
*/
NextToken?: NextToken;
}
export interface ListSecurityProfilesRequest {
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
/**
* 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.
*/
NextToken?: NextToken;
/**
* The maximimum number of results to return per page.
*/
MaxResults?: MaxResult1000;
}
export interface ListSecurityProfilesResponse {
/**
* Information about the security profiles.
*/
SecurityProfileSummaryList?: SecurityProfileSummaryList;
/**
* If there are additional results, this is the token for the next set of results.
*/
NextToken?: NextToken;
}
export interface ListUserHierarchyGroupsRequest {
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
/**
* 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.
*/
NextToken?: NextToken;
/**
* The maximimum number of results to return per page.
*/
MaxResults?: MaxResult1000;
}
export interface ListUserHierarchyGroupsResponse {
/**
* Information about the hierarchy groups.
*/
UserHierarchyGroupSummaryList?: HierarchyGroupSummaryList;
/**
* If there are additional results, this is the token for the next set of results.
*/
NextToken?: NextToken;
}
export interface ListUsersRequest {
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
/**
* 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.
*/
NextToken?: NextToken;
/**
* The maximimum number of results to return per page.
*/
MaxResults?: MaxResult1000;
}
export interface ListUsersResponse {
/**
* Information about the users.
*/
UserSummaryList?: UserSummaryList;
/**
* If there are additional results, this is the token for the next set of results.
*/
NextToken?: NextToken;
}
export type MaxResult100 = number;
export type MaxResult1000 = number;
export type NextToken = string;
export type Password = string;
export type PhoneNumber = string;
export type 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"|string;
export type PhoneNumberCountryCodes = PhoneNumberCountryCode[];
export type PhoneNumberId = string;
export interface PhoneNumberSummary {
/**
* The identifier of the phone number.
*/
Id?: PhoneNumberId;
/**
* The Amazon Resource Name (ARN) of the phone number.
*/
Arn?: ARN;
/**
* The phone number.
*/
PhoneNumber?: PhoneNumber;
/**
* The type of phone number.
*/
PhoneNumberType?: PhoneNumberType;
/**
* The ISO country code.
*/
PhoneNumberCountryCode?: PhoneNumberCountryCode;
}
export type PhoneNumberSummaryList = PhoneNumberSummary[];
export type PhoneNumberType = "TOLL_FREE"|"DID"|string;
export type PhoneNumberTypes = PhoneNumberType[];
export type PhoneType = "SOFT_PHONE"|"DESK_PHONE"|string;
export type QueueId = string;
export type QueueName = string;
export interface QueueReference {
/**
* The identifier of the queue.
*/
Id?: QueueId;
/**
* The Amazon Resource Name (ARN) of the queue.
*/
Arn?: ARN;
}
export interface QueueSummary {
/**
* The identifier of the queue.
*/
Id?: QueueId;
/**
* The Amazon Resource Name (ARN) of the queue.
*/
Arn?: ARN;
/**
* The name of the queue.
*/
Name?: QueueName;
/**
* The type of queue.
*/
QueueType?: QueueType;
}
export type QueueSummaryList = QueueSummary[];
export type QueueType = "STANDARD"|"AGENT"|string;
export type QueueTypes = QueueType[];
export type Queues = QueueId[];
export type RoutingProfileId = string;
export type RoutingProfileName = string;
export interface RoutingProfileSummary {
/**
* The identifier of the routing profile.
*/
Id?: RoutingProfileId;
/**
* The Amazon Resource Name (ARN) of the routing profile.
*/
Arn?: ARN;
/**
* The name of the routing profile.
*/
Name?: RoutingProfileName;
}
export type RoutingProfileSummaryList = RoutingProfileSummary[];
export type SecurityProfileId = string;
export type SecurityProfileIds = SecurityProfileId[];
export type SecurityProfileName = string;
export interface SecurityProfileSummary {
/**
* The identifier of the security profile.
*/
Id?: SecurityProfileId;
/**
* The Amazon Resource Name (ARN) of the security profile.
*/
Arn?: ARN;
/**
* The name of the security profile.
*/
Name?: SecurityProfileName;
}
export type SecurityProfileSummaryList = SecurityProfileSummary[];
export type SecurityToken = string;
export interface StartOutboundVoiceContactRequest {
/**
* The phone number of the customer, in E.164 format.
*/
DestinationPhoneNumber: PhoneNumber;
/**
* The identifier of the contact flow for the outbound call.
*/
ContactFlowId: ContactFlowId;
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
/**
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned. If the contact is disconnected, a new contact is started.
*/
ClientToken?: ClientToken;
/**
* The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.
*/
SourcePhoneNumber?: PhoneNumber;
/**
* The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.
*/
QueueId?: QueueId;
/**
* A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact 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.
*/
Attributes?: Attributes;
}
export interface StartOutboundVoiceContactResponse {
/**
* The identifier of this contact within the Amazon Connect instance.
*/
ContactId?: ContactId;
}
export type Statistic = "SUM"|"MAX"|"AVG"|string;
export interface StopContactRequest {
/**
* The ID of the contact.
*/
ContactId: ContactId;
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
}
export interface StopContactResponse {
}
export interface Threshold {
/**
* The type of comparison. Only "less than" (LT) comparisons are supported.
*/
Comparison?: Comparison;
/**
* The threshold value to compare.
*/
ThresholdValue?: ThresholdValue;
}
export type ThresholdValue = number;
export type Unit = "SECONDS"|"COUNT"|"PERCENT"|string;
export interface UpdateContactAttributesRequest {
/**
* The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
*/
InitialContactId: ContactId;
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
/**
* The Amazon Connect attributes. These attributes can be accessed in contact flows just like any other contact attributes. You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
*/
Attributes: Attributes;
}
export interface UpdateContactAttributesResponse {
}
export interface UpdateUserHierarchyRequest {
/**
* The identifier of the hierarchy group.
*/
HierarchyGroupId?: HierarchyGroupId;
/**
* The identifier of the user account.
*/
UserId: UserId;
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
}
export interface UpdateUserIdentityInfoRequest {
/**
* The identity information for the user.
*/
IdentityInfo: UserIdentityInfo;
/**
* The identifier of the user account.
*/
UserId: UserId;
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
}
export interface UpdateUserPhoneConfigRequest {
/**
* Information about phone configuration settings for the user.
*/
PhoneConfig: UserPhoneConfig;
/**
* The identifier of the user account.
*/
UserId: UserId;
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId;
}
export interface UpdateUserRoutingProfileRequest {
/**
* The identifier of the routing profile for the user.
*/
RoutingProfileId: RoutingProfileId;
/**
* The identifier of the user account.
*/
UserId: UserId;
/**
* The identifier of the Amazon Connect instance.
*/
InstanceId: InstanceId