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

#include <DescribeCapacityProvidersRequest.h>

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

Public Member Functions

 DescribeCapacityProvidersRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::Vector< Aws::String > & GetCapacityProviders () const
 
bool CapacityProvidersHasBeenSet () const
 
void SetCapacityProviders (const Aws::Vector< Aws::String > &value)
 
void SetCapacityProviders (Aws::Vector< Aws::String > &&value)
 
DescribeCapacityProvidersRequestWithCapacityProviders (const Aws::Vector< Aws::String > &value)
 
DescribeCapacityProvidersRequestWithCapacityProviders (Aws::Vector< Aws::String > &&value)
 
DescribeCapacityProvidersRequestAddCapacityProviders (const Aws::String &value)
 
DescribeCapacityProvidersRequestAddCapacityProviders (Aws::String &&value)
 
DescribeCapacityProvidersRequestAddCapacityProviders (const char *value)
 
const Aws::Vector< CapacityProviderField > & GetInclude () const
 
bool IncludeHasBeenSet () const
 
void SetInclude (const Aws::Vector< CapacityProviderField > &value)
 
void SetInclude (Aws::Vector< CapacityProviderField > &&value)
 
DescribeCapacityProvidersRequestWithInclude (const Aws::Vector< CapacityProviderField > &value)
 
DescribeCapacityProvidersRequestWithInclude (Aws::Vector< CapacityProviderField > &&value)
 
DescribeCapacityProvidersRequestAddInclude (const CapacityProviderField &value)
 
DescribeCapacityProvidersRequestAddInclude (CapacityProviderField &&value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
DescribeCapacityProvidersRequestWithMaxResults (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
DescribeCapacityProvidersRequestWithNextToken (const Aws::String &value)
 
DescribeCapacityProvidersRequestWithNextToken (Aws::String &&value)
 
DescribeCapacityProvidersRequestWithNextToken (const char *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 23 of file DescribeCapacityProvidersRequest.h.

Constructor & Destructor Documentation

◆ DescribeCapacityProvidersRequest()

Aws::ECS::Model::DescribeCapacityProvidersRequest::DescribeCapacityProvidersRequest ( )

Member Function Documentation

◆ AddCapacityProviders() [1/3]

DescribeCapacityProvidersRequest& Aws::ECS::Model::DescribeCapacityProvidersRequest::AddCapacityProviders ( const Aws::String value)
inline

The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

Definition at line 86 of file DescribeCapacityProvidersRequest.h.

◆ AddCapacityProviders() [2/3]

DescribeCapacityProvidersRequest& Aws::ECS::Model::DescribeCapacityProvidersRequest::AddCapacityProviders ( Aws::String &&  value)
inline

The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

Definition at line 93 of file DescribeCapacityProvidersRequest.h.

◆ AddCapacityProviders() [3/3]

DescribeCapacityProvidersRequest& Aws::ECS::Model::DescribeCapacityProvidersRequest::AddCapacityProviders ( const char *  value)
inline

The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

Definition at line 100 of file DescribeCapacityProvidersRequest.h.

◆ AddInclude() [1/2]

DescribeCapacityProvidersRequest& Aws::ECS::Model::DescribeCapacityProvidersRequest::AddInclude ( const CapacityProviderField value)
inline

Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

Definition at line 150 of file DescribeCapacityProvidersRequest.h.

◆ AddInclude() [2/2]

DescribeCapacityProvidersRequest& Aws::ECS::Model::DescribeCapacityProvidersRequest::AddInclude ( CapacityProviderField &&  value)
inline

Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

Definition at line 157 of file DescribeCapacityProvidersRequest.h.

◆ CapacityProvidersHasBeenSet()

bool Aws::ECS::Model::DescribeCapacityProvidersRequest::CapacityProvidersHasBeenSet ( ) const
inline

The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

Definition at line 51 of file DescribeCapacityProvidersRequest.h.

◆ GetCapacityProviders()

const Aws::Vector<Aws::String>& Aws::ECS::Model::DescribeCapacityProvidersRequest::GetCapacityProviders ( ) const
inline

The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

Definition at line 44 of file DescribeCapacityProvidersRequest.h.

◆ GetInclude()

const Aws::Vector<CapacityProviderField>& Aws::ECS::Model::DescribeCapacityProvidersRequest::GetInclude ( ) const
inline

Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

Definition at line 108 of file DescribeCapacityProvidersRequest.h.

◆ GetMaxResults()

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

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

Definition at line 172 of file DescribeCapacityProvidersRequest.h.

◆ GetNextToken()

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

The nextToken value returned from a previous paginated DescribeCapacityProviders request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

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 226 of file DescribeCapacityProvidersRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::ECS::ECSRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file DescribeCapacityProvidersRequest.h.

◆ IncludeHasBeenSet()

bool Aws::ECS::Model::DescribeCapacityProvidersRequest::IncludeHasBeenSet ( ) const
inline

Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

Definition at line 115 of file DescribeCapacityProvidersRequest.h.

◆ MaxResultsHasBeenSet()

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

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

Definition at line 186 of file DescribeCapacityProvidersRequest.h.

◆ NextTokenHasBeenSet()

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

The nextToken value returned from a previous paginated DescribeCapacityProviders request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

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 237 of file DescribeCapacityProvidersRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCapacityProviders() [1/2]

void Aws::ECS::Model::DescribeCapacityProvidersRequest::SetCapacityProviders ( const Aws::Vector< Aws::String > &  value)
inline

The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

Definition at line 58 of file DescribeCapacityProvidersRequest.h.

◆ SetCapacityProviders() [2/2]

void Aws::ECS::Model::DescribeCapacityProvidersRequest::SetCapacityProviders ( Aws::Vector< Aws::String > &&  value)
inline

The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

Definition at line 65 of file DescribeCapacityProvidersRequest.h.

◆ SetInclude() [1/2]

void Aws::ECS::Model::DescribeCapacityProvidersRequest::SetInclude ( const Aws::Vector< CapacityProviderField > &  value)
inline

Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

Definition at line 122 of file DescribeCapacityProvidersRequest.h.

◆ SetInclude() [2/2]

void Aws::ECS::Model::DescribeCapacityProvidersRequest::SetInclude ( Aws::Vector< CapacityProviderField > &&  value)
inline

Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

Definition at line 129 of file DescribeCapacityProvidersRequest.h.

◆ SetMaxResults()

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

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

Definition at line 200 of file DescribeCapacityProvidersRequest.h.

◆ SetNextToken() [1/3]

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

The nextToken value returned from a previous paginated DescribeCapacityProviders request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

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 248 of file DescribeCapacityProvidersRequest.h.

◆ SetNextToken() [2/3]

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

The nextToken value returned from a previous paginated DescribeCapacityProviders request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

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 259 of file DescribeCapacityProvidersRequest.h.

◆ SetNextToken() [3/3]

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

The nextToken value returned from a previous paginated DescribeCapacityProviders request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

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 270 of file DescribeCapacityProvidersRequest.h.

◆ WithCapacityProviders() [1/2]

DescribeCapacityProvidersRequest& Aws::ECS::Model::DescribeCapacityProvidersRequest::WithCapacityProviders ( const Aws::Vector< Aws::String > &  value)
inline

The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

Definition at line 72 of file DescribeCapacityProvidersRequest.h.

◆ WithCapacityProviders() [2/2]

DescribeCapacityProvidersRequest& Aws::ECS::Model::DescribeCapacityProvidersRequest::WithCapacityProviders ( Aws::Vector< Aws::String > &&  value)
inline

The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100 capacity providers can be described in an action.

Definition at line 79 of file DescribeCapacityProvidersRequest.h.

◆ WithInclude() [1/2]

DescribeCapacityProvidersRequest& Aws::ECS::Model::DescribeCapacityProvidersRequest::WithInclude ( const Aws::Vector< CapacityProviderField > &  value)
inline

Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

Definition at line 136 of file DescribeCapacityProvidersRequest.h.

◆ WithInclude() [2/2]

DescribeCapacityProvidersRequest& Aws::ECS::Model::DescribeCapacityProvidersRequest::WithInclude ( Aws::Vector< CapacityProviderField > &&  value)
inline

Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

Definition at line 143 of file DescribeCapacityProvidersRequest.h.

◆ WithMaxResults()

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

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

Definition at line 214 of file DescribeCapacityProvidersRequest.h.

◆ WithNextToken() [1/3]

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

The nextToken value returned from a previous paginated DescribeCapacityProviders request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

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 281 of file DescribeCapacityProvidersRequest.h.

◆ WithNextToken() [2/3]

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

The nextToken value returned from a previous paginated DescribeCapacityProviders request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

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 292 of file DescribeCapacityProvidersRequest.h.

◆ WithNextToken() [3/3]

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

The nextToken value returned from a previous paginated DescribeCapacityProviders request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

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 303 of file DescribeCapacityProvidersRequest.h.


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