update_incident_record
¶
update_incident_record(
arn: Arn,
*,
config_overrides: Optional[SSMIncidentsClientConfig] = None,
client_token: Optional[ClientToken] = None,
title: Optional[IncidentTitle] = None,
summary: Optional[IncidentSummary] = None,
impact: Optional[Impact] = None,
status: Optional[IncidentRecordStatus] = None,
chat_channel: Optional[ChatChannel] = None,
notification_targets: Optional[NotificationTargetSet] = None,
) -> UpdateIncidentRecordOutput
Update the details of an incident record. You can use this operation to update an incident record from the defined chat channel. For more information about using actions in chat channels, see Interacting through chat.
Parameters:
-
client_token(Optional[ClientToken], default:None) –A token that ensures that a client calls the operation only once with the specified details.
-
arn(Arn) –The Amazon Resource Name (ARN) of the incident record you are updating.
-
title(Optional[IncidentTitle], default:None) –A brief description of the incident.
-
summary(Optional[IncidentSummary], default:None) –A longer description of what occurred during the incident.
-
impact(Optional[Impact], default:None) –Defines the impact of the incident to customers and applications. If you provide an impact for an incident, it overwrites the impact provided by the response plan.
Supported impact codes
-
1- Critical -
2- High -
3- Medium -
4- Low -
5- No Impact
-
-
status(Optional[IncidentRecordStatus], default:None) –The status of the incident. Possible statuses are
OpenorResolved. -
chat_channel(Optional[ChatChannel], default:None) –The Chatbot chat channel where responders can collaborate.
-
notification_targets(Optional[NotificationTargetSet], default:None) –The Amazon SNS targets that Incident Manager notifies when a client updates an incident.
Using multiple SNS topics creates redundancy in the event that a Region is down during the incident.
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
1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 | |