Amazon Connect Participant Service

2024/12/18 - Amazon Connect Participant Service - 2 new1 updated api methods

Changes  This release adds support for the GetAuthenticationUrl and CancelParticipantAuthentication APIs used for customer authentication within Amazon Connect chats. There are also minor updates to the GetAttachment API.

CancelParticipantAuthentication (new) Link ¶

Cancels the authentication session. The opted out branch of the Authenticate Customer flow block will be taken.

See also: AWS API Documentation

Request Syntax

client.cancel_participant_authentication(
    SessionId='string',
    ConnectionToken='string'
)
type SessionId:

string

param SessionId:

[REQUIRED]

The sessionId provided in the authenticationInitiated event.

type ConnectionToken:

string

param ConnectionToken:

[REQUIRED]

The authentication token associated with the participant's connection.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

GetAuthenticationUrl (new) Link ¶

Retrieves the AuthenticationUrl for the current authentication session for the AuthenticateCustomer flow block.

For security recommendations, see Amazon Connect Chat security best practices.

See also: AWS API Documentation

Request Syntax

client.get_authentication_url(
    SessionId='string',
    RedirectUri='string',
    ConnectionToken='string'
)
type SessionId:

string

param SessionId:

[REQUIRED]

The sessionId provided in the authenticationInitiated event.

type RedirectUri:

string

param RedirectUri:

[REQUIRED]

The URL where the customer will be redirected after Amazon Cognito authorizes the user.

type ConnectionToken:

string

param ConnectionToken:

[REQUIRED]

The authentication token associated with the participant's connection.

rtype:

dict

returns:

Response Syntax

{
    'AuthenticationUrl': 'string'
}

Response Structure

  • (dict) --

    • AuthenticationUrl (string) --

      The URL where the customer will sign in to the identity provider. This URL contains the authorize endpoint for the Cognito UserPool used in the authentication.

GetAttachment (updated) Link ¶
Changes (request, response)
Request 
{'UrlExpiryInSeconds': 'integer'}
Response 
{'AttachmentSizeInBytes': 'long'}

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 Amazon Connect Chat security best practices.

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

See also: AWS API Documentation

Request Syntax

client.get_attachment(
    AttachmentId='string',
    ConnectionToken='string',
    UrlExpiryInSeconds=123
)
type AttachmentId:

string

param AttachmentId:

[REQUIRED]

A unique identifier for the attachment.

type ConnectionToken:

string

param ConnectionToken:

[REQUIRED]

The authentication token associated with the participant's connection.

type UrlExpiryInSeconds:

integer

param UrlExpiryInSeconds:

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.

rtype:

dict

returns:

Response Syntax

{
    'Url': 'string',
    'UrlExpiry': 'string',
    'AttachmentSizeInBytes': 123
}

Response Structure

  • (dict) --

    • 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.

    • UrlExpiry (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.

    • AttachmentSizeInBytes (integer) --

      The size of the attachment in bytes.