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

Class DescribeStateMachineRequest

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.DescribeStateMachineRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeStateMachineRequest.Builder,DescribeStateMachineRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeStateMachineRequest extends SfnRequest implements ToCopyableBuilder<DescribeStateMachineRequest.Builder,DescribeStateMachineRequest>

  • Method Details

    • stateMachineArn

      public final String stateMachineArn()

      The Amazon Resource Name (ARN) of the state machine for which you want the information.

      If you specify a state machine version ARN, this API returns details about that version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

      Returns:
      The Amazon Resource Name (ARN) of the state machine for which you want the information.

      If you specify a state machine version ARN, this API returns details about that version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1.

    • includedData

      public final IncludedData includedData()

      If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

      When calling a labelled ARN for an encrypted state machine, the includedData = METADATA_ONLY parameter will not apply because Step Functions needs to decrypt the entire state machine definition to get the Distributed Map state’s definition. In this case, the API caller needs to have kms:Decrypt permission.

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

      Returns:
      If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

      When calling a labelled ARN for an encrypted state machine, the includedData = METADATA_ONLY parameter will not apply because Step Functions needs to decrypt the entire state machine definition to get the Distributed Map state’s definition. In this case, the API caller needs to have kms:Decrypt permission.

      See Also:

    • includedDataAsString

      public final String includedDataAsString()

      If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

      When calling a labelled ARN for an encrypted state machine, the includedData = METADATA_ONLY parameter will not apply because Step Functions needs to decrypt the entire state machine definition to get the Distributed Map state’s definition. In this case, the API caller needs to have kms:Decrypt permission.

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

      Returns:
      If your state machine definition is encrypted with a KMS key, callers must have kms:Decrypt permission to decrypt the definition. Alternatively, you can call the API with includedData = METADATA_ONLY to get a successful response without the encrypted definition.

      When calling a labelled ARN for an encrypted state machine, the includedData = METADATA_ONLY parameter will not apply because Step Functions needs to decrypt the entire state machine definition to get the Distributed Map state’s definition. In this case, the API caller needs to have kms:Decrypt permission.

      See Also:

    • toBuilder

      public DescribeStateMachineRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeStateMachineRequest.Builder,DescribeStateMachineRequest>
      Specified by:
      toBuilder in class SfnRequest

    • builder

      public static DescribeStateMachineRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeStateMachineRequest.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo