[ aws . securityagent ]
Resumes a stopped or paused pentest job from its last saved checkpoint. The job keeps its pentest job identifier and continues as a new version, keeping the findings and progress from earlier runs. You can resume a job within 7 days of when it was created.
See also: AWS API Documentation
resume-pentest-job
[--agent-space-id <value>]
[--pentest-job-id <value>]
[--actors <value>]
[--network-traffic-config <value>]
[--vpc-config <value>]
[--max-task-hours <value>]
[--copy-config-from-pentest | --no-copy-config-from-pentest]
[--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>]
[--help]
--agent-space-id (string)
The unique identifier of the agent space.
--pentest-job-id (string)
The unique identifier of the pentest job to resume.
--actors (list)
The actors to use for the resumed job. When specified, replaces the actors the job used before it stopped.
(structure)
Represents an actor used during penetration testing. An actor defines a user or entity that interacts with the target application, including authentication credentials and target URIs.
identifier -> (string)
The unique identifier for the actor.uris -> (list)
The list of URIs that the actor targets during testing.
(string)
authentication -> (structure)
The authentication configuration for the actor.
providerType -> (string)
The type of authentication provider. Valid values include SECRETS_MANAGER, AWS_LAMBDA, AWS_IAM_ROLE, and AWS_INTERNAL.
Possible values:
SECRETS_MANAGERAWS_LAMBDAAWS_IAM_ROLEAWS_INTERNALvalue -> (string)
The authentication value, such as a secret ARN, Lambda function ARN, or IAM role ARN, depending on the provider type.description -> (string)
A description of the actor.enableEmailMfa -> (boolean)
Whether email-based MFA is enabled for this actor.mfaForwardingAddress -> (string)
Server-generated email forwarding address for receiving MFA codes.
Shorthand Syntax:
identifier=string,uris=string,string,authentication={providerType=string,value=string},description=string,enableEmailMfa=boolean,mfaForwardingAddress=string ...
JSON Syntax:
[
{
"identifier": "string",
"uris": ["string", ...],
"authentication": {
"providerType": "SECRETS_MANAGER"|"AWS_LAMBDA"|"AWS_IAM_ROLE"|"AWS_INTERNAL",
"value": "string"
},
"description": "string",
"enableEmailMfa": true|false,
"mfaForwardingAddress": "string"
}
...
]
--network-traffic-config (structure)
The network traffic configuration to use for the resumed job. When specified, replaces the configuration the job used before it stopped.
rules -> (list)
The list of network traffic rules that control which URLs are allowed or denied during testing.
(structure)
A rule that controls network traffic during penetration testing by allowing or denying traffic to specific URL patterns.
effect -> (string)
The effect of the rule. Valid values are ALLOW and DENY.
Possible values:
ALLOWDENYpattern -> (string)
The URL pattern to match for the rule.networkTrafficRuleType -> (string)
The type of the network traffic rule. Currently, only URL is supported.
Possible values:
URLcustomHeaders -> (list)
The list of custom HTTP headers to include in network traffic during testing.
(structure)
A custom HTTP header to include in network traffic during penetration testing.
name -> (string)
The name of the custom header.value -> (string)
The value of the custom header.
Shorthand Syntax:
rules=[{effect=string,pattern=string,networkTrafficRuleType=string},{effect=string,pattern=string,networkTrafficRuleType=string}],customHeaders=[{name=string,value=string},{name=string,value=string}]
JSON Syntax:
{
"rules": [
{
"effect": "ALLOW"|"DENY",
"pattern": "string",
"networkTrafficRuleType": "URL"
}
...
],
"customHeaders": [
{
"name": "string",
"value": "string"
}
...
]
}
--vpc-config (structure)
The VPC configuration to use for the resumed job. When specified, replaces the configuration the job used before it stopped.
vpcArn -> (string)
The Amazon Resource Name (ARN) or ID of the VPC.securityGroupArns -> (list)
The Amazon Resource Names (ARNs) or IDs of the security groups for the VPC configuration.
(string)
ARN or ID of a security group.subnetArns -> (list)
The Amazon Resource Names (ARNs) or IDs of the subnets for the VPC configuration.
(string)
ARN or ID of a subnet.
Shorthand Syntax:
vpcArn=string,securityGroupArns=string,string,subnetArns=string,string
JSON Syntax:
{
"vpcArn": "string",
"securityGroupArns": ["string", ...],
"subnetArns": ["string", ...]
}
--max-task-hours (double)
The maximum number of task hours for the resumed job. To resume a job that stopped because it reached its task hours limit, specify a higher value.
--copy-config-from-pentest | --no-copy-config-from-pentest (boolean)
Specifies whether to copy the current actors, network traffic configuration, VPC configuration, and maximum task hours from the pentest to the resumed job. The job’s scope, such as its target endpoints, is never changed. Values you specify in this request take precedence over copied values.
--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.
--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.
--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.
--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.
--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.
--help (boolean)
Display help for the command/subcommand.
title -> (string)
The title of the pentest job.
status -> (string)
The current status of the pentest job.
Possible values:
IN_PROGRESSSTOPPINGSTOPPEDPAUSINGPAUSEDFAILEDCOMPLETED
createdAt -> (timestamp)
The date and time the pentest job was created, in UTC format.
updatedAt -> (timestamp)
The date and time the pentest job was last updated, in UTC format.
pentestId -> (string)
The unique identifier of the pentest.
pentestJobId -> (string)
The unique identifier of the resumed pentest job.
version -> (string)
The version of the pentest job that the resume started. The version increases each time the job is resumed.