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

Interface DescribeStateMachineRequest.Builder

    • Method Detail

      • stateMachineArn

        DescribeStateMachineRequest.Builder stateMachineArn​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • includedData

        DescribeStateMachineRequest.Builder includedData​(String 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.

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

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

      • includedData

        DescribeStateMachineRequest.Builder includedData​(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.

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

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