AddArtifact

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

Adds an Artifact for the given agent space

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:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

InternalServerException:

Unexpected server error occurred

ResourceNotFoundException:

Specified resource was not found

ThrottlingException:

Request denied due to throttling

AccessDeniedException:

Request denied due to insufficient permissions

BatchDeletePentests

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

Deletes multiple pentests in a single request

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>',
                        's3Location' => '<string>',
                    ],
                    // ...
                ],
                'endpoints' => [
                    [
                        'uri' => '<string>',
                    ],
                    // ...
                ],
                'integratedRepositories' => [
                    [
                        'integrationId' => '<string>',
                        'providerResourceId' => '<string>',
                    ],
                    // ...
                ],
                'sourceCode' => [
                    [
                        's3Location' => '<string>',
                    ],
                    // ...
                ],
            ],
            'codeRemediationStrategy' => 'AUTOMATIC|DISABLED',
            'createdAt' => <DateTime>,
            '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.

BatchGetAgentSpaces

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

Retrieves multiple agent spaces in a single request

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([/* ... */]);

Retrieve the list of artifact metadata for the given 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:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

InternalServerException:

Unexpected server error occurred

ResourceNotFoundException:

Specified resource was not found

ThrottlingException:

Request denied due to throttling

AccessDeniedException:

Request denied due to insufficient permissions

BatchGetFindings

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

Retrieves multiple findings in a single request

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'findings' => [
        [
            'agentSpaceId' => '<string>',
            'attackScript' => '<string>',
            'codeRemediationTask' => [
                'status' => 'IN_PROGRESS|COMPLETED|FAILED',
                'statusReason' => '<string>',
                'taskDetails' => [
                    [
                        'codeDiffLink' => '<string>',
                        'pullRequestLink' => '<string>',
                        'repoName' => '<string>',
                    ],
                    // ...
                ],
            ],
            'confidence' => 'FALSE_POSITIVE|UNCONFIRMED|LOW|MEDIUM|HIGH',
            'createdAt' => <DateTime>,
            '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>,
        ],
        // ...
    ],
    'notFound' => ['<string>', ...],
]

Result Details

Errors

There are no errors described for this operation.

BatchGetPentestJobTasks

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

Retrieves multiple tasks for a pentest job in a single request

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 multiple pentest jobs in a single request

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>',
                ],
                // ...
            ],
            'codeRemediationStrategy' => 'AUTOMATIC|DISABLED',
            'createdAt' => <DateTime>,
            'documents' => [
                [
                    'artifactId' => '<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',
                    '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 multiple pentests in a single request

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>',
                        's3Location' => '<string>',
                    ],
                    // ...
                ],
                'endpoints' => [
                    [
                        'uri' => '<string>',
                    ],
                    // ...
                ],
                'integratedRepositories' => [
                    [
                        'integrationId' => '<string>',
                        'providerResourceId' => '<string>',
                    ],
                    // ...
                ],
                'sourceCode' => [
                    [
                        's3Location' => '<string>',
                    ],
                    // ...
                ],
            ],
            'codeRemediationStrategy' => 'AUTOMATIC|DISABLED',
            'createdAt' => <DateTime>,
            '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.

BatchGetTargetDomains

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

Retrieves multiple target domains in a single request

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',
            ],
            'verificationStatus' => 'PENDING|VERIFIED|FAILED|UNREACHABLE',
            'verifiedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

CreateAgentSpace

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

Creates an agent space record

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

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.

CreateIntegration

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

Creates the Integration of the Security Agent App with an external Provider

Parameter Syntax

$result = $client->createIntegration([
    'input' => [ // REQUIRED
        'github' => [
            'code' => '<string>', // REQUIRED
            'organizationName' => '<string>',
            'state' => '<string>', // REQUIRED
        ],
    ],
    'integrationDisplayName' => '<string>', // REQUIRED
    'kmsKeyId' => '<string>',
    'provider' => 'GITHUB', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

Specified resource was not found

InternalServerException:

Unexpected server error occurred

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ConflictException:

Request conflicts with current resource state

ThrottlingException:

Request denied due to throttling

AccessDeniedException:

Request denied due to insufficient permissions

CreateMembership

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

Adds a single member to an agent space with specified role

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

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>',
                's3Location' => '<string>',
            ],
            // ...
        ],
        'endpoints' => [
            [
                'uri' => '<string>',
            ],
            // ...
        ],
        'integratedRepositories' => [
            [
                'integrationId' => '<string>', // REQUIRED
                'providerResourceId' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'sourceCode' => [
            [
                's3Location' => '<string>',
            ],
            // ...
        ],
    ],
    'codeRemediationStrategy' => 'AUTOMATIC|DISABLED',
    '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>',
                '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.

CreateTargetDomain

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

Creates a target domain record

Parameter Syntax

$result = $client->createTargetDomain([
    'tags' => ['<string>', ...],
    'targetDomainName' => '<string>', // REQUIRED
    'verificationMethod' => 'DNS_TXT|HTTP_ROUTE', // 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',
    ],
    'verificationStatus' => 'PENDING|VERIFIED|FAILED|UNREACHABLE',
    'verifiedAt' => <DateTime>,
]

Result Details

Errors

There are no errors described for this operation.

DeleteAgentSpace

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

Deletes an agent space record

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

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([/* ... */]);

Delete an Artifact from the given agent space

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Specified resource was not found

InternalServerException:

Unexpected server error occurred

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ThrottlingException:

Request denied due to throttling

AccessDeniedException:

Request denied due to insufficient permissions

DeleteIntegration

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

Deletes the Integration of the Security Agent App with an external Provider

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Specified resource was not found

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

InternalServerException:

Unexpected server error occurred

ConflictException:

Request conflicts with current resource state

ThrottlingException:

Request denied due to throttling

AccessDeniedException:

Request denied due to insufficient permissions

DeleteMembership

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

Removes a single member associated 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.

DeleteTargetDomain

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

Deletes a target domain record

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.

GetApplication

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

Retrieves application details by application ID

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([/* ... */]);

Retrieve an Artifact for the given 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:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

InternalServerException:

Unexpected server error occurred

ResourceNotFoundException:

Specified resource was not found

ThrottlingException:

Request denied due to throttling

AccessDeniedException:

Request denied due to insufficient permissions

GetIntegration

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

Gets Integration metadata from the provided id

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'displayName' => '<string>',
    'installationId' => '<string>',
    'integrationId' => '<string>',
    'kmsKeyId' => '<string>',
    'provider' => 'GITHUB',
    'providerType' => 'SOURCE_CODE|DOCUMENTATION',
]

Result Details

Errors

ResourceNotFoundException:

Specified resource was not found

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

InternalServerException:

Unexpected server error occurred

ThrottlingException:

Request denied due to throttling

AccessDeniedException:

Request denied due to insufficient permissions

InitiateProviderRegistration

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

Initiates the registration of Security Agent App for an external Provider

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

Specified resource was not found

InternalServerException:

Unexpected server error occurred

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ConflictException:

Request conflicts with current resource state

ThrottlingException:

Request denied due to throttling

AccessDeniedException:

Request denied due to insufficient permissions

ListAgentSpaces

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

Lists agent spaces

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([/* ... */]);

Lists all applications in the 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([/* ... */]);

Lists the artifacts for the associated 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:

Unexpected server error occurred

ResourceNotFoundException:

Specified resource was not found

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ThrottlingException:

Request denied due to throttling

AccessDeniedException:

Request denied due to insufficient permissions

ListDiscoveredEndpoints

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

Lists discovered endpoints associated with a pentest job with optional URI prefix filtering

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 findings with filtering and pagination support. When filters are applied, the actual number of results returned may be less than the specified limit

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'findingsSummaries' => [
        [
            'agentSpaceId' => '<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>,
        ],
        // ...
    ],
    '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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'integratedResourceSummaries' => [
        [
            'capabilities' => [
                'github' => [
                    'leaveComments' => true || false,
                    'remediateCode' => true || false,
                ],
            ],
            'integrationId' => '<string>',
            'resource' => [
                'githubRepository' => [
                    'accessType' => 'PRIVATE|PUBLIC',
                    'name' => '<string>',
                    'owner' => '<string>',
                    'providerResourceId' => '<string>',
                ],
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Specified resource was not found

InternalServerException:

Unexpected server error occurred

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ThrottlingException:

Request denied due to throttling

AccessDeniedException:

Request denied due to insufficient permissions

ListIntegrations

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

Retrieves the Integrations associated with the user's account

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

Specified resource was not found

InternalServerException:

Unexpected server error occurred

ThrottlingException:

Request denied due to throttling

AccessDeniedException:

Request denied due to insufficient permissions

ListMemberships

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

Lists all members associated to an agent space with pagination support

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([/* ... */]);

Lists tasks associated with a specific pentest job

Parameter Syntax

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

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([/* ... */]);

Lists pentest jobs associated with a pentest

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([/* ... */]);

Lists pentests with optional filtering by status

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.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists tags for a Security Agent resource

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

There are no errors described for this operation.

ListTargetDomains

$result = $client->listTargetDomains([/* ... */]);
$promise = $client->listTargetDomainsAsync([/* ... */]);

Lists target domains

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'targetDomainSummaries' => [
        [
            'domainName' => '<string>',
            'targetDomainId' => '<string>',
            'verificationStatus' => 'PENDING|VERIFIED|FAILED|UNREACHABLE',
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

StartCodeRemediation

$result = $client->startCodeRemediation([/* ... */]);
$promise = $client->startCodeRemediationAsync([/* ... */]);

Starts code remediation for the specified findings

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

StartPentestJob

$result = $client->startPentestJob([/* ... */]);
$promise = $client->startPentestJobAsync([/* ... */]);

Initiates the execution of a pentest

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'agentSpaceId' => '<string>',
    '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.

StopPentestJob

$result = $client->stopPentestJob([/* ... */]);
$promise = $client->stopPentestJobAsync([/* ... */]);

Stops the execution of a running pentest

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds tags to a Security Agent resource

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from a Security Agent resource

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

UpdateAgentSpace

$result = $client->updateAgentSpace([/* ... */]);
$promise = $client->updateAgentSpaceAsync([/* ... */]);

Updates an agent space record

Parameter Syntax

$result = $client->updateAgentSpace([
    'agentSpaceId' => '<string>', // REQUIRED
    '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>',
    'name' => '<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>',
    'name' => '<string>',
    'targetDomainIds' => ['<string>', ...],
    'updatedAt' => <DateTime>,
]

Result Details

Errors

There are no errors described for this operation.

UpdateApplication

$result = $client->updateApplication([/* ... */]);
$promise = $client->updateApplicationAsync([/* ... */]);

Updates application configuration

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

There are no errors described for this operation.

UpdateFinding

$result = $client->updateFinding([/* ... */]);
$promise = $client->updateFindingAsync([/* ... */]);

Updates an existing security finding with new details or status

Parameter Syntax

$result = $client->updateFinding([
    'agentSpaceId' => '<string>', // REQUIRED
    'findingId' => '<string>', // REQUIRED
    'riskLevel' => 'UNKNOWN|INFORMATIONAL|LOW|MEDIUM|HIGH|CRITICAL',
    'status' => 'ACTIVE|RESOLVED|ACCEPTED|FALSE_POSITIVE',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

UpdateIntegratedResources

$result = $client->updateIntegratedResources([/* ... */]);
$promise = $client->updateIntegratedResourcesAsync([/* ... */]);

Updates the integrated resources for an agent space

Parameter Syntax

$result = $client->updateIntegratedResources([
    'agentSpaceId' => '<string>', // REQUIRED
    'integrationId' => '<string>', // REQUIRED
    'items' => [ // REQUIRED
        [
            'capabilities' => [
                'github' => [
                    'leaveComments' => true || false,
                    'remediateCode' => true || false,
                ],
            ],
            'resource' => [ // REQUIRED
                'githubRepository' => [
                    'name' => '<string>', // REQUIRED
                    'owner' => '<string>', // REQUIRED
                ],
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.

ResourceNotFoundException:

Specified resource was not found

InternalServerException:

Unexpected server error occurred

ConflictException:

Request conflicts with current resource state

ThrottlingException:

Request denied due to throttling

AccessDeniedException:

Request denied due to insufficient permissions

UpdatePentest

$result = $client->updatePentest([/* ... */]);
$promise = $client->updatePentestAsync([/* ... */]);

Updates an existing pentest with new configuration or settings

Parameter Syntax

$result = $client->updatePentest([
    '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>',
                's3Location' => '<string>',
            ],
            // ...
        ],
        'endpoints' => [
            [
                'uri' => '<string>',
            ],
            // ...
        ],
        'integratedRepositories' => [
            [
                'integrationId' => '<string>', // REQUIRED
                'providerResourceId' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'sourceCode' => [
            [
                's3Location' => '<string>',
            ],
            // ...
        ],
    ],
    'codeRemediationStrategy' => 'AUTOMATIC|DISABLED',
    'excludeRiskTypes' => ['<string>', ...],
    'logConfig' => [
        'logGroup' => '<string>',
        'logStream' => '<string>',
    ],
    'networkTrafficConfig' => [
        'customHeaders' => [
            [
                'name' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'rules' => [
            [
                'effect' => 'ALLOW|DENY',
                'networkTrafficRuleType' => 'URL',
                'pattern' => '<string>',
            ],
            // ...
        ],
    ],
    'pentestId' => '<string>', // REQUIRED
    'serviceRole' => '<string>',
    'title' => '<string>',
    '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>',
                '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.

UpdateTargetDomain

$result = $client->updateTargetDomain([/* ... */]);
$promise = $client->updateTargetDomainAsync([/* ... */]);

Updates a target domain record

Parameter Syntax

$result = $client->updateTargetDomain([
    'targetDomainId' => '<string>', // REQUIRED
    'verificationMethod' => 'DNS_TXT|HTTP_ROUTE', // 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',
    ],
    'verificationStatus' => 'PENDING|VERIFIED|FAILED|UNREACHABLE',
    'verifiedAt' => <DateTime>,
]

Result Details

Errors

There are no errors described for this operation.

VerifyTargetDomain

$result = $client->verifyTargetDomain([/* ... */]);
$promise = $client->verifyTargetDomainAsync([/* ... */]);

Verifies ownership for a registered target domain

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'domainName' => '<string>',
    'status' => 'PENDING|VERIFIED|FAILED|UNREACHABLE',
    'targetDomainId' => '<string>',
    'updatedAt' => <DateTime>,
    'verifiedAt' => <DateTime>,
]

Result Details

Errors

There are no errors described for this operation.