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

UpdateApprovalPolicy

Updates an approval policy in Quick Sight.

Request Syntax


PATCH /governance/approvalworkflows/policies/PolicyId HTTP/1.1
Content-type: application/json

{
   "Actions": [ "string" ],
   "ApplicableTo": { 
      "GroupArns": [ "string" ],
      "Type": "string"
   },
   "ApprovalGroups": [ "string" ],
   "AssetTypes": [ "string" ],
   "Description": "string",
   "Name": "string"
}

URI Request Parameters

The request uses the following URI parameters.

PolicyId

The unique identifier of the approval policy to update.

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

Pattern: [a-zA-Z0-9\-_]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

Actions

The list of governed actions that trigger the approval workflow.

Type: Array of strings

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

Valid Values: SHARE

Required: No

ApplicableTo

The scoping configuration that determines who the approval policy applies to.

Type: ApplicableTo object

Required: No

ApprovalGroups

The list of group ARNs whose members can approve requests.

Type: Array of strings

Array Members: Minimum number of 1 item.

Required: No

AssetTypes

The list of asset types that the approval policy applies to.

Type: Array of strings

Array Members: Minimum number of 1 item.

Valid Values: AGENT | SPACE | KNOWLEDGE_BASE

Required: No

Description

A description of the approval policy.

Type: String

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

Required: No

Name

The name of the approval policy.

Type: String

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Policy": { 
      "Actions": [ "string" ],
      "ApplicableTo": { 
         "GroupArns": [ "string" ],
         "Type": "string"
      },
      "ApprovalGroups": [ "string" ],
      "AssetTypes": [ "string" ],
      "CreatedAt": number,
      "Description": "string",
      "Name": "string",
      "PolicyArn": "string",
      "PolicyId": "string",
      "UpdatedAt": number
   }
}

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.

Policy

The updated approval policy.

Type: ApprovalPolicy object

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 AWS request ID for this request.

HTTP Status Code: 401

ConflictException

Updating or deleting a resource can cause an inconsistent state.

RequestId: The AWS request ID for this request.

HTTP Status Code: 409

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

ResourceNotFoundException

One or more resources can't be found.

RequestId: The AWS request ID for this request.
ResourceType: The resource type for this request.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

RequestId: The AWS request ID for this request.

HTTP Status Code: 429