Aws::ECS::Model::ListAccountSettingsRequest Class Reference

#include <ListAccountSettingsRequest.h>

Inheritance diagram for Aws::ECS::Model::ListAccountSettingsRequest:

Public Member Functions
	ListAccountSettingsRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override
const SettingName &	GetName () const
bool	NameHasBeenSet () const
void	SetName (const SettingName &value)
void	SetName (SettingName &&value)
ListAccountSettingsRequest &	WithName (const SettingName &value)
ListAccountSettingsRequest &	WithName (SettingName &&value)
const Aws::String &	GetValue () const
bool	ValueHasBeenSet () const
void	SetValue (const Aws::String &value)
void	SetValue (Aws::String &&value)
void	SetValue (const char *value)
ListAccountSettingsRequest &	WithValue (const Aws::String &value)
ListAccountSettingsRequest &	WithValue (Aws::String &&value)
ListAccountSettingsRequest &	WithValue (const char *value)
const Aws::String &	GetPrincipalArn () const
bool	PrincipalArnHasBeenSet () const
void	SetPrincipalArn (const Aws::String &value)
void	SetPrincipalArn (Aws::String &&value)
void	SetPrincipalArn (const char *value)
ListAccountSettingsRequest &	WithPrincipalArn (const Aws::String &value)
ListAccountSettingsRequest &	WithPrincipalArn (Aws::String &&value)
ListAccountSettingsRequest &	WithPrincipalArn (const char *value)
bool	GetEffectiveSettings () const
bool	EffectiveSettingsHasBeenSet () const
void	SetEffectiveSettings (bool value)
ListAccountSettingsRequest &	WithEffectiveSettings (bool 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)
ListAccountSettingsRequest &	WithNextToken (const Aws::String &value)
ListAccountSettingsRequest &	WithNextToken (Aws::String &&value)
ListAccountSettingsRequest &	WithNextToken (const char *value)
int	GetMaxResults () const
bool	MaxResultsHasBeenSet () const
void	SetMaxResults (int value)
ListAccountSettingsRequest &	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 ListAccountSettingsRequest.h.

Constructor & Destructor Documentation

ListAccountSettingsRequest()

Aws::ECS::Model::ListAccountSettingsRequest::ListAccountSettingsRequest

(

)

Member Function Documentation

EffectiveSettingsHasBeenSet()

bool Aws::ECS::Model::ListAccountSettingsRequest::EffectiveSettingsHasBeenSet ( ) const

inline

Specifies whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn are returned. If false, the account settings for the principalArn are returned if they are set. Otherwise, no account settings are returned.

Definition at line 191 of file ListAccountSettingsRequest.h.

GetEffectiveSettings()

bool Aws::ECS::Model::ListAccountSettingsRequest::GetEffectiveSettings ( ) const

inline

Specifies whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn are returned. If false, the account settings for the principalArn are returned if they are set. Otherwise, no account settings are returned.

Definition at line 182 of file ListAccountSettingsRequest.h.

GetMaxResults()

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

inline

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

Definition at line 312 of file ListAccountSettingsRequest.h.

GetName()

const SettingName& Aws::ECS::Model::ListAccountSettingsRequest::GetName ( ) const

inline

The name of the account setting you want to list the settings for.

Definition at line 41 of file ListAccountSettingsRequest.h.

GetNextToken()

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

inline

The nextToken value returned from a ListAccountSettings 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 ListAccountSettingsRequest.h.

GetPrincipalArn()

const Aws::String& Aws::ECS::Model::ListAccountSettingsRequest::GetPrincipalArn ( ) const

inline

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

Definition at line 123 of file ListAccountSettingsRequest.h.

GetRequestSpecificHeaders()

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

overridevirtual

Reimplemented from Aws::ECS::ECSRequest.

GetServiceRequestName()

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

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file ListAccountSettingsRequest.h.

GetValue()

const Aws::String& Aws::ECS::Model::ListAccountSettingsRequest::GetValue ( ) const

inline

The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter.

Definition at line 73 of file ListAccountSettingsRequest.h.

MaxResultsHasBeenSet()

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

inline

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

Definition at line 325 of file ListAccountSettingsRequest.h.

NameHasBeenSet()

bool Aws::ECS::Model::ListAccountSettingsRequest::NameHasBeenSet ( ) const

inline

The name of the account setting you want to list the settings for.

Definition at line 46 of file ListAccountSettingsRequest.h.

NextTokenHasBeenSet()

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

inline

The nextToken value returned from a ListAccountSettings 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 ListAccountSettingsRequest.h.

PrincipalArnHasBeenSet()

bool Aws::ECS::Model::ListAccountSettingsRequest::PrincipalArnHasBeenSet ( ) const

inline

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

Definition at line 130 of file ListAccountSettingsRequest.h.

SerializePayload()

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

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetEffectiveSettings()

void Aws::ECS::Model::ListAccountSettingsRequest::SetEffectiveSettings ( bool  value )

inline

Specifies whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn are returned. If false, the account settings for the principalArn are returned if they are set. Otherwise, no account settings are returned.

Definition at line 200 of file ListAccountSettingsRequest.h.

SetMaxResults()

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

inline

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

Definition at line 338 of file ListAccountSettingsRequest.h.

SetName() [1/2]

void Aws::ECS::Model::ListAccountSettingsRequest::SetName ( const SettingName &  value )

inline

The name of the account setting you want to list the settings for.

Definition at line 51 of file ListAccountSettingsRequest.h.

SetName() [2/2]

void Aws::ECS::Model::ListAccountSettingsRequest::SetName ( SettingName &&  value )

inline

The name of the account setting you want to list the settings for.

Definition at line 56 of file ListAccountSettingsRequest.h.

SetNextToken() [1/3]

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

inline

The nextToken value returned from a ListAccountSettings 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 ListAccountSettingsRequest.h.

SetNextToken() [2/3]

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

inline

The nextToken value returned from a ListAccountSettings 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 ListAccountSettingsRequest.h.

SetNextToken() [3/3]

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

inline

The nextToken value returned from a ListAccountSettings 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 265 of file ListAccountSettingsRequest.h.

SetPrincipalArn() [1/3]

void Aws::ECS::Model::ListAccountSettingsRequest::SetPrincipalArn ( Aws::String &&  value )

inline

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

Definition at line 144 of file ListAccountSettingsRequest.h.

SetPrincipalArn() [2/3]

void Aws::ECS::Model::ListAccountSettingsRequest::SetPrincipalArn ( const Aws::String &  value )

inline

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

Definition at line 137 of file ListAccountSettingsRequest.h.

SetPrincipalArn() [3/3]

void Aws::ECS::Model::ListAccountSettingsRequest::SetPrincipalArn ( const char *  value )

inline

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

Definition at line 151 of file ListAccountSettingsRequest.h.

SetValue() [1/3]

void Aws::ECS::Model::ListAccountSettingsRequest::SetValue ( Aws::String &&  value )

inline

The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter.

Definition at line 91 of file ListAccountSettingsRequest.h.

SetValue() [2/3]

void Aws::ECS::Model::ListAccountSettingsRequest::SetValue ( const Aws::String &  value )

inline

The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter.

Definition at line 85 of file ListAccountSettingsRequest.h.

SetValue() [3/3]

void Aws::ECS::Model::ListAccountSettingsRequest::SetValue ( const char *  value )

inline

The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter.

Definition at line 97 of file ListAccountSettingsRequest.h.

ValueHasBeenSet()

bool Aws::ECS::Model::ListAccountSettingsRequest::ValueHasBeenSet ( ) const

inline

The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter.

Definition at line 79 of file ListAccountSettingsRequest.h.

WithEffectiveSettings()

ListAccountSettingsRequest& Aws::ECS::Model::ListAccountSettingsRequest::WithEffectiveSettings ( bool  value )

inline

Specifies whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn are returned. If false, the account settings for the principalArn are returned if they are set. Otherwise, no account settings are returned.

Definition at line 209 of file ListAccountSettingsRequest.h.

WithMaxResults()

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

inline

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

Definition at line 351 of file ListAccountSettingsRequest.h.

WithName() [1/2]

ListAccountSettingsRequest& Aws::ECS::Model::ListAccountSettingsRequest::WithName ( const SettingName &  value )

inline

The name of the account setting you want to list the settings for.

Definition at line 61 of file ListAccountSettingsRequest.h.

WithName() [2/2]

ListAccountSettingsRequest& Aws::ECS::Model::ListAccountSettingsRequest::WithName ( SettingName &&  value )

inline

The name of the account setting you want to list the settings for.

Definition at line 66 of file ListAccountSettingsRequest.h.

WithNextToken() [1/3]

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

inline

The nextToken value returned from a ListAccountSettings 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 287 of file ListAccountSettingsRequest.h.

WithNextToken() [2/3]

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

inline

The nextToken value returned from a ListAccountSettings 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 276 of file ListAccountSettingsRequest.h.

WithNextToken() [3/3]

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

inline

The nextToken value returned from a ListAccountSettings 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 298 of file ListAccountSettingsRequest.h.

WithPrincipalArn() [1/3]

ListAccountSettingsRequest& Aws::ECS::Model::ListAccountSettingsRequest::WithPrincipalArn ( Aws::String &&  value )

inline

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

Definition at line 165 of file ListAccountSettingsRequest.h.

WithPrincipalArn() [2/3]

ListAccountSettingsRequest& Aws::ECS::Model::ListAccountSettingsRequest::WithPrincipalArn ( const Aws::String &  value )

inline

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

Definition at line 158 of file ListAccountSettingsRequest.h.

WithPrincipalArn() [3/3]

ListAccountSettingsRequest& Aws::ECS::Model::ListAccountSettingsRequest::WithPrincipalArn ( const char *  value )

inline

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

Definition at line 172 of file ListAccountSettingsRequest.h.

WithValue() [1/3]

ListAccountSettingsRequest& Aws::ECS::Model::ListAccountSettingsRequest::WithValue ( Aws::String &&  value )

inline

The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter.

Definition at line 109 of file ListAccountSettingsRequest.h.

WithValue() [2/3]

ListAccountSettingsRequest& Aws::ECS::Model::ListAccountSettingsRequest::WithValue ( const Aws::String &  value )

inline

The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter.

Definition at line 103 of file ListAccountSettingsRequest.h.

WithValue() [3/3]

ListAccountSettingsRequest& Aws::ECS::Model::ListAccountSettingsRequest::WithValue ( const char *  value )

inline

The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter.

Definition at line 115 of file ListAccountSettingsRequest.h.

---

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

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