QuickSight / Client / create_iam_policy_assignment

create_iam_policy_assignment#

QuickSight.Client.create_iam_policy_assignment(**kwargs)#

Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.

See also: AWS API Documentation

Request Syntax

response = client.create_iam_policy_assignment(
    AwsAccountId='string',
    AssignmentName='string',
    AssignmentStatus='ENABLED'|'DRAFT'|'DISABLED',
    PolicyArn='string',
    Identities={
        'string': [
            'string',
        ]
    },
    Namespace='string'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.

  • AssignmentName (string) –

    [REQUIRED]

    The name of the assignment, also called a rule. It must be unique within an Amazon Web Services account.

  • AssignmentStatus (string) –

    [REQUIRED]

    The status of the assignment. Possible values are as follows:

    • ENABLED - Anything specified in this assignment is used when creating the data source.

    • DISABLED - This assignment isn’t used when creating the data source.

    • DRAFT - This assignment is an unfinished draft and isn’t used when creating the data source.

  • PolicyArn (string) – The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.

  • Identities (dict) –

    The Amazon QuickSight users, groups, or both that you want to assign the policy to.

    • (string) –

      • (list) –

        • (string) –

  • Namespace (string) –

    [REQUIRED]

    The namespace that contains the assignment.

Return type:

dict

Returns:

Response Syntax

{
    'AssignmentName': 'string',
    'AssignmentId': 'string',
    'AssignmentStatus': 'ENABLED'|'DRAFT'|'DISABLED',
    'PolicyArn': 'string',
    'Identities': {
        'string': [
            'string',
        ]
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) –

    • AssignmentName (string) –

      The name of the assignment. This name must be unique within the Amazon Web Services account.

    • AssignmentId (string) –

      The ID for the assignment.

    • AssignmentStatus (string) –

      The status of the assignment. Possible values are as follows:

      • ENABLED - Anything specified in this assignment is used when creating the data source.

      • DISABLED - This assignment isn’t used when creating the data source.

      • DRAFT - This assignment is an unfinished draft and isn’t used when creating the data source.

    • PolicyArn (string) –

      The ARN for the IAM policy that is applied to the Amazon QuickSight users and groups specified in this assignment.

    • Identities (dict) –

      The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.

      • (string) –

        • (list) –

          • (string) –

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

    • Status (integer) –

      The HTTP status of the request.

Exceptions

  • QuickSight.Client.exceptions.AccessDeniedException

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.ResourceExistsException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.ConcurrentUpdatingException

  • QuickSight.Client.exceptions.InternalFailureException