@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSSSMIncidents
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSSSMIncidents
instead.
AWS Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their AWS-hosted applications. An incident is any unplanned interruption or reduction in quality of services.
Incident Manager increases incident resolution by notifying responders of impact, highlighting relevant troubleshooting data, and providing collaboration tools to get services back up and running. To achieve the primary goal of reducing the time-to-resolution of critical incidents, Incident Manager automates response plans and enables responder team escalation.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
CreateReplicationSetResult |
createReplicationSet(CreateReplicationSetRequest createReplicationSetRequest)
A replication set replicates and encrypts your data to the provided Regions with the provided KMS key.
|
CreateResponsePlanResult |
createResponsePlan(CreateResponsePlanRequest createResponsePlanRequest)
Creates a response plan that automates the initial response to incidents.
|
CreateTimelineEventResult |
createTimelineEvent(CreateTimelineEventRequest createTimelineEventRequest)
Creates a custom timeline event on the incident details page of an incident record.
|
DeleteIncidentRecordResult |
deleteIncidentRecord(DeleteIncidentRecordRequest deleteIncidentRecordRequest)
Delete an incident record from Incident Manager.
|
DeleteReplicationSetResult |
deleteReplicationSet(DeleteReplicationSetRequest deleteReplicationSetRequest)
Deletes all Regions in your replication set.
|
DeleteResourcePolicyResult |
deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes the resource policy that AWS Resource Access Manager uses to share your Incident Manager resource.
|
DeleteResponsePlanResult |
deleteResponsePlan(DeleteResponsePlanRequest deleteResponsePlanRequest)
Deletes the specified response plan.
|
DeleteTimelineEventResult |
deleteTimelineEvent(DeleteTimelineEventRequest deleteTimelineEventRequest)
Deletes a timeline event from an incident.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetIncidentRecordResult |
getIncidentRecord(GetIncidentRecordRequest getIncidentRecordRequest)
Returns the details of the specified incident record.
|
GetReplicationSetResult |
getReplicationSet(GetReplicationSetRequest getReplicationSetRequest)
Retrieve your Incident Manager replication set.
|
GetResourcePoliciesResult |
getResourcePolicies(GetResourcePoliciesRequest getResourcePoliciesRequest)
Retrieves the resource policies attached to the specified response plan.
|
GetResponsePlanResult |
getResponsePlan(GetResponsePlanRequest getResponsePlanRequest)
Retrieves the details of the specified response plan.
|
GetTimelineEventResult |
getTimelineEvent(GetTimelineEventRequest getTimelineEventRequest)
Retrieves a timeline event based on its ID and incident record.
|
ListIncidentRecordsResult |
listIncidentRecords(ListIncidentRecordsRequest listIncidentRecordsRequest)
Lists all incident records in your account.
|
ListRelatedItemsResult |
listRelatedItems(ListRelatedItemsRequest listRelatedItemsRequest)
List all related items for an incident record.
|
ListReplicationSetsResult |
listReplicationSets(ListReplicationSetsRequest listReplicationSetsRequest)
Lists details about the replication set configured in your account.
|
ListResponsePlansResult |
listResponsePlans(ListResponsePlansRequest listResponsePlansRequest)
Lists all response plans in your account.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags that are attached to the specified response plan.
|
ListTimelineEventsResult |
listTimelineEvents(ListTimelineEventsRequest listTimelineEventsRequest)
Lists timeline events of the specified incident record.
|
PutResourcePolicyResult |
putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
Adds a resource policy to the specified response plan.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartIncidentResult |
startIncident(StartIncidentRequest startIncidentRequest)
Used to start an incident from CloudWatch alarms, EventBridge events, or manually.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds a tag to a response plan.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from a resource.
|
UpdateDeletionProtectionResult |
updateDeletionProtection(UpdateDeletionProtectionRequest updateDeletionProtectionRequest)
Update deletion protection to either allow or deny deletion of the final Region in a replication set.
|
UpdateIncidentRecordResult |
updateIncidentRecord(UpdateIncidentRecordRequest updateIncidentRecordRequest)
Update the details of an incident record.
|
UpdateRelatedItemsResult |
updateRelatedItems(UpdateRelatedItemsRequest updateRelatedItemsRequest)
Add or remove related items from the related items tab of an incident record.
|
UpdateReplicationSetResult |
updateReplicationSet(UpdateReplicationSetRequest updateReplicationSetRequest)
Add or delete Regions from your replication set.
|
UpdateResponsePlanResult |
updateResponsePlan(UpdateResponsePlanRequest updateResponsePlanRequest)
Updates the specified response plan.
|
UpdateTimelineEventResult |
updateTimelineEvent(UpdateTimelineEventRequest updateTimelineEventRequest)
Updates a timeline event.
|
AWSSSMIncidentsWaiters |
waiters() |
static final String ENDPOINT_PREFIX
CreateReplicationSetResult createReplicationSet(CreateReplicationSetRequest createReplicationSetRequest)
A replication set replicates and encrypts your data to the provided Regions with the provided KMS key.
createReplicationSetRequest
- ServiceQuotaExceededException
- Request would cause a service quota to be exceeded.ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ConflictException
- Updating or deleting a resource causes an inconsistent state.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.CreateResponsePlanResult createResponsePlan(CreateResponsePlanRequest createResponsePlanRequest)
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.
createResponsePlanRequest
- ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- Request references a resource which does not exist.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ConflictException
- Updating or deleting a resource causes an inconsistent state.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.CreateTimelineEventResult createTimelineEvent(CreateTimelineEventRequest createTimelineEventRequest)
Creates a custom timeline event on the incident details page of an incident record. Timeline events are automatically created by Incident Manager, marking key moment during an incident. You can create custom timeline events to mark important events that are automatically detected by Incident Manager.
createTimelineEventRequest
- ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- Request references a resource which does not exist.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ConflictException
- Updating or deleting a resource causes an inconsistent state.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.DeleteIncidentRecordResult deleteIncidentRecord(DeleteIncidentRecordRequest deleteIncidentRecordRequest)
Delete an incident record from Incident Manager.
deleteIncidentRecordRequest
- ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.DeleteReplicationSetResult deleteReplicationSet(DeleteReplicationSetRequest deleteReplicationSetRequest)
Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data.
deleteReplicationSetRequest
- ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- Request references a resource which does not exist.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes the resource policy that AWS Resource Access Manager uses to share your Incident Manager resource.
deleteResourcePolicyRequest
- ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- Request references a resource which does not exist.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.DeleteResponsePlanResult deleteResponsePlan(DeleteResponsePlanRequest deleteResponsePlanRequest)
Deletes the specified response plan. Deleting a response plan stops all linked CloudWatch alarms and EventBridge events from creating an incident with this response plan.
deleteResponsePlanRequest
- ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.DeleteTimelineEventResult deleteTimelineEvent(DeleteTimelineEventRequest deleteTimelineEventRequest)
Deletes a timeline event from an incident.
deleteTimelineEventRequest
- ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.GetIncidentRecordResult getIncidentRecord(GetIncidentRecordRequest getIncidentRecordRequest)
Returns the details of the specified incident record.
getIncidentRecordRequest
- ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- Request references a resource which does not exist.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.GetReplicationSetResult getReplicationSet(GetReplicationSetRequest getReplicationSetRequest)
Retrieve your Incident Manager replication set.
getReplicationSetRequest
- ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- Request references a resource which does not exist.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.GetResourcePoliciesResult getResourcePolicies(GetResourcePoliciesRequest getResourcePoliciesRequest)
Retrieves the resource policies attached to the specified response plan.
getResourcePoliciesRequest
- ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- Request references a resource which does not exist.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.GetResponsePlanResult getResponsePlan(GetResponsePlanRequest getResponsePlanRequest)
Retrieves the details of the specified response plan.
getResponsePlanRequest
- ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- Request references a resource which does not exist.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.GetTimelineEventResult getTimelineEvent(GetTimelineEventRequest getTimelineEventRequest)
Retrieves a timeline event based on its ID and incident record.
getTimelineEventRequest
- ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- Request references a resource which does not exist.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ListIncidentRecordsResult listIncidentRecords(ListIncidentRecordsRequest listIncidentRecordsRequest)
Lists all incident records in your account. Use this command to retrieve the Amazon Resource Name (ARN) of the incident record you want to update.
listIncidentRecordsRequest
- ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ListRelatedItemsResult listRelatedItems(ListRelatedItemsRequest listRelatedItemsRequest)
List all related items for an incident record.
listRelatedItemsRequest
- ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ListReplicationSetsResult listReplicationSets(ListReplicationSetsRequest listReplicationSetsRequest)
Lists details about the replication set configured in your account.
listReplicationSetsRequest
- ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ListResponsePlansResult listResponsePlans(ListResponsePlansRequest listResponsePlansRequest)
Lists all response plans in your account.
listResponsePlansRequest
- ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags that are attached to the specified response plan.
listTagsForResourceRequest
- ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- Request references a resource which does not exist.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.ListTimelineEventsResult listTimelineEvents(ListTimelineEventsRequest listTimelineEventsRequest)
Lists timeline events of the specified incident record.
listTimelineEventsRequest
- ThrottlingException
- The request was denied due to request throttling.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
Adds a resource policy to the specified response plan.
putResourcePolicyRequest
- ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- Request references a resource which does not exist.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.StartIncidentResult startIncident(StartIncidentRequest startIncidentRequest)
Used to start an incident from CloudWatch alarms, EventBridge events, or manually.
startIncidentRequest
- ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- Request references a resource which does not exist.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ConflictException
- Updating or deleting a resource causes an inconsistent state.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds a tag to a response plan.
tagResourceRequest
- ServiceQuotaExceededException
- Request would cause a service quota to be exceeded.ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- Request references a resource which does not exist.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ConflictException
- Updating or deleting a resource causes an inconsistent state.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from a resource.
untagResourceRequest
- ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- Request references a resource which does not exist.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ConflictException
- Updating or deleting a resource causes an inconsistent state.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.UpdateDeletionProtectionResult updateDeletionProtection(UpdateDeletionProtectionRequest updateDeletionProtectionRequest)
Update deletion protection to either allow or deny deletion of the final Region in a replication set.
updateDeletionProtectionRequest
- ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- Request references a resource which does not exist.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.UpdateIncidentRecordResult updateIncidentRecord(UpdateIncidentRecordRequest updateIncidentRecordRequest)
Update the details of an incident record. You can use this action to update an incident record from the defined chat channel. For more information about using actions in chat channels, see Interacting through chat.
updateIncidentRecordRequest
- ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- Request references a resource which does not exist.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ConflictException
- Updating or deleting a resource causes an inconsistent state.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.UpdateRelatedItemsResult updateRelatedItems(UpdateRelatedItemsRequest updateRelatedItemsRequest)
Add or remove related items from the related items tab of an incident record.
updateRelatedItemsRequest
- ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- Request references a resource which does not exist.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ConflictException
- Updating or deleting a resource causes an inconsistent state.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.UpdateReplicationSetResult updateReplicationSet(UpdateReplicationSetRequest updateReplicationSetRequest)
Add or delete Regions from your replication set.
updateReplicationSetRequest
- ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- Request references a resource which does not exist.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.UpdateResponsePlanResult updateResponsePlan(UpdateResponsePlanRequest updateResponsePlanRequest)
Updates the specified response plan.
updateResponsePlanRequest
- ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- Request references a resource which does not exist.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ConflictException
- Updating or deleting a resource causes an inconsistent state.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.UpdateTimelineEventResult updateTimelineEvent(UpdateTimelineEventRequest updateTimelineEventRequest)
Updates a timeline event. You can update events of type Custom Event
.
updateTimelineEventRequest
- ThrottlingException
- The request was denied due to request throttling.ResourceNotFoundException
- Request references a resource which does not exist.AccessDeniedException
- You don't have sufficient access to perform this action.ValidationException
- The input fails to satisfy the constraints specified by an AWS service.ConflictException
- Updating or deleting a resource causes an inconsistent state.InternalServerException
- The request processing has failed because of an unknown error, exception or failure.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.AWSSSMIncidentsWaiters waiters()