AWS API Changes

2022/01/11 - Amazon WorkSpaces - 4 new api methods

Changes Introducing new APIs for Workspaces audio optimization with Amazon Connect: CreateConnectClientAddIn, DescribeConnectClientAddIns, UpdateConnectClientAddIn and DeleteConnectClientAddIn.

DescribeConnectClientAddIns (new)

Link ¶

Retrieves a list of Amazon Connect client add-ins that have been created.

See also: AWS API Documentation

Request Syntax

client.describe_connect_client_add_ins(
    ResourceId='string',
    NextToken='string',
    MaxResults=123
)

type ResourceId

string

param ResourceId

[REQUIRED]

The directory identifier for which the client add-in is configured.

type NextToken

string

param NextToken

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

type MaxResults

integer

param MaxResults

The maximum number of items to return.

rtype

dict

returns

Response Syntax

{
    'AddIns': [
        {
            'AddInId': 'string',
            'ResourceId': 'string',
            'Name': 'string',
            'URL': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- AddIns (list) --
  
  Information about client add-ins.
  - (dict) --
    
    Describes an Amazon Connect client add-in.
    - AddInId (string) --
      
      The client add-in identifier.
    - ResourceId (string) --
      
      The directory identifier for which the client add-in is configured.
    - Name (string) --
      
      The name of the client add in.
    - URL (string) --
      
      The endpoint URL of the client add-in.
- NextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DeleteConnectClientAddIn (new)

Link ¶

Deletes a client-add-in for Amazon Connect that is configured within a directory.

See also: AWS API Documentation

Request Syntax

client.delete_connect_client_add_in(
    AddInId='string',
    ResourceId='string'
)

type AddInId

string

param AddInId

[REQUIRED]

The identifier of the client add-in to delete.

type ResourceId

string

param ResourceId

[REQUIRED]

The directory identifier for which the client add-in is configured.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

CreateConnectClientAddIn (new)

Link ¶

Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory.

This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.

See also: AWS API Documentation

Request Syntax

client.create_connect_client_add_in(
    ResourceId='string',
    Name='string',
    URL='string'
)

type ResourceId

string

param ResourceId

[REQUIRED]

The directory identifier for which to configure the client add-in.

type Name

string

param Name

[REQUIRED]

The name of the client add-in.

type URL

string

param URL

[REQUIRED]

The endpoint URL of the Amazon Connect client add-in.

rtype

dict

returns

Response Syntax

{
    'AddInId': 'string'
}

Response Structure

(dict) --
- AddInId (string) --
  
  The client add-in identifier.

UpdateConnectClientAddIn (new)

Link ¶

Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.

See also: AWS API Documentation

Request Syntax

client.update_connect_client_add_in(
    AddInId='string',
    ResourceId='string',
    Name='string',
    URL='string'
)

type AddInId

string

param AddInId

[REQUIRED]

The identifier of the client add-in to update.

type ResourceId

string

param ResourceId

[REQUIRED]

The directory identifier for which the client add-in is configured.

type Name

string

param Name

The name of the client add-in.

type URL

string

param URL

The endpoint URL of the Amazon Connect client add-in.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --