class Aws::Redshift::Types::DescribeClusterSnapshotsMessage

@note When making an API call, you may pass DescribeClusterSnapshotsMessage

data as a hash:

    {
      cluster_identifier: "String",
      snapshot_identifier: "String",
      snapshot_type: "String",
      start_time: Time.now,
      end_time: Time.now,
      max_records: 1,
      marker: "String",
      owner_account: "String",
      tag_keys: ["String"],
      tag_values: ["String"],
      cluster_exists: false,
      sorting_entities: [
        {
          attribute: "SOURCE_TYPE", # required, accepts SOURCE_TYPE, TOTAL_SIZE, CREATE_TIME
          sort_order: "ASC", # accepts ASC, DESC
        },
      ],
    }

@!attribute [rw] cluster_identifier

The identifier of the cluster which generated the requested
snapshots.
@return [String]

@!attribute [rw] snapshot_identifier

The snapshot identifier of the snapshot about which to return
information.
@return [String]

@!attribute [rw] snapshot_type

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

Valid Values: `automated` \| `manual`
@return [String]

@!attribute [rw] start_time

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.][1]

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

[1]: http://en.wikipedia.org/wiki/ISO_8601
@return [Time]

@!attribute [rw] end_time

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.][1]

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

[1]: http://en.wikipedia.org/wiki/ISO_8601
@return [Time]

@!attribute [rw] max_records

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.
@return [Integer]

@!attribute [rw] marker

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`, Amazon Web Services 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.
@return [String]

@!attribute [rw] owner_account

The Amazon Web Services 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 Amazon Web Services account, or do not specify the parameter.
@return [String]

@!attribute [rw] tag_keys

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.
@return [Array<String>]

@!attribute [rw] tag_values

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.
@return [Array<String>]

@!attribute [rw] cluster_exists

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.
@return [Boolean]

@!attribute [rw] sorting_entities

@return [Array<Types::SnapshotSortingEntity>]

@see docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/DescribeClusterSnapshotsMessage AWS API Documentation

Constants

SENSITIVE