[ aws . resiliencehub ]

batch-update-recommendation-status

Description

Enables you to include or exclude one or more operational recommendations.

See also: AWS API Documentation

Synopsis

  batch-update-recommendation-status
--app-arn <value>
--request-entries <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--app-arn (string)

Amazon Resource Name (ARN) of the Resilience Hub 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 Amazon Web Services General Reference guide.

--request-entries (list)

Defines the list of operational recommendations that need to be included or excluded.

(structure)

Defines the operational recommendation item that is to be included or excluded.

appComponentId -> (string)

Indicates the identifier of the AppComponent.

entryId -> (string)

An identifier for an entry in this batch that is used to communicate the result.

Note

The entryId s of a batch request need to be unique within a request.

excludeReason -> (string)

Indicates the reason for excluding an operational recommendation.

excluded -> (boolean)

Indicates if the operational recommendation needs to be excluded. If set to True, the operational recommendation will be excluded.

item -> (structure)

The operational recommendation item.

resourceId -> (string)

Resource identifier of the operational recommendation item.

targetAccountId -> (string)

Identifier of the target Amazon Web Services account.

targetRegion -> (string)

Identifier of the target Amazon Web Services Region.

referenceId -> (string)

Reference identifier of the operational recommendation item.

Shorthand Syntax:

appComponentId=string,entryId=string,excludeReason=string,excluded=boolean,item={resourceId=string,targetAccountId=string,targetRegion=string},referenceId=string ...

JSON Syntax:

[
  {
    "appComponentId": "string",
    "entryId": "string",
    "excludeReason": "AlreadyImplemented"|"NotRelevant"|"ComplexityOfImplementation",
    "excluded": true|false,
    "item": {
      "resourceId": "string",
      "targetAccountId": "string",
      "targetRegion": "string"
    },
    "referenceId": "string"
  }
  ...
]

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

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
• yaml
• yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

appArn -> (string)

Amazon Resource Name (ARN) of the Resilience Hub 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 Amazon Web Services General Reference guide.

failedEntries -> (list)

A list of items with error details about each item, which could not be included or excluded.

(structure)

List of operational recommendations that did not get included or excluded.

entryId -> (string)

An identifier of an entry in this batch that is used to communicate the result.

Note

The entryId s of a batch request need to be unique within a request.

errorMessage -> (string)

Indicates the error that occurred while excluding an operational recommendation.

successfulEntries -> (list)

A list of items that were included or excluded.

(structure)

List of operational recommendations that were successfully included or excluded.

appComponentId -> (string)

Indicates the identifier of an AppComponent.

entryId -> (string)

An identifier for an entry in this batch that is used to communicate the result.

Note

The entryId s of a batch request need to be unique within a request.

excludeReason -> (string)

Indicates the reason for excluding an operational recommendation.

excluded -> (boolean)

Indicates if the operational recommendation was successfully excluded.

item -> (structure)

The operational recommendation item.

resourceId -> (string)

Resource identifier of the operational recommendation item.

targetAccountId -> (string)

Identifier of the target Amazon Web Services account.

targetRegion -> (string)

Identifier of the target Amazon Web Services Region.

referenceId -> (string)

Reference identifier of the operational recommendation.