Class DescribeExecutionResponse

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

  • Method Details

    • executionArn

      public final String executionArn()

      The Amazon Resource Name (ARN) that identifies the execution.

      Returns:
      The Amazon Resource Name (ARN) that identifies the execution.

    • stateMachineArn

      public final String stateMachineArn()

      The Amazon Resource Name (ARN) of the executed stated machine.

      Returns:
      The Amazon Resource Name (ARN) of the executed stated machine.

    • name

      public final String name()

      The name of the execution.

      A name must not contain:

      • white space

      • brackets < > { } [ ]

      • wildcard characters ? *

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

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

      • surrogates (U+D800-DFFF)

      • invalid characters ( U+10FFFF)

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

      Returns:
      The name of the execution.

      A name must not contain:

      • white space

      • brackets < > { } [ ]

      • wildcard characters ? *

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

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

      • surrogates (U+D800-DFFF)

      • invalid characters ( U+10FFFF)

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

    • status

      public final ExecutionStatus status()

      The current status of the execution.

      If the service returns an enum value that is not available in the current SDK version, status will return ExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the execution.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the execution.

      If the service returns an enum value that is not available in the current SDK version, status will return ExecutionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the execution.
      See Also:

    • startDate

      public final Instant startDate()

      The date the execution is started.

      Returns:
      The date the execution is started.

    • stopDate

      public final Instant stopDate()

      If the execution ended, the date the execution stopped.

      Returns:
      If the execution ended, the date the execution stopped.

    • input

      public final String input()

      The string that contains the JSON input data of the execution. 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 of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

    • inputDetails

      public final CloudWatchEventsExecutionDataDetails inputDetails()
      Returns the value of the InputDetails property for this object.
      Returns:
      The value of the InputDetails property for this object.

    • output

      public final String output()

      The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

      This field is set only if the execution succeeds. If the execution fails, this field is null.

      Returns:
      The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

      This field is set only if the execution succeeds. If the execution fails, this field is null.

    • outputDetails

      public final CloudWatchEventsExecutionDataDetails outputDetails()
      Returns the value of the OutputDetails property for this object.
      Returns:
      The value of the OutputDetails property for this object.

    • traceHeader

      public final String traceHeader()

      The X-Ray trace header that was passed to the execution.

      For X-Ray traces, all Amazon Web Services services use the X-Amzn-Trace-Id header from the HTTP request. Using the header is the preferred mechanism to identify a trace. StartExecution and StartSyncExecution API operations can also use traceHeader from the body of the request payload. If both sources are provided, Step Functions will use the header value (preferred) over the value in the request body.

      Returns:
      The X-Ray trace header that was passed to the execution.

      For X-Ray traces, all Amazon Web Services services use the X-Amzn-Trace-Id header from the HTTP request. Using the header is the preferred mechanism to identify a trace. StartExecution and StartSyncExecution API operations can also use traceHeader from the body of the request payload. If both sources are provided, Step Functions will use the header value (preferred) over the value in the request body.

    • mapRunArn

      public final String mapRunArn()

      The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.

      Returns:
      The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.

    • error

      public final String error()

      The error string if the state machine execution failed.

      Returns:
      The error string if the state machine execution failed.

    • cause

      public final String cause()

      The cause string if the state machine execution failed.

      Returns:
      The cause string if the state machine execution failed.

    • stateMachineVersionArn

      public final String stateMachineVersionArn()

      The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

      If you start an execution from a StartExecution request without specifying a state machine version or alias ARN, Step Functions returns a null value.

      Returns:
      The Amazon Resource Name (ARN) of the state machine version associated with the execution. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

      If you start an execution from a StartExecution request without specifying a state machine version or alias ARN, Step Functions returns a null value.

    • stateMachineAliasArn

      public final String stateMachineAliasArn()

      The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD.

      If you start an execution from a StartExecution request with a state machine version ARN, this field will be null.

      Returns:
      The Amazon Resource Name (ARN) of the state machine alias associated with the execution. The alias ARN is a combination of state machine ARN and the alias name separated by a colon (:). For example, stateMachineARN:PROD.

      If you start an execution from a StartExecution request with a state machine version ARN, this field will be null.

    • redriveCount

      public final Integer redriveCount()

      The number of times you've redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is only updated if you successfully redrive an execution.

      Returns:
      The number of times you've redriven an execution. If you have not yet redriven an execution, the redriveCount is 0. This count is only updated if you successfully redrive an execution.

    • redriveDate

      public final Instant redriveDate()

      The date the execution was last redriven. If you have not yet redriven an execution, the redriveDate is null.

      The redriveDate is unavailable if you redrive a Map Run that starts child workflow executions of type EXPRESS.

      Returns:
      The date the execution was last redriven. If you have not yet redriven an execution, the redriveDate is null.

      The redriveDate is unavailable if you redrive a Map Run that starts child workflow executions of type EXPRESS.

    • redriveStatus

      public final ExecutionRedriveStatus redriveStatus()

      Indicates whether or not an execution can be redriven at a given point in time.

      • For executions of type STANDARD, redriveStatus is NOT_REDRIVABLE if calling the RedriveExecution API action would return the ExecutionNotRedrivable error.

      • For a Distributed Map that includes child workflows of type STANDARD, redriveStatus indicates whether or not the Map Run can redrive child workflow executions.

      • For a Distributed Map that includes child workflows of type EXPRESS, redriveStatus indicates whether or not the Map Run can redrive child workflow executions.

        You can redrive failed or timed out EXPRESS workflows only if they're a part of a Map Run. When you redrive the Map Run, these workflows are restarted using the StartExecution API action.

      If the service returns an enum value that is not available in the current SDK version, redriveStatus will return ExecutionRedriveStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from redriveStatusAsString().

      Returns:
      Indicates whether or not an execution can be redriven at a given point in time.

      • For executions of type STANDARD, redriveStatus is NOT_REDRIVABLE if calling the RedriveExecution API action would return the ExecutionNotRedrivable error.

      • For a Distributed Map that includes child workflows of type STANDARD, redriveStatus indicates whether or not the Map Run can redrive child workflow executions.

      • For a Distributed Map that includes child workflows of type EXPRESS, redriveStatus indicates whether or not the Map Run can redrive child workflow executions.

        You can redrive failed or timed out EXPRESS workflows only if they're a part of a Map Run. When you redrive the Map Run, these workflows are restarted using the StartExecution API action.

      See Also:

    • redriveStatusAsString

      public final String redriveStatusAsString()

      Indicates whether or not an execution can be redriven at a given point in time.

      • For executions of type STANDARD, redriveStatus is NOT_REDRIVABLE if calling the RedriveExecution API action would return the ExecutionNotRedrivable error.

      • For a Distributed Map that includes child workflows of type STANDARD, redriveStatus indicates whether or not the Map Run can redrive child workflow executions.

      • For a Distributed Map that includes child workflows of type EXPRESS, redriveStatus indicates whether or not the Map Run can redrive child workflow executions.

        You can redrive failed or timed out EXPRESS workflows only if they're a part of a Map Run. When you redrive the Map Run, these workflows are restarted using the StartExecution API action.

      If the service returns an enum value that is not available in the current SDK version, redriveStatus will return ExecutionRedriveStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from redriveStatusAsString().

      Returns:
      Indicates whether or not an execution can be redriven at a given point in time.

      • For executions of type STANDARD, redriveStatus is NOT_REDRIVABLE if calling the RedriveExecution API action would return the ExecutionNotRedrivable error.

      • For a Distributed Map that includes child workflows of type STANDARD, redriveStatus indicates whether or not the Map Run can redrive child workflow executions.

      • For a Distributed Map that includes child workflows of type EXPRESS, redriveStatus indicates whether or not the Map Run can redrive child workflow executions.

        You can redrive failed or timed out EXPRESS workflows only if they're a part of a Map Run. When you redrive the Map Run, these workflows are restarted using the StartExecution API action.

      See Also:

    • redriveStatusReason

      public final String redriveStatusReason()

      When redriveStatus is NOT_REDRIVABLE, redriveStatusReason specifies the reason why an execution cannot be redriven.

      • For executions of type STANDARD, or for a Distributed Map that includes child workflows of type STANDARD, redriveStatusReason can include one of the following reasons:

        • State machine is in DELETING status.

        • Execution is RUNNING and cannot be redriven.

        • Execution is SUCCEEDED and cannot be redriven.

        • Execution was started before the launch of RedriveExecution.

        • Execution history event limit exceeded.

        • Execution has exceeded the max execution time.

        • Execution redrivable period exceeded.

      • For a Distributed Map that includes child workflows of type EXPRESS, redriveStatusReason is only returned if the child workflows are not redrivable. This happens when the child workflow executions have completed successfully.

      Returns:
      When redriveStatus is NOT_REDRIVABLE, redriveStatusReason specifies the reason why an execution cannot be redriven.

      • For executions of type STANDARD, or for a Distributed Map that includes child workflows of type STANDARD, redriveStatusReason can include one of the following reasons:

        • State machine is in DELETING status.

        • Execution is RUNNING and cannot be redriven.

        • Execution is SUCCEEDED and cannot be redriven.

        • Execution was started before the launch of RedriveExecution.

        • Execution history event limit exceeded.

        • Execution has exceeded the max execution time.

        • Execution redrivable period exceeded.

      • For a Distributed Map that includes child workflows of type EXPRESS, redriveStatusReason is only returned if the child workflows are not redrivable. This happens when the child workflow executions have completed successfully.

    • toBuilder

      public DescribeExecutionResponse.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<DescribeExecutionResponse.Builder,DescribeExecutionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeExecutionResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.