Struct aws_sdk_ssm::client::fluent_builders::SendAutomationSignal

source · [−]

pub struct SendAutomationSignal { /* private fields */ }

Expand description

Fluent builder constructing a request to SendAutomationSignal.

Sends a signal to an Automation execution to change the current behavior or status of the execution.

Implementations

source

impl SendAutomationSignal

source

pub async fn send(
self
) -> Result<SendAutomationSignalOutput, SdkError<SendAutomationSignalError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

source

pub fn automation_execution_id(self, input: impl Into<String>) -> Self

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

source

pub fn set_automation_execution_id(self, input: Option<String>) -> Self

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

source

pub fn signal_type(self, input: SignalType) -> Self

The type of signal to send to an Automation execution.

source

pub fn set_signal_type(self, input: Option<SignalType>) -> Self

The type of signal to send to an Automation execution.

source

pub fn payload(self, k: impl Into<String>, v: Vec<String>) -> Self

Adds a key-value pair to Payload.

To override the contents of this collection use set_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"

source

pub fn set_payload(self, input: Option<HashMap<String, Vec<String>>>) -> Self

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"

Trait Implementations

source

impl Clone for SendAutomationSignal

source

fn clone(&self) -> SendAutomationSignal

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl Debug for SendAutomationSignal

source

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl !RefUnwindSafe for SendAutomationSignal

impl Send for SendAutomationSignal

impl Sync for SendAutomationSignal

impl Unpin for SendAutomationSignal

impl !UnwindSafe for SendAutomationSignal

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct aws_sdk_ssm::client::fluent_builders::SendAutomationSignal

Implementations

impl SendAutomationSignal

pub async fn send( self) -> Result<SendAutomationSignalOutput, SdkError<SendAutomationSignalError>>

pub fn automation_execution_id(self, input: impl Into<String>) -> Self

pub fn set_automation_execution_id(self, input: Option<String>) -> Self

pub fn signal_type(self, input: SignalType) -> Self

pub fn set_signal_type(self, input: Option<SignalType>) -> Self

pub fn payload(self, k: impl Into<String>, v: Vec<String>) -> Self

pub fn set_payload(self, input: Option<HashMap<String, Vec<String>>>) -> Self

Trait Implementations

impl Clone for SendAutomationSignal

fn clone(&self) -> SendAutomationSignal

fn clone_from(&mut self, source: &Self)

impl Debug for SendAutomationSignal

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Auto Trait Implementations

impl !RefUnwindSafe for SendAutomationSignal

impl Send for SendAutomationSignal

impl Sync for SendAutomationSignal

impl Unpin for SendAutomationSignal

impl !UnwindSafe for SendAutomationSignal

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

pub async fn send(
self
) -> Result<SendAutomationSignalOutput, SdkError<SendAutomationSignalError>>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,