Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.
ConnectionToken
is used for invoking this API instead of
ParticipantToken
.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
Synopsis
- data StartAttachmentUpload = StartAttachmentUpload' {}
- newStartAttachmentUpload :: Text -> Natural -> Text -> Text -> Text -> StartAttachmentUpload
- startAttachmentUpload_contentType :: Lens' StartAttachmentUpload Text
- startAttachmentUpload_attachmentSizeInBytes :: Lens' StartAttachmentUpload Natural
- startAttachmentUpload_attachmentName :: Lens' StartAttachmentUpload Text
- startAttachmentUpload_clientToken :: Lens' StartAttachmentUpload Text
- startAttachmentUpload_connectionToken :: Lens' StartAttachmentUpload Text
- data StartAttachmentUploadResponse = StartAttachmentUploadResponse' {}
- newStartAttachmentUploadResponse :: Int -> StartAttachmentUploadResponse
- startAttachmentUploadResponse_attachmentId :: Lens' StartAttachmentUploadResponse (Maybe Text)
- startAttachmentUploadResponse_uploadMetadata :: Lens' StartAttachmentUploadResponse (Maybe UploadMetadata)
- startAttachmentUploadResponse_httpStatus :: Lens' StartAttachmentUploadResponse Int
Creating a Request
data StartAttachmentUpload Source #
See: newStartAttachmentUpload
smart constructor.
StartAttachmentUpload' | |
|
Instances
newStartAttachmentUpload Source #
Create a value of StartAttachmentUpload
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartAttachmentUpload
, startAttachmentUpload_contentType
- Describes the MIME file type of the attachment. For a list of supported
file types, see
Feature specifications
in the Amazon Connect Administrator Guide.
$sel:attachmentSizeInBytes:StartAttachmentUpload'
, startAttachmentUpload_attachmentSizeInBytes
- The size of the attachment in bytes.
StartAttachmentUpload
, startAttachmentUpload_attachmentName
- A case-sensitive name of the attachment being uploaded.
$sel:clientToken:StartAttachmentUpload'
, startAttachmentUpload_clientToken
- 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.
StartAttachmentUpload
, startAttachmentUpload_connectionToken
- The authentication token associated with the participant's connection.
Request Lenses
startAttachmentUpload_contentType :: Lens' StartAttachmentUpload Text Source #
Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.
startAttachmentUpload_attachmentSizeInBytes :: Lens' StartAttachmentUpload Natural Source #
The size of the attachment in bytes.
startAttachmentUpload_attachmentName :: Lens' StartAttachmentUpload Text Source #
A case-sensitive name of the attachment being uploaded.
startAttachmentUpload_clientToken :: Lens' StartAttachmentUpload Text Source #
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.
startAttachmentUpload_connectionToken :: Lens' StartAttachmentUpload Text Source #
The authentication token associated with the participant's connection.
Destructuring the Response
data StartAttachmentUploadResponse Source #
See: newStartAttachmentUploadResponse
smart constructor.
StartAttachmentUploadResponse' | |
|
Instances
newStartAttachmentUploadResponse Source #
Create a value of StartAttachmentUploadResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartAttachmentUploadResponse
, startAttachmentUploadResponse_attachmentId
- A unique identifier for the attachment.
$sel:uploadMetadata:StartAttachmentUploadResponse'
, startAttachmentUploadResponse_uploadMetadata
- Fields to be used while uploading the attachment.
$sel:httpStatus:StartAttachmentUploadResponse'
, startAttachmentUploadResponse_httpStatus
- The response's http status code.
Response Lenses
startAttachmentUploadResponse_attachmentId :: Lens' StartAttachmentUploadResponse (Maybe Text) Source #
A unique identifier for the attachment.
startAttachmentUploadResponse_uploadMetadata :: Lens' StartAttachmentUploadResponse (Maybe UploadMetadata) Source #
Fields to be used while uploading the attachment.
startAttachmentUploadResponse_httpStatus :: Lens' StartAttachmentUploadResponse Int Source #
The response's http status code.