/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::RedShift::DescribeClusterSnapshots

NAME

Paws::RedShift::DescribeClusterSnapshots - Arguments for method DescribeClusterSnapshots on Paws::RedShift

DESCRIPTION

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

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

SYNOPSIS

my $redshift = Paws->service('RedShift');
my $SnapshotMessage = $redshift->DescribeClusterSnapshots(
  ClusterExists      => 1,                        # OPTIONAL
  ClusterIdentifier  => 'MyString',               # OPTIONAL
  EndTime            => '1970-01-01T01:00:00',    # OPTIONAL
  Marker             => 'MyString',               # OPTIONAL
  MaxRecords         => 1,                        # OPTIONAL
  OwnerAccount       => 'MyString',               # OPTIONAL
  SnapshotIdentifier => 'MyString',               # OPTIONAL
  SnapshotType       => 'MyString',               # OPTIONAL
  SortingEntities    => [
    {
      Attribute =>
        'SOURCE_TYPE',    # values: SOURCE_TYPE, TOTAL_SIZE, CREATE_TIME
      SortOrder => 'ASC', # values: ASC, DESC; OPTIONAL
    },
    ...
  ],    # OPTIONAL
  StartTime => '1970-01-01T01:00:00',    # OPTIONAL
  TagKeys   => [
    'MyString', ...                      # max: 2147483647
  ],    # OPTIONAL
  TagValues => [
    'MyString', ...    # max: 2147483647
  ],    # OPTIONAL
);

# Results:
my $Marker    = $SnapshotMessage->Marker;
my $Snapshots = $SnapshotMessage->Snapshots;

# Returns a L<Paws::RedShift::SnapshotMessage> 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/redshift/DescribeClusterSnapshots

ATTRIBUTES

ClusterExists => Bool

A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:

  • If ClusterExists is set to true, ClusterIdentifier is required.

  • If ClusterExists is set to false and ClusterIdentifier isn't specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.

  • If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.

  • If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.

ClusterIdentifier => Str

The identifier of the cluster which generated the requested snapshots.

EndTime => Str

A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. (http://en.wikipedia.org/wiki/ISO_8601)

Example: 2012-07-16T18:00:00Z

Marker => Str

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords => Int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

OwnerAccount => Str

The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter.

SnapshotIdentifier => Str

The snapshot identifier of the snapshot about which to return information.

SnapshotType => Str

The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.

Valid Values: automated | manual

SortingEntities => ArrayRef[Paws::RedShift::SnapshotSortingEntity]

StartTime => Str

A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page. (http://en.wikipedia.org/wiki/ISO_8601)

Example: 2012-07-16T18:00:00Z

TagKeys => ArrayRef[Str|Undef]

A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.

TagValues => ArrayRef[Str|Undef]

A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeClusterSnapshots in Paws::RedShift

BUGS and CONTRIBUTIONS

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