Client

ssmincidents

R Documentation

AWS Systems Manager Incident Manager¶

Description¶

Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web Services-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.

Usage¶

ssmincidents(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- ssmincidents(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

batch_get_incident_findings: Retrieves details about all specified findings for an incident, including descriptive details about each finding
create_replication_set: A replication set replicates and encrypts your data to the provided Regions with the provided KMS key
create_response_plan: Creates a response plan that automates the initial response to incidents
create_timeline_event: Creates a custom timeline event on the incident details page of an incident record
delete_incident_record: Delete an incident record from Incident Manager
delete_replication_set: Deletes all Regions in your replication set
delete_resource_policy: Deletes the resource policy that Resource Access Manager uses to share your Incident Manager resource
delete_response_plan: Deletes the specified response plan
delete_timeline_event: Deletes a timeline event from an incident
get_incident_record: Returns the details for the specified incident record
get_replication_set: Retrieve your Incident Manager replication set
get_resource_policies: Retrieves the resource policies attached to the specified response plan
get_response_plan: Retrieves the details of the specified response plan
get_timeline_event: Retrieves a timeline event based on its ID and incident record
list_incident_findings: Retrieves a list of the IDs of findings, plus their last modified times, that have been identified for a specified incident
list_incident_records: Lists all incident records in your account
list_related_items: List all related items for an incident record
list_replication_sets: Lists details about the replication set configured in your account
list_response_plans: Lists all response plans in your account
list_tags_for_resource: Lists the tags that are attached to the specified response plan or incident
list_timeline_events: Lists timeline events for the specified incident record
put_resource_policy: Adds a resource policy to the specified response plan
start_incident: Used to start an incident from CloudWatch alarms, EventBridge events, or manually
tag_resource: Adds a tag to a response plan
untag_resource: Removes a tag from a resource
update_deletion_protection: Update deletion protection to either allow or deny deletion of the final Region in a replication set
update_incident_record: Update the details of an incident record
update_related_items: Add or remove related items from the related items tab of an incident record
update_replication_set: Add or delete Regions from your replication set
update_response_plan: Updates the specified response plan
update_timeline_event: Updates a timeline event

Examples¶

## Not run: 
svc <- ssmincidents()
svc$batch_get_incident_findings(
  Foo = 123
)

## End(Not run)