Aws::ECS::Model::ListTasksRequest Class Reference

#include <ListTasksRequest.h>

Inheritance diagram for Aws::ECS::Model::ListTasksRequest:

Public Member Functions
	ListTasksRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override
const Aws::String &	GetCluster () const
bool	ClusterHasBeenSet () const
void	SetCluster (const Aws::String &value)
void	SetCluster (Aws::String &&value)
void	SetCluster (const char *value)
ListTasksRequest &	WithCluster (const Aws::String &value)
ListTasksRequest &	WithCluster (Aws::String &&value)
ListTasksRequest &	WithCluster (const char *value)
const Aws::String &	GetContainerInstance () const
bool	ContainerInstanceHasBeenSet () const
void	SetContainerInstance (const Aws::String &value)
void	SetContainerInstance (Aws::String &&value)
void	SetContainerInstance (const char *value)
ListTasksRequest &	WithContainerInstance (const Aws::String &value)
ListTasksRequest &	WithContainerInstance (Aws::String &&value)
ListTasksRequest &	WithContainerInstance (const char *value)
const Aws::String &	GetFamily () const
bool	FamilyHasBeenSet () const
void	SetFamily (const Aws::String &value)
void	SetFamily (Aws::String &&value)
void	SetFamily (const char *value)
ListTasksRequest &	WithFamily (const Aws::String &value)
ListTasksRequest &	WithFamily (Aws::String &&value)
ListTasksRequest &	WithFamily (const char *value)
const Aws::String &	GetNextToken () const
bool	NextTokenHasBeenSet () const
void	SetNextToken (const Aws::String &value)
void	SetNextToken (Aws::String &&value)
void	SetNextToken (const char *value)
ListTasksRequest &	WithNextToken (const Aws::String &value)
ListTasksRequest &	WithNextToken (Aws::String &&value)
ListTasksRequest &	WithNextToken (const char *value)
int	GetMaxResults () const
bool	MaxResultsHasBeenSet () const
void	SetMaxResults (int value)
ListTasksRequest &	WithMaxResults (int value)
const Aws::String &	GetStartedBy () const
bool	StartedByHasBeenSet () const
void	SetStartedBy (const Aws::String &value)
void	SetStartedBy (Aws::String &&value)
void	SetStartedBy (const char *value)
ListTasksRequest &	WithStartedBy (const Aws::String &value)
ListTasksRequest &	WithStartedBy (Aws::String &&value)
ListTasksRequest &	WithStartedBy (const char *value)
const Aws::String &	GetServiceName () const
bool	ServiceNameHasBeenSet () const
void	SetServiceName (const Aws::String &value)
void	SetServiceName (Aws::String &&value)
void	SetServiceName (const char *value)
ListTasksRequest &	WithServiceName (const Aws::String &value)
ListTasksRequest &	WithServiceName (Aws::String &&value)
ListTasksRequest &	WithServiceName (const char *value)
const DesiredStatus &	GetDesiredStatus () const
bool	DesiredStatusHasBeenSet () const
void	SetDesiredStatus (const DesiredStatus &value)
void	SetDesiredStatus (DesiredStatus &&value)
ListTasksRequest &	WithDesiredStatus (const DesiredStatus &value)
ListTasksRequest &	WithDesiredStatus (DesiredStatus &&value)
const LaunchType &	GetLaunchType () const
bool	LaunchTypeHasBeenSet () const
void	SetLaunchType (const LaunchType &value)
void	SetLaunchType (LaunchType &&value)
ListTasksRequest &	WithLaunchType (const LaunchType &value)
ListTasksRequest &	WithLaunchType (LaunchType &&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::IOStream >	GetBody () 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 RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () 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::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () 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 23 of file ListTasksRequest.h.

Constructor & Destructor Documentation

ListTasksRequest()

Aws::ECS::Model::ListTasksRequest::ListTasksRequest

(

)

Member Function Documentation

ClusterHasBeenSet()

bool Aws::ECS::Model::ListTasksRequest::ClusterHasBeenSet ( ) const

inline

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListTasks results. If you do not specify a cluster, the default cluster is assumed.

Definition at line 51 of file ListTasksRequest.h.

ContainerInstanceHasBeenSet()

bool Aws::ECS::Model::ListTasksRequest::ContainerInstanceHasBeenSet ( ) const

inline

The container instance ID or full ARN of the container instance to use when filtering the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

Definition at line 110 of file ListTasksRequest.h.

DesiredStatusHasBeenSet()

bool Aws::ECS::Model::ListTasksRequest::DesiredStatusHasBeenSet ( ) const

inline

The task desired status to use when filtering the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this does not return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

Definition at line 498 of file ListTasksRequest.h.

FamilyHasBeenSet()

bool Aws::ECS::Model::ListTasksRequest::FamilyHasBeenSet ( ) const

inline

The name of the task definition family to use when filtering the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

Definition at line 173 of file ListTasksRequest.h.

GetCluster()

const Aws::String& Aws::ECS::Model::ListTasksRequest::GetCluster ( ) const

inline

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListTasks results. If you do not specify a cluster, the default cluster is assumed.

Definition at line 44 of file ListTasksRequest.h.

GetContainerInstance()

const Aws::String& Aws::ECS::Model::ListTasksRequest::GetContainerInstance ( ) const

inline

The container instance ID or full ARN of the container instance to use when filtering the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

Definition at line 102 of file ListTasksRequest.h.

GetDesiredStatus()

const DesiredStatus& Aws::ECS::Model::ListTasksRequest::GetDesiredStatus ( ) const

inline

The task desired status to use when filtering the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this does not return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

Definition at line 483 of file ListTasksRequest.h.

GetFamily()

const Aws::String& Aws::ECS::Model::ListTasksRequest::GetFamily ( ) const

inline

The name of the task definition family to use when filtering the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

Definition at line 166 of file ListTasksRequest.h.

GetLaunchType()

const LaunchType& Aws::ECS::Model::ListTasksRequest::GetLaunchType ( ) const

inline

The launch type to use when filtering the ListTasks results.

Definition at line 564 of file ListTasksRequest.h.

GetMaxResults()

int Aws::ECS::Model::ListTasksRequest::GetMaxResults ( ) const

inline

The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks 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 ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable.

Definition at line 317 of file ListTasksRequest.h.

GetNextToken()

const Aws::String& Aws::ECS::Model::ListTasksRequest::GetNextToken ( ) const

inline

The nextToken value returned from a ListTasks 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 227 of file ListTasksRequest.h.

GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::ECS::Model::ListTasksRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::ECS::ECSRequest.

GetServiceName()

const Aws::String& Aws::ECS::Model::ListTasksRequest::GetServiceName ( ) const

inline

The name of the service to use when filtering the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

Definition at line 418 of file ListTasksRequest.h.

GetServiceRequestName()

virtual const char* Aws::ECS::Model::ListTasksRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file ListTasksRequest.h.

GetStartedBy()

const Aws::String& Aws::ECS::Model::ListTasksRequest::GetStartedBy ( ) const

inline

The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value.

Definition at line 361 of file ListTasksRequest.h.

LaunchTypeHasBeenSet()

bool Aws::ECS::Model::ListTasksRequest::LaunchTypeHasBeenSet ( ) const

inline

The launch type to use when filtering the ListTasks results.

Definition at line 569 of file ListTasksRequest.h.

MaxResultsHasBeenSet()

bool Aws::ECS::Model::ListTasksRequest::MaxResultsHasBeenSet ( ) const

inline

The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks 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 ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable.

Definition at line 329 of file ListTasksRequest.h.

NextTokenHasBeenSet()

bool Aws::ECS::Model::ListTasksRequest::NextTokenHasBeenSet ( ) const

inline

The nextToken value returned from a ListTasks 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 238 of file ListTasksRequest.h.

SerializePayload()

Aws::String Aws::ECS::Model::ListTasksRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

ServiceNameHasBeenSet()

bool Aws::ECS::Model::ListTasksRequest::ServiceNameHasBeenSet ( ) const

inline

The name of the service to use when filtering the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

Definition at line 425 of file ListTasksRequest.h.

SetCluster() [1/3]

void Aws::ECS::Model::ListTasksRequest::SetCluster ( Aws::String &&  value )

inline

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListTasks results. If you do not specify a cluster, the default cluster is assumed.

Definition at line 65 of file ListTasksRequest.h.

SetCluster() [2/3]

void Aws::ECS::Model::ListTasksRequest::SetCluster ( const Aws::String &  value )

inline

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListTasks results. If you do not specify a cluster, the default cluster is assumed.

Definition at line 58 of file ListTasksRequest.h.

SetCluster() [3/3]

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

inline

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListTasks results. If you do not specify a cluster, the default cluster is assumed.

Definition at line 72 of file ListTasksRequest.h.

SetContainerInstance() [1/3]

void Aws::ECS::Model::ListTasksRequest::SetContainerInstance ( Aws::String &&  value )

inline

The container instance ID or full ARN of the container instance to use when filtering the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

Definition at line 126 of file ListTasksRequest.h.

SetContainerInstance() [2/3]

void Aws::ECS::Model::ListTasksRequest::SetContainerInstance ( const Aws::String &  value )

inline

The container instance ID or full ARN of the container instance to use when filtering the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

Definition at line 118 of file ListTasksRequest.h.

SetContainerInstance() [3/3]

void Aws::ECS::Model::ListTasksRequest::SetContainerInstance ( const char *  value )

inline

The container instance ID or full ARN of the container instance to use when filtering the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

Definition at line 134 of file ListTasksRequest.h.

SetDesiredStatus() [1/2]

void Aws::ECS::Model::ListTasksRequest::SetDesiredStatus ( const DesiredStatus &  value )

inline

The task desired status to use when filtering the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this does not return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

Definition at line 513 of file ListTasksRequest.h.

SetDesiredStatus() [2/2]

void Aws::ECS::Model::ListTasksRequest::SetDesiredStatus ( DesiredStatus &&  value )

inline

The task desired status to use when filtering the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this does not return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

Definition at line 528 of file ListTasksRequest.h.

SetFamily() [1/3]

void Aws::ECS::Model::ListTasksRequest::SetFamily ( Aws::String &&  value )

inline

The name of the task definition family to use when filtering the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

Definition at line 187 of file ListTasksRequest.h.

SetFamily() [2/3]

void Aws::ECS::Model::ListTasksRequest::SetFamily ( const Aws::String &  value )

inline

The name of the task definition family to use when filtering the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

Definition at line 180 of file ListTasksRequest.h.

SetFamily() [3/3]

void Aws::ECS::Model::ListTasksRequest::SetFamily ( const char *  value )

inline

The name of the task definition family to use when filtering the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

Definition at line 194 of file ListTasksRequest.h.

SetLaunchType() [1/2]

void Aws::ECS::Model::ListTasksRequest::SetLaunchType ( const LaunchType &  value )

inline

The launch type to use when filtering the ListTasks results.

Definition at line 574 of file ListTasksRequest.h.

SetLaunchType() [2/2]

void Aws::ECS::Model::ListTasksRequest::SetLaunchType ( LaunchType &&  value )

inline

The launch type to use when filtering the ListTasks results.

Definition at line 579 of file ListTasksRequest.h.

SetMaxResults()

void Aws::ECS::Model::ListTasksRequest::SetMaxResults ( int  value )

inline

The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks 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 ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable.

Definition at line 341 of file ListTasksRequest.h.

SetNextToken() [1/3]

void Aws::ECS::Model::ListTasksRequest::SetNextToken ( Aws::String &&  value )

inline

The nextToken value returned from a ListTasks 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 260 of file ListTasksRequest.h.

SetNextToken() [2/3]

void Aws::ECS::Model::ListTasksRequest::SetNextToken ( const Aws::String &  value )

inline

The nextToken value returned from a ListTasks 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 249 of file ListTasksRequest.h.

SetNextToken() [3/3]

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

inline

The nextToken value returned from a ListTasks 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 271 of file ListTasksRequest.h.

SetServiceName() [1/3]

void Aws::ECS::Model::ListTasksRequest::SetServiceName ( Aws::String &&  value )

inline

The name of the service to use when filtering the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

Definition at line 439 of file ListTasksRequest.h.

SetServiceName() [2/3]

void Aws::ECS::Model::ListTasksRequest::SetServiceName ( const Aws::String &  value )

inline

The name of the service to use when filtering the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

Definition at line 432 of file ListTasksRequest.h.

SetServiceName() [3/3]

void Aws::ECS::Model::ListTasksRequest::SetServiceName ( const char *  value )

inline

The name of the service to use when filtering the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

Definition at line 446 of file ListTasksRequest.h.

SetStartedBy() [1/3]

void Aws::ECS::Model::ListTasksRequest::SetStartedBy ( Aws::String &&  value )

inline

The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value.

Definition at line 382 of file ListTasksRequest.h.

SetStartedBy() [2/3]

void Aws::ECS::Model::ListTasksRequest::SetStartedBy ( const Aws::String &  value )

inline

The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value.

Definition at line 375 of file ListTasksRequest.h.

SetStartedBy() [3/3]

void Aws::ECS::Model::ListTasksRequest::SetStartedBy ( const char *  value )

inline

The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value.

Definition at line 389 of file ListTasksRequest.h.

StartedByHasBeenSet()

bool Aws::ECS::Model::ListTasksRequest::StartedByHasBeenSet ( ) const

inline

The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value.

Definition at line 368 of file ListTasksRequest.h.

WithCluster() [1/3]

ListTasksRequest& Aws::ECS::Model::ListTasksRequest::WithCluster ( Aws::String &&  value )

inline

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListTasks results. If you do not specify a cluster, the default cluster is assumed.

Definition at line 86 of file ListTasksRequest.h.

WithCluster() [2/3]

ListTasksRequest& Aws::ECS::Model::ListTasksRequest::WithCluster ( const Aws::String &  value )

inline

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListTasks results. If you do not specify a cluster, the default cluster is assumed.

Definition at line 79 of file ListTasksRequest.h.

WithCluster() [3/3]

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

inline

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListTasks results. If you do not specify a cluster, the default cluster is assumed.

Definition at line 93 of file ListTasksRequest.h.

WithContainerInstance() [1/3]

ListTasksRequest& Aws::ECS::Model::ListTasksRequest::WithContainerInstance ( Aws::String &&  value )

inline

The container instance ID or full ARN of the container instance to use when filtering the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

Definition at line 150 of file ListTasksRequest.h.

WithContainerInstance() [2/3]

ListTasksRequest& Aws::ECS::Model::ListTasksRequest::WithContainerInstance ( const Aws::String &  value )

inline

The container instance ID or full ARN of the container instance to use when filtering the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

Definition at line 142 of file ListTasksRequest.h.

WithContainerInstance() [3/3]

ListTasksRequest& Aws::ECS::Model::ListTasksRequest::WithContainerInstance ( const char *  value )

inline

The container instance ID or full ARN of the container instance to use when filtering the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

Definition at line 158 of file ListTasksRequest.h.

WithDesiredStatus() [1/2]

ListTasksRequest& Aws::ECS::Model::ListTasksRequest::WithDesiredStatus ( const DesiredStatus &  value )

inline

The task desired status to use when filtering the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this does not return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

Definition at line 543 of file ListTasksRequest.h.

WithDesiredStatus() [2/2]

ListTasksRequest& Aws::ECS::Model::ListTasksRequest::WithDesiredStatus ( DesiredStatus &&  value )

inline

The task desired status to use when filtering the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this does not return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

Definition at line 558 of file ListTasksRequest.h.

WithFamily() [1/3]

ListTasksRequest& Aws::ECS::Model::ListTasksRequest::WithFamily ( Aws::String &&  value )

inline

The name of the task definition family to use when filtering the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

Definition at line 208 of file ListTasksRequest.h.

WithFamily() [2/3]

ListTasksRequest& Aws::ECS::Model::ListTasksRequest::WithFamily ( const Aws::String &  value )

inline

The name of the task definition family to use when filtering the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

Definition at line 201 of file ListTasksRequest.h.

WithFamily() [3/3]

ListTasksRequest& Aws::ECS::Model::ListTasksRequest::WithFamily ( const char *  value )

inline

The name of the task definition family to use when filtering the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

Definition at line 215 of file ListTasksRequest.h.

WithLaunchType() [1/2]

ListTasksRequest& Aws::ECS::Model::ListTasksRequest::WithLaunchType ( const LaunchType &  value )

inline

The launch type to use when filtering the ListTasks results.

Definition at line 584 of file ListTasksRequest.h.

WithLaunchType() [2/2]

ListTasksRequest& Aws::ECS::Model::ListTasksRequest::WithLaunchType ( LaunchType &&  value )

inline

The launch type to use when filtering the ListTasks results.

Definition at line 589 of file ListTasksRequest.h.

WithMaxResults()

ListTasksRequest& Aws::ECS::Model::ListTasksRequest::WithMaxResults ( int  value )

inline

The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks 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 ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable.

Definition at line 353 of file ListTasksRequest.h.

WithNextToken() [1/3]

ListTasksRequest& Aws::ECS::Model::ListTasksRequest::WithNextToken ( Aws::String &&  value )

inline

The nextToken value returned from a ListTasks 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 293 of file ListTasksRequest.h.

WithNextToken() [2/3]

ListTasksRequest& Aws::ECS::Model::ListTasksRequest::WithNextToken ( const Aws::String &  value )

inline

The nextToken value returned from a ListTasks 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 282 of file ListTasksRequest.h.

WithNextToken() [3/3]

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

inline

The nextToken value returned from a ListTasks 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 304 of file ListTasksRequest.h.

WithServiceName() [1/3]

ListTasksRequest& Aws::ECS::Model::ListTasksRequest::WithServiceName ( Aws::String &&  value )

inline

The name of the service to use when filtering the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

Definition at line 460 of file ListTasksRequest.h.

WithServiceName() [2/3]

ListTasksRequest& Aws::ECS::Model::ListTasksRequest::WithServiceName ( const Aws::String &  value )

inline

The name of the service to use when filtering the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

Definition at line 453 of file ListTasksRequest.h.

WithServiceName() [3/3]

ListTasksRequest& Aws::ECS::Model::ListTasksRequest::WithServiceName ( const char *  value )

inline

The name of the service to use when filtering the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

Definition at line 467 of file ListTasksRequest.h.

WithStartedBy() [1/3]

ListTasksRequest& Aws::ECS::Model::ListTasksRequest::WithStartedBy ( Aws::String &&  value )

inline

The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value.

Definition at line 403 of file ListTasksRequest.h.

WithStartedBy() [2/3]

ListTasksRequest& Aws::ECS::Model::ListTasksRequest::WithStartedBy ( const Aws::String &  value )

inline

The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value.

Definition at line 396 of file ListTasksRequest.h.

WithStartedBy() [3/3]

ListTasksRequest& Aws::ECS::Model::ListTasksRequest::WithStartedBy ( const char *  value )

inline

The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value.

Definition at line 410 of file ListTasksRequest.h.

---

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

• aws-cpp-sdk-ecs/include/aws/ecs/model/ListTasksRequest.h