DescribeSnapshots (smaws-clients.Smaws_Client

Module Smaws_Client_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.

val error_to_string : 
  [ Smaws_Lib.Protocols.AwsJson.error
  | `BadRequest of Types.bad_request
  | `InternalServerError of Types.internal_server_error
  | `SnapshotNotFound of Types.snapshot_not_found ] ->
  string

val request : 
  'http_type Smaws_Lib.Context.t ->
  Types.describe_snapshots_request ->
  (Types.describe_snapshots_response,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `BadRequest of Types.bad_request
    | `InternalServerError of Types.internal_server_error
    | `SnapshotNotFound of Types.snapshot_not_found ])
    Stdlib.result

val request_with_metadata : 
  'http_type Smaws_Lib.Context.t ->
  Types.describe_snapshots_request ->
  (Types.describe_snapshots_response Smaws_Lib.Response.t,
    [> Smaws_Lib.Protocols.AwsJson.error
    | `BadRequest of Types.bad_request
    | `InternalServerError of Types.internal_server_error
    | `SnapshotNotFound of Types.snapshot_not_found ]
    * Smaws_Lib.Response.metadata)
    Stdlib.result