UpdateDashboardLinks - Amazon QuickSight

UpdateDashboardLinks

Updates the linked analyses on a dashboard.

PUT /accounts/AwsAccountId/dashboards/DashboardId/linked-entities HTTP/1.1 Content-type: application/json { "LinkEntities": [ "string" ] }

The request uses the following URI parameters.

The ID of the AWS account that contains the dashboard whose links you want to update.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

The ID for the dashboard.

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

Pattern: [\w\-]+

Required: Yes

The request accepts the following data in JSON format.

list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

Type: Array of strings

Array Members: Maximum number of 5 items.

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

Pattern: ^arn:aws[\w\-]*:quicksight:[\w\-]+:\d+:analysis/[\w\-]{1,512}

Required: Yes

HTTP/1.1 Status Content-type: application/json { "DashboardArn": "string", "LinkEntities": [ "string" ], "RequestId": "string" }

If the action is successful, the service sends back the following HTTP response.

The HTTP status of the request.

The following data is returned in JSON format by the service.

The Amazon Resource Name (ARN) of the dashboard.

Type: String

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

Type: Array of strings

Array Members: Maximum number of 5 items.

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

Pattern: ^arn:aws[\w\-]*:quicksight:[\w\-]+:\d+:analysis/[\w\-]{1,512}

The AWS request ID for this operation.

Type: String

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

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

HTTP Status Code: 401

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

HTTP Status Code: 400

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

HTTP Status Code: 429

UnsupportedUserEditionException

This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

HTTP Status Code: 403

For more information about using this API in one of the language-specific AWS SDKs, see the following: