AddArtifact

$result = $client->addArtifact([/* ... */]);
$promise = $client->addArtifactAsync([/* ... */]);

Uploads an artifact to an agent space. Artifacts provide additional context for security testing, such as architecture diagrams, API specifications, or configuration files.

Parameter Syntax

$result = $client->addArtifact([
    'agentSpaceId' => '<string>', // REQUIRED
    'artifactContent' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'artifactType' => 'TXT|PNG|JPEG|MD|PDF|DOCX|DOC|JSON|YAML', // REQUIRED
    'fileName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'artifactId' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

InternalServerException:

An unexpected error occurred during the processing of your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

BatchCreateSecurityRequirements

$result = $client->batchCreateSecurityRequirements([/* ... */]);
$promise = $client->batchCreateSecurityRequirementsAsync([/* ... */]);

Batch creates security requirements in a customer managed pack.

Parameter Syntax

$result = $client->batchCreateSecurityRequirements([
    'packId' => '<string>', // REQUIRED
    'securityRequirements' => [ // REQUIRED
        [
            'description' => '<string>', // REQUIRED
            'domain' => '<string>', // REQUIRED
            'evaluation' => '<string>', // REQUIRED
            'name' => '<string>', // REQUIRED
            'remediation' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'code' => '<string>',
            'message' => '<string>',
            'securityRequirementName' => '<string>',
        ],
        // ...
    ],
    'securityRequirements' => [
        [
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'domain' => '<string>',
            'evaluation' => '<string>',
            'name' => '<string>',
            'packId' => '<string>',
            'remediation' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

InternalServerException:

An unexpected error occurred during the processing of your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ServiceQuotaExceededException:

The request exceeds a service quota. Review your current usage and request a quota increase if needed.

BatchDeleteCodeReviews

$result = $client->batchDeleteCodeReviews([/* ... */]);
$promise = $client->batchDeleteCodeReviewsAsync([/* ... */]);

Deletes one or more code reviews from an agent space.

Parameter Syntax

$result = $client->batchDeleteCodeReviews([
    'agentSpaceId' => '<string>', // REQUIRED
    'codeReviewIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'deleted' => ['<string>', ...],
    'failed' => [
        [
            'codeReviewId' => '<string>',
            'reason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

BatchDeletePentests

$result = $client->batchDeletePentests([/* ... */]);
$promise = $client->batchDeletePentestsAsync([/* ... */]);

Deletes one or more pentests from an agent space.

Parameter Syntax

$result = $client->batchDeletePentests([
    'agentSpaceId' => '<string>', // REQUIRED
    'pentestIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'deleted' => [
        [
            'agentSpaceId' => '<string>',
            'assets' => [
                'actors' => [
                    [
                        'authentication' => [
                            'providerType' => 'SECRETS_MANAGER|AWS_LAMBDA|AWS_IAM_ROLE|AWS_INTERNAL',
                            'value' => '<string>',
                        ],
                        'description' => '<string>',
                        'identifier' => '<string>',
                        'uris' => ['<string>', ...],
                    ],
                    // ...
                ],
                'documents' => [
                    [
                        'artifactId' => '<string>',
                        'integratedDocument' => [
                            'integrationId' => '<string>',
                            'resourceId' => '<string>',
                        ],
                        's3Location' => '<string>',
                    ],
                    // ...
                ],
                'endpoints' => [
                    [
                        'uri' => '<string>',
                    ],
                    // ...
                ],
                'integratedRepositories' => [
                    [
                        'integrationId' => '<string>',
                        'providerResourceId' => '<string>',
                    ],
                    // ...
                ],
                'sourceCode' => [
                    [
                        's3Location' => '<string>',
                    ],
                    // ...
                ],
            ],
            'cleanUpStrategy' => 'BEST_EFFORT_DELETE|RETAIN_ALL',
            'codeRemediationStrategy' => 'AUTOMATIC|DISABLED',
            'createdAt' => <DateTime>,
            'disableManagedSkills' => ['<string>', ...],
            'excludeRiskTypes' => ['<string>', ...],
            'logConfig' => [
                'logGroup' => '<string>',
                'logStream' => '<string>',
            ],
            'networkTrafficConfig' => [
                'customHeaders' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'rules' => [
                    [
                        'effect' => 'ALLOW|DENY',
                        'networkTrafficRuleType' => 'URL',
                        'pattern' => '<string>',
                    ],
                    // ...
                ],
            ],
            'pentestId' => '<string>',
            'serviceRole' => '<string>',
            'title' => '<string>',
            'updatedAt' => <DateTime>,
            'vpcConfig' => [
                'securityGroupArns' => ['<string>', ...],
                'subnetArns' => ['<string>', ...],
                'vpcArn' => '<string>',
            ],
        ],
        // ...
    ],
    'failed' => [
        [
            'pentestId' => '<string>',
            'reason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

BatchDeleteSecurityRequirements

$result = $client->batchDeleteSecurityRequirements([/* ... */]);
$promise = $client->batchDeleteSecurityRequirementsAsync([/* ... */]);

Batch deletes security requirements from a customer managed pack.

Parameter Syntax

$result = $client->batchDeleteSecurityRequirements([
    'packId' => '<string>', // REQUIRED
    'securityRequirementNames' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'deletedSecurityRequirementNames' => ['<string>', ...],
    'errors' => [
        [
            'code' => '<string>',
            'message' => '<string>',
            'securityRequirementName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

InternalServerException:

An unexpected error occurred during the processing of your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

BatchDeleteThreatModels

$result = $client->batchDeleteThreatModels([/* ... */]);
$promise = $client->batchDeleteThreatModelsAsync([/* ... */]);

Deletes one or more threat models from an agent space.

Parameter Syntax

$result = $client->batchDeleteThreatModels([
    'agentSpaceId' => '<string>', // REQUIRED
    'threatModelIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'deleted' => ['<string>', ...],
    'failed' => [
        [
            'reason' => '<string>',
            'threatModelId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

BatchGetAgentSpaces

$result = $client->batchGetAgentSpaces([/* ... */]);
$promise = $client->batchGetAgentSpacesAsync([/* ... */]);

Retrieves information about one or more agent spaces.

Parameter Syntax

$result = $client->batchGetAgentSpaces([
    'agentSpaceIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'agentSpaces' => [
        [
            'agentSpaceId' => '<string>',
            'awsResources' => [
                'iamRoles' => ['<string>', ...],
                'lambdaFunctionArns' => ['<string>', ...],
                'logGroups' => ['<string>', ...],
                's3Buckets' => ['<string>', ...],
                'secretArns' => ['<string>', ...],
                'vpcs' => [
                    [
                        'securityGroupArns' => ['<string>', ...],
                        'subnetArns' => ['<string>', ...],
                        'vpcArn' => '<string>',
                    ],
                    // ...
                ],
            ],
            'codeReviewSettings' => [
                'controlsScanning' => true || false,
                'generalPurposeScanning' => true || false,
            ],
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'kmsKeyId' => '<string>',
            'name' => '<string>',
            'targetDomainIds' => ['<string>', ...],
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'notFound' => ['<string>', ...],
]

Result Details

Errors

There are no errors described for this operation.

BatchGetArtifactMetadata

$result = $client->batchGetArtifactMetadata([/* ... */]);
$promise = $client->batchGetArtifactMetadataAsync([/* ... */]);

Retrieves metadata for one or more artifacts in an agent space.

Parameter Syntax

$result = $client->batchGetArtifactMetadata([
    'agentSpaceId' => '<string>', // REQUIRED
    'artifactIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'artifactMetadataList' => [
        [
            'agentSpaceId' => '<string>',
            'artifactId' => '<string>',
            'fileName' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

InternalServerException:

An unexpected error occurred during the processing of your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

BatchGetCodeReviewJobTasks

$result = $client->batchGetCodeReviewJobTasks([/* ... */]);
$promise = $client->batchGetCodeReviewJobTasksAsync([/* ... */]);

Retrieves information about one or more tasks within a code review job.

Parameter Syntax

$result = $client->batchGetCodeReviewJobTasks([
    'agentSpaceId' => '<string>', // REQUIRED
    'codeReviewJobTaskIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'codeReviewJobTasks' => [
        [
            'agentSpaceId' => '<string>',
            'categories' => [
                [
                    'isPrimary' => true || false,
                    'name' => '<string>',
                ],
                // ...
            ],
            'codeReviewId' => '<string>',
            'codeReviewJobId' => '<string>',
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'executionStatus' => 'IN_PROGRESS|ABORTED|COMPLETED|INTERNAL_ERROR|FAILED',
            'logsLocation' => [
                'cloudWatchLog' => [
                    'logGroup' => '<string>',
                    'logStream' => '<string>',
                ],
                'logType' => 'CLOUDWATCH',
            ],
            'riskType' => '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',
            'taskId' => '<string>',
            'title' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'notFound' => ['<string>', ...],
]

Result Details

Errors

There are no errors described for this operation.

BatchGetCodeReviewJobs

$result = $client->batchGetCodeReviewJobs([/* ... */]);
$promise = $client->batchGetCodeReviewJobsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchGetCodeReviewJobs([
    'agentSpaceId' => '<string>', // REQUIRED
    'codeReviewJobIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'codeReviewJobs' => [
        [
            'codeRemediationStrategy' => 'AUTOMATIC|DISABLED',
            'codeReviewId' => '<string>',
            'codeReviewJobId' => '<string>',
            'createdAt' => <DateTime>,
            'documents' => [
                [
                    'artifactId' => '<string>',
                    'integratedDocument' => [
                        'integrationId' => '<string>',
                        'resourceId' => '<string>',
                    ],
                    's3Location' => '<string>',
                ],
                // ...
            ],
            'errorInformation' => [
                'code' => 'CLIENT_ERROR|INTERNAL_ERROR|STOPPED_BY_USER',
                'message' => '<string>',
            ],
            'executionContext' => [
                [
                    'context' => '<string>',
                    'contextType' => 'ERROR|CLIENT_ERROR|WARNING|INFO',
                    'timestamp' => <DateTime>,
                ],
                // ...
            ],
            'integratedRepositories' => [
                [
                    'integrationId' => '<string>',
                    'providerResourceId' => '<string>',
                ],
                // ...
            ],
            'logConfig' => [
                'logGroup' => '<string>',
                'logStream' => '<string>',
            ],
            'overview' => '<string>',
            'serviceRole' => '<string>',
            'sourceCode' => [
                [
                    's3Location' => '<string>',
                ],
                // ...
            ],
            'status' => 'IN_PROGRESS|STOPPING|STOPPED|FAILED|COMPLETED',
            'steps' => [
                [
                    'createdAt' => <DateTime>,
                    'name' => 'PREFLIGHT|STATIC_ANALYSIS|PENTEST|FINALIZING|VALIDATION',
                    'status' => 'NOT_STARTED|IN_PROGRESS|COMPLETED|FAILED|STOPPED',
                    'updatedAt' => <DateTime>,
                ],
                // ...
            ],
            'title' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'notFound' => ['<string>', ...],
]

Result Details

Errors

There are no errors described for this operation.

BatchGetCodeReviews

$result = $client->batchGetCodeReviews([/* ... */]);
$promise = $client->batchGetCodeReviewsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchGetCodeReviews([
    'agentSpaceId' => '<string>', // REQUIRED
    'codeReviewIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'codeReviews' => [
        [
            'agentSpaceId' => '<string>',
            'assets' => [
                'actors' => [
                    [
                        'authentication' => [
                            'providerType' => 'SECRETS_MANAGER|AWS_LAMBDA|AWS_IAM_ROLE|AWS_INTERNAL',
                            'value' => '<string>',
                        ],
                        'description' => '<string>',
                        'identifier' => '<string>',
                        'uris' => ['<string>', ...],
                    ],
                    // ...
                ],
                'documents' => [
                    [
                        'artifactId' => '<string>',
                        'integratedDocument' => [
                            'integrationId' => '<string>',
                            'resourceId' => '<string>',
                        ],
                        's3Location' => '<string>',
                    ],
                    // ...
                ],
                'endpoints' => [
                    [
                        'uri' => '<string>',
                    ],
                    // ...
                ],
                'integratedRepositories' => [
                    [
                        'integrationId' => '<string>',
                        'providerResourceId' => '<string>',
                    ],
                    // ...
                ],
                'sourceCode' => [
                    [
                        's3Location' => '<string>',
                    ],
                    // ...
                ],
            ],
            'codeRemediationStrategy' => 'AUTOMATIC|DISABLED',
            'codeReviewId' => '<string>',
            'createdAt' => <DateTime>,
            'logConfig' => [
                'logGroup' => '<string>',
                'logStream' => '<string>',
            ],
            'serviceRole' => '<string>',
            'title' => '<string>',
            'updatedAt' => <DateTime>,
            'validationMode' => 'DISABLED|SIMULATED',
        ],
        // ...
    ],
    'notFound' => ['<string>', ...],
]

Result Details

Errors

There are no errors described for this operation.

BatchGetFindings

$result = $client->batchGetFindings([/* ... */]);
$promise = $client->batchGetFindingsAsync([/* ... */]);

Retrieves information about one or more security findings in an agent space.

Parameter Syntax

$result = $client->batchGetFindings([
    'agentSpaceId' => '<string>', // REQUIRED
    'findingIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'findings' => [
        [
            'agentSpaceId' => '<string>',
            'alignmentRationale' => '<string>',
            'attackScript' => '<string>',
            'codeLocations' => [
                [
                    'filePath' => '<string>',
                    'label' => '<string>',
                    'lineEnd' => <integer>,
                    'lineStart' => <integer>,
                ],
                // ...
            ],
            'codeRemediationTask' => [
                'status' => 'IN_PROGRESS|COMPLETED|FAILED',
                'statusReason' => '<string>',
                'taskDetails' => [
                    [
                        'codeDiffLink' => '<string>',
                        'pullRequestLink' => '<string>',
                        'repoName' => '<string>',
                    ],
                    // ...
                ],
            ],
            'codeReviewId' => '<string>',
            'codeReviewJobId' => '<string>',
            'confidence' => 'FALSE_POSITIVE|UNCONFIRMED|LOW|MEDIUM|HIGH',
            'createdAt' => <DateTime>,
            'customerNote' => '<string>',
            'description' => '<string>',
            'findingId' => '<string>',
            'lastUpdatedBy' => '<string>',
            'name' => '<string>',
            'pentestId' => '<string>',
            'pentestJobId' => '<string>',
            'reasoning' => '<string>',
            'riskLevel' => 'UNKNOWN|INFORMATIONAL|LOW|MEDIUM|HIGH|CRITICAL',
            'riskScore' => '<string>',
            'riskType' => '<string>',
            'status' => 'ACTIVE|RESOLVED|ACCEPTED|FALSE_POSITIVE',
            'taskId' => '<string>',
            'updatedAt' => <DateTime>,
            'validationStatus' => 'CONFIRMED|NOT_REPRODUCED|VALIDATION_FAILED|VALIDATING|NOT_VALIDATED',
            'verificationScript' => [
                'envVars' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'instructions' => '<string>',
                'scriptType' => '<string>',
                'scriptUrl' => '<string>',
            ],
        ],
        // ...
    ],
    'notFound' => ['<string>', ...],
]

Result Details

Errors

There are no errors described for this operation.

BatchGetPentestJobTasks

$result = $client->batchGetPentestJobTasks([/* ... */]);
$promise = $client->batchGetPentestJobTasksAsync([/* ... */]);

Retrieves information about one or more tasks within a pentest job.

Parameter Syntax

$result = $client->batchGetPentestJobTasks([
    'agentSpaceId' => '<string>', // REQUIRED
    'taskIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'notFound' => ['<string>', ...],
    'tasks' => [
        [
            'agentSpaceId' => '<string>',
            'categories' => [
                [
                    'isPrimary' => true || false,
                    'name' => '<string>',
                ],
                // ...
            ],
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'executionStatus' => 'IN_PROGRESS|ABORTED|COMPLETED|INTERNAL_ERROR|FAILED',
            'logsLocation' => [
                'cloudWatchLog' => [
                    'logGroup' => '<string>',
                    'logStream' => '<string>',
                ],
                'logType' => 'CLOUDWATCH',
            ],
            'pentestId' => '<string>',
            'pentestJobId' => '<string>',
            'riskType' => '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',
            'targetEndpoint' => [
                'uri' => '<string>',
            ],
            'taskId' => '<string>',
            'title' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

BatchGetPentestJobs

$result = $client->batchGetPentestJobs([/* ... */]);
$promise = $client->batchGetPentestJobsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchGetPentestJobs([
    'agentSpaceId' => '<string>', // REQUIRED
    'pentestJobIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'notFound' => ['<string>', ...],
    'pentestJobs' => [
        [
            'actors' => [
                [
                    'authentication' => [
                        'providerType' => 'SECRETS_MANAGER|AWS_LAMBDA|AWS_IAM_ROLE|AWS_INTERNAL',
                        'value' => '<string>',
                    ],
                    'description' => '<string>',
                    'identifier' => '<string>',
                    'uris' => ['<string>', ...],
                ],
                // ...
            ],
            'allowedDomains' => [
                [
                    'uri' => '<string>',
                ],
                // ...
            ],
            'cleanUpStrategy' => 'BEST_EFFORT_DELETE|RETAIN_ALL',
            'codeRemediationStrategy' => 'AUTOMATIC|DISABLED',
            'createdAt' => <DateTime>,
            'disableManagedSkills' => ['<string>', ...],
            'documents' => [
                [
                    'artifactId' => '<string>',
                    'integratedDocument' => [
                        'integrationId' => '<string>',
                        'resourceId' => '<string>',
                    ],
                    's3Location' => '<string>',
                ],
                // ...
            ],
            'endpoints' => [
                [
                    'uri' => '<string>',
                ],
                // ...
            ],
            'errorInformation' => [
                'code' => 'CLIENT_ERROR|INTERNAL_ERROR|STOPPED_BY_USER',
                'message' => '<string>',
            ],
            'excludePaths' => [
                [
                    'uri' => '<string>',
                ],
                // ...
            ],
            'excludeRiskTypes' => ['<string>', ...],
            'executionContext' => [
                [
                    'context' => '<string>',
                    'contextType' => 'ERROR|CLIENT_ERROR|WARNING|INFO',
                    'timestamp' => <DateTime>,
                ],
                // ...
            ],
            'integratedRepositories' => [
                [
                    'integrationId' => '<string>',
                    'providerResourceId' => '<string>',
                ],
                // ...
            ],
            'logConfig' => [
                'logGroup' => '<string>',
                'logStream' => '<string>',
            ],
            'networkTrafficConfig' => [
                'customHeaders' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'rules' => [
                    [
                        'effect' => 'ALLOW|DENY',
                        'networkTrafficRuleType' => 'URL',
                        'pattern' => '<string>',
                    ],
                    // ...
                ],
            ],
            'overview' => '<string>',
            'pentestId' => '<string>',
            'pentestJobId' => '<string>',
            'serviceRole' => '<string>',
            'sourceCode' => [
                [
                    's3Location' => '<string>',
                ],
                // ...
            ],
            'status' => 'IN_PROGRESS|STOPPING|STOPPED|FAILED|COMPLETED',
            'steps' => [
                [
                    'createdAt' => <DateTime>,
                    'name' => 'PREFLIGHT|STATIC_ANALYSIS|PENTEST|FINALIZING|VALIDATION',
                    'status' => 'NOT_STARTED|IN_PROGRESS|COMPLETED|FAILED|STOPPED',
                    'updatedAt' => <DateTime>,
                ],
                // ...
            ],
            'title' => '<string>',
            'updatedAt' => <DateTime>,
            'vpcConfig' => [
                'securityGroupArns' => ['<string>', ...],
                'subnetArns' => ['<string>', ...],
                'vpcArn' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

BatchGetPentests

$result = $client->batchGetPentests([/* ... */]);
$promise = $client->batchGetPentestsAsync([/* ... */]);

Retrieves information about one or more pentests in an agent space.

Parameter Syntax

$result = $client->batchGetPentests([
    'agentSpaceId' => '<string>', // REQUIRED
    'pentestIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'notFound' => ['<string>', ...],
    'pentests' => [
        [
            'agentSpaceId' => '<string>',
            'assets' => [
                'actors' => [
                    [
                        'authentication' => [
                            'providerType' => 'SECRETS_MANAGER|AWS_LAMBDA|AWS_IAM_ROLE|AWS_INTERNAL',
                            'value' => '<string>',
                        ],
                        'description' => '<string>',
                        'identifier' => '<string>',
                        'uris' => ['<string>', ...],
                    ],
                    // ...
                ],
                'documents' => [
                    [
                        'artifactId' => '<string>',
                        'integratedDocument' => [
                            'integrationId' => '<string>',
                            'resourceId' => '<string>',
                        ],
                        's3Location' => '<string>',
                    ],
                    // ...
                ],
                'endpoints' => [
                    [
                        'uri' => '<string>',
                    ],
                    // ...
                ],
                'integratedRepositories' => [
                    [
                        'integrationId' => '<string>',
                        'providerResourceId' => '<string>',
                    ],
                    // ...
                ],
                'sourceCode' => [
                    [
                        's3Location' => '<string>',
                    ],
                    // ...
                ],
            ],
            'cleanUpStrategy' => 'BEST_EFFORT_DELETE|RETAIN_ALL',
            'codeRemediationStrategy' => 'AUTOMATIC|DISABLED',
            'createdAt' => <DateTime>,
            'disableManagedSkills' => ['<string>', ...],
            'excludeRiskTypes' => ['<string>', ...],
            'logConfig' => [
                'logGroup' => '<string>',
                'logStream' => '<string>',
            ],
            'networkTrafficConfig' => [
                'customHeaders' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'rules' => [
                    [
                        'effect' => 'ALLOW|DENY',
                        'networkTrafficRuleType' => 'URL',
                        'pattern' => '<string>',
                    ],
                    // ...
                ],
            ],
            'pentestId' => '<string>',
            'serviceRole' => '<string>',
            'title' => '<string>',
            'updatedAt' => <DateTime>,
            'vpcConfig' => [
                'securityGroupArns' => ['<string>', ...],
                'subnetArns' => ['<string>', ...],
                'vpcArn' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

BatchGetSecurityRequirements

$result = $client->batchGetSecurityRequirements([/* ... */]);
$promise = $client->batchGetSecurityRequirementsAsync([/* ... */]);

Batch retrieves security requirements from a pack.

Parameter Syntax

$result = $client->batchGetSecurityRequirements([
    'packId' => '<string>', // REQUIRED
    'securityRequirementNames' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'code' => '<string>',
            'message' => '<string>',
            'securityRequirementName' => '<string>',
        ],
        // ...
    ],
    'securityRequirements' => [
        [
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'domain' => '<string>',
            'evaluation' => '<string>',
            'name' => '<string>',
            'packId' => '<string>',
            'remediation' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

InternalServerException:

An unexpected error occurred during the processing of your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

BatchGetTargetDomains

$result = $client->batchGetTargetDomains([/* ... */]);
$promise = $client->batchGetTargetDomainsAsync([/* ... */]);

Retrieves information about one or more target domains.

Parameter Syntax

$result = $client->batchGetTargetDomains([
    'targetDomainIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'notFound' => ['<string>', ...],
    'targetDomains' => [
        [
            'createdAt' => <DateTime>,
            'domainName' => '<string>',
            'targetDomainId' => '<string>',
            'verificationDetails' => [
                'dnsTxt' => [
                    'dnsRecordName' => '<string>',
                    'dnsRecordType' => 'TXT',
                    'token' => '<string>',
                ],
                'httpRoute' => [
                    'routePath' => '<string>',
                    'token' => '<string>',
                ],
                'method' => 'DNS_TXT|HTTP_ROUTE|PRIVATE_VPC',
            ],
            'verificationStatus' => 'PENDING|VERIFIED|FAILED|UNREACHABLE',
            'verificationStatusReason' => '<string>',
            'verifiedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

BatchGetThreatModelJobTasks

$result = $client->batchGetThreatModelJobTasks([/* ... */]);
$promise = $client->batchGetThreatModelJobTasksAsync([/* ... */]);

Retrieves information about one or more tasks within a threat model job.

Parameter Syntax

$result = $client->batchGetThreatModelJobTasks([
    'agentSpaceId' => '<string>', // REQUIRED
    'threatModelJobTaskIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'notFound' => ['<string>', ...],
    'threatModelJobTasks' => [
        [
            'agentSpaceId' => '<string>',
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'executionStatus' => 'IN_PROGRESS|ABORTED|COMPLETED|INTERNAL_ERROR|FAILED',
            'logsLocation' => [
                'cloudWatchLog' => [
                    'logGroup' => '<string>',
                    'logStream' => '<string>',
                ],
                'logType' => 'CLOUDWATCH',
            ],
            'taskId' => '<string>',
            'threatModelId' => '<string>',
            'threatModelJobId' => '<string>',
            'title' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

BatchGetThreatModelJobs

$result = $client->batchGetThreatModelJobs([/* ... */]);
$promise = $client->batchGetThreatModelJobsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchGetThreatModelJobs([
    'agentSpaceId' => '<string>', // REQUIRED
    'threatModelJobIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'notFound' => ['<string>', ...],
    'threatModelJobs' => [
        [
            'agentSpaceId' => '<string>',
            'createdAt' => <DateTime>,
            'documents' => [
                [
                    'artifactId' => '<string>',
                    'integratedDocument' => [
                        'integrationId' => '<string>',
                        'resourceId' => '<string>',
                    ],
                    's3Location' => '<string>',
                ],
                // ...
            ],
            'errorInformation' => [
                'code' => 'CLIENT_ERROR|INTERNAL_ERROR|STOPPED_BY_USER',
                'message' => '<string>',
            ],
            'executionEndTime' => <DateTime>,
            'executionStartTime' => <DateTime>,
            'integratedRepositories' => [
                [
                    'integrationId' => '<string>',
                    'providerResourceId' => '<string>',
                ],
                // ...
            ],
            'scopeDocs' => [
                [
                    'artifactId' => '<string>',
                    'integratedDocument' => [
                        'integrationId' => '<string>',
                        'resourceId' => '<string>',
                    ],
                    's3Location' => '<string>',
                ],
                // ...
            ],
            'sourceCode' => [
                [
                    's3Location' => '<string>',
                ],
                // ...
            ],
            'status' => 'IN_PROGRESS|STOPPING|STOPPED|FAILED|COMPLETED',
            'systemOverview' => '<string>',
            'threatModelId' => '<string>',
            'threatModelJobId' => '<string>',
            'title' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

BatchGetThreatModels

$result = $client->batchGetThreatModels([/* ... */]);
$promise = $client->batchGetThreatModelsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->batchGetThreatModels([
    'agentSpaceId' => '<string>', // REQUIRED
    'threatModelIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'notFound' => ['<string>', ...],
    'threatModels' => [
        [
            'agentSpaceId' => '<string>',
            'assets' => [
                'actors' => [
                    [
                        'authentication' => [
                            'providerType' => 'SECRETS_MANAGER|AWS_LAMBDA|AWS_IAM_ROLE|AWS_INTERNAL',
                            'value' => '<string>',
                        ],
                        'description' => '<string>',
                        'identifier' => '<string>',
                        'uris' => ['<string>', ...],
                    ],
                    // ...
                ],
                'documents' => [
                    [
                        'artifactId' => '<string>',
                        'integratedDocument' => [
                            'integrationId' => '<string>',
                            'resourceId' => '<string>',
                        ],
                        's3Location' => '<string>',
                    ],
                    // ...
                ],
                'endpoints' => [
                    [
                        'uri' => '<string>',
                    ],
                    // ...
                ],
                'integratedRepositories' => [
                    [
                        'integrationId' => '<string>',
                        'providerResourceId' => '<string>',
                    ],
                    // ...
                ],
                'sourceCode' => [
                    [
                        's3Location' => '<string>',
                    ],
                    // ...
                ],
            ],
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'logConfig' => [
                'logGroup' => '<string>',
                'logStream' => '<string>',
            ],
            'scopeDocs' => [
                [
                    'artifactId' => '<string>',
                    'integratedDocument' => [
                        'integrationId' => '<string>',
                        'resourceId' => '<string>',
                    ],
                    's3Location' => '<string>',
                ],
                // ...
            ],
            'serviceRole' => '<string>',
            'threatModelId' => '<string>',
            'title' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

BatchGetThreats

$result = $client->batchGetThreats([/* ... */]);
$promise = $client->batchGetThreatsAsync([/* ... */]);

Retrieves information about one or more threats.

Parameter Syntax

$result = $client->batchGetThreats([
    'agentSpaceId' => '<string>', // REQUIRED
    'threatIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'notFound' => ['<string>', ...],
    'threats' => [
        [
            'anchor' => [
                'id' => '<string>',
                'kind' => '<string>',
                'packageId' => '<string>',
            ],
            'comments' => '<string>',
            'createdAt' => <DateTime>,
            'createdBy' => 'CUSTOMER|AGENT',
            'evidence' => [
                [
                    'packageId' => '<string>',
                    'path' => '<string>',
                ],
                // ...
            ],
            'impactedAssets' => ['<string>', ...],
            'impactedGoal' => ['<string>', ...],
            'prerequisites' => '<string>',
            'recommendation' => '<string>',
            'severity' => 'CRITICAL|HIGH|MEDIUM|LOW|INFO',
            'statement' => '<string>',
            'status' => 'OPEN|RESOLVED|DISMISSED',
            'stride' => ['<string>', ...],
            'threatAction' => '<string>',
            'threatId' => '<string>',
            'threatImpact' => '<string>',
            'threatJobId' => '<string>',
            'threatSource' => '<string>',
            'title' => '<string>',
            'updatedAt' => <DateTime>,
            'updatedBy' => 'CUSTOMER|AGENT',
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

BatchUpdateSecurityRequirements

$result = $client->batchUpdateSecurityRequirements([/* ... */]);
$promise = $client->batchUpdateSecurityRequirementsAsync([/* ... */]);

Batch updates security requirements within a customer managed pack.

Parameter Syntax

$result = $client->batchUpdateSecurityRequirements([
    'packId' => '<string>', // REQUIRED
    'securityRequirements' => [ // REQUIRED
        [
            'description' => '<string>',
            'domain' => '<string>',
            'evaluation' => '<string>',
            'name' => '<string>', // REQUIRED
            'remediation' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'errors' => [
        [
            'code' => '<string>',
            'message' => '<string>',
            'securityRequirementName' => '<string>',
        ],
        // ...
    ],
    'updatedSecurityRequirementNames' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

InternalServerException:

An unexpected error occurred during the processing of your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

CreateAgentSpace

$result = $client->createAgentSpace([/* ... */]);
$promise = $client->createAgentSpaceAsync([/* ... */]);

Creates a new agent space. An agent space is a dedicated workspace for securing a specific application.

Parameter Syntax

$result = $client->createAgentSpace([
    'awsResources' => [
        'iamRoles' => ['<string>', ...],
        'lambdaFunctionArns' => ['<string>', ...],
        'logGroups' => ['<string>', ...],
        's3Buckets' => ['<string>', ...],
        'secretArns' => ['<string>', ...],
        'vpcs' => [
            [
                'securityGroupArns' => ['<string>', ...],
                'subnetArns' => ['<string>', ...],
                'vpcArn' => '<string>',
            ],
            // ...
        ],
    ],
    'codeReviewSettings' => [
        'controlsScanning' => true || false, // REQUIRED
        'generalPurposeScanning' => true || false, // REQUIRED
    ],
    'description' => '<string>',
    'kmsKeyId' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
    'targetDomainIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'agentSpaceId' => '<string>',
    'awsResources' => [
        'iamRoles' => ['<string>', ...],
        'lambdaFunctionArns' => ['<string>', ...],
        'logGroups' => ['<string>', ...],
        's3Buckets' => ['<string>', ...],
        'secretArns' => ['<string>', ...],
        'vpcs' => [
            [
                'securityGroupArns' => ['<string>', ...],
                'subnetArns' => ['<string>', ...],
                'vpcArn' => '<string>',
            ],
            // ...
        ],
    ],
    'codeReviewSettings' => [
        'controlsScanning' => true || false,
        'generalPurposeScanning' => true || false,
    ],
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'kmsKeyId' => '<string>',
    'name' => '<string>',
    'targetDomainIds' => ['<string>', ...],
    'updatedAt' => <DateTime>,
]

Result Details

Errors

There are no errors described for this operation.

CreateApplication

$result = $client->createApplication([/* ... */]);
$promise = $client->createApplicationAsync([/* ... */]);

Creates a new application. An application is the top-level organizational unit that supports IAM Identity Center integration.

Parameter Syntax

$result = $client->createApplication([
    'defaultKmsKeyId' => '<string>',
    'idcInstanceArn' => '<string>',
    'roleArn' => '<string>',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'applicationId' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

CreateCodeReview

$result = $client->createCodeReview([/* ... */]);
$promise = $client->createCodeReviewAsync([/* ... */]);

Creates a new code review configuration in an agent space. A code review defines the parameters for automated security-focused code analysis.

Parameter Syntax

$result = $client->createCodeReview([
    'agentSpaceId' => '<string>', // REQUIRED
    'assets' => [ // REQUIRED
        'actors' => [
            [
                'authentication' => [
                    'providerType' => 'SECRETS_MANAGER|AWS_LAMBDA|AWS_IAM_ROLE|AWS_INTERNAL',
                    'value' => '<string>',
                ],
                'description' => '<string>',
                'identifier' => '<string>',
                'uris' => ['<string>', ...],
            ],
            // ...
        ],
        'documents' => [
            [
                'artifactId' => '<string>',
                'integratedDocument' => [
                    'integrationId' => '<string>', // REQUIRED
                    'resourceId' => '<string>', // REQUIRED
                ],
                's3Location' => '<string>',
            ],
            // ...
        ],
        'endpoints' => [
            [
                'uri' => '<string>',
            ],
            // ...
        ],
        'integratedRepositories' => [
            [
                'integrationId' => '<string>', // REQUIRED
                'providerResourceId' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'sourceCode' => [
            [
                's3Location' => '<string>',
            ],
            // ...
        ],
    ],
    'codeRemediationStrategy' => 'AUTOMATIC|DISABLED',
    'logConfig' => [
        'logGroup' => '<string>',
        'logStream' => '<string>',
    ],
    'serviceRole' => '<string>',
    'title' => '<string>', // REQUIRED
    'validationMode' => 'DISABLED|SIMULATED',
]);

Parameter Details

Result Syntax

[
    'agentSpaceId' => '<string>',
    'assets' => [
        'actors' => [
            [
                'authentication' => [
                    'providerType' => 'SECRETS_MANAGER|AWS_LAMBDA|AWS_IAM_ROLE|AWS_INTERNAL',
                    'value' => '<string>',
                ],
                'description' => '<string>',
                'identifier' => '<string>',
                'uris' => ['<string>', ...],
            ],
            // ...
        ],
        'documents' => [
            [
                'artifactId' => '<string>',
                'integratedDocument' => [
                    'integrationId' => '<string>',
                    'resourceId' => '<string>',
                ],
                's3Location' => '<string>',
            ],
            // ...
        ],
        'endpoints' => [
            [
                'uri' => '<string>',
            ],
            // ...
        ],
        'integratedRepositories' => [
            [
                'integrationId' => '<string>',
                'providerResourceId' => '<string>',
            ],
            // ...
        ],
        'sourceCode' => [
            [
                's3Location' => '<string>',
            ],
            // ...
        ],
    ],
    'codeRemediationStrategy' => 'AUTOMATIC|DISABLED',
    'codeReviewId' => '<string>',
    'createdAt' => <DateTime>,
    'logConfig' => [
        'logGroup' => '<string>',
        'logStream' => '<string>',
    ],
    'serviceRole' => '<string>',
    'title' => '<string>',
    'updatedAt' => <DateTime>,
    'validationMode' => 'DISABLED|SIMULATED',
]

Result Details

Errors

There are no errors described for this operation.

CreateIntegration

$result = $client->createIntegration([/* ... */]);
$promise = $client->createIntegrationAsync([/* ... */]);

Creates a new integration with a third-party provider, such as GitHub, for code review and remediation.

Parameter Syntax

$result = $client->createIntegration([
    'input' => [ // REQUIRED
        'bitbucket' => [
            'code' => '<string>', // REQUIRED
            'installationId' => '<string>', // REQUIRED
            'state' => '<string>', // REQUIRED
            'workspace' => '<string>', // REQUIRED
        ],
        'confluence' => [
            'code' => '<string>', // REQUIRED
            'installationId' => '<string>', // REQUIRED
            'siteUrl' => '<string>', // REQUIRED
            'state' => '<string>', // REQUIRED
        ],
        'github' => [
            'code' => '<string>', // REQUIRED
            'installationId' => '<string>',
            'organizationName' => '<string>',
            'state' => '<string>', // REQUIRED
            'targetUrl' => '<string>',
        ],
        'gitlab' => [
            'accessToken' => '<string>', // REQUIRED
            'groupId' => '<string>',
            'targetUrl' => '<string>',
            'tokenType' => 'PERSONAL|GROUP', // REQUIRED
        ],
    ],
    'integrationDisplayName' => '<string>', // REQUIRED
    'kmsKeyId' => '<string>',
    'privateConnectionName' => '<string>',
    'provider' => 'GITHUB|GITLAB|BITBUCKET|CONFLUENCE', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'integrationId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

InternalServerException:

An unexpected error occurred during the processing of your request.

ValidationException:

The input fails to satisfy the constraints specified by the service.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

CreateMembership

$result = $client->createMembership([/* ... */]);
$promise = $client->createMembershipAsync([/* ... */]);

Creates a new membership, granting a user access to an agent space within an application.

Parameter Syntax

$result = $client->createMembership([
    'agentSpaceId' => '<string>', // REQUIRED
    'applicationId' => '<string>', // REQUIRED
    'config' => [
        'user' => [
            'role' => 'MEMBER',
        ],
    ],
    'memberType' => 'USER', // REQUIRED
    'membershipId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

CreatePentest

$result = $client->createPentest([/* ... */]);
$promise = $client->createPentestAsync([/* ... */]);

Creates a new pentest configuration in an agent space. A pentest defines the security test parameters, including target assets, risk type exclusions, and logging configuration.

Parameter Syntax

$result = $client->createPentest([
    'agentSpaceId' => '<string>', // REQUIRED
    'assets' => [
        'actors' => [
            [
                'authentication' => [
                    'providerType' => 'SECRETS_MANAGER|AWS_LAMBDA|AWS_IAM_ROLE|AWS_INTERNAL',
                    'value' => '<string>',
                ],
                'description' => '<string>',
                'identifier' => '<string>',
                'uris' => ['<string>', ...],
            ],
            // ...
        ],
        'documents' => [
            [
                'artifactId' => '<string>',
                'integratedDocument' => [
                    'integrationId' => '<string>', // REQUIRED
                    'resourceId' => '<string>', // REQUIRED
                ],
                's3Location' => '<string>',
            ],
            // ...
        ],
        'endpoints' => [
            [
                'uri' => '<string>',
            ],
            // ...
        ],
        'integratedRepositories' => [
            [
                'integrationId' => '<string>', // REQUIRED
                'providerResourceId' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'sourceCode' => [
            [
                's3Location' => '<string>',
            ],
            // ...
        ],
    ],
    'codeRemediationStrategy' => 'AUTOMATIC|DISABLED',
    'disableManagedSkills' => ['<string>', ...],
    'excludeRiskTypes' => ['<string>', ...],
    'logConfig' => [
        'logGroup' => '<string>',
        'logStream' => '<string>',
    ],
    'networkTrafficConfig' => [
        'customHeaders' => [
            [
                'name' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'rules' => [
            [
                'effect' => 'ALLOW|DENY',
                'networkTrafficRuleType' => 'URL',
                'pattern' => '<string>',
            ],
            // ...
        ],
    ],
    'serviceRole' => '<string>',
    'title' => '<string>', // REQUIRED
    'vpcConfig' => [
        'securityGroupArns' => ['<string>', ...],
        'subnetArns' => ['<string>', ...],
        'vpcArn' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'agentSpaceId' => '<string>',
    'assets' => [
        'actors' => [
            [
                'authentication' => [
                    'providerType' => 'SECRETS_MANAGER|AWS_LAMBDA|AWS_IAM_ROLE|AWS_INTERNAL',
                    'value' => '<string>',
                ],
                'description' => '<string>',
                'identifier' => '<string>',
                'uris' => ['<string>', ...],
            ],
            // ...
        ],
        'documents' => [
            [
                'artifactId' => '<string>',
                'integratedDocument' => [
                    'integrationId' => '<string>',
                    'resourceId' => '<string>',
                ],
                's3Location' => '<string>',
            ],
            // ...
        ],
        'endpoints' => [
            [
                'uri' => '<string>',
            ],
            // ...
        ],
        'integratedRepositories' => [
            [
                'integrationId' => '<string>',
                'providerResourceId' => '<string>',
            ],
            // ...
        ],
        'sourceCode' => [
            [
                's3Location' => '<string>',
            ],
            // ...
        ],
    ],
    'createdAt' => <DateTime>,
    'excludeRiskTypes' => ['<string>', ...],
    'logConfig' => [
        'logGroup' => '<string>',
        'logStream' => '<string>',
    ],
    'pentestId' => '<string>',
    'serviceRole' => '<string>',
    'title' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

There are no errors described for this operation.

CreatePrivateConnection

$result = $client->createPrivateConnection([/* ... */]);
$promise = $client->createPrivateConnectionAsync([/* ... */]);

Creates a private connection for reaching a self-hosted provider instance over private networking using Amazon VPC Lattice.

Parameter Syntax

$result = $client->createPrivateConnection([
    'mode' => [ // REQUIRED
        'selfManaged' => [
            'certificate' => '<string>',
            'resourceConfigurationId' => '<string>', // REQUIRED
        ],
        'serviceManaged' => [
            'certificate' => '<string>',
            'dnsResolution' => 'PUBLIC|IN_VPC',
            'hostAddress' => '<string>', // REQUIRED
            'ipAddressType' => 'IPV4|IPV6|DUAL_STACK',
            'ipv4AddressesPerEni' => <integer>,
            'portRanges' => ['<string>', ...],
            'securityGroupIds' => ['<string>', ...],
            'subnetIds' => ['<string>', ...], // REQUIRED
            'vpcId' => '<string>', // REQUIRED
        ],
    ],
    'privateConnectionName' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'certificateExpiryTime' => <DateTime>,
    'dnsResolution' => 'PUBLIC|IN_VPC',
    'failureMessage' => '<string>',
    'hostAddress' => '<string>',
    'name' => '<string>',
    'resourceConfigurationId' => '<string>',
    'resourceGatewayId' => '<string>',
    'status' => 'ACTIVE|CREATE_IN_PROGRESS|CREATE_FAILED|DELETE_IN_PROGRESS|DELETE_FAILED',
    'tags' => ['<string>', ...],
    'type' => 'SERVICE_MANAGED|SELF_MANAGED',
    'vpcId' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

InternalServerException:

An unexpected error occurred during the processing of your request.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

CreateSecurityRequirementPack

$result = $client->createSecurityRequirementPack([/* ... */]);
$promise = $client->createSecurityRequirementPackAsync([/* ... */]);

Creates a customer managed security requirement pack.

Parameter Syntax

$result = $client->createSecurityRequirementPack([
    'description' => '<string>',
    'kmsKeyId' => '<string>',
    'name' => '<string>', // REQUIRED
    'status' => 'ENABLED|DISABLED',
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'kmsKeyId' => '<string>',
    'packId' => '<string>',
    'status' => 'ENABLED|DISABLED',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

InternalServerException:

An unexpected error occurred during the processing of your request.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ServiceQuotaExceededException:

The request exceeds a service quota. Review your current usage and request a quota increase if needed.

CreateTargetDomain

$result = $client->createTargetDomain([/* ... */]);
$promise = $client->createTargetDomainAsync([/* ... */]);

Creates a new target domain for penetration testing. A target domain is a web domain that must be registered and verified before it can be tested.

Parameter Syntax

$result = $client->createTargetDomain([
    'tags' => ['<string>', ...],
    'targetDomainName' => '<string>', // REQUIRED
    'verificationMethod' => 'DNS_TXT|HTTP_ROUTE|PRIVATE_VPC', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'domainName' => '<string>',
    'targetDomainId' => '<string>',
    'verificationDetails' => [
        'dnsTxt' => [
            'dnsRecordName' => '<string>',
            'dnsRecordType' => 'TXT',
            'token' => '<string>',
        ],
        'httpRoute' => [
            'routePath' => '<string>',
            'token' => '<string>',
        ],
        'method' => 'DNS_TXT|HTTP_ROUTE|PRIVATE_VPC',
    ],
    'verificationStatus' => 'PENDING|VERIFIED|FAILED|UNREACHABLE',
    'verificationStatusReason' => '<string>',
    'verifiedAt' => <DateTime>,
]

Result Details

Errors

There are no errors described for this operation.

CreateThreat

$result = $client->createThreat([/* ... */]);
$promise = $client->createThreatAsync([/* ... */]);

Creates a new threat under a threat model job.

Parameter Syntax

$result = $client->createThreat([
    'agentSpaceId' => '<string>', // REQUIRED
    'anchor' => [
        'id' => '<string>',
        'kind' => '<string>',
        'packageId' => '<string>',
    ],
    'comments' => '<string>',
    'evidence' => [
        [
            'packageId' => '<string>',
            'path' => '<string>',
        ],
        // ...
    ],
    'impactedAssets' => ['<string>', ...],
    'impactedGoal' => ['<string>', ...],
    'prerequisites' => '<string>',
    'recommendation' => '<string>',
    'severity' => 'CRITICAL|HIGH|MEDIUM|LOW|INFO',
    'statement' => '<string>',
    'stride' => ['<string>', ...],
    'threatAction' => '<string>',
    'threatImpact' => '<string>',
    'threatJobId' => '<string>', // REQUIRED
    'threatSource' => '<string>',
    'title' => '<string>',
]);

Parameter Details

Result Syntax

[
    'anchor' => [
        'id' => '<string>',
        'kind' => '<string>',
        'packageId' => '<string>',
    ],
    'comments' => '<string>',
    'createdAt' => <DateTime>,
    'createdBy' => 'CUSTOMER|AGENT',
    'evidence' => [
        [
            'packageId' => '<string>',
            'path' => '<string>',
        ],
        // ...
    ],
    'impactedAssets' => ['<string>', ...],
    'impactedGoal' => ['<string>', ...],
    'prerequisites' => '<string>',
    'recommendation' => '<string>',
    'severity' => 'CRITICAL|HIGH|MEDIUM|LOW|INFO',
    'statement' => '<string>',
    'status' => 'OPEN|RESOLVED|DISMISSED',
    'stride' => ['<string>', ...],
    'threatAction' => '<string>',
    'threatId' => '<string>',
    'threatImpact' => '<string>',
    'threatJobId' => '<string>',
    'threatSource' => '<string>',
    'title' => '<string>',
    'updatedAt' => <DateTime>,
    'updatedBy' => 'CUSTOMER|AGENT',
]

Result Details

Errors

There are no errors described for this operation.

CreateThreatModel

$result = $client->createThreatModel([/* ... */]);
$promise = $client->createThreatModelAsync([/* ... */]);

Creates a new threat model configuration in an agent space. A threat model defines the parameters for automated threat analysis.

Parameter Syntax

$result = $client->createThreatModel([
    'agentSpaceId' => '<string>', // REQUIRED
    'assets' => [
        'actors' => [
            [
                'authentication' => [
                    'providerType' => 'SECRETS_MANAGER|AWS_LAMBDA|AWS_IAM_ROLE|AWS_INTERNAL',
                    'value' => '<string>',
                ],
                'description' => '<string>',
                'identifier' => '<string>',
                'uris' => ['<string>', ...],
            ],
            // ...
        ],
        'documents' => [
            [
                'artifactId' => '<string>',
                'integratedDocument' => [
                    'integrationId' => '<string>', // REQUIRED
                    'resourceId' => '<string>', // REQUIRED
                ],
                's3Location' => '<string>',
            ],
            // ...
        ],
        'endpoints' => [
            [
                'uri' => '<string>',
            ],
            // ...
        ],
        'integratedRepositories' => [
            [
                'integrationId' => '<string>', // REQUIRED
                'providerResourceId' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'sourceCode' => [
            [
                's3Location' => '<string>',
            ],
            // ...
        ],
    ],
    'description' => '<string>',
    'logConfig' => [
        'logGroup' => '<string>',
        'logStream' => '<string>',
    ],
    'reportDestination' => [
        'containerId' => '<string>', // REQUIRED
        'documentId' => '<string>',
        'integrationId' => '<string>', // REQUIRED
        'parentId' => '<string>',
    ],
    'scopeDocs' => [
        [
            'artifactId' => '<string>',
            'integratedDocument' => [
                'integrationId' => '<string>', // REQUIRED
                'resourceId' => '<string>', // REQUIRED
            ],
            's3Location' => '<string>',
        ],
        // ...
    ],
    'serviceRole' => '<string>', // REQUIRED
    'title' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'agentSpaceId' => '<string>',
    'assets' => [
        'actors' => [
            [
                'authentication' => [
                    'providerType' => 'SECRETS_MANAGER|AWS_LAMBDA|AWS_IAM_ROLE|AWS_INTERNAL',
                    'value' => '<string>',
                ],
                'description' => '<string>',
                'identifier' => '<string>',
                'uris' => ['<string>', ...],
            ],
            // ...
        ],
        'documents' => [
            [
                'artifactId' => '<string>',
                'integratedDocument' => [
                    'integrationId' => '<string>',
                    'resourceId' => '<string>',
                ],
                's3Location' => '<string>',
            ],
            // ...
        ],
        'endpoints' => [
            [
                'uri' => '<string>',
            ],
            // ...
        ],
        'integratedRepositories' => [
            [
                'integrationId' => '<string>',
                'providerResourceId' => '<string>',
            ],
            // ...
        ],
        'sourceCode' => [
            [
                's3Location' => '<string>',
            ],
            // ...
        ],
    ],
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'logConfig' => [
        'logGroup' => '<string>',
        'logStream' => '<string>',
    ],
    'scopeDocs' => [
        [
            'artifactId' => '<string>',
            'integratedDocument' => [
                'integrationId' => '<string>',
                'resourceId' => '<string>',
            ],
            's3Location' => '<string>',
        ],
        // ...
    ],
    'serviceRole' => '<string>',
    'threatModelId' => '<string>',
    'title' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

There are no errors described for this operation.

DeleteAgentSpace

$result = $client->deleteAgentSpace([/* ... */]);
$promise = $client->deleteAgentSpaceAsync([/* ... */]);

Deletes an agent space and all of its associated resources, including pentests, findings, and artifacts.

Parameter Syntax

$result = $client->deleteAgentSpace([
    'agentSpaceId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'agentSpaceId' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

DeleteApplication

$result = $client->deleteApplication([/* ... */]);
$promise = $client->deleteApplicationAsync([/* ... */]);

Deletes an application and its associated configuration, including IAM Identity Center settings.

Parameter Syntax

$result = $client->deleteApplication([
    'applicationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeleteArtifact

$result = $client->deleteArtifact([/* ... */]);
$promise = $client->deleteArtifactAsync([/* ... */]);

Deletes an artifact from an agent space.

Parameter Syntax

$result = $client->deleteArtifact([
    'agentSpaceId' => '<string>', // REQUIRED
    'artifactId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

InternalServerException:

An unexpected error occurred during the processing of your request.

ValidationException:

The input fails to satisfy the constraints specified by the service.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

DeleteIntegration

$result = $client->deleteIntegration([/* ... */]);
$promise = $client->deleteIntegrationAsync([/* ... */]);

Deletes an integration with a third-party provider.

Parameter Syntax

$result = $client->deleteIntegration([
    'integrationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

ValidationException:

The input fails to satisfy the constraints specified by the service.

InternalServerException:

An unexpected error occurred during the processing of your request.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

DeleteMembership

$result = $client->deleteMembership([/* ... */]);
$promise = $client->deleteMembershipAsync([/* ... */]);

Deletes a membership, revoking a user's access to an agent space.

Parameter Syntax

$result = $client->deleteMembership([
    'agentSpaceId' => '<string>', // REQUIRED
    'applicationId' => '<string>', // REQUIRED
    'memberType' => 'USER',
    'membershipId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

DeletePrivateConnection

$result = $client->deletePrivateConnection([/* ... */]);
$promise = $client->deletePrivateConnectionAsync([/* ... */]);

Deletes a private connection.

Parameter Syntax

$result = $client->deletePrivateConnection([
    'privateConnectionName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'certificateExpiryTime' => <DateTime>,
    'dnsResolution' => 'PUBLIC|IN_VPC',
    'failureMessage' => '<string>',
    'hostAddress' => '<string>',
    'name' => '<string>',
    'resourceConfigurationId' => '<string>',
    'resourceGatewayId' => '<string>',
    'status' => 'ACTIVE|CREATE_IN_PROGRESS|CREATE_FAILED|DELETE_IN_PROGRESS|DELETE_FAILED',
    'tags' => ['<string>', ...],
    'type' => 'SERVICE_MANAGED|SELF_MANAGED',
    'vpcId' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

InternalServerException:

An unexpected error occurred during the processing of your request.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

DeleteSecurityRequirementPack

$result = $client->deleteSecurityRequirementPack([/* ... */]);
$promise = $client->deleteSecurityRequirementPackAsync([/* ... */]);

Deletes a customer managed security requirement pack and all its associated security requirements.

Parameter Syntax

$result = $client->deleteSecurityRequirementPack([
    'packId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

InternalServerException:

An unexpected error occurred during the processing of your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

DeleteTargetDomain

$result = $client->deleteTargetDomain([/* ... */]);
$promise = $client->deleteTargetDomainAsync([/* ... */]);

Deletes a target domain registration. After deletion, the domain can no longer be used for penetration testing.

Parameter Syntax

$result = $client->deleteTargetDomain([
    'targetDomainId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'targetDomainId' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

DescribePrivateConnection

$result = $client->describePrivateConnection([/* ... */]);
$promise = $client->describePrivateConnectionAsync([/* ... */]);

Retrieves the details of a private connection.

Parameter Syntax

$result = $client->describePrivateConnection([
    'privateConnectionName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'certificateExpiryTime' => <DateTime>,
    'dnsResolution' => 'PUBLIC|IN_VPC',
    'failureMessage' => '<string>',
    'hostAddress' => '<string>',
    'name' => '<string>',
    'resourceConfigurationId' => '<string>',
    'resourceGatewayId' => '<string>',
    'status' => 'ACTIVE|CREATE_IN_PROGRESS|CREATE_FAILED|DELETE_IN_PROGRESS|DELETE_FAILED',
    'tags' => ['<string>', ...],
    'type' => 'SERVICE_MANAGED|SELF_MANAGED',
    'vpcId' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

InternalServerException:

An unexpected error occurred during the processing of your request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

GetApplication

$result = $client->getApplication([/* ... */]);
$promise = $client->getApplicationAsync([/* ... */]);

Retrieves information about an application.

Parameter Syntax

$result = $client->getApplication([
    'applicationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'applicationId' => '<string>',
    'applicationName' => '<string>',
    'defaultKmsKeyId' => '<string>',
    'domain' => '<string>',
    'idcConfiguration' => [
        'idcApplicationArn' => '<string>',
        'idcInstanceArn' => '<string>',
    ],
    'roleArn' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

GetArtifact

$result = $client->getArtifact([/* ... */]);
$promise = $client->getArtifactAsync([/* ... */]);

Retrieves an artifact from an agent space.

Parameter Syntax

$result = $client->getArtifact([
    'agentSpaceId' => '<string>', // REQUIRED
    'artifactId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'agentSpaceId' => '<string>',
    'artifact' => [
        'contents' => '<string>',
        'type' => 'TXT|PNG|JPEG|MD|PDF|DOCX|DOC|JSON|YAML',
    ],
    'artifactId' => '<string>',
    'fileName' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

InternalServerException:

An unexpected error occurred during the processing of your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

GetIntegration

$result = $client->getIntegration([/* ... */]);
$promise = $client->getIntegrationAsync([/* ... */]);

Retrieves information about an integration.

Parameter Syntax

$result = $client->getIntegration([
    'integrationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'displayName' => '<string>',
    'installationId' => '<string>',
    'integrationId' => '<string>',
    'kmsKeyId' => '<string>',
    'privateConnectionName' => '<string>',
    'provider' => 'GITHUB|GITLAB|BITBUCKET|CONFLUENCE',
    'providerType' => 'SOURCE_CODE|DOCUMENTATION',
    'targetUrl' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

ValidationException:

The input fails to satisfy the constraints specified by the service.

InternalServerException:

An unexpected error occurred during the processing of your request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

GetSecurityRequirementPack

$result = $client->getSecurityRequirementPack([/* ... */]);
$promise = $client->getSecurityRequirementPackAsync([/* ... */]);

Retrieves information about a security requirement pack.

Parameter Syntax

$result = $client->getSecurityRequirementPack([
    'packId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'description' => '<string>',
    'importStatus' => 'PENDING|IN_PROGRESS|FAILED|COMPLETED',
    'kmsKeyId' => '<string>',
    'managementType' => 'AWS_MANAGED|CUSTOMER_MANAGED',
    'name' => '<string>',
    'packId' => '<string>',
    'status' => 'ENABLED|DISABLED',
    'updatedAt' => <DateTime>,
    'vendorName' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

InternalServerException:

An unexpected error occurred during the processing of your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ImportSecurityRequirements

$result = $client->importSecurityRequirements([/* ... */]);
$promise = $client->importSecurityRequirementsAsync([/* ... */]);

Imports security requirements from uploaded documents into a customer managed security requirement pack. The import process asynchronously extracts and generates structured security requirements from the provided source files.

Parameter Syntax

$result = $client->importSecurityRequirements([
    'input' => [ // REQUIRED
        'documents' => [
            [
                'content' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
                'format' => 'MD|PDF|TXT|DOCX|DOC', // REQUIRED
                'name' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'packId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'importStatus' => 'PENDING|IN_PROGRESS|FAILED|COMPLETED',
    'packId' => '<string>',
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

InternalServerException:

An unexpected error occurred during the processing of your request.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ServiceQuotaExceededException:

The request exceeds a service quota. Review your current usage and request a quota increase if needed.

InitiateProviderRegistration

$result = $client->initiateProviderRegistration([/* ... */]);
$promise = $client->initiateProviderRegistrationAsync([/* ... */]);

Initiates the OAuth registration flow with a third-party provider. Returns a redirect URL and CSRF state token for completing the authorization.

Parameter Syntax

$result = $client->initiateProviderRegistration([
    'provider' => 'GITHUB|GITLAB|BITBUCKET|CONFLUENCE', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'csrfState' => '<string>',
    'redirectTo' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

InternalServerException:

An unexpected error occurred during the processing of your request.

ValidationException:

The input fails to satisfy the constraints specified by the service.

ConflictException:

The request could not be completed due to a conflict with the current state of the resource.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListAgentSpaces

$result = $client->listAgentSpaces([/* ... */]);
$promise = $client->listAgentSpacesAsync([/* ... */]);

Returns a paginated list of agent space summaries in your account.

Parameter Syntax

$result = $client->listAgentSpaces([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'agentSpaceSummaries' => [
        [
            'agentSpaceId' => '<string>',
            'createdAt' => <DateTime>,
            'name' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListApplications

$result = $client->listApplications([/* ... */]);
$promise = $client->listApplicationsAsync([/* ... */]);

Returns a paginated list of application summaries in your account.

Parameter Syntax

$result = $client->listApplications([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'applicationSummaries' => [
        [
            'applicationId' => '<string>',
            'applicationName' => '<string>',
            'defaultKmsKeyId' => '<string>',
            'domain' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListArtifacts

$result = $client->listArtifacts([/* ... */]);
$promise = $client->listArtifactsAsync([/* ... */]);

Returns a paginated list of artifact summaries for the specified agent space.

Parameter Syntax

$result = $client->listArtifacts([
    'agentSpaceId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'artifactSummaries' => [
        [
            'artifactId' => '<string>',
            'artifactType' => 'TXT|PNG|JPEG|MD|PDF|DOCX|DOC|JSON|YAML',
            'fileName' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

InternalServerException:

An unexpected error occurred during the processing of your request.

ResourceNotFoundException:

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

ValidationException:

The input fails to satisfy the constraints specified by the service.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListCodeReviewJobTasks

$result = $client->listCodeReviewJobTasks([/* ... */]);
$promise = $client->listCodeReviewJobTasksAsync([/* ... */]);

Returns a paginated list of task summaries for the specified code review job, optionally filtered by step name or category.

Parameter Syntax

$result = $client->listCodeReviewJobTasks([
    'agentSpaceId' => '<string>', // REQUIRED
    'categoryName' => '<string>',
    'codeReviewJobId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'stepName' => 'PREFLIGHT|STATIC_ANALYSIS|PENTEST|FINALIZING|VALIDATION',
]);

Parameter Details

Result Syntax

[
    'codeReviewJobTaskSummaries' => [
        [
            'agentSpaceId' => '<string>',
            'codeReviewId' => '<string>',
            'codeReviewJobId' => '<string>',
            'createdAt' => <DateTime>,
            'executionStatus' => 'IN_PROGRESS|ABORTED|COMPLETED|INTERNAL_ERROR|FAILED',
            'riskType' => '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',
            'taskId' => '<string>',
            'title' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListCodeReviewJobsForCodeReview

$result = $client->listCodeReviewJobsForCodeReview([/* ... */]);
$promise = $client->listCodeReviewJobsForCodeReviewAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listCodeReviewJobsForCodeReview([
    'agentSpaceId' => '<string>', // REQUIRED
    'codeReviewId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'codeReviewJobSummaries' => [
        [
            'codeReviewId' => '<string>',
            'codeReviewJobId' => '<string>',
            'createdAt' => <DateTime>,
            'status' => 'IN_PROGRESS|STOPPING|STOPPED|FAILED|COMPLETED',
            'title' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListCodeReviews

$result = $client->listCodeReviews([/* ... */]);
$promise = $client->listCodeReviewsAsync([/* ... */]);

Returns a paginated list of code review summaries for the specified agent space.

Parameter Syntax

$result = $client->listCodeReviews([
    'agentSpaceId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'codeReviewSummaries' => [
        [
            'agentSpaceId' => '<string>',
            'codeReviewId' => '<string>',
            'createdAt' => <DateTime>,
            'title' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListDiscoveredEndpoints

$result = $client->listDiscoveredEndpoints([/* ... */]);
$promise = $client->listDiscoveredEndpointsAsync([/* ... */]);

Returns a paginated list of endpoints discovered during a pentest job execution.

Parameter Syntax

$result = $client->listDiscoveredEndpoints([
    'agentSpaceId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'pentestJobId' => '<string>', // REQUIRED
    'prefix' => '<string>',
]);

Parameter Details

Result Syntax

[
    'discoveredEndpoints' => [
        [
            'agentSpaceId' => '<string>',
            'description' => '<string>',
            'evidence' => '<string>',
            'operation' => '<string>',
            'pentestJobId' => '<string>',
            'taskId' => '<string>',
            'uri' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListFindings

$result = $client->listFindings([/* ... */]);
$promise = $client->listFindingsAsync([/* ... */]);

Lists the security findings for a pentest job.

Parameter Syntax

$result = $client->listFindings([
    'agentSpaceId' => '<string>', // REQUIRED
    'codeReviewJobId' => '<string>',
    'confidence' => 'FALSE_POSITIVE|UNCONFIRMED|LOW|MEDIUM|HIGH',
    'maxResults' => <integer>,
    'name' => '<string>',
    'nextToken' => '<string>',
    'pentestJobId' => '<string>',
    'riskLevel' => 'UNKNOWN|INFORMATIONAL|LOW|MEDIUM|HIGH|CRITICAL',
    'riskType' => '<string>',
    'status' => 'ACTIVE|RESOLVED|ACCEPTED|FALSE_POSITIVE',
]);

Parameter Details

Result Syntax

[
    'findingsSummaries' => [
        [
            'agentSpaceId' => '<string>',
            'codeReviewId' => '<string>',
            'codeReviewJobId' => '<string>',
            'confidence' => 'FALSE_POSITIVE|UNCONFIRMED|LOW|MEDIUM|HIGH',
            'createdAt' => <DateTime>,
            'findingId' => '<string>',
            'name' => '<string>',
            'pentestId' => '<string>',
            'pentestJobId' => '<string>',
            'riskLevel' => 'UNKNOWN|INFORMATIONAL|LOW|MEDIUM|HIGH|CRITICAL',
            'riskType' => '<string>',
            'status' => 'ACTIVE|RESOLVED|ACCEPTED|FALSE_POSITIVE',
            'updatedAt' => <DateTime>,
            'validationStatus' => 'CONFIRMED|NOT_REPRODUCED|VALIDATION_FAILED|VALIDATING|NOT_VALIDATED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListIntegratedResources

$result = $client->listIntegratedResources([/* ... */]);
$promise = $client->listIntegratedResourcesAsync([/* ... */]);

Lists the integrated resources for an agent space, optionally filtered by integration or resource type.

Parameter Syntax

$result = $client->listIntegratedResources([
    'agentSpaceId' => '<string>', // REQUIRED
    'integrationId' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'resourceType' => 'CODE_REPOSITORY|DOCUMENT',
]);

Parameter Details

Result Syntax

[
    'integratedResourceSummaries' => [
        [
            'capabilities' => [
                'bitbucket' => [
                    'leaveComments' => true || false,
                    'remediateCode' => true || false,
                ],
                'confluence' => [
                    'createDocument' => true || false,
                    'fetchDocument' => true || false,
                    'updateDocument' => true || false,
                ],
                'github' => [
                    'leaveComments' => true || false,
                    'remediateCode' => true || false,
                ],
                'gitlab' => [
                    'leaveComments' => true || false,
                    'remediateCode' => true || false,
                ],
            ],
            'integrationId' => '<string>',
            'resource' => [
                'bitbucketRepository' => [
                    'accessType' => 'PRIVATE|PUBLIC',
                    'name' => '<string>',
                    'providerResourceId' => '<string>',
                    'workspace' => '<string>',
                ],
                'confluenceDocument' => [
                    'name' => '<string>',
                    'pageId' => '<string>',
                    'providerResourceId' => '<string>',
                    'spaceKey' => '<string>',
                    'spaceTitle' => '<string>',
                    'title' => '<string>',
                ],
                'githubRepository' => [
                    'accessType' => 'PRIVATE|PUBLIC',
                    'name' => '<string>',
                    'owner' => '<string>',
                    'providerResourceId' => '<string>',
                ],
                'gitlabRepository' => [
                    'accessType' => 'PRIVATE|PUBLIC',
                    'name' => '<string>',
                    'namespace' => '<string>',
                    'providerResourceId' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

InternalServerException:

An unexpected error occurred during the processing of your request.

ValidationException:

The input fails to satisfy the constraints specified by the service.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListIntegrations

$result = $client->listIntegrations([/* ... */]);
$promise = $client->listIntegrationsAsync([/* ... */]);

Lists the integrations in your account, optionally filtered by provider or provider type.

Parameter Syntax

$result = $client->listIntegrations([
    'filter' => [
        'provider' => 'GITHUB|GITLAB|BITBUCKET|CONFLUENCE',
        'providerType' => 'SOURCE_CODE|DOCUMENTATION',
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'integrationSummaries' => [
        [
            'displayName' => '<string>',
            'installationId' => '<string>',
            'integrationId' => '<string>',
            'privateConnectionName' => '<string>',
            'provider' => 'GITHUB|GITLAB|BITBUCKET|CONFLUENCE',
            'providerType' => 'SOURCE_CODE|DOCUMENTATION',
            'targetUrl' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.

InternalServerException:

An unexpected error occurred during the processing of your request.

ValidationException:

The input fails to satisfy the constraints specified by the service.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListMemberships

$result = $client->listMemberships([/* ... */]);
$promise = $client->listMembershipsAsync([/* ... */]);

Returns a paginated list of membership summaries for the specified agent space within an application.

Parameter Syntax

$result = $client->listMemberships([
    'agentSpaceId' => '<string>', // REQUIRED
    'applicationId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'memberType' => 'USER|ALL',
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'membershipSummaries' => [
        [
            'agentSpaceId' => '<string>',
            'applicationId' => '<string>',
            'config' => [
                'user' => [
                    'role' => 'MEMBER',
                ],
            ],
            'createdAt' => <DateTime>,
            'createdBy' => '<string>',
            'memberType' => 'USER',
            'membershipId' => '<string>',
            'metadata' => [
                'user' => [
                    'email' => '<string>',
                    'username' => '<string>',
                ],
            ],
            'updatedAt' => <DateTime>,
            'updatedBy' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListPentestJobTasks

$result = $client->listPentestJobTasks([/* ... */]);
$promise = $client->listPentestJobTasksAsync([/* ... */]);

Returns a paginated list of task summaries for the specified pentest job, optionally filtered by step name or category.

Parameter Syntax

$result = $client->listPentestJobTasks([
    'agentSpaceId' => '<string>', // REQUIRED
    'categoryName' => '<string>',
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'pentestJobId' => '<string>',
    'stepName' => 'PREFLIGHT|STATIC_ANALYSIS|PENTEST|FINALIZING|VALIDATION',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'taskSummaries' => [
        [
            'agentSpaceId' => '<string>',
            'createdAt' => <DateTime>,
            'executionStatus' => 'IN_PROGRESS|ABORTED|COMPLETED|INTERNAL_ERROR|FAILED',
            'pentestId' => '<string>',
            'pentestJobId' => '<string>',
            'riskType' => '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',
            'taskId' => '<string>',
            'title' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

ListPentestJobsForPentest

$result = $client->listPentestJobsForPentest([/* ... */]);
$promise = $client->listPentestJobsForPentestAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listPentestJobsForPentest([
    'agentSpaceId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'pentestId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'pentestJobSummaries' => [
        [
            'createdAt' => <DateTime>,
            'pentestId' => '<string>',
            'pentestJobId' => '<string>',
            'status' => 'IN_PROGRESS|STOPPING|STOPPED|FAILED|COMPLETED',
            'title' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

ListPentests

$result = $client->listPentests([/* ... */]);
$promise = $client->listPentestsAsync([/* ... */]);

Returns a paginated list of pentest summaries for the specified agent space.

Parameter Syntax

$result = $client->listPentests([
    'agentSpaceId' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'pentestSummaries' => [
        [
            'agentSpaceId' => '<string>',
            'createdAt' => <DateTime>,
            'pentestId' => '<string>',
            'title' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

ListPrivateConnections

$result = $client->listPrivateConnections([/* ... */]);
$promise = $client->listPrivateConnectionsAsync([/* ... */]);

Lists the private connections in your account.

Parameter Syntax

$result = $client->listPrivateConnections([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'privateConnections' => [
        [
            'certificateExpiryTime' => <DateTime>,
            'dnsResolution' => 'PUBLIC|IN_VPC',
            'failureMessage' => '<string>',
            'hostAddress' => '<string>',
            'name' => '<string>',
            'resourceConfigurationId' => '<string>',
            'resourceGatewayId' => '<string>',
            'status' => 'ACTIVE|CREATE_IN_PROGRESS|CREATE_FAILED|DELETE_IN_PROGRESS|DELETE_FAILED',
            'tags' => ['<string>', ...],
            'type' => 'SERVICE_MANAGED|SELF_MANAGED',
            'vpcId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The input fails to satisfy the constraints specified by the service.

InternalServerException:

An unexpected error occurred during the processing of your request.

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You do not have sufficient access to perform this action.

ListSecurityRequirementPacks

$result = $client->listSecurityRequirementPacks([/* ... */]);
$promise = $client->listSecurityRequirementPacksAsync([/* ... */]);

Lists all security requirement packs in the caller's account.

Parameter Syntax

$result = $client->listSecurityRequirementPacks([
    'filter' => [
        'managementType' => 'AWS_MANAGED|CUSTOMER_MANAGED',
        'status' => 'ENABLED|DISABLED',
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'securityRequirementPackSummaries' => [
        [
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'managementType' => 'AWS_MANAGED|CUSTOMER_MANAGED',
            'name' => '<string>',
            'packId' => '<string>',
            'status' => 'ENABLED|DISABLED',
            'updatedAt' => <DateTime>,
            'vendorName' => '<string>',
        ],
        // ...
    ],
]

Result Details