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

#include <GetExecutionHistoryRequest.h>

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

Public Member Functions

 GetExecutionHistoryRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetExecutionArn () const
 
bool ExecutionArnHasBeenSet () const
 
void SetExecutionArn (const Aws::String &value)
 
void SetExecutionArn (Aws::String &&value)
 
void SetExecutionArn (const char *value)
 
GetExecutionHistoryRequestWithExecutionArn (const Aws::String &value)
 
GetExecutionHistoryRequestWithExecutionArn (Aws::String &&value)
 
GetExecutionHistoryRequestWithExecutionArn (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
GetExecutionHistoryRequestWithMaxResults (int value)
 
bool GetReverseOrder () const
 
bool ReverseOrderHasBeenSet () const
 
void SetReverseOrder (bool value)
 
GetExecutionHistoryRequestWithReverseOrder (bool value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
GetExecutionHistoryRequestWithNextToken (const Aws::String &value)
 
GetExecutionHistoryRequestWithNextToken (Aws::String &&value)
 
GetExecutionHistoryRequestWithNextToken (const char *value)
 
bool GetIncludeExecutionData () const
 
bool IncludeExecutionDataHasBeenSet () const
 
void SetIncludeExecutionData (bool value)
 
GetExecutionHistoryRequestWithIncludeExecutionData (bool 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 21 of file GetExecutionHistoryRequest.h.

Constructor & Destructor Documentation

◆ GetExecutionHistoryRequest()

Aws::SFN::Model::GetExecutionHistoryRequest::GetExecutionHistoryRequest ( )

Member Function Documentation

◆ ExecutionArnHasBeenSet()

bool Aws::SFN::Model::GetExecutionHistoryRequest::ExecutionArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the execution.

Definition at line 45 of file GetExecutionHistoryRequest.h.

◆ GetExecutionArn()

const Aws::String& Aws::SFN::Model::GetExecutionHistoryRequest::GetExecutionArn ( ) const
inline

The Amazon Resource Name (ARN) of the execution.

Definition at line 40 of file GetExecutionHistoryRequest.h.

◆ GetIncludeExecutionData()

bool Aws::SFN::Model::GetExecutionHistoryRequest::GetIncludeExecutionData ( ) const
inline

You can select whether execution data (input or output of a history event) is returned. The default is true.

Definition at line 221 of file GetExecutionHistoryRequest.h.

◆ GetMaxResults()

int Aws::SFN::Model::GetExecutionHistoryRequest::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 85 of file GetExecutionHistoryRequest.h.

◆ GetNextToken()

const Aws::String& Aws::SFN::Model::GetExecutionHistoryRequest::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 144 of file GetExecutionHistoryRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::SFN::SFNRequest.

◆ GetReverseOrder()

bool Aws::SFN::Model::GetExecutionHistoryRequest::GetReverseOrder ( ) const
inline

Lists events in descending order of their timeStamp.

Definition at line 118 of file GetExecutionHistoryRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file GetExecutionHistoryRequest.h.

◆ IncludeExecutionDataHasBeenSet()

bool Aws::SFN::Model::GetExecutionHistoryRequest::IncludeExecutionDataHasBeenSet ( ) const
inline

You can select whether execution data (input or output of a history event) is returned. The default is true.

Definition at line 227 of file GetExecutionHistoryRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::SFN::Model::GetExecutionHistoryRequest::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 94 of file GetExecutionHistoryRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::SFN::Model::GetExecutionHistoryRequest::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 154 of file GetExecutionHistoryRequest.h.

◆ ReverseOrderHasBeenSet()

bool Aws::SFN::Model::GetExecutionHistoryRequest::ReverseOrderHasBeenSet ( ) const
inline

Lists events in descending order of their timeStamp.

Definition at line 123 of file GetExecutionHistoryRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetExecutionArn() [1/3]

void Aws::SFN::Model::GetExecutionHistoryRequest::SetExecutionArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the execution.

Definition at line 55 of file GetExecutionHistoryRequest.h.

◆ SetExecutionArn() [2/3]

void Aws::SFN::Model::GetExecutionHistoryRequest::SetExecutionArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the execution.

Definition at line 50 of file GetExecutionHistoryRequest.h.

◆ SetExecutionArn() [3/3]

void Aws::SFN::Model::GetExecutionHistoryRequest::SetExecutionArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the execution.

Definition at line 60 of file GetExecutionHistoryRequest.h.

◆ SetIncludeExecutionData()

void Aws::SFN::Model::GetExecutionHistoryRequest::SetIncludeExecutionData ( bool  value)
inline

You can select whether execution data (input or output of a history event) is returned. The default is true.

Definition at line 233 of file GetExecutionHistoryRequest.h.

◆ SetMaxResults()

void Aws::SFN::Model::GetExecutionHistoryRequest::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 103 of file GetExecutionHistoryRequest.h.

◆ SetNextToken() [1/3]

void Aws::SFN::Model::GetExecutionHistoryRequest::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 174 of file GetExecutionHistoryRequest.h.

◆ SetNextToken() [2/3]

void Aws::SFN::Model::GetExecutionHistoryRequest::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 164 of file GetExecutionHistoryRequest.h.

◆ SetNextToken() [3/3]

void Aws::SFN::Model::GetExecutionHistoryRequest::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 184 of file GetExecutionHistoryRequest.h.

◆ SetReverseOrder()

void Aws::SFN::Model::GetExecutionHistoryRequest::SetReverseOrder ( bool  value)
inline

Lists events in descending order of their timeStamp.

Definition at line 128 of file GetExecutionHistoryRequest.h.

◆ WithExecutionArn() [1/3]

GetExecutionHistoryRequest& Aws::SFN::Model::GetExecutionHistoryRequest::WithExecutionArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the execution.

Definition at line 70 of file GetExecutionHistoryRequest.h.

◆ WithExecutionArn() [2/3]

GetExecutionHistoryRequest& Aws::SFN::Model::GetExecutionHistoryRequest::WithExecutionArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the execution.

Definition at line 65 of file GetExecutionHistoryRequest.h.

◆ WithExecutionArn() [3/3]

GetExecutionHistoryRequest& Aws::SFN::Model::GetExecutionHistoryRequest::WithExecutionArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the execution.

Definition at line 75 of file GetExecutionHistoryRequest.h.

◆ WithIncludeExecutionData()

GetExecutionHistoryRequest& Aws::SFN::Model::GetExecutionHistoryRequest::WithIncludeExecutionData ( bool  value)
inline

You can select whether execution data (input or output of a history event) is returned. The default is true.

Definition at line 239 of file GetExecutionHistoryRequest.h.

◆ WithMaxResults()

GetExecutionHistoryRequest& Aws::SFN::Model::GetExecutionHistoryRequest::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 112 of file GetExecutionHistoryRequest.h.

◆ WithNextToken() [1/3]

GetExecutionHistoryRequest& Aws::SFN::Model::GetExecutionHistoryRequest::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 204 of file GetExecutionHistoryRequest.h.

◆ WithNextToken() [2/3]

GetExecutionHistoryRequest& Aws::SFN::Model::GetExecutionHistoryRequest::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 194 of file GetExecutionHistoryRequest.h.

◆ WithNextToken() [3/3]

GetExecutionHistoryRequest& Aws::SFN::Model::GetExecutionHistoryRequest::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 214 of file GetExecutionHistoryRequest.h.

◆ WithReverseOrder()

GetExecutionHistoryRequest& Aws::SFN::Model::GetExecutionHistoryRequest::WithReverseOrder ( bool  value)
inline

Lists events in descending order of their timeStamp.

Definition at line 133 of file GetExecutionHistoryRequest.h.


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