API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see

We welcome your feedback on this new version of the documentation. Send your comments to


import ""

type DescribeDBSnapshotsInput struct { DBInstanceIdentifier *string `type:"string"` DBSnapshotIdentifier *string `type:"string"` DbiResourceId *string `type:"string"` Filters []*Filter `locationNameList:"Filter" type:"list"` IncludePublic *bool `type:"boolean"` IncludeShared *bool `type:"boolean"` Marker *string `type:"string"` MaxRecords *int64 `type:"integer"` SnapshotType *string `type:"string"` }


Type: *string

The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction with DBSnapshotIdentifier. This parameter is not case-sensitive.


  • If supplied, must match the identifier of an existing DBInstance.


Type: *string

A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.


  • If supplied, must match the identifier of an existing DBSnapshot.

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.


Type: *string

A specific DB resource ID to describe.


A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

Currently, wildcards are not supported in filters.

The following actions can be filtered:

  • DescribeDBClusterBacktracks

  • DescribeDBClusterEndpoints

  • DescribeDBClusters

  • DescribeDBInstances

  • DescribePendingMaintenanceActions


Type: *bool

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

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.


Type: *bool

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

You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.


Type: *string

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.


Type: *int64

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.


Type: *string

The type of snapshots to 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 don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. 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 don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.



func (s DescribeDBSnapshotsInput) GoString() string

GoString returns the string representation


func (s *DescribeDBSnapshotsInput) SetDBInstanceIdentifier(v string) *DescribeDBSnapshotsInput

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.


func (s *DescribeDBSnapshotsInput) SetDBSnapshotIdentifier(v string) *DescribeDBSnapshotsInput

SetDBSnapshotIdentifier sets the DBSnapshotIdentifier field's value.


func (s *DescribeDBSnapshotsInput) SetDbiResourceId(v string) *DescribeDBSnapshotsInput

SetDbiResourceId sets the DbiResourceId field's value.


func (s *DescribeDBSnapshotsInput) SetFilters(v []*Filter) *DescribeDBSnapshotsInput

SetFilters sets the Filters field's value.


func (s *DescribeDBSnapshotsInput) SetIncludePublic(v bool) *DescribeDBSnapshotsInput

SetIncludePublic sets the IncludePublic field's value.


func (s *DescribeDBSnapshotsInput) SetIncludeShared(v bool) *DescribeDBSnapshotsInput

SetIncludeShared sets the IncludeShared field's value.


func (s *DescribeDBSnapshotsInput) SetMarker(v string) *DescribeDBSnapshotsInput

SetMarker sets the Marker field's value.


func (s *DescribeDBSnapshotsInput) SetMaxRecords(v int64) *DescribeDBSnapshotsInput

SetMaxRecords sets the MaxRecords field's value.


func (s *DescribeDBSnapshotsInput) SetSnapshotType(v string) *DescribeDBSnapshotsInput

SetSnapshotType sets the SnapshotType field's value.


func (s DescribeDBSnapshotsInput) String() string

String returns the string representation


func (s *DescribeDBSnapshotsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: