CreateConnectClientAddInCommand

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WorkSpacesClient, CreateConnectClientAddInCommand } from "@aws-sdk/client-workspaces"; // ES Modules import
// const { WorkSpacesClient, CreateConnectClientAddInCommand } = require("@aws-sdk/client-workspaces"); // CommonJS import
const client = new WorkSpacesClient(config);
const input = { // CreateConnectClientAddInRequest
  ResourceId: "STRING_VALUE", // required
  Name: "STRING_VALUE", // required
  URL: "STRING_VALUE", // required
};
const command = new CreateConnectClientAddInCommand(input);
const response = await client.send(command);
// { // CreateConnectClientAddInResult
//   AddInId: "STRING_VALUE",
// };

CreateConnectClientAddInCommand Input

Parameter
Type
Description
Name
Required
string | undefined

The name of the client add-in.

ResourceId
Required
string | undefined

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

URL
Required
string | undefined

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

CreateConnectClientAddInCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
AddInId
string | undefined

The client add-in identifier.

Throws

Name
Fault
Details
AccessDeniedException
client

The user is not authorized to access a resource.

InvalidParameterValuesException
client

One or more parameter values are not valid.

ResourceAlreadyExistsException
client

The specified resource already exists.

ResourceCreationFailedException
client

The resource could not be created.

ResourceNotFoundException
client

The resource could not be found.

WorkSpacesServiceException
Base exception class for all service exceptions from WorkSpaces service.