AWS SDK for C++  1.9.16
AWS SDK for C++
Public Member Functions | List of all members
Aws::SFN::Model::ListExecutionsRequest Class Reference

#include <ListExecutionsRequest.h>

+ Inheritance diagram for Aws::SFN::Model::ListExecutionsRequest:

Public Member Functions

 ListExecutionsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetStateMachineArn () const
 
bool StateMachineArnHasBeenSet () const
 
void SetStateMachineArn (const Aws::String &value)
 
void SetStateMachineArn (Aws::String &&value)
 
void SetStateMachineArn (const char *value)
 
ListExecutionsRequestWithStateMachineArn (const Aws::String &value)
 
ListExecutionsRequestWithStateMachineArn (Aws::String &&value)
 
ListExecutionsRequestWithStateMachineArn (const char *value)
 
const ExecutionStatusGetStatusFilter () const
 
bool StatusFilterHasBeenSet () const
 
void SetStatusFilter (const ExecutionStatus &value)
 
void SetStatusFilter (ExecutionStatus &&value)
 
ListExecutionsRequestWithStatusFilter (const ExecutionStatus &value)
 
ListExecutionsRequestWithStatusFilter (ExecutionStatus &&value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListExecutionsRequestWithMaxResults (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)
 
ListExecutionsRequestWithNextToken (const Aws::String &value)
 
ListExecutionsRequestWithNextToken (Aws::String &&value)
 
ListExecutionsRequestWithNextToken (const char *value)
 
- Public Member Functions inherited from Aws::SFN::SFNRequest
virtual ~SFNRequest ()
 
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 22 of file ListExecutionsRequest.h.

Constructor & Destructor Documentation

◆ ListExecutionsRequest()

Aws::SFN::Model::ListExecutionsRequest::ListExecutionsRequest ( )

Member Function Documentation

◆ GetMaxResults()

int Aws::SFN::Model::ListExecutionsRequest::GetMaxResults ( ) const
inline

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

Definition at line 131 of file ListExecutionsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::SFN::Model::ListExecutionsRequest::GetNextToken ( ) const
inline

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Definition at line 169 of file ListExecutionsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SFN::Model::ListExecutionsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::SFN::SFNRequest.

◆ GetServiceRequestName()

virtual const char* Aws::SFN::Model::ListExecutionsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file ListExecutionsRequest.h.

◆ GetStateMachineArn()

const Aws::String& Aws::SFN::Model::ListExecutionsRequest::GetStateMachineArn ( ) const
inline

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

Definition at line 42 of file ListExecutionsRequest.h.

◆ GetStatusFilter()

const ExecutionStatus& Aws::SFN::Model::ListExecutionsRequest::GetStatusFilter ( ) const
inline

If specified, only list the executions whose current execution status matches the given filter.

Definition at line 91 of file ListExecutionsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::SFN::Model::ListExecutionsRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

Definition at line 140 of file ListExecutionsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::SFN::Model::ListExecutionsRequest::NextTokenHasBeenSet ( ) const
inline

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Definition at line 179 of file ListExecutionsRequest.h.

◆ SerializePayload()

Aws::String Aws::SFN::Model::ListExecutionsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetMaxResults()

void Aws::SFN::Model::ListExecutionsRequest::SetMaxResults ( int  value)
inline

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

Definition at line 149 of file ListExecutionsRequest.h.

◆ SetNextToken() [1/3]

void Aws::SFN::Model::ListExecutionsRequest::SetNextToken ( Aws::String &&  value)
inline

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Definition at line 199 of file ListExecutionsRequest.h.

◆ SetNextToken() [2/3]

void Aws::SFN::Model::ListExecutionsRequest::SetNextToken ( const Aws::String value)
inline

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Definition at line 189 of file ListExecutionsRequest.h.

◆ SetNextToken() [3/3]

void Aws::SFN::Model::ListExecutionsRequest::SetNextToken ( const char *  value)
inline

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Definition at line 209 of file ListExecutionsRequest.h.

◆ SetStateMachineArn() [1/3]

void Aws::SFN::Model::ListExecutionsRequest::SetStateMachineArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

Definition at line 60 of file ListExecutionsRequest.h.

◆ SetStateMachineArn() [2/3]

void Aws::SFN::Model::ListExecutionsRequest::SetStateMachineArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

Definition at line 54 of file ListExecutionsRequest.h.

◆ SetStateMachineArn() [3/3]

void Aws::SFN::Model::ListExecutionsRequest::SetStateMachineArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

Definition at line 66 of file ListExecutionsRequest.h.

◆ SetStatusFilter() [1/2]

void Aws::SFN::Model::ListExecutionsRequest::SetStatusFilter ( const ExecutionStatus value)
inline

If specified, only list the executions whose current execution status matches the given filter.

Definition at line 103 of file ListExecutionsRequest.h.

◆ SetStatusFilter() [2/2]

void Aws::SFN::Model::ListExecutionsRequest::SetStatusFilter ( ExecutionStatus &&  value)
inline

If specified, only list the executions whose current execution status matches the given filter.

Definition at line 109 of file ListExecutionsRequest.h.

◆ StateMachineArnHasBeenSet()

bool Aws::SFN::Model::ListExecutionsRequest::StateMachineArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

Definition at line 48 of file ListExecutionsRequest.h.

◆ StatusFilterHasBeenSet()

bool Aws::SFN::Model::ListExecutionsRequest::StatusFilterHasBeenSet ( ) const
inline

If specified, only list the executions whose current execution status matches the given filter.

Definition at line 97 of file ListExecutionsRequest.h.

◆ WithMaxResults()

ListExecutionsRequest& Aws::SFN::Model::ListExecutionsRequest::WithMaxResults ( int  value)
inline

The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

Definition at line 158 of file ListExecutionsRequest.h.

◆ WithNextToken() [1/3]

ListExecutionsRequest& Aws::SFN::Model::ListExecutionsRequest::WithNextToken ( Aws::String &&  value)
inline

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Definition at line 229 of file ListExecutionsRequest.h.

◆ WithNextToken() [2/3]

ListExecutionsRequest& Aws::SFN::Model::ListExecutionsRequest::WithNextToken ( const Aws::String value)
inline

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Definition at line 219 of file ListExecutionsRequest.h.

◆ WithNextToken() [3/3]

ListExecutionsRequest& Aws::SFN::Model::ListExecutionsRequest::WithNextToken ( const char *  value)
inline

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Definition at line 239 of file ListExecutionsRequest.h.

◆ WithStateMachineArn() [1/3]

ListExecutionsRequest& Aws::SFN::Model::ListExecutionsRequest::WithStateMachineArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

Definition at line 78 of file ListExecutionsRequest.h.

◆ WithStateMachineArn() [2/3]

ListExecutionsRequest& Aws::SFN::Model::ListExecutionsRequest::WithStateMachineArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

Definition at line 72 of file ListExecutionsRequest.h.

◆ WithStateMachineArn() [3/3]

ListExecutionsRequest& Aws::SFN::Model::ListExecutionsRequest::WithStateMachineArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the state machine whose executions is listed.

Definition at line 84 of file ListExecutionsRequest.h.

◆ WithStatusFilter() [1/2]

ListExecutionsRequest& Aws::SFN::Model::ListExecutionsRequest::WithStatusFilter ( const ExecutionStatus value)
inline

If specified, only list the executions whose current execution status matches the given filter.

Definition at line 115 of file ListExecutionsRequest.h.

◆ WithStatusFilter() [2/2]

ListExecutionsRequest& Aws::SFN::Model::ListExecutionsRequest::WithStatusFilter ( ExecutionStatus &&  value)
inline

If specified, only list the executions whose current execution status matches the given filter.

Definition at line 121 of file ListExecutionsRequest.h.


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