Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ssm-contacts ]

stop-engagement

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  stop-engagement
--engagement-id <value>
[--reason <value>]
[--cli-input-json <value>]
[--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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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