CreateConnectClientAddIn - Amazon WorkSpaces Service

CreateConnectClientAddIn

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.

Request Syntax

{ "Name": "string", "ResourceId": "string", "URL": "string" }

Request Parameters

The request accepts the following data in JSON format.

Name

The name of the client add-in.

Type: String

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

Pattern: ^.*$

Required: Yes

ResourceId

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

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

URL

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

Type: String

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

Pattern: ^(http|https)\://\S+

Required: Yes

Response Syntax

{ "AddInId": "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.

AddInId

The client add-in identifier.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Errors

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

AccessDeniedException

The user is not authorized to access a resource.

HTTP Status Code: 400

InvalidParameterValuesException

One or more parameter values are not valid.

HTTP Status Code: 400

ResourceAlreadyExistsException

The specified resource already exists.

HTTP Status Code: 400

ResourceCreationFailedException

The resource could not be created.

HTTP Status Code: 400

ResourceNotFoundException

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: