Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.QuickSight.DescribeGroupMembership

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Use the DescribeGroupMembership operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated GroupMember object is returned.

Synopsis

data DescribeGroupMembership = DescribeGroupMembership' {
- memberName :: Text
- groupName :: Text
- awsAccountId :: Text
- namespace :: Text
}
newDescribeGroupMembership :: Text -> Text -> Text -> Text -> DescribeGroupMembership
describeGroupMembership_memberName :: Lens' DescribeGroupMembership Text
describeGroupMembership_groupName :: Lens' DescribeGroupMembership Text
describeGroupMembership_awsAccountId :: Lens' DescribeGroupMembership Text
describeGroupMembership_namespace :: Lens' DescribeGroupMembership Text
data DescribeGroupMembershipResponse = DescribeGroupMembershipResponse' {
- groupMember :: Maybe GroupMember
- requestId :: Maybe Text
- status :: Int
}
newDescribeGroupMembershipResponse :: Int -> DescribeGroupMembershipResponse
describeGroupMembershipResponse_groupMember :: Lens' DescribeGroupMembershipResponse (Maybe GroupMember)
describeGroupMembershipResponse_requestId :: Lens' DescribeGroupMembershipResponse (Maybe Text)
describeGroupMembershipResponse_status :: Lens' DescribeGroupMembershipResponse Int

Creating a Request

data DescribeGroupMembership Source #

See: newDescribeGroupMembership smart constructor.

Constructors

DescribeGroupMembership'

Fields

memberName :: Text
The user name of the user that you want to search for.
groupName :: Text
The name of the group that you want to search.
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 that includes the group you are searching within.

Instances

Instances details

ToHeaders DescribeGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.DescribeGroupMembership Methods toHeaders :: DescribeGroupMembership -> [Header] #
ToPath DescribeGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.DescribeGroupMembership Methods toPath :: DescribeGroupMembership -> ByteString #
ToQuery DescribeGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.DescribeGroupMembership Methods toQuery :: DescribeGroupMembership -> QueryString #
AWSRequest DescribeGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.DescribeGroupMembership Associated Types type AWSResponse DescribeGroupMembership # Methods request :: (Service -> Service) -> DescribeGroupMembership -> Request DescribeGroupMembership # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeGroupMembership -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeGroupMembership))) #
Generic DescribeGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.DescribeGroupMembership Associated Types type Rep DescribeGroupMembership :: Type -> Type # Methods from :: DescribeGroupMembership -> Rep DescribeGroupMembership x # to :: Rep DescribeGroupMembership x -> DescribeGroupMembership #
Read DescribeGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.DescribeGroupMembership Methods readsPrec :: Int -> ReadS DescribeGroupMembership # readList :: ReadS [DescribeGroupMembership] # readPrec :: ReadPrec DescribeGroupMembership # readListPrec :: ReadPrec [DescribeGroupMembership] #
Show DescribeGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.DescribeGroupMembership Methods showsPrec :: Int -> DescribeGroupMembership -> ShowS # show :: DescribeGroupMembership -> String # showList :: [DescribeGroupMembership] -> ShowS #
NFData DescribeGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.DescribeGroupMembership Methods rnf :: DescribeGroupMembership -> () #
Eq DescribeGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.DescribeGroupMembership Methods (==) :: DescribeGroupMembership -> DescribeGroupMembership -> Bool # (/=) :: DescribeGroupMembership -> DescribeGroupMembership -> Bool #
Hashable DescribeGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.DescribeGroupMembership Methods hashWithSalt :: Int -> DescribeGroupMembership -> Int # hash :: DescribeGroupMembership -> Int #
type AWSResponse DescribeGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.DescribeGroupMembership type AWSResponse DescribeGroupMembership = DescribeGroupMembershipResponse
type Rep DescribeGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.DescribeGroupMembership type Rep DescribeGroupMembership = D1 ('MetaData "DescribeGroupMembership" "Amazonka.QuickSight.DescribeGroupMembership" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "DescribeGroupMembership'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "memberName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: 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))))

newDescribeGroupMembership Source #

Arguments

:: Text	`DescribeGroupMembership`
-> Text	`DescribeGroupMembership`
-> Text	`DescribeGroupMembership`
-> Text	`DescribeGroupMembership`
-> DescribeGroupMembership

Create a value of DescribeGroupMembership 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:

DescribeGroupMembership, describeGroupMembership_memberName - The user name of the user that you want to search for.

DescribeGroupMembership, describeGroupMembership_groupName - The name of the group that you want to search.

DescribeGroupMembership, describeGroupMembership_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.

DescribeGroupMembership, describeGroupMembership_namespace - The namespace that includes the group you are searching within.

Request Lenses

describeGroupMembership_memberName :: Lens' DescribeGroupMembership Text Source #

The user name of the user that you want to search for.

describeGroupMembership_groupName :: Lens' DescribeGroupMembership Text Source #

The name of the group that you want to search.

describeGroupMembership_awsAccountId :: Lens' DescribeGroupMembership 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.

describeGroupMembership_namespace :: Lens' DescribeGroupMembership Text Source #

The namespace that includes the group you are searching within.

Destructuring the Response

data DescribeGroupMembershipResponse Source #

See: newDescribeGroupMembershipResponse smart constructor.

Constructors

DescribeGroupMembershipResponse'
Fields groupMember :: Maybe GroupMember requestId :: Maybe Text The Amazon Web Services request ID for this operation. status :: Int The HTTP status of the request.

Instances

Instances details

Generic DescribeGroupMembershipResponse Source #
Instance details Defined in Amazonka.QuickSight.DescribeGroupMembership Associated Types type Rep DescribeGroupMembershipResponse :: Type -> Type # Methods from :: DescribeGroupMembershipResponse -> Rep DescribeGroupMembershipResponse x # to :: Rep DescribeGroupMembershipResponse x -> DescribeGroupMembershipResponse #
Read DescribeGroupMembershipResponse Source #
Instance details Defined in Amazonka.QuickSight.DescribeGroupMembership Methods readsPrec :: Int -> ReadS DescribeGroupMembershipResponse # readList :: ReadS [DescribeGroupMembershipResponse] # readPrec :: ReadPrec DescribeGroupMembershipResponse # readListPrec :: ReadPrec [DescribeGroupMembershipResponse] #
Show DescribeGroupMembershipResponse Source #
Instance details Defined in Amazonka.QuickSight.DescribeGroupMembership Methods showsPrec :: Int -> DescribeGroupMembershipResponse -> ShowS # show :: DescribeGroupMembershipResponse -> String # showList :: [DescribeGroupMembershipResponse] -> ShowS #
NFData DescribeGroupMembershipResponse Source #
Instance details Defined in Amazonka.QuickSight.DescribeGroupMembership Methods rnf :: DescribeGroupMembershipResponse -> () #
Eq DescribeGroupMembershipResponse Source #
Instance details Defined in Amazonka.QuickSight.DescribeGroupMembership Methods (==) :: DescribeGroupMembershipResponse -> DescribeGroupMembershipResponse -> Bool # (/=) :: DescribeGroupMembershipResponse -> DescribeGroupMembershipResponse -> Bool #
type Rep DescribeGroupMembershipResponse Source #
Instance details Defined in Amazonka.QuickSight.DescribeGroupMembership type Rep DescribeGroupMembershipResponse = D1 ('MetaData "DescribeGroupMembershipResponse" "Amazonka.QuickSight.DescribeGroupMembership" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "DescribeGroupMembershipResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "groupMember") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GroupMember)) :: (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeGroupMembershipResponse Source #

Arguments

:: Int	`DescribeGroupMembershipResponse`
-> DescribeGroupMembershipResponse

Create a value of DescribeGroupMembershipResponse 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:groupMember:DescribeGroupMembershipResponse', describeGroupMembershipResponse_groupMember - Undocumented member.

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

DescribeGroupMembershipResponse, describeGroupMembershipResponse_status - The HTTP status of the request.

Response Lenses

describeGroupMembershipResponse_groupMember :: Lens' DescribeGroupMembershipResponse (Maybe GroupMember) Source #

Undocumented member.

describeGroupMembershipResponse_requestId :: Lens' DescribeGroupMembershipResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeGroupMembershipResponse_status :: Lens' DescribeGroupMembershipResponse Int Source #

The HTTP status of the request.