Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . securityagent ]
batch-get-threats¶
Synopsis¶
batch-get-threats
--threat-ids <value>
--agent-space-id <value>
[--cli-input-json <value>]
[--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>]
[--v2-debug]
Options¶
--threat-ids (list)
The list of threat identifiers to retrieve.
(string)
Syntax:
"string" "string" ...
--agent-space-id (string)
The unique identifier of the agent space.
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.
--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
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
--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.
--v2-debug (boolean)
Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.
Output¶
threats -> (list)
The list of threats that were found.
(structure)
Represents a threat identified during threat modeling.
threatId -> (string)
The unique identifier of the threat.threatJobId -> (string)
The unique identifier of the threat model job that produced the threat.title -> (string)
A short title summarizing the threat.statement -> (string)
The natural-language threat statement.severity -> (string)
The severity level of the threat.status -> (string)
The current status of the threat.comments -> (string)
Optional customer comment on the threat.threatSource -> (string)
The actor or origin of the threat.prerequisites -> (string)
The conditions required for the threat to be exploitable.threatAction -> (string)
What the threat source can do.threatImpact -> (string)
The direct consequence of the threat action.impactedGoal -> (list)
The security goals affected by the threat.
(string)
impactedAssets -> (list)
The specific assets affected by the threat.
(string)
anchor -> (structure)
The DFD element this threat is anchored to.
kind -> (string)
The kind of DFD element.id -> (string)
The identifier of the DFD element.packageId -> (string)
The package identifier containing the DFD element.evidence -> (list)
The source code files supporting the threat.
(structure)
Source code file supporting a threat.
packageId -> (string)
The package identifier containing the evidence file.path -> (string)
The file path of the evidence.stride -> (list)
The STRIDE categories applicable to this threat.
(string)
STRIDE threat classification category.recommendation -> (string)
The recommended mitigation guidance for this threat.createdBy -> (string)
Who created this threat.updatedBy -> (string)
Who last updated this threat.createdAt -> (timestamp)
The date and time the threat was created, in UTC format.updatedAt -> (timestamp)
The date and time the threat was last updated, in UTC format.
notFound -> (list)
The list of threat identifiers that were not found.
(string)