QuickSight / Client / create_approval_policy

create_approval_policy

QuickSight.Client.create_approval_policy(**kwargs)

Creates an approval policy in Quick Sight.

See also: AWS API Documentation

Request Syntax

response = client.create_approval_policy(
    PolicyId='string',
    Name='string',
    Description='string',
    Actions=[
        'SHARE',
    ],
    AssetTypes=[
        'AGENT'|'SPACE'|'KNOWLEDGE_BASE',
    ],
    ApplicableTo={
        'Type': 'GROUP',
        'GroupArns': [
            'string',
        ]
    },
    ApprovalGroups=[
        'string',
    ]
)

Parameters:

• PolicyId (string) –

  [REQUIRED]

  The unique identifier to assign to the approval policy. You cannot change this value after you create the policy.

• Name (string) –

  [REQUIRED]

  The name of the approval policy.

• Description (string) – A description of the approval policy.

• Actions (list) –

  [REQUIRED]

  The list of governed actions that trigger the approval workflow.

  • (string) –

• AssetTypes (list) –

  [REQUIRED]

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

  • (string) –

• ApplicableTo (dict) –

  [REQUIRED]

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

  • Type (string) – [REQUIRED]

    The type of scoping that determines which principals the approval policy applies to. Valid values are defined as follows:

    • GROUP: The policy applies only to principals in the groups specified by GroupArns. When you use GROUP, you must also provide a value for GroupArns.

  • GroupArns (list) –

    The list of group ARNs that the policy applies to. Required when type is GROUP.

    • (string) –

• ApprovalGroups (list) –

  [REQUIRED]

  The list of group ARNs whose members can approve requests.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Policy': {
        'PolicyId': 'string',
        'PolicyArn': 'string',
        'Name': 'string',
        'Description': 'string',
        'Actions': [
            'SHARE',
        ],
        'AssetTypes': [
            'AGENT'|'SPACE'|'KNOWLEDGE_BASE',
        ],
        'ApplicableTo': {
            'Type': 'GROUP',
            'GroupArns': [
                'string',
            ]
        },
        'ApprovalGroups': [
            'string',
        ],
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) –

  • Policy (dict) –

    The approval policy that was created.

    • PolicyId (string) –

      The unique identifier of the approval policy.

    • PolicyArn (string) –

      The Amazon Resource Name (ARN) of the approval policy.

    • Name (string) –

      The name of the approval policy.

    • Description (string) –

      A description of the approval policy.

    • Actions (list) –

      The list of governed actions that trigger the approval workflow.

      • (string) –

    • AssetTypes (list) –

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

      • (string) –

    • ApplicableTo (dict) –

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

      • Type (string) –

        The type of scoping that determines which principals the approval policy applies to. Valid values are defined as follows:

        • GROUP: The policy applies only to principals in the groups specified by GroupArns. When you use GROUP, you must also provide a value for GroupArns.

      • GroupArns (list) –

        The list of group ARNs that the policy applies to. Required when type is GROUP.

        • (string) –

    • ApprovalGroups (list) –

      The list of group ARNs whose members can approve requests.

      • (string) –

    • CreatedAt (datetime) –

      The date and time that the approval policy was created.

    • UpdatedAt (datetime) –

      The date and time that the approval policy was last updated.

Exceptions

• QuickSight.Client.exceptions.ThrottlingException

• QuickSight.Client.exceptions.InvalidParameterValueException

• QuickSight.Client.exceptions.InternalFailureException

• QuickSight.Client.exceptions.ResourceNotFoundException

• QuickSight.Client.exceptions.LimitExceededException

• QuickSight.Client.exceptions.ConflictException

• QuickSight.Client.exceptions.AccessDeniedException