You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Redshift::Types::DescribeClusterSnapshotsMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb

Overview

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"],
}

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_identifierString

The identifier of the cluster for which information about snapshots is requested.

Returns:

  • (String)


2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 2592

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_type,
  :start_time,
  :end_time,
  :max_records,
  :marker,
  :owner_account,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end

#end_timeTime

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.

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

Returns:

  • (Time)


2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 2592

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_type,
  :start_time,
  :end_time,
  :max_records,
  :marker,
  :owner_account,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end

#markerString

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.

Returns:

  • (String)


2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 2592

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_type,
  :start_time,
  :end_time,
  :max_records,
  :marker,
  :owner_account,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end

#max_recordsInteger

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.

Returns:

  • (Integer)


2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 2592

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_type,
  :start_time,
  :end_time,
  :max_records,
  :marker,
  :owner_account,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end

#owner_accountString

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.

Returns:

  • (String)


2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 2592

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_type,
  :start_time,
  :end_time,
  :max_records,
  :marker,
  :owner_account,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end

#snapshot_identifierString

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

Returns:

  • (String)


2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 2592

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_type,
  :start_time,
  :end_time,
  :max_records,
  :marker,
  :owner_account,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end

#snapshot_typeString

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

Valid Values: automated | manual

Returns:

  • (String)


2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 2592

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_type,
  :start_time,
  :end_time,
  :max_records,
  :marker,
  :owner_account,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end

#start_timeTime

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.

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

Returns:

  • (Time)


2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 2592

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_type,
  :start_time,
  :end_time,
  :max_records,
  :marker,
  :owner_account,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end

#tag_keysArray<String>

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.

Returns:

  • (Array<String>)


2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 2592

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_type,
  :start_time,
  :end_time,
  :max_records,
  :marker,
  :owner_account,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end

#tag_valuesArray<String>

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.

Returns:

  • (Array<String>)


2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 2592

class DescribeClusterSnapshotsMessage < Struct.new(
  :cluster_identifier,
  :snapshot_identifier,
  :snapshot_type,
  :start_time,
  :end_time,
  :max_records,
  :marker,
  :owner_account,
  :tag_keys,
  :tag_values)
  include Aws::Structure
end