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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an empty shared folder.

Synopsis

data CreateFolder = CreateFolder' {
- folderType :: Maybe FolderType
- name :: Maybe Text
- parentFolderArn :: Maybe Text
- permissions :: Maybe (NonEmpty ResourcePermission)
- tags :: Maybe (NonEmpty Tag)
- awsAccountId :: Text
- folderId :: Text
}
newCreateFolder :: Text -> Text -> CreateFolder
createFolder_folderType :: Lens' CreateFolder (Maybe FolderType)
createFolder_name :: Lens' CreateFolder (Maybe Text)
createFolder_parentFolderArn :: Lens' CreateFolder (Maybe Text)
createFolder_permissions :: Lens' CreateFolder (Maybe (NonEmpty ResourcePermission))
createFolder_tags :: Lens' CreateFolder (Maybe (NonEmpty Tag))
createFolder_awsAccountId :: Lens' CreateFolder Text
createFolder_folderId :: Lens' CreateFolder Text
data CreateFolderResponse = CreateFolderResponse' {
- arn :: Maybe Text
- folderId :: Maybe Text
- requestId :: Maybe Text
- status :: Int
}
newCreateFolderResponse :: Int -> CreateFolderResponse
createFolderResponse_arn :: Lens' CreateFolderResponse (Maybe Text)
createFolderResponse_folderId :: Lens' CreateFolderResponse (Maybe Text)
createFolderResponse_requestId :: Lens' CreateFolderResponse (Maybe Text)
createFolderResponse_status :: Lens' CreateFolderResponse Int

Creating a Request

data CreateFolder Source #

See: newCreateFolder smart constructor.

Constructors

CreateFolder'

Fields

folderType :: Maybe FolderType
The type of folder. By default, folderType is SHARED.
name :: Maybe Text
The name of the folder.
parentFolderArn :: Maybe Text
The Amazon Resource Name (ARN) for the parent folder.
ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.
permissions :: Maybe (NonEmpty ResourcePermission)
A structure that describes the principals and the resource-level permissions of a folder.
To specify no permissions, omit Permissions.
tags :: Maybe (NonEmpty Tag)
Tags for the folder.
awsAccountId :: Text
The ID for the Amazon Web Services account where you want to create the folder.
folderId :: Text
The ID of the folder.

Instances

Instances details

ToJSON CreateFolder Source #
Instance details Defined in Amazonka.QuickSight.CreateFolder Methods toJSON :: CreateFolder -> Value # toEncoding :: CreateFolder -> Encoding # toJSONList :: [CreateFolder] -> Value # toEncodingList :: [CreateFolder] -> Encoding #
ToHeaders CreateFolder Source #
Instance details Defined in Amazonka.QuickSight.CreateFolder Methods toHeaders :: CreateFolder -> [Header] #
ToPath CreateFolder Source #
Instance details Defined in Amazonka.QuickSight.CreateFolder Methods toPath :: CreateFolder -> ByteString #
ToQuery CreateFolder Source #
Instance details Defined in Amazonka.QuickSight.CreateFolder Methods toQuery :: CreateFolder -> QueryString #
AWSRequest CreateFolder Source #
Instance details Defined in Amazonka.QuickSight.CreateFolder Associated Types type AWSResponse CreateFolder # Methods request :: (Service -> Service) -> CreateFolder -> Request CreateFolder # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateFolder -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateFolder))) #
Generic CreateFolder Source #
Instance details Defined in Amazonka.QuickSight.CreateFolder Associated Types type Rep CreateFolder :: Type -> Type # Methods from :: CreateFolder -> Rep CreateFolder x # to :: Rep CreateFolder x -> CreateFolder #
Read CreateFolder Source #
Instance details Defined in Amazonka.QuickSight.CreateFolder Methods readsPrec :: Int -> ReadS CreateFolder # readList :: ReadS [CreateFolder] # readPrec :: ReadPrec CreateFolder # readListPrec :: ReadPrec [CreateFolder] #
Show CreateFolder Source #
Instance details Defined in Amazonka.QuickSight.CreateFolder Methods showsPrec :: Int -> CreateFolder -> ShowS # show :: CreateFolder -> String # showList :: [CreateFolder] -> ShowS #
NFData CreateFolder Source #
Instance details Defined in Amazonka.QuickSight.CreateFolder Methods rnf :: CreateFolder -> () #
Eq CreateFolder Source #
Instance details Defined in Amazonka.QuickSight.CreateFolder Methods (==) :: CreateFolder -> CreateFolder -> Bool # (/=) :: CreateFolder -> CreateFolder -> Bool #
Hashable CreateFolder Source #
Instance details Defined in Amazonka.QuickSight.CreateFolder Methods hashWithSalt :: Int -> CreateFolder -> Int # hash :: CreateFolder -> Int #
type AWSResponse CreateFolder Source #
Instance details Defined in Amazonka.QuickSight.CreateFolder type AWSResponse CreateFolder = CreateFolderResponse
type Rep CreateFolder Source #
Instance details Defined in Amazonka.QuickSight.CreateFolder type Rep CreateFolder = D1 ('MetaData "CreateFolder" "Amazonka.QuickSight.CreateFolder" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "CreateFolder'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "folderType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FolderType)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parentFolderArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "permissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ResourcePermission))) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag)))) :: (S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "folderId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateFolder Source #

Arguments

:: Text	`CreateFolder`
-> Text	`CreateFolder`
-> CreateFolder

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

CreateFolder, createFolder_folderType - The type of folder. By default, folderType is SHARED.

CreateFolder, createFolder_name - The name of the folder.

$sel:parentFolderArn:CreateFolder', createFolder_parentFolderArn - The Amazon Resource Name (ARN) for the parent folder.

ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

CreateFolder, createFolder_permissions - A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions.

CreateFolder, createFolder_tags - Tags for the folder.

CreateFolder, createFolder_awsAccountId - The ID for the Amazon Web Services account where you want to create the folder.

CreateFolder, createFolder_folderId - The ID of the folder.

Request Lenses

createFolder_folderType :: Lens' CreateFolder (Maybe FolderType) Source #

The type of folder. By default, folderType is SHARED.

createFolder_name :: Lens' CreateFolder (Maybe Text) Source #

The name of the folder.

createFolder_parentFolderArn :: Lens' CreateFolder (Maybe Text) Source #

The Amazon Resource Name (ARN) for the parent folder.

ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

createFolder_permissions :: Lens' CreateFolder (Maybe (NonEmpty ResourcePermission)) Source #

A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions.

createFolder_tags :: Lens' CreateFolder (Maybe (NonEmpty Tag)) Source #

Tags for the folder.

createFolder_awsAccountId :: Lens' CreateFolder Text Source #

The ID for the Amazon Web Services account where you want to create the folder.

createFolder_folderId :: Lens' CreateFolder Text Source #

The ID of the folder.

Destructuring the Response

data CreateFolderResponse Source #

See: newCreateFolderResponse smart constructor.

Constructors

CreateFolderResponse'
Fields arn :: Maybe Text The Amazon Resource Name (ARN) for the newly created folder. folderId :: Maybe Text The folder ID for the newly created folder. requestId :: Maybe Text The request ID for the newly created folder. status :: Int The HTTP status of the request.

Instances

Instances details

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

newCreateFolderResponse Source #

Arguments

:: Int	`CreateFolderResponse`
-> CreateFolderResponse

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

CreateFolderResponse, createFolderResponse_arn - The Amazon Resource Name (ARN) for the newly created folder.

CreateFolder, createFolderResponse_folderId - The folder ID for the newly created folder.

$sel:requestId:CreateFolderResponse', createFolderResponse_requestId - The request ID for the newly created folder.

CreateFolderResponse, createFolderResponse_status - The HTTP status of the request.

Response Lenses

createFolderResponse_arn :: Lens' CreateFolderResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the newly created folder.

createFolderResponse_folderId :: Lens' CreateFolderResponse (Maybe Text) Source #

The folder ID for the newly created folder.

createFolderResponse_requestId :: Lens' CreateFolderResponse (Maybe Text) Source #

The request ID for the newly created folder.

createFolderResponse_status :: Lens' CreateFolderResponse Int Source #

The HTTP status of the request.