Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

AssociateWorkspace

Associates a workspace with one or more users or routing profiles, allowing them to access the workspace's configured views and pages.

Request Syntax


POST /workspaces/InstanceId/WorkspaceId/associate HTTP/1.1
Content-type: application/json

{
   "ResourceArns": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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

Required: Yes

WorkspaceId

The identifier of the workspace.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

ResourceArns

The Amazon Resource Names (ARNs) of the resources to associate with the workspace. Valid resource types are users and routing profiles.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "FailedList": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "ResourceArn": "string"
      }
   ],
   "SuccessfulList": [ 
      { 
         "ResourceArn": "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.

FailedList

A list of resources that failed to be associated with the workspace, including error details.

Type: Array of FailedBatchAssociationSummary objects

SuccessfulList

A list of resources that were successfully associated with the workspace.

Type: Array of SuccessfulBatchAssociationSummary objects

Errors

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

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

DuplicateResourceException

A resource with the specified name already exists.

HTTP Status Code: 409

InternalServiceException

Request processing failed because of an error or failure with the service.

Message: The message.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

Message: The message about the parameters.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

Message: The message about the request.
Reason: Reason why the request was invalid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429