Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

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.

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 to support idempotency of request.
connectionToken :: Text
The authentication token associated with the participant's connection.

Instances

Instances details

Eq StartAttachmentUpload Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Methods (==) :: StartAttachmentUpload -> StartAttachmentUpload -> Bool # (/=) :: StartAttachmentUpload -> StartAttachmentUpload -> Bool #
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 #
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 #
NFData StartAttachmentUpload Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Methods rnf :: StartAttachmentUpload -> () #
Hashable StartAttachmentUpload Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Methods hashWithSalt :: Int -> StartAttachmentUpload -> Int # hash :: StartAttachmentUpload -> Int #
ToJSON StartAttachmentUpload Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Methods toJSON :: StartAttachmentUpload -> Value # toEncoding :: StartAttachmentUpload -> Encoding # toJSONList :: [StartAttachmentUpload] -> Value # toEncodingList :: [StartAttachmentUpload] -> Encoding #
AWSRequest StartAttachmentUpload Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Associated Types type AWSResponse StartAttachmentUpload # Methods request :: StartAttachmentUpload -> Request StartAttachmentUpload # response :: MonadResource m => Logger -> Service -> Proxy StartAttachmentUpload -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartAttachmentUpload))) #
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 #
type Rep StartAttachmentUpload Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload type Rep StartAttachmentUpload = D1 ('MetaData "StartAttachmentUpload" "Amazonka.ConnectParticipant.StartAttachmentUpload" "libZSservicesZSamazonka-connectparticipantZSamazonka-connectparticipant" '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)))))
type AWSResponse StartAttachmentUpload Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload type AWSResponse StartAttachmentUpload = StartAttachmentUploadResponse

newStartAttachmentUpload Source #

Arguments

:: Text	`$sel:contentType:StartAttachmentUpload'`
-> Natural	`$sel:attachmentSizeInBytes:StartAttachmentUpload'`
-> Text	`$sel:attachmentName:StartAttachmentUpload'`
-> Text	`$sel:clientToken:StartAttachmentUpload'`
-> Text	`$sel:connectionToken: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:

$sel:contentType: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.

$sel:attachmentName:StartAttachmentUpload', startAttachmentUpload_attachmentName - A case-sensitive name of the attachment being uploaded.

$sel:clientToken:StartAttachmentUpload', startAttachmentUpload_clientToken - A unique case sensitive identifier to support idempotency of request.

$sel:connectionToken: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 to support idempotency of request.

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

Eq StartAttachmentUploadResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Methods (==) :: StartAttachmentUploadResponse -> StartAttachmentUploadResponse -> Bool # (/=) :: StartAttachmentUploadResponse -> StartAttachmentUploadResponse -> Bool #
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 #
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 #
NFData StartAttachmentUploadResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload Methods rnf :: StartAttachmentUploadResponse -> () #
type Rep StartAttachmentUploadResponse Source #
Instance details Defined in Amazonka.ConnectParticipant.StartAttachmentUpload type Rep StartAttachmentUploadResponse = D1 ('MetaData "StartAttachmentUploadResponse" "Amazonka.ConnectParticipant.StartAttachmentUpload" "libZSservicesZSamazonka-connectparticipantZSamazonka-connectparticipant" '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:

$sel:attachmentId: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.