Amazonka.ConnectParticipant.GetAttachment

Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.

ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Creating a Request

data GetAttachment

See: newGetAttachment smart constructor.

Constructors

GetAttachment'

Fields

• attachmentId :: Text

  A unique identifier for the attachment.

• connectionToken :: Text

  The authentication token associated with the participant's connection.

Instances

ToJSON GetAttachment

Defined in Amazonka.ConnectParticipant.GetAttachment

Methods

toJSON :: GetAttachment -> Value

toEncoding :: GetAttachment -> Encoding

toJSONList :: [GetAttachment] -> Value

toEncodingList :: [GetAttachment] -> Encoding

ToHeaders GetAttachment

Defined in Amazonka.ConnectParticipant.GetAttachment

Methods

toHeaders :: GetAttachment -> [Header]

ToPath GetAttachment

Defined in Amazonka.ConnectParticipant.GetAttachment

Methods

toPath :: GetAttachment -> ByteString

ToQuery GetAttachment

Defined in Amazonka.ConnectParticipant.GetAttachment

Methods

toQuery :: GetAttachment -> QueryString

AWSRequest GetAttachment

Defined in Amazonka.ConnectParticipant.GetAttachment

Associated Types

type AWSResponse GetAttachment

Methods

request :: (Service -> Service) -> GetAttachment -> Request GetAttachment

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetAttachment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetAttachment)))

Generic GetAttachment

Defined in Amazonka.ConnectParticipant.GetAttachment

Associated Types

type Rep GetAttachment :: Type -> Type

Methods

from :: GetAttachment -> Rep GetAttachment x

to :: Rep GetAttachment x -> GetAttachment

Read GetAttachment

Defined in Amazonka.ConnectParticipant.GetAttachment

Methods

readsPrec :: Int -> ReadS GetAttachment

readList :: ReadS [GetAttachment]

readPrec :: ReadPrec GetAttachment

readListPrec :: ReadPrec [GetAttachment]

Show GetAttachment

Defined in Amazonka.ConnectParticipant.GetAttachment

Methods

showsPrec :: Int -> GetAttachment -> ShowS

show :: GetAttachment -> String

showList :: [GetAttachment] -> ShowS

NFData GetAttachment

Defined in Amazonka.ConnectParticipant.GetAttachment

Methods

rnf :: GetAttachment -> ()

Eq GetAttachment

Defined in Amazonka.ConnectParticipant.GetAttachment

Methods

(==) :: GetAttachment -> GetAttachment -> Bool

(/=) :: GetAttachment -> GetAttachment -> Bool

Hashable GetAttachment

Defined in Amazonka.ConnectParticipant.GetAttachment

Methods

hashWithSalt :: Int -> GetAttachment -> Int

hash :: GetAttachment -> Int

type AWSResponse GetAttachment

Defined in Amazonka.ConnectParticipant.GetAttachment

type AWSResponse GetAttachment = GetAttachmentResponse

type Rep GetAttachment

Defined in Amazonka.ConnectParticipant.GetAttachment

type Rep GetAttachment = D1 ('MetaData "GetAttachment" "Amazonka.ConnectParticipant.GetAttachment" "amazonka-connectparticipant-2.0-I4GmkIlwxQUGg1dW7eNFQJ" 'False) (C1 ('MetaCons "GetAttachment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attachmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "connectionToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetAttachment

Arguments

:: Text

GetAttachment

-> Text

GetAttachment

-> GetAttachment

Create a value of GetAttachment 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:

GetAttachment, getAttachment_attachmentId - A unique identifier for the attachment.

GetAttachment, getAttachment_connectionToken - The authentication token associated with the participant's connection.

Request Lenses

getAttachment_attachmentId :: Lens' GetAttachment Text

A unique identifier for the attachment.

getAttachment_connectionToken :: Lens' GetAttachment Text

The authentication token associated with the participant's connection.

Destructuring the Response

data GetAttachmentResponse

See: newGetAttachmentResponse smart constructor.

Constructors

GetAttachmentResponse'

Fields

• url :: Maybe Text

  This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response to StartAttachmentUpload.

• urlExpiry :: Maybe Text

  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.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetAttachmentResponse

Defined in Amazonka.ConnectParticipant.GetAttachment

Associated Types

type Rep GetAttachmentResponse :: Type -> Type

Methods

from :: GetAttachmentResponse -> Rep GetAttachmentResponse x

to :: Rep GetAttachmentResponse x -> GetAttachmentResponse

Read GetAttachmentResponse

Defined in Amazonka.ConnectParticipant.GetAttachment

Methods

readsPrec :: Int -> ReadS GetAttachmentResponse

readList :: ReadS [GetAttachmentResponse]

readPrec :: ReadPrec GetAttachmentResponse

readListPrec :: ReadPrec [GetAttachmentResponse]

Show GetAttachmentResponse

Defined in Amazonka.ConnectParticipant.GetAttachment

Methods

showsPrec :: Int -> GetAttachmentResponse -> ShowS

show :: GetAttachmentResponse -> String

showList :: [GetAttachmentResponse] -> ShowS

NFData GetAttachmentResponse

Defined in Amazonka.ConnectParticipant.GetAttachment

Methods

rnf :: GetAttachmentResponse -> ()

Eq GetAttachmentResponse

Defined in Amazonka.ConnectParticipant.GetAttachment

Methods

(==) :: GetAttachmentResponse -> GetAttachmentResponse -> Bool

(/=) :: GetAttachmentResponse -> GetAttachmentResponse -> Bool

type Rep GetAttachmentResponse

Defined in Amazonka.ConnectParticipant.GetAttachment

type Rep GetAttachmentResponse = D1 ('MetaData "GetAttachmentResponse" "Amazonka.ConnectParticipant.GetAttachment" "amazonka-connectparticipant-2.0-I4GmkIlwxQUGg1dW7eNFQJ" 'False) (C1 ('MetaCons "GetAttachmentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "urlExpiry") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetAttachmentResponse

Arguments

:: Int

$sel:httpStatus:GetAttachmentResponse'

-> GetAttachmentResponse

Create a value of GetAttachmentResponse 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:

GetAttachmentResponse, getAttachmentResponse_url - This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response to StartAttachmentUpload.

GetAttachmentResponse, getAttachmentResponse_urlExpiry - 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.

$sel:httpStatus:GetAttachmentResponse', getAttachmentResponse_httpStatus - The response's http status code.

Response Lenses

getAttachmentResponse_url :: Lens' GetAttachmentResponse (Maybe Text)

This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response to StartAttachmentUpload.

getAttachmentResponse_urlExpiry :: Lens' GetAttachmentResponse (Maybe Text)

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.

getAttachmentResponse_httpStatus :: Lens' GetAttachmentResponse Int

The response's http status code.