DescribeConnectClientAddIns - Amazon WorkSpaces Service


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

Request Syntax

{ "MaxResults": number, "NextToken": "string", "ResourceId": "string" }

Request Parameters

The request accepts the following data in JSON format.


The maximum number of items to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 25.

Required: No


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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No


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

Type: String

Length Constraints: Minimum length of 10. Maximum length of 65.

Pattern: ^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)

Required: Yes

Response Syntax

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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


Information about client add-ins.

Type: Array of ConnectClientAddIn objects


The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.


For information about the errors that are common to all actions, see Common Errors.


The user is not authorized to access a resource.

HTTP Status Code: 400


One or more parameter values are not valid.

HTTP Status Code: 400


The resource could not be found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: