AWS SDK for C++  1.7.342
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::EC2::Model::DescribePlacementGroupsRequest Class Reference

#include <DescribePlacementGroupsRequest.h>

+ Inheritance diagram for Aws::EC2::Model::DescribePlacementGroupsRequest:

Public Member Functions

 DescribePlacementGroupsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
DescribePlacementGroupsRequestWithFilters (const Aws::Vector< Filter > &value)
 
DescribePlacementGroupsRequestWithFilters (Aws::Vector< Filter > &&value)
 
DescribePlacementGroupsRequestAddFilters (const Filter &value)
 
DescribePlacementGroupsRequestAddFilters (Filter &&value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
DescribePlacementGroupsRequestWithDryRun (bool value)
 
const Aws::Vector< Aws::String > & GetGroupNames () const
 
bool GroupNamesHasBeenSet () const
 
void SetGroupNames (const Aws::Vector< Aws::String > &value)
 
void SetGroupNames (Aws::Vector< Aws::String > &&value)
 
DescribePlacementGroupsRequestWithGroupNames (const Aws::Vector< Aws::String > &value)
 
DescribePlacementGroupsRequestWithGroupNames (Aws::Vector< Aws::String > &&value)
 
DescribePlacementGroupsRequestAddGroupNames (const Aws::String &value)
 
DescribePlacementGroupsRequestAddGroupNames (Aws::String &&value)
 
DescribePlacementGroupsRequestAddGroupNames (const char *value)
 
const Aws::Vector< Aws::String > & GetGroupIds () const
 
bool GroupIdsHasBeenSet () const
 
void SetGroupIds (const Aws::Vector< Aws::String > &value)
 
void SetGroupIds (Aws::Vector< Aws::String > &&value)
 
DescribePlacementGroupsRequestWithGroupIds (const Aws::Vector< Aws::String > &value)
 
DescribePlacementGroupsRequestWithGroupIds (Aws::Vector< Aws::String > &&value)
 
DescribePlacementGroupsRequestAddGroupIds (const Aws::String &value)
 
DescribePlacementGroupsRequestAddGroupIds (Aws::String &&value)
 
DescribePlacementGroupsRequestAddGroupIds (const char *value)
 
- Public Member Functions inherited from Aws::EC2::EC2Request
virtual ~EC2Request ()
 
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
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::EC2::EC2Request
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 33 of file DescribePlacementGroupsRequest.h.

Constructor & Destructor Documentation

◆ DescribePlacementGroupsRequest()

Aws::EC2::Model::DescribePlacementGroupsRequest::DescribePlacementGroupsRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

DescribePlacementGroupsRequest& Aws::EC2::Model::DescribePlacementGroupsRequest::AddFilters ( const Filter value)
inline

The filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster | spread | partition).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

Definition at line 175 of file DescribePlacementGroupsRequest.h.

◆ AddFilters() [2/2]

DescribePlacementGroupsRequest& Aws::EC2::Model::DescribePlacementGroupsRequest::AddFilters ( Filter &&  value)
inline

The filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster | spread | partition).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

Definition at line 193 of file DescribePlacementGroupsRequest.h.

◆ AddGroupIds() [1/3]

DescribePlacementGroupsRequest& Aws::EC2::Model::DescribePlacementGroupsRequest::AddGroupIds ( const Aws::String value)
inline

The IDs of the placement groups.

Definition at line 317 of file DescribePlacementGroupsRequest.h.

◆ AddGroupIds() [2/3]

DescribePlacementGroupsRequest& Aws::EC2::Model::DescribePlacementGroupsRequest::AddGroupIds ( Aws::String &&  value)
inline

The IDs of the placement groups.

Definition at line 322 of file DescribePlacementGroupsRequest.h.

◆ AddGroupIds() [3/3]

DescribePlacementGroupsRequest& Aws::EC2::Model::DescribePlacementGroupsRequest::AddGroupIds ( const char *  value)
inline

The IDs of the placement groups.

Definition at line 327 of file DescribePlacementGroupsRequest.h.

◆ AddGroupNames() [1/3]

DescribePlacementGroupsRequest& Aws::EC2::Model::DescribePlacementGroupsRequest::AddGroupNames ( const Aws::String value)
inline

The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

Definition at line 269 of file DescribePlacementGroupsRequest.h.

◆ AddGroupNames() [2/3]

DescribePlacementGroupsRequest& Aws::EC2::Model::DescribePlacementGroupsRequest::AddGroupNames ( Aws::String &&  value)
inline

The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

Definition at line 275 of file DescribePlacementGroupsRequest.h.

◆ AddGroupNames() [3/3]

DescribePlacementGroupsRequest& Aws::EC2::Model::DescribePlacementGroupsRequest::AddGroupNames ( const char *  value)
inline

The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

Definition at line 281 of file DescribePlacementGroupsRequest.h.

◆ DryRunHasBeenSet()

bool Aws::EC2::Model::DescribePlacementGroupsRequest::DryRunHasBeenSet ( ) const
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 210 of file DescribePlacementGroupsRequest.h.

◆ DumpBodyToUrl()

void Aws::EC2::Model::DescribePlacementGroupsRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ FiltersHasBeenSet()

bool Aws::EC2::Model::DescribePlacementGroupsRequest::FiltersHasBeenSet ( ) const
inline

The filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster | spread | partition).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

Definition at line 85 of file DescribePlacementGroupsRequest.h.

◆ GetDryRun()

bool Aws::EC2::Model::DescribePlacementGroupsRequest::GetDryRun ( ) const
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 202 of file DescribePlacementGroupsRequest.h.

◆ GetFilters()

const Aws::Vector<Filter>& Aws::EC2::Model::DescribePlacementGroupsRequest::GetFilters ( ) const
inline

The filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster | spread | partition).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

Definition at line 67 of file DescribePlacementGroupsRequest.h.

◆ GetGroupIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribePlacementGroupsRequest::GetGroupIds ( ) const
inline

The IDs of the placement groups.

Definition at line 287 of file DescribePlacementGroupsRequest.h.

◆ GetGroupNames()

const Aws::Vector<Aws::String>& Aws::EC2::Model::DescribePlacementGroupsRequest::GetGroupNames ( ) const
inline

The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

Definition at line 233 of file DescribePlacementGroupsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::EC2::Model::DescribePlacementGroupsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 42 of file DescribePlacementGroupsRequest.h.

◆ GroupIdsHasBeenSet()

bool Aws::EC2::Model::DescribePlacementGroupsRequest::GroupIdsHasBeenSet ( ) const
inline

The IDs of the placement groups.

Definition at line 292 of file DescribePlacementGroupsRequest.h.

◆ GroupNamesHasBeenSet()

bool Aws::EC2::Model::DescribePlacementGroupsRequest::GroupNamesHasBeenSet ( ) const
inline

The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

Definition at line 239 of file DescribePlacementGroupsRequest.h.

◆ SerializePayload()

Aws::String Aws::EC2::Model::DescribePlacementGroupsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDryRun()

void Aws::EC2::Model::DescribePlacementGroupsRequest::SetDryRun ( bool  value)
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 218 of file DescribePlacementGroupsRequest.h.

◆ SetFilters() [1/2]

void Aws::EC2::Model::DescribePlacementGroupsRequest::SetFilters ( const Aws::Vector< Filter > &  value)
inline

The filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster | spread | partition).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

Definition at line 103 of file DescribePlacementGroupsRequest.h.

◆ SetFilters() [2/2]

void Aws::EC2::Model::DescribePlacementGroupsRequest::SetFilters ( Aws::Vector< Filter > &&  value)
inline

The filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster | spread | partition).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

Definition at line 121 of file DescribePlacementGroupsRequest.h.

◆ SetGroupIds() [1/2]

void Aws::EC2::Model::DescribePlacementGroupsRequest::SetGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

The IDs of the placement groups.

Definition at line 297 of file DescribePlacementGroupsRequest.h.

◆ SetGroupIds() [2/2]

void Aws::EC2::Model::DescribePlacementGroupsRequest::SetGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

The IDs of the placement groups.

Definition at line 302 of file DescribePlacementGroupsRequest.h.

◆ SetGroupNames() [1/2]

void Aws::EC2::Model::DescribePlacementGroupsRequest::SetGroupNames ( const Aws::Vector< Aws::String > &  value)
inline

The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

Definition at line 245 of file DescribePlacementGroupsRequest.h.

◆ SetGroupNames() [2/2]

void Aws::EC2::Model::DescribePlacementGroupsRequest::SetGroupNames ( Aws::Vector< Aws::String > &&  value)
inline

The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

Definition at line 251 of file DescribePlacementGroupsRequest.h.

◆ WithDryRun()

DescribePlacementGroupsRequest& Aws::EC2::Model::DescribePlacementGroupsRequest::WithDryRun ( bool  value)
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 226 of file DescribePlacementGroupsRequest.h.

◆ WithFilters() [1/2]

DescribePlacementGroupsRequest& Aws::EC2::Model::DescribePlacementGroupsRequest::WithFilters ( const Aws::Vector< Filter > &  value)
inline

The filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster | spread | partition).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

Definition at line 139 of file DescribePlacementGroupsRequest.h.

◆ WithFilters() [2/2]

DescribePlacementGroupsRequest& Aws::EC2::Model::DescribePlacementGroupsRequest::WithFilters ( Aws::Vector< Filter > &&  value)
inline

The filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster | spread | partition).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

Definition at line 157 of file DescribePlacementGroupsRequest.h.

◆ WithGroupIds() [1/2]

DescribePlacementGroupsRequest& Aws::EC2::Model::DescribePlacementGroupsRequest::WithGroupIds ( const Aws::Vector< Aws::String > &  value)
inline

The IDs of the placement groups.

Definition at line 307 of file DescribePlacementGroupsRequest.h.

◆ WithGroupIds() [2/2]

DescribePlacementGroupsRequest& Aws::EC2::Model::DescribePlacementGroupsRequest::WithGroupIds ( Aws::Vector< Aws::String > &&  value)
inline

The IDs of the placement groups.

Definition at line 312 of file DescribePlacementGroupsRequest.h.

◆ WithGroupNames() [1/2]

DescribePlacementGroupsRequest& Aws::EC2::Model::DescribePlacementGroupsRequest::WithGroupNames ( const Aws::Vector< Aws::String > &  value)
inline

The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

Definition at line 257 of file DescribePlacementGroupsRequest.h.

◆ WithGroupNames() [2/2]

DescribePlacementGroupsRequest& Aws::EC2::Model::DescribePlacementGroupsRequest::WithGroupNames ( Aws::Vector< Aws::String > &&  value)
inline

The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

Definition at line 263 of file DescribePlacementGroupsRequest.h.


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