Create Contact

ssmcontacts_create_contact

R Documentation

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¶

Description¶

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.

Usage¶

ssmcontacts_create_contact(Alias, DisplayName, Type, Plan, Tags,
  IdempotencyToken)

Arguments¶

Alias: [required] The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.
DisplayName: The full name of the contact or escalation plan.
Type: [required] To create an escalation plan use ESCALATION. To create a contact use PERSONAL.
Plan: [required] A list of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.
Tags: Adds a tag to the target. You can only tag resources created in the first Region of your replication set.
IdempotencyToken: A token ensuring that the operation is called only once with the specified details.

Value¶

A list with the following syntax:

list(
  ContactArn = "string"
)

Request syntax¶

svc$create_contact(
  Alias = "string",
  DisplayName = "string",
  Type = "PERSONAL"|"ESCALATION"|"ONCALL_SCHEDULE",
  Plan = list(
    Stages = list(
      list(
        DurationInMinutes = 123,
        Targets = list(
          list(
            ChannelTargetInfo = list(
              ContactChannelId = "string",
              RetryIntervalInMinutes = 123
            ),
            ContactTargetInfo = list(
              ContactId = "string",
              IsEssential = TRUE|FALSE
            )
          )
        )
      )
    ),
    RotationIds = list(
      "string"
    )
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  IdempotencyToken = "string"
)

Examples¶

## Not run: 
# The following create-contact example creates a contact in your
# environment with a blank plan. The plan can be updated after creating
# contact channels. Use the create-contact-channel operation with the
# output ARN of this command. After you have created contact channels for
# this contact use update-contact to update the plan.
svc$create_contact(
  Alias = "akuam",
  DisplayName = "Akua Mansa",
  Plan = list(
    Stages = list()
  ),
  Type = "PERSONAL"
)

## End(Not run)