![]() |
![]()
| ![]() |
![]()
NAMEPaws::RDS::DescribeDBSnapshots - Arguments for method DescribeDBSnapshots on Paws::RDS DESCRIPTIONThis class represents the parameters used for calling the method DescribeDBSnapshots on the Amazon Relational Database Service service. Use the attributes of this class as arguments to method DescribeDBSnapshots. You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDBSnapshots. SYNOPSISmy $rds = Paws->service('RDS'); # To list DB snapshot attributes # This example lists all manually-created, shared snapshots for the specified DB # instance. my $DBSnapshotMessage = $rds->DescribeDBSnapshots( 'DBInstanceIdentifier' => 'mymysqlinstance', 'IncludePublic' => 0, 'IncludeShared' => 1, 'SnapshotType' => 'manual' ); Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeDBSnapshots> ATTRIBUTESDBInstanceIdentifier => StrThe 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 isn't case-sensitive. Constraints:
DbiResourceId => StrA specific DB resource ID to describe. DBSnapshotIdentifier => StrA specific DB snapshot identifier to describe. This parameter can't be used in conjunction with "DBInstanceIdentifier". This value is stored as a lowercase string. Constraints:
Filters => ArrayRef[Paws::RDS::Filter]A filter that specifies one or more DB snapshots to describe. Supported filters:
IncludePublic => BoolA 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. IncludeShared => BoolA 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. Marker => StrAn 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 => IntThe 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 => StrThe type of snapshots to be returned. You can specify one of the following values:
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". SEE ALSOThis class forms part of Paws, documenting arguments for method DescribeDBSnapshots in Paws::RDS BUGS and CONTRIBUTIONSThe source code is located here: <https://github.com/pplu/aws-sdk-perl> Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>
|