Method: Aws::Drs::Client#describe_recovery_snapshots

Defined in:

lib/aws-sdk-drs/client.rb

#describe_recovery_snapshots(params = {}) ⇒ Types::DescribeRecoverySnapshotsResponse

Lists all Recovery Snapshots for a single Source Server.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values

resp = client.describe_recovery_snapshots({
  filters: {
    from_date_time: "ISO8601DatetimeString",
    to_date_time: "ISO8601DatetimeString",
  },
  max_results: 1,
  next_token: "PaginationToken",
  order: "ASC", # accepts ASC, DESC
  source_server_id: "SourceServerID", # required
})

Response structure

resp.items #=> Array
resp.items[0].ebs_snapshots #=> Array
resp.items[0].ebs_snapshots[0] #=> String
resp.items[0].expected_timestamp #=> String
resp.items[0].snapshot_id #=> String
resp.items[0].source_server_id #=> String
resp.items[0].timestamp #=> String
resp.next_token #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :filters (Types::DescribeRecoverySnapshotsRequestFilters) —

  A set of filters by which to return Recovery Snapshots.

• :max_results (Integer) —

  Maximum number of Recovery Snapshots to retrieve.

• :next_token (String) —

  The token of the next Recovery Snapshot to retrieve.

• :order (String) —

  The sorted ordering by which to return Recovery Snapshots.

• :source_server_id (required, String) —

  Filter Recovery Snapshots by Source Server ID.

Returns:

• (Types::DescribeRecoverySnapshotsResponse) —

  Returns a response object which responds to the following methods:

  • #items => Array<Types::RecoverySnapshot>

  • #next_token => String

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-drs/client.rb', line 1398

def describe_recovery_snapshots(params = {}, options = {})
  req = build_request(:describe_recovery_snapshots, params)
  req.send_request(options)
end