Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RDS.DescribeDBSnapshots

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about DB snapshots. This API action supports pagination.

This operation returns paginated results.

Synopsis

data DescribeDBSnapshots = DescribeDBSnapshots' {
- dbInstanceIdentifier :: Maybe Text
- dbSnapshotIdentifier :: Maybe Text
- dbiResourceId :: Maybe Text
- filters :: Maybe [Filter]
- includePublic :: Maybe Bool
- includeShared :: Maybe Bool
- marker :: Maybe Text
- maxRecords :: Maybe Int
- snapshotType :: Maybe Text
}
newDescribeDBSnapshots :: DescribeDBSnapshots
describeDBSnapshots_dbInstanceIdentifier :: Lens' DescribeDBSnapshots (Maybe Text)
describeDBSnapshots_dbSnapshotIdentifier :: Lens' DescribeDBSnapshots (Maybe Text)
describeDBSnapshots_dbiResourceId :: Lens' DescribeDBSnapshots (Maybe Text)
describeDBSnapshots_filters :: Lens' DescribeDBSnapshots (Maybe [Filter])
describeDBSnapshots_includePublic :: Lens' DescribeDBSnapshots (Maybe Bool)
describeDBSnapshots_includeShared :: Lens' DescribeDBSnapshots (Maybe Bool)
describeDBSnapshots_marker :: Lens' DescribeDBSnapshots (Maybe Text)
describeDBSnapshots_maxRecords :: Lens' DescribeDBSnapshots (Maybe Int)
describeDBSnapshots_snapshotType :: Lens' DescribeDBSnapshots (Maybe Text)
data DescribeDBSnapshotsResponse = DescribeDBSnapshotsResponse' {
- dbSnapshots :: Maybe [DBSnapshot]
- marker :: Maybe Text
- httpStatus :: Int
}
newDescribeDBSnapshotsResponse :: Int -> DescribeDBSnapshotsResponse
describeDBSnapshotsResponse_dbSnapshots :: Lens' DescribeDBSnapshotsResponse (Maybe [DBSnapshot])
describeDBSnapshotsResponse_marker :: Lens' DescribeDBSnapshotsResponse (Maybe Text)
describeDBSnapshotsResponse_httpStatus :: Lens' DescribeDBSnapshotsResponse Int

Creating a Request

data DescribeDBSnapshots Source #

See: newDescribeDBSnapshots smart constructor.

Constructors

DescribeDBSnapshots'

Fields

dbInstanceIdentifier :: Maybe Text
The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive.
Constraints:
- If supplied, must match the identifier of an existing DBInstance.
dbSnapshotIdentifier :: Maybe Text
A specific DB snapshot identifier to describe. This value is stored as a lowercase string.
Constraints:
- 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.
dbiResourceId :: Maybe Text
A specific DB resource ID to describe.
filters :: Maybe [Filter]
A filter that specifies one or more DB snapshots to describe.
Supported filters:
- db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
- db-snapshot-id - Accepts DB snapshot identifiers.
- dbi-resource-id - Accepts identifiers of source DB instances.
- snapshot-type - Accepts types of DB snapshots.
- engine - Accepts names of database engines.
includePublic :: Maybe Bool
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
This setting doesn't apply to RDS Custom.
includeShared :: Maybe Bool
A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
This setting doesn't apply to RDS Custom.
marker :: Maybe Text
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.
maxRecords :: Maybe Int
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 you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
snapshotType :: Maybe Text
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 Amazon Web Services account.
- manual - Return all DB snapshots that have been taken by my Amazon Web Services account.
- shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.
- public - Return all DB snapshots that have been marked as public.
- awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.
  For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide.
  The awsbackup type does not apply to Aurora.
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 enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.
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.

Instances

Instances details

ToHeaders DescribeDBSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBSnapshots Methods toHeaders :: DescribeDBSnapshots -> [Header] #
ToPath DescribeDBSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBSnapshots Methods toPath :: DescribeDBSnapshots -> ByteString #
ToQuery DescribeDBSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBSnapshots Methods toQuery :: DescribeDBSnapshots -> QueryString #
AWSPager DescribeDBSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBSnapshots Methods page :: DescribeDBSnapshots -> AWSResponse DescribeDBSnapshots -> Maybe DescribeDBSnapshots #
AWSRequest DescribeDBSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBSnapshots Associated Types type AWSResponse DescribeDBSnapshots # Methods request :: (Service -> Service) -> DescribeDBSnapshots -> Request DescribeDBSnapshots # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDBSnapshots -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDBSnapshots))) #
Generic DescribeDBSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBSnapshots Associated Types type Rep DescribeDBSnapshots :: Type -> Type # Methods from :: DescribeDBSnapshots -> Rep DescribeDBSnapshots x # to :: Rep DescribeDBSnapshots x -> DescribeDBSnapshots #
Read DescribeDBSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBSnapshots Methods readsPrec :: Int -> ReadS DescribeDBSnapshots # readList :: ReadS [DescribeDBSnapshots] # readPrec :: ReadPrec DescribeDBSnapshots # readListPrec :: ReadPrec [DescribeDBSnapshots] #
Show DescribeDBSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBSnapshots Methods showsPrec :: Int -> DescribeDBSnapshots -> ShowS # show :: DescribeDBSnapshots -> String # showList :: [DescribeDBSnapshots] -> ShowS #
NFData DescribeDBSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBSnapshots Methods rnf :: DescribeDBSnapshots -> () #
Eq DescribeDBSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBSnapshots Methods (==) :: DescribeDBSnapshots -> DescribeDBSnapshots -> Bool # (/=) :: DescribeDBSnapshots -> DescribeDBSnapshots -> Bool #
Hashable DescribeDBSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBSnapshots Methods hashWithSalt :: Int -> DescribeDBSnapshots -> Int # hash :: DescribeDBSnapshots -> Int #
type AWSResponse DescribeDBSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBSnapshots type AWSResponse DescribeDBSnapshots = DescribeDBSnapshotsResponse
type Rep DescribeDBSnapshots Source #
Instance details Defined in Amazonka.RDS.DescribeDBSnapshots type Rep DescribeDBSnapshots = D1 ('MetaData "DescribeDBSnapshots" "Amazonka.RDS.DescribeDBSnapshots" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeDBSnapshots'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbSnapshotIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "dbiResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])))) :: ((S1 ('MetaSel ('Just "includePublic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "includeShared") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "snapshotType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newDescribeDBSnapshots :: DescribeDBSnapshots Source #

Create a value of DescribeDBSnapshots with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeDBSnapshots, describeDBSnapshots_dbInstanceIdentifier - The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive.

Constraints:

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

DescribeDBSnapshots, describeDBSnapshots_dbSnapshotIdentifier - A specific DB snapshot identifier to describe. This value is stored as a lowercase string.

Constraints:

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.

DescribeDBSnapshots, describeDBSnapshots_dbiResourceId - A specific DB resource ID to describe.

$sel:filters:DescribeDBSnapshots', describeDBSnapshots_filters - A filter that specifies one or more DB snapshots to describe.

Supported filters:

db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
db-snapshot-id - Accepts DB snapshot identifiers.
dbi-resource-id - Accepts identifiers of source DB instances.
snapshot-type - Accepts types of DB snapshots.
engine - Accepts names of database engines.

$sel:includePublic:DescribeDBSnapshots', describeDBSnapshots_includePublic - A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

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

This setting doesn't apply to RDS Custom.

$sel:includeShared:DescribeDBSnapshots', describeDBSnapshots_includeShared - A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

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

This setting doesn't apply to RDS Custom.

DescribeDBSnapshots, describeDBSnapshots_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.

$sel:maxRecords:DescribeDBSnapshots', describeDBSnapshots_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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

DescribeDBSnapshots, describeDBSnapshots_snapshotType - 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 Amazon Web Services account.
manual - Return all DB snapshots that have been taken by my Amazon Web Services account.
shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.
public - Return all DB snapshots that have been marked as public.
awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.
For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide.
The awsbackup type does not apply to Aurora.

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 enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.

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.

Request Lenses

describeDBSnapshots_dbInstanceIdentifier :: Lens' DescribeDBSnapshots (Maybe Text) Source #

The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive.

Constraints:

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

describeDBSnapshots_dbSnapshotIdentifier :: Lens' DescribeDBSnapshots (Maybe Text) Source #

A specific DB snapshot identifier to describe. This value is stored as a lowercase string.

Constraints:

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.

describeDBSnapshots_dbiResourceId :: Lens' DescribeDBSnapshots (Maybe Text) Source #

A specific DB resource ID to describe.

describeDBSnapshots_filters :: Lens' DescribeDBSnapshots (Maybe [Filter]) Source #

A filter that specifies one or more DB snapshots to describe.

Supported filters:

db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).
db-snapshot-id - Accepts DB snapshot identifiers.
dbi-resource-id - Accepts identifiers of source DB instances.
snapshot-type - Accepts types of DB snapshots.
engine - Accepts names of database engines.

describeDBSnapshots_includePublic :: Lens' DescribeDBSnapshots (Maybe Bool) Source #

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.

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

This setting doesn't apply to RDS Custom.

describeDBSnapshots_includeShared :: Lens' DescribeDBSnapshots (Maybe Bool) Source #

A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.

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

This setting doesn't apply to RDS Custom.

describeDBSnapshots_marker :: Lens' DescribeDBSnapshots (Maybe Text) Source #

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.

describeDBSnapshots_maxRecords :: Lens' DescribeDBSnapshots (Maybe Int) Source #

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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeDBSnapshots_snapshotType :: Lens' DescribeDBSnapshots (Maybe Text) Source #

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 Amazon Web Services account.
manual - Return all DB snapshots that have been taken by my Amazon Web Services account.
shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.
public - Return all DB snapshots that have been marked as public.
awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service.
For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide.
The awsbackup type does not apply to Aurora.

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 enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.

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.

Destructuring the Response

data DescribeDBSnapshotsResponse Source #

Contains the result of a successful invocation of the DescribeDBSnapshots action.

See: newDescribeDBSnapshotsResponse smart constructor.

Constructors

DescribeDBSnapshotsResponse'
Fields dbSnapshots :: Maybe [DBSnapshot] A list of `DBSnapshot` instances. marker :: Maybe Text An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeDBSnapshotsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBSnapshots Associated Types type Rep DescribeDBSnapshotsResponse :: Type -> Type # Methods from :: DescribeDBSnapshotsResponse -> Rep DescribeDBSnapshotsResponse x # to :: Rep DescribeDBSnapshotsResponse x -> DescribeDBSnapshotsResponse #
Read DescribeDBSnapshotsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBSnapshots Methods readsPrec :: Int -> ReadS DescribeDBSnapshotsResponse # readList :: ReadS [DescribeDBSnapshotsResponse] # readPrec :: ReadPrec DescribeDBSnapshotsResponse # readListPrec :: ReadPrec [DescribeDBSnapshotsResponse] #
Show DescribeDBSnapshotsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBSnapshots Methods showsPrec :: Int -> DescribeDBSnapshotsResponse -> ShowS # show :: DescribeDBSnapshotsResponse -> String # showList :: [DescribeDBSnapshotsResponse] -> ShowS #
NFData DescribeDBSnapshotsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBSnapshots Methods rnf :: DescribeDBSnapshotsResponse -> () #
Eq DescribeDBSnapshotsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBSnapshots Methods (==) :: DescribeDBSnapshotsResponse -> DescribeDBSnapshotsResponse -> Bool # (/=) :: DescribeDBSnapshotsResponse -> DescribeDBSnapshotsResponse -> Bool #
type Rep DescribeDBSnapshotsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBSnapshots type Rep DescribeDBSnapshotsResponse = D1 ('MetaData "DescribeDBSnapshotsResponse" "Amazonka.RDS.DescribeDBSnapshots" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeDBSnapshotsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbSnapshots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBSnapshot])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBSnapshotsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeDBSnapshotsResponse'`
-> DescribeDBSnapshotsResponse

Create a value of DescribeDBSnapshotsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dbSnapshots:DescribeDBSnapshotsResponse', describeDBSnapshotsResponse_dbSnapshots - A list of DBSnapshot instances.

DescribeDBSnapshots, describeDBSnapshotsResponse_marker - An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

$sel:httpStatus:DescribeDBSnapshotsResponse', describeDBSnapshotsResponse_httpStatus - The response's http status code.

Response Lenses

describeDBSnapshotsResponse_dbSnapshots :: Lens' DescribeDBSnapshotsResponse (Maybe [DBSnapshot]) Source #

A list of DBSnapshot instances.

describeDBSnapshotsResponse_marker :: Lens' DescribeDBSnapshotsResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBSnapshotsResponse_httpStatus :: Lens' DescribeDBSnapshotsResponse Int Source #

The response's http status code.