Aws::ECS::Model::ListTaskDefinitionFamiliesRequest Class Reference

#include <ListTaskDefinitionFamiliesRequest.h>

Inheritance diagram for Aws::ECS::Model::ListTaskDefinitionFamiliesRequest:

Public Member Functions
	ListTaskDefinitionFamiliesRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override
const Aws::String &	GetFamilyPrefix () const
bool	FamilyPrefixHasBeenSet () const
void	SetFamilyPrefix (const Aws::String &value)
void	SetFamilyPrefix (Aws::String &&value)
void	SetFamilyPrefix (const char *value)
ListTaskDefinitionFamiliesRequest &	WithFamilyPrefix (const Aws::String &value)
ListTaskDefinitionFamiliesRequest &	WithFamilyPrefix (Aws::String &&value)
ListTaskDefinitionFamiliesRequest &	WithFamilyPrefix (const char *value)
const TaskDefinitionFamilyStatus &	GetStatus () const
bool	StatusHasBeenSet () const
void	SetStatus (const TaskDefinitionFamilyStatus &value)
void	SetStatus (TaskDefinitionFamilyStatus &&value)
ListTaskDefinitionFamiliesRequest &	WithStatus (const TaskDefinitionFamilyStatus &value)
ListTaskDefinitionFamiliesRequest &	WithStatus (TaskDefinitionFamilyStatus &&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)
ListTaskDefinitionFamiliesRequest &	WithNextToken (const Aws::String &value)
ListTaskDefinitionFamiliesRequest &	WithNextToken (Aws::String &&value)
ListTaskDefinitionFamiliesRequest &	WithNextToken (const char *value)
int	GetMaxResults () const
bool	MaxResultsHasBeenSet () const
void	SetMaxResults (int value)
ListTaskDefinitionFamiliesRequest &	WithMaxResults (int 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 22 of file ListTaskDefinitionFamiliesRequest.h.

Constructor & Destructor Documentation

ListTaskDefinitionFamiliesRequest()

Aws::ECS::Model::ListTaskDefinitionFamiliesRequest::ListTaskDefinitionFamiliesRequest

(

)

Member Function Documentation

FamilyPrefixHasBeenSet()

bool Aws::ECS::Model::ListTaskDefinitionFamiliesRequest::FamilyPrefixHasBeenSet ( ) const

inline

The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.

Definition at line 52 of file ListTaskDefinitionFamiliesRequest.h.

GetFamilyPrefix()

const Aws::String& Aws::ECS::Model::ListTaskDefinitionFamiliesRequest::GetFamilyPrefix ( ) const

inline

The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.

Definition at line 44 of file ListTaskDefinitionFamiliesRequest.h.

GetMaxResults()

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

inline

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

Definition at line 282 of file ListTaskDefinitionFamiliesRequest.h.

GetNextToken()

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

inline

The nextToken value returned from a ListTaskDefinitionFamilies 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 191 of file ListTaskDefinitionFamiliesRequest.h.

GetRequestSpecificHeaders()

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

overridevirtual

Reimplemented from Aws::ECS::ECSRequest.

GetServiceRequestName()

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

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file ListTaskDefinitionFamiliesRequest.h.

GetStatus()

const TaskDefinitionFamilyStatus& Aws::ECS::Model::ListTaskDefinitionFamiliesRequest::GetStatus ( ) const

inline

The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

Definition at line 114 of file ListTaskDefinitionFamiliesRequest.h.

MaxResultsHasBeenSet()

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

inline

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

Definition at line 295 of file ListTaskDefinitionFamiliesRequest.h.

NextTokenHasBeenSet()

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

inline

The nextToken value returned from a ListTaskDefinitionFamilies 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 202 of file ListTaskDefinitionFamiliesRequest.h.

SerializePayload()

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

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetFamilyPrefix() [1/3]

void Aws::ECS::Model::ListTaskDefinitionFamiliesRequest::SetFamilyPrefix ( Aws::String &&  value )

inline

The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.

Definition at line 68 of file ListTaskDefinitionFamiliesRequest.h.

SetFamilyPrefix() [2/3]

void Aws::ECS::Model::ListTaskDefinitionFamiliesRequest::SetFamilyPrefix ( const Aws::String &  value )

inline

The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.

Definition at line 60 of file ListTaskDefinitionFamiliesRequest.h.

SetFamilyPrefix() [3/3]

void Aws::ECS::Model::ListTaskDefinitionFamiliesRequest::SetFamilyPrefix ( const char *  value )

inline

The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.

Definition at line 76 of file ListTaskDefinitionFamiliesRequest.h.

SetMaxResults()

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

inline

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

Definition at line 308 of file ListTaskDefinitionFamiliesRequest.h.

SetNextToken() [1/3]

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

inline

The nextToken value returned from a ListTaskDefinitionFamilies 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 224 of file ListTaskDefinitionFamiliesRequest.h.

SetNextToken() [2/3]

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

inline

The nextToken value returned from a ListTaskDefinitionFamilies 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 213 of file ListTaskDefinitionFamiliesRequest.h.

SetNextToken() [3/3]

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

inline

The nextToken value returned from a ListTaskDefinitionFamilies 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 235 of file ListTaskDefinitionFamiliesRequest.h.

SetStatus() [1/2]

void Aws::ECS::Model::ListTaskDefinitionFamiliesRequest::SetStatus ( const TaskDefinitionFamilyStatus &  value )

inline

The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

Definition at line 140 of file ListTaskDefinitionFamiliesRequest.h.

SetStatus() [2/2]

void Aws::ECS::Model::ListTaskDefinitionFamiliesRequest::SetStatus ( TaskDefinitionFamilyStatus &&  value )

inline

The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

Definition at line 153 of file ListTaskDefinitionFamiliesRequest.h.

StatusHasBeenSet()

bool Aws::ECS::Model::ListTaskDefinitionFamiliesRequest::StatusHasBeenSet ( ) const

inline

The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

Definition at line 127 of file ListTaskDefinitionFamiliesRequest.h.

WithFamilyPrefix() [1/3]

ListTaskDefinitionFamiliesRequest& Aws::ECS::Model::ListTaskDefinitionFamiliesRequest::WithFamilyPrefix ( Aws::String &&  value )

inline

The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.

Definition at line 92 of file ListTaskDefinitionFamiliesRequest.h.

WithFamilyPrefix() [2/3]

ListTaskDefinitionFamiliesRequest& Aws::ECS::Model::ListTaskDefinitionFamiliesRequest::WithFamilyPrefix ( const Aws::String &  value )

inline

The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.

Definition at line 84 of file ListTaskDefinitionFamiliesRequest.h.

WithFamilyPrefix() [3/3]

ListTaskDefinitionFamiliesRequest& Aws::ECS::Model::ListTaskDefinitionFamiliesRequest::WithFamilyPrefix ( const char *  value )

inline

The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.

Definition at line 100 of file ListTaskDefinitionFamiliesRequest.h.

WithMaxResults()

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

inline

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

Definition at line 321 of file ListTaskDefinitionFamiliesRequest.h.

WithNextToken() [1/3]

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

inline

The nextToken value returned from a ListTaskDefinitionFamilies 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 257 of file ListTaskDefinitionFamiliesRequest.h.

WithNextToken() [2/3]

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

inline

The nextToken value returned from a ListTaskDefinitionFamilies 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 246 of file ListTaskDefinitionFamiliesRequest.h.

WithNextToken() [3/3]

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

inline

The nextToken value returned from a ListTaskDefinitionFamilies 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 268 of file ListTaskDefinitionFamiliesRequest.h.

WithStatus() [1/2]

ListTaskDefinitionFamiliesRequest& Aws::ECS::Model::ListTaskDefinitionFamiliesRequest::WithStatus ( const TaskDefinitionFamilyStatus &  value )

inline

The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

Definition at line 166 of file ListTaskDefinitionFamiliesRequest.h.

WithStatus() [2/2]

ListTaskDefinitionFamiliesRequest& Aws::ECS::Model::ListTaskDefinitionFamiliesRequest::WithStatus ( TaskDefinitionFamilyStatus &&  value )

inline

The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

Definition at line 179 of file ListTaskDefinitionFamiliesRequest.h.

---

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

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