[ aws . resiliencehub ]

list-app-assessments

Description

Lists the assessments for an AWS Resilience Hub application. You can use request parameters to refine the results for the response object.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-app-assessments
[--app-arn <value>]
[--assessment-name <value>]
[--assessment-status <value>]
[--compliance-status <value>]
[--invoker <value>]
[--max-results <value>]
[--next-token <value>]
[--reverse-order | --no-reverse-order]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--app-arn (string)

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

--assessment-name (string)

The name for the assessment.

--assessment-status (list)

The current status of the assessment for the resiliency policy.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  Pending
  InProgress
  Failed
  Success

--compliance-status (string)

The current status of compliance for the resiliency policy.

Possible values:

• PolicyBreached

• PolicyMet

--invoker (string)

Specifies the entity that invoked a specific assessment, either a User or the System .

Possible values:

• User

• System

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

--reverse-order | --no-reverse-order (boolean)

The default is to sort by ascending startTime . To sort by descending startTime , set reverseOrder to true .

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

Output

assessmentSummaries -> (list)

The summaries for the specified assessments, returned as an object. This object includes application versions, associated Amazon Resource Numbers (ARNs), cost, messages, resiliency scores, and more.

(structure)

Defines an application assessment summary.

appArn -> (string)

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

appVersion -> (string)

The version of the application.

assessmentArn -> (string)

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

assessmentName -> (string)

The name of the assessment.

assessmentStatus -> (string)

The current status of the assessment for the resiliency policy.

complianceStatus -> (string)

The current status of compliance for the resiliency policy.

cost -> (structure)

The cost for the application.

amount -> (double)

The cost amount.

currency -> (string)

The cost currency, for example USD .

frequency -> (string)

The cost frequency.

endTime -> (timestamp)

The end time for the action.

invoker -> (string)

The entity that invoked the assessment.

message -> (string)

The message from the assessment run.

resiliencyScore -> (double)

The current resiliency score for the application.

startTime -> (timestamp)

The starting time for the action.

nextToken -> (string)

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