AWS Security Agent

2026/11/18 - AWS Security Agent - 1 new12 updated api methods

Changes  This release adds support for resuming a paused penetration test job from its last saved checkpoint.

ResumePentestJob (new) Link ¶

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

Request Syntax

client.resume_pentest_job(
    agentSpaceId='string',
    pentestJobId='string',
    actors=[
        {
            'identifier': 'string',
            'uris': [
                'string',
            ],
            'authentication': {
                'providerType': 'SECRETS_MANAGER'|'AWS_LAMBDA'|'AWS_IAM_ROLE'|'AWS_INTERNAL',
                'value': 'string'
            },
            'description': 'string',
            'enableEmailMfa': True|False,
            'mfaForwardingAddress': 'string'
        },
    ],
    networkTrafficConfig={
        'rules': [
            {
                'effect': 'ALLOW'|'DENY',
                'pattern': 'string',
                'networkTrafficRuleType': 'URL'
            },
        ],
        'customHeaders': [
            {
                'name': 'string',
                'value': 'string'
            },
        ]
    },
    vpcConfig={
        'vpcArn': 'string',
        'securityGroupArns': [
            'string',
        ],
        'subnetArns': [
            'string',
        ]
    },
    maxTaskHours=123.0,
    copyConfigFromPentest=True|False
)
type agentSpaceId:

string

param agentSpaceId:

The unique identifier of the agent space.

type pentestJobId:

string

param pentestJobId:

The unique identifier of the pentest job to resume.

type actors:

list

param actors:

The actors to use for the resumed job. When specified, replaces the actors the job used before it stopped.

  • (dict) --

    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 (dict) --

      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.

      • value (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.

type networkTrafficConfig:

dict

param networkTrafficConfig:

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.

    • (dict) --

      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.

      • pattern (string) --

        The URL pattern to match for the rule.

      • networkTrafficRuleType (string) --

        The type of the network traffic rule. Currently, only URL is supported.

  • customHeaders (list) --

    The list of custom HTTP headers to include in network traffic during testing.

    • (dict) --

      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.

type vpcConfig:

dict

param vpcConfig:

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.

type maxTaskHours:

float

param maxTaskHours:

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.

type copyConfigFromPentest:

boolean

param copyConfigFromPentest:

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.

rtype:

dict

returns:

Response Syntax

{
    'title': 'string',
    'status': 'IN_PROGRESS'|'STOPPING'|'STOPPED'|'PAUSING'|'PAUSED'|'FAILED'|'COMPLETED',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'pentestId': 'string',
    'pentestJobId': 'string',
    'version': 'string'
}

Response Structure

  • (dict) --

    Output for the ResumePentestJob operation.

    • title (string) --

      The title of the pentest job.

    • status (string) --

      The current status of the pentest job.

    • createdAt (datetime) --

      The date and time the pentest job was created, in UTC format.

    • updatedAt (datetime) --

      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.

BatchDisassociateFindingIssue (updated) Link ¶
Changes (response)
{'errors': {'code': {'PAUSED_BY_USER'}}}

Disassociates a batch of findings from their linked issues.

See also: AWS API Documentation

Request Syntax

client.batch_disassociate_finding_issue(
    agentSpaceId='string',
    pentestJobId='string',
    codeReviewJobId='string',
    findingIds=[
        'string',
    ]
)
type agentSpaceId:

string

param agentSpaceId:

[REQUIRED]

The identifier of the agent space where the job exists.

type pentestJobId:

string

param pentestJobId:

The identifier of the penetration test job. This parameter is mutually exclusive with codeReviewJobId.

type codeReviewJobId:

string

param codeReviewJobId:

The identifier of the code review job. This parameter is mutually exclusive with pentestJobId.

type findingIds:

list

param findingIds:

[REQUIRED]

The identifiers of the findings to disassociate from their issues. Each must belong to the specified job.

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'errors': [
        {
            'findingId': 'string',
            'code': 'CLIENT_ERROR'|'INTERNAL_ERROR'|'STOPPED_BY_USER'|'PAUSED_BY_USER',
            'message': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    The output for the BatchDisassociateFindingIssue operation.

    • errors (list) --

      The findings whose issue could not be disassociated.

      • (dict) --

        A finding that failed to disassociate, with the cause of the failure.

        • findingId (string) --

          The identifier of the finding that failed to disassociate.

        • code (string) --

          The machine-readable failure category.

        • message (string) --

          A customer-facing explanation of the failure.

BatchExportFindings (updated) Link ¶
Changes (response)
{'errors': {'code': {'PAUSED_BY_USER'}}}

Exports a batch of findings to the connected issue tracker as issues.

See also: AWS API Documentation

Request Syntax

client.batch_export_findings(
    agentSpaceId='string',
    pentestJobId='string',
    codeReviewJobId='string',
    issueDestination={
        'integrationId': 'string',
        'projectKey': 'string'
    },
    findingIds=[
        'string',
    ]
)
type agentSpaceId:

string

param agentSpaceId:

[REQUIRED]

The identifier of the agent space where the job exists.

type pentestJobId:

string

param pentestJobId:

The identifier of the penetration test job. This parameter is mutually exclusive with codeReviewJobId.

type codeReviewJobId:

string

param codeReviewJobId:

The identifier of the code review job. This parameter is mutually exclusive with pentestJobId.

type issueDestination:

dict

param issueDestination:

[REQUIRED]

The destination issue-tracker project the findings are exported to. Must be a connected capability of the agent space.

  • integrationId (string) -- [REQUIRED]

    The integration identifier for the issue-tracker provider.

  • projectKey (string) -- [REQUIRED]

    The identifier of the project the issues are filed under.

type findingIds:

list

param findingIds:

[REQUIRED]

The identifiers of the findings to export. Each must belong to the specified job.

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'results': [
        {
            'findingId': 'string',
            'linkedIssue': {
                'provider': 'GITHUB'|'GITLAB'|'BITBUCKET'|'CONFLUENCE'|'AZURE_DEVOPS'|'JIRA',
                'integrationId': 'string',
                'projectKey': 'string',
                'issueKey': 'string',
                'issueId': 'string',
                'issueUrl': 'string',
                'siteUrl': 'string'
            }
        },
    ],
    'errors': [
        {
            'findingId': 'string',
            'code': 'CLIENT_ERROR'|'INTERNAL_ERROR'|'STOPPED_BY_USER'|'PAUSED_BY_USER',
            'message': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    The output for the BatchExportFindings operation.

    • results (list) --

      The findings whose issue was created, each with its linked issue.

      • (dict) --

        A finding whose issue was created.

        • findingId (string) --

          The identifier of the finding this result corresponds to.

        • linkedIssue (dict) --

          The issue that was created for the finding.

          • provider (string) --

            The issue-tracker provider.

          • integrationId (string) --

            The integration identifier for the issue-tracker provider.

          • projectKey (string) --

            The key of the project the issue belongs to.

          • issueKey (string) --

            The issue key.

          • issueId (string) --

            The stable numeric issue identifier.

          • issueUrl (string) --

            The issue URL.

          • siteUrl (string) --

            The Atlassian Cloud site URL.

    • errors (list) --

      The findings whose issue could not be created, each with a customer-facing reason.

      • (dict) --

        A finding whose issue could not be created, with the cause of the failure.

        • findingId (string) --

          The identifier of the finding this error corresponds to.

        • code (string) --

          The machine-readable failure category.

        • message (string) --

          A customer-facing explanation of why the issue could not be created.

BatchGetCodeReviewJobs (updated) Link ¶
Changes (response)
{'codeReviewJobs': {'errorInformation': {'code': {'PAUSED_BY_USER'}},
                    'status': {'PAUSED', 'PAUSING'}}}

Retrieves information about one or more code review jobs in an agent space.

See also: AWS API Documentation

Request Syntax

client.batch_get_code_review_jobs(
    codeReviewJobIds=[
        'string',
    ],
    agentSpaceId='string'
)
type codeReviewJobIds:

list

param codeReviewJobIds:

[REQUIRED]

The list of code review job identifiers to retrieve.

  • (string) --

type agentSpaceId:

string

param agentSpaceId:

[REQUIRED]

The unique identifier of the agent space that contains the code review jobs.

rtype:

dict

returns:

Response Syntax

{
    'codeReviewJobs': [
        {
            'codeReviewJobId': 'string',
            'codeReviewId': 'string',
            'title': 'string',
            'overview': 'string',
            'status': 'IN_PROGRESS'|'STOPPING'|'STOPPED'|'PAUSING'|'PAUSED'|'FAILED'|'COMPLETED',
            'documents': [
                {
                    's3Location': 'string',
                    'artifactId': 'string',
                    'integratedDocument': {
                        'integrationId': 'string',
                        'resourceId': 'string'
                    }
                },
            ],
            'sourceCode': [
                {
                    's3Location': 'string'
                },
            ],
            'steps': [
                {
                    'name': 'PREFLIGHT'|'STATIC_ANALYSIS'|'PENTEST'|'FINALIZING'|'VALIDATION',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOPPED',
                    'createdAt': datetime(2015, 1, 1),
                    'updatedAt': datetime(2015, 1, 1)
                },
            ],
            'executionContext': [
                {
                    'contextType': 'ERROR'|'CLIENT_ERROR'|'WARNING'|'INFO',
                    'context': 'string',
                    'timestamp': datetime(2015, 1, 1)
                },
            ],
            'serviceRole': 'string',
            'logConfig': {
                'logGroup': 'string',
                'logStream': 'string'
            },
            'errorInformation': {
                'code': 'CLIENT_ERROR'|'INTERNAL_ERROR'|'STOPPED_BY_USER'|'PAUSED_BY_USER',
                'message': 'string'
            },
            'integratedRepositories': [
                {
                    'integrationId': 'string',
                    'providerResourceId': 'string',
                    'branch': 'string'
                },
            ],
            'codeRemediationStrategy': 'AUTOMATIC'|'DISABLED',
            'maxTaskHours': 123.0,
            'reportDestination': {
                'integrationId': 'string',
                'containerId': 'string',
                'parentId': 'string',
                'documentId': 'string'
            },
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'notFound': [
        'string',
    ]
}

Response Structure

  • (dict) --

    Output for the BatchGetCodeReviewJobs operation.

    • codeReviewJobs (list) --

      The list of code review jobs that were found.

      • (dict) --

        Represents a code review job, which is an execution instance of a code review. A code review job progresses through preflight, static analysis, and finalizing steps.

        • codeReviewJobId (string) --

          The unique identifier of the code review job.

        • codeReviewId (string) --

          The unique identifier of the code review associated with the job.

        • title (string) --

          The title of the code review job.

        • overview (string) --

          An overview of the code review job results.

        • status (string) --

          The current status of the code review job.

        • documents (list) --

          The list of documents providing context for the code review job.

          • (dict) --

            Represents a document that provides context for security testing.

            • s3Location (string) --

              The Amazon S3 location of the document.

            • artifactId (string) --

              The unique identifier of the artifact associated with the document.

            • integratedDocument (dict) --

              A reference to a document in an integrated third-party provider.

              • integrationId (string) --

                The identifier of the integration that provides access to the document.

              • resourceId (string) --

                The provider-specific resource identifier for the document.

        • sourceCode (list) --

          The list of source code repositories analyzed during the code review job.

          • (dict) --

            Represents a source code repository used for security analysis during a pentest.

            • s3Location (string) --

              The Amazon S3 location of the source code repository archive.

        • steps (list) --

          The list of steps in the code review job execution.

          • (dict) --

            Represents a step in the pentest job execution pipeline. Steps include preflight, static analysis, pentest, and finalizing.

            • name (string) --

              The name of the step. Valid values include PREFLIGHT, STATIC_ANALYSIS, PENTEST, VALIDATION, and FINALIZING.

            • status (string) --

              The current status of the step.

            • createdAt (datetime) --

              The date and time the step was created, in UTC format.

            • updatedAt (datetime) --

              The date and time the step was last updated, in UTC format.

        • executionContext (list) --

          The execution context messages for the code review job.

          • (dict) --

            Contains contextual information about the execution of a pentest job, such as errors, warnings, or informational messages.

            • contextType (string) --

              The type of context. Valid values include ERROR, CLIENT_ERROR, WARNING, and INFO.

            • context (string) --

              The context message.

            • timestamp (datetime) --

              The date and time the context was recorded, in UTC format.

        • serviceRole (string) --

          The IAM service role used for the code review job.

        • logConfig (dict) --

          The CloudWatch Logs configuration for the code review job.

          • logGroup (string) --

            The name of the CloudWatch log group.

          • logStream (string) --

            The name of the CloudWatch log stream.

        • errorInformation (dict) --

          Error information if the code review job encountered an error.

          • code (string) --

            The error code. Valid values include CLIENT_ERROR, INTERNAL_ERROR, and STOPPED_BY_USER.

          • message (string) --

            A message describing the error.

        • integratedRepositories (list) --

          The list of integrated repositories associated with the code review job.

          • (dict) --

            Represents a code repository that is integrated with the service through a third-party provider.

            • integrationId (string) --

              The unique identifier of the integration that provides access to the repository.

            • providerResourceId (string) --

              The provider-specific resource identifier for the repository.

            • branch (string) --

              An optional override for the repository branch.

        • codeRemediationStrategy (string) --

          The code remediation strategy for the code review job.

        • maxTaskHours (float) --

          The maximum number of billable task hours allowed for this code review job. If the cumulative task hours reach this limit, the job is gracefully stopped.

        • reportDestination (dict) --

          The destination for publishing scan reports to an integrated document provider.

          • integrationId (string) --

            The integration identifier for the document provider.

          • containerId (string) --

            The container identifier where the report will be published.

          • parentId (string) --

            The parent document identifier under which the report will be created.

          • documentId (string) --

            The existing document identifier to update instead of creating a new document.

        • createdAt (datetime) --

          The date and time the code review job was created, in UTC format.

        • updatedAt (datetime) --

          The date and time the code review job was last updated, in UTC format.

    • notFound (list) --

      The list of code review job identifiers that were not found.

      • (string) --

BatchGetPentestJobs (updated) Link ¶
Changes (response)
{'pentestJobs': {'errorInformation': {'code': {'PAUSED_BY_USER'}},
                 'status': {'PAUSED', 'PAUSING'},
                 'version': 'string'}}

Retrieves information about one or more pentest jobs in an agent space.

See also: AWS API Documentation

Request Syntax

client.batch_get_pentest_jobs(
    pentestJobIds=[
        'string',
    ],
    agentSpaceId='string'
)
type pentestJobIds:

list

param pentestJobIds:

[REQUIRED]

The list of pentest job identifiers to retrieve.

  • (string) --

type agentSpaceId:

string

param agentSpaceId:

[REQUIRED]

The unique identifier of the agent space that contains the pentest jobs.

rtype:

dict

returns:

Response Syntax

{
    'pentestJobs': [
        {
            'pentestJobId': 'string',
            'pentestId': 'string',
            'title': 'string',
            'overview': 'string',
            'status': 'IN_PROGRESS'|'STOPPING'|'STOPPED'|'PAUSING'|'PAUSED'|'FAILED'|'COMPLETED',
            'endpoints': [
                {
                    'uri': 'string'
                },
            ],
            'actors': [
                {
                    'identifier': 'string',
                    'uris': [
                        'string',
                    ],
                    'authentication': {
                        'providerType': 'SECRETS_MANAGER'|'AWS_LAMBDA'|'AWS_IAM_ROLE'|'AWS_INTERNAL',
                        'value': 'string'
                    },
                    'description': 'string',
                    'enableEmailMfa': True|False,
                    'mfaForwardingAddress': 'string'
                },
            ],
            'documents': [
                {
                    's3Location': 'string',
                    'artifactId': 'string',
                    'integratedDocument': {
                        'integrationId': 'string',
                        'resourceId': 'string'
                    }
                },
            ],
            'sourceCode': [
                {
                    's3Location': 'string'
                },
            ],
            'excludePaths': [
                {
                    'uri': 'string'
                },
            ],
            'allowedDomains': [
                {
                    'uri': 'string'
                },
            ],
            'excludeRiskTypes': [
                'CROSS_SITE_SCRIPTING'|'DEFAULT_CREDENTIALS'|'INSECURE_DIRECT_OBJECT_REFERENCE'|'PRIVILEGE_ESCALATION'|'SERVER_SIDE_TEMPLATE_INJECTION'|'COMMAND_INJECTION'|'CODE_INJECTION'|'SQL_INJECTION'|'ARBITRARY_FILE_UPLOAD'|'INSECURE_DESERIALIZATION'|'LOCAL_FILE_INCLUSION'|'INFORMATION_DISCLOSURE'|'PATH_TRAVERSAL'|'SERVER_SIDE_REQUEST_FORGERY'|'JSON_WEB_TOKEN_VULNERABILITIES'|'XML_EXTERNAL_ENTITY'|'FILE_DELETION'|'OTHER'|'GRAPHQL_VULNERABILITIES'|'BUSINESS_LOGIC_VULNERABILITIES'|'CRYPTOGRAPHIC_VULNERABILITIES'|'DENIAL_OF_SERVICE'|'FILE_ACCESS'|'FILE_CREATION'|'DATABASE_MODIFICATION'|'DATABASE_ACCESS'|'OUTBOUND_SERVICE_REQUEST'|'UNKNOWN',
            ],
            'steps': [
                {
                    'name': 'PREFLIGHT'|'STATIC_ANALYSIS'|'PENTEST'|'FINALIZING'|'VALIDATION',
                    'status': 'NOT_STARTED'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOPPED',
                    'createdAt': datetime(2015, 1, 1),
                    'updatedAt': datetime(2015, 1, 1)
                },
            ],
            'executionContext': [
                {
                    'contextType': 'ERROR'|'CLIENT_ERROR'|'WARNING'|'INFO',
                    'context': 'string',
                    'timestamp': datetime(2015, 1, 1)
                },
            ],
            'serviceRole': 'string',
            'logConfig': {
                'logGroup': 'string',
                'logStream': 'string'
            },
            'vpcConfig': {
                'vpcArn': 'string',
                'securityGroupArns': [
                    'string',
                ],
                'subnetArns': [
                    'string',
                ]
            },
            'networkTrafficConfig': {
                'rules': [
                    {
                        'effect': 'ALLOW'|'DENY',
                        'pattern': 'string',
                        'networkTrafficRuleType': 'URL'
                    },
                ],
                'customHeaders': [
                    {
                        'name': 'string',
                        'value': 'string'
                    },
                ]
            },
            'errorInformation': {
                'code': 'CLIENT_ERROR'|'INTERNAL_ERROR'|'STOPPED_BY_USER'|'PAUSED_BY_USER',
                'message': 'string'
            },
            'integratedRepositories': [
                {
                    'integrationId': 'string',
                    'providerResourceId': 'string',
                    'branch': 'string'
                },
            ],
            'trustedCaCertificates': [
                {
                    'source': {
                        'inlinePem': 'string',
                        'artifactId': 'string',
                        's3Location': 'string'
                    }
                },
            ],
            'clientCertificates': [
                {
                    'name': 'string',
                    'secretArn': 'string',
                    'origins': [
                        'string',
                    ]
                },
            ],
            'codeRemediationStrategy': 'AUTOMATIC'|'DISABLED',
            'cleanUpStrategy': 'BEST_EFFORT_DELETE'|'RETAIN_ALL',
            'disableManagedSkills': [
                'FINDING_PERSONALIZATION'|'LOGIN_OPTIMIZATION',
            ],
            'maxTaskHours': 123.0,
            'jobType': 'FULL'|'REVALIDATION'|'CICD',
            'selectedFindingIds': [
                'string',
            ],
            'reportDestination': {
                'integrationId': 'string',
                'containerId': 'string',
                'parentId': 'string',
                'documentId': 'string'
            },
            'reportUrl': 'string',
            'scopeResult': {
                'decision': 'IN_SCOPE'|'SCOPED_OUT'|'SCOPE_CONFLICT',
                'reason': 'string'
            },
            'scopeChanges': [
                {
                    'integrationId': 'string',
                    'providerResourceId': 'string',
                    'baseCommitSha': 'string',
                    'headCommitSha': 'string',
                    'triggerRunId': 'string'
                },
            ],
            'cicdConfiguration': {
                'enabled': True|False
            },
            'testScope': {
                'type': 'WEB_APP'|'GENERATIVE_AI_APP'
            },
            'version': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'notFound': [
        'string',
    ]
}

Response Structure

  • (dict) --

    Output for the BatchGetPentestJobs operation.

    • pentestJobs (list) --

      The list of pentest jobs that were found.

      • (dict) --

        Represents a pentest job, which is an execution instance of a pentest. A pentest job progresses through preflight, static analysis, pentest, and finalizing steps.

        • pentestJobId (string) --

          The unique identifier of the pentest job.

        • pentestId (string) --

          The unique identifier of the pentest associated with the job.

        • title (string) --

          The title of the pentest job.

        • overview (string) --

          An overview of the pentest job results.

        • status (string) --

          The current status of the pentest job.

        • endpoints (list) --

          The list of endpoints being tested in the pentest job.

          • (dict) --

            Represents a target endpoint for penetration testing.

            • uri (string) --

              The URI of the endpoint.

        • actors (list) --

          The list of actors used during the pentest job.

          • (dict) --

            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 (dict) --

              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.

              • value (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.

        • documents (list) --

          The list of documents providing context for the pentest job.

          • (dict) --

            Represents a document that provides context for security testing.

            • s3Location (string) --

              The Amazon S3 location of the document.

            • artifactId (string) --

              The unique identifier of the artifact associated with the document.

            • integratedDocument (dict) --

              A reference to a document in an integrated third-party provider.

              • integrationId (string) --

                The identifier of the integration that provides access to the document.

              • resourceId (string) --

                The provider-specific resource identifier for the document.

        • sourceCode (list) --

          The list of source code repositories analyzed during the pentest job.

          • (dict) --

            Represents a source code repository used for security analysis during a pentest.

            • s3Location (string) --

              The Amazon S3 location of the source code repository archive.

        • excludePaths (list) --

          The list of paths excluded from the pentest job.

          • (dict) --

            Represents a target endpoint for penetration testing.

            • uri (string) --

              The URI of the endpoint.

        • allowedDomains (list) --

          The list of domains allowed during the pentest job.

          • (dict) --

            Represents a target endpoint for penetration testing.

            • uri (string) --

              The URI of the endpoint.

        • excludeRiskTypes (list) --

          The list of risk types excluded from the pentest job.

          • (string) --

            Type of security risk.

        • steps (list) --

          The list of steps in the pentest job execution.

          • (dict) --

            Represents a step in the pentest job execution pipeline. Steps include preflight, static analysis, pentest, and finalizing.

            • name (string) --

              The name of the step. Valid values include PREFLIGHT, STATIC_ANALYSIS, PENTEST, VALIDATION, and FINALIZING.

            • status (string) --

              The current status of the step.

            • createdAt (datetime) --

              The date and time the step was created, in UTC format.

            • updatedAt (datetime) --

              The date and time the step was last updated, in UTC format.

        • executionContext (list) --

          The execution context messages for the pentest job.

          • (dict) --

            Contains contextual information about the execution of a pentest job, such as errors, warnings, or informational messages.

            • contextType (string) --

              The type of context. Valid values include ERROR, CLIENT_ERROR, WARNING, and INFO.

            • context (string) --

              The context message.

            • timestamp (datetime) --

              The date and time the context was recorded, in UTC format.

        • serviceRole (string) --

          The IAM service role used for the pentest job.

        • logConfig (dict) --

          The CloudWatch Logs configuration for the pentest job.

          • logGroup (string) --

            The name of the CloudWatch log group.

          • logStream (string) --

            The name of the CloudWatch log stream.

        • vpcConfig (dict) --

          The VPC configuration for the pentest job.

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

        • networkTrafficConfig (dict) --

          The network traffic configuration for the pentest job.

          • rules (list) --

            The list of network traffic rules that control which URLs are allowed or denied during testing.

            • (dict) --

              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.

              • pattern (string) --

                The URL pattern to match for the rule.

              • networkTrafficRuleType (string) --

                The type of the network traffic rule. Currently, only URL is supported.

          • customHeaders (list) --

            The list of custom HTTP headers to include in network traffic during testing.

            • (dict) --

              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.

        • errorInformation (dict) --

          Error information if the pentest job encountered an error.

          • code (string) --

            The error code. Valid values include CLIENT_ERROR, INTERNAL_ERROR, and STOPPED_BY_USER.

          • message (string) --

            A message describing the error.

        • integratedRepositories (list) --

          The list of integrated repositories associated with the pentest job.

          • (dict) --

            Represents a code repository that is integrated with the service through a third-party provider.

            • integrationId (string) --

              The unique identifier of the integration that provides access to the repository.

            • providerResourceId (string) --

              The provider-specific resource identifier for the repository.

            • branch (string) --

              An optional override for the repository branch.

        • trustedCaCertificates (list) --

          The trust anchors used to validate target endpoint TLS certificates during the pentest job.

          • (dict) --

            A trust anchor used when validating a target endpoint's TLS certificate.

            • source (dict) --

              The source that Security Agent reads the certificate from.

              • inlinePem (string) --

                A PEM-encoded X.509 certificate supplied inline.

              • artifactId (string) --

                The artifact ID of an uploaded certificate file.

              • s3Location (string) --

                The Amazon S3 location URI of a customer-staged certificate.

        • clientCertificates (list) --

          The client certificates for mutual TLS (mTLS) authentication to target hosts during the pentest job.

          • (dict) --

            A client certificate for mutual TLS (mTLS) authentication to target hosts.

            • name (string) --

              A customer-chosen name for this client certificate, used in error messages and console display.

            • secretArn (string) --

              The ARN of the Secrets Manager secret containing the certificate and private key.

            • origins (list) --

              The origins (scheme://host[:port]) this certificate applies to. Paths are not supported. Each hostname can have at most one client certificate.

              • (string) --

        • codeRemediationStrategy (string) --

          The code remediation strategy for the pentest job.

        • cleanUpStrategy (string) --

          Strategy for cleaning up resources after pentest job completion.

        • disableManagedSkills (list) --

          A list of managed skills disabled for this pentest job. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION.

          • (string) --

            Type of managed skill that can be enabled or disabled for a pentest.

        • maxTaskHours (float) --

          The maximum number of billable task hours allowed for this pentest job. If the cumulative task hours reach this limit, the job is gracefully stopped.

        • jobType (string) --

          The type of the pentest job. Valid values are FULL, REVALIDATION, and CICD.

        • selectedFindingIds (list) --

          The list of finding identifiers selected for revalidation. Present only when jobType is REVALIDATION.

          • (string) --

        • reportDestination (dict) --

          The destination for publishing scan reports to an integrated document provider.

          • integrationId (string) --

            The integration identifier for the document provider.

          • containerId (string) --

            The container identifier where the report will be published.

          • parentId (string) --

            The parent document identifier under which the report will be created.

          • documentId (string) --

            The existing document identifier to update instead of creating a new document.

        • reportUrl (string) --

          The URL to view this pentest job's findings report in the console.

        • scopeResult (dict) --

          The scoping outcome for this CI/CD pentest job. Present only for jobs of type CICD.

          • decision (string) --

            The scoping decision for the job's code changes.

          • reason (string) --

            A human-readable explanation of the scoping decision.

        • scopeChanges (list) --

          The code changes that defined the scope of this CI/CD pentest job. Present only for jobs of type CICD.

          • (dict) --

            A code change in a CI/CD pipeline run that defines what a CI/CD pentest job tests. Each scope change identifies an integrated repository and the commit range for the change.

            • integrationId (string) --

              The identifier of the integration for the source-code provider that hosts the repository.

            • providerResourceId (string) --

              The provider-specific identifier of the repository the change belongs to.

            • baseCommitSha (string) --

              The commit SHA that the change is compared against. When omitted, the change is evaluated against the head commit alone.

            • headCommitSha (string) --

              The commit SHA at the tip of the change to be tested.

            • triggerRunId (string) --

              The identifier of the CI/CD pipeline run that triggered this pentest job.

        • cicdConfiguration (dict) --

          The configuration that enables a pentest to run as part of a CI/CD pipeline, scoped to the code changes in each pipeline run.

          • enabled (boolean) --

            Whether CI/CD pentesting is enabled for this pentest.

        • testScope (dict) --

          The category of application a pentest targets.

          • type (string) --

            The category of application under test.

        • version (string) --

          The version of the pentest job. The version increases each time the job is resumed. This value is absent for jobs created before versions were recorded.

        • createdAt (datetime) --

          The date and time the pentest job was created, in UTC format.

        • updatedAt (datetime) --

          The date and time the pentest job was last updated, in UTC format.

    • notFound (list) --

      The list of pentest job identifiers that were not found.

      • (string) --

BatchGetThreatModelJobs (updated) Link ¶
Changes (response)
{'threatModelJobs': {'errorInformation': {'code': {'PAUSED_BY_USER'}},
                     'status': {'PAUSED', 'PAUSING'}}}

Retrieves information about one or more threat model jobs in an agent space.

See also: AWS API Documentation

Request Syntax

client.batch_get_threat_model_jobs(
    threatModelJobIds=[
        'string',
    ],
    agentSpaceId='string'
)
type threatModelJobIds:

list

param threatModelJobIds:

[REQUIRED]

The list of threat model job identifiers to retrieve.

  • (string) --

type agentSpaceId:

string

param agentSpaceId:

[REQUIRED]

The unique identifier of the agent space that contains the threat model jobs.

rtype:

dict

returns:

Response Syntax

{
    'threatModelJobs': [
        {
            'threatModelJobId': 'string',
            'threatModelId': 'string',
            'agentSpaceId': 'string',
            'title': 'string',
            'status': 'IN_PROGRESS'|'STOPPING'|'STOPPED'|'PAUSING'|'PAUSED'|'FAILED'|'COMPLETED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'executionStartTime': datetime(2015, 1, 1),
            'executionEndTime': datetime(2015, 1, 1),
            'sourceCode': [
                {
                    's3Location': 'string'
                },
            ],
            'integratedRepositories': [
                {
                    'integrationId': 'string',
                    'providerResourceId': 'string',
                    'branch': 'string'
                },
            ],
            'documents': [
                {
                    's3Location': 'string',
                    'artifactId': 'string',
                    'integratedDocument': {
                        'integrationId': 'string',
                        'resourceId': 'string'
                    }
                },
            ],
            'scopeDocs': [
                {
                    's3Location': 'string',
                    'artifactId': 'string',
                    'integratedDocument': {
                        'integrationId': 'string',
                        'resourceId': 'string'
                    }
                },
            ],
            'errorInformation': {
                'code': 'CLIENT_ERROR'|'INTERNAL_ERROR'|'STOPPED_BY_USER'|'PAUSED_BY_USER',
                'message': 'string'
            },
            'systemOverview': 'string',
            'reportDestination': {
                'integrationId': 'string',
                'containerId': 'string',
                'parentId': 'string',
                'documentId': 'string'
            }
        },
    ],
    'notFound': [
        'string',
    ]
}

Response Structure

  • (dict) --

    Output for the BatchGetThreatModelJobs operation.

    • threatModelJobs (list) --

      The list of threat model jobs that were found.

      • (dict) --

        Represents a threat model job, which is an execution instance of a threat model.

        • threatModelJobId (string) --

          The unique identifier of the threat model job.

        • threatModelId (string) --

          The unique identifier of the threat model associated with the job.

        • agentSpaceId (string) --

          The unique identifier of the agent space.

        • title (string) --

          The title of the threat model job.

        • status (string) --

          The current status of the threat model job.

        • createdAt (datetime) --

          The date and time the threat model job was created, in UTC format.

        • updatedAt (datetime) --

          The date and time the threat model job was last updated, in UTC format.

        • executionStartTime (datetime) --

          The date and time the threat model job execution started, in UTC format.

        • executionEndTime (datetime) --

          The date and time the threat model job execution ended, in UTC format.

        • sourceCode (list) --

          The list of source code repositories used for threat modeling.

          • (dict) --

            Represents a source code repository used for security analysis during a pentest.

            • s3Location (string) --

              The Amazon S3 location of the source code repository archive.

        • integratedRepositories (list) --

          The list of integrated repositories used for threat modeling.

          • (dict) --

            Represents a code repository that is integrated with the service through a third-party provider.

            • integrationId (string) --

              The unique identifier of the integration that provides access to the repository.

            • providerResourceId (string) --

              The provider-specific resource identifier for the repository.

            • branch (string) --

              An optional override for the repository branch.

        • documents (list) --

          The list of documents used for threat modeling.

          • (dict) --

            Represents a document that provides context for security testing.

            • s3Location (string) --

              The Amazon S3 location of the document.

            • artifactId (string) --

              The unique identifier of the artifact associated with the document.

            • integratedDocument (dict) --

              A reference to a document in an integrated third-party provider.

              • integrationId (string) --

                The identifier of the integration that provides access to the document.

              • resourceId (string) --

                The provider-specific resource identifier for the document.

        • scopeDocs (list) --

          The scoped documents for the agent to focus on during threat modeling.

          • (dict) --

            Represents a document that provides context for security testing.

            • s3Location (string) --

              The Amazon S3 location of the document.

            • artifactId (string) --

              The unique identifier of the artifact associated with the document.

            • integratedDocument (dict) --

              A reference to a document in an integrated third-party provider.

              • integrationId (string) --

                The identifier of the integration that provides access to the document.

              • resourceId (string) --

                The provider-specific resource identifier for the document.

        • errorInformation (dict) --

          Error information if the threat model job encountered an error.

          • code (string) --

            The error code. Valid values include CLIENT_ERROR, INTERNAL_ERROR, and STOPPED_BY_USER.

          • message (string) --

            A message describing the error.

        • systemOverview (string) --

          The system overview generated during threat modeling.

        • reportDestination (dict) --

          The destination for publishing scan reports to an integrated document provider.

          • integrationId (string) --

            The integration identifier for the document provider.

          • containerId (string) --

            The container identifier where the report will be published.

          • parentId (string) --

            The parent document identifier under which the report will be created.

          • documentId (string) --

            The existing document identifier to update instead of creating a new document.

    • notFound (list) --

      The list of threat model job identifiers that were not found.

      • (string) --

ListCodeReviewJobsForCodeReview (updated) Link ¶
Changes (response)
{'codeReviewJobSummaries': {'status': {'PAUSED', 'PAUSING'}}}

Returns a paginated list of code review job summaries for the specified code review configuration.

See also: AWS API Documentation

Request Syntax

client.list_code_review_jobs_for_code_review(
    maxResults=123,
    codeReviewId='string',
    agentSpaceId='string',
    nextToken='string'
)
type maxResults:

integer

param maxResults:

The maximum number of results to return in a single call.

type codeReviewId:

string

param codeReviewId:

[REQUIRED]

The unique identifier of the code review to list jobs for.

type agentSpaceId:

string

param agentSpaceId:

[REQUIRED]

The unique identifier of the agent space.

type nextToken:

string

param nextToken:

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

rtype:

dict

returns:

Response Syntax

{
    'codeReviewJobSummaries': [
        {
            'codeReviewJobId': 'string',
            'codeReviewId': 'string',
            'title': 'string',
            'status': 'IN_PROGRESS'|'STOPPING'|'STOPPED'|'PAUSING'|'PAUSED'|'FAILED'|'COMPLETED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    Output for the ListCodeReviewJobsForCodeReview operation.

    • codeReviewJobSummaries (list) --

      The list of code review job summaries.

      • (dict) --

        Contains summary information about a code review job.

        • codeReviewJobId (string) --

          The unique identifier of the code review job.

        • codeReviewId (string) --

          The unique identifier of the code review associated with the job.

        • title (string) --

          The title of the code review job.

        • status (string) --

          The current status of the code review job.

        • createdAt (datetime) --

          The date and time the code review job was created, in UTC format.

        • updatedAt (datetime) --

          The date and time the code review job was last updated, in UTC format.

    • nextToken (string) --

      A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

ListPentestJobsForPentest (updated) Link ¶
Changes (response)
{'pentestJobSummaries': {'status': {'PAUSED', 'PAUSING'}, 'version': 'string'}}

Returns a paginated list of pentest job summaries for the specified pentest configuration.

See also: AWS API Documentation

Request Syntax

client.list_pentest_jobs_for_pentest(
    maxResults=123,
    pentestId='string',
    agentSpaceId='string',
    nextToken='string',
    jobType='FULL'|'REVALIDATION'|'CICD'
)
type maxResults:

integer

param maxResults:

The maximum number of results to return in a single call.

type pentestId:

string

param pentestId:

[REQUIRED]

The unique identifier of the pentest to list jobs for.

type agentSpaceId:

string

param agentSpaceId:

[REQUIRED]

The unique identifier of the agent space.

type nextToken:

string

param nextToken:

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

type jobType:

string

param jobType:

Filters the returned pentest jobs to only those of the specified job type.

rtype:

dict

returns:

Response Syntax

{
    'pentestJobSummaries': [
        {
            'pentestJobId': 'string',
            'pentestId': 'string',
            'title': 'string',
            'status': 'IN_PROGRESS'|'STOPPING'|'STOPPED'|'PAUSING'|'PAUSED'|'FAILED'|'COMPLETED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'jobType': 'FULL'|'REVALIDATION'|'CICD',
            'reportUrl': 'string',
            'version': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    Output for the ListPentestJobsForPentest operation.

    • pentestJobSummaries (list) --

      The list of pentest job summaries.

      • (dict) --

        Contains summary information about a pentest job.

        • pentestJobId (string) --

          The unique identifier of the pentest job.

        • pentestId (string) --

          The unique identifier of the pentest associated with the job.

        • title (string) --

          The title of the pentest job.

        • status (string) --

          The current status of the pentest job.

        • createdAt (datetime) --

          The date and time the pentest job was created, in UTC format.

        • updatedAt (datetime) --

          The date and time the pentest job was last updated, in UTC format.

        • jobType (string) --

          The type of the pentest job. Valid values are FULL, REVALIDATION, and CICD.

        • reportUrl (string) --

          The URL to view this pentest job's findings report in the console.

        • version (string) --

          The version of the pentest job. The version increases each time the job is resumed. This value is absent for jobs created before versions were recorded.

    • nextToken (string) --

      A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

ListThreatModelJobs (updated) Link ¶
Changes (response)
{'threatModelJobSummaries': {'status': {'PAUSED', 'PAUSING'}}}

Returns a paginated list of threat model job summaries for the specified threat model.

See also: AWS API Documentation

Request Syntax

client.list_threat_model_jobs(
    maxResults=123,
    threatModelId='string',
    agentSpaceId='string',
    nextToken='string'
)
type maxResults:

integer

param maxResults:

The maximum number of results to return in a single call.

type threatModelId:

string

param threatModelId:

[REQUIRED]

The unique identifier of the threat model to list jobs for.

type agentSpaceId:

string

param agentSpaceId:

[REQUIRED]

The unique identifier of the agent space.

type nextToken:

string

param nextToken:

A token to use for paginating results that are returned in the response.

rtype:

dict

returns:

Response Syntax

{
    'threatModelJobSummaries': [
        {
            'threatModelJobId': 'string',
            'threatModelId': 'string',
            'agentSpaceId': 'string',
            'title': 'string',
            'status': 'IN_PROGRESS'|'STOPPING'|'STOPPED'|'PAUSING'|'PAUSED'|'FAILED'|'COMPLETED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    Output for the ListThreatModelJobs operation.

    • threatModelJobSummaries (list) --

      The list of threat model job summaries.

      • (dict) --

        Contains summary information about a threat model job.

        • threatModelJobId (string) --

          The unique identifier of the threat model job.

        • threatModelId (string) --

          The unique identifier of the threat model associated with the job.

        • agentSpaceId (string) --

          The unique identifier of the agent space.

        • title (string) --

          The title of the threat model job.

        • status (string) --

          The current status of the threat model job.

        • createdAt (datetime) --

          The date and time the threat model job was created, in UTC format.

        • updatedAt (datetime) --

          The date and time the threat model job was last updated, in UTC format.

    • nextToken (string) --

      A token to use for paginating results that are returned in the response.

StartCodeReviewJob (updated) Link ¶
Changes (response)
{'status': {'PAUSED', 'PAUSING'}}

Starts a new code review job for a code review configuration. The job executes the security-focused code analysis defined in the code review.

See also: AWS API Documentation

Request Syntax

client.start_code_review_job(
    agentSpaceId='string',
    codeReviewId='string',
    diffSource={
        's3Uri': 'string'
    }
)
type agentSpaceId:

string

param agentSpaceId:

[REQUIRED]

The unique identifier of the agent space.

type codeReviewId:

string

param codeReviewId:

[REQUIRED]

The unique identifier of the code review to start a job for.

type diffSource:

dict

param diffSource:

Source of the diff for a differential scan. When present, the job analyzes only the changed lines instead of performing a full scan.

  • s3Uri (string) --

    S3 URI pointing to a unified diff file. The file must be in standard unified diff format and stored in an S3 bucket connected to your Agent Space.

rtype:

dict

returns:

Response Syntax

{
    'title': 'string',
    'status': 'IN_PROGRESS'|'STOPPING'|'STOPPED'|'PAUSING'|'PAUSED'|'FAILED'|'COMPLETED',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'codeReviewId': 'string',
    'codeReviewJobId': 'string',
    'agentSpaceId': 'string'
}

Response Structure

  • (dict) --

    Output for the StartCodeReviewJob operation.

    • title (string) --

      The title of the code review job.

    • status (string) --

      The current status of the code review job.

    • createdAt (datetime) --

      The date and time the code review job was created, in UTC format.

    • updatedAt (datetime) --

      The date and time the code review job was last updated, in UTC format.

    • codeReviewId (string) --

      The unique identifier of the code review.

    • codeReviewJobId (string) --

      The unique identifier of the started code review job.

    • agentSpaceId (string) --

      The unique identifier of the agent space.

StartPentestJob (updated) Link ¶
Changes (response)
{'status': {'PAUSED', 'PAUSING'}}

Starts a new pentest job for a pentest configuration. The job executes the security tests defined in the pentest.

See also: AWS API Documentation

Request Syntax

client.start_pentest_job(
    agentSpaceId='string',
    pentestId='string',
    jobType='FULL'|'REVALIDATION'|'CICD',
    selectedFindingIds=[
        'string',
    ],
    scopeChanges=[
        {
            'integrationId': 'string',
            'providerResourceId': 'string',
            'baseCommitSha': 'string',
            'headCommitSha': 'string',
            'triggerRunId': 'string'
        },
    ]
)
type agentSpaceId:

string

param agentSpaceId:

[REQUIRED]

The unique identifier of the agent space.

type pentestId:

string

param pentestId:

[REQUIRED]

The unique identifier of the pentest to start a job for.

type jobType:

string

param jobType:

The type of pentest job to start. Valid values are FULL, REVALIDATION, and CICD. When set to REVALIDATION, the selectedFindingIds parameter is required. When set to CICD, the scopeChanges parameter defines the code changes to test.

type selectedFindingIds:

list

param selectedFindingIds:

The list of finding identifiers to revalidate. Required when jobType is REVALIDATION. Each finding must belong to the same agent space and pentest.

  • (string) --

type scopeChanges:

list

param scopeChanges:

The code changes that define the scope of a CI/CD pentest job. Provide this when starting a job with jobType CICD to test only the changes in the current pipeline run.

  • (dict) --

    A code change in a CI/CD pipeline run that defines what a CI/CD pentest job tests. Each scope change identifies an integrated repository and the commit range for the change.

    • integrationId (string) -- [REQUIRED]

      The identifier of the integration for the source-code provider that hosts the repository.

    • providerResourceId (string) -- [REQUIRED]

      The provider-specific identifier of the repository the change belongs to.

    • baseCommitSha (string) --

      The commit SHA that the change is compared against. When omitted, the change is evaluated against the head commit alone.

    • headCommitSha (string) -- [REQUIRED]

      The commit SHA at the tip of the change to be tested.

    • triggerRunId (string) --

      The identifier of the CI/CD pipeline run that triggered this pentest job.

rtype:

dict

returns:

Response Syntax

{
    'title': 'string',
    'status': 'IN_PROGRESS'|'STOPPING'|'STOPPED'|'PAUSING'|'PAUSED'|'FAILED'|'COMPLETED',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'pentestId': 'string',
    'pentestJobId': 'string',
    'agentSpaceId': 'string'
}

Response Structure

  • (dict) --

    Output for the StartPentestJob operation.

    • title (string) --

      The title of the pentest job.

    • status (string) --

      The current status of the pentest job.

    • createdAt (datetime) --

      The date and time the pentest job was created, in UTC format.

    • updatedAt (datetime) --

      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 started pentest job.

    • agentSpaceId (string) --

      The unique identifier of the agent space.

StartThreatModelJob (updated) Link ¶
Changes (response)
{'status': {'PAUSED', 'PAUSING'}}

Starts a new threat model job for a threat model configuration.

See also: AWS API Documentation

Request Syntax

client.start_threat_model_job(
    agentSpaceId='string',
    threatModelId='string'
)
type agentSpaceId:

string

param agentSpaceId:

[REQUIRED]

The unique identifier of the agent space.

type threatModelId:

string

param threatModelId:

[REQUIRED]

The unique identifier of the threat model to start a job for.

rtype:

dict

returns:

Response Syntax

{
    'title': 'string',
    'status': 'IN_PROGRESS'|'STOPPING'|'STOPPED'|'PAUSING'|'PAUSED'|'FAILED'|'COMPLETED',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1),
    'threatModelId': 'string',
    'threatModelJobId': 'string',
    'agentSpaceId': 'string'
}

Response Structure

  • (dict) --

    Output for the StartThreatModelJob operation.

    • title (string) --

      The title of the threat model job.

    • status (string) --

      The current status of the threat model job.

    • createdAt (datetime) --

      The date and time the threat model job was created, in UTC format.

    • updatedAt (datetime) --

      The date and time the threat model job was last updated, in UTC format.

    • threatModelId (string) --

      The unique identifier of the threat model.

    • threatModelJobId (string) --

      The unique identifier of the started threat model job.

    • agentSpaceId (string) --

      The unique identifier of the agent space.

StopPentestJob (updated) Link ¶
Changes (request)
{'pause': 'boolean'}

Stops a running pentest job. The job transitions to a stopping state and then to stopped after cleanup completes.

See also: AWS API Documentation

Request Syntax

client.stop_pentest_job(
    agentSpaceId='string',
    pentestJobId='string',
    pause=True|False
)
type agentSpaceId:

string

param agentSpaceId:

[REQUIRED]

The unique identifier of the agent space.

type pentestJobId:

string

param pentestJobId:

[REQUIRED]

The unique identifier of the pentest job to stop.

type pause:

boolean

param pause:

Specifies whether to pause the job instead of stopping it. A paused job moves to PAUSING and then to PAUSED, and you can resume it later with ResumePentestJob. You can pause only a job that is IN_PROGRESS. The default is false.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

    Output for the StopPentestJob operation.