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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the directory for a particular update type.

Creating a Request

data UpdateDirectorySetup Source #

See: newUpdateDirectorySetup smart constructor.

Constructors

UpdateDirectorySetup'

Fields

createSnapshotBeforeUpdate :: Maybe Bool
The boolean that specifies if a snapshot for the directory needs to be taken before updating the directory.
oSUpdateSettings :: Maybe OSUpdateSettings
The settings for the OS update that needs to be performed on the directory.
directoryId :: Text
The identifier of the directory on which you want to perform the update.
updateType :: UpdateType
The type of update that needs to be performed on the directory. For example, OS.

Instances

Instances details

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

newUpdateDirectorySetup Source #

Arguments

:: Text	`UpdateDirectorySetup`
-> UpdateType	`$sel:updateType:UpdateDirectorySetup'`
-> UpdateDirectorySetup

Create a value of UpdateDirectorySetup 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:createSnapshotBeforeUpdate:UpdateDirectorySetup', updateDirectorySetup_createSnapshotBeforeUpdate - The boolean that specifies if a snapshot for the directory needs to be taken before updating the directory.

UpdateDirectorySetup, updateDirectorySetup_oSUpdateSettings - The settings for the OS update that needs to be performed on the directory.

UpdateDirectorySetup, updateDirectorySetup_directoryId - The identifier of the directory on which you want to perform the update.

$sel:updateType:UpdateDirectorySetup', updateDirectorySetup_updateType - The type of update that needs to be performed on the directory. For example, OS.

Request Lenses

updateDirectorySetup_createSnapshotBeforeUpdate :: Lens' UpdateDirectorySetup (Maybe Bool) Source #

The boolean that specifies if a snapshot for the directory needs to be taken before updating the directory.

updateDirectorySetup_oSUpdateSettings :: Lens' UpdateDirectorySetup (Maybe OSUpdateSettings) Source #

The settings for the OS update that needs to be performed on the directory.

updateDirectorySetup_directoryId :: Lens' UpdateDirectorySetup Text Source #

The identifier of the directory on which you want to perform the update.

updateDirectorySetup_updateType :: Lens' UpdateDirectorySetup UpdateType Source #

The type of update that needs to be performed on the directory. For example, OS.

Destructuring the Response

data UpdateDirectorySetupResponse Source #

See: newUpdateDirectorySetupResponse smart constructor.

Constructors

UpdateDirectorySetupResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newUpdateDirectorySetupResponse Source #

Arguments

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

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

Response Lenses

updateDirectorySetupResponse_httpStatus :: Lens' UpdateDirectorySetupResponse Int Source #

The response's http status code.