/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace SFN { namespace Model { /** */ class StartExecutionRequest : public SFNRequest { public: AWS_SFN_API StartExecutionRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "StartExecution"; } AWS_SFN_API Aws::String SerializePayload() const override; AWS_SFN_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

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

The * stateMachineArn parameter accepts one of the following inputs:

*
  • An unqualified state machine ARN – Refers to a state * machine ARN that isn't qualified with a version or alias ARN. The following is * an example of an unqualified state machine ARN.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> *

    Step Functions doesn't associate state machine executions that you start * with an unqualified ARN with a version. This is true even if that version uses * the same revision that the execution used.

  • A state machine * version ARN – Refers to a version ARN, which is a combination of state * machine ARN and the version number separated by a colon (:). The following is an * example of the ARN for version 10.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>:10 *

    Step Functions doesn't associate executions that you start with a * version ARN with any aliases that point to that version.

  • A * state machine alias ARN – Refers to an alias ARN, which is a combination of * state machine ARN and the alias name separated by a colon (:). The following is * an example of the ARN for an alias named PROD.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> *

    Step Functions associates executions that you start with an alias ARN * with that alias and the state machine version used for that execution.

  • *
*/ inline const Aws::String& GetStateMachineArn() const{ return m_stateMachineArn; } /** *

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

The * stateMachineArn parameter accepts one of the following inputs:

*
  • An unqualified state machine ARN – Refers to a state * machine ARN that isn't qualified with a version or alias ARN. The following is * an example of an unqualified state machine ARN.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> *

    Step Functions doesn't associate state machine executions that you start * with an unqualified ARN with a version. This is true even if that version uses * the same revision that the execution used.

  • A state machine * version ARN – Refers to a version ARN, which is a combination of state * machine ARN and the version number separated by a colon (:). The following is an * example of the ARN for version 10.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>:10 *

    Step Functions doesn't associate executions that you start with a * version ARN with any aliases that point to that version.

  • A * state machine alias ARN – Refers to an alias ARN, which is a combination of * state machine ARN and the alias name separated by a colon (:). The following is * an example of the ARN for an alias named PROD.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> *

    Step Functions associates executions that you start with an alias ARN * with that alias and the state machine version used for that execution.

  • *
*/ inline bool StateMachineArnHasBeenSet() const { return m_stateMachineArnHasBeenSet; } /** *

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

The * stateMachineArn parameter accepts one of the following inputs:

*
  • An unqualified state machine ARN – Refers to a state * machine ARN that isn't qualified with a version or alias ARN. The following is * an example of an unqualified state machine ARN.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> *

    Step Functions doesn't associate state machine executions that you start * with an unqualified ARN with a version. This is true even if that version uses * the same revision that the execution used.

  • A state machine * version ARN – Refers to a version ARN, which is a combination of state * machine ARN and the version number separated by a colon (:). The following is an * example of the ARN for version 10.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>:10 *

    Step Functions doesn't associate executions that you start with a * version ARN with any aliases that point to that version.

  • A * state machine alias ARN – Refers to an alias ARN, which is a combination of * state machine ARN and the alias name separated by a colon (:). The following is * an example of the ARN for an alias named PROD.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> *

    Step Functions associates executions that you start with an alias ARN * with that alias and the state machine version used for that execution.

  • *
*/ inline void SetStateMachineArn(const Aws::String& value) { m_stateMachineArnHasBeenSet = true; m_stateMachineArn = value; } /** *

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

The * stateMachineArn parameter accepts one of the following inputs:

*
  • An unqualified state machine ARN – Refers to a state * machine ARN that isn't qualified with a version or alias ARN. The following is * an example of an unqualified state machine ARN.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> *

    Step Functions doesn't associate state machine executions that you start * with an unqualified ARN with a version. This is true even if that version uses * the same revision that the execution used.

  • A state machine * version ARN – Refers to a version ARN, which is a combination of state * machine ARN and the version number separated by a colon (:). The following is an * example of the ARN for version 10.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>:10 *

    Step Functions doesn't associate executions that you start with a * version ARN with any aliases that point to that version.

  • A * state machine alias ARN – Refers to an alias ARN, which is a combination of * state machine ARN and the alias name separated by a colon (:). The following is * an example of the ARN for an alias named PROD.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> *

    Step Functions associates executions that you start with an alias ARN * with that alias and the state machine version used for that execution.

  • *
*/ inline void SetStateMachineArn(Aws::String&& value) { m_stateMachineArnHasBeenSet = true; m_stateMachineArn = std::move(value); } /** *

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

The * stateMachineArn parameter accepts one of the following inputs:

*
  • An unqualified state machine ARN – Refers to a state * machine ARN that isn't qualified with a version or alias ARN. The following is * an example of an unqualified state machine ARN.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> *

    Step Functions doesn't associate state machine executions that you start * with an unqualified ARN with a version. This is true even if that version uses * the same revision that the execution used.

  • A state machine * version ARN – Refers to a version ARN, which is a combination of state * machine ARN and the version number separated by a colon (:). The following is an * example of the ARN for version 10.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>:10 *

    Step Functions doesn't associate executions that you start with a * version ARN with any aliases that point to that version.

  • A * state machine alias ARN – Refers to an alias ARN, which is a combination of * state machine ARN and the alias name separated by a colon (:). The following is * an example of the ARN for an alias named PROD.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> *

    Step Functions associates executions that you start with an alias ARN * with that alias and the state machine version used for that execution.

  • *
*/ inline void SetStateMachineArn(const char* value) { m_stateMachineArnHasBeenSet = true; m_stateMachineArn.assign(value); } /** *

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

The * stateMachineArn parameter accepts one of the following inputs:

*
  • An unqualified state machine ARN – Refers to a state * machine ARN that isn't qualified with a version or alias ARN. The following is * an example of an unqualified state machine ARN.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> *

    Step Functions doesn't associate state machine executions that you start * with an unqualified ARN with a version. This is true even if that version uses * the same revision that the execution used.

  • A state machine * version ARN – Refers to a version ARN, which is a combination of state * machine ARN and the version number separated by a colon (:). The following is an * example of the ARN for version 10.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>:10 *

    Step Functions doesn't associate executions that you start with a * version ARN with any aliases that point to that version.

  • A * state machine alias ARN – Refers to an alias ARN, which is a combination of * state machine ARN and the alias name separated by a colon (:). The following is * an example of the ARN for an alias named PROD.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> *

    Step Functions associates executions that you start with an alias ARN * with that alias and the state machine version used for that execution.

  • *
*/ inline StartExecutionRequest& WithStateMachineArn(const Aws::String& value) { SetStateMachineArn(value); return *this;} /** *

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

The * stateMachineArn parameter accepts one of the following inputs:

*
  • An unqualified state machine ARN – Refers to a state * machine ARN that isn't qualified with a version or alias ARN. The following is * an example of an unqualified state machine ARN.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> *

    Step Functions doesn't associate state machine executions that you start * with an unqualified ARN with a version. This is true even if that version uses * the same revision that the execution used.

  • A state machine * version ARN – Refers to a version ARN, which is a combination of state * machine ARN and the version number separated by a colon (:). The following is an * example of the ARN for version 10.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>:10 *

    Step Functions doesn't associate executions that you start with a * version ARN with any aliases that point to that version.

  • A * state machine alias ARN – Refers to an alias ARN, which is a combination of * state machine ARN and the alias name separated by a colon (:). The following is * an example of the ARN for an alias named PROD.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> *

    Step Functions associates executions that you start with an alias ARN * with that alias and the state machine version used for that execution.

  • *
*/ inline StartExecutionRequest& WithStateMachineArn(Aws::String&& value) { SetStateMachineArn(std::move(value)); return *this;} /** *

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

The * stateMachineArn parameter accepts one of the following inputs:

*
  • An unqualified state machine ARN – Refers to a state * machine ARN that isn't qualified with a version or alias ARN. The following is * an example of an unqualified state machine ARN.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> *

    Step Functions doesn't associate state machine executions that you start * with an unqualified ARN with a version. This is true even if that version uses * the same revision that the execution used.

  • A state machine * version ARN – Refers to a version ARN, which is a combination of state * machine ARN and the version number separated by a colon (:). The following is an * example of the ARN for version 10.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>:10 *

    Step Functions doesn't associate executions that you start with a * version ARN with any aliases that point to that version.

  • A * state machine alias ARN – Refers to an alias ARN, which is a combination of * state machine ARN and the alias name separated by a colon (:). The following is * an example of the ARN for an alias named PROD.

    * arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> *

    Step Functions associates executions that you start with an alias ARN * with that alias and the state machine version used for that execution.

  • *
*/ inline StartExecutionRequest& WithStateMachineArn(const char* value) { SetStateMachineArn(value); return *this;} /** *

Optional name of the execution. This name must be unique for your Amazon Web * Services account, Region, and state machine for 90 days. For more information, * see * Limits Related to State Machine Executions in the 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 _.

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

Optional name of the execution. This name must be unique for your Amazon Web * Services account, Region, and state machine for 90 days. For more information, * see * Limits Related to State Machine Executions in the 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 _.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

Optional name of the execution. This name must be unique for your Amazon Web * Services account, Region, and state machine for 90 days. For more information, * see * Limits Related to State Machine Executions in the 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 _.

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

Optional name of the execution. This name must be unique for your Amazon Web * Services account, Region, and state machine for 90 days. For more information, * see * Limits Related to State Machine Executions in the 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 _.

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

Optional name of the execution. This name must be unique for your Amazon Web * Services account, Region, and state machine for 90 days. For more information, * see * Limits Related to State Machine Executions in the 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 _.

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

Optional name of the execution. This name must be unique for your Amazon Web * Services account, Region, and state machine for 90 days. For more information, * see * Limits Related to State Machine Executions in the 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 _.

*/ inline StartExecutionRequest& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

Optional name of the execution. This name must be unique for your Amazon Web * Services account, Region, and state machine for 90 days. For more information, * see * Limits Related to State Machine Executions in the 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 _.

*/ inline StartExecutionRequest& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

Optional name of the execution. This name must be unique for your Amazon Web * Services account, Region, and state machine for 90 days. For more information, * see * Limits Related to State Machine Executions in the 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 _.

*/ inline StartExecutionRequest& WithName(const char* value) { SetName(value); return *this;} /** *

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.

*/ inline const Aws::String& GetInput() const{ return m_input; } /** *

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.

*/ inline bool InputHasBeenSet() const { return m_inputHasBeenSet; } /** *

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.

*/ inline void SetInput(const Aws::String& value) { m_inputHasBeenSet = true; m_input = value; } /** *

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.

*/ inline void SetInput(Aws::String&& value) { m_inputHasBeenSet = true; m_input = std::move(value); } /** *

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.

*/ inline void SetInput(const char* value) { m_inputHasBeenSet = true; m_input.assign(value); } /** *

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.

*/ inline StartExecutionRequest& WithInput(const Aws::String& value) { SetInput(value); return *this;} /** *

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.

*/ inline StartExecutionRequest& WithInput(Aws::String&& value) { SetInput(std::move(value)); return *this;} /** *

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.

*/ inline StartExecutionRequest& WithInput(const char* value) { SetInput(value); return *this;} /** *

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

*/ inline const Aws::String& GetTraceHeader() const{ return m_traceHeader; } /** *

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

*/ inline bool TraceHeaderHasBeenSet() const { return m_traceHeaderHasBeenSet; } /** *

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

*/ inline void SetTraceHeader(const Aws::String& value) { m_traceHeaderHasBeenSet = true; m_traceHeader = value; } /** *

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

*/ inline void SetTraceHeader(Aws::String&& value) { m_traceHeaderHasBeenSet = true; m_traceHeader = std::move(value); } /** *

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

*/ inline void SetTraceHeader(const char* value) { m_traceHeaderHasBeenSet = true; m_traceHeader.assign(value); } /** *

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

*/ inline StartExecutionRequest& WithTraceHeader(const Aws::String& value) { SetTraceHeader(value); return *this;} /** *

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

*/ inline StartExecutionRequest& WithTraceHeader(Aws::String&& value) { SetTraceHeader(std::move(value)); return *this;} /** *

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

*/ inline StartExecutionRequest& WithTraceHeader(const char* value) { SetTraceHeader(value); return *this;} private: Aws::String m_stateMachineArn; bool m_stateMachineArnHasBeenSet = false; Aws::String m_name; bool m_nameHasBeenSet = false; Aws::String m_input; bool m_inputHasBeenSet = false; Aws::String m_traceHeader; bool m_traceHeaderHasBeenSet = false; }; } // namespace Model } // namespace SFN } // namespace Aws