create-contact¶

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.

Synopsis¶

  create-contact
--alias <value>
[--display-name <value>]
--type <value>
--plan <value>
[--tags <value>]
[--idempotency-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--alias (string)

The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.

--display-name (string)

The full name of the contact or escalation plan.

--type (string)

To create an escalation plan use ESCALATION . To create a contact use PERSONAL .

Possible values:

PERSONAL

ESCALATION

--plan (structure)

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.

Stages -> (list)

A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.

(structure)

A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.

DurationInMinutes -> (integer)

The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.

Targets -> (list)

The contacts or contact methods that the escalation plan or engagement plan is engaging.

(structure)

The contact or contact channel that’s being engaged.

ChannelTargetInfo -> (structure)

Information about the contact channel Incident Manager is engaging.

ContactChannelId -> (string)

The Amazon Resource Name (ARN) of the contact channel.

RetryIntervalInMinutes -> (integer)

The number of minutes to wait to retry sending engagement in the case the engagement initially fails.

ContactTargetInfo -> (structure)

Information about the contact that Incident Manager is engaging.

ContactId -> (string)

The Amazon Resource Name (ARN) of the contact.

IsEssential -> (boolean)

A Boolean value determining if the contact’s acknowledgement stops the progress of stages in the plan.

JSON Syntax:

{
  "Stages": [
    {
      "DurationInMinutes": integer,
      "Targets": [
        {
          "ChannelTargetInfo": {
            "ContactChannelId": "string",
            "RetryIntervalInMinutes": integer
          },
          "ContactTargetInfo": {
            "ContactId": "string",
            "IsEssential": true|false
          }
        }
        ...
      ]
    }
    ...
  ]
}

--tags (list)

Adds a tag to the target. You can only tag resources created in the first Region of your replication set.

(structure)

A container of a key-value name pair.

Key -> (string)

Name of the object key.

Value -> (string)

Value of the tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--idempotency-token (string)

A token ensuring that the operation is called only once with the specified details.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create a contact

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 command with the output ARN of this command. After you have created contact channels for this contact use update-contact to update the plan.

aws ssm-contacts create-contact \
    --alias "akuam" \
    --display-name "Akua Mansa" \
    --type PERSONAL \
    --plan '{"Stages": []}'

Output:

{
    "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
}

For more information, see Contacts in the Incident Manager User Guide.

Output¶

ContactArn -> (string)

The Amazon Resource Name (ARN) of the created contact or escalation plan.

Table of Contents

Feedback

User Guide