Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.QuickSight.CreateGroupMembership

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Adds an Amazon QuickSight user to an Amazon QuickSight group.

Synopsis

data CreateGroupMembership = CreateGroupMembership' {
- memberName :: Text
- groupName :: Text
- awsAccountId :: Text
- namespace :: Text
}
newCreateGroupMembership :: Text -> Text -> Text -> Text -> CreateGroupMembership
createGroupMembership_memberName :: Lens' CreateGroupMembership Text
createGroupMembership_groupName :: Lens' CreateGroupMembership Text
createGroupMembership_awsAccountId :: Lens' CreateGroupMembership Text
createGroupMembership_namespace :: Lens' CreateGroupMembership Text
data CreateGroupMembershipResponse = CreateGroupMembershipResponse' {
- requestId :: Maybe Text
- groupMember :: Maybe GroupMember
- status :: Int
}
newCreateGroupMembershipResponse :: Int -> CreateGroupMembershipResponse
createGroupMembershipResponse_requestId :: Lens' CreateGroupMembershipResponse (Maybe Text)
createGroupMembershipResponse_groupMember :: Lens' CreateGroupMembershipResponse (Maybe GroupMember)
createGroupMembershipResponse_status :: Lens' CreateGroupMembershipResponse Int

Creating a Request

data CreateGroupMembership Source #

See: newCreateGroupMembership smart constructor.

Constructors

CreateGroupMembership'

Fields

memberName :: Text
The name of the user that you want to add to the group membership.
groupName :: Text
The name of the group that you want to add the user to.
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 CreateGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.CreateGroupMembership Methods (==) :: CreateGroupMembership -> CreateGroupMembership -> Bool # (/=) :: CreateGroupMembership -> CreateGroupMembership -> Bool #
Read CreateGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.CreateGroupMembership Methods readsPrec :: Int -> ReadS CreateGroupMembership # readList :: ReadS [CreateGroupMembership] # readPrec :: ReadPrec CreateGroupMembership # readListPrec :: ReadPrec [CreateGroupMembership] #
Show CreateGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.CreateGroupMembership Methods showsPrec :: Int -> CreateGroupMembership -> ShowS # show :: CreateGroupMembership -> String # showList :: [CreateGroupMembership] -> ShowS #
Generic CreateGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.CreateGroupMembership Associated Types type Rep CreateGroupMembership :: Type -> Type # Methods from :: CreateGroupMembership -> Rep CreateGroupMembership x # to :: Rep CreateGroupMembership x -> CreateGroupMembership #
NFData CreateGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.CreateGroupMembership Methods rnf :: CreateGroupMembership -> () #
Hashable CreateGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.CreateGroupMembership Methods hashWithSalt :: Int -> CreateGroupMembership -> Int # hash :: CreateGroupMembership -> Int #
ToJSON CreateGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.CreateGroupMembership Methods toJSON :: CreateGroupMembership -> Value # toEncoding :: CreateGroupMembership -> Encoding # toJSONList :: [CreateGroupMembership] -> Value # toEncodingList :: [CreateGroupMembership] -> Encoding #
AWSRequest CreateGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.CreateGroupMembership Associated Types type AWSResponse CreateGroupMembership # Methods request :: CreateGroupMembership -> Request CreateGroupMembership # response :: MonadResource m => Logger -> Service -> Proxy CreateGroupMembership -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateGroupMembership))) #
ToHeaders CreateGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.CreateGroupMembership Methods toHeaders :: CreateGroupMembership -> [Header] #
ToPath CreateGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.CreateGroupMembership Methods toPath :: CreateGroupMembership -> ByteString #
ToQuery CreateGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.CreateGroupMembership Methods toQuery :: CreateGroupMembership -> QueryString #
type Rep CreateGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.CreateGroupMembership type Rep CreateGroupMembership = D1 ('MetaData "CreateGroupMembership" "Amazonka.QuickSight.CreateGroupMembership" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "CreateGroupMembership'" '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))))
type AWSResponse CreateGroupMembership Source #
Instance details Defined in Amazonka.QuickSight.CreateGroupMembership type AWSResponse CreateGroupMembership = CreateGroupMembershipResponse

newCreateGroupMembership Source #

Arguments

:: Text	`$sel:memberName:CreateGroupMembership'`
-> Text	`$sel:groupName:CreateGroupMembership'`
-> Text	`$sel:awsAccountId:CreateGroupMembership'`
-> Text	`$sel:namespace:CreateGroupMembership'`
-> CreateGroupMembership

Create a value of CreateGroupMembership 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:memberName:CreateGroupMembership', createGroupMembership_memberName - The name of the user that you want to add to the group membership.

$sel:groupName:CreateGroupMembership', createGroupMembership_groupName - The name of the group that you want to add the user to.

$sel:awsAccountId:CreateGroupMembership', createGroupMembership_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:CreateGroupMembership', createGroupMembership_namespace - The namespace. Currently, you should set this to default.

Request Lenses

createGroupMembership_memberName :: Lens' CreateGroupMembership Text Source #

The name of the user that you want to add to the group membership.

createGroupMembership_groupName :: Lens' CreateGroupMembership Text Source #

The name of the group that you want to add the user to.

createGroupMembership_awsAccountId :: Lens' CreateGroupMembership 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.

createGroupMembership_namespace :: Lens' CreateGroupMembership Text Source #

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

Destructuring the Response

data CreateGroupMembershipResponse Source #

See: newCreateGroupMembershipResponse smart constructor.

Constructors

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

Instances

Instances details

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

newCreateGroupMembershipResponse Source #

Arguments

:: Int	`$sel:status:CreateGroupMembershipResponse'`
-> CreateGroupMembershipResponse

Create a value of CreateGroupMembershipResponse 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:CreateGroupMembershipResponse', createGroupMembershipResponse_requestId - The Amazon Web Services request ID for this operation.

$sel:groupMember:CreateGroupMembershipResponse', createGroupMembershipResponse_groupMember - The group member.

$sel:status:CreateGroupMembershipResponse', createGroupMembershipResponse_status - The HTTP status of the request.

Response Lenses

createGroupMembershipResponse_requestId :: Lens' CreateGroupMembershipResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createGroupMembershipResponse_groupMember :: Lens' CreateGroupMembershipResponse (Maybe GroupMember) Source #

The group member.

createGroupMembershipResponse_status :: Lens' CreateGroupMembershipResponse Int Source #

The HTTP status of the request.