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

UpdateFlowPermissions

Updates permissions against principals on a flow.

Request Syntax


PUT /accounts/AwsAccountId/flows/FlowId/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 flow you are updating permissions against.

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12}

Required: Yes

FlowId

The unique identifier of the flow to update permissions for.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

GrantPermissions

The permissions that you want to grant on this flow.

Type: Array of Permission objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Required: No

RevokePermissions

The permissions that you want to revoke from this flow.

Type: Array of Permission objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Required: No

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "Arn": "string",
   "FlowId": "string",
   "Permissions": [ 
      { 
         "Actions": [ "string" ],
         "Principal": "string"
      }
   ],
   "RequestId": "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.

Arn

The Amazon Resource Name (ARN) of the flow you are updating permissions against.

Type: String

FlowId

The unique identifier of the flow with updated permissions.

Type: String

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

Permissions

The permissions on the flow after they are updated.

Type: Array of Permission objects

RequestId

The AWS request ID for this operation.

Type: String

Errors

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

RequestId: The AWS request ID for this request.

HTTP Status Code: 401

InternalFailureException

An internal failure occurred.

RequestId: The AWS request ID for this request.

HTTP Status Code: 500

InvalidParameterValueException

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

RequestId: The AWS request ID for this request.

HTTP Status Code: 400

ThrottlingException

Access is throttled.

RequestId: The AWS request ID for this request.

HTTP Status Code: 429