Package software.amazon.awssdk.services.sfn.model

Interface StartExecutionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartExecutionRequest.Builder,StartExecutionRequest>, SdkBuilder<StartExecutionRequest.Builder,StartExecutionRequest>, SdkPojo, SdkRequest.Builder, SfnRequest.Builder
Enclosing class:
StartExecutionRequest
public static interface StartExecutionRequest.Builder extends SfnRequest.Builder, SdkPojo, CopyableBuilder<StartExecutionRequest.Builder,StartExecutionRequest>

  • Method Details

    • stateMachineArn

      StartExecutionRequest.Builder stateMachineArn(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      StartExecutionRequest.Builder name(String 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.

      If you don't provide a name for the execution, Step Functions automatically generates a universally unique identifier (UUID) as the execution name.

      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 _.

      Parameters:
      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.

      If you don't provide a name for the execution, Step Functions automatically generates a universally unique identifier (UUID) as the execution name.

      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 _.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • input

      StartExecutionRequest.Builder input(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • traceHeader

      StartExecutionRequest.Builder traceHeader(String traceHeader)

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

      Parameters:
      traceHeader - Passes the X-Ray trace header. The trace header can also be passed in the request payload.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StartExecutionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartExecutionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.