update_analysis_permissions

update_analysis_permissions(**kwargs)

Updates the read and write permissions for an analysis.

See also: AWS API Documentation

Request Syntax

response = client.update_analysis_permissions(
    AwsAccountId='string',
    AnalysisId='string',
    GrantPermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    RevokePermissions=[
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ]
)
Parameters
  • AwsAccountId (string) --

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the analysis whose permissions you're updating. You must be using the Amazon Web Services account that the analysis is in.

  • AnalysisId (string) --

    [REQUIRED]

    The ID of the analysis whose permissions you're updating. The ID is part of the analysis URL.

  • GrantPermissions (list) --

    A structure that describes the permissions to add and the principal to add them to.

    • (dict) --

      Permission for the resource.

      • Principal (string) -- [REQUIRED]

        The Amazon Resource Name (ARN) of the principal. This can be one of the following:

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
        • The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
        • The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
      • Actions (list) -- [REQUIRED]

        The IAM action to grant or revoke permissions on.

        • (string) --
  • RevokePermissions (list) --

    A structure that describes the permissions to remove and the principal to remove them from.

    • (dict) --

      Permission for the resource.

      • Principal (string) -- [REQUIRED]

        The Amazon Resource Name (ARN) of the principal. This can be one of the following:

        • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
        • The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
        • The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
      • Actions (list) -- [REQUIRED]

        The IAM action to grant or revoke permissions on.

        • (string) --
Return type

dict

Returns

Response Syntax

{
    'AnalysisArn': 'string',
    'AnalysisId': 'string',
    'Permissions': [
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) --

    • AnalysisArn (string) --

      The Amazon Resource Name (ARN) of the analysis that you updated.

    • AnalysisId (string) --

      The ID of the analysis that you updated permissions for.

    • Permissions (list) --

      A structure that describes the principals and the resource-level permissions on an analysis.

      • (dict) --

        Permission for the resource.

        • Principal (string) --

          The Amazon Resource Name (ARN) of the principal. This can be one of the following:

          • The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
          • The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
          • The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
        • Actions (list) --

          The IAM action to grant or revoke permissions on.

          • (string) --
    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

    • Status (integer) --

      The HTTP status of the request.

Exceptions

  • QuickSight.Client.exceptions.ThrottlingException
  • QuickSight.Client.exceptions.InvalidParameterValueException
  • QuickSight.Client.exceptions.ResourceNotFoundException
  • QuickSight.Client.exceptions.UnsupportedUserEditionException
  • QuickSight.Client.exceptions.ConflictException
  • QuickSight.Client.exceptions.LimitExceededException
  • QuickSight.Client.exceptions.InternalFailureException