Update Contact

ssmcontacts_update_contact

R Documentation

Updates the contact or escalation plan specified¶

Description¶

Updates the contact or escalation plan specified.

Usage¶

ssmcontacts_update_contact(ContactId, DisplayName, Plan)

Arguments¶

ContactId: [required] The Amazon Resource Name (ARN) of the contact or escalation plan you're updating.
DisplayName: The full name of the contact or escalation plan.
Plan: A list of stages. A contact has an engagement plan with stages for specified contact channels. An escalation plan uses these stages to contact specified contacts.

Value¶

An empty list.

Request syntax¶

svc$update_contact(
  ContactId = "string",
  DisplayName = "string",
  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"
    )
  )
)

Examples¶

## Not run: 
# The following update-contact example updates the engagement plan of the
# contact Akua to include the three types of contacts channels. This is
# done after creating contact channels for Akua.
svc$update_contact(
  ContactId = "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam",
  Plan = list(
    Stages = list(
      list(
        DurationInMinutes = 5L,
        Targets = list(
          list(
            ChannelTargetInfo = list(
              ContactChannelId = "arn:aws:ssm-contacts:us-east-2:1111222233...",
              RetryIntervalInMinutes = 1L
            )
          )
        )
      ),
      list(
        DurationInMinutes = 5L,
        Targets = list(
          list(
            ChannelTargetInfo = list(
              ContactChannelId = "arn:aws:ssm-contacts:us-east-2:1111222233...",
              RetryIntervalInMinutes = 1L
            )
          )
        )
      ),
      list(
        DurationInMinutes = 5L,
        Targets = list(
          list(
            ChannelTargetInfo = list(
              ContactChannelId = "arn:aws:ssm-contacts:us-east-2:1111222233...",
              RetryIntervalInMinutes = 1L
            )
          )
        )
      )
    )
  )
)

## End(Not run)