update_group

QuickSight.Client.update_group(**kwargs)

Changes a group description.

See also: AWS API Documentation

Request Syntax

response = client.update_group(
    GroupName='string',
    Description='string',
    AwsAccountId='string',
    Namespace='string'
)
Parameters
  • GroupName (string) --

    [REQUIRED]

    The name of the group that you want to update.

  • Description (string) -- The description for the group that you want to update.
  • AwsAccountId (string) --

    [REQUIRED]

    The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

  • Namespace (string) --

    [REQUIRED]

    The namespace of the group that you want to update.

Return type

dict

Returns

Response Syntax

{
    'Group': {
        'Arn': 'string',
        'GroupName': 'string',
        'Description': 'string',
        'PrincipalId': 'string'
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) --

    • Group (dict) --

      The name of the group.

      • Arn (string) --

        The Amazon Resource Name (ARN) for the group.

      • GroupName (string) --

        The name of the group.

      • Description (string) --

        The group description.

      • PrincipalId (string) --

        The principal ID of the group.

    • 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.ResourceNotFoundException
  • QuickSight.Client.exceptions.ThrottlingException
  • QuickSight.Client.exceptions.PreconditionNotMetException
  • QuickSight.Client.exceptions.InternalFailureException
  • QuickSight.Client.exceptions.ResourceUnavailableException