Package software.amazon.awssdk.services.ssm.model

Interface SendAutomationSignalRequest.Builder

    • Method Detail

      • automationExecutionId

        SendAutomationSignalRequest.Builder automationExecutionId​(String automationExecutionId)

        The unique identifier for an existing Automation execution that you want to send the signal to.

        Parameters:
        automationExecutionId - The unique identifier for an existing Automation execution that you want to send the signal to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • signalType

        SendAutomationSignalRequest.Builder signalType​(String signalType)

        The type of signal to send to an Automation execution.

        Parameters:
        signalType - The type of signal to send to an Automation execution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SignalType, SignalType

      • signalType

        SendAutomationSignalRequest.Builder signalType​(SignalType signalType)

        The type of signal to send to an Automation execution.

        Parameters:
        signalType - The type of signal to send to an Automation execution.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SignalType, SignalType

      • payload

        SendAutomationSignalRequest.Builder payload​(Map<String,​? extends Collection<String>> payload)

        The data sent with the signal. The data schema depends on the type of signal used in the request.

        For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

        Comment="Looks good"

        For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

        StepName="step1"

        For the StopStep signal type, you must send the step execution ID as the payload. For example:

        StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"

        Parameters:
        payload - The data sent with the signal. The data schema depends on the type of signal used in the request.

        For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

        Comment="Looks good"

        For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

        StepName="step1"

        For the StopStep signal type, you must send the step execution ID as the payload. For example:

        StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"

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