Client

ssmcontacts

R Documentation

AWS Systems Manager Incident Manager Contacts¶

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¶

ssmcontacts(
  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 <- ssmcontacts(
  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¶

accept_page: Used to acknowledge an engagement to a contact channel during an incident
activate_contact_channel: Activates a contact's contact channel
create_contact: Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in phases during an incident
create_contact_channel: A contact channel is the method that Incident Manager uses to engage your contact
create_rotation: Creates a rotation in an on-call schedule
create_rotation_override: Creates an override for a rotation in an on-call schedule
deactivate_contact_channel: To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel
delete_contact: To remove a contact from Incident Manager, you can delete the contact
delete_contact_channel: To no longer receive engagements on a contact channel, you can delete the channel from a contact
delete_rotation: Deletes a rotation from the system
delete_rotation_override: Deletes an existing override for an on-call rotation
describe_engagement: Incident Manager uses engagements to engage contacts and escalation plans during an incident
describe_page: Lists details of the engagement to a contact channel
get_contact: Retrieves information about the specified contact or escalation plan
get_contact_channel: List details about a specific contact channel
get_contact_policy: Retrieves the resource policies attached to the specified contact or escalation plan
get_rotation: Retrieves information about an on-call rotation
get_rotation_override: Retrieves information about an override to an on-call rotation
list_contact_channels: Lists all contact channels for the specified contact
list_contacts: Lists all contacts and escalation plans in Incident Manager
list_engagements: Lists all engagements that have happened in an incident
list_page_receipts: Lists all of the engagements to contact channels that have been acknowledged
list_page_resolutions: Returns the resolution path of an engagement
list_pages_by_contact: Lists the engagements to a contact's contact channels
list_pages_by_engagement: Lists the engagements to contact channels that occurred by engaging a contact
list_preview_rotation_shifts: Returns a list of shifts based on rotation configuration parameters
list_rotation_overrides: Retrieves a list of overrides currently specified for an on-call rotation
list_rotations: Retrieves a list of on-call rotations
list_rotation_shifts: Returns a list of shifts generated by an existing rotation in the system
list_tags_for_resource: Lists the tags of an escalation plan or contact
put_contact_policy: Adds a resource policy to the specified contact or escalation plan
send_activation_code: Sends an activation code to a contact channel
start_engagement: Starts an engagement to a contact or escalation plan
stop_engagement: Stops an engagement before it finishes the final stage of the escalation plan or engagement plan
tag_resource: Tags a contact or escalation plan
untag_resource: Removes tags from the specified resource
update_contact: Updates the contact or escalation plan specified
update_contact_channel: Updates a contact's contact channel
update_rotation: Updates the information specified for an on-call rotation

Examples¶

## Not run: 
svc <- ssmcontacts()
svc$accept_page(
  Foo = 123
)

## End(Not run)