Struct aws_sdk_redshift::operation::describe_cluster_snapshots::DescribeClusterSnapshotsInput

#[non_exhaustive]
pub struct DescribeClusterSnapshotsInput {

    pub cluster_identifier: Option<String>,
    pub snapshot_identifier: Option<String>,
    pub snapshot_arn: Option<String>,
    pub snapshot_type: Option<String>,
    pub start_time: Option<DateTime>,
    pub end_time: Option<DateTime>,
    pub max_records: Option<i32>,
    pub marker: Option<String>,
    pub owner_account: Option<String>,
    pub tag_keys: Option<Vec<String>>,
    pub tag_values: Option<Vec<String>>,
    pub cluster_exists: Option<bool>,
    pub sorting_entities: Option<Vec<SnapshotSortingEntity>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

cluster_identifier: Option<String>

The identifier of the cluster which generated the requested snapshots.

snapshot_identifier: Option<String>

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

snapshot_arn: Option<String>

The Amazon Resource Name (ARN) of the snapshot associated with the message to describe cluster snapshots.

snapshot_type: Option<String>

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

Valid Values: automated | manual

start_time: Option<DateTime>

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

end_time: Option<DateTime>

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

max_records: Option<i32>

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.

marker: Option<String>

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.

owner_account: Option<String>

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.

tag_keys: Option<Vec<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.

tag_values: Option<Vec<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.

cluster_exists: Option<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.

sorting_entities: Option<Vec<SnapshotSortingEntity>>

Implementations

impl DescribeClusterSnapshotsInput

pub fn cluster_identifier(&self) -> Option<&str>

The identifier of the cluster which generated the requested snapshots.

pub fn snapshot_identifier(&self) -> Option<&str>

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

pub fn snapshot_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the snapshot associated with the message to describe cluster snapshots.

pub fn snapshot_type(&self) -> Option<&str>

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

Valid Values: automated | manual

pub fn start_time(&self) -> Option<&DateTime>

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

pub fn end_time(&self) -> Option<&DateTime>

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

pub fn max_records(&self) -> Option<i32>

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.

pub fn marker(&self) -> Option<&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, 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.

pub fn owner_account(&self) -> Option<&str>

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.

pub fn tag_keys(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tag_keys.is_none().

pub fn tag_values(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tag_values.is_none().

pub fn cluster_exists(&self) -> Option<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.

pub fn sorting_entities(&self) -> &[SnapshotSortingEntity]

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .sorting_entities.is_none().

impl DescribeClusterSnapshotsInput

pub fn builder() -> DescribeClusterSnapshotsInputBuilder

Creates a new builder-style object to manufacture DescribeClusterSnapshotsInput.

Trait Implementations

impl Clone for DescribeClusterSnapshotsInput

fn clone(&self) -> DescribeClusterSnapshotsInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeClusterSnapshotsInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for DescribeClusterSnapshotsInput

fn eq(&self, other: &DescribeClusterSnapshotsInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DescribeClusterSnapshotsInput