QuickSight / Client / update_iam_policy_assignment

update_iam_policy_assignment#

QuickSight.Client.update_iam_policy_assignment(**kwargs)#

Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in Identities.

See also: AWS API Documentation

Request Syntax

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

  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the IAM policy assignment.

  • AssignmentName (string) –

    [REQUIRED]

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

  • Namespace (string) –

    [REQUIRED]

    The namespace of 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 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) –

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • AssignmentName (string) –

      The name of the assignment or rule.

    • AssignmentId (string) –

      The ID of the assignment.

    • PolicyArn (string) –

      The ARN for the IAM policy 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) –

    • 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.

    • 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