describe_db_snapshots ( $opt )

Returns information about DBSnapshots. This API supports pagination.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • DBInstanceIdentifier - string - Optional - A DB Instance Identifier to retrieve the list of DB Snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier. This parameter isn’t case sensitive. Constraints:
    • Must contain from 1 to 63 alphanumeric characters or hyphens
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
  • DBSnapshotIdentifier - string - Optional - A specific DB Snapshot Identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string. Constraints:
    • Must be 1 to 255 alphanumeric characters
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    • If this is the identifier of an automated snapshot, the SnapshotType parameter must also be specified.
  • SnapshotType - string - Optional - An optional snapshot type for which snapshots will be returned. If not specified, the returned results will include snapshots of all types.
  • MaxRecords - integer - Optional - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100
  • Marker - string - Optional - An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
  • curlopts - array - Optional - A set of values to pass directly into curl_setopt(), where the key is a pre-defined CURLOPT_* constant.
  • returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.

Returns

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

Examples

Describe a single database snapshot.

// Instantiate the class
$rds = new AmazonRDS();

$response = $rds->describe_db_snapshots();

// Success?
var_dump($response->isOK());
Result:
bool(true)

Related Methods

Source

Method defined in services/rds.class.php | Toggle source view (6 lines) | View on GitHub

public function describe_db_snapshots($opt = null)
{
    if (!$opt) $opt = array();
            
    return $this->authenticate('DescribeDBSnapshots', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback