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 . codeguruprofiler ]
Add up to 2 anomaly notifications channels for a profiling group.
See also: AWS API Documentation
add-notification-channels
--channels <value>
--profiling-group-name <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>]
--channels
(list)
One or 2 channels to report to when anomalies are detected.
(structure)
Notification medium for users to get alerted for events that occur in application profile. We support SNS topic as a notification channel.
eventPublishers -> (list)
List of publishers for different type of events that may be detected in an application from the profile. Anomaly detection is the only event publisher in Profiler.
(string)
id -> (string)
Unique identifier for eachChannel
in the notification configuration of a Profiling Group. A random UUID for channelId is used when adding a channel to the notification configuration if not specified in the request.uri -> (string)
Unique arn of the resource to be used for notifications. We support a valid SNS topic arn as a channel uri.
Shorthand Syntax:
eventPublishers=string,string,id=string,uri=string ...
JSON Syntax:
[
{
"eventPublishers": ["AnomalyDetection", ...],
"id": "string",
"uri": "string"
}
...
]
--profiling-group-name
(string)
The name of the profiling group that we are setting up notifications for.
--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.
--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.
--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.
--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.
notificationConfiguration -> (structure)
The new notification configuration for this profiling group.
channels -> (list)
List of up to two channels to be used for sending notifications for events detected from the application profile.
(structure)
Notification medium for users to get alerted for events that occur in application profile. We support SNS topic as a notification channel.
eventPublishers -> (list)
List of publishers for different type of events that may be detected in an application from the profile. Anomaly detection is the only event publisher in Profiler.
(string)
id -> (string)
Unique identifier for eachChannel
in the notification configuration of a Profiling Group. A random UUID for channelId is used when adding a channel to the notification configuration if not specified in the request.uri -> (string)
Unique arn of the resource to be used for notifications. We support a valid SNS topic arn as a channel uri.