amazonka-quicksight-2.0: Amazon QuickSight SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.QuickSight.DescribeGroup

Description

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

Synopsis

Creating a Request

data DescribeGroup Source #

See: newDescribeGroup smart constructor.

Constructors

DescribeGroup' 

Fields

  • groupName :: Text

    The name of the group that you want to describe.

  • awsAccountId :: Text

    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 :: Text

    The namespace of the group that you want described.

Instances

Instances details
ToHeaders DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

ToPath DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

ToQuery DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

AWSRequest DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Associated Types

type AWSResponse DescribeGroup #

Generic DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Associated Types

type Rep DescribeGroup :: Type -> Type #

Read DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Show DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

NFData DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Methods

rnf :: DescribeGroup -> () #

Eq DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Hashable DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

type AWSResponse DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

type Rep DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

type Rep DescribeGroup = D1 ('MetaData "DescribeGroup" "Amazonka.QuickSight.DescribeGroup" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "DescribeGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "groupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDescribeGroup Source #

Create a value of DescribeGroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeGroup, describeGroup_groupName - The name of the group that you want to describe.

DescribeGroup, describeGroup_awsAccountId - 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.

DescribeGroup, describeGroup_namespace - The namespace of the group that you want described.

Request Lenses

describeGroup_groupName :: Lens' DescribeGroup Text Source #

The name of the group that you want to describe.

describeGroup_awsAccountId :: Lens' DescribeGroup Text Source #

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.

describeGroup_namespace :: Lens' DescribeGroup Text Source #

The namespace of the group that you want described.

Destructuring the Response

data DescribeGroupResponse Source #

See: newDescribeGroupResponse smart constructor.

Constructors

DescribeGroupResponse' 

Fields

Instances

Instances details
Generic DescribeGroupResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Associated Types

type Rep DescribeGroupResponse :: Type -> Type #

Read DescribeGroupResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Show DescribeGroupResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

NFData DescribeGroupResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Methods

rnf :: DescribeGroupResponse -> () #

Eq DescribeGroupResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

type Rep DescribeGroupResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

type Rep DescribeGroupResponse = D1 ('MetaData "DescribeGroupResponse" "Amazonka.QuickSight.DescribeGroup" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "DescribeGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "group'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Group)) :*: (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeGroupResponse Source #

Create a value of DescribeGroupResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:group':DescribeGroupResponse', describeGroupResponse_group - The name of the group.

$sel:requestId:DescribeGroupResponse', describeGroupResponse_requestId - The Amazon Web Services request ID for this operation.

DescribeGroupResponse, describeGroupResponse_status - The HTTP status of the request.

Response Lenses

describeGroupResponse_requestId :: Lens' DescribeGroupResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.