[ aws . inspector2 ]
batch-get-account-status¶
Description¶
Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
batch-get-account-status
[--account-ids <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--account-ids (list)
The 12-digit Amazon Web Services account IDs of the accounts to retrieve Amazon Inspector status for.
(string)
Syntax:
"string" "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.
See ‘aws help’ for descriptions of global parameters.
Output¶
accounts -> (list)
An array of objects that provide details on the status of Amazon Inspector for each of the requested accounts.
(structure)
An object with details the status of an Amazon Web Services account within your Amazon Inspector environment
accountId -> (string)
The Amazon Web Services account ID.
resourceState -> (structure)
An object detailing which resources Amazon Inspector is enabled to scan for the account.
ec2 -> (structure)
An object detailing the state of Amazon Inspector scanning for Amazon EC2 resources.
errorCode -> (string)
The error code explaining why the account failed to enable Amazon Inspector.
errorMessage -> (string)
The error message received when the account failed to enable Amazon Inspector.
status -> (string)
The status of Amazon Inspector for the account.
ecr -> (structure)
An object detailing the state of Amazon Inspector scanning for Amazon ECR resources.
errorCode -> (string)
The error code explaining why the account failed to enable Amazon Inspector.
errorMessage -> (string)
The error message received when the account failed to enable Amazon Inspector.
status -> (string)
The status of Amazon Inspector for the account.
state -> (structure)
An object detailing the status of Amazon Inspector for the account.
errorCode -> (string)
The error code explaining why the account failed to enable Amazon Inspector.
errorMessage -> (string)
The error message received when the account failed to enable Amazon Inspector.
status -> (string)
The status of Amazon Inspector for the account.
failedAccounts -> (list)
An array of objects detailing any accounts that failed to enable Amazon Inspector and why.
(structure)
An object with details on why an account failed to enable Amazon Inspector.
accountId -> (string)
The Amazon Web Services account ID.
errorCode -> (string)
The error code explaining why the account failed to enable Amazon Inspector.
errorMessage -> (string)
The error message received when the account failed to enable Amazon Inspector.
resourceStatus -> (structure)
An object detailing which resources Amazon Inspector is enabled to scan for the account.
ec2 -> (string)
The status of Amazon Inspector scanning for Amazon EC2 resources.
ecr -> (string)
The status of Amazon Inspector scanning for Amazon ECR resources.
status -> (string)
The status of Amazon Inspector for the account.