libZSservicesZSamazonka-quicksightZSamazonka-quicksight
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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. Currently, you should set this to default.

Instances

Instances details
Eq DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Methods

(==) :: DescribeGroup -> DescribeGroup -> Bool #

(/=) :: DescribeGroup -> DescribeGroup -> Bool #

Read DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Methods

readsPrec :: Int -> ReadS DescribeGroup #

readList :: ReadS [DescribeGroup] #

readPrec :: ReadPrec DescribeGroup #

readListPrec :: ReadPrec [DescribeGroup] #

Show DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Methods

showsPrec :: Int -> DescribeGroup -> ShowS #

show :: DescribeGroup -> String #

showList :: [DescribeGroup] -> ShowS #

Generic DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Associated Types

type Rep DescribeGroup :: Type -> Type #

Methods

from :: DescribeGroup -> Rep DescribeGroup x #

to :: Rep DescribeGroup x -> DescribeGroup #

NFData DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Methods

rnf :: DescribeGroup -> () #

Hashable DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Methods

hashWithSalt :: Int -> DescribeGroup -> Int #

hash :: DescribeGroup -> Int #

AWSRequest DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Associated Types

type AWSResponse DescribeGroup #

Methods

request :: DescribeGroup -> Request DescribeGroup #

response :: MonadResource m => Logger -> Service -> Proxy DescribeGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeGroup))) #

ToHeaders DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Methods

toHeaders :: DescribeGroup -> [Header] #

ToPath DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Methods

toPath :: DescribeGroup -> ByteString #

ToQuery DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Methods

toQuery :: DescribeGroup -> QueryString #

type Rep DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

type Rep DescribeGroup = D1 ('MetaData "DescribeGroup" "Amazonka.QuickSight.DescribeGroup" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" '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))))
type AWSResponse DescribeGroup Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

type AWSResponse DescribeGroup = DescribeGroupResponse

newDescribeGroup Source #

Arguments

:: Text

$sel:groupName:DescribeGroup'

-> Text

$sel:awsAccountId:DescribeGroup'

-> Text

$sel:namespace:DescribeGroup'

-> DescribeGroup 

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:

$sel:groupName:DescribeGroup', describeGroup_groupName - The name of the group that you want to describe.

$sel:awsAccountId: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.

$sel:namespace:DescribeGroup', describeGroup_namespace - The namespace. Currently, you should set this to default.

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. Currently, you should set this to default.

Destructuring the Response

data DescribeGroupResponse Source #

See: newDescribeGroupResponse smart constructor.

Constructors

DescribeGroupResponse' 

Fields

Instances

Instances details
Eq DescribeGroupResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Methods

(==) :: DescribeGroupResponse -> DescribeGroupResponse -> Bool #

(/=) :: DescribeGroupResponse -> DescribeGroupResponse -> Bool #

Read DescribeGroupResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Methods

readsPrec :: Int -> ReadS DescribeGroupResponse #

readList :: ReadS [DescribeGroupResponse] #

readPrec :: ReadPrec DescribeGroupResponse #

readListPrec :: ReadPrec [DescribeGroupResponse] #

Show DescribeGroupResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Methods

showsPrec :: Int -> DescribeGroupResponse -> ShowS #

show :: DescribeGroupResponse -> String #

showList :: [DescribeGroupResponse] -> ShowS #

Generic DescribeGroupResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Associated Types

type Rep DescribeGroupResponse :: Type -> Type #

Methods

from :: DescribeGroupResponse -> Rep DescribeGroupResponse x #

to :: Rep DescribeGroupResponse x -> DescribeGroupResponse #

NFData DescribeGroupResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

Methods

rnf :: DescribeGroupResponse -> () #

type Rep DescribeGroupResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeGroup

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

newDescribeGroupResponse Source #

Arguments

:: Int

$sel:status:DescribeGroupResponse'

-> DescribeGroupResponse 

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:requestId:DescribeGroupResponse', describeGroupResponse_requestId - The Amazon Web Services request ID for this operation.

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

$sel:status: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.

describeGroupResponse_group :: Lens' DescribeGroupResponse (Maybe Group) Source #

The name of the group.

describeGroupResponse_status :: Lens' DescribeGroupResponse Int Source #

The HTTP status of the request.