amazonka-ssm-2.0: Amazon Simple Systems Manager (SSM) SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SSM.SendAutomationSignal

Description

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

Synopsis

Creating a Request

data SendAutomationSignal Source #

See: newSendAutomationSignal smart constructor.

Constructors

SendAutomationSignal' 

Fields

  • payload :: Maybe (HashMap Text [Text])

    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"
  • automationExecutionId :: Text

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

  • signalType :: SignalType

    The type of signal to send to an Automation execution.

Instances

Instances details
ToJSON SendAutomationSignal Source # 
Instance details

Defined in Amazonka.SSM.SendAutomationSignal

Methods

toJSON :: SendAutomationSignal -> Value #

toEncoding :: SendAutomationSignal -> Encoding #

toJSONList :: [SendAutomationSignal] -> Value #

toEncodingList :: [SendAutomationSignal] -> Encoding #

ToHeaders SendAutomationSignal Source # 
Instance details

Defined in Amazonka.SSM.SendAutomationSignal

Methods

toHeaders :: SendAutomationSignal -> [Header] #

ToPath SendAutomationSignal Source # 
Instance details

Defined in Amazonka.SSM.SendAutomationSignal

Methods

toPath :: SendAutomationSignal -> ByteString #

ToQuery SendAutomationSignal Source # 
Instance details

Defined in Amazonka.SSM.SendAutomationSignal

Methods

toQuery :: SendAutomationSignal -> QueryString #

AWSRequest SendAutomationSignal Source # 
Instance details

Defined in Amazonka.SSM.SendAutomationSignal

Associated Types

type AWSResponse SendAutomationSignal #

Methods

request :: (Service -> Service) -> SendAutomationSignal -> Request SendAutomationSignal #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SendAutomationSignal -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendAutomationSignal))) #

Generic SendAutomationSignal Source # 
Instance details

Defined in Amazonka.SSM.SendAutomationSignal

Associated Types

type Rep SendAutomationSignal :: Type -> Type #

Methods

from :: SendAutomationSignal -> Rep SendAutomationSignal x #

to :: Rep SendAutomationSignal x -> SendAutomationSignal #

Read SendAutomationSignal Source # 
Instance details

Defined in Amazonka.SSM.SendAutomationSignal

Methods

readsPrec :: Int -> ReadS SendAutomationSignal #

readList :: ReadS [SendAutomationSignal] #

readPrec :: ReadPrec SendAutomationSignal #

readListPrec :: ReadPrec [SendAutomationSignal] #

Show SendAutomationSignal Source # 
Instance details

Defined in Amazonka.SSM.SendAutomationSignal

Methods

showsPrec :: Int -> SendAutomationSignal -> ShowS #

show :: SendAutomationSignal -> String #

showList :: [SendAutomationSignal] -> ShowS #

NFData SendAutomationSignal Source # 
Instance details

Defined in Amazonka.SSM.SendAutomationSignal

Methods

rnf :: SendAutomationSignal -> () #

Eq SendAutomationSignal Source # 
Instance details

Defined in Amazonka.SSM.SendAutomationSignal

Methods

(==) :: SendAutomationSignal -> SendAutomationSignal -> Bool #

(/=) :: SendAutomationSignal -> SendAutomationSignal -> Bool #

Hashable SendAutomationSignal Source # 
Instance details

Defined in Amazonka.SSM.SendAutomationSignal

Methods

hashWithSalt :: Int -> SendAutomationSignal -> Int #

hash :: SendAutomationSignal -> Int #

type AWSResponse SendAutomationSignal Source # 
Instance details

Defined in Amazonka.SSM.SendAutomationSignal

type AWSResponse SendAutomationSignal = SendAutomationSignalResponse
type Rep SendAutomationSignal Source # 
Instance details

Defined in Amazonka.SSM.SendAutomationSignal

type Rep SendAutomationSignal = D1 ('MetaData "SendAutomationSignal" "Amazonka.SSM.SendAutomationSignal" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "SendAutomationSignal'" 'PrefixI 'True) (S1 ('MetaSel ('Just "payload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: (S1 ('MetaSel ('Just "automationExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "signalType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SignalType))))

newSendAutomationSignal Source #

Arguments

:: Text

SendAutomationSignal

-> SignalType

$sel:signalType:SendAutomationSignal'

-> SendAutomationSignal 

Create a value of SendAutomationSignal with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

SendAutomationSignal, sendAutomationSignal_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"

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

$sel:signalType:SendAutomationSignal', sendAutomationSignal_signalType - The type of signal to send to an Automation execution.

Request Lenses

sendAutomationSignal_payload :: Lens' SendAutomationSignal (Maybe (HashMap Text [Text])) Source #

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"

sendAutomationSignal_automationExecutionId :: Lens' SendAutomationSignal Text Source #

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

sendAutomationSignal_signalType :: Lens' SendAutomationSignal SignalType Source #

The type of signal to send to an Automation execution.

Destructuring the Response

data SendAutomationSignalResponse Source #

See: newSendAutomationSignalResponse smart constructor.

Constructors

SendAutomationSignalResponse' 

Fields

Instances

Instances details
Generic SendAutomationSignalResponse Source # 
Instance details

Defined in Amazonka.SSM.SendAutomationSignal

Associated Types

type Rep SendAutomationSignalResponse :: Type -> Type #

Methods

from :: SendAutomationSignalResponse -> Rep SendAutomationSignalResponse x #

to :: Rep SendAutomationSignalResponse x -> SendAutomationSignalResponse #

Read SendAutomationSignalResponse Source # 
Instance details

Defined in Amazonka.SSM.SendAutomationSignal

Methods

readsPrec :: Int -> ReadS SendAutomationSignalResponse #

readList :: ReadS [SendAutomationSignalResponse] #

readPrec :: ReadPrec SendAutomationSignalResponse #

readListPrec :: ReadPrec [SendAutomationSignalResponse] #

Show SendAutomationSignalResponse Source # 
Instance details

Defined in Amazonka.SSM.SendAutomationSignal

Methods

showsPrec :: Int -> SendAutomationSignalResponse -> ShowS #

show :: SendAutomationSignalResponse -> String #

showList :: [SendAutomationSignalResponse] -> ShowS #

NFData SendAutomationSignalResponse Source # 
Instance details

Defined in Amazonka.SSM.SendAutomationSignal

Methods

rnf :: SendAutomationSignalResponse -> () #

Eq SendAutomationSignalResponse Source # 
Instance details

Defined in Amazonka.SSM.SendAutomationSignal

Methods

(==) :: SendAutomationSignalResponse -> SendAutomationSignalResponse -> Bool #

(/=) :: SendAutomationSignalResponse -> SendAutomationSignalResponse -> Bool #

type Rep SendAutomationSignalResponse Source # 
Instance details

Defined in Amazonka.SSM.SendAutomationSignal

type Rep SendAutomationSignalResponse = D1 ('MetaData "SendAutomationSignalResponse" "Amazonka.SSM.SendAutomationSignal" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "SendAutomationSignalResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSendAutomationSignalResponse Source #

Arguments

:: Int

$sel:httpStatus:SendAutomationSignalResponse'

-> SendAutomationSignalResponse 

Create a value of SendAutomationSignalResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:SendAutomationSignalResponse', sendAutomationSignalResponse_httpStatus - The response's http status code.

Response Lenses

sendAutomationSignalResponse_httpStatus :: Lens' SendAutomationSignalResponse Int Source #

The response's http status code.