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

Amazonka.ConnectParticipant.StartAttachmentUpload

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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' {
- contentType :: Text
- attachmentSizeInBytes :: Natural
- attachmentName :: Text
- clientToken :: Text
- connectionToken :: Text
}
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' {
- attachmentId :: Maybe Text
- uploadMetadata :: Maybe UploadMetadata
- httpStatus :: Int
}
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.

Constructors

StartAttachmentUpload'

Fields

contentType :: Text
Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.
attachmentSizeInBytes :: Natural
The size of the attachment in bytes.
attachmentName :: Text
A case-sensitive name of the attachment being uploaded.
clientToken :: Text
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.
connectionToken :: Text
The authentication token associated with the participant's connection.

Instances

Instances details

ToJSON StartAttachmentUpload Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Methods toJSON :: StartAttachmentUpload -> Value # toEncoding :: StartAttachmentUpload -> Encoding # toJSONList :: [StartAttachmentUpload] -> Value # toEncodingList :: [StartAttachmentUpload] -> Encoding #
ToHeaders StartAttachmentUpload Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Methods toHeaders :: StartAttachmentUpload -> [Header] #
ToPath StartAttachmentUpload Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Methods toPath :: StartAttachmentUpload -> ByteString #
ToQuery StartAttachmentUpload Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Methods toQuery :: StartAttachmentUpload -> QueryString #
AWSRequest StartAttachmentUpload Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Associated Types type AWSResponse StartAttachmentUpload # Methods request :: (Service -> Service) -> StartAttachmentUpload -> Request StartAttachmentUpload # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartAttachmentUpload -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartAttachmentUpload))) #
Generic StartAttachmentUpload Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Associated Types type Rep StartAttachmentUpload :: Type -> Type # Methods from :: StartAttachmentUpload -> Rep StartAttachmentUpload x # to :: Rep StartAttachmentUpload x -> StartAttachmentUpload #
Read StartAttachmentUpload Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Methods readsPrec :: Int -> ReadS StartAttachmentUpload # readList :: ReadS [StartAttachmentUpload] # readPrec :: ReadPrec StartAttachmentUpload # readListPrec :: ReadPrec [StartAttachmentUpload] #
Show StartAttachmentUpload Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Methods showsPrec :: Int -> StartAttachmentUpload -> ShowS # show :: StartAttachmentUpload -> String # showList :: [StartAttachmentUpload] -> ShowS #
NFData StartAttachmentUpload Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Methods rnf :: StartAttachmentUpload -> () #
Eq StartAttachmentUpload Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Methods (==) :: StartAttachmentUpload -> StartAttachmentUpload -> Bool # (/=) :: StartAttachmentUpload -> StartAttachmentUpload -> Bool #
Hashable StartAttachmentUpload Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Methods hashWithSalt :: Int -> StartAttachmentUpload -> Int # hash :: StartAttachmentUpload -> Int #
type AWSResponse StartAttachmentUpload Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload type AWSResponse StartAttachmentUpload = StartAttachmentUploadResponse
type Rep StartAttachmentUpload Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload type Rep StartAttachmentUpload = D1 ('MetaData "StartAttachmentUpload" "Amazonka.ConnectParticipant.StartAttachmentUpload" "amazonka-connectparticipant-2.0-I4GmkIlwxQUGg1dW7eNFQJ" 'False) (C1 ('MetaCons "StartAttachmentUpload'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "attachmentSizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)) :: (S1 ('MetaSel ('Just "attachmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "connectionToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newStartAttachmentUpload Source #

Arguments

:: Text	`StartAttachmentUpload`
-> Natural	`$sel:attachmentSizeInBytes:StartAttachmentUpload'`
-> Text	`StartAttachmentUpload`
-> Text	`$sel:clientToken:StartAttachmentUpload'`
-> Text	`StartAttachmentUpload`
-> StartAttachmentUpload

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.

Constructors

StartAttachmentUploadResponse'
Fields attachmentId :: Maybe Text A unique identifier for the attachment. uploadMetadata :: Maybe UploadMetadata Fields to be used while uploading the attachment. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic StartAttachmentUploadResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Associated Types type Rep StartAttachmentUploadResponse :: Type -> Type # Methods from :: StartAttachmentUploadResponse -> Rep StartAttachmentUploadResponse x # to :: Rep StartAttachmentUploadResponse x -> StartAttachmentUploadResponse #
Read StartAttachmentUploadResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Methods readsPrec :: Int -> ReadS StartAttachmentUploadResponse # readList :: ReadS [StartAttachmentUploadResponse] # readPrec :: ReadPrec StartAttachmentUploadResponse # readListPrec :: ReadPrec [StartAttachmentUploadResponse] #
Show StartAttachmentUploadResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Methods showsPrec :: Int -> StartAttachmentUploadResponse -> ShowS # show :: StartAttachmentUploadResponse -> String # showList :: [StartAttachmentUploadResponse] -> ShowS #
NFData StartAttachmentUploadResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Methods rnf :: StartAttachmentUploadResponse -> () #
Eq StartAttachmentUploadResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Methods (==) :: StartAttachmentUploadResponse -> StartAttachmentUploadResponse -> Bool # (/=) :: StartAttachmentUploadResponse -> StartAttachmentUploadResponse -> Bool #
type Rep StartAttachmentUploadResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload type Rep StartAttachmentUploadResponse = D1 ('MetaData "StartAttachmentUploadResponse" "Amazonka.ConnectParticipant.StartAttachmentUpload" "amazonka-connectparticipant-2.0-I4GmkIlwxQUGg1dW7eNFQJ" 'False) (C1 ('MetaCons "StartAttachmentUploadResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attachmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "uploadMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UploadMetadata)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newStartAttachmentUploadResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartAttachmentUploadResponse'`
-> StartAttachmentUploadResponse

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.