AWS SDK for C++  1.8.60
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::Redshift::Model::DescribeClusterSnapshotsRequest Class Reference

#include <DescribeClusterSnapshotsRequest.h>

+ Inheritance diagram for Aws::Redshift::Model::DescribeClusterSnapshotsRequest:

Public Member Functions

 DescribeClusterSnapshotsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetClusterIdentifier () const
 
bool ClusterIdentifierHasBeenSet () const
 
void SetClusterIdentifier (const Aws::String &value)
 
void SetClusterIdentifier (Aws::String &&value)
 
void SetClusterIdentifier (const char *value)
 
DescribeClusterSnapshotsRequestWithClusterIdentifier (const Aws::String &value)
 
DescribeClusterSnapshotsRequestWithClusterIdentifier (Aws::String &&value)
 
DescribeClusterSnapshotsRequestWithClusterIdentifier (const char *value)
 
const Aws::StringGetSnapshotIdentifier () const
 
bool SnapshotIdentifierHasBeenSet () const
 
void SetSnapshotIdentifier (const Aws::String &value)
 
void SetSnapshotIdentifier (Aws::String &&value)
 
void SetSnapshotIdentifier (const char *value)
 
DescribeClusterSnapshotsRequestWithSnapshotIdentifier (const Aws::String &value)
 
DescribeClusterSnapshotsRequestWithSnapshotIdentifier (Aws::String &&value)
 
DescribeClusterSnapshotsRequestWithSnapshotIdentifier (const char *value)
 
const Aws::StringGetSnapshotType () const
 
bool SnapshotTypeHasBeenSet () const
 
void SetSnapshotType (const Aws::String &value)
 
void SetSnapshotType (Aws::String &&value)
 
void SetSnapshotType (const char *value)
 
DescribeClusterSnapshotsRequestWithSnapshotType (const Aws::String &value)
 
DescribeClusterSnapshotsRequestWithSnapshotType (Aws::String &&value)
 
DescribeClusterSnapshotsRequestWithSnapshotType (const char *value)
 
const Aws::Utils::DateTimeGetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (const Aws::Utils::DateTime &value)
 
void SetStartTime (Aws::Utils::DateTime &&value)
 
DescribeClusterSnapshotsRequestWithStartTime (const Aws::Utils::DateTime &value)
 
DescribeClusterSnapshotsRequestWithStartTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetEndTime () const
 
bool EndTimeHasBeenSet () const
 
void SetEndTime (const Aws::Utils::DateTime &value)
 
void SetEndTime (Aws::Utils::DateTime &&value)
 
DescribeClusterSnapshotsRequestWithEndTime (const Aws::Utils::DateTime &value)
 
DescribeClusterSnapshotsRequestWithEndTime (Aws::Utils::DateTime &&value)
 
int GetMaxRecords () const
 
bool MaxRecordsHasBeenSet () const
 
void SetMaxRecords (int value)
 
DescribeClusterSnapshotsRequestWithMaxRecords (int value)
 
const Aws::StringGetMarker () const
 
bool MarkerHasBeenSet () const
 
void SetMarker (const Aws::String &value)
 
void SetMarker (Aws::String &&value)
 
void SetMarker (const char *value)
 
DescribeClusterSnapshotsRequestWithMarker (const Aws::String &value)
 
DescribeClusterSnapshotsRequestWithMarker (Aws::String &&value)
 
DescribeClusterSnapshotsRequestWithMarker (const char *value)
 
const Aws::StringGetOwnerAccount () const
 
bool OwnerAccountHasBeenSet () const
 
void SetOwnerAccount (const Aws::String &value)
 
void SetOwnerAccount (Aws::String &&value)
 
void SetOwnerAccount (const char *value)
 
DescribeClusterSnapshotsRequestWithOwnerAccount (const Aws::String &value)
 
DescribeClusterSnapshotsRequestWithOwnerAccount (Aws::String &&value)
 
DescribeClusterSnapshotsRequestWithOwnerAccount (const char *value)
 
const Aws::Vector< Aws::String > & GetTagKeys () const
 
bool TagKeysHasBeenSet () const
 
void SetTagKeys (const Aws::Vector< Aws::String > &value)
 
void SetTagKeys (Aws::Vector< Aws::String > &&value)
 
DescribeClusterSnapshotsRequestWithTagKeys (const Aws::Vector< Aws::String > &value)
 
DescribeClusterSnapshotsRequestWithTagKeys (Aws::Vector< Aws::String > &&value)
 
DescribeClusterSnapshotsRequestAddTagKeys (const Aws::String &value)
 
DescribeClusterSnapshotsRequestAddTagKeys (Aws::String &&value)
 
DescribeClusterSnapshotsRequestAddTagKeys (const char *value)
 
const Aws::Vector< Aws::String > & GetTagValues () const
 
bool TagValuesHasBeenSet () const
 
void SetTagValues (const Aws::Vector< Aws::String > &value)
 
void SetTagValues (Aws::Vector< Aws::String > &&value)
 
DescribeClusterSnapshotsRequestWithTagValues (const Aws::Vector< Aws::String > &value)
 
DescribeClusterSnapshotsRequestWithTagValues (Aws::Vector< Aws::String > &&value)
 
DescribeClusterSnapshotsRequestAddTagValues (const Aws::String &value)
 
DescribeClusterSnapshotsRequestAddTagValues (Aws::String &&value)
 
DescribeClusterSnapshotsRequestAddTagValues (const char *value)
 
bool GetClusterExists () const
 
bool ClusterExistsHasBeenSet () const
 
void SetClusterExists (bool value)
 
DescribeClusterSnapshotsRequestWithClusterExists (bool value)
 
const Aws::Vector< SnapshotSortingEntity > & GetSortingEntities () const
 
bool SortingEntitiesHasBeenSet () const
 
void SetSortingEntities (const Aws::Vector< SnapshotSortingEntity > &value)
 
void SetSortingEntities (Aws::Vector< SnapshotSortingEntity > &&value)
 
DescribeClusterSnapshotsRequestWithSortingEntities (const Aws::Vector< SnapshotSortingEntity > &value)
 
DescribeClusterSnapshotsRequestWithSortingEntities (Aws::Vector< SnapshotSortingEntity > &&value)
 
DescribeClusterSnapshotsRequestAddSortingEntities (const SnapshotSortingEntity &value)
 
DescribeClusterSnapshotsRequestAddSortingEntities (SnapshotSortingEntity &&value)
 
- Public Member Functions inherited from Aws::Redshift::RedshiftRequest
virtual ~RedshiftRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::Redshift::RedshiftRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

See Also:

AWS API Reference

Definition at line 27 of file DescribeClusterSnapshotsRequest.h.

Constructor & Destructor Documentation

◆ DescribeClusterSnapshotsRequest()

Aws::Redshift::Model::DescribeClusterSnapshotsRequest::DescribeClusterSnapshotsRequest ( )

Member Function Documentation

◆ AddSortingEntities() [1/2]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::AddSortingEntities ( const SnapshotSortingEntity value)
inline

Definition at line 765 of file DescribeClusterSnapshotsRequest.h.

◆ AddSortingEntities() [2/2]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::AddSortingEntities ( SnapshotSortingEntity &&  value)
inline

Definition at line 770 of file DescribeClusterSnapshotsRequest.h.

◆ AddTagKeys() [1/3]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::AddTagKeys ( const Aws::String value)
inline

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.

Definition at line 545 of file DescribeClusterSnapshotsRequest.h.

◆ AddTagKeys() [2/3]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::AddTagKeys ( Aws::String &&  value)
inline

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.

Definition at line 555 of file DescribeClusterSnapshotsRequest.h.

◆ AddTagKeys() [3/3]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::AddTagKeys ( const char *  value)
inline

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.

Definition at line 565 of file DescribeClusterSnapshotsRequest.h.

◆ AddTagValues() [1/3]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::AddTagValues ( const Aws::String value)
inline

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.

Definition at line 636 of file DescribeClusterSnapshotsRequest.h.

◆ AddTagValues() [2/3]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::AddTagValues ( Aws::String &&  value)
inline

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.

Definition at line 646 of file DescribeClusterSnapshotsRequest.h.

◆ AddTagValues() [3/3]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::AddTagValues ( const char *  value)
inline

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.

Definition at line 656 of file DescribeClusterSnapshotsRequest.h.

◆ ClusterExistsHasBeenSet()

bool Aws::Redshift::Model::DescribeClusterSnapshotsRequest::ClusterExistsHasBeenSet ( ) const
inline

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.

Definition at line 693 of file DescribeClusterSnapshotsRequest.h.

◆ ClusterIdentifierHasBeenSet()

bool Aws::Redshift::Model::DescribeClusterSnapshotsRequest::ClusterIdentifierHasBeenSet ( ) const
inline

The identifier of the cluster which generated the requested snapshots.

Definition at line 53 of file DescribeClusterSnapshotsRequest.h.

◆ DumpBodyToUrl()

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ EndTimeHasBeenSet()

bool Aws::Redshift::Model::DescribeClusterSnapshotsRequest::EndTimeHasBeenSet ( ) const
inline

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

Definition at line 255 of file DescribeClusterSnapshotsRequest.h.

◆ GetClusterExists()

bool Aws::Redshift::Model::DescribeClusterSnapshotsRequest::GetClusterExists ( ) const
inline

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.

Definition at line 675 of file DescribeClusterSnapshotsRequest.h.

◆ GetClusterIdentifier()

const Aws::String& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::GetClusterIdentifier ( ) const
inline

The identifier of the cluster which generated the requested snapshots.

Definition at line 48 of file DescribeClusterSnapshotsRequest.h.

◆ GetEndTime()

const Aws::Utils::DateTime& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::GetEndTime ( ) const
inline

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

Definition at line 247 of file DescribeClusterSnapshotsRequest.h.

◆ GetMarker()

const Aws::String& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::GetMarker ( ) const
inline

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.

Definition at line 339 of file DescribeClusterSnapshotsRequest.h.

◆ GetMaxRecords()

int Aws::Redshift::Model::DescribeClusterSnapshotsRequest::GetMaxRecords ( ) const
inline

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.

Definition at line 298 of file DescribeClusterSnapshotsRequest.h.

◆ GetOwnerAccount()

const Aws::String& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::GetOwnerAccount ( ) const
inline

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.

Definition at line 418 of file DescribeClusterSnapshotsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Redshift::Model::DescribeClusterSnapshotsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file DescribeClusterSnapshotsRequest.h.

◆ GetSnapshotIdentifier()

const Aws::String& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::GetSnapshotIdentifier ( ) const
inline

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

Definition at line 90 of file DescribeClusterSnapshotsRequest.h.

◆ GetSnapshotType()

const Aws::String& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::GetSnapshotType ( ) const
inline

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

Valid Values: automated | manual

Definition at line 140 of file DescribeClusterSnapshotsRequest.h.

◆ GetSortingEntities()

const Aws::Vector<SnapshotSortingEntity>& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::GetSortingEntities ( ) const
inline

Definition at line 735 of file DescribeClusterSnapshotsRequest.h.

◆ GetStartTime()

const Aws::Utils::DateTime& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::GetStartTime ( ) const
inline

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

Definition at line 198 of file DescribeClusterSnapshotsRequest.h.

◆ GetTagKeys()

const Aws::Vector<Aws::String>& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::GetTagKeys ( ) const
inline

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.

Definition at line 485 of file DescribeClusterSnapshotsRequest.h.

◆ GetTagValues()

const Aws::Vector<Aws::String>& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::GetTagValues ( ) const
inline

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.

Definition at line 576 of file DescribeClusterSnapshotsRequest.h.

◆ MarkerHasBeenSet()

bool Aws::Redshift::Model::DescribeClusterSnapshotsRequest::MarkerHasBeenSet ( ) const
inline

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.

Definition at line 349 of file DescribeClusterSnapshotsRequest.h.

◆ MaxRecordsHasBeenSet()

bool Aws::Redshift::Model::DescribeClusterSnapshotsRequest::MaxRecordsHasBeenSet ( ) const
inline

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.

Definition at line 308 of file DescribeClusterSnapshotsRequest.h.

◆ OwnerAccountHasBeenSet()

bool Aws::Redshift::Model::DescribeClusterSnapshotsRequest::OwnerAccountHasBeenSet ( ) const
inline

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.

Definition at line 426 of file DescribeClusterSnapshotsRequest.h.

◆ SerializePayload()

Aws::String Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClusterExists()

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetClusterExists ( bool  value)
inline

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.

Definition at line 711 of file DescribeClusterSnapshotsRequest.h.

◆ SetClusterIdentifier() [1/3]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetClusterIdentifier ( const Aws::String value)
inline

The identifier of the cluster which generated the requested snapshots.

Definition at line 58 of file DescribeClusterSnapshotsRequest.h.

◆ SetClusterIdentifier() [2/3]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetClusterIdentifier ( Aws::String &&  value)
inline

The identifier of the cluster which generated the requested snapshots.

Definition at line 63 of file DescribeClusterSnapshotsRequest.h.

◆ SetClusterIdentifier() [3/3]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetClusterIdentifier ( const char *  value)
inline

The identifier of the cluster which generated the requested snapshots.

Definition at line 68 of file DescribeClusterSnapshotsRequest.h.

◆ SetEndTime() [1/2]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetEndTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 263 of file DescribeClusterSnapshotsRequest.h.

◆ SetEndTime() [2/2]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetEndTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 271 of file DescribeClusterSnapshotsRequest.h.

◆ SetMarker() [1/3]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetMarker ( const Aws::String value)
inline

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.

Definition at line 359 of file DescribeClusterSnapshotsRequest.h.

◆ SetMarker() [2/3]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetMarker ( Aws::String &&  value)
inline

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.

Definition at line 369 of file DescribeClusterSnapshotsRequest.h.

◆ SetMarker() [3/3]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetMarker ( const char *  value)
inline

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.

Definition at line 379 of file DescribeClusterSnapshotsRequest.h.

◆ SetMaxRecords()

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetMaxRecords ( int  value)
inline

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.

Definition at line 318 of file DescribeClusterSnapshotsRequest.h.

◆ SetOwnerAccount() [1/3]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetOwnerAccount ( const Aws::String value)
inline

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.

Definition at line 434 of file DescribeClusterSnapshotsRequest.h.

◆ SetOwnerAccount() [2/3]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetOwnerAccount ( Aws::String &&  value)
inline

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.

Definition at line 442 of file DescribeClusterSnapshotsRequest.h.

◆ SetOwnerAccount() [3/3]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetOwnerAccount ( const char *  value)
inline

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.

Definition at line 450 of file DescribeClusterSnapshotsRequest.h.

◆ SetSnapshotIdentifier() [1/3]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetSnapshotIdentifier ( const Aws::String value)
inline

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

Definition at line 102 of file DescribeClusterSnapshotsRequest.h.

◆ SetSnapshotIdentifier() [2/3]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetSnapshotIdentifier ( Aws::String &&  value)
inline

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

Definition at line 108 of file DescribeClusterSnapshotsRequest.h.

◆ SetSnapshotIdentifier() [3/3]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetSnapshotIdentifier ( const char *  value)
inline

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

Definition at line 114 of file DescribeClusterSnapshotsRequest.h.

◆ SetSnapshotType() [1/3]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetSnapshotType ( const Aws::String value)
inline

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

Valid Values: automated | manual

Definition at line 154 of file DescribeClusterSnapshotsRequest.h.

◆ SetSnapshotType() [2/3]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetSnapshotType ( Aws::String &&  value)
inline

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

Valid Values: automated | manual

Definition at line 161 of file DescribeClusterSnapshotsRequest.h.

◆ SetSnapshotType() [3/3]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetSnapshotType ( const char *  value)
inline

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

Valid Values: automated | manual

Definition at line 168 of file DescribeClusterSnapshotsRequest.h.

◆ SetSortingEntities() [1/2]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetSortingEntities ( const Aws::Vector< SnapshotSortingEntity > &  value)
inline

Definition at line 745 of file DescribeClusterSnapshotsRequest.h.

◆ SetSortingEntities() [2/2]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetSortingEntities ( Aws::Vector< SnapshotSortingEntity > &&  value)
inline

Definition at line 750 of file DescribeClusterSnapshotsRequest.h.

◆ SetStartTime() [1/2]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetStartTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 214 of file DescribeClusterSnapshotsRequest.h.

◆ SetStartTime() [2/2]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetStartTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 222 of file DescribeClusterSnapshotsRequest.h.

◆ SetTagKeys() [1/2]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetTagKeys ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 505 of file DescribeClusterSnapshotsRequest.h.

◆ SetTagKeys() [2/2]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetTagKeys ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 515 of file DescribeClusterSnapshotsRequest.h.

◆ SetTagValues() [1/2]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetTagValues ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 596 of file DescribeClusterSnapshotsRequest.h.

◆ SetTagValues() [2/2]

void Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SetTagValues ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 606 of file DescribeClusterSnapshotsRequest.h.

◆ SnapshotIdentifierHasBeenSet()

bool Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SnapshotIdentifierHasBeenSet ( ) const
inline

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

Definition at line 96 of file DescribeClusterSnapshotsRequest.h.

◆ SnapshotTypeHasBeenSet()

bool Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SnapshotTypeHasBeenSet ( ) const
inline

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

Valid Values: automated | manual

Definition at line 147 of file DescribeClusterSnapshotsRequest.h.

◆ SortingEntitiesHasBeenSet()

bool Aws::Redshift::Model::DescribeClusterSnapshotsRequest::SortingEntitiesHasBeenSet ( ) const
inline

Definition at line 740 of file DescribeClusterSnapshotsRequest.h.

◆ StartTimeHasBeenSet()

bool Aws::Redshift::Model::DescribeClusterSnapshotsRequest::StartTimeHasBeenSet ( ) const
inline

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

Definition at line 206 of file DescribeClusterSnapshotsRequest.h.

◆ TagKeysHasBeenSet()

bool Aws::Redshift::Model::DescribeClusterSnapshotsRequest::TagKeysHasBeenSet ( ) const
inline

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.

Definition at line 495 of file DescribeClusterSnapshotsRequest.h.

◆ TagValuesHasBeenSet()

bool Aws::Redshift::Model::DescribeClusterSnapshotsRequest::TagValuesHasBeenSet ( ) const
inline

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.

Definition at line 586 of file DescribeClusterSnapshotsRequest.h.

◆ WithClusterExists()

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithClusterExists ( bool  value)
inline

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.

Definition at line 729 of file DescribeClusterSnapshotsRequest.h.

◆ WithClusterIdentifier() [1/3]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithClusterIdentifier ( const Aws::String value)
inline

The identifier of the cluster which generated the requested snapshots.

Definition at line 73 of file DescribeClusterSnapshotsRequest.h.

◆ WithClusterIdentifier() [2/3]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithClusterIdentifier ( Aws::String &&  value)
inline

The identifier of the cluster which generated the requested snapshots.

Definition at line 78 of file DescribeClusterSnapshotsRequest.h.

◆ WithClusterIdentifier() [3/3]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithClusterIdentifier ( const char *  value)
inline

The identifier of the cluster which generated the requested snapshots.

Definition at line 83 of file DescribeClusterSnapshotsRequest.h.

◆ WithEndTime() [1/2]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithEndTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 279 of file DescribeClusterSnapshotsRequest.h.

◆ WithEndTime() [2/2]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithEndTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 287 of file DescribeClusterSnapshotsRequest.h.

◆ WithMarker() [1/3]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithMarker ( const Aws::String value)
inline

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.

Definition at line 389 of file DescribeClusterSnapshotsRequest.h.

◆ WithMarker() [2/3]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithMarker ( Aws::String &&  value)
inline

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.

Definition at line 399 of file DescribeClusterSnapshotsRequest.h.

◆ WithMarker() [3/3]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithMarker ( const char *  value)
inline

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.

Definition at line 409 of file DescribeClusterSnapshotsRequest.h.

◆ WithMaxRecords()

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithMaxRecords ( int  value)
inline

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.

Definition at line 328 of file DescribeClusterSnapshotsRequest.h.

◆ WithOwnerAccount() [1/3]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithOwnerAccount ( const Aws::String value)
inline

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.

Definition at line 458 of file DescribeClusterSnapshotsRequest.h.

◆ WithOwnerAccount() [2/3]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithOwnerAccount ( Aws::String &&  value)
inline

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.

Definition at line 466 of file DescribeClusterSnapshotsRequest.h.

◆ WithOwnerAccount() [3/3]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithOwnerAccount ( const char *  value)
inline

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.

Definition at line 474 of file DescribeClusterSnapshotsRequest.h.

◆ WithSnapshotIdentifier() [1/3]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithSnapshotIdentifier ( const Aws::String value)
inline

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

Definition at line 120 of file DescribeClusterSnapshotsRequest.h.

◆ WithSnapshotIdentifier() [2/3]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithSnapshotIdentifier ( Aws::String &&  value)
inline

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

Definition at line 126 of file DescribeClusterSnapshotsRequest.h.

◆ WithSnapshotIdentifier() [3/3]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithSnapshotIdentifier ( const char *  value)
inline

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

Definition at line 132 of file DescribeClusterSnapshotsRequest.h.

◆ WithSnapshotType() [1/3]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithSnapshotType ( const Aws::String value)
inline

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

Valid Values: automated | manual

Definition at line 175 of file DescribeClusterSnapshotsRequest.h.

◆ WithSnapshotType() [2/3]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithSnapshotType ( Aws::String &&  value)
inline

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

Valid Values: automated | manual

Definition at line 182 of file DescribeClusterSnapshotsRequest.h.

◆ WithSnapshotType() [3/3]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithSnapshotType ( const char *  value)
inline

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

Valid Values: automated | manual

Definition at line 189 of file DescribeClusterSnapshotsRequest.h.

◆ WithSortingEntities() [1/2]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithSortingEntities ( const Aws::Vector< SnapshotSortingEntity > &  value)
inline

Definition at line 755 of file DescribeClusterSnapshotsRequest.h.

◆ WithSortingEntities() [2/2]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithSortingEntities ( Aws::Vector< SnapshotSortingEntity > &&  value)
inline

Definition at line 760 of file DescribeClusterSnapshotsRequest.h.

◆ WithStartTime() [1/2]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithStartTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 230 of file DescribeClusterSnapshotsRequest.h.

◆ WithStartTime() [2/2]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithStartTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 238 of file DescribeClusterSnapshotsRequest.h.

◆ WithTagKeys() [1/2]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithTagKeys ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 525 of file DescribeClusterSnapshotsRequest.h.

◆ WithTagKeys() [2/2]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithTagKeys ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 535 of file DescribeClusterSnapshotsRequest.h.

◆ WithTagValues() [1/2]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithTagValues ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 616 of file DescribeClusterSnapshotsRequest.h.

◆ WithTagValues() [2/2]

DescribeClusterSnapshotsRequest& Aws::Redshift::Model::DescribeClusterSnapshotsRequest::WithTagValues ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 626 of file DescribeClusterSnapshotsRequest.h.


The documentation for this class was generated from the following file: