Class StartExecutionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.sfn.model.SfnRequest
software.amazon.awssdk.services.sfn.model.StartExecutionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartExecutionRequest.Builder,StartExecutionRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartExecutionRequest extends SfnRequest implements ToCopyableBuilder<StartExecutionRequest.Builder,StartExecutionRequest>

  • Method Details

    • stateMachineArn

      public final 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.

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

    • name

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

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

    • input

      public final 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.

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

    • traceHeader

      public final String traceHeader()

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

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

    • toBuilder

      public StartExecutionRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartExecutionRequest.Builder,StartExecutionRequest>
      Specified by:
      toBuilder in class SfnRequest
      Returns:
      a builder for type T

    • builder

      public static StartExecutionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartExecutionRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.