Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SSMContacts.StopEngagement

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.

Synopsis

Creating a Request

data StopEngagement Source #

See: newStopEngagement smart constructor.

Constructors

StopEngagement'
Fields reason :: Maybe Text The reason that you're stopping the engagement. engagementId :: Text The Amazon Resource Name (ARN) of the engagement.

Instances

Instances details

Eq StopEngagement Source #
Instance details Defined in Amazonka.SSMContacts.StopEngagement Methods (==) :: StopEngagement -> StopEngagement -> Bool # (/=) :: StopEngagement -> StopEngagement -> Bool #
Read StopEngagement Source #
Instance details Defined in Amazonka.SSMContacts.StopEngagement Methods readsPrec :: Int -> ReadS StopEngagement # readList :: ReadS [StopEngagement] # readPrec :: ReadPrec StopEngagement # readListPrec :: ReadPrec [StopEngagement] #
Show StopEngagement Source #
Instance details Defined in Amazonka.SSMContacts.StopEngagement Methods showsPrec :: Int -> StopEngagement -> ShowS # show :: StopEngagement -> String # showList :: [StopEngagement] -> ShowS #
Generic StopEngagement Source #
Instance details Defined in Amazonka.SSMContacts.StopEngagement Associated Types type Rep StopEngagement :: Type -> Type # Methods from :: StopEngagement -> Rep StopEngagement x # to :: Rep StopEngagement x -> StopEngagement #
NFData StopEngagement Source #
Instance details Defined in Amazonka.SSMContacts.StopEngagement Methods rnf :: StopEngagement -> () #
Hashable StopEngagement Source #
Instance details Defined in Amazonka.SSMContacts.StopEngagement Methods hashWithSalt :: Int -> StopEngagement -> Int # hash :: StopEngagement -> Int #
ToJSON StopEngagement Source #
Instance details Defined in Amazonka.SSMContacts.StopEngagement Methods toJSON :: StopEngagement -> Value # toEncoding :: StopEngagement -> Encoding # toJSONList :: [StopEngagement] -> Value # toEncodingList :: [StopEngagement] -> Encoding #
AWSRequest StopEngagement Source #
Instance details Defined in Amazonka.SSMContacts.StopEngagement Associated Types type AWSResponse StopEngagement # Methods request :: StopEngagement -> Request StopEngagement # response :: MonadResource m => Logger -> Service -> Proxy StopEngagement -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopEngagement))) #
ToHeaders StopEngagement Source #
Instance details Defined in Amazonka.SSMContacts.StopEngagement Methods toHeaders :: StopEngagement -> [Header] #
ToPath StopEngagement Source #
Instance details Defined in Amazonka.SSMContacts.StopEngagement Methods toPath :: StopEngagement -> ByteString #
ToQuery StopEngagement Source #
Instance details Defined in Amazonka.SSMContacts.StopEngagement Methods toQuery :: StopEngagement -> QueryString #
type Rep StopEngagement Source #
Instance details Defined in Amazonka.SSMContacts.StopEngagement type Rep StopEngagement = D1 ('MetaData "StopEngagement" "Amazonka.SSMContacts.StopEngagement" "libZSservicesZSamazonka-ssm-contactsZSamazonka-ssm-contacts" 'False) (C1 ('MetaCons "StopEngagement'" 'PrefixI 'True) (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "engagementId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse StopEngagement Source #
Instance details Defined in Amazonka.SSMContacts.StopEngagement type AWSResponse StopEngagement = StopEngagementResponse

newStopEngagement Source #

Arguments

:: Text	`$sel:engagementId:StopEngagement'`
-> StopEngagement

Create a value of StopEngagement 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:reason:StopEngagement', stopEngagement_reason - The reason that you're stopping the engagement.

$sel:engagementId:StopEngagement', stopEngagement_engagementId - The Amazon Resource Name (ARN) of the engagement.

Request Lenses

stopEngagement_reason :: Lens' StopEngagement (Maybe Text) Source #

The reason that you're stopping the engagement.

stopEngagement_engagementId :: Lens' StopEngagement Text Source #

The Amazon Resource Name (ARN) of the engagement.

Destructuring the Response

data StopEngagementResponse Source #

See: newStopEngagementResponse smart constructor.

Constructors

StopEngagementResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Eq StopEngagementResponse Source #
Instance details Defined in Amazonka.SSMContacts.StopEngagement Methods (==) :: StopEngagementResponse -> StopEngagementResponse -> Bool # (/=) :: StopEngagementResponse -> StopEngagementResponse -> Bool #
Read StopEngagementResponse Source #
Instance details Defined in Amazonka.SSMContacts.StopEngagement Methods readsPrec :: Int -> ReadS StopEngagementResponse # readList :: ReadS [StopEngagementResponse] # readPrec :: ReadPrec StopEngagementResponse # readListPrec :: ReadPrec [StopEngagementResponse] #
Show StopEngagementResponse Source #
Instance details Defined in Amazonka.SSMContacts.StopEngagement Methods showsPrec :: Int -> StopEngagementResponse -> ShowS # show :: StopEngagementResponse -> String # showList :: [StopEngagementResponse] -> ShowS #
Generic StopEngagementResponse Source #
Instance details Defined in Amazonka.SSMContacts.StopEngagement Associated Types type Rep StopEngagementResponse :: Type -> Type # Methods from :: StopEngagementResponse -> Rep StopEngagementResponse x # to :: Rep StopEngagementResponse x -> StopEngagementResponse #
NFData StopEngagementResponse Source #
Instance details Defined in Amazonka.SSMContacts.StopEngagement Methods rnf :: StopEngagementResponse -> () #
type Rep StopEngagementResponse Source #
Instance details Defined in Amazonka.SSMContacts.StopEngagement type Rep StopEngagementResponse = D1 ('MetaData "StopEngagementResponse" "Amazonka.SSMContacts.StopEngagement" "libZSservicesZSamazonka-ssm-contactsZSamazonka-ssm-contacts" 'False) (C1 ('MetaCons "StopEngagementResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStopEngagementResponse Source #

Arguments

:: Int	`$sel:httpStatus:StopEngagementResponse'`
-> StopEngagementResponse

Create a value of StopEngagementResponse 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:StopEngagementResponse', stopEngagementResponse_httpStatus - The response's http status code.

Response Lenses

stopEngagementResponse_httpStatus :: Lens' StopEngagementResponse Int Source #

The response's http status code.