Amazonka.FSx.CreateSnapshot

Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, you can easily undo file changes and compare file versions by restoring the volume to a previous version.

If a snapshot with the specified client request token exists, and the parameters match, this operation returns the description of the existing snapshot. If a snapshot with the specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a snapshot with the specified client request token doesn't exist, CreateSnapshot does the following:

• Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle state of CREATING.
• Returns the description of the snapshot.

By using the idempotent operation, you can retry a CreateSnapshot operation without the risk of creating an extra snapshot. This approach can be useful when an initial call fails in a way that makes it unclear whether a snapshot was created. If you use the same client request token and the initial call created a snapshot, the operation returns a successful result because all the parameters are the same.

The CreateSnapshot operation returns while the snapshot's lifecycle state is still CREATING. You can check the snapshot creation status by calling the DescribeSnapshots operation, which returns the snapshot state along with other information.

Creating a Request

data CreateSnapshot

See: newCreateSnapshot smart constructor.

Constructors

CreateSnapshot'

Fields

• clientRequestToken :: Maybe Text
• tags :: Maybe (NonEmpty Tag)
• name :: Text

  The name of the snapshot.

• volumeId :: Text

  The ID of the volume that you are taking a snapshot of.

Instances

ToJSON CreateSnapshot

Defined in Amazonka.FSx.CreateSnapshot

Methods

toJSON :: CreateSnapshot -> Value

toEncoding :: CreateSnapshot -> Encoding

toJSONList :: [CreateSnapshot] -> Value

toEncodingList :: [CreateSnapshot] -> Encoding

ToHeaders CreateSnapshot

Defined in Amazonka.FSx.CreateSnapshot

Methods

toHeaders :: CreateSnapshot -> [Header]

ToPath CreateSnapshot

Defined in Amazonka.FSx.CreateSnapshot

Methods

toPath :: CreateSnapshot -> ByteString

ToQuery CreateSnapshot

Defined in Amazonka.FSx.CreateSnapshot

Methods

toQuery :: CreateSnapshot -> QueryString

AWSRequest CreateSnapshot

Defined in Amazonka.FSx.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

Defined in Amazonka.FSx.CreateSnapshot

Associated Types

type Rep CreateSnapshot :: Type -> Type

Methods

from :: CreateSnapshot -> Rep CreateSnapshot x

to :: Rep CreateSnapshot x -> CreateSnapshot

Read CreateSnapshot

Defined in Amazonka.FSx.CreateSnapshot

Methods

readsPrec :: Int -> ReadS CreateSnapshot

readList :: ReadS [CreateSnapshot]

readPrec :: ReadPrec CreateSnapshot

readListPrec :: ReadPrec [CreateSnapshot]

Show CreateSnapshot

Defined in Amazonka.FSx.CreateSnapshot

Methods

showsPrec :: Int -> CreateSnapshot -> ShowS

show :: CreateSnapshot -> String

showList :: [CreateSnapshot] -> ShowS

NFData CreateSnapshot

Defined in Amazonka.FSx.CreateSnapshot

Methods

rnf :: CreateSnapshot -> ()

Eq CreateSnapshot

Defined in Amazonka.FSx.CreateSnapshot

Methods

(==) :: CreateSnapshot -> CreateSnapshot -> Bool

(/=) :: CreateSnapshot -> CreateSnapshot -> Bool

Hashable CreateSnapshot

Defined in Amazonka.FSx.CreateSnapshot

Methods

hashWithSalt :: Int -> CreateSnapshot -> Int

hash :: CreateSnapshot -> Int

type AWSResponse CreateSnapshot

Defined in Amazonka.FSx.CreateSnapshot

type AWSResponse CreateSnapshot = CreateSnapshotResponse

type Rep CreateSnapshot

Defined in Amazonka.FSx.CreateSnapshot

type Rep CreateSnapshot = D1 ('MetaData "CreateSnapshot" "Amazonka.FSx.CreateSnapshot" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "CreateSnapshot'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag)))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "volumeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateSnapshot

Arguments

:: Text

CreateSnapshot

-> 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:

$sel:clientRequestToken:CreateSnapshot', createSnapshot_clientRequestToken - Undocumented member.

CreateSnapshot, createSnapshot_tags - Undocumented member.

CreateSnapshot, createSnapshot_name - The name of the snapshot.

CreateSnapshot, createSnapshot_volumeId - The ID of the volume that you are taking a snapshot of.

Request Lenses

createSnapshot_clientRequestToken :: Lens' CreateSnapshot (Maybe Text)

Undocumented member.

createSnapshot_tags :: Lens' CreateSnapshot (Maybe (NonEmpty Tag))

Undocumented member.

createSnapshot_name :: Lens' CreateSnapshot Text

The name of the snapshot.

createSnapshot_volumeId :: Lens' CreateSnapshot Text

The ID of the volume that you are taking a snapshot of.

Destructuring the Response

data CreateSnapshotResponse

See: newCreateSnapshotResponse smart constructor.

Constructors

CreateSnapshotResponse'

Fields

• snapshot :: Maybe Snapshot

  A description of the snapshot.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateSnapshotResponse

Defined in Amazonka.FSx.CreateSnapshot

Associated Types

type Rep CreateSnapshotResponse :: Type -> Type

Methods

from :: CreateSnapshotResponse -> Rep CreateSnapshotResponse x

to :: Rep CreateSnapshotResponse x -> CreateSnapshotResponse

Read CreateSnapshotResponse

Defined in Amazonka.FSx.CreateSnapshot

Methods

readsPrec :: Int -> ReadS CreateSnapshotResponse

readList :: ReadS [CreateSnapshotResponse]

readPrec :: ReadPrec CreateSnapshotResponse

readListPrec :: ReadPrec [CreateSnapshotResponse]

Show CreateSnapshotResponse

Defined in Amazonka.FSx.CreateSnapshot

Methods

showsPrec :: Int -> CreateSnapshotResponse -> ShowS

show :: CreateSnapshotResponse -> String

showList :: [CreateSnapshotResponse] -> ShowS

NFData CreateSnapshotResponse

Defined in Amazonka.FSx.CreateSnapshot

Methods

rnf :: CreateSnapshotResponse -> ()

Eq CreateSnapshotResponse

Defined in Amazonka.FSx.CreateSnapshot

Methods

(==) :: CreateSnapshotResponse -> CreateSnapshotResponse -> Bool

(/=) :: CreateSnapshotResponse -> CreateSnapshotResponse -> Bool

type Rep CreateSnapshotResponse

Defined in Amazonka.FSx.CreateSnapshot

type Rep CreateSnapshotResponse = D1 ('MetaData "CreateSnapshotResponse" "Amazonka.FSx.CreateSnapshot" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "CreateSnapshotResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "snapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Snapshot)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateSnapshotResponse

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:

$sel:snapshot:CreateSnapshotResponse', createSnapshotResponse_snapshot - A description of the snapshot.

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

Response Lenses

createSnapshotResponse_snapshot :: Lens' CreateSnapshotResponse (Maybe Snapshot)

A description of the snapshot.

createSnapshotResponse_httpStatus :: Lens' CreateSnapshotResponse Int

The response's http status code.