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.CloudDirectory.CreateDirectory

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema.

You can also quickly create a directory using a managed schema, called the QuickStartSchema. For more information, see Managed Schema in the Amazon Cloud Directory Developer Guide.

Synopsis

data CreateDirectory = CreateDirectory' {
- name :: Text
- schemaArn :: Text
}
newCreateDirectory :: Text -> Text -> CreateDirectory
createDirectory_name :: Lens' CreateDirectory Text
createDirectory_schemaArn :: Lens' CreateDirectory Text
data CreateDirectoryResponse = CreateDirectoryResponse' {
- httpStatus :: Int
- directoryArn :: Text
- name :: Text
- objectIdentifier :: Text
- appliedSchemaArn :: Text
}
newCreateDirectoryResponse :: Int -> Text -> Text -> Text -> Text -> CreateDirectoryResponse
createDirectoryResponse_httpStatus :: Lens' CreateDirectoryResponse Int
createDirectoryResponse_directoryArn :: Lens' CreateDirectoryResponse Text
createDirectoryResponse_name :: Lens' CreateDirectoryResponse Text
createDirectoryResponse_objectIdentifier :: Lens' CreateDirectoryResponse Text
createDirectoryResponse_appliedSchemaArn :: Lens' CreateDirectoryResponse Text

Creating a Request

data CreateDirectory Source #

See: newCreateDirectory smart constructor.

Constructors

CreateDirectory'
Fields name :: Text The name of the Directory. Should be unique per account, per region. schemaArn :: Text The Amazon Resource Name (ARN) of the published schema that will be copied into the data Directory. For more information, see arns.

Instances

Instances details

Eq CreateDirectory Source #
Instance details Defined in Amazonka.CloudDirectory.CreateDirectory Methods (==) :: CreateDirectory -> CreateDirectory -> Bool # (/=) :: CreateDirectory -> CreateDirectory -> Bool #
Read CreateDirectory Source #
Instance details Defined in Amazonka.CloudDirectory.CreateDirectory Methods readsPrec :: Int -> ReadS CreateDirectory # readList :: ReadS [CreateDirectory] # readPrec :: ReadPrec CreateDirectory # readListPrec :: ReadPrec [CreateDirectory] #
Show CreateDirectory Source #
Instance details Defined in Amazonka.CloudDirectory.CreateDirectory Methods showsPrec :: Int -> CreateDirectory -> ShowS # show :: CreateDirectory -> String # showList :: [CreateDirectory] -> ShowS #
Generic CreateDirectory Source #
Instance details Defined in Amazonka.CloudDirectory.CreateDirectory Associated Types type Rep CreateDirectory :: Type -> Type # Methods from :: CreateDirectory -> Rep CreateDirectory x # to :: Rep CreateDirectory x -> CreateDirectory #
NFData CreateDirectory Source #
Instance details Defined in Amazonka.CloudDirectory.CreateDirectory Methods rnf :: CreateDirectory -> () #
Hashable CreateDirectory Source #
Instance details Defined in Amazonka.CloudDirectory.CreateDirectory Methods hashWithSalt :: Int -> CreateDirectory -> Int # hash :: CreateDirectory -> Int #
ToJSON CreateDirectory Source #
Instance details Defined in Amazonka.CloudDirectory.CreateDirectory Methods toJSON :: CreateDirectory -> Value # toEncoding :: CreateDirectory -> Encoding # toJSONList :: [CreateDirectory] -> Value # toEncodingList :: [CreateDirectory] -> Encoding #
AWSRequest CreateDirectory Source #
Instance details Defined in Amazonka.CloudDirectory.CreateDirectory Associated Types type AWSResponse CreateDirectory # Methods request :: CreateDirectory -> Request CreateDirectory # response :: MonadResource m => Logger -> Service -> Proxy CreateDirectory -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDirectory))) #
ToHeaders CreateDirectory Source #
Instance details Defined in Amazonka.CloudDirectory.CreateDirectory Methods toHeaders :: CreateDirectory -> [Header] #
ToPath CreateDirectory Source #
Instance details Defined in Amazonka.CloudDirectory.CreateDirectory Methods toPath :: CreateDirectory -> ByteString #
ToQuery CreateDirectory Source #
Instance details Defined in Amazonka.CloudDirectory.CreateDirectory Methods toQuery :: CreateDirectory -> QueryString #
type Rep CreateDirectory Source #
Instance details Defined in Amazonka.CloudDirectory.CreateDirectory type Rep CreateDirectory = D1 ('MetaData "CreateDirectory" "Amazonka.CloudDirectory.CreateDirectory" "libZSservicesZSamazonka-clouddirectoryZSamazonka-clouddirectory" 'False) (C1 ('MetaCons "CreateDirectory'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "schemaArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CreateDirectory Source #
Instance details Defined in Amazonka.CloudDirectory.CreateDirectory type AWSResponse CreateDirectory = CreateDirectoryResponse

newCreateDirectory Source #

Arguments

:: Text	`$sel:name:CreateDirectory'`
-> Text	`$sel:schemaArn:CreateDirectory'`
-> CreateDirectory

Create a value of CreateDirectory 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:name:CreateDirectory', createDirectory_name - The name of the Directory. Should be unique per account, per region.

$sel:schemaArn:CreateDirectory', createDirectory_schemaArn - The Amazon Resource Name (ARN) of the published schema that will be copied into the data Directory. For more information, see arns.

Request Lenses

createDirectory_name :: Lens' CreateDirectory Text Source #

The name of the Directory. Should be unique per account, per region.

createDirectory_schemaArn :: Lens' CreateDirectory Text Source #

The Amazon Resource Name (ARN) of the published schema that will be copied into the data Directory. For more information, see arns.

Destructuring the Response

data CreateDirectoryResponse Source #

See: newCreateDirectoryResponse smart constructor.

Constructors

CreateDirectoryResponse'

Fields

httpStatus :: Int
The response's http status code.
directoryArn :: Text
The ARN that is associated with the Directory. For more information, see arns.
name :: Text
The name of the Directory.
objectIdentifier :: Text
The root object node of the created directory.
appliedSchemaArn :: Text
The ARN of the published schema in the Directory. Once a published schema is copied into the directory, it has its own ARN, which is referred to applied schema ARN. For more information, see arns.

Instances

Instances details

Eq CreateDirectoryResponse Source #
Instance details Defined in Amazonka.CloudDirectory.CreateDirectory Methods (==) :: CreateDirectoryResponse -> CreateDirectoryResponse -> Bool # (/=) :: CreateDirectoryResponse -> CreateDirectoryResponse -> Bool #
Read CreateDirectoryResponse Source #
Instance details Defined in Amazonka.CloudDirectory.CreateDirectory Methods readsPrec :: Int -> ReadS CreateDirectoryResponse # readList :: ReadS [CreateDirectoryResponse] # readPrec :: ReadPrec CreateDirectoryResponse # readListPrec :: ReadPrec [CreateDirectoryResponse] #
Show CreateDirectoryResponse Source #
Instance details Defined in Amazonka.CloudDirectory.CreateDirectory Methods showsPrec :: Int -> CreateDirectoryResponse -> ShowS # show :: CreateDirectoryResponse -> String # showList :: [CreateDirectoryResponse] -> ShowS #
Generic CreateDirectoryResponse Source #
Instance details Defined in Amazonka.CloudDirectory.CreateDirectory Associated Types type Rep CreateDirectoryResponse :: Type -> Type # Methods from :: CreateDirectoryResponse -> Rep CreateDirectoryResponse x # to :: Rep CreateDirectoryResponse x -> CreateDirectoryResponse #
NFData CreateDirectoryResponse Source #
Instance details Defined in Amazonka.CloudDirectory.CreateDirectory Methods rnf :: CreateDirectoryResponse -> () #
type Rep CreateDirectoryResponse Source #
Instance details Defined in Amazonka.CloudDirectory.CreateDirectory type Rep CreateDirectoryResponse = D1 ('MetaData "CreateDirectoryResponse" "Amazonka.CloudDirectory.CreateDirectory" "libZSservicesZSamazonka-clouddirectoryZSamazonka-clouddirectory" 'False) (C1 ('MetaCons "CreateDirectoryResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "directoryArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "objectIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "appliedSchemaArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateDirectoryResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateDirectoryResponse'`
-> Text	`$sel:directoryArn:CreateDirectoryResponse'`
-> Text	`$sel:name:CreateDirectory'`
-> Text	`$sel:objectIdentifier:CreateDirectoryResponse'`
-> Text	`$sel:appliedSchemaArn:CreateDirectoryResponse'`
-> CreateDirectoryResponse

Create a value of CreateDirectoryResponse 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:httpStatus:CreateDirectoryResponse', createDirectoryResponse_httpStatus - The response's http status code.

$sel:directoryArn:CreateDirectoryResponse', createDirectoryResponse_directoryArn - The ARN that is associated with the Directory. For more information, see arns.

$sel:name:CreateDirectory', createDirectoryResponse_name - The name of the Directory.

$sel:objectIdentifier:CreateDirectoryResponse', createDirectoryResponse_objectIdentifier - The root object node of the created directory.

$sel:appliedSchemaArn:CreateDirectoryResponse', createDirectoryResponse_appliedSchemaArn - The ARN of the published schema in the Directory. Once a published schema is copied into the directory, it has its own ARN, which is referred to applied schema ARN. For more information, see arns.

Response Lenses

createDirectoryResponse_httpStatus :: Lens' CreateDirectoryResponse Int Source #

The response's http status code.

createDirectoryResponse_directoryArn :: Lens' CreateDirectoryResponse Text Source #

The ARN that is associated with the Directory. For more information, see arns.

createDirectoryResponse_name :: Lens' CreateDirectoryResponse Text Source #

The name of the Directory.

createDirectoryResponse_objectIdentifier :: Lens' CreateDirectoryResponse Text Source #

The root object node of the created directory.

createDirectoryResponse_appliedSchemaArn :: Lens' CreateDirectoryResponse Text Source #

The ARN of the published schema in the Directory. Once a published schema is copied into the directory, it has its own ARN, which is referred to applied schema ARN. For more information, see arns.