AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . rolesanywhere ]

reset-notification-settings

Description

Resets the custom notification setting to IAM Roles Anywhere default setting.

Required permissions: rolesanywhere:ResetNotificationSettings .

See also: AWS API Documentation

Synopsis

  reset-notification-settings
--trust-anchor-id <value>
--notification-setting-keys <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--trust-anchor-id (string)

The unique identifier of the trust anchor.

--notification-setting-keys (list)

A list of notification setting keys to reset. A notification setting key includes the event and the channel.

(structure)

A notification setting key to reset. A notification setting key includes the event and the channel.

event -> (string)

The notification setting event to reset.

channel -> (string)

The specified channel of notification.

Shorthand Syntax:

event=string,channel=string ...

JSON Syntax:

[
  {
    "event": "CA_CERTIFICATE_EXPIRY"|"END_ENTITY_CERTIFICATE_EXPIRY",
    "channel": "ALL"
  }
  ...
]

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

trustAnchor -> (structure)

The state of the trust anchor after a read or write operation.

trustAnchorId -> (string)

The unique identifier of the trust anchor.

trustAnchorArn -> (string)

The ARN of the trust anchor.

name -> (string)

The name of the trust anchor.

source -> (structure)

The trust anchor type and its related certificate data.

sourceType -> (string)

The type of the trust anchor.

sourceData -> (tagged union structure)

The data field of the trust anchor depending on its type.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: x509CertificateData, acmPcaArn.

x509CertificateData -> (string)

The PEM-encoded data for the certificate anchor. Included for trust anchors of type CERTIFICATE_BUNDLE .

acmPcaArn -> (string)

The root certificate of the Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests. Included for trust anchors of type AWS_ACM_PCA .

enabled -> (boolean)

Indicates whether the trust anchor is enabled.

createdAt -> (timestamp)

The ISO-8601 timestamp when the trust anchor was created.

updatedAt -> (timestamp)

The ISO-8601 timestamp when the trust anchor was last updated.

notificationSettings -> (list)

A list of notification settings to be associated to the trust anchor.

(structure)

The state of a notification setting.

A notification setting includes information such as event name, threshold, status of the notification setting, and the channel to notify.

enabled -> (boolean)

Indicates whether the notification setting is enabled.

event -> (string)

The event to which this notification setting is applied.

threshold -> (integer)

The number of days before a notification event.

channel -> (string)

The specified channel of notification. IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and Health Dashboard to notify for an event.

Note

In the absence of a specific channel, IAM Roles Anywhere applies this setting to ‘ALL’ channels.

configuredBy -> (string)

The principal that configured the notification setting. For default settings configured by IAM Roles Anywhere, the value is rolesanywhere.amazonaws.com , and for customized notifications settings, it is the respective account ID.