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.CreateGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an Amazon QuickSight group.

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

The response is a group object.

Synopsis

Creating a Request

data CreateGroup Source #

The request object for this operation.

See: newCreateGroup smart constructor.

Constructors

CreateGroup'

Fields

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

newCreateGroup Source #

Arguments

:: Text	`$sel:groupName:CreateGroup'`
-> Text	`$sel:awsAccountId:CreateGroup'`
-> Text	`$sel:namespace:CreateGroup'`
-> CreateGroup

Create a value of CreateGroup 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:description:CreateGroup', createGroup_description - A description for the group that you want to create.

$sel:groupName:CreateGroup', createGroup_groupName - A name for the group that you want to create.

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

Request Lenses

createGroup_description :: Lens' CreateGroup (Maybe Text) Source #

A description for the group that you want to create.

createGroup_groupName :: Lens' CreateGroup Text Source #

A name for the group that you want to create.

createGroup_awsAccountId :: Lens' CreateGroup 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.

createGroup_namespace :: Lens' CreateGroup Text Source #

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

Destructuring the Response

data CreateGroupResponse Source #

The response object for this operation.

See: newCreateGroupResponse smart constructor.

Constructors

CreateGroupResponse'
Fields requestId :: Maybe Text The Amazon Web Services request ID for this operation. group' :: Maybe Group The name of the group. status :: Int The HTTP status of the request.

Instances

Instances details

Eq CreateGroupResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateGroup Methods (==) :: CreateGroupResponse -> CreateGroupResponse -> Bool # (/=) :: CreateGroupResponse -> CreateGroupResponse -> Bool #
Read CreateGroupResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateGroup Methods readsPrec :: Int -> ReadS CreateGroupResponse # readList :: ReadS [CreateGroupResponse] # readPrec :: ReadPrec CreateGroupResponse # readListPrec :: ReadPrec [CreateGroupResponse] #
Show CreateGroupResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateGroup Methods showsPrec :: Int -> CreateGroupResponse -> ShowS # show :: CreateGroupResponse -> String # showList :: [CreateGroupResponse] -> ShowS #
Generic CreateGroupResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateGroup Associated Types type Rep CreateGroupResponse :: Type -> Type # Methods from :: CreateGroupResponse -> Rep CreateGroupResponse x # to :: Rep CreateGroupResponse x -> CreateGroupResponse #
NFData CreateGroupResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateGroup Methods rnf :: CreateGroupResponse -> () #
type Rep CreateGroupResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateGroup type Rep CreateGroupResponse = D1 ('MetaData "CreateGroupResponse" "Amazonka.QuickSight.CreateGroup" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "CreateGroupResponse'" '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))))

newCreateGroupResponse Source #

Arguments

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

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

$sel:group':CreateGroupResponse', createGroupResponse_group - The name of the group.

$sel:status:CreateGroupResponse', createGroupResponse_status - The HTTP status of the request.

Response Lenses

createGroupResponse_requestId :: Lens' CreateGroupResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createGroupResponse_group :: Lens' CreateGroupResponse (Maybe Group) Source #

The name of the group.

createGroupResponse_status :: Lens' CreateGroupResponse Int Source #

The HTTP status of the request.