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.SSMIncidents.CreateResponsePlan

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a response plan that automates the initial response to incidents. A response plan engages contacts, starts chat channel collaboration, and initiates runbooks at the beginning of an incident.

Synopsis

data CreateResponsePlan = CreateResponsePlan' {
- clientToken :: Maybe Text
- actions :: Maybe [Action]
- displayName :: Maybe Text
- chatChannel :: Maybe ChatChannel
- engagements :: Maybe [Text]
- tags :: Maybe (HashMap Text Text)
- incidentTemplate :: IncidentTemplate
- name :: Text
}
newCreateResponsePlan :: IncidentTemplate -> Text -> CreateResponsePlan
createResponsePlan_clientToken :: Lens' CreateResponsePlan (Maybe Text)
createResponsePlan_actions :: Lens' CreateResponsePlan (Maybe [Action])
createResponsePlan_displayName :: Lens' CreateResponsePlan (Maybe Text)
createResponsePlan_chatChannel :: Lens' CreateResponsePlan (Maybe ChatChannel)
createResponsePlan_engagements :: Lens' CreateResponsePlan (Maybe [Text])
createResponsePlan_tags :: Lens' CreateResponsePlan (Maybe (HashMap Text Text))
createResponsePlan_incidentTemplate :: Lens' CreateResponsePlan IncidentTemplate
createResponsePlan_name :: Lens' CreateResponsePlan Text
data CreateResponsePlanResponse = CreateResponsePlanResponse' {
- httpStatus :: Int
- arn :: Text
}
newCreateResponsePlanResponse :: Int -> Text -> CreateResponsePlanResponse
createResponsePlanResponse_httpStatus :: Lens' CreateResponsePlanResponse Int
createResponsePlanResponse_arn :: Lens' CreateResponsePlanResponse Text

Creating a Request

data CreateResponsePlan Source #

See: newCreateResponsePlan smart constructor.

Constructors

CreateResponsePlan'

Fields

clientToken :: Maybe Text
A token ensuring that the action is called only once with the specified details.
actions :: Maybe [Action]
The actions that the response plan starts at the beginning of an incident.
displayName :: Maybe Text
The long format of the response plan name. This field can contain spaces.
chatChannel :: Maybe ChatChannel
The AWS Chatbot chat channel used for collaboration during an incident.
engagements :: Maybe [Text]
The contacts and escalation plans that the response plan engages during an incident.
tags :: Maybe (HashMap Text Text)
A list of tags that you are adding to the response plan.
incidentTemplate :: IncidentTemplate
Details used to create an incident when using this response plan.
name :: Text
The short format name of the response plan. Can't include spaces.

Instances

Instances details

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

newCreateResponsePlan Source #

Arguments

:: IncidentTemplate	`$sel:incidentTemplate:CreateResponsePlan'`
-> Text	`$sel:name:CreateResponsePlan'`
-> CreateResponsePlan

Create a value of CreateResponsePlan 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:clientToken:CreateResponsePlan', createResponsePlan_clientToken - A token ensuring that the action is called only once with the specified details.

$sel:actions:CreateResponsePlan', createResponsePlan_actions - The actions that the response plan starts at the beginning of an incident.

$sel:displayName:CreateResponsePlan', createResponsePlan_displayName - The long format of the response plan name. This field can contain spaces.

$sel:chatChannel:CreateResponsePlan', createResponsePlan_chatChannel - The AWS Chatbot chat channel used for collaboration during an incident.

$sel:engagements:CreateResponsePlan', createResponsePlan_engagements - The contacts and escalation plans that the response plan engages during an incident.

$sel:tags:CreateResponsePlan', createResponsePlan_tags - A list of tags that you are adding to the response plan.

$sel:incidentTemplate:CreateResponsePlan', createResponsePlan_incidentTemplate - Details used to create an incident when using this response plan.

$sel:name:CreateResponsePlan', createResponsePlan_name - The short format name of the response plan. Can't include spaces.

Request Lenses

createResponsePlan_clientToken :: Lens' CreateResponsePlan (Maybe Text) Source #

A token ensuring that the action is called only once with the specified details.

createResponsePlan_actions :: Lens' CreateResponsePlan (Maybe [Action]) Source #

The actions that the response plan starts at the beginning of an incident.

createResponsePlan_displayName :: Lens' CreateResponsePlan (Maybe Text) Source #

The long format of the response plan name. This field can contain spaces.

createResponsePlan_chatChannel :: Lens' CreateResponsePlan (Maybe ChatChannel) Source #

The AWS Chatbot chat channel used for collaboration during an incident.

createResponsePlan_engagements :: Lens' CreateResponsePlan (Maybe [Text]) Source #

The contacts and escalation plans that the response plan engages during an incident.

createResponsePlan_tags :: Lens' CreateResponsePlan (Maybe (HashMap Text Text)) Source #

A list of tags that you are adding to the response plan.

createResponsePlan_incidentTemplate :: Lens' CreateResponsePlan IncidentTemplate Source #

Details used to create an incident when using this response plan.

createResponsePlan_name :: Lens' CreateResponsePlan Text Source #

The short format name of the response plan. Can't include spaces.

Destructuring the Response

data CreateResponsePlanResponse Source #

See: newCreateResponsePlanResponse smart constructor.

Constructors

CreateResponsePlanResponse'
Fields httpStatus :: Int The response's http status code. arn :: Text The Amazon Resource Name (ARN) of the response plan.

Instances

Instances details

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

newCreateResponsePlanResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateResponsePlanResponse'`
-> Text	`$sel:arn:CreateResponsePlanResponse'`
-> CreateResponsePlanResponse

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

$sel:arn:CreateResponsePlanResponse', createResponsePlanResponse_arn - The Amazon Resource Name (ARN) of the response plan.

Response Lenses

createResponsePlanResponse_httpStatus :: Lens' CreateResponsePlanResponse Int Source #

The response's http status code.

createResponsePlanResponse_arn :: Lens' CreateResponsePlanResponse Text Source #

The Amazon Resource Name (ARN) of the response plan.