approval_policies

Creates, updates, deletes, gets or lists an approval_policies resource.

Overview

Name	approval_policies
Type	Resource
Id	aws.quicksight.approval_policies

Fields

The following fields are returned by SELECT queries:

describe_approval_policy

Name	Datatype	Description
actions	array	The list of governed actions that trigger the approval workflow.
applicable_to	object	The scoping configuration that determines which principals an approval policy applies to.
approval_groups	array	The list of group ARNs whose members can approve requests.
asset_types	array	The list of asset types that the approval policy applies to.
created_at	string (date-time)	The date and time that the approval policy was created.
description	string	A description of the approval policy.
name	string	The name of the approval policy.
policy_arn	string	The Amazon Resource Name (ARN) of the approval policy.
policy_id	string	The unique identifier of the approval policy. (pattern: <code>[a-zA-Z0-9-_]+</code>)
updated_at	string (date-time)	The date and time that the approval policy was last updated.

list_approval_policies

Name	Datatype	Description
actions	array	The list of governed actions that trigger the approval workflow.
applicable_to	object	The scoping configuration that determines which principals an approval policy applies to.
approval_groups	array	The list of group ARNs whose members can approve requests.
asset_types	array	The list of asset types that the approval policy applies to.
created_at	string (date-time)	The date and time that the approval policy was created.
description	string	A description of the approval policy.
name	string	The name of the approval policy.
policy_arn	string	The Amazon Resource Name (ARN) of the approval policy.
policy_id	string	The unique identifier of the approval policy. (pattern: <code>[a-zA-Z0-9-_]+</code>)
updated_at	string (date-time)	The date and time that the approval policy was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_approval_policy	select	policy_id, region		Describes an approval policy in Quick Sight.
list_approval_policies	select	region	next-token, max-results	Lists all approval policies in the specified Quick Sight account. The results are paginated. If the response includes a NextToken value, pass it in a subsequent call to retrieve the next set of results.
create_approval_policy	insert	region, PolicyId, AssetTypes, ApplicableTo, ApprovalGroups		Creates an approval policy in Quick Sight.
update_approval_policy	update	policy_id, region		Updates an approval policy in Quick Sight.
delete_approval_policy	delete	policy_id, region		Deletes an approval policy in Quick Sight.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
policy_id	string	The unique identifier of the approval policy to delete.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of results to return in a single call. If you don't specify a value, the service returns a default number of results. Use the NextToken value in the response to retrieve additional results.
next-token	string	The token for the next set of results, or null if there are no more results.

SELECT examples

describe_approval_policy

Describes an approval policy in Quick Sight.

SELECT
actions,
applicable_to,
approval_groups,
asset_types,
created_at,
description,
name,
policy_arn,
policy_id,
updated_at
FROM aws.quicksight.approval_policies
WHERE policy_id = '{{ policy_id }}' -- required
AND region = '{{ region }}' -- required
;

list_approval_policies

Lists all approval policies in the specified Quick Sight account. The results are paginated. If the response includes a NextToken value, pass it in a subsequent call to retrieve the next set of results.

SELECT
actions,
applicable_to,
approval_groups,
asset_types,
created_at,
description,
name,
policy_arn,
policy_id,
updated_at
FROM aws.quicksight.approval_policies
WHERE region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_approval_policy

Creates an approval policy in Quick Sight.

INSERT INTO aws.quicksight.approval_policies (
PolicyId,
Name,
Description,
Actions,
AssetTypes,
ApplicableTo,
ApprovalGroups,
region
)
SELECT 
'{{ PolicyId }}' /* required */,
'{{ Name }}',
'{{ Description }}',
'{{ Actions }}',
'{{ AssetTypes }}' /* required */,
'{{ ApplicableTo }}' /* required */,
'{{ ApprovalGroups }}' /* required */,
'{{ region }}'
RETURNING
policy
;

Manifest

# Description fields are for documentation purposes
- name: approval_policies
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the approval_policies resource.
  - name: PolicyId
    value: "{{ PolicyId }}"
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: Actions
    value:
      - "{{ Actions }}"
  - name: AssetTypes
    value:
      - "{{ AssetTypes }}"
  - name: ApplicableTo
    description: |
      The scoping configuration that determines which principals an approval policy applies to.
    value:
      Type: "{{ Type }}"
      GroupArns:
        - "{{ GroupArns }}"
  - name: ApprovalGroups
    value:
      - "{{ ApprovalGroups }}"

UPDATE examples

update_approval_policy

Updates an approval policy in Quick Sight.

UPDATE aws.quicksight.approval_policies
SET 
Name = '{{ Name }}',
Description = '{{ Description }}',
Actions = '{{ Actions }}',
AssetTypes = '{{ AssetTypes }}',
ApplicableTo = '{{ ApplicableTo }}',
ApprovalGroups = '{{ ApprovalGroups }}'
WHERE 
policy_id = '{{ policy_id }}' --required
AND region = '{{ region }}' --required
RETURNING
policy;

DELETE examples

delete_approval_policy

Deletes an approval policy in Quick Sight.

DELETE FROM aws.quicksight.approval_policies
WHERE policy_id = '{{ policy_id }}' --required
AND region = '{{ region }}' --required
;