AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 3.5
 
Container for the parameters to the DescribeDBSnapshots operation. Returns information about DB snapshots. This API supports pagination.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.RDS.AmazonRDSRequest
      Amazon.RDS.Model.DescribeDBSnapshotsRequest

Namespace: Amazon.RDS.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class DescribeDBSnapshotsRequest : AmazonRDSRequest
         IRequestEvents

The DescribeDBSnapshotsRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeDBSnapshotsRequest() Empty constructor used to set properties independently even when a simple constructor is available

Properties

NameTypeDescription
Public Property DBInstanceIdentifier System.String Gets and sets the property DBInstanceIdentifier.

A DB instance identifier to retrieve the list of DB snapshots for. This parameter cannot be used in conjunction with DBSnapshotIdentifier. This parameter is not 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
Public Property DBSnapshotIdentifier System.String Gets and sets the property DBSnapshotIdentifier.

A specific DB snapshot identifier to describe. This parameter 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.
Public Property Filters System.Collections.Generic.List<Amazon.RDS.Model.Filter> Gets and sets the property Filters.

This parameter is not currently supported.

Public Property IncludePublic System.Boolean Gets and sets the property IncludePublic.

True to include manual DB snapshots that are public and can be copied or restored by any AWS account; otherwise false. The default is false.

An manual DB snapshot is shared as public by the ModifyDBSnapshotAttribute API.

Public Property IncludeShared System.Boolean Gets and sets the property IncludeShared.

True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore; otherwise false. The default is false.

An AWS account is given permission to restore a manual DB snapshot from another AWS account by the ModifyDBSnapshotAttribute API.

Public Property Marker System.String Gets and sets the property Marker.

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.

Public Property MaxRecords System.Int32 Gets and sets the property MaxRecords.

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 can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Public Property SnapshotType System.String Gets and sets the property SnapshotType.

The type of snapshots that will be returned. You can specify one of the following values:

  • automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.
  • manual - Return all DB snapshots that have been taken by my AWS account.
  • shared - Return all manual DB snapshots that have been shared to my AWS account.
  • public - Return all DB snapshots that have been marked as public.

If you do not specify a SnapshotType, then both automated and manual snapshots are returned. You can include shared snapshots with these results by setting the IncludeShared parameter to true. You can include public snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters do not apply for SnapshotType values of manual or automated. The IncludePublic parameter does not apply when SnapshotType is set to shared. the IncludeShared parameter does not apply when SnapshotType is set to public.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1