[ aws . resiliencehub ]

list-alarm-recommendations

Description

Lists the alarm recommendations for a AWS Resilience Hub application.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-alarm-recommendations
--assessment-arn <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--assessment-arn (string)

The Amazon Resource Name (ARN) of the assessment. The format for this ARN is: arn:partition :dcps:region :account :app-assessment/app-id . For more information about ARNs, see Amazon Resource Names (ARNs) in the AWS General Reference .

--max-results (integer)

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

--next-token (string)

Null, or the token from a previous call to get the next set of results.

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

See ‘aws help’ for descriptions of global parameters.

Output

alarmRecommendations -> (list)

The alarm recommendations for an AWS Resilience Hub application, returned as an object. This object includes application component names, descriptions, information about whether a recommendation has already been implemented or not, prerequisites, and more.

(structure)

Defines a recommendation for a CloudWatch alarm.

appComponentName -> (string)

The application component for the CloudWatch alarm recommendation.

description -> (string)

The description of the recommendation.

items -> (list)

The list of CloudWatch alarm recommendations.

(structure)

Defines a recommendation.

alreadyImplemented -> (boolean)

Specifies if the recommendation has already been implemented.

resourceId -> (string)

The resource identifier.

targetAccountId -> (string)

The target account identifier.

targetRegion -> (string)

The target region.

name -> (string)

The name of the alarm recommendation.

prerequisite -> (string)

The prerequisite for the alarm recommendation.

recommendationId -> (string)

The identifier of the alarm recommendation.

referenceId -> (string)

The reference identifier of the alarm recommendation.

type -> (string)

The type of alarm recommendation.

nextToken -> (string)

The token for the next set of results, or null if there are no more results.