AWS SDK for C++  1.8.51
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest Class Reference

#include <DescribeEnvironmentsRequest.h>

+ Inheritance diagram for Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest:

Public Member Functions

 DescribeEnvironmentsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetApplicationName () const
 
bool ApplicationNameHasBeenSet () const
 
void SetApplicationName (const Aws::String &value)
 
void SetApplicationName (Aws::String &&value)
 
void SetApplicationName (const char *value)
 
DescribeEnvironmentsRequestWithApplicationName (const Aws::String &value)
 
DescribeEnvironmentsRequestWithApplicationName (Aws::String &&value)
 
DescribeEnvironmentsRequestWithApplicationName (const char *value)
 
const Aws::StringGetVersionLabel () const
 
bool VersionLabelHasBeenSet () const
 
void SetVersionLabel (const Aws::String &value)
 
void SetVersionLabel (Aws::String &&value)
 
void SetVersionLabel (const char *value)
 
DescribeEnvironmentsRequestWithVersionLabel (const Aws::String &value)
 
DescribeEnvironmentsRequestWithVersionLabel (Aws::String &&value)
 
DescribeEnvironmentsRequestWithVersionLabel (const char *value)
 
const Aws::Vector< Aws::String > & GetEnvironmentIds () const
 
bool EnvironmentIdsHasBeenSet () const
 
void SetEnvironmentIds (const Aws::Vector< Aws::String > &value)
 
void SetEnvironmentIds (Aws::Vector< Aws::String > &&value)
 
DescribeEnvironmentsRequestWithEnvironmentIds (const Aws::Vector< Aws::String > &value)
 
DescribeEnvironmentsRequestWithEnvironmentIds (Aws::Vector< Aws::String > &&value)
 
DescribeEnvironmentsRequestAddEnvironmentIds (const Aws::String &value)
 
DescribeEnvironmentsRequestAddEnvironmentIds (Aws::String &&value)
 
DescribeEnvironmentsRequestAddEnvironmentIds (const char *value)
 
const Aws::Vector< Aws::String > & GetEnvironmentNames () const
 
bool EnvironmentNamesHasBeenSet () const
 
void SetEnvironmentNames (const Aws::Vector< Aws::String > &value)
 
void SetEnvironmentNames (Aws::Vector< Aws::String > &&value)
 
DescribeEnvironmentsRequestWithEnvironmentNames (const Aws::Vector< Aws::String > &value)
 
DescribeEnvironmentsRequestWithEnvironmentNames (Aws::Vector< Aws::String > &&value)
 
DescribeEnvironmentsRequestAddEnvironmentNames (const Aws::String &value)
 
DescribeEnvironmentsRequestAddEnvironmentNames (Aws::String &&value)
 
DescribeEnvironmentsRequestAddEnvironmentNames (const char *value)
 
bool GetIncludeDeleted () const
 
bool IncludeDeletedHasBeenSet () const
 
void SetIncludeDeleted (bool value)
 
DescribeEnvironmentsRequestWithIncludeDeleted (bool value)
 
const Aws::Utils::DateTimeGetIncludedDeletedBackTo () const
 
bool IncludedDeletedBackToHasBeenSet () const
 
void SetIncludedDeletedBackTo (const Aws::Utils::DateTime &value)
 
void SetIncludedDeletedBackTo (Aws::Utils::DateTime &&value)
 
DescribeEnvironmentsRequestWithIncludedDeletedBackTo (const Aws::Utils::DateTime &value)
 
DescribeEnvironmentsRequestWithIncludedDeletedBackTo (Aws::Utils::DateTime &&value)
 
int GetMaxRecords () const
 
bool MaxRecordsHasBeenSet () const
 
void SetMaxRecords (int value)
 
DescribeEnvironmentsRequestWithMaxRecords (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)
 
DescribeEnvironmentsRequestWithNextToken (const Aws::String &value)
 
DescribeEnvironmentsRequestWithNextToken (Aws::String &&value)
 
DescribeEnvironmentsRequestWithNextToken (const char *value)
 
- Public Member Functions inherited from Aws::ElasticBeanstalk::ElasticBeanstalkRequest
virtual ~ElasticBeanstalkRequest ()
 
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::ElasticBeanstalk::ElasticBeanstalkRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Request to describe one or more environments.

See Also:

AWS API Reference

Definition at line 26 of file DescribeEnvironmentsRequest.h.

Constructor & Destructor Documentation

◆ DescribeEnvironmentsRequest()

Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::DescribeEnvironmentsRequest ( )

Member Function Documentation

◆ AddEnvironmentIds() [1/3]

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::AddEnvironmentIds ( const Aws::String value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

Definition at line 182 of file DescribeEnvironmentsRequest.h.

◆ AddEnvironmentIds() [2/3]

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::AddEnvironmentIds ( Aws::String &&  value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

Definition at line 188 of file DescribeEnvironmentsRequest.h.

◆ AddEnvironmentIds() [3/3]

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::AddEnvironmentIds ( const char *  value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

Definition at line 194 of file DescribeEnvironmentsRequest.h.

◆ AddEnvironmentNames() [1/3]

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::AddEnvironmentNames ( const Aws::String value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

Definition at line 237 of file DescribeEnvironmentsRequest.h.

◆ AddEnvironmentNames() [2/3]

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::AddEnvironmentNames ( Aws::String &&  value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

Definition at line 243 of file DescribeEnvironmentsRequest.h.

◆ AddEnvironmentNames() [3/3]

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::AddEnvironmentNames ( const char *  value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

Definition at line 249 of file DescribeEnvironmentsRequest.h.

◆ ApplicationNameHasBeenSet()

bool Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::ApplicationNameHasBeenSet ( ) const
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

Definition at line 54 of file DescribeEnvironmentsRequest.h.

◆ DumpBodyToUrl()

void Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::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.

◆ EnvironmentIdsHasBeenSet()

bool Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::EnvironmentIdsHasBeenSet ( ) const
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

Definition at line 152 of file DescribeEnvironmentsRequest.h.

◆ EnvironmentNamesHasBeenSet()

bool Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::EnvironmentNamesHasBeenSet ( ) const
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

Definition at line 207 of file DescribeEnvironmentsRequest.h.

◆ GetApplicationName()

const Aws::String& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::GetApplicationName ( ) const
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

Definition at line 48 of file DescribeEnvironmentsRequest.h.

◆ GetEnvironmentIds()

const Aws::Vector<Aws::String>& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::GetEnvironmentIds ( ) const
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

Definition at line 146 of file DescribeEnvironmentsRequest.h.

◆ GetEnvironmentNames()

const Aws::Vector<Aws::String>& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::GetEnvironmentNames ( ) const
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

Definition at line 201 of file DescribeEnvironmentsRequest.h.

◆ GetIncludedDeletedBackTo()

const Aws::Utils::DateTime& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::GetIncludedDeletedBackTo ( ) const
inline

If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

Definition at line 285 of file DescribeEnvironmentsRequest.h.

◆ GetIncludeDeleted()

bool Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::GetIncludeDeleted ( ) const
inline

Indicates whether to include deleted environments:

true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

false: Do not include deleted environments.

Definition at line 257 of file DescribeEnvironmentsRequest.h.

◆ GetMaxRecords()

int Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::GetMaxRecords ( ) const
inline

For a paginated request. Specify a maximum number of environments to include in each response.

If no MaxRecords is specified, all available environments are retrieved in a single response.

Definition at line 323 of file DescribeEnvironmentsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::GetNextToken ( ) const
inline

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

If no NextToken is specified, the first page is retrieved.

Definition at line 353 of file DescribeEnvironmentsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file DescribeEnvironmentsRequest.h.

◆ GetVersionLabel()

const Aws::String& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::GetVersionLabel ( ) const
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

Definition at line 97 of file DescribeEnvironmentsRequest.h.

◆ IncludedDeletedBackToHasBeenSet()

bool Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::IncludedDeletedBackToHasBeenSet ( ) const
inline

If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

Definition at line 291 of file DescribeEnvironmentsRequest.h.

◆ IncludeDeletedHasBeenSet()

bool Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::IncludeDeletedHasBeenSet ( ) const
inline

Indicates whether to include deleted environments:

true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

false: Do not include deleted environments.

Definition at line 264 of file DescribeEnvironmentsRequest.h.

◆ MaxRecordsHasBeenSet()

bool Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::MaxRecordsHasBeenSet ( ) const
inline

For a paginated request. Specify a maximum number of environments to include in each response.

If no MaxRecords is specified, all available environments are retrieved in a single response.

Definition at line 330 of file DescribeEnvironmentsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::NextTokenHasBeenSet ( ) const
inline

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

If no NextToken is specified, the first page is retrieved.

Definition at line 361 of file DescribeEnvironmentsRequest.h.

◆ SerializePayload()

Aws::String Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetApplicationName() [1/3]

void Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetApplicationName ( const Aws::String value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

Definition at line 60 of file DescribeEnvironmentsRequest.h.

◆ SetApplicationName() [2/3]

void Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetApplicationName ( Aws::String &&  value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

Definition at line 66 of file DescribeEnvironmentsRequest.h.

◆ SetApplicationName() [3/3]

void Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetApplicationName ( const char *  value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

Definition at line 72 of file DescribeEnvironmentsRequest.h.

◆ SetEnvironmentIds() [1/2]

void Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetEnvironmentIds ( const Aws::Vector< Aws::String > &  value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

Definition at line 158 of file DescribeEnvironmentsRequest.h.

◆ SetEnvironmentIds() [2/2]

void Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetEnvironmentIds ( Aws::Vector< Aws::String > &&  value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

Definition at line 164 of file DescribeEnvironmentsRequest.h.

◆ SetEnvironmentNames() [1/2]

void Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetEnvironmentNames ( const Aws::Vector< Aws::String > &  value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

Definition at line 213 of file DescribeEnvironmentsRequest.h.

◆ SetEnvironmentNames() [2/2]

void Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetEnvironmentNames ( Aws::Vector< Aws::String > &&  value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

Definition at line 219 of file DescribeEnvironmentsRequest.h.

◆ SetIncludedDeletedBackTo() [1/2]

void Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetIncludedDeletedBackTo ( const Aws::Utils::DateTime value)
inline

If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

Definition at line 297 of file DescribeEnvironmentsRequest.h.

◆ SetIncludedDeletedBackTo() [2/2]

void Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetIncludedDeletedBackTo ( Aws::Utils::DateTime &&  value)
inline

If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

Definition at line 303 of file DescribeEnvironmentsRequest.h.

◆ SetIncludeDeleted()

void Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetIncludeDeleted ( bool  value)
inline

Indicates whether to include deleted environments:

true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

false: Do not include deleted environments.

Definition at line 271 of file DescribeEnvironmentsRequest.h.

◆ SetMaxRecords()

void Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetMaxRecords ( int  value)
inline

For a paginated request. Specify a maximum number of environments to include in each response.

If no MaxRecords is specified, all available environments are retrieved in a single response.

Definition at line 337 of file DescribeEnvironmentsRequest.h.

◆ SetNextToken() [1/3]

void Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetNextToken ( const Aws::String value)
inline

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

If no NextToken is specified, the first page is retrieved.

Definition at line 369 of file DescribeEnvironmentsRequest.h.

◆ SetNextToken() [2/3]

void Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetNextToken ( Aws::String &&  value)
inline

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

If no NextToken is specified, the first page is retrieved.

Definition at line 377 of file DescribeEnvironmentsRequest.h.

◆ SetNextToken() [3/3]

void Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetNextToken ( const char *  value)
inline

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

If no NextToken is specified, the first page is retrieved.

Definition at line 385 of file DescribeEnvironmentsRequest.h.

◆ SetVersionLabel() [1/3]

void Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetVersionLabel ( const Aws::String value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

Definition at line 109 of file DescribeEnvironmentsRequest.h.

◆ SetVersionLabel() [2/3]

void Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetVersionLabel ( Aws::String &&  value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

Definition at line 115 of file DescribeEnvironmentsRequest.h.

◆ SetVersionLabel() [3/3]

void Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::SetVersionLabel ( const char *  value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

Definition at line 121 of file DescribeEnvironmentsRequest.h.

◆ VersionLabelHasBeenSet()

bool Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::VersionLabelHasBeenSet ( ) const
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

Definition at line 103 of file DescribeEnvironmentsRequest.h.

◆ WithApplicationName() [1/3]

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithApplicationName ( const Aws::String value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

Definition at line 78 of file DescribeEnvironmentsRequest.h.

◆ WithApplicationName() [2/3]

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithApplicationName ( Aws::String &&  value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

Definition at line 84 of file DescribeEnvironmentsRequest.h.

◆ WithApplicationName() [3/3]

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithApplicationName ( const char *  value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

Definition at line 90 of file DescribeEnvironmentsRequest.h.

◆ WithEnvironmentIds() [1/2]

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithEnvironmentIds ( const Aws::Vector< Aws::String > &  value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

Definition at line 170 of file DescribeEnvironmentsRequest.h.

◆ WithEnvironmentIds() [2/2]

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithEnvironmentIds ( Aws::Vector< Aws::String > &&  value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

Definition at line 176 of file DescribeEnvironmentsRequest.h.

◆ WithEnvironmentNames() [1/2]

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithEnvironmentNames ( const Aws::Vector< Aws::String > &  value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

Definition at line 225 of file DescribeEnvironmentsRequest.h.

◆ WithEnvironmentNames() [2/2]

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithEnvironmentNames ( Aws::Vector< Aws::String > &&  value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

Definition at line 231 of file DescribeEnvironmentsRequest.h.

◆ WithIncludedDeletedBackTo() [1/2]

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithIncludedDeletedBackTo ( const Aws::Utils::DateTime value)
inline

If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

Definition at line 309 of file DescribeEnvironmentsRequest.h.

◆ WithIncludedDeletedBackTo() [2/2]

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithIncludedDeletedBackTo ( Aws::Utils::DateTime &&  value)
inline

If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

Definition at line 315 of file DescribeEnvironmentsRequest.h.

◆ WithIncludeDeleted()

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithIncludeDeleted ( bool  value)
inline

Indicates whether to include deleted environments:

true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

false: Do not include deleted environments.

Definition at line 278 of file DescribeEnvironmentsRequest.h.

◆ WithMaxRecords()

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithMaxRecords ( int  value)
inline

For a paginated request. Specify a maximum number of environments to include in each response.

If no MaxRecords is specified, all available environments are retrieved in a single response.

Definition at line 344 of file DescribeEnvironmentsRequest.h.

◆ WithNextToken() [1/3]

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithNextToken ( const Aws::String value)
inline

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

If no NextToken is specified, the first page is retrieved.

Definition at line 393 of file DescribeEnvironmentsRequest.h.

◆ WithNextToken() [2/3]

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithNextToken ( Aws::String &&  value)
inline

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

If no NextToken is specified, the first page is retrieved.

Definition at line 401 of file DescribeEnvironmentsRequest.h.

◆ WithNextToken() [3/3]

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithNextToken ( const char *  value)
inline

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

If no NextToken is specified, the first page is retrieved.

Definition at line 409 of file DescribeEnvironmentsRequest.h.

◆ WithVersionLabel() [1/3]

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithVersionLabel ( const Aws::String value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

Definition at line 127 of file DescribeEnvironmentsRequest.h.

◆ WithVersionLabel() [2/3]

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithVersionLabel ( Aws::String &&  value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

Definition at line 133 of file DescribeEnvironmentsRequest.h.

◆ WithVersionLabel() [3/3]

DescribeEnvironmentsRequest& Aws::ElasticBeanstalk::Model::DescribeEnvironmentsRequest::WithVersionLabel ( const char *  value)
inline

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

Definition at line 139 of file DescribeEnvironmentsRequest.h.


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