Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . quicksight ]

describe-group

Description

Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).

The permissions resource is ``arn:aws:quicksight:us-east-1:relevant-aws-account-id :group/default/group-name `` .

The response is the group object.

CLI Sample:

aws quicksight describe-group -\-aws-account-id=11112222333 -\-namespace=default -\-group-name=Sales

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-group
--group-name <value>
--aws-account-id <value>
--namespace <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--group-name (string)

The name of the group that you want to describe.

--aws-account-id (string)

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

--namespace (string)

The namespace. Currently, you should set this to default .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Group -> (structure)

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 AWS request ID for this operation.

Status -> (integer)

The http status of the request.