AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::ECS::Model::ListContainerInstancesRequest Class Reference

#include <ListContainerInstancesRequest.h>

+ Inheritance diagram for Aws::ECS::Model::ListContainerInstancesRequest:

Public Member Functions

 ListContainerInstancesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetCluster () const
 
bool ClusterHasBeenSet () const
 
void SetCluster (const Aws::String &value)
 
void SetCluster (Aws::String &&value)
 
void SetCluster (const char *value)
 
ListContainerInstancesRequestWithCluster (const Aws::String &value)
 
ListContainerInstancesRequestWithCluster (Aws::String &&value)
 
ListContainerInstancesRequestWithCluster (const char *value)
 
const Aws::StringGetFilter () const
 
bool FilterHasBeenSet () const
 
void SetFilter (const Aws::String &value)
 
void SetFilter (Aws::String &&value)
 
void SetFilter (const char *value)
 
ListContainerInstancesRequestWithFilter (const Aws::String &value)
 
ListContainerInstancesRequestWithFilter (Aws::String &&value)
 
ListContainerInstancesRequestWithFilter (const char *value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListContainerInstancesRequestWithNextToken (const Aws::String &value)
 
ListContainerInstancesRequestWithNextToken (Aws::String &&value)
 
ListContainerInstancesRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListContainerInstancesRequestWithMaxResults (int value)
 
const ContainerInstanceStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const ContainerInstanceStatus &value)
 
void SetStatus (ContainerInstanceStatus &&value)
 
ListContainerInstancesRequestWithStatus (const ContainerInstanceStatus &value)
 
ListContainerInstancesRequestWithStatus (ContainerInstanceStatus &&value)
 
- Public Member Functions inherited from Aws::ECS::ECSRequest
virtual ~ECSRequest ()
 
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
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file ListContainerInstancesRequest.h.

Constructor & Destructor Documentation

◆ ListContainerInstancesRequest()

Aws::ECS::Model::ListContainerInstancesRequest::ListContainerInstancesRequest ( )

Member Function Documentation

◆ ClusterHasBeenSet()

bool Aws::ECS::Model::ListContainerInstancesRequest::ClusterHasBeenSet ( ) const
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.

Definition at line 50 of file ListContainerInstancesRequest.h.

◆ FilterHasBeenSet()

bool Aws::ECS::Model::ListContainerInstancesRequest::FilterHasBeenSet ( ) const
inline

You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

Definition at line 111 of file ListContainerInstancesRequest.h.

◆ GetCluster()

const Aws::String& Aws::ECS::Model::ListContainerInstancesRequest::GetCluster ( ) const
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.

Definition at line 43 of file ListContainerInstancesRequest.h.

◆ GetFilter()

const Aws::String& Aws::ECS::Model::ListContainerInstancesRequest::GetFilter ( ) const
inline

You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

Definition at line 102 of file ListContainerInstancesRequest.h.

◆ GetMaxResults()

int Aws::ECS::Model::ListContainerInstancesRequest::GetMaxResults ( ) const
inline

The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.

Definition at line 268 of file ListContainerInstancesRequest.h.

◆ GetNextToken()

const Aws::String& Aws::ECS::Model::ListContainerInstancesRequest::GetNextToken ( ) const
inline

The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 177 of file ListContainerInstancesRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::ECS::Model::ListContainerInstancesRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::ECS::ECSRequest.

◆ GetServiceRequestName()

virtual const char* Aws::ECS::Model::ListContainerInstancesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file ListContainerInstancesRequest.h.

◆ GetStatus()

const ContainerInstanceStatus& Aws::ECS::Model::ListContainerInstancesRequest::GetStatus ( ) const
inline

Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you do not specify this parameter, the default is to include container instances set to all states other than INACTIVE.

Definition at line 318 of file ListContainerInstancesRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::ECS::Model::ListContainerInstancesRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.

Definition at line 281 of file ListContainerInstancesRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::ECS::Model::ListContainerInstancesRequest::NextTokenHasBeenSet ( ) const
inline

The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 188 of file ListContainerInstancesRequest.h.

◆ SerializePayload()

Aws::String Aws::ECS::Model::ListContainerInstancesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCluster() [1/3]

void Aws::ECS::Model::ListContainerInstancesRequest::SetCluster ( const Aws::String value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.

Definition at line 57 of file ListContainerInstancesRequest.h.

◆ SetCluster() [2/3]

void Aws::ECS::Model::ListContainerInstancesRequest::SetCluster ( Aws::String &&  value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.

Definition at line 64 of file ListContainerInstancesRequest.h.

◆ SetCluster() [3/3]

void Aws::ECS::Model::ListContainerInstancesRequest::SetCluster ( const char *  value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.

Definition at line 71 of file ListContainerInstancesRequest.h.

◆ SetFilter() [1/3]

void Aws::ECS::Model::ListContainerInstancesRequest::SetFilter ( const Aws::String value)
inline

You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

Definition at line 120 of file ListContainerInstancesRequest.h.

◆ SetFilter() [2/3]

void Aws::ECS::Model::ListContainerInstancesRequest::SetFilter ( Aws::String &&  value)
inline

You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

Definition at line 129 of file ListContainerInstancesRequest.h.

◆ SetFilter() [3/3]

void Aws::ECS::Model::ListContainerInstancesRequest::SetFilter ( const char *  value)
inline

You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

Definition at line 138 of file ListContainerInstancesRequest.h.

◆ SetMaxResults()

void Aws::ECS::Model::ListContainerInstancesRequest::SetMaxResults ( int  value)
inline

The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.

Definition at line 294 of file ListContainerInstancesRequest.h.

◆ SetNextToken() [1/3]

void Aws::ECS::Model::ListContainerInstancesRequest::SetNextToken ( const Aws::String value)
inline

The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 199 of file ListContainerInstancesRequest.h.

◆ SetNextToken() [2/3]

void Aws::ECS::Model::ListContainerInstancesRequest::SetNextToken ( Aws::String &&  value)
inline

The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 210 of file ListContainerInstancesRequest.h.

◆ SetNextToken() [3/3]

void Aws::ECS::Model::ListContainerInstancesRequest::SetNextToken ( const char *  value)
inline

The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 221 of file ListContainerInstancesRequest.h.

◆ SetStatus() [1/2]

void Aws::ECS::Model::ListContainerInstancesRequest::SetStatus ( const ContainerInstanceStatus value)
inline

Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you do not specify this parameter, the default is to include container instances set to all states other than INACTIVE.

Definition at line 338 of file ListContainerInstancesRequest.h.

◆ SetStatus() [2/2]

void Aws::ECS::Model::ListContainerInstancesRequest::SetStatus ( ContainerInstanceStatus &&  value)
inline

Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you do not specify this parameter, the default is to include container instances set to all states other than INACTIVE.

Definition at line 348 of file ListContainerInstancesRequest.h.

◆ StatusHasBeenSet()

bool Aws::ECS::Model::ListContainerInstancesRequest::StatusHasBeenSet ( ) const
inline

Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you do not specify this parameter, the default is to include container instances set to all states other than INACTIVE.

Definition at line 328 of file ListContainerInstancesRequest.h.

◆ WithCluster() [1/3]

ListContainerInstancesRequest& Aws::ECS::Model::ListContainerInstancesRequest::WithCluster ( const Aws::String value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.

Definition at line 78 of file ListContainerInstancesRequest.h.

◆ WithCluster() [2/3]

ListContainerInstancesRequest& Aws::ECS::Model::ListContainerInstancesRequest::WithCluster ( Aws::String &&  value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.

Definition at line 85 of file ListContainerInstancesRequest.h.

◆ WithCluster() [3/3]

ListContainerInstancesRequest& Aws::ECS::Model::ListContainerInstancesRequest::WithCluster ( const char *  value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.

Definition at line 92 of file ListContainerInstancesRequest.h.

◆ WithFilter() [1/3]

ListContainerInstancesRequest& Aws::ECS::Model::ListContainerInstancesRequest::WithFilter ( const Aws::String value)
inline

You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

Definition at line 147 of file ListContainerInstancesRequest.h.

◆ WithFilter() [2/3]

ListContainerInstancesRequest& Aws::ECS::Model::ListContainerInstancesRequest::WithFilter ( Aws::String &&  value)
inline

You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

Definition at line 156 of file ListContainerInstancesRequest.h.

◆ WithFilter() [3/3]

ListContainerInstancesRequest& Aws::ECS::Model::ListContainerInstancesRequest::WithFilter ( const char *  value)
inline

You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

Definition at line 165 of file ListContainerInstancesRequest.h.

◆ WithMaxResults()

ListContainerInstancesRequest& Aws::ECS::Model::ListContainerInstancesRequest::WithMaxResults ( int  value)
inline

The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.

Definition at line 307 of file ListContainerInstancesRequest.h.

◆ WithNextToken() [1/3]

ListContainerInstancesRequest& Aws::ECS::Model::ListContainerInstancesRequest::WithNextToken ( const Aws::String value)
inline

The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 232 of file ListContainerInstancesRequest.h.

◆ WithNextToken() [2/3]

ListContainerInstancesRequest& Aws::ECS::Model::ListContainerInstancesRequest::WithNextToken ( Aws::String &&  value)
inline

The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 243 of file ListContainerInstancesRequest.h.

◆ WithNextToken() [3/3]

ListContainerInstancesRequest& Aws::ECS::Model::ListContainerInstancesRequest::WithNextToken ( const char *  value)
inline

The nextToken value returned from a ListContainerInstances request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 254 of file ListContainerInstancesRequest.h.

◆ WithStatus() [1/2]

ListContainerInstancesRequest& Aws::ECS::Model::ListContainerInstancesRequest::WithStatus ( const ContainerInstanceStatus value)
inline

Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you do not specify this parameter, the default is to include container instances set to all states other than INACTIVE.

Definition at line 358 of file ListContainerInstancesRequest.h.

◆ WithStatus() [2/2]

ListContainerInstancesRequest& Aws::ECS::Model::ListContainerInstancesRequest::WithStatus ( ContainerInstanceStatus &&  value)
inline

Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you do not specify this parameter, the default is to include container instances set to all states other than INACTIVE.

Definition at line 368 of file ListContainerInstancesRequest.h.


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