View a markdown version of this page

UpdateAppPermissions - Amazon Quick
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

UpdateAppPermissions

Updates the resource permissions for an app. You can grant or revoke permissions and, optionally, change the app's visibility.

Request Syntax

PUT /accounts/AwsAccountId/apps/AppId/permissions HTTP/1.1 Content-type: application/json { "GrantPermissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "RevokePermissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "Visibility": "string" }

URI Request Parameters

The request uses the following URI parameters.

AppId

The ID of the app.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

AwsAccountId

The ID of the Amazon account that contains the app.

Length Constraints: Fixed length of 12.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

GrantPermissions

The permissions that you want to grant on the app.

Type: Array of ResourcePermission objects

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

Required: No

RevokePermissions

The permissions that you want to revoke from the app.

Type: Array of ResourcePermission objects

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

Required: No

Visibility

The visibility to set for the app. Currently, only PRIVATE is accepted, which removes public (anonymous) access from the app. If you don't specify a value, the app's visibility is unchanged. Setting an app to PUBLIC through this operation is not supported.

Type: String

Valid Values: PRIVATE | PUBLIC

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "AppId": "string", "Arn": "string", "Permissions": [ { "Actions": [ "string" ], "Principal": "string" } ], "RequestId": "string", "Visibility": "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.

AppId

The ID of the app.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Arn

The Amazon Resource Name (ARN) of the app.

Type: String

Permissions

The updated resource permissions for the app.

Type: Array of ResourcePermission objects

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

RequestId

The Amazon request ID for this operation.

Type: String

Visibility

The visibility of the app after the update (PRIVATE or PUBLIC).

Type: String

Valid Values: PRIVATE | PUBLIC

Errors

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

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 Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.

RequestId

The Amazon request ID for this request.

HTTP Status Code: 401

ConflictException

Updating or deleting a resource can cause an inconsistent state.

RequestId

The Amazon request ID for this request.

HTTP Status Code: 409

InternalFailureException

An internal failure occurred.

RequestId

The Amazon request ID for this request.

HTTP Status Code: 500

InvalidParameterException

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

RequestId

The Amazon request ID for this request.

HTTP Status Code: 400

ResourceNotFoundException

One or more resources can't be found.

RequestId

The Amazon request ID for this request.

ResourceType

The resource type for this request.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

RequestId

The Amazon request ID for this request.

HTTP Status Code: 429

See Also

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