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

Class StartSyncExecutionRequest

    • Method Detail

      • stateMachineArn

        public final String stateMachineArn()

        The Amazon Resource Name (ARN) of the state machine to execute.

        Returns:
        The Amazon Resource Name (ARN) of the state machine to execute.

      • name

        public final String name()

        The name of the execution.

        Returns:
        The name of the execution.

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

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

        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.
        See Also:
        IncludedData

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

        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.
        See Also:
        IncludedData

      • 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