Amazonka.FSx.DescribeSnapshots

Returns the description of specific Amazon FSx for OpenZFS snapshots, if a SnapshotIds value is provided. Otherwise, this operation returns all snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all snapshots, you can optionally specify the MaxResults parameter to limit the number of snapshots in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

Use this operation in an iterative process to retrieve a list of your snapshots. DescribeSnapshots is called first without a NextToken value. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken value.

When using this operation, keep the following in mind:

• The operation might return fewer than the MaxResults value of snapshot descriptions while still including a NextToken value.
• The order of snapshots returned in the response of one DescribeSnapshots call and the order of backups returned across the responses of a multi-call iteration is unspecified.

Creating a Request

data DescribeSnapshots

See: newDescribeSnapshots smart constructor.

Constructors

DescribeSnapshots'

Fields

• filters :: Maybe [SnapshotFilter]

  The filters structure. The supported names are file-system-id or volume-id.

• maxResults :: Maybe Natural
• nextToken :: Maybe Text
• snapshotIds :: Maybe [Text]

  The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a SnapshotNotFound error occurs.

Instances

ToJSON DescribeSnapshots

Defined in Amazonka.FSx.DescribeSnapshots

Methods

toJSON :: DescribeSnapshots -> Value

toEncoding :: DescribeSnapshots -> Encoding

toJSONList :: [DescribeSnapshots] -> Value

toEncodingList :: [DescribeSnapshots] -> Encoding

ToHeaders DescribeSnapshots

Defined in Amazonka.FSx.DescribeSnapshots

Methods

toHeaders :: DescribeSnapshots -> [Header]

ToPath DescribeSnapshots

Defined in Amazonka.FSx.DescribeSnapshots

Methods

toPath :: DescribeSnapshots -> ByteString

ToQuery DescribeSnapshots

Defined in Amazonka.FSx.DescribeSnapshots

Methods

toQuery :: DescribeSnapshots -> QueryString

AWSRequest DescribeSnapshots

Defined in Amazonka.FSx.DescribeSnapshots

Associated Types

type AWSResponse DescribeSnapshots

Methods

request :: (Service -> Service) -> DescribeSnapshots -> Request DescribeSnapshots

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeSnapshots -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeSnapshots)))

Generic DescribeSnapshots

Defined in Amazonka.FSx.DescribeSnapshots

Associated Types

type Rep DescribeSnapshots :: Type -> Type

Methods

from :: DescribeSnapshots -> Rep DescribeSnapshots x

to :: Rep DescribeSnapshots x -> DescribeSnapshots

Read DescribeSnapshots

Defined in Amazonka.FSx.DescribeSnapshots

Methods

readsPrec :: Int -> ReadS DescribeSnapshots

readList :: ReadS [DescribeSnapshots]

readPrec :: ReadPrec DescribeSnapshots

readListPrec :: ReadPrec [DescribeSnapshots]

Show DescribeSnapshots

Defined in Amazonka.FSx.DescribeSnapshots

Methods

showsPrec :: Int -> DescribeSnapshots -> ShowS

show :: DescribeSnapshots -> String

showList :: [DescribeSnapshots] -> ShowS

NFData DescribeSnapshots

Defined in Amazonka.FSx.DescribeSnapshots

Methods

rnf :: DescribeSnapshots -> ()

Eq DescribeSnapshots

Defined in Amazonka.FSx.DescribeSnapshots

Methods

(==) :: DescribeSnapshots -> DescribeSnapshots -> Bool

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

Hashable DescribeSnapshots

Defined in Amazonka.FSx.DescribeSnapshots

Methods

hashWithSalt :: Int -> DescribeSnapshots -> Int

hash :: DescribeSnapshots -> Int

type AWSResponse DescribeSnapshots

Defined in Amazonka.FSx.DescribeSnapshots

type AWSResponse DescribeSnapshots = DescribeSnapshotsResponse

type Rep DescribeSnapshots

Defined in Amazonka.FSx.DescribeSnapshots

type Rep DescribeSnapshots = D1 ('MetaData "DescribeSnapshots" "Amazonka.FSx.DescribeSnapshots" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "DescribeSnapshots'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SnapshotFilter])) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "snapshotIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newDescribeSnapshots :: DescribeSnapshots

Create a value of DescribeSnapshots 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:filters:DescribeSnapshots', describeSnapshots_filters - The filters structure. The supported names are file-system-id or volume-id.

$sel:maxResults:DescribeSnapshots', describeSnapshots_maxResults - Undocumented member.

DescribeSnapshots, describeSnapshots_nextToken - Undocumented member.

$sel:snapshotIds:DescribeSnapshots', describeSnapshots_snapshotIds - The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a SnapshotNotFound error occurs.

Request Lenses

describeSnapshots_filters :: Lens' DescribeSnapshots (Maybe [SnapshotFilter])

The filters structure. The supported names are file-system-id or volume-id.

describeSnapshots_maxResults :: Lens' DescribeSnapshots (Maybe Natural)

Undocumented member.

describeSnapshots_nextToken :: Lens' DescribeSnapshots (Maybe Text)

Undocumented member.

describeSnapshots_snapshotIds :: Lens' DescribeSnapshots (Maybe [Text])

The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a SnapshotNotFound error occurs.

Destructuring the Response

data DescribeSnapshotsResponse

See: newDescribeSnapshotsResponse smart constructor.

Constructors

DescribeSnapshotsResponse'

Fields

• nextToken :: Maybe Text
• snapshots :: Maybe [Snapshot]

  An array of snapshots.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeSnapshotsResponse

Defined in Amazonka.FSx.DescribeSnapshots

Associated Types

type Rep DescribeSnapshotsResponse :: Type -> Type

Methods

from :: DescribeSnapshotsResponse -> Rep DescribeSnapshotsResponse x

to :: Rep DescribeSnapshotsResponse x -> DescribeSnapshotsResponse

Read DescribeSnapshotsResponse

Defined in Amazonka.FSx.DescribeSnapshots

Methods

readsPrec :: Int -> ReadS DescribeSnapshotsResponse

readList :: ReadS [DescribeSnapshotsResponse]

readPrec :: ReadPrec DescribeSnapshotsResponse

readListPrec :: ReadPrec [DescribeSnapshotsResponse]

Show DescribeSnapshotsResponse

Defined in Amazonka.FSx.DescribeSnapshots

Methods

showsPrec :: Int -> DescribeSnapshotsResponse -> ShowS

show :: DescribeSnapshotsResponse -> String

showList :: [DescribeSnapshotsResponse] -> ShowS

NFData DescribeSnapshotsResponse

Defined in Amazonka.FSx.DescribeSnapshots

Methods

rnf :: DescribeSnapshotsResponse -> ()

Eq DescribeSnapshotsResponse

Defined in Amazonka.FSx.DescribeSnapshots

Methods

(==) :: DescribeSnapshotsResponse -> DescribeSnapshotsResponse -> Bool

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

type Rep DescribeSnapshotsResponse

Defined in Amazonka.FSx.DescribeSnapshots

type Rep DescribeSnapshotsResponse = D1 ('MetaData "DescribeSnapshotsResponse" "Amazonka.FSx.DescribeSnapshots" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "DescribeSnapshotsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "snapshots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Snapshot])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeSnapshotsResponse

Arguments

:: Int

$sel:httpStatus:DescribeSnapshotsResponse'

-> DescribeSnapshotsResponse

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

DescribeSnapshots, describeSnapshotsResponse_nextToken - Undocumented member.

$sel:snapshots:DescribeSnapshotsResponse', describeSnapshotsResponse_snapshots - An array of snapshots.

$sel:httpStatus:DescribeSnapshotsResponse', describeSnapshotsResponse_httpStatus - The response's http status code.

Response Lenses

describeSnapshotsResponse_nextToken :: Lens' DescribeSnapshotsResponse (Maybe Text)

Undocumented member.

describeSnapshotsResponse_snapshots :: Lens' DescribeSnapshotsResponse (Maybe [Snapshot])

An array of snapshots.

describeSnapshotsResponse_httpStatus :: Lens' DescribeSnapshotsResponse Int

The response's http status code.