WorkSpaces / Client / describe_connect_client_add_ins

describe_connect_client_add_ins#

WorkSpaces.Client.describe_connect_client_add_ins(**kwargs)#

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

Request Syntax

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

Parameters:

ResourceId (string) –
[REQUIRED]

The directory identifier for which the client add-in is configured.
NextToken (string) – If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
MaxResults (integer) – The maximum number of items to return.

Return type:

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.

Exceptions

WorkSpaces.Client.exceptions.InvalidParameterValuesException
WorkSpaces.Client.exceptions.ResourceNotFoundException
WorkSpaces.Client.exceptions.AccessDeniedException