GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::ElastiCache::DescribeSnapshots(3) User Contributed Perl Documentation Paws::ElastiCache::DescribeSnapshots(3)

Paws::ElastiCache::DescribeSnapshots - Arguments for method DescribeSnapshots on Paws::ElastiCache

This class represents the parameters used for calling the method DescribeSnapshots on the Amazon ElastiCache service. Use the attributes of this class as arguments to method DescribeSnapshots.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeSnapshots.

    my $elasticache = Paws->service('ElastiCache');
    # DescribeSnapshots
    # Returns information about the snapshot mysnapshot. By default.
    my $DescribeSnapshotsListMessage =
      $elasticache->DescribeSnapshots( 'SnapshotName' => 'snapshot-20161212' );
    # Results:
    my $Marker    = $DescribeSnapshotsListMessage->Marker;
    my $Snapshots = $DescribeSnapshotsListMessage->Snapshots;
    # Returns a L<Paws::ElastiCache::DescribeSnapshotsListMessage> object.

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/elasticache/DescribeSnapshots>

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords".

The maximum number of records to include in the response. If more records exist than the specified "MaxRecords" value, a marker is included in the response so that the remaining results can be retrieved.

Default: 50

Constraints: minimum 20; maximum 50.

A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.

A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.

If set to "system", the output shows snapshots that were automatically created by ElastiCache. If set to "user" the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

This class forms part of Paws, documenting arguments for method DescribeSnapshots in Paws::ElastiCache

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.