[ aws . resiliencehub ]

list-app-component-recommendations

Description

Lists the recommendations for an AWS Resilience Hub component.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-app-component-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 :resiliencehub: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

componentRecommendations -> (list)

The recommendations for an Resilience Hub application component, returned as an object. This object contains component names, configuration recommendations, and recommendation statuses.

(structure)

Defines recommendations for a Resilience Hub application component, returned as an object. This object contains component names, configuration recommendations, and recommendation statuses.

appComponentName -> (string)

The name of the application component.

configRecommendations -> (list)

The list of recommendations.

(structure)

Defines a configuration recommendation.

appComponentName -> (string)

The application component name.

compliance -> (map)

The current compliance against the resiliency policy before applying the configuration change.

key -> (string)

value -> (structure)

Defines the compliance against the resiliency policy for a disruption.

achievableRpoInSecs -> (integer)

The Recovery Point Objective (RPO) that is achievable, in seconds.

achievableRtoInSecs -> (integer)

The Recovery Time Objective (RTO) that is achievable, in seconds

complianceStatus -> (string)

The current status of compliance for the resiliency policy.

currentRpoInSecs -> (integer)

The current RPO, in seconds.

currentRtoInSecs -> (integer)

The current RTO, in seconds.

message -> (string)

The disruption compliance message.

rpoDescription -> (string)

The RPO description.

rpoReferenceId -> (string)

The RPO reference identifier.

rtoDescription -> (string)

The RTO description.

rtoReferenceId -> (string)

The RTO reference identifier.

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.

description -> (string)

The optional description for an app.

haArchitecture -> (string)

The architecture type.

name -> (string)

The name of the recommendation configuration.

optimizationType -> (string)

The type of optimization.

recommendationCompliance -> (map)

The expected compliance against the resiliency policy after applying the configuration change.

key -> (string)

value -> (structure)

Defines a disruption compliance recommendation.

expectedComplianceStatus -> (string)

The expected compliance status after applying the recommended configuration change.

expectedRpoDescription -> (string)

The expected Recovery Point Objective (RPO) description after applying the recommended configuration change.

expectedRpoInSecs -> (integer)

The expected RPO after applying the recommended configuration change.

expectedRtoDescription -> (string)

The expected Recovery Time Objective (RTO) description after applying the recommended configuration change.

expectedRtoInSecs -> (integer)

The expected RTO after applying the recommended configuration change.

referenceId -> (string)

The reference identifier for the recommendation configuration.

suggestedChanges -> (list)

List of the suggested configuration changes.

(string)

recommendationStatus -> (string)

The recommendation status.

nextToken -> (string)

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