update_response_plan
¶
update_response_plan(
arn: Arn,
*,
config_overrides: Optional[SSMIncidentsClientConfig] = None,
client_token: Optional[ClientToken] = None,
display_name: Optional[ResponsePlanDisplayName] = None,
incident_template_title: Optional[IncidentTitle] = None,
incident_template_impact: Optional[Impact] = None,
incident_template_summary: Optional[IncidentSummary] = None,
incident_template_dedupe_string: Optional[DedupeString] = None,
incident_template_notification_targets: Optional[NotificationTargetSet] = None,
chat_channel: Optional[ChatChannel] = None,
engagements: Optional[EngagementSet] = None,
actions: Optional[ActionsList] = None,
incident_template_tags: Optional[TagMapUpdate] = None,
integrations: Optional[Integrations] = None,
) -> UpdateResponsePlanOutput
Updates the specified response plan.
Parameters:
-
client_token(Optional[ClientToken], default:None) –A token ensuring that the operation is called only once with the specified details.
-
arn(Arn) –The Amazon Resource Name (ARN) of the response plan.
-
display_name(Optional[ResponsePlanDisplayName], default:None) –The long format name of the response plan. The display name can't contain spaces.
-
incident_template_title(Optional[IncidentTitle], default:None) –The short format name of the incident. The title can't contain spaces.
-
incident_template_impact(Optional[Impact], default:None) –Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.
Supported impact codes
-
1- Critical -
2- High -
3- Medium -
4- Low -
5- No Impact
-
-
incident_template_summary(Optional[IncidentSummary], default:None) –A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps.
-
incident_template_dedupe_string(Optional[DedupeString], default:None) –The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.
-
incident_template_notification_targets(Optional[NotificationTargetSet], default:None) –The Amazon SNS targets that are notified when updates are made to an incident.
-
chat_channel(Optional[ChatChannel], default:None) –The Chatbot chat channel used for collaboration during an incident.
Use the empty structure to remove the chat channel from the response plan.
-
engagements(Optional[EngagementSet], default:None) –The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
-
actions(Optional[ActionsList], default:None) –The actions that this response plan takes at the beginning of an incident.
-
incident_template_tags(Optional[TagMapUpdate], default:None) –Tags to assign to the template. When the
StartIncidentAPI action is called, Incident Manager assigns the tags specified in the template to the incident. To call this action, you must also have permission to call theTagResourceAPI action for the incident record resource. -
integrations(Optional[Integrations], default:None) –Information about third-party services integrated into the response plan.
Raises:
-
AccessDeniedException–You don't have sufficient access to perform this operation.
-
ConflictException–Updating or deleting a resource causes an inconsistent state.
-
InternalServerException–The request processing has failed because of an unknown error, exception or failure.
-
ResourceNotFoundException–Request references a resource which doesn't exist.
-
ThrottlingException–The request was denied due to request throttling.
-
ValidationException–The input fails to satisfy the constraints specified by an Amazon Web Services service.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_ssm_incidents/_services/ssm_incidents.py
2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 | |