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

UpdateTemplatePermissions

Updates the resource permissions for a template.

Request Syntax


PUT /accounts/AwsAccountId/templates/TemplateId/permissions HTTP/1.1
Content-type: application/json

{
   "GrantPermissions": [ 
      { 
         "Actions": [ "string" ],
         "Principal": "string"
      }
   ],
   "RevokePermissions": [ 
      { 
         "Actions": [ "string" ],
         "Principal": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID of the AWS account that contains the template.

Length Constraints: Fixed length of 12.

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

Required: Yes

TemplateId

The ID for the template.

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

Pattern: [\w\-]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

GrantPermissions

A list of resource permissions to be granted on the template.

Type: Array of ResourcePermission objects

Array Members: Maximum number of 100 items.

Required: No

RevokePermissions

A list of resource permissions to be revoked from the template.

Type: Array of ResourcePermission objects

Array Members: Maximum number of 100 items.

Required: No

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "Permissions": [ 
      { 
         "Actions": [ "string" ],
         "Principal": "string"
      }
   ],
   "RequestId": "string",
   "TemplateArn": "string",
   "TemplateId": "string"
}

Response Elements

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

Status: The HTTP status of the request.

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

Permissions

A list of resource permissions to be set on the template.

Type: Array of ResourcePermission objects

Array Members: Maximum number of 100 items.

RequestId

The AWS request ID for this operation.

Type: String

TemplateArn

The Amazon Resource Name (ARN) of the template.

Type: String

TemplateId

The ID for the template.

Type: String

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

Pattern: [\w\-]+

Errors

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

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

LimitExceededException

A limit is exceeded.

HTTP Status Code: 409

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