attachments
Creates, updates, deletes, gets or lists an attachments resource.
Overview
| Name | attachments |
| Type | Resource |
| Id | aws.connectparticipant.attachments |
Fields
The following fields are returned by SELECT queries:
- get_attachment
| Name | Datatype | Description |
|---|---|---|
attachment_size_in_bytes | integer (int64) | The size of the attachment in bytes. |
url | string | This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response to StartAttachmentUpload. |
url_expiry | string | 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. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_attachment | select | X-Amz-Bearer, region | Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts. For security recommendations, see Connect Customer Chat security best practices. The participant role CUSTOM_BOT is not permitted to access attachments customers may upload. An AccessDeniedException can indicate that the participant may be a CUSTOM_BOT, and it doesn't have access to attachments. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. | |
complete_attachment_upload | exec | X-Amz-Bearer, region, AttachmentIds, ClientToken | Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API. A conflict exception is thrown when an attachment with that identifier is already being uploaded. For security recommendations, see Connect Customer Chat security best practices. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. | |
start_attachment_upload | exec | X-Amz-Bearer, region, ContentType, AttachmentSizeInBytes, AttachmentName, ClientToken | Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3. For security recommendations, see Connect Customer Chat security best practices. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
X-Amz-Bearer | string | The authentication token associated with the participant's connection. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_attachment
Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts. For security recommendations, see Connect Customer Chat security best practices. The participant role CUSTOM_BOT is not permitted to access attachments customers may upload. An AccessDeniedException can indicate that the participant may be a CUSTOM_BOT, and it doesn't have access to attachments. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
SELECT
attachment_size_in_bytes,
url,
url_expiry
FROM aws.connectparticipant.attachments
WHERE `X-Amz-Bearer` = '{{ X-Amz-Bearer }}' -- required
AND region = '{{ region }}' -- required
;
Lifecycle Methods
- complete_attachment_upload
- start_attachment_upload
Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API. A conflict exception is thrown when an attachment with that identifier is already being uploaded. For security recommendations, see Connect Customer Chat security best practices. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
EXEC aws.connectparticipant.attachments.complete_attachment_upload
@X-Amz-Bearer='{{ X-Amz-Bearer }}' --required,
@region='{{ region }}' --required
@@json=
'{
"AttachmentIds": "{{ AttachmentIds }}",
"ClientToken": "{{ ClientToken }}"
}'
;
Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3. For security recommendations, see Connect Customer Chat security best practices. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
EXEC aws.connectparticipant.attachments.start_attachment_upload
@X-Amz-Bearer='{{ X-Amz-Bearer }}' --required,
@region='{{ region }}' --required
@@json=
'{
"ContentType": "{{ ContentType }}",
"AttachmentSizeInBytes": {{ AttachmentSizeInBytes }},
"AttachmentName": "{{ AttachmentName }}",
"ClientToken": "{{ ClientToken }}"
}'
;