Connect / Client / disassociate_workspace

disassociate_workspace

Connect.Client.disassociate_workspace(**kwargs)

Removes the association between a workspace and one or more users or routing profiles.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_workspace(
    InstanceId='string',
    WorkspaceId='string',
    ResourceArns=[
        'string',
    ]
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

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

  • WorkspaceId (string) –

    [REQUIRED]

    The identifier of the workspace.

  • ResourceArns (list) –

    [REQUIRED]

    The Amazon Resource Names (ARNs) of the resources to disassociate from the workspace.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'SuccessfulList': [
        {
            'ResourceArn': 'string'
        },
    ],
    'FailedList': [
        {
            'ResourceArn': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • SuccessfulList (list) –

      A list of resources that were successfully disassociated from the workspace.

      • (dict) –

        Contains information about a resource that was successfully associated with a workspace in a batch operation.

        • ResourceArn (string) –

          The Amazon Resource Name (ARN) of the resource that was successfully associated.

    • FailedList (list) –

      A list of resources that failed to be disassociated from the workspace, including error details.

      • (dict) –

        Contains information about a resource that failed to be associated with a workspace in a batch operation.

        • ResourceArn (string) –

          The Amazon Resource Name (ARN) of the resource that failed to be associated.

        • ErrorCode (string) –

          The error code indicating why the association failed.

        • ErrorMessage (string) –

          An error message describing why the association failed.

Exceptions