update_template_permissions

update_template_permissions(**kwargs)

Updates the resource permissions for a template.

See also: AWS API Documentation

Request Syntax

response = client.update_template_permissions(
    AwsAccountId='string',
    TemplateId='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 template.

• TemplateId (string) --

  [REQUIRED]

  The ID for the template.

• GrantPermissions (list) --

  A list of resource permissions to be granted on the template.

  • (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 list of resource permissions to be revoked from the template.

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

{
    'TemplateId': 'string',
    'TemplateArn': 'string',
    'Permissions': [
        {
            'Principal': 'string',
            'Actions': [
                'string',
            ]
        },
    ],
    'RequestId': 'string',
    'Status': 123
}

Response Structure

• (dict) --

  • TemplateId (string) --

    The ID for the template.

  • TemplateArn (string) --

    The Amazon Resource Name (ARN) of the template.

  • Permissions (list) --

    A list of resource permissions to be set on the template.

    • (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.ConflictException
• QuickSight.Client.exceptions.ResourceNotFoundException
• QuickSight.Client.exceptions.UnsupportedUserEditionException
• QuickSight.Client.exceptions.LimitExceededException
• QuickSight.Client.exceptions.InternalFailureException