accept-page¶

Description¶

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

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 | --cli-input-yaml]
[--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 | --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 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

Table of Contents

Feedback

User Guide