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.DirectoryService.StartSchemaExtension

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Applies a schema extension to a Microsoft AD directory.

Synopsis

data StartSchemaExtension = StartSchemaExtension' {
- directoryId :: Text
- createSnapshotBeforeSchemaExtension :: Bool
- ldifContent :: Text
- description :: Text
}
newStartSchemaExtension :: Text -> Bool -> Text -> Text -> StartSchemaExtension
startSchemaExtension_directoryId :: Lens' StartSchemaExtension Text
startSchemaExtension_createSnapshotBeforeSchemaExtension :: Lens' StartSchemaExtension Bool
startSchemaExtension_ldifContent :: Lens' StartSchemaExtension Text
startSchemaExtension_description :: Lens' StartSchemaExtension Text
data StartSchemaExtensionResponse = StartSchemaExtensionResponse' {
- schemaExtensionId :: Maybe Text
- httpStatus :: Int
}
newStartSchemaExtensionResponse :: Int -> StartSchemaExtensionResponse
startSchemaExtensionResponse_schemaExtensionId :: Lens' StartSchemaExtensionResponse (Maybe Text)
startSchemaExtensionResponse_httpStatus :: Lens' StartSchemaExtensionResponse Int

Creating a Request

data StartSchemaExtension Source #

See: newStartSchemaExtension smart constructor.

Constructors

StartSchemaExtension'

Fields

directoryId :: Text
The identifier of the directory for which the schema extension will be applied to.
createSnapshotBeforeSchemaExtension :: Bool
If true, creates a snapshot of the directory before applying the schema extension.
ldifContent :: Text
The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with \n. See the example request below for more details. The file size can be no larger than 1MB.
description :: Text
A description of the schema extension.

Instances

Instances details

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

newStartSchemaExtension Source #

Arguments

:: Text	`$sel:directoryId:StartSchemaExtension'`
-> Bool	`$sel:createSnapshotBeforeSchemaExtension:StartSchemaExtension'`
-> Text	`$sel:ldifContent:StartSchemaExtension'`
-> Text	`$sel:description:StartSchemaExtension'`
-> StartSchemaExtension

Create a value of StartSchemaExtension 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:directoryId:StartSchemaExtension', startSchemaExtension_directoryId - The identifier of the directory for which the schema extension will be applied to.

$sel:createSnapshotBeforeSchemaExtension:StartSchemaExtension', startSchemaExtension_createSnapshotBeforeSchemaExtension - If true, creates a snapshot of the directory before applying the schema extension.

$sel:ldifContent:StartSchemaExtension', startSchemaExtension_ldifContent - The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with \n. See the example request below for more details. The file size can be no larger than 1MB.

$sel:description:StartSchemaExtension', startSchemaExtension_description - A description of the schema extension.

Request Lenses

startSchemaExtension_directoryId :: Lens' StartSchemaExtension Text Source #

The identifier of the directory for which the schema extension will be applied to.

startSchemaExtension_createSnapshotBeforeSchemaExtension :: Lens' StartSchemaExtension Bool Source #

If true, creates a snapshot of the directory before applying the schema extension.

startSchemaExtension_ldifContent :: Lens' StartSchemaExtension Text Source #

The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with \n. See the example request below for more details. The file size can be no larger than 1MB.

startSchemaExtension_description :: Lens' StartSchemaExtension Text Source #

A description of the schema extension.

Destructuring the Response

data StartSchemaExtensionResponse Source #

See: newStartSchemaExtensionResponse smart constructor.

Constructors

StartSchemaExtensionResponse'
Fields schemaExtensionId :: Maybe Text The identifier of the schema extension that will be applied. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq StartSchemaExtensionResponse Source #
Instance details Defined in Amazonka.DirectoryService.StartSchemaExtension Methods (==) :: StartSchemaExtensionResponse -> StartSchemaExtensionResponse -> Bool # (/=) :: StartSchemaExtensionResponse -> StartSchemaExtensionResponse -> Bool #
Read StartSchemaExtensionResponse Source #
Instance details Defined in Amazonka.DirectoryService.StartSchemaExtension Methods readsPrec :: Int -> ReadS StartSchemaExtensionResponse # readList :: ReadS [StartSchemaExtensionResponse] # readPrec :: ReadPrec StartSchemaExtensionResponse # readListPrec :: ReadPrec [StartSchemaExtensionResponse] #
Show StartSchemaExtensionResponse Source #
Instance details Defined in Amazonka.DirectoryService.StartSchemaExtension Methods showsPrec :: Int -> StartSchemaExtensionResponse -> ShowS # show :: StartSchemaExtensionResponse -> String # showList :: [StartSchemaExtensionResponse] -> ShowS #
Generic StartSchemaExtensionResponse Source #
Instance details Defined in Amazonka.DirectoryService.StartSchemaExtension Associated Types type Rep StartSchemaExtensionResponse :: Type -> Type # Methods from :: StartSchemaExtensionResponse -> Rep StartSchemaExtensionResponse x # to :: Rep StartSchemaExtensionResponse x -> StartSchemaExtensionResponse #
NFData StartSchemaExtensionResponse Source #
Instance details Defined in Amazonka.DirectoryService.StartSchemaExtension Methods rnf :: StartSchemaExtensionResponse -> () #
type Rep StartSchemaExtensionResponse Source #
Instance details Defined in Amazonka.DirectoryService.StartSchemaExtension type Rep StartSchemaExtensionResponse = D1 ('MetaData "StartSchemaExtensionResponse" "Amazonka.DirectoryService.StartSchemaExtension" "libZSservicesZSamazonka-dsZSamazonka-ds" 'False) (C1 ('MetaCons "StartSchemaExtensionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "schemaExtensionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartSchemaExtensionResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartSchemaExtensionResponse'`
-> StartSchemaExtensionResponse

Create a value of StartSchemaExtensionResponse 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:schemaExtensionId:StartSchemaExtensionResponse', startSchemaExtensionResponse_schemaExtensionId - The identifier of the schema extension that will be applied.

$sel:httpStatus:StartSchemaExtensionResponse', startSchemaExtensionResponse_httpStatus - The response's http status code.

Response Lenses

startSchemaExtensionResponse_schemaExtensionId :: Lens' StartSchemaExtensionResponse (Maybe Text) Source #

The identifier of the schema extension that will be applied.

startSchemaExtensionResponse_httpStatus :: Lens' StartSchemaExtensionResponse Int Source #

The response's http status code.