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 ]

accept-page

Description

Used to acknowledge an engagement to a contact channel during an incident.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  accept-page
--page-id <value>
[--contact-channel-id <value>]
--accept-type <value>
[--note <value>]
--accept-code <value>
[--accept-code-validation <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--page-id (string)

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

--contact-channel-id (string)

The ARN of the contact channel.

--accept-type (string)

The type indicates if the page was DELIVERED or READ .

Possible values:

  • DELIVERED
  • READ

--note (string)

Information provided by the user when the user acknowledges the page.

--accept-code (string)

The accept code is a 6-digit code used to acknowledge the page.

--accept-code-validation (string)

An optional field that Incident Manager uses to ENFORCE AcceptCode validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.

Incident Manager can also IGNORE AcceptCode validation. Ignoring AcceptCode validation causes Incident Manager to accept any value entered for the AcceptCode .

Possible values:

  • IGNORE
  • ENFORCE

--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 accept a page during and engagement

The following accept-page example uses an accept code sent to the contact channel to accept a page.

aws ssm-contacts accept-page \
    --page-id "arn:aws:ssm-contacts:us-east-2:682428703967:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3" \
    --accept-type READ \
    --accept-code 425440

This command produces no output

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

Output

None