AWS SDK for C++  1.8.183
AWS SDK for C++
Public Member Functions | List of all members
Aws::CostExplorer::Model::GetTagsRequest Class Reference

#include <GetTagsRequest.h>

+ Inheritance diagram for Aws::CostExplorer::Model::GetTagsRequest:

Public Member Functions

 GetTagsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetSearchString () const
 
bool SearchStringHasBeenSet () const
 
void SetSearchString (const Aws::String &value)
 
void SetSearchString (Aws::String &&value)
 
void SetSearchString (const char *value)
 
GetTagsRequestWithSearchString (const Aws::String &value)
 
GetTagsRequestWithSearchString (Aws::String &&value)
 
GetTagsRequestWithSearchString (const char *value)
 
const DateIntervalGetTimePeriod () const
 
bool TimePeriodHasBeenSet () const
 
void SetTimePeriod (const DateInterval &value)
 
void SetTimePeriod (DateInterval &&value)
 
GetTagsRequestWithTimePeriod (const DateInterval &value)
 
GetTagsRequestWithTimePeriod (DateInterval &&value)
 
const Aws::StringGetTagKey () const
 
bool TagKeyHasBeenSet () const
 
void SetTagKey (const Aws::String &value)
 
void SetTagKey (Aws::String &&value)
 
void SetTagKey (const char *value)
 
GetTagsRequestWithTagKey (const Aws::String &value)
 
GetTagsRequestWithTagKey (Aws::String &&value)
 
GetTagsRequestWithTagKey (const char *value)
 
const ExpressionGetFilter () const
 
bool FilterHasBeenSet () const
 
void SetFilter (const Expression &value)
 
void SetFilter (Expression &&value)
 
GetTagsRequestWithFilter (const Expression &value)
 
GetTagsRequestWithFilter (Expression &&value)
 
const Aws::Vector< SortDefinition > & GetSortBy () const
 
bool SortByHasBeenSet () const
 
void SetSortBy (const Aws::Vector< SortDefinition > &value)
 
void SetSortBy (Aws::Vector< SortDefinition > &&value)
 
GetTagsRequestWithSortBy (const Aws::Vector< SortDefinition > &value)
 
GetTagsRequestWithSortBy (Aws::Vector< SortDefinition > &&value)
 
GetTagsRequestAddSortBy (const SortDefinition &value)
 
GetTagsRequestAddSortBy (SortDefinition &&value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
GetTagsRequestWithMaxResults (int value)
 
const Aws::StringGetNextPageToken () const
 
bool NextPageTokenHasBeenSet () const
 
void SetNextPageToken (const Aws::String &value)
 
void SetNextPageToken (Aws::String &&value)
 
void SetNextPageToken (const char *value)
 
GetTagsRequestWithNextPageToken (const Aws::String &value)
 
GetTagsRequestWithNextPageToken (Aws::String &&value)
 
GetTagsRequestWithNextPageToken (const char *value)
 
- Public Member Functions inherited from Aws::CostExplorer::CostExplorerRequest
virtual ~CostExplorerRequest ()
 
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 25 of file GetTagsRequest.h.

Constructor & Destructor Documentation

◆ GetTagsRequest()

Aws::CostExplorer::Model::GetTagsRequest::GetTagsRequest ( )

Member Function Documentation

◆ AddSortBy() [1/2]

GetTagsRequest& Aws::CostExplorer::Model::GetTagsRequest::AddSortBy ( const SortDefinition value)
inline

The value by which you want to sort the data.

The key represents cost and usage metrics. The following values are supported:

  • BlendedCost

  • UnblendedCost

  • AmortizedCost

  • NetAmortizedCost

  • NetUnblendedCost

  • UsageQuantity

  • NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When using SortBy, NextPageToken and SearchString are not supported.

Definition at line 293 of file GetTagsRequest.h.

◆ AddSortBy() [2/2]

GetTagsRequest& Aws::CostExplorer::Model::GetTagsRequest::AddSortBy ( SortDefinition &&  value)
inline

The value by which you want to sort the data.

The key represents cost and usage metrics. The following values are supported:

  • BlendedCost

  • UnblendedCost

  • AmortizedCost

  • NetAmortizedCost

  • NetUnblendedCost

  • UsageQuantity

  • NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When using SortBy, NextPageToken and SearchString are not supported.

Definition at line 307 of file GetTagsRequest.h.

◆ FilterHasBeenSet()

bool Aws::CostExplorer::Model::GetTagsRequest::FilterHasBeenSet ( ) const
inline

Definition at line 182 of file GetTagsRequest.h.

◆ GetFilter()

const Expression& Aws::CostExplorer::Model::GetTagsRequest::GetFilter ( ) const
inline

Definition at line 179 of file GetTagsRequest.h.

◆ GetMaxResults()

int Aws::CostExplorer::Model::GetTagsRequest::GetMaxResults ( ) const
inline

This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

For GetTags, MaxResults has an upper limit of 1000.

Definition at line 317 of file GetTagsRequest.h.

◆ GetNextPageToken()

const Aws::String& Aws::CostExplorer::Model::GetTagsRequest::GetNextPageToken ( ) const
inline

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Definition at line 352 of file GetTagsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CostExplorer::Model::GetTagsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetSearchString()

const Aws::String& Aws::CostExplorer::Model::GetTagsRequest::GetSearchString ( ) const
inline

The value that you want to search for.

Definition at line 44 of file GetTagsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::CostExplorer::Model::GetTagsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file GetTagsRequest.h.

◆ GetSortBy()

const Aws::Vector<SortDefinition>& Aws::CostExplorer::Model::GetTagsRequest::GetSortBy ( ) const
inline

The value by which you want to sort the data.

The key represents cost and usage metrics. The following values are supported:

  • BlendedCost

  • UnblendedCost

  • AmortizedCost

  • NetAmortizedCost

  • NetUnblendedCost

  • UsageQuantity

  • NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When using SortBy, NextPageToken and SearchString are not supported.

Definition at line 209 of file GetTagsRequest.h.

◆ GetTagKey()

const Aws::String& Aws::CostExplorer::Model::GetTagsRequest::GetTagKey ( ) const
inline

The key of the tag that you want to return values for.

Definition at line 140 of file GetTagsRequest.h.

◆ GetTimePeriod()

const DateInterval& Aws::CostExplorer::Model::GetTagsRequest::GetTimePeriod ( ) const
inline

The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

Definition at line 89 of file GetTagsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::CostExplorer::Model::GetTagsRequest::MaxResultsHasBeenSet ( ) const
inline

This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

For GetTags, MaxResults has an upper limit of 1000.

Definition at line 326 of file GetTagsRequest.h.

◆ NextPageTokenHasBeenSet()

bool Aws::CostExplorer::Model::GetTagsRequest::NextPageTokenHasBeenSet ( ) const
inline

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Definition at line 359 of file GetTagsRequest.h.

◆ SearchStringHasBeenSet()

bool Aws::CostExplorer::Model::GetTagsRequest::SearchStringHasBeenSet ( ) const
inline

The value that you want to search for.

Definition at line 49 of file GetTagsRequest.h.

◆ SerializePayload()

Aws::String Aws::CostExplorer::Model::GetTagsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFilter() [1/2]

void Aws::CostExplorer::Model::GetTagsRequest::SetFilter ( const Expression value)
inline

Definition at line 185 of file GetTagsRequest.h.

◆ SetFilter() [2/2]

void Aws::CostExplorer::Model::GetTagsRequest::SetFilter ( Expression &&  value)
inline

Definition at line 188 of file GetTagsRequest.h.

◆ SetMaxResults()

void Aws::CostExplorer::Model::GetTagsRequest::SetMaxResults ( int  value)
inline

This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

For GetTags, MaxResults has an upper limit of 1000.

Definition at line 335 of file GetTagsRequest.h.

◆ SetNextPageToken() [1/3]

void Aws::CostExplorer::Model::GetTagsRequest::SetNextPageToken ( Aws::String &&  value)
inline

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Definition at line 373 of file GetTagsRequest.h.

◆ SetNextPageToken() [2/3]

void Aws::CostExplorer::Model::GetTagsRequest::SetNextPageToken ( const Aws::String value)
inline

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Definition at line 366 of file GetTagsRequest.h.

◆ SetNextPageToken() [3/3]

void Aws::CostExplorer::Model::GetTagsRequest::SetNextPageToken ( const char *  value)
inline

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Definition at line 380 of file GetTagsRequest.h.

◆ SetSearchString() [1/3]

void Aws::CostExplorer::Model::GetTagsRequest::SetSearchString ( Aws::String &&  value)
inline

The value that you want to search for.

Definition at line 59 of file GetTagsRequest.h.

◆ SetSearchString() [2/3]

void Aws::CostExplorer::Model::GetTagsRequest::SetSearchString ( const Aws::String value)
inline

The value that you want to search for.

Definition at line 54 of file GetTagsRequest.h.

◆ SetSearchString() [3/3]

void Aws::CostExplorer::Model::GetTagsRequest::SetSearchString ( const char *  value)
inline

The value that you want to search for.

Definition at line 64 of file GetTagsRequest.h.

◆ SetSortBy() [1/2]

void Aws::CostExplorer::Model::GetTagsRequest::SetSortBy ( Aws::Vector< SortDefinition > &&  value)
inline

The value by which you want to sort the data.

The key represents cost and usage metrics. The following values are supported:

  • BlendedCost

  • UnblendedCost

  • AmortizedCost

  • NetAmortizedCost

  • NetUnblendedCost

  • UsageQuantity

  • NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When using SortBy, NextPageToken and SearchString are not supported.

Definition at line 251 of file GetTagsRequest.h.

◆ SetSortBy() [2/2]

void Aws::CostExplorer::Model::GetTagsRequest::SetSortBy ( const Aws::Vector< SortDefinition > &  value)
inline

The value by which you want to sort the data.

The key represents cost and usage metrics. The following values are supported:

  • BlendedCost

  • UnblendedCost

  • AmortizedCost

  • NetAmortizedCost

  • NetUnblendedCost

  • UsageQuantity

  • NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When using SortBy, NextPageToken and SearchString are not supported.

Definition at line 237 of file GetTagsRequest.h.

◆ SetTagKey() [1/3]

void Aws::CostExplorer::Model::GetTagsRequest::SetTagKey ( Aws::String &&  value)
inline

The key of the tag that you want to return values for.

Definition at line 155 of file GetTagsRequest.h.

◆ SetTagKey() [2/3]

void Aws::CostExplorer::Model::GetTagsRequest::SetTagKey ( const Aws::String value)
inline

The key of the tag that you want to return values for.

Definition at line 150 of file GetTagsRequest.h.

◆ SetTagKey() [3/3]

void Aws::CostExplorer::Model::GetTagsRequest::SetTagKey ( const char *  value)
inline

The key of the tag that you want to return values for.

Definition at line 160 of file GetTagsRequest.h.

◆ SetTimePeriod() [1/2]

void Aws::CostExplorer::Model::GetTagsRequest::SetTimePeriod ( const DateInterval value)
inline

The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

Definition at line 107 of file GetTagsRequest.h.

◆ SetTimePeriod() [2/2]

void Aws::CostExplorer::Model::GetTagsRequest::SetTimePeriod ( DateInterval &&  value)
inline

The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

Definition at line 116 of file GetTagsRequest.h.

◆ SortByHasBeenSet()

bool Aws::CostExplorer::Model::GetTagsRequest::SortByHasBeenSet ( ) const
inline

The value by which you want to sort the data.

The key represents cost and usage metrics. The following values are supported:

  • BlendedCost

  • UnblendedCost

  • AmortizedCost

  • NetAmortizedCost

  • NetUnblendedCost

  • UsageQuantity

  • NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When using SortBy, NextPageToken and SearchString are not supported.

Definition at line 223 of file GetTagsRequest.h.

◆ TagKeyHasBeenSet()

bool Aws::CostExplorer::Model::GetTagsRequest::TagKeyHasBeenSet ( ) const
inline

The key of the tag that you want to return values for.

Definition at line 145 of file GetTagsRequest.h.

◆ TimePeriodHasBeenSet()

bool Aws::CostExplorer::Model::GetTagsRequest::TimePeriodHasBeenSet ( ) const
inline

The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

Definition at line 98 of file GetTagsRequest.h.

◆ WithFilter() [1/2]

GetTagsRequest& Aws::CostExplorer::Model::GetTagsRequest::WithFilter ( const Expression value)
inline

Definition at line 191 of file GetTagsRequest.h.

◆ WithFilter() [2/2]

GetTagsRequest& Aws::CostExplorer::Model::GetTagsRequest::WithFilter ( Expression &&  value)
inline

Definition at line 194 of file GetTagsRequest.h.

◆ WithMaxResults()

GetTagsRequest& Aws::CostExplorer::Model::GetTagsRequest::WithMaxResults ( int  value)
inline

This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

For GetTags, MaxResults has an upper limit of 1000.

Definition at line 344 of file GetTagsRequest.h.

◆ WithNextPageToken() [1/3]

GetTagsRequest& Aws::CostExplorer::Model::GetTagsRequest::WithNextPageToken ( Aws::String &&  value)
inline

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Definition at line 394 of file GetTagsRequest.h.

◆ WithNextPageToken() [2/3]

GetTagsRequest& Aws::CostExplorer::Model::GetTagsRequest::WithNextPageToken ( const Aws::String value)
inline

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Definition at line 387 of file GetTagsRequest.h.

◆ WithNextPageToken() [3/3]

GetTagsRequest& Aws::CostExplorer::Model::GetTagsRequest::WithNextPageToken ( const char *  value)
inline

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

Definition at line 401 of file GetTagsRequest.h.

◆ WithSearchString() [1/3]

GetTagsRequest& Aws::CostExplorer::Model::GetTagsRequest::WithSearchString ( Aws::String &&  value)
inline

The value that you want to search for.

Definition at line 74 of file GetTagsRequest.h.

◆ WithSearchString() [2/3]

GetTagsRequest& Aws::CostExplorer::Model::GetTagsRequest::WithSearchString ( const Aws::String value)
inline

The value that you want to search for.

Definition at line 69 of file GetTagsRequest.h.

◆ WithSearchString() [3/3]

GetTagsRequest& Aws::CostExplorer::Model::GetTagsRequest::WithSearchString ( const char *  value)
inline

The value that you want to search for.

Definition at line 79 of file GetTagsRequest.h.

◆ WithSortBy() [1/2]

GetTagsRequest& Aws::CostExplorer::Model::GetTagsRequest::WithSortBy ( Aws::Vector< SortDefinition > &&  value)
inline

The value by which you want to sort the data.

The key represents cost and usage metrics. The following values are supported:

  • BlendedCost

  • UnblendedCost

  • AmortizedCost

  • NetAmortizedCost

  • NetUnblendedCost

  • UsageQuantity

  • NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When using SortBy, NextPageToken and SearchString are not supported.

Definition at line 279 of file GetTagsRequest.h.

◆ WithSortBy() [2/2]

GetTagsRequest& Aws::CostExplorer::Model::GetTagsRequest::WithSortBy ( const Aws::Vector< SortDefinition > &  value)
inline

The value by which you want to sort the data.

The key represents cost and usage metrics. The following values are supported:

  • BlendedCost

  • UnblendedCost

  • AmortizedCost

  • NetAmortizedCost

  • NetUnblendedCost

  • UsageQuantity

  • NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When using SortBy, NextPageToken and SearchString are not supported.

Definition at line 265 of file GetTagsRequest.h.

◆ WithTagKey() [1/3]

GetTagsRequest& Aws::CostExplorer::Model::GetTagsRequest::WithTagKey ( Aws::String &&  value)
inline

The key of the tag that you want to return values for.

Definition at line 170 of file GetTagsRequest.h.

◆ WithTagKey() [2/3]

GetTagsRequest& Aws::CostExplorer::Model::GetTagsRequest::WithTagKey ( const Aws::String value)
inline

The key of the tag that you want to return values for.

Definition at line 165 of file GetTagsRequest.h.

◆ WithTagKey() [3/3]

GetTagsRequest& Aws::CostExplorer::Model::GetTagsRequest::WithTagKey ( const char *  value)
inline

The key of the tag that you want to return values for.

Definition at line 175 of file GetTagsRequest.h.

◆ WithTimePeriod() [1/2]

GetTagsRequest& Aws::CostExplorer::Model::GetTagsRequest::WithTimePeriod ( const DateInterval value)
inline

The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

Definition at line 125 of file GetTagsRequest.h.

◆ WithTimePeriod() [2/2]

GetTagsRequest& Aws::CostExplorer::Model::GetTagsRequest::WithTimePeriod ( DateInterval &&  value)
inline

The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

Definition at line 134 of file GetTagsRequest.h.


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