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

#include <StartExecutionRequest.h>

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

Public Member Functions

 StartExecutionRequest ()
 
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)
 
StartExecutionRequestWithStateMachineArn (const Aws::String &value)
 
StartExecutionRequestWithStateMachineArn (Aws::String &&value)
 
StartExecutionRequestWithStateMachineArn (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
StartExecutionRequestWithName (const Aws::String &value)
 
StartExecutionRequestWithName (Aws::String &&value)
 
StartExecutionRequestWithName (const char *value)
 
const Aws::StringGetInput () const
 
bool InputHasBeenSet () const
 
void SetInput (const Aws::String &value)
 
void SetInput (Aws::String &&value)
 
void SetInput (const char *value)
 
StartExecutionRequestWithInput (const Aws::String &value)
 
StartExecutionRequestWithInput (Aws::String &&value)
 
StartExecutionRequestWithInput (const char *value)
 
const Aws::StringGetTraceHeader () const
 
bool TraceHeaderHasBeenSet () const
 
void SetTraceHeader (const Aws::String &value)
 
void SetTraceHeader (Aws::String &&value)
 
void SetTraceHeader (const char *value)
 
StartExecutionRequestWithTraceHeader (const Aws::String &value)
 
StartExecutionRequestWithTraceHeader (Aws::String &&value)
 
StartExecutionRequestWithTraceHeader (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 21 of file StartExecutionRequest.h.

Constructor & Destructor Documentation

◆ StartExecutionRequest()

Aws::SFN::Model::StartExecutionRequest::StartExecutionRequest ( )

Member Function Documentation

◆ GetInput()

const Aws::String& Aws::SFN::Model::StartExecutionRequest::GetInput ( ) const
inline

The string that contains the JSON input data for the execution, for example:

"input": "{\"first_name" : "test"}"

If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

Definition at line 207 of file StartExecutionRequest.h.

◆ GetName()

const Aws::String& Aws::SFN::Model::StartExecutionRequest::GetName ( ) const
inline

The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

A name must not contain:

  • white space

  • brackets < > { } [ ]

  • wildcard characters ? *

  • special characters " # % \ ^ | ~ ` $ & , ; : /

  • control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Definition at line 91 of file StartExecutionRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::SFN::SFNRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file StartExecutionRequest.h.

◆ GetStateMachineArn()

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

The Amazon Resource Name (ARN) of the state machine to execute.

Definition at line 40 of file StartExecutionRequest.h.

◆ GetTraceHeader()

const Aws::String& Aws::SFN::Model::StartExecutionRequest::GetTraceHeader ( ) const
inline

Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

Definition at line 284 of file StartExecutionRequest.h.

◆ InputHasBeenSet()

bool Aws::SFN::Model::StartExecutionRequest::InputHasBeenSet ( ) const
inline

The string that contains the JSON input data for the execution, for example:

"input": "{\"first_name" : "test"}"

If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

Definition at line 217 of file StartExecutionRequest.h.

◆ NameHasBeenSet()

bool Aws::SFN::Model::StartExecutionRequest::NameHasBeenSet ( ) const
inline

The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

A name must not contain:

  • white space

  • brackets < > { } [ ]

  • wildcard characters ? *

  • special characters " # % \ ^ | ~ ` $ & , ; : /

  • control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Definition at line 106 of file StartExecutionRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetInput() [1/3]

void Aws::SFN::Model::StartExecutionRequest::SetInput ( Aws::String &&  value)
inline

The string that contains the JSON input data for the execution, for example:

"input": "{\"first_name" : "test"}"

If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

Definition at line 237 of file StartExecutionRequest.h.

◆ SetInput() [2/3]

void Aws::SFN::Model::StartExecutionRequest::SetInput ( const Aws::String value)
inline

The string that contains the JSON input data for the execution, for example:

"input": "{\"first_name" : "test"}"

If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

Definition at line 227 of file StartExecutionRequest.h.

◆ SetInput() [3/3]

void Aws::SFN::Model::StartExecutionRequest::SetInput ( const char *  value)
inline

The string that contains the JSON input data for the execution, for example:

"input": "{\"first_name" : "test"}"

If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

Definition at line 247 of file StartExecutionRequest.h.

◆ SetName() [1/3]

void Aws::SFN::Model::StartExecutionRequest::SetName ( Aws::String &&  value)
inline

The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

A name must not contain:

  • white space

  • brackets < > { } [ ]

  • wildcard characters ? *

  • special characters " # % \ ^ | ~ ` $ & , ; : /

  • control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Definition at line 136 of file StartExecutionRequest.h.

◆ SetName() [2/3]

void Aws::SFN::Model::StartExecutionRequest::SetName ( const Aws::String value)
inline

The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

A name must not contain:

  • white space

  • brackets < > { } [ ]

  • wildcard characters ? *

  • special characters " # % \ ^ | ~ ` $ & , ; : /

  • control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Definition at line 121 of file StartExecutionRequest.h.

◆ SetName() [3/3]

void Aws::SFN::Model::StartExecutionRequest::SetName ( const char *  value)
inline

The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

A name must not contain:

  • white space

  • brackets < > { } [ ]

  • wildcard characters ? *

  • special characters " # % \ ^ | ~ ` $ & , ; : /

  • control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Definition at line 151 of file StartExecutionRequest.h.

◆ SetStateMachineArn() [1/3]

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

The Amazon Resource Name (ARN) of the state machine to execute.

Definition at line 55 of file StartExecutionRequest.h.

◆ SetStateMachineArn() [2/3]

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

The Amazon Resource Name (ARN) of the state machine to execute.

Definition at line 50 of file StartExecutionRequest.h.

◆ SetStateMachineArn() [3/3]

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

The Amazon Resource Name (ARN) of the state machine to execute.

Definition at line 60 of file StartExecutionRequest.h.

◆ SetTraceHeader() [1/3]

void Aws::SFN::Model::StartExecutionRequest::SetTraceHeader ( Aws::String &&  value)
inline

Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

Definition at line 302 of file StartExecutionRequest.h.

◆ SetTraceHeader() [2/3]

void Aws::SFN::Model::StartExecutionRequest::SetTraceHeader ( const Aws::String value)
inline

Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

Definition at line 296 of file StartExecutionRequest.h.

◆ SetTraceHeader() [3/3]

void Aws::SFN::Model::StartExecutionRequest::SetTraceHeader ( const char *  value)
inline

Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

Definition at line 308 of file StartExecutionRequest.h.

◆ StateMachineArnHasBeenSet()

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

The Amazon Resource Name (ARN) of the state machine to execute.

Definition at line 45 of file StartExecutionRequest.h.

◆ TraceHeaderHasBeenSet()

bool Aws::SFN::Model::StartExecutionRequest::TraceHeaderHasBeenSet ( ) const
inline

Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

Definition at line 290 of file StartExecutionRequest.h.

◆ WithInput() [1/3]

StartExecutionRequest& Aws::SFN::Model::StartExecutionRequest::WithInput ( Aws::String &&  value)
inline

The string that contains the JSON input data for the execution, for example:

"input": "{\"first_name" : "test"}"

If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

Definition at line 267 of file StartExecutionRequest.h.

◆ WithInput() [2/3]

StartExecutionRequest& Aws::SFN::Model::StartExecutionRequest::WithInput ( const Aws::String value)
inline

The string that contains the JSON input data for the execution, for example:

"input": "{\"first_name" : "test"}"

If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

Definition at line 257 of file StartExecutionRequest.h.

◆ WithInput() [3/3]

StartExecutionRequest& Aws::SFN::Model::StartExecutionRequest::WithInput ( const char *  value)
inline

The string that contains the JSON input data for the execution, for example:

"input": "{\"first_name" : "test"}"

If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

Definition at line 277 of file StartExecutionRequest.h.

◆ WithName() [1/3]

StartExecutionRequest& Aws::SFN::Model::StartExecutionRequest::WithName ( Aws::String &&  value)
inline

The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

A name must not contain:

  • white space

  • brackets < > { } [ ]

  • wildcard characters ? *

  • special characters " # % \ ^ | ~ ` $ & , ; : /

  • control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Definition at line 181 of file StartExecutionRequest.h.

◆ WithName() [2/3]

StartExecutionRequest& Aws::SFN::Model::StartExecutionRequest::WithName ( const Aws::String value)
inline

The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

A name must not contain:

  • white space

  • brackets < > { } [ ]

  • wildcard characters ? *

  • special characters " # % \ ^ | ~ ` $ & , ; : /

  • control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Definition at line 166 of file StartExecutionRequest.h.

◆ WithName() [3/3]

StartExecutionRequest& Aws::SFN::Model::StartExecutionRequest::WithName ( const char *  value)
inline

The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

A name must not contain:

  • white space

  • brackets < > { } [ ]

  • wildcard characters ? *

  • special characters " # % \ ^ | ~ ` $ & , ; : /

  • control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

Definition at line 196 of file StartExecutionRequest.h.

◆ WithStateMachineArn() [1/3]

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

The Amazon Resource Name (ARN) of the state machine to execute.

Definition at line 70 of file StartExecutionRequest.h.

◆ WithStateMachineArn() [2/3]

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

The Amazon Resource Name (ARN) of the state machine to execute.

Definition at line 65 of file StartExecutionRequest.h.

◆ WithStateMachineArn() [3/3]

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

The Amazon Resource Name (ARN) of the state machine to execute.

Definition at line 75 of file StartExecutionRequest.h.

◆ WithTraceHeader() [1/3]

StartExecutionRequest& Aws::SFN::Model::StartExecutionRequest::WithTraceHeader ( Aws::String &&  value)
inline

Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

Definition at line 320 of file StartExecutionRequest.h.

◆ WithTraceHeader() [2/3]

StartExecutionRequest& Aws::SFN::Model::StartExecutionRequest::WithTraceHeader ( const Aws::String value)
inline

Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

Definition at line 314 of file StartExecutionRequest.h.

◆ WithTraceHeader() [3/3]

StartExecutionRequest& Aws::SFN::Model::StartExecutionRequest::WithTraceHeader ( const char *  value)
inline

Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

Definition at line 326 of file StartExecutionRequest.h.


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