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 |
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' {}
- 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.
CreateFolder' | |
|
Instances
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.
Instances
newCreateFolderResponse Source #
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.