aws-sdk 2.1611.0 → 2.1613.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/apis/bedrock-agent-2023-06-05.min.json +43 -42
- package/apis/connect-2017-08-08.min.json +719 -439
- package/apis/connectcases-2022-10-03.min.json +40 -19
- package/apis/datasync-2018-11-09.min.json +3 -0
- package/apis/dynamodb-2012-08-10.min.json +249 -180
- package/apis/ec2-2016-11-15.min.json +107 -70
- package/apis/inspector2-2020-06-08.min.json +95 -94
- package/apis/personalize-2018-05-22.min.json +153 -44
- package/apis/redshift-serverless-2021-04-21.min.json +7 -1
- package/apis/sesv2-2019-09-27.min.json +3 -0
- package/clients/bedrockagent.d.ts +13 -4
- package/clients/connect.d.ts +331 -2
- package/clients/connectcases.d.ts +39 -14
- package/clients/datasync.d.ts +6 -6
- package/clients/dynamodb.d.ts +80 -11
- package/clients/ec2.d.ts +47 -0
- package/clients/inspector2.d.ts +6 -1
- package/clients/personalize.d.ts +160 -1
- package/clients/redshiftserverless.d.ts +17 -7
- package/clients/sagemaker.d.ts +1 -1
- package/clients/sesv2.d.ts +4 -0
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +11 -11
- package/dist/aws-sdk.js +1231 -736
- package/dist/aws-sdk.min.js +85 -84
- package/lib/core.js +1 -1
- package/lib/dynamodb/document_client.d.ts +76 -7
- package/package.json +1 -1
package/clients/connect.d.ts
CHANGED
@@ -147,6 +147,14 @@ declare class Connect extends Service {
|
|
147
147
|
* This API is in preview release for Amazon Connect and is subject to change. Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call.
|
148
148
|
*/
|
149
149
|
batchDisassociateAnalyticsDataSet(callback?: (err: AWSError, data: Connect.Types.BatchDisassociateAnalyticsDataSetResponse) => void): Request<Connect.Types.BatchDisassociateAnalyticsDataSetResponse, AWSError>;
|
150
|
+
/**
|
151
|
+
* Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.
|
152
|
+
*/
|
153
|
+
batchGetAttachedFileMetadata(params: Connect.Types.BatchGetAttachedFileMetadataRequest, callback?: (err: AWSError, data: Connect.Types.BatchGetAttachedFileMetadataResponse) => void): Request<Connect.Types.BatchGetAttachedFileMetadataResponse, AWSError>;
|
154
|
+
/**
|
155
|
+
* Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn.
|
156
|
+
*/
|
157
|
+
batchGetAttachedFileMetadata(callback?: (err: AWSError, data: Connect.Types.BatchGetAttachedFileMetadataResponse) => void): Request<Connect.Types.BatchGetAttachedFileMetadataResponse, AWSError>;
|
150
158
|
/**
|
151
159
|
* Retrieve the flow associations for the given resources.
|
152
160
|
*/
|
@@ -171,6 +179,14 @@ declare class Connect extends Service {
|
|
171
179
|
* Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created. For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide. You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation. If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 days past the oldest number released has expired. By default you can claim and release up to 200% of your maximum number of active phone numbers during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 days past the oldest number released has expired. For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
|
172
180
|
*/
|
173
181
|
claimPhoneNumber(callback?: (err: AWSError, data: Connect.Types.ClaimPhoneNumberResponse) => void): Request<Connect.Types.ClaimPhoneNumberResponse, AWSError>;
|
182
|
+
/**
|
183
|
+
* Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
|
184
|
+
*/
|
185
|
+
completeAttachedFileUpload(params: Connect.Types.CompleteAttachedFileUploadRequest, callback?: (err: AWSError, data: Connect.Types.CompleteAttachedFileUploadResponse) => void): Request<Connect.Types.CompleteAttachedFileUploadResponse, AWSError>;
|
186
|
+
/**
|
187
|
+
* Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API.
|
188
|
+
*/
|
189
|
+
completeAttachedFileUpload(callback?: (err: AWSError, data: Connect.Types.CompleteAttachedFileUploadResponse) => void): Request<Connect.Types.CompleteAttachedFileUploadResponse, AWSError>;
|
174
190
|
/**
|
175
191
|
* This API is in preview release for Amazon Connect and is subject to change. Creates an agent status for the specified Amazon Connect instance.
|
176
192
|
*/
|
@@ -371,6 +387,14 @@ declare class Connect extends Service {
|
|
371
387
|
* Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form.
|
372
388
|
*/
|
373
389
|
deactivateEvaluationForm(callback?: (err: AWSError, data: Connect.Types.DeactivateEvaluationFormResponse) => void): Request<Connect.Types.DeactivateEvaluationFormResponse, AWSError>;
|
390
|
+
/**
|
391
|
+
* Deletes an attached file along with the underlying S3 Object. The attached file is permanently deleted if S3 bucket versioning is not enabled.
|
392
|
+
*/
|
393
|
+
deleteAttachedFile(params: Connect.Types.DeleteAttachedFileRequest, callback?: (err: AWSError, data: Connect.Types.DeleteAttachedFileResponse) => void): Request<Connect.Types.DeleteAttachedFileResponse, AWSError>;
|
394
|
+
/**
|
395
|
+
* Deletes an attached file along with the underlying S3 Object. The attached file is permanently deleted if S3 bucket versioning is not enabled.
|
396
|
+
*/
|
397
|
+
deleteAttachedFile(callback?: (err: AWSError, data: Connect.Types.DeleteAttachedFileResponse) => void): Request<Connect.Types.DeleteAttachedFileResponse, AWSError>;
|
374
398
|
/**
|
375
399
|
* Deletes a contact evaluation in the specified Amazon Connect instance.
|
376
400
|
*/
|
@@ -851,6 +875,14 @@ declare class Connect extends Service {
|
|
851
875
|
* Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a MISSED, ERROR, ENDED, or REJECTED state in the Agent Event Stream.
|
852
876
|
*/
|
853
877
|
dismissUserContact(callback?: (err: AWSError, data: Connect.Types.DismissUserContactResponse) => void): Request<Connect.Types.DismissUserContactResponse, AWSError>;
|
878
|
+
/**
|
879
|
+
* Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED.
|
880
|
+
*/
|
881
|
+
getAttachedFile(params: Connect.Types.GetAttachedFileRequest, callback?: (err: AWSError, data: Connect.Types.GetAttachedFileResponse) => void): Request<Connect.Types.GetAttachedFileResponse, AWSError>;
|
882
|
+
/**
|
883
|
+
* Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is APPROVED.
|
884
|
+
*/
|
885
|
+
getAttachedFile(callback?: (err: AWSError, data: Connect.Types.GetAttachedFileResponse) => void): Request<Connect.Types.GetAttachedFileResponse, AWSError>;
|
854
886
|
/**
|
855
887
|
* Retrieves the contact attributes for the specified contact.
|
856
888
|
*/
|
@@ -1451,6 +1483,14 @@ declare class Connect extends Service {
|
|
1451
1483
|
* Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes: SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action. Access to this API is currently restricted to Amazon Pinpoint for supporting SMS integration.
|
1452
1484
|
*/
|
1453
1485
|
sendChatIntegrationEvent(callback?: (err: AWSError, data: Connect.Types.SendChatIntegrationEventResponse) => void): Request<Connect.Types.SendChatIntegrationEventResponse, AWSError>;
|
1486
|
+
/**
|
1487
|
+
* Provides a pre-signed Amazon S3 URL in response for uploading your content. You may only use this API to upload attachments to a Connect Case.
|
1488
|
+
*/
|
1489
|
+
startAttachedFileUpload(params: Connect.Types.StartAttachedFileUploadRequest, callback?: (err: AWSError, data: Connect.Types.StartAttachedFileUploadResponse) => void): Request<Connect.Types.StartAttachedFileUploadResponse, AWSError>;
|
1490
|
+
/**
|
1491
|
+
* Provides a pre-signed Amazon S3 URL in response for uploading your content. You may only use this API to upload attachments to a Connect Case.
|
1492
|
+
*/
|
1493
|
+
startAttachedFileUpload(callback?: (err: AWSError, data: Connect.Types.StartAttachedFileUploadResponse) => void): Request<Connect.Types.StartAttachedFileUploadResponse, AWSError>;
|
1454
1494
|
/**
|
1455
1495
|
* Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service. When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS. A 429 error occurs in the following situations: API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception. The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException. If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support. For more information about chat, see Chat in the Amazon Connect Administrator Guide.
|
1456
1496
|
*/
|
@@ -2441,6 +2481,64 @@ declare namespace Connect {
|
|
2441
2481
|
UserProficiencies: UserProficiencyList;
|
2442
2482
|
}
|
2443
2483
|
export type AssociationId = string;
|
2484
|
+
export interface AttachedFile {
|
2485
|
+
/**
|
2486
|
+
* The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.
|
2487
|
+
*/
|
2488
|
+
CreationTime: ISO8601Datetime;
|
2489
|
+
/**
|
2490
|
+
* The unique identifier of the attached file resource (ARN).
|
2491
|
+
*/
|
2492
|
+
FileArn: ARN;
|
2493
|
+
/**
|
2494
|
+
* The unique identifier of the attached file resource.
|
2495
|
+
*/
|
2496
|
+
FileId: FileId;
|
2497
|
+
/**
|
2498
|
+
* A case-sensitive name of the attached file being uploaded.
|
2499
|
+
*/
|
2500
|
+
FileName: FileName;
|
2501
|
+
/**
|
2502
|
+
* The size of the attached file in bytes.
|
2503
|
+
*/
|
2504
|
+
FileSizeInBytes: FileSizeInBytes;
|
2505
|
+
/**
|
2506
|
+
* The current status of the attached file.
|
2507
|
+
*/
|
2508
|
+
FileStatus: FileStatusType;
|
2509
|
+
/**
|
2510
|
+
* Represents the identity that created the file.
|
2511
|
+
*/
|
2512
|
+
CreatedBy?: CreatedByInfo;
|
2513
|
+
/**
|
2514
|
+
* The use case for the file.
|
2515
|
+
*/
|
2516
|
+
FileUseCaseType?: FileUseCaseType;
|
2517
|
+
/**
|
2518
|
+
* The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource. This value must be a valid ARN.
|
2519
|
+
*/
|
2520
|
+
AssociatedResourceArn?: ARN;
|
2521
|
+
/**
|
2522
|
+
* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
|
2523
|
+
*/
|
2524
|
+
Tags?: TagMap;
|
2525
|
+
}
|
2526
|
+
export interface AttachedFileError {
|
2527
|
+
/**
|
2528
|
+
* Status code describing the failure.
|
2529
|
+
*/
|
2530
|
+
ErrorCode?: ErrorCode;
|
2531
|
+
/**
|
2532
|
+
* Why the attached file couldn't be retrieved.
|
2533
|
+
*/
|
2534
|
+
ErrorMessage?: ErrorMessage;
|
2535
|
+
/**
|
2536
|
+
* The unique identifier of the attached file resource.
|
2537
|
+
*/
|
2538
|
+
FileId?: FileId;
|
2539
|
+
}
|
2540
|
+
export type AttachedFileErrorsList = AttachedFileError[];
|
2541
|
+
export type AttachedFilesList = AttachedFile[];
|
2444
2542
|
export type AttachmentName = string;
|
2445
2543
|
export interface AttachmentReference {
|
2446
2544
|
/**
|
@@ -2560,6 +2658,30 @@ declare namespace Connect {
|
|
2560
2658
|
*/
|
2561
2659
|
Errors?: ErrorResults;
|
2562
2660
|
}
|
2661
|
+
export interface BatchGetAttachedFileMetadataRequest {
|
2662
|
+
/**
|
2663
|
+
* The unique identifiers of the attached file resource.
|
2664
|
+
*/
|
2665
|
+
FileIds: FileIdList;
|
2666
|
+
/**
|
2667
|
+
* The unique identifier of the Connect instance.
|
2668
|
+
*/
|
2669
|
+
InstanceId: InstanceId;
|
2670
|
+
/**
|
2671
|
+
* The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource. This value must be a valid ARN.
|
2672
|
+
*/
|
2673
|
+
AssociatedResourceArn: ARN;
|
2674
|
+
}
|
2675
|
+
export interface BatchGetAttachedFileMetadataResponse {
|
2676
|
+
/**
|
2677
|
+
* List of attached files that were successfully retrieved.
|
2678
|
+
*/
|
2679
|
+
Files?: AttachedFilesList;
|
2680
|
+
/**
|
2681
|
+
* List of errors of attached files that could not be retrieved.
|
2682
|
+
*/
|
2683
|
+
Errors?: AttachedFileErrorsList;
|
2684
|
+
}
|
2563
2685
|
export interface BatchGetFlowAssociationRequest {
|
2564
2686
|
/**
|
2565
2687
|
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
|
@@ -2746,6 +2868,22 @@ declare namespace Connect {
|
|
2746
2868
|
export type ClientToken = string;
|
2747
2869
|
export type CommonNameLength127 = string;
|
2748
2870
|
export type Comparison = "LT"|string;
|
2871
|
+
export interface CompleteAttachedFileUploadRequest {
|
2872
|
+
/**
|
2873
|
+
* The unique identifier of the Connect instance.
|
2874
|
+
*/
|
2875
|
+
InstanceId: InstanceId;
|
2876
|
+
/**
|
2877
|
+
* The unique identifier of the attached file resource.
|
2878
|
+
*/
|
2879
|
+
FileId: FileId;
|
2880
|
+
/**
|
2881
|
+
* The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource. This value must be a valid ARN.
|
2882
|
+
*/
|
2883
|
+
AssociatedResourceArn: ARN;
|
2884
|
+
}
|
2885
|
+
export interface CompleteAttachedFileUploadResponse {
|
2886
|
+
}
|
2749
2887
|
export type Concurrency = number;
|
2750
2888
|
export interface ConnectionData {
|
2751
2889
|
/**
|
@@ -3990,6 +4128,16 @@ declare namespace Connect {
|
|
3990
4128
|
*/
|
3991
4129
|
State: VocabularyState;
|
3992
4130
|
}
|
4131
|
+
export interface CreatedByInfo {
|
4132
|
+
/**
|
4133
|
+
* An agent ARN representing a connect user.
|
4134
|
+
*/
|
4135
|
+
ConnectUserArn?: ARN;
|
4136
|
+
/**
|
4137
|
+
* STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.
|
4138
|
+
*/
|
4139
|
+
AWSIdentityArn?: ARN;
|
4140
|
+
}
|
3993
4141
|
export interface Credentials {
|
3994
4142
|
/**
|
3995
4143
|
* An access token generated for a federated user to access Amazon Connect.
|
@@ -4116,6 +4264,22 @@ declare namespace Connect {
|
|
4116
4264
|
}
|
4117
4265
|
export type DefaultVocabularyList = DefaultVocabulary[];
|
4118
4266
|
export type Delay = number;
|
4267
|
+
export interface DeleteAttachedFileRequest {
|
4268
|
+
/**
|
4269
|
+
* The unique identifier of the Connect instance.
|
4270
|
+
*/
|
4271
|
+
InstanceId: InstanceId;
|
4272
|
+
/**
|
4273
|
+
* The unique identifier of the attached file resource.
|
4274
|
+
*/
|
4275
|
+
FileId: FileId;
|
4276
|
+
/**
|
4277
|
+
* The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource. This value must be a valid ARN.
|
4278
|
+
*/
|
4279
|
+
AssociatedResourceArn: ARN;
|
4280
|
+
}
|
4281
|
+
export interface DeleteAttachedFileResponse {
|
4282
|
+
}
|
4119
4283
|
export interface DeleteContactEvaluationRequest {
|
4120
4284
|
/**
|
4121
4285
|
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
|
@@ -4974,6 +5138,16 @@ declare namespace Connect {
|
|
4974
5138
|
}
|
4975
5139
|
export type DistributionList = Distribution[];
|
4976
5140
|
export type Double = number;
|
5141
|
+
export interface DownloadUrlMetadata {
|
5142
|
+
/**
|
5143
|
+
* A pre-signed URL that should be used to download the attached file.
|
5144
|
+
*/
|
5145
|
+
Url?: MetadataUrl;
|
5146
|
+
/**
|
5147
|
+
* The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
|
5148
|
+
*/
|
5149
|
+
UrlExpiry?: ISO8601Datetime;
|
5150
|
+
}
|
4977
5151
|
export type Email = string;
|
4978
5152
|
export interface EmailReference {
|
4979
5153
|
/**
|
@@ -5012,6 +5186,8 @@ declare namespace Connect {
|
|
5012
5186
|
}
|
5013
5187
|
export type EndpointAddress = string;
|
5014
5188
|
export type EndpointType = "TELEPHONE_NUMBER"|"VOIP"|"CONTACT_FLOW"|string;
|
5189
|
+
export type ErrorCode = string;
|
5190
|
+
export type ErrorMessage = string;
|
5015
5191
|
export interface ErrorResult {
|
5016
5192
|
/**
|
5017
5193
|
* The error code.
|
@@ -5601,6 +5777,12 @@ declare namespace Connect {
|
|
5601
5777
|
StringValue?: FieldStringValue;
|
5602
5778
|
}
|
5603
5779
|
export type FieldValues = FieldValue[];
|
5780
|
+
export type FileId = string;
|
5781
|
+
export type FileIdList = FileId[];
|
5782
|
+
export type FileName = string;
|
5783
|
+
export type FileSizeInBytes = number;
|
5784
|
+
export type FileStatusType = "APPROVED"|"REJECTED"|"PROCESSING"|"FAILED"|string;
|
5785
|
+
export type FileUseCaseType = "ATTACHMENT"|string;
|
5604
5786
|
export interface FilterV2 {
|
5605
5787
|
/**
|
5606
5788
|
* The key to use for filtering data. For example, QUEUE, ROUTING_PROFILE, AGENT, CHANNEL, AGENT_HIERARCHY_LEVEL_ONE, AGENT_HIERARCHY_LEVEL_TWO, AGENT_HIERARCHY_LEVEL_THREE, AGENT_HIERARCHY_LEVEL_FOUR, AGENT_HIERARCHY_LEVEL_FIVE. There must be at least 1 key and a maximum 5 keys.
|
@@ -5649,6 +5831,70 @@ declare namespace Connect {
|
|
5649
5831
|
export type FlowAssociationSummaryList = FlowAssociationSummary[];
|
5650
5832
|
export type FunctionArn = string;
|
5651
5833
|
export type FunctionArnsList = FunctionArn[];
|
5834
|
+
export interface GetAttachedFileRequest {
|
5835
|
+
/**
|
5836
|
+
* The unique identifier of the Connect instance.
|
5837
|
+
*/
|
5838
|
+
InstanceId: InstanceId;
|
5839
|
+
/**
|
5840
|
+
* The unique identifier of the attached file resource.
|
5841
|
+
*/
|
5842
|
+
FileId: FileId;
|
5843
|
+
/**
|
5844
|
+
* Optional override for the expiry of the pre-signed S3 URL in seconds.
|
5845
|
+
*/
|
5846
|
+
UrlExpiryInSeconds?: URLExpiryInSeconds;
|
5847
|
+
/**
|
5848
|
+
* The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource. This value must be a valid ARN.
|
5849
|
+
*/
|
5850
|
+
AssociatedResourceArn: ARN;
|
5851
|
+
}
|
5852
|
+
export interface GetAttachedFileResponse {
|
5853
|
+
/**
|
5854
|
+
* The unique identifier of the attached file resource (ARN).
|
5855
|
+
*/
|
5856
|
+
FileArn?: ARN;
|
5857
|
+
/**
|
5858
|
+
* The unique identifier of the attached file resource.
|
5859
|
+
*/
|
5860
|
+
FileId?: FileId;
|
5861
|
+
/**
|
5862
|
+
* The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.
|
5863
|
+
*/
|
5864
|
+
CreationTime?: ISO8601Datetime;
|
5865
|
+
/**
|
5866
|
+
* The current status of the attached file.
|
5867
|
+
*/
|
5868
|
+
FileStatus?: FileStatusType;
|
5869
|
+
/**
|
5870
|
+
* A case-sensitive name of the attached file being uploaded.
|
5871
|
+
*/
|
5872
|
+
FileName?: FileName;
|
5873
|
+
/**
|
5874
|
+
* The size of the attached file in bytes.
|
5875
|
+
*/
|
5876
|
+
FileSizeInBytes: FileSizeInBytes;
|
5877
|
+
/**
|
5878
|
+
* The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource. This value must be a valid ARN.
|
5879
|
+
*/
|
5880
|
+
AssociatedResourceArn?: ARN;
|
5881
|
+
/**
|
5882
|
+
* The use case for the file.
|
5883
|
+
*/
|
5884
|
+
FileUseCaseType?: FileUseCaseType;
|
5885
|
+
/**
|
5886
|
+
* Represents the identity that created the file.
|
5887
|
+
*/
|
5888
|
+
CreatedBy?: CreatedByInfo;
|
5889
|
+
/**
|
5890
|
+
* URL and expiry to be used when downloading the attached file.
|
5891
|
+
*/
|
5892
|
+
DownloadUrlMetadata?: DownloadUrlMetadata;
|
5893
|
+
/**
|
5894
|
+
* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
|
5895
|
+
*/
|
5896
|
+
Tags?: TagMap;
|
5897
|
+
}
|
5652
5898
|
export interface GetContactAttributesRequest {
|
5653
5899
|
/**
|
5654
5900
|
* The identifier of the Amazon Connect instance.
|
@@ -5867,7 +6113,7 @@ declare namespace Connect {
|
|
5867
6113
|
*/
|
5868
6114
|
Groupings?: GroupingsV2;
|
5869
6115
|
/**
|
5870
|
-
* The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's Guide. ABANDONMENT_RATE Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Abandonment rate AGENT_ADHERENT_TIME This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Adherent time AGENT_ANSWER_RATE Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent answer rate AGENT_NON_ADHERENT_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Non-adherent time AGENT_NON_RESPONSE Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent non-response AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy Data for this metric is available starting from October 1, 2023 0:00:00 GMT. UI name: Agent non-response without customer abandons AGENT_OCCUPANCY Unit: Percentage Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Occupancy AGENT_SCHEDULE_ADHERENCE This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Adherence AGENT_SCHEDULED_TIME This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Scheduled time AVG_ABANDON_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Average queue abandon time AVG_ACTIVE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Average active time AVG_AFTER_CONTACT_WORK_TIME Unit: Seconds Valid metric filter key: INITIATION_METHOD Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Average after contact work time Feature is a valid filter but not a valid grouping. AVG_AGENT_CONNECTING_TIME Unit: Seconds Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Average agent API connecting time The Negate key in Metric Level Filters is not applicable for this metric. AVG_AGENT_PAUSE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Average agent pause time AVG_CASE_RELATED_CONTACTS Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Average contacts per case AVG_CASE_RESOLUTION_TIME Unit: Seconds Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Average case resolution time AVG_CONTACT_DURATION Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Average contact duration Feature is a valid filter but not a valid grouping. AVG_CONVERSATION_DURATION Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Average conversation duration AVG_GREETING_TIME_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average greeting time agent AVG_HANDLE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression UI name: Average handle time Feature is a valid filter but not a valid grouping. AVG_HOLD_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Average customer hold time Feature is a valid filter but not a valid grouping. AVG_HOLD_TIME_ALL_CONTACTS Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average customer hold time all contacts AVG_HOLDS Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Average holds Feature is a valid filter but not a valid grouping. AVG_INTERACTION_AND_HOLD_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average agent interaction and customer hold time AVG_INTERACTION_TIME Unit: Seconds Valid metric filter key: INITIATION_METHOD Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype UI name: Average agent interaction time Feature is a valid filter but not a valid grouping. AVG_INTERRUPTIONS_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average interruptions agent AVG_INTERRUPTION_TIME_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average interruption time agent AVG_NON_TALK_TIME This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average non-talk time AVG_QUEUE_ANSWER_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype UI name: Average queue answer time Feature is a valid filter but not a valid grouping. AVG_RESOLUTION_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype UI name: Average resolution time AVG_TALK_TIME This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average talk time AVG_TALK_TIME_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average talk time agent AVG_TALK_TIME_CUSTOMER This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average talk time customer CASES_CREATED Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases created CONTACTS_ABANDONED Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression UI name: Contact abandoned CONTACTS_CREATED Unit: Count Valid metric filter key: INITIATION_METHOD Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype UI name: Contacts created Feature is a valid filter but not a valid grouping. CONTACTS_HANDLED Unit: Count Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression UI name: API contacts handled Feature is a valid filter but not a valid grouping. CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT Unit: Count Valid metric filter key: INITIATION_METHOD Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts handled by Connected to agent CONTACTS_HOLD_ABANDONS Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts hold disconnect CONTACTS_ON_HOLD_AGENT_DISCONNECT Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts hold agent disconnect CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts hold customer disconnect CONTACTS_PUT_ON_HOLD Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts put on hold CONTACTS_TRANSFERRED_OUT_EXTERNAL Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts transferred out external CONTACTS_TRANSFERRED_OUT_INTERNAL Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts transferred out internal CONTACTS_QUEUED Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts queued CONTACTS_QUEUED_BY_ENQUEUE Unit: Count Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts queued by Enqueue CONTACTS_RESOLVED_IN_X Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype Threshold: For ThresholdValue enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than"). UI name: Contacts resolved in X CONTACTS_TRANSFERRED_OUT Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Contacts transferred out Feature is a valid filter but not a valid grouping. CONTACTS_TRANSFERRED_OUT_BY_AGENT Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts transferred out by agent CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts transferred out queue CURRENT_CASES Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Current cases MAX_QUEUED_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Maximum queued time PERCENT_CASES_FIRST_CONTACT_RESOLVED Unit: Percent Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases resolved on first contact PERCENT_CONTACTS_STEP_EXPIRED Unit: Percent Valid groupings and filters: Queue, RoutingStepExpression UI name: Not available PERCENT_CONTACTS_STEP_JOINED Unit: Percent Valid groupings and filters: Queue, RoutingStepExpression UI name: Not available PERCENT_NON_TALK_TIME This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Percentage Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Non-talk time percent PERCENT_TALK_TIME This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Percentage Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Talk time percent PERCENT_TALK_TIME_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Percentage Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Talk time agent percent PERCENT_TALK_TIME_CUSTOMER This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Percentage Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Talk time customer percent REOPENED_CASE_ACTIONS Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases reopened RESOLVED_CASE_ACTIONS Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases resolved SERVICE_LEVEL You can include up to 20 SERVICE_LEVEL metrics in a request. Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than"). UI name: Service level X STEP_CONTACTS_QUEUED Unit: Count Valid groupings and filters: Queue, RoutingStepExpression UI name: Not available SUM_AFTER_CONTACT_WORK_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: After contact work time SUM_CONNECTING_TIME_AGENT Unit: Seconds Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent API connecting time The Negate key in Metric Level Filters is not applicable for this metric. SUM_CONTACT_FLOW_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contact flow time SUM_CONTACT_TIME_AGENT Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent on contact time SUM_CONTACTS_ANSWERED_IN_X Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than"). UI name: Contacts answered in X seconds SUM_CONTACTS_ABANDONED_IN_X Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than"). UI name: Contacts abandoned in X seconds SUM_CONTACTS_DISCONNECTED Valid metric filter key: DISCONNECT_REASON Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contact disconnected SUM_ERROR_STATUS_TIME_AGENT Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Error status time SUM_HANDLE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contact handle time SUM_HOLD_TIME Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Customer hold time SUM_IDLE_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Agent idle time SUM_INTERACTION_AND_HOLD_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent interaction and hold time SUM_INTERACTION_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent interaction time SUM_NON_PRODUCTIVE_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Non-Productive Time SUM_ONLINE_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Online time SUM_RETRY_CALLBACK_ATTEMPTS Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype UI name: Callback attempts
|
6116
|
+
* The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's Guide. ABANDONMENT_RATE Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Abandonment rate AGENT_ADHERENT_TIME This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Adherent time AGENT_ANSWER_RATE Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent answer rate AGENT_NON_ADHERENT_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Non-adherent time AGENT_NON_RESPONSE Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent non-response AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy Data for this metric is available starting from October 1, 2023 0:00:00 GMT. UI name: Agent non-response without customer abandons AGENT_OCCUPANCY Unit: Percentage Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Occupancy AGENT_SCHEDULE_ADHERENCE This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Adherence AGENT_SCHEDULED_TIME This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Scheduled time AVG_ABANDON_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Average queue abandon time AVG_ACTIVE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Average active time AVG_AFTER_CONTACT_WORK_TIME Unit: Seconds Valid metric filter key: INITIATION_METHOD Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Average after contact work time Feature is a valid filter but not a valid grouping. AVG_AGENT_CONNECTING_TIME Unit: Seconds Valid metric filter key: INITIATION_METHOD. For now, this metric only supports the following as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Average agent API connecting time The Negate key in Metric Level Filters is not applicable for this metric. AVG_AGENT_PAUSE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Average agent pause time AVG_CASE_RELATED_CONTACTS Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Average contacts per case AVG_CASE_RESOLUTION_TIME Unit: Seconds Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Average case resolution time AVG_CONTACT_DURATION Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Average contact duration Feature is a valid filter but not a valid grouping. AVG_CONVERSATION_DURATION Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Average conversation duration AVG_GREETING_TIME_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average agent greeting time AVG_HANDLE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression UI name: Average handle time Feature is a valid filter but not a valid grouping. AVG_HOLD_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Average customer hold time Feature is a valid filter but not a valid grouping. AVG_HOLD_TIME_ALL_CONTACTS Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average customer hold time all contacts AVG_HOLDS Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Average holds Feature is a valid filter but not a valid grouping. AVG_INTERACTION_AND_HOLD_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average agent interaction and customer hold time AVG_INTERACTION_TIME Unit: Seconds Valid metric filter key: INITIATION_METHOD Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype UI name: Average agent interaction time Feature is a valid filter but not a valid grouping. AVG_INTERRUPTIONS_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average agent interruptions AVG_INTERRUPTION_TIME_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average agent interruption time AVG_NON_TALK_TIME This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average non-talk time AVG_QUEUE_ANSWER_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype UI name: Average queue answer time Feature is a valid filter but not a valid grouping. AVG_RESOLUTION_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype UI name: Average resolution time AVG_TALK_TIME This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average talk time AVG_TALK_TIME_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average agent talk time AVG_TALK_TIME_CUSTOMER This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Average customer talk time CASES_CREATED Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases created CONTACTS_ABANDONED Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression UI name: Contact abandoned CONTACTS_CREATED Unit: Count Valid metric filter key: INITIATION_METHOD Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype UI name: Contacts created Feature is a valid filter but not a valid grouping. CONTACTS_HANDLED Unit: Count Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression UI name: API contacts handled Feature is a valid filter but not a valid grouping. CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT Unit: Count Valid metric filter key: INITIATION_METHOD Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts handled (connected to agent timestamp) CONTACTS_HOLD_ABANDONS Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts hold disconnect CONTACTS_ON_HOLD_AGENT_DISCONNECT Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts hold agent disconnect CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts hold customer disconnect CONTACTS_PUT_ON_HOLD Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts put on hold CONTACTS_TRANSFERRED_OUT_EXTERNAL Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts transferred out external CONTACTS_TRANSFERRED_OUT_INTERNAL Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contacts transferred out internal CONTACTS_QUEUED Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts queued CONTACTS_QUEUED_BY_ENQUEUE Unit: Count Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts queued (enqueue timestamp) CONTACTS_RESOLVED_IN_X Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype Threshold: For ThresholdValue enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than"). UI name: Contacts resolved in X CONTACTS_TRANSFERRED_OUT Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype UI name: Contacts transferred out Feature is a valid filter but not a valid grouping. CONTACTS_TRANSFERRED_OUT_BY_AGENT Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts transferred out by agent CONTACTS_TRANSFERRED_OUT_FROM_QUEUE Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contacts transferred out queue CURRENT_CASES Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Current cases MAX_QUEUED_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Maximum queued time PERCENT_CASES_FIRST_CONTACT_RESOLVED Unit: Percent Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases resolved on first contact PERCENT_CONTACTS_STEP_EXPIRED Unit: Percent Valid groupings and filters: Queue, RoutingStepExpression UI name: Not available PERCENT_CONTACTS_STEP_JOINED Unit: Percent Valid groupings and filters: Queue, RoutingStepExpression UI name: Not available PERCENT_NON_TALK_TIME This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Percentage Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Non-talk time percent PERCENT_TALK_TIME This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Percentage Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Talk time percent PERCENT_TALK_TIME_AGENT This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Percentage Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Agent talk time percent PERCENT_TALK_TIME_CUSTOMER This metric is available only for contacts analyzed by Contact Lens conversational analytics. Unit: Percentage Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Customer talk time percent REOPENED_CASE_ACTIONS Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases reopened RESOLVED_CASE_ACTIONS Unit: Count Required filter key: CASE_TEMPLATE_ARN Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS UI name: Cases resolved SERVICE_LEVEL You can include up to 20 SERVICE_LEVEL metrics in a request. Unit: Percent Valid groupings and filters: Queue, Channel, Routing Profile Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than"). UI name: Service level X STEP_CONTACTS_QUEUED Unit: Count Valid groupings and filters: Queue, RoutingStepExpression UI name: Not available SUM_AFTER_CONTACT_WORK_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: After contact work time SUM_CONNECTING_TIME_AGENT Unit: Seconds Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent API connecting time The Negate key in Metric Level Filters is not applicable for this metric. SUM_CONTACT_FLOW_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contact flow time SUM_CONTACT_TIME_AGENT Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent on contact time SUM_CONTACTS_ANSWERED_IN_X Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than"). UI name: Contacts answered in X seconds SUM_CONTACTS_ABANDONED_IN_X Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than"). UI name: Contacts abandoned in X seconds SUM_CONTACTS_DISCONNECTED Valid metric filter key: DISCONNECT_REASON Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype UI name: Contact disconnected SUM_ERROR_STATUS_TIME_AGENT Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Error status time SUM_HANDLE_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Contact handle time SUM_HOLD_TIME Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Customer hold time SUM_IDLE_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Agent idle time SUM_INTERACTION_AND_HOLD_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent interaction and hold time SUM_INTERACTION_TIME Unit: Seconds Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy UI name: Agent interaction time SUM_NON_PRODUCTIVE_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Non-Productive Time SUM_ONLINE_TIME_AGENT Unit: Seconds Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy UI name: Online time SUM_RETRY_CALLBACK_ATTEMPTS Unit: Count Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype UI name: Callback attempts
|
5871
6117
|
*/
|
5872
6118
|
Metrics: MetricsV2;
|
5873
6119
|
/**
|
@@ -7990,6 +8236,7 @@ declare namespace Connect {
|
|
7990
8236
|
Audio?: AudioFeatures;
|
7991
8237
|
}
|
7992
8238
|
export type MeetingId = string;
|
8239
|
+
export type MetadataUrl = string;
|
7993
8240
|
export type MetricDataCollectionsV2 = MetricDataV2[];
|
7994
8241
|
export interface MetricDataV2 {
|
7995
8242
|
/**
|
@@ -10118,6 +10365,70 @@ declare namespace Connect {
|
|
10118
10365
|
export type SourceApplicationName = string;
|
10119
10366
|
export type SourceId = string;
|
10120
10367
|
export type SourceType = "SALESFORCE"|"ZENDESK"|"CASES"|string;
|
10368
|
+
export interface StartAttachedFileUploadRequest {
|
10369
|
+
/**
|
10370
|
+
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
|
10371
|
+
*/
|
10372
|
+
ClientToken?: ClientToken;
|
10373
|
+
/**
|
10374
|
+
* The unique identifier of the Connect instance.
|
10375
|
+
*/
|
10376
|
+
InstanceId: InstanceId;
|
10377
|
+
/**
|
10378
|
+
* A case-sensitive name of the attached file being uploaded.
|
10379
|
+
*/
|
10380
|
+
FileName: FileName;
|
10381
|
+
/**
|
10382
|
+
* The size of the attached file in bytes.
|
10383
|
+
*/
|
10384
|
+
FileSizeInBytes: FileSizeInBytes;
|
10385
|
+
/**
|
10386
|
+
* Optional override for the expiry of the pre-signed S3 URL in seconds.
|
10387
|
+
*/
|
10388
|
+
UrlExpiryInSeconds?: URLExpiryInSeconds;
|
10389
|
+
/**
|
10390
|
+
* The use case for the file.
|
10391
|
+
*/
|
10392
|
+
FileUseCaseType: FileUseCaseType;
|
10393
|
+
/**
|
10394
|
+
* The resource to which the attached file is (being) uploaded to. Cases are the only current supported resource. This value must be a valid ARN.
|
10395
|
+
*/
|
10396
|
+
AssociatedResourceArn: ARN;
|
10397
|
+
/**
|
10398
|
+
* Represents the identity that created the file.
|
10399
|
+
*/
|
10400
|
+
CreatedBy?: CreatedByInfo;
|
10401
|
+
/**
|
10402
|
+
* The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
|
10403
|
+
*/
|
10404
|
+
Tags?: TagMap;
|
10405
|
+
}
|
10406
|
+
export interface StartAttachedFileUploadResponse {
|
10407
|
+
/**
|
10408
|
+
* The unique identifier of the attached file resource (ARN).
|
10409
|
+
*/
|
10410
|
+
FileArn?: ARN;
|
10411
|
+
/**
|
10412
|
+
* The unique identifier of the attached file resource.
|
10413
|
+
*/
|
10414
|
+
FileId?: FileId;
|
10415
|
+
/**
|
10416
|
+
* The time of Creation of the file resource as an ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2024-05-03T02:41:28.172Z.
|
10417
|
+
*/
|
10418
|
+
CreationTime?: ISO8601Datetime;
|
10419
|
+
/**
|
10420
|
+
* The current status of the attached file.
|
10421
|
+
*/
|
10422
|
+
FileStatus?: FileStatusType;
|
10423
|
+
/**
|
10424
|
+
* Represents the identity that created the file.
|
10425
|
+
*/
|
10426
|
+
CreatedBy?: CreatedByInfo;
|
10427
|
+
/**
|
10428
|
+
* Information to be used while uploading the attached file.
|
10429
|
+
*/
|
10430
|
+
UploadUrlMetadata?: UploadUrlMetadata;
|
10431
|
+
}
|
10121
10432
|
export interface StartChatContactRequest {
|
10122
10433
|
/**
|
10123
10434
|
* The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
|
@@ -10931,6 +11242,7 @@ declare namespace Connect {
|
|
10931
11242
|
ContactArn?: ARN;
|
10932
11243
|
}
|
10933
11244
|
export type URI = string;
|
11245
|
+
export type URLExpiryInSeconds = number;
|
10934
11246
|
export type Unit = "SECONDS"|"COUNT"|"PERCENT"|string;
|
10935
11247
|
export interface UntagContactRequest {
|
10936
11248
|
/**
|
@@ -11005,7 +11317,7 @@ declare namespace Connect {
|
|
11005
11317
|
*/
|
11006
11318
|
InstanceId: InstanceId;
|
11007
11319
|
/**
|
11008
|
-
* The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes. You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
|
11320
|
+
* The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes. You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters. When the attributes for a contact exceed 32 KB, the contact is routed down the Error branch of the flow. As a mitigation, consider the following options: Remove unnecessary attributes by setting their values to empty. If the attributes are only used in one flow and don't need to be referred to outside of that flow (for example, by a Lambda or another flow), then use flow attributes. This way you aren't needlessly persisting the 32 KB of information from one flow to another. For more information, see Flow block: Set contact attributes in the Amazon Connect Administrator Guide.
|
11009
11321
|
*/
|
11010
11322
|
Attributes: Attributes;
|
11011
11323
|
}
|
@@ -11922,7 +12234,24 @@ declare namespace Connect {
|
|
11922
12234
|
}
|
11923
12235
|
export interface UpdateViewMetadataResponse {
|
11924
12236
|
}
|
12237
|
+
export interface UploadUrlMetadata {
|
12238
|
+
/**
|
12239
|
+
* A pre-signed S3 URL that should be used for uploading the attached file.
|
12240
|
+
*/
|
12241
|
+
Url?: MetadataUrl;
|
12242
|
+
/**
|
12243
|
+
* The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
|
12244
|
+
*/
|
12245
|
+
UrlExpiry?: ISO8601Datetime;
|
12246
|
+
/**
|
12247
|
+
* A map of headers that should be provided when uploading the attached file.
|
12248
|
+
*/
|
12249
|
+
HeadersToInclude?: UrlMetadataSignedHeaders;
|
12250
|
+
}
|
11925
12251
|
export type Url = string;
|
12252
|
+
export type UrlMetadataSignedHeaders = {[key: string]: UrlMetadataSignedHeadersValue};
|
12253
|
+
export type UrlMetadataSignedHeadersKey = string;
|
12254
|
+
export type UrlMetadataSignedHeadersValue = string;
|
11926
12255
|
export interface UrlReference {
|
11927
12256
|
/**
|
11928
12257
|
* Identifier of the URL reference.
|