stop-engagement¶

Description¶

Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren’t engaged.

Synopsis¶

  stop-engagement
--engagement-id <value>
[--reason <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--engagement-id (string)

The Amazon Resource Name (ARN) of the engagement.

--reason (string)

The reason that you’re stopping the engagement.

--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.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To stop an engagement

The following stop-engagement example stops an engagement from paging further contacts and contact channels.

aws ssm-contacts stop-engagement \
    --engagement-id "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"

This command produces no output.

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

Output¶

None

Table of Contents

Feedback

User Guide