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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a snapshot of a Simple AD or Microsoft AD directory in the Amazon Web Services cloud.

You cannot take snapshots of AD Connector directories.

Creating a Request

data CreateSnapshot Source #

Contains the inputs for the CreateSnapshot operation.

See: newCreateSnapshot smart constructor.

Constructors

CreateSnapshot'
Fields name :: Maybe Text The descriptive name to apply to the snapshot. directoryId :: Text The identifier of the directory of which to take a snapshot.

Instances

Instances details

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

newCreateSnapshot Source #

Arguments

:: Text	`CreateSnapshot`
-> CreateSnapshot

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

CreateSnapshot, createSnapshot_name - The descriptive name to apply to the snapshot.

CreateSnapshot, createSnapshot_directoryId - The identifier of the directory of which to take a snapshot.

Request Lenses

createSnapshot_name :: Lens' CreateSnapshot (Maybe Text) Source #

The descriptive name to apply to the snapshot.

createSnapshot_directoryId :: Lens' CreateSnapshot Text Source #

The identifier of the directory of which to take a snapshot.

Destructuring the Response

data CreateSnapshotResponse Source #

Contains the results of the CreateSnapshot operation.

See: newCreateSnapshotResponse smart constructor.

Constructors

CreateSnapshotResponse'
Fields snapshotId :: Maybe Text The identifier of the snapshot that was created. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateSnapshotResponse Source #

Arguments

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

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

CreateSnapshotResponse, createSnapshotResponse_snapshotId - The identifier of the snapshot that was created.

$sel:httpStatus:CreateSnapshotResponse', createSnapshotResponse_httpStatus - The response's http status code.

Response Lenses

createSnapshotResponse_snapshotId :: Lens' CreateSnapshotResponse (Maybe Text) Source #

The identifier of the snapshot that was created.

createSnapshotResponse_httpStatus :: Lens' CreateSnapshotResponse Int Source #

The response's http status code.