updateWorkspaceMetadata method

Future<void> updateWorkspaceMetadata({
  1. required String instanceId,
  2. required String workspaceId,
  3. String? description,
  4. String? name,
  5. String? title,
})

Updates the metadata of a workspace, such as its name and description.

May throw AccessDeniedException. May throw DuplicateResourceException. May throw InternalServiceException. May throw InvalidParameterException. May throw InvalidRequestException. May throw ResourceNotFoundException. May throw ThrottlingException.

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

Parameter workspaceId : The identifier of the workspace.

Parameter description : The description of the workspace.

Parameter name : The name of the workspace.

Parameter title : The title displayed for the workspace.

Implementation

Future<void> updateWorkspaceMetadata({
  required String instanceId,
  required String workspaceId,
  String? description,
  String? name,
  String? title,
}) async {
  final $payload = <String, dynamic>{
    if (description != null) 'Description': description,
    if (name != null) 'Name': name,
    if (title != null) 'Title': title,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri:
        '/workspaces/${Uri.encodeComponent(instanceId)}/${Uri.encodeComponent(workspaceId)}/metadata',
    exceptionFnMap: _exceptionFns,
  );
}