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

Interface StartSyncExecutionRequest.Builder

    • Method Detail

      • stateMachineArn

        StartSyncExecutionRequest.Builder stateMachineArn​(String stateMachineArn)

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

        Parameters:
        stateMachineArn - The Amazon Resource Name (ARN) of the state machine to execute.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        StartSyncExecutionRequest.Builder name​(String name)

        The name of the execution.

        Parameters:
        name - The name of the execution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • input

        StartSyncExecutionRequest.Builder input​(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.

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

      • traceHeader

        StartSyncExecutionRequest.Builder traceHeader​(String traceHeader)

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

        Parameters:
        traceHeader - Passes the X-Ray trace header. The trace header can also be passed in the request payload.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • includedData

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

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

      • includedData

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

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