[ aws . securityagent ]

batch-get-threats

Description

Retrieves information about one or more threats.

See also: AWS API Documentation

Synopsis

  batch-get-threats
--threat-ids <value>
--agent-space-id <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]
[--cli-error-format <value>]

Options

--threat-ids (list) [required]

The list of threat identifiers to retrieve.

(string)

Syntax:

"string" "string" ...

--agent-space-id (string) [required]

The unique identifier of the agent space.

--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
• off

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

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

• legacy
• json
• yaml
• text
• table
• enhanced

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.

Possible values:

• CRITICAL
• HIGH
• MEDIUM
• LOW
• INFO

status -> (string)

The current status of the threat.

Possible values:

• OPEN
• RESOLVED
• DISMISSED

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.

Possible values:

• SPOOFING
• TAMPERING
• REPUDIATION
• INFORMATION_DISCLOSURE
• DENIAL_OF_SERVICE
• ELEVATION_OF_PRIVILEGE

recommendation -> (string)

The recommended mitigation guidance for this threat.

createdBy -> (string)

Who created this threat.

Possible values:

• CUSTOMER
• AGENT

updatedBy -> (string)

Who last updated this threat.

Possible values:

• CUSTOMER
• AGENT

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)