{ "version":"2.0", "metadata":{ "apiVersion":"2025-09-06", "auth":["aws.auth#sigv4"], "endpointPrefix":"securityagent", "protocol":"rest-json", "protocols":["rest-json"], "serviceFullName":"AWS Security Agent", "serviceId":"SecurityAgent", "signatureVersion":"v4", "signingName":"securityagent", "uid":"securityagent-2025-09-06" }, "operations":{ "AddArtifact":{ "name":"AddArtifact", "http":{ "method":"POST", "requestUri":"/AddArtifact", "responseCode":201 }, "input":{"shape":"AddArtifactInput"}, "output":{"shape":"AddArtifactOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Adds an Artifact for the given agent space

" }, "BatchDeletePentests":{ "name":"BatchDeletePentests", "http":{ "method":"POST", "requestUri":"/BatchDeletePentests", "responseCode":200 }, "input":{"shape":"BatchDeletePentestsInput"}, "output":{"shape":"BatchDeletePentestsOutput"}, "documentation":"

Deletes multiple pentests in a single request

" }, "BatchGetAgentSpaces":{ "name":"BatchGetAgentSpaces", "http":{ "method":"POST", "requestUri":"/BatchGetAgentSpaces", "responseCode":200 }, "input":{"shape":"BatchGetAgentSpacesInput"}, "output":{"shape":"BatchGetAgentSpacesOutput"}, "documentation":"

Retrieves multiple agent spaces in a single request

", "readonly":true }, "BatchGetArtifactMetadata":{ "name":"BatchGetArtifactMetadata", "http":{ "method":"POST", "requestUri":"/BatchGetArtifactMetadata", "responseCode":200 }, "input":{"shape":"BatchGetArtifactMetadataInput"}, "output":{"shape":"BatchGetArtifactMetadataOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Retrieve the list of artifact metadata for the given agent space

" }, "BatchGetFindings":{ "name":"BatchGetFindings", "http":{ "method":"POST", "requestUri":"/BatchGetFindings", "responseCode":200 }, "input":{"shape":"BatchGetFindingsInput"}, "output":{"shape":"BatchGetFindingsOutput"}, "documentation":"

Retrieves multiple findings in a single request

" }, "BatchGetPentestJobTasks":{ "name":"BatchGetPentestJobTasks", "http":{ "method":"POST", "requestUri":"/BatchGetPentestJobTasks", "responseCode":200 }, "input":{"shape":"BatchGetPentestJobTasksInput"}, "output":{"shape":"BatchGetPentestJobTasksOutput"}, "documentation":"

Retrieves multiple tasks for a pentest job in a single request

" }, "BatchGetPentestJobs":{ "name":"BatchGetPentestJobs", "http":{ "method":"POST", "requestUri":"/BatchGetPentestJobs", "responseCode":200 }, "input":{"shape":"BatchGetPentestJobsInput"}, "output":{"shape":"BatchGetPentestJobsOutput"}, "documentation":"

Retrieves multiple pentest jobs in a single request

" }, "BatchGetPentests":{ "name":"BatchGetPentests", "http":{ "method":"POST", "requestUri":"/BatchGetPentests", "responseCode":200 }, "input":{"shape":"BatchGetPentestsInput"}, "output":{"shape":"BatchGetPentestsOutput"}, "documentation":"

Retrieves multiple pentests in a single request

" }, "BatchGetTargetDomains":{ "name":"BatchGetTargetDomains", "http":{ "method":"POST", "requestUri":"/BatchGetTargetDomains", "responseCode":200 }, "input":{"shape":"BatchGetTargetDomainsInput"}, "output":{"shape":"BatchGetTargetDomainsOutput"}, "documentation":"

Retrieves multiple target domains in a single request

", "readonly":true }, "CreateAgentSpace":{ "name":"CreateAgentSpace", "http":{ "method":"POST", "requestUri":"/CreateAgentSpace", "responseCode":200 }, "input":{"shape":"CreateAgentSpaceInput"}, "output":{"shape":"CreateAgentSpaceOutput"}, "documentation":"

Creates an agent space record

" }, "CreateApplication":{ "name":"CreateApplication", "http":{ "method":"POST", "requestUri":"/CreateApplication", "responseCode":200 }, "input":{"shape":"CreateApplicationRequest"}, "output":{"shape":"CreateApplicationResponse"}, "documentation":"

Creates a new application

" }, "CreateIntegration":{ "name":"CreateIntegration", "http":{ "method":"POST", "requestUri":"/CreateIntegration", "responseCode":201 }, "input":{"shape":"CreateIntegrationInput"}, "output":{"shape":"CreateIntegrationOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

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

" }, "CreateMembership":{ "name":"CreateMembership", "http":{ "method":"POST", "requestUri":"/CreateMembership", "responseCode":200 }, "input":{"shape":"CreateMembershipRequest"}, "output":{"shape":"CreateMembershipResponse"}, "documentation":"

Adds a single member to an agent space with specified role

" }, "CreatePentest":{ "name":"CreatePentest", "http":{ "method":"POST", "requestUri":"/CreatePentest", "responseCode":200 }, "input":{"shape":"CreatePentestInput"}, "output":{"shape":"CreatePentestOutput"}, "documentation":"

Creates a new pentest configuration

" }, "CreateTargetDomain":{ "name":"CreateTargetDomain", "http":{ "method":"POST", "requestUri":"/CreateTargetDomain", "responseCode":200 }, "input":{"shape":"CreateTargetDomainInput"}, "output":{"shape":"CreateTargetDomainOutput"}, "documentation":"

Creates a target domain record

" }, "DeleteAgentSpace":{ "name":"DeleteAgentSpace", "http":{ "method":"POST", "requestUri":"/DeleteAgentSpace", "responseCode":200 }, "input":{"shape":"DeleteAgentSpaceInput"}, "output":{"shape":"DeleteAgentSpaceOutput"}, "documentation":"

Deletes an agent space record

", "idempotent":true }, "DeleteApplication":{ "name":"DeleteApplication", "http":{ "method":"POST", "requestUri":"/DeleteApplication", "responseCode":200 }, "input":{"shape":"DeleteApplicationRequest"}, "documentation":"

Deletes an application

", "idempotent":true }, "DeleteArtifact":{ "name":"DeleteArtifact", "http":{ "method":"POST", "requestUri":"/DeleteArtifact", "responseCode":200 }, "input":{"shape":"DeleteArtifactInput"}, "output":{"shape":"DeleteArtifactOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Delete an Artifact from the given agent space

" }, "DeleteIntegration":{ "name":"DeleteIntegration", "http":{ "method":"POST", "requestUri":"/DeleteIntegration", "responseCode":200 }, "input":{"shape":"DeleteIntegrationInput"}, "output":{"shape":"DeleteIntegrationOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

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

", "idempotent":true }, "DeleteMembership":{ "name":"DeleteMembership", "http":{ "method":"POST", "requestUri":"/DeleteMembership", "responseCode":200 }, "input":{"shape":"DeleteMembershipRequest"}, "output":{"shape":"DeleteMembershipResponse"}, "documentation":"

Removes a single member associated to an agent space

" }, "DeleteTargetDomain":{ "name":"DeleteTargetDomain", "http":{ "method":"POST", "requestUri":"/DeleteTargetDomain", "responseCode":200 }, "input":{"shape":"DeleteTargetDomainInput"}, "output":{"shape":"DeleteTargetDomainOutput"}, "documentation":"

Deletes a target domain record

", "idempotent":true }, "GetApplication":{ "name":"GetApplication", "http":{ "method":"POST", "requestUri":"/GetApplication", "responseCode":200 }, "input":{"shape":"GetApplicationRequest"}, "output":{"shape":"GetApplicationResponse"}, "documentation":"

Retrieves application details by application ID

", "readonly":true }, "GetArtifact":{ "name":"GetArtifact", "http":{ "method":"POST", "requestUri":"/GetArtifact", "responseCode":200 }, "input":{"shape":"GetArtifactInput"}, "output":{"shape":"GetArtifactOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Retrieve an Artifact for the given agent space

" }, "GetIntegration":{ "name":"GetIntegration", "http":{ "method":"POST", "requestUri":"/GetIntegration", "responseCode":200 }, "input":{"shape":"GetIntegrationInput"}, "output":{"shape":"GetIntegrationOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Gets Integration metadata from the provided id

", "readonly":true }, "InitiateProviderRegistration":{ "name":"InitiateProviderRegistration", "http":{ "method":"POST", "requestUri":"/oauth2/provider/register", "responseCode":200 }, "input":{"shape":"InitiateProviderRegistrationInput"}, "output":{"shape":"InitiateProviderRegistrationOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Initiates the registration of Security Agent App for an external Provider

" }, "ListAgentSpaces":{ "name":"ListAgentSpaces", "http":{ "method":"POST", "requestUri":"/ListAgentSpaces", "responseCode":200 }, "input":{"shape":"ListAgentSpacesInput"}, "output":{"shape":"ListAgentSpacesOutput"}, "documentation":"

Lists agent spaces

", "readonly":true }, "ListApplications":{ "name":"ListApplications", "http":{ "method":"POST", "requestUri":"/ListApplications", "responseCode":200 }, "input":{"shape":"ListApplicationsRequest"}, "output":{"shape":"ListApplicationsResponse"}, "documentation":"

Lists all applications in the account

", "readonly":true }, "ListArtifacts":{ "name":"ListArtifacts", "http":{ "method":"POST", "requestUri":"/ListArtifacts", "responseCode":200 }, "input":{"shape":"ListArtifactsInput"}, "output":{"shape":"ListArtifactsOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists the artifacts for the associated agent space

", "readonly":true }, "ListDiscoveredEndpoints":{ "name":"ListDiscoveredEndpoints", "http":{ "method":"POST", "requestUri":"/ListDiscoveredEndpoints", "responseCode":200 }, "input":{"shape":"ListDiscoveredEndpointsInput"}, "output":{"shape":"ListDiscoveredEndpointsOutput"}, "documentation":"

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

" }, "ListFindings":{ "name":"ListFindings", "http":{ "method":"POST", "requestUri":"/ListFindings", "responseCode":200 }, "input":{"shape":"ListFindingsInput"}, "output":{"shape":"ListFindingsOutput"}, "documentation":"

Lists findings with filtering and pagination support. When filters are applied, the actual number of results returned may be less than the specified limit

" }, "ListIntegratedResources":{ "name":"ListIntegratedResources", "http":{ "method":"POST", "requestUri":"/ListIntegratedResources", "responseCode":200 }, "input":{"shape":"ListIntegratedResourcesInput"}, "output":{"shape":"ListIntegratedResourcesOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists the integrated resources for an agent space

" }, "ListIntegrations":{ "name":"ListIntegrations", "http":{ "method":"POST", "requestUri":"/ListIntegrations", "responseCode":200 }, "input":{"shape":"ListIntegrationsInput"}, "output":{"shape":"ListIntegrationsOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Retrieves the Integrations associated with the user's account

", "readonly":true }, "ListMemberships":{ "name":"ListMemberships", "http":{ "method":"POST", "requestUri":"/ListMemberships", "responseCode":200 }, "input":{"shape":"ListMembershipsRequest"}, "output":{"shape":"ListMembershipsResponse"}, "documentation":"

Lists all members associated to an agent space with pagination support

" }, "ListPentestJobTasks":{ "name":"ListPentestJobTasks", "http":{ "method":"POST", "requestUri":"/ListPentestJobTasks", "responseCode":200 }, "input":{"shape":"ListPentestJobTasksInput"}, "output":{"shape":"ListPentestJobTasksOutput"}, "documentation":"

Lists tasks associated with a specific pentest job

" }, "ListPentestJobsForPentest":{ "name":"ListPentestJobsForPentest", "http":{ "method":"POST", "requestUri":"/ListPentestJobsForPentest", "responseCode":200 }, "input":{"shape":"ListPentestJobsForPentestInput"}, "output":{"shape":"ListPentestJobsForPentestOutput"}, "documentation":"

Lists pentest jobs associated with a pentest

" }, "ListPentests":{ "name":"ListPentests", "http":{ "method":"POST", "requestUri":"/ListPentests", "responseCode":200 }, "input":{"shape":"ListPentestsInput"}, "output":{"shape":"ListPentestsOutput"}, "documentation":"

Lists pentests with optional filtering by status

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{resourceArn}", "responseCode":200 }, "input":{"shape":"ListTagsForResourceInput"}, "output":{"shape":"ListTagsForResourceOutput"}, "documentation":"

Lists tags for a Security Agent resource

", "readonly":true }, "ListTargetDomains":{ "name":"ListTargetDomains", "http":{ "method":"POST", "requestUri":"/ListTargetDomains", "responseCode":200 }, "input":{"shape":"ListTargetDomainsInput"}, "output":{"shape":"ListTargetDomainsOutput"}, "documentation":"

Lists target domains

", "readonly":true }, "StartCodeRemediation":{ "name":"StartCodeRemediation", "http":{ "method":"POST", "requestUri":"/StartCodeRemediation", "responseCode":200 }, "input":{"shape":"StartCodeRemediationInput"}, "output":{"shape":"StartCodeRemediationOutput"}, "documentation":"

Starts code remediation for the specified findings

" }, "StartPentestJob":{ "name":"StartPentestJob", "http":{ "method":"POST", "requestUri":"/StartPentestJob", "responseCode":200 }, "input":{"shape":"StartPentestJobInput"}, "output":{"shape":"StartPentestJobOutput"}, "documentation":"

Initiates the execution of a pentest

" }, "StopPentestJob":{ "name":"StopPentestJob", "http":{ "method":"POST", "requestUri":"/StopPentestJob", "responseCode":200 }, "input":{"shape":"StopPentestJobInput"}, "output":{"shape":"StopPentestJobOutput"}, "documentation":"

Stops the execution of a running pentest

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{resourceArn}", "responseCode":204 }, "input":{"shape":"TagResourceInput"}, "output":{"shape":"TagResourceOutput"}, "documentation":"

Adds tags to a Security Agent resource

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{resourceArn}", "responseCode":204 }, "input":{"shape":"UntagResourceInput"}, "output":{"shape":"UntagResourceOutput"}, "documentation":"

Removes tags from a Security Agent resource

", "idempotent":true }, "UpdateAgentSpace":{ "name":"UpdateAgentSpace", "http":{ "method":"POST", "requestUri":"/UpdateAgentSpace", "responseCode":200 }, "input":{"shape":"UpdateAgentSpaceInput"}, "output":{"shape":"UpdateAgentSpaceOutput"}, "documentation":"

Updates an agent space record

" }, "UpdateApplication":{ "name":"UpdateApplication", "http":{ "method":"POST", "requestUri":"/UpdateApplication", "responseCode":200 }, "input":{"shape":"UpdateApplicationRequest"}, "output":{"shape":"UpdateApplicationResponse"}, "documentation":"

Updates application configuration

", "idempotent":true }, "UpdateFinding":{ "name":"UpdateFinding", "http":{ "method":"POST", "requestUri":"/UpdateFinding", "responseCode":200 }, "input":{"shape":"UpdateFindingInput"}, "output":{"shape":"UpdateFindingOutput"}, "documentation":"

Updates an existing security finding with new details or status

" }, "UpdateIntegratedResources":{ "name":"UpdateIntegratedResources", "http":{ "method":"POST", "requestUri":"/UpdateIntegratedResources", "responseCode":200 }, "input":{"shape":"UpdateIntegratedResourcesInput"}, "output":{"shape":"UpdateIntegratedResourcesOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ConflictException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Updates the integrated resources for an agent space

" }, "UpdatePentest":{ "name":"UpdatePentest", "http":{ "method":"POST", "requestUri":"/UpdatePentest", "responseCode":200 }, "input":{"shape":"UpdatePentestInput"}, "output":{"shape":"UpdatePentestOutput"}, "documentation":"

Updates an existing pentest with new configuration or settings

" }, "UpdateTargetDomain":{ "name":"UpdateTargetDomain", "http":{ "method":"POST", "requestUri":"/UpdateTargetDomain", "responseCode":200 }, "input":{"shape":"UpdateTargetDomainInput"}, "output":{"shape":"UpdateTargetDomainOutput"}, "documentation":"

Updates a target domain record

" }, "VerifyTargetDomain":{ "name":"VerifyTargetDomain", "http":{ "method":"POST", "requestUri":"/VerifyTargetDomain", "responseCode":200 }, "input":{"shape":"VerifyTargetDomainInput"}, "output":{"shape":"VerifyTargetDomainOutput"}, "documentation":"

Verifies ownership for a registered target domain

" } }, "shapes":{ "AWSResources":{ "type":"structure", "members":{ "vpcs":{ "shape":"VpcConfigs", "documentation":"

VPC configurations that the Security Agent accesses in the customer environment

" }, "logGroups":{ "shape":"LogGroupArns", "documentation":"

CloudWatch log group ARNs or names used to store Security Agent logs

" }, "s3Buckets":{ "shape":"S3BucketArns", "documentation":"

S3 bucket ARNs or names used to store Security Agent artifacts

" }, "secretArns":{ "shape":"SecretArns", "documentation":"

SecretsManager secret ARNs or names used to store tester credentials for pentests

" }, "lambdaFunctionArns":{ "shape":"LambdaFunctionArns", "documentation":"

Lambda function ARNs or names used to retrieve tester credentials for pentests

" }, "iamRoles":{ "shape":"IamRoles", "documentation":"

IAM role ARNs that the Security Agent can assume to access customer resources

" } }, "documentation":"

AWS resource configurations associated with the agent space

" }, "AccessDeniedException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"String", "documentation":"

Error description

" } }, "documentation":"

Request denied due to insufficient permissions

", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "AccessType":{ "type":"string", "documentation":"

Defines the visibility level of provider resources. PRIVATE indicates restricted access (e.g: private GitHub repositories), while PUBLIC indicates open access (e.g: public GitHub repositories)

", "enum":[ "PRIVATE", "PUBLIC" ] }, "Actor":{ "type":"structure", "members":{ "identifier":{ "shape":"String", "documentation":"

Unique identifier for the actor (case-insensitive)

" }, "uris":{ "shape":"UriList", "documentation":"

List of URIs accessible with the actor's credentials

" }, "authentication":{ "shape":"Authentication", "documentation":"

Authentication information used by the actor to access resources

" }, "description":{ "shape":"String", "documentation":"

Additional description or details about the actor

" } }, "documentation":"

Represents an entity that interacts with the system during security testing

" }, "ActorList":{ "type":"list", "member":{"shape":"Actor"} }, "AddArtifactInput":{ "type":"structure", "required":[ "agentSpaceId", "artifactContent", "artifactType", "fileName" ], "members":{ "agentSpaceId":{ "shape":"AgentSpaceId", "documentation":"

Unique identifier of the agent space

" }, "artifactContent":{ "shape":"Blob", "documentation":"

Binary content of the artifact

" }, "artifactType":{ "shape":"ArtifactType", "documentation":"

Type of the artifact file

" }, "fileName":{ "shape":"String", "documentation":"

Name of the artifact file

" } } }, "AddArtifactOutput":{ "type":"structure", "required":["artifactId"], "members":{ "artifactId":{ "shape":"ArtifactId", "documentation":"

Unique identifier of the created artifact

" } } }, "AgentName":{ "type":"string", "documentation":"

Name of an agent space

" }, "AgentSpace":{ "type":"structure", "required":[ "agentSpaceId", "name" ], "members":{ "agentSpaceId":{ "shape":"AgentSpaceId", "documentation":"

Unique identifier of the agent space

" }, "name":{ "shape":"String", "documentation":"

Name of the agent space

" }, "description":{ "shape":"String", "documentation":"

Description of the agent space

" }, "awsResources":{ "shape":"AWSResources", "documentation":"

AWS resource configurations

" }, "targetDomainIds":{ "shape":"TargetDomainIdList", "documentation":"

List of target domain IDs registered with the agent space

" }, "codeReviewSettings":{ "shape":"CodeReviewSettings", "documentation":"

Configuration for code review analysis, including controls scanning and general purpose scanning settings

" }, "kmsKeyId":{ "shape":"KmsKeyId", "documentation":"

Identifier of the KMS key used to encrypt data. Can be a key ID, key ARN, alias name, or alias ARN. If not specified, an AWS managed key is used.

" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the agent space was created

" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the agent space was last updated

" } }, "documentation":"

Agent space structure

" }, "AgentSpaceId":{ "type":"string", "documentation":"

Unique identifier of the agent space

" }, "AgentSpaceIdList":{ "type":"list", "member":{"shape":"AgentSpaceId"} }, "AgentSpaceList":{ "type":"list", "member":{"shape":"AgentSpace"} }, "AgentSpaceSummary":{ "type":"structure", "required":[ "agentSpaceId", "name" ], "members":{ "agentSpaceId":{ "shape":"AgentSpaceId", "documentation":"

Unique identifier of the agent space

" }, "name":{ "shape":"String", "documentation":"

Name of the agent space

" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the agent space was created

" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the agent space was last updated

" } }, "documentation":"

Summary information for an agent space

" }, "AgentSpaceSummaryList":{ "type":"list", "member":{"shape":"AgentSpaceSummary"} }, "ApplicationDomain":{ "type":"string", "documentation":"

Domain where the application is available

" }, "ApplicationId":{ "type":"string", "documentation":"

Application identifier

" }, "ApplicationSummary":{ "type":"structure", "required":[ "applicationId", "applicationName", "domain" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

Unique identifier of the application

" }, "applicationName":{ "shape":"String", "documentation":"

Name of the application, automatically assigned by the service

" }, "domain":{ "shape":"ApplicationDomain", "documentation":"

Domain where the application is available

" }, "defaultKmsKeyId":{ "shape":"DefaultKmsKeyId", "documentation":"

Default KMS key identifier used to encrypt application data

" } }, "documentation":"

Application summary for list operations

" }, "ApplicationSummaryList":{ "type":"list", "member":{"shape":"ApplicationSummary"}, "documentation":"

List of application summaries

" }, "Artifact":{ "type":"structure", "required":[ "contents", "type" ], "members":{ "contents":{ "shape":"String", "documentation":"

The content of the artifact

" }, "type":{ "shape":"ArtifactType", "documentation":"

The file type of the artifact

" } }, "documentation":"

Files containing relevant data for review

" }, "ArtifactId":{ "type":"string", "documentation":"

The id of the artifact

" }, "ArtifactIds":{ "type":"list", "member":{"shape":"ArtifactId"} }, "ArtifactMetadataItem":{ "type":"structure", "required":[ "agentSpaceId", "artifactId", "fileName", "updatedAt" ], "members":{ "agentSpaceId":{ "shape":"AgentSpaceId", "documentation":"

Unique identifier of the agent space

" }, "artifactId":{ "shape":"ArtifactId", "documentation":"

Unique identifier of the artifact

" }, "fileName":{ "shape":"String", "documentation":"

Name of the artifact file

" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the artifact was last updated

" } }, "documentation":"

Metadata in relation to the artifact

" }, "ArtifactMetadataList":{ "type":"list", "member":{"shape":"ArtifactMetadataItem"}, "documentation":"

List of metadata objects containing artifacts details

" }, "ArtifactSummary":{ "type":"structure", "required":[ "artifactId", "fileName", "artifactType" ], "members":{ "artifactId":{ "shape":"ArtifactId", "documentation":"

Unique identifier of the artifact

" }, "fileName":{ "shape":"String", "documentation":"

Name of the artifact file

" }, "artifactType":{ "shape":"ArtifactType", "documentation":"

Type of the artifact file

" } }, "documentation":"

Summary information about an artifact

" }, "ArtifactSummaryList":{ "type":"list", "member":{"shape":"ArtifactSummary"}, "documentation":"

List of artifact summaries

" }, "ArtifactType":{ "type":"string", "documentation":"

Supported file extension types for artifacts

", "enum":[ "TXT", "PNG", "JPEG", "MD", "PDF", "DOCX", "DOC", "JSON", "YAML" ] }, "Assets":{ "type":"structure", "members":{ "endpoints":{ "shape":"EndpointList", "documentation":"

List of web application endpoints to test

" }, "actors":{ "shape":"ActorList", "documentation":"

List of actors that interact with the system

" }, "documents":{ "shape":"DocumentList", "documentation":"

List of documents providing context for testing

" }, "sourceCode":{ "shape":"SourceCodeRepositoryList", "documentation":"

List of source code repositories for static analysis

" }, "integratedRepositories":{ "shape":"IntegratedRepositoryList", "documentation":"

List of integrated code repositories

" } }, "documentation":"

Collection of assets to be tested or used during a pentest

" }, "AuthCode":{ "type":"string", "documentation":"

Authorization code from OAuth flow

" }, "Authentication":{ "type":"structure", "members":{ "providerType":{ "shape":"AuthenticationProviderType", "documentation":"

Provider type for the authentication credentials

" }, "value":{ "shape":"String", "documentation":"

Authentication credential value or reference

" } }, "documentation":"

Authentication information used to access protected resources

" }, "AuthenticationProviderType":{ "type":"string", "documentation":"

Type of authentication provider

", "enum":[ "SECRETS_MANAGER", "AWS_LAMBDA", "AWS_IAM_ROLE", "AWS_INTERNAL" ] }, "BatchDeletePentestsInput":{ "type":"structure", "required":[ "pentestIds", "agentSpaceId" ], "members":{ "pentestIds":{ "shape":"PentestIdList", "documentation":"

List of pentest IDs to delete

" }, "agentSpaceId":{ "shape":"String", "documentation":"

ID of the agent space where the pentests exist

" } }, "documentation":"

Input for deleting multiple pentests

" }, "BatchDeletePentestsOutput":{ "type":"structure", "members":{ "deleted":{ "shape":"PentestList", "documentation":"

List of successfully deleted pentests

" }, "failed":{ "shape":"DeletePentestFailureList", "documentation":"

List of pentests that could not be deleted and the reasons for failure

" } }, "documentation":"

Output for the BatchDeletePentests operation

" }, "BatchGetAgentSpacesInput":{ "type":"structure", "required":["agentSpaceIds"], "members":{ "agentSpaceIds":{ "shape":"AgentSpaceIdList", "documentation":"

List of agent space IDs to retrieve

" } }, "documentation":"

Input for batch retrieving agent spaces

" }, "BatchGetAgentSpacesOutput":{ "type":"structure", "members":{ "agentSpaces":{ "shape":"AgentSpaceList", "documentation":"

List of agent spaces that were successfully retrieved

" }, "notFound":{ "shape":"AgentSpaceIdList", "documentation":"

List of agent space IDs that could not be found

" } }, "documentation":"

Output for the BatchGetAgentSpaces operation

" }, "BatchGetArtifactMetadataInput":{ "type":"structure", "required":[ "agentSpaceId", "artifactIds" ], "members":{ "agentSpaceId":{ "shape":"AgentSpaceId", "documentation":"

Unique identifier of the agent space

" }, "artifactIds":{ "shape":"ArtifactIds", "documentation":"

List of artifact identifiers

" } } }, "BatchGetArtifactMetadataOutput":{ "type":"structure", "required":["artifactMetadataList"], "members":{ "artifactMetadataList":{ "shape":"ArtifactMetadataList", "documentation":"

List of artifact metadata

" } } }, "BatchGetFindingsInput":{ "type":"structure", "required":[ "findingIds", "agentSpaceId" ], "members":{ "findingIds":{ "shape":"FindingIdList", "documentation":"

List of finding IDs to retrieve

" }, "agentSpaceId":{ "shape":"String", "documentation":"

ID of the agent space where the findings exist

" } }, "documentation":"

Input for BatchGetFindings operation

" }, "BatchGetFindingsOutput":{ "type":"structure", "members":{ "findings":{ "shape":"FindingList", "documentation":"

List of successfully retrieved findings

" }, "notFound":{ "shape":"FindingIdList", "documentation":"

List of finding IDs that could not be found

" } }, "documentation":"

Output for the BatchGetFindings operation

" }, "BatchGetPentestJobTasksInput":{ "type":"structure", "required":[ "agentSpaceId", "taskIds" ], "members":{ "agentSpaceId":{ "shape":"String", "documentation":"

ID of the agent space where the pentest exists

" }, "taskIds":{ "shape":"TaskIdList", "documentation":"

List of task IDs to retrieve

" } }, "documentation":"

Input for retrieving multiple tasks by their IDs for a pentest job

" }, "BatchGetPentestJobTasksOutput":{ "type":"structure", "members":{ "tasks":{ "shape":"TaskList", "documentation":"

List of successfully retrieved tasks

" }, "notFound":{ "shape":"TaskIdList", "documentation":"

List of task IDs that could not be found

" } }, "documentation":"

Output for the BatchGetPentestJobTasks operation

" }, "BatchGetPentestJobsInput":{ "type":"structure", "required":[ "pentestJobIds", "agentSpaceId" ], "members":{ "pentestJobIds":{ "shape":"PentestJobIdList", "documentation":"

List of pentest job IDs to retrieve

" }, "agentSpaceId":{ "shape":"String", "documentation":"

ID of the agent space where the pentest exists

" } }, "documentation":"

Input for BatchGetPentestJobs operation

" }, "BatchGetPentestJobsOutput":{ "type":"structure", "members":{ "pentestJobs":{ "shape":"PentestJobList", "documentation":"

List of successfully retrieved pentest jobs

" }, "notFound":{ "shape":"PentestJobIdList", "documentation":"

List of pentest job IDs that could not be found

" } }, "documentation":"

Output for the BatchGetPentestJobs operation

" }, "BatchGetPentestsInput":{ "type":"structure", "required":[ "pentestIds", "agentSpaceId" ], "members":{ "pentestIds":{ "shape":"PentestIdList", "documentation":"

List of pentest IDs to retrieve

" }, "agentSpaceId":{ "shape":"String", "documentation":"

ID of the agent space where the pentest exists

" } }, "documentation":"

Input for retrieving multiple pentests by their IDs

" }, "BatchGetPentestsOutput":{ "type":"structure", "members":{ "pentests":{ "shape":"PentestList", "documentation":"

List of successfully retrieved pentests

" }, "notFound":{ "shape":"PentestIdList", "documentation":"

List of pentest IDs that could not be found

" } }, "documentation":"

Output for the BatchGetPentests operation

" }, "BatchGetTargetDomainsInput":{ "type":"structure", "required":["targetDomainIds"], "members":{ "targetDomainIds":{ "shape":"TargetDomainIdList", "documentation":"

List of target domain IDs to retrieve

" } }, "documentation":"

Input for batch retrieving target domains

" }, "BatchGetTargetDomainsOutput":{ "type":"structure", "members":{ "targetDomains":{ "shape":"TargetDomainList", "documentation":"

List of target domains that were successfully retrieved

" }, "notFound":{ "shape":"TargetDomainIdList", "documentation":"

List of target domain IDs that could not be found

" } }, "documentation":"

Output for the BatchGetTargetDomains operation

" }, "Blob":{"type":"blob"}, "Boolean":{ "type":"boolean", "box":true }, "Category":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

Name of the category

" }, "isPrimary":{ "shape":"Boolean", "documentation":"

Whether this is the primary category for the task

" } }, "documentation":"

Represents a category classification for tasks

" }, "CategoryList":{ "type":"list", "member":{"shape":"Category"} }, "CloudWatchLog":{ "type":"structure", "members":{ "logGroup":{ "shape":"String", "documentation":"

Name of the CloudWatch log group

" }, "logStream":{ "shape":"String", "documentation":"

Name of the CloudWatch log stream

" } }, "documentation":"

Reference to logs stored in CloudWatch

" }, "CodeRemediationStrategy":{ "type":"string", "documentation":"

Strategy for automated code remediation

", "enum":[ "AUTOMATIC", "DISABLED" ] }, "CodeRemediationTask":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"CodeRemediationTaskStatus", "documentation":"

Current status of the code remediation task

" }, "statusReason":{ "shape":"String", "documentation":"

Reason for the current code remediation task status

" }, "taskDetails":{ "shape":"CodeRemediationTaskDetailsList", "documentation":"

Details of the code remediation for each repository

" } }, "documentation":"

Information about task for code remediation

" }, "CodeRemediationTaskDetails":{ "type":"structure", "members":{ "repoName":{ "shape":"String", "documentation":"

Name of the repository

" }, "codeDiffLink":{ "shape":"String", "documentation":"

Link to the code diff for the remediation

" }, "pullRequestLink":{ "shape":"String", "documentation":"

Link to the pull request for the remediation

" } }, "documentation":"

Code remediation details for a single repository

" }, "CodeRemediationTaskDetailsList":{ "type":"list", "member":{"shape":"CodeRemediationTaskDetails"} }, "CodeRemediationTaskStatus":{ "type":"string", "documentation":"

Code remediation task status

", "enum":[ "IN_PROGRESS", "COMPLETED", "FAILED" ] }, "CodeReviewSettings":{ "type":"structure", "required":[ "controlsScanning", "generalPurposeScanning" ], "members":{ "controlsScanning":{ "shape":"Boolean", "documentation":"

Whether Controls are utilized for code review analysis

" }, "generalPurposeScanning":{ "shape":"Boolean", "documentation":"

Whether general purpose analysis is performed for code review

" } }, "documentation":"

Details of code review settings

" }, "ConfidenceLevel":{ "type":"string", "documentation":"

Finding confidence level

", "enum":[ "FALSE_POSITIVE", "UNCONFIRMED", "LOW", "MEDIUM", "HIGH" ] }, "ConflictException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"String", "documentation":"

Error description

" } }, "documentation":"

Request conflicts with current resource state

", "error":{ "httpStatusCode":409, "senderFault":true }, "exception":true }, "ContextType":{ "type":"string", "documentation":"

Category of execution context

", "enum":[ "ERROR", "CLIENT_ERROR", "WARNING", "INFO" ] }, "CreateAgentSpaceInput":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"AgentName", "documentation":"

Name of the agent space

" }, "description":{ "shape":"String", "documentation":"

Description of the agent space

" }, "awsResources":{ "shape":"AWSResources", "documentation":"

AWS resource configurations associated with the agent space

" }, "targetDomainIds":{ "shape":"TargetDomainIdList", "documentation":"

Target domain IDs to associate with the agent space

" }, "codeReviewSettings":{ "shape":"CodeReviewSettings", "documentation":"

Configuration for code review analysis, including controls scanning and general purpose scanning settings

" }, "kmsKeyId":{ "shape":"KmsKeyId", "documentation":"

Identifier of the KMS key used to encrypt data. Can be a key ID, key ARN, alias name, or alias ARN. If not specified, an AWS managed key is used.

" }, "tags":{ "shape":"TagMap", "documentation":"

Tags to associate with the agent space

" } }, "documentation":"

Input for creating a new agent space

" }, "CreateAgentSpaceOutput":{ "type":"structure", "required":[ "agentSpaceId", "name" ], "members":{ "agentSpaceId":{ "shape":"AgentSpaceId", "documentation":"

Unique identifier of the created agent space

" }, "name":{ "shape":"AgentName", "documentation":"

Name of the created agent space

" }, "description":{ "shape":"String", "documentation":"

Description of the created agent space

" }, "awsResources":{ "shape":"AWSResources", "documentation":"

AWS resource configurations associated with the agent space

" }, "targetDomainIds":{ "shape":"TargetDomainIdList", "documentation":"

List of target domain IDs registered with the agent space

" }, "codeReviewSettings":{ "shape":"CodeReviewSettings", "documentation":"

Configuration for code review analysis, including controls scanning and general purpose scanning settings

" }, "kmsKeyId":{ "shape":"KmsKeyId", "documentation":"

Identifier of the KMS key used to encrypt data. Can be a key ID, key ARN, alias name, or alias ARN. If not specified, an AWS managed key is used.

" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the agent space was created

" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the agent space was last updated

" } }, "documentation":"

Output for the CreateAgentSpace operation

" }, "CreateApplicationRequest":{ "type":"structure", "members":{ "idcInstanceArn":{ "shape":"IdCInstanceArn", "documentation":"

ARN of the IAM Identity Center instance used for user authentication. Optional for non-IdC applications

" }, "roleArn":{ "shape":"RoleArn", "documentation":"

ARN of the IAM role that the application uses to access AWS resources on your behalf

" }, "defaultKmsKeyId":{ "shape":"DefaultKmsKeyId", "documentation":"

Default KMS key identifier used to encrypt application data

" }, "tags":{ "shape":"TagMap", "documentation":"

Tags to associate with the application

" } } }, "CreateApplicationResponse":{ "type":"structure", "required":["applicationId"], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

Application ID

" } } }, "CreateIntegrationInput":{ "type":"structure", "required":[ "provider", "input", "integrationDisplayName" ], "members":{ "provider":{ "shape":"Provider", "documentation":"

Provider to integrate with

" }, "input":{ "shape":"ProviderInput", "documentation":"

Provider-specific input parameters

" }, "integrationDisplayName":{ "shape":"String", "documentation":"

Display name for the integration

" }, "kmsKeyId":{ "shape":"KmsKeyId", "documentation":"

KMS key ID for encrypting integration details

" }, "tags":{ "shape":"TagMap", "documentation":"

Tags to associate with the integration

" } } }, "CreateIntegrationOutput":{ "type":"structure", "required":["integrationId"], "members":{ "integrationId":{ "shape":"IntegrationId", "documentation":"

Unique identifier of the created integration

" } } }, "CreateMembershipRequest":{ "type":"structure", "required":[ "applicationId", "agentSpaceId", "membershipId", "memberType" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

Application identifier

" }, "agentSpaceId":{ "shape":"AgentSpaceId", "documentation":"

Agent space identifier

" }, "membershipId":{ "shape":"MembershipId", "documentation":"

Member identifier (userId or agentSpaceId)

" }, "memberType":{ "shape":"MembershipType", "documentation":"

Type of member (USER or AGENT_SPACE)

" }, "config":{ "shape":"MembershipConfig", "documentation":"

Membership details (user or agent specific)

" } }, "documentation":"

Request structure for adding a single member to an agent space

" }, "CreateMembershipResponse":{ "type":"structure", "members":{}, "documentation":"

Response structure for adding a single member to an agent space

" }, "CreatePentestInput":{ "type":"structure", "required":[ "title", "agentSpaceId" ], "members":{ "title":{ "shape":"String", "documentation":"

Title of the pentest

" }, "agentSpaceId":{ "shape":"String", "documentation":"

ID of the agent space where the pentest should be created

" }, "assets":{ "shape":"Assets", "documentation":"

Assets to be tested during the pentest

" }, "excludeRiskTypes":{ "shape":"RiskTypeList", "documentation":"

A list of risk types excluded from the pentest execution

" }, "serviceRole":{ "shape":"ServiceRole", "documentation":"

Service role ARN for accessing customer resources

" }, "logConfig":{ "shape":"CloudWatchLog", "documentation":"

CloudWatch log group and stream prefix where pentest execution logs are stored

" }, "vpcConfig":{ "shape":"VpcConfig", "documentation":"

VPC configuration that the Security Agent accesses

" }, "networkTrafficConfig":{ "shape":"NetworkTrafficConfig", "documentation":"

Configuration for network traffic filtering

" }, "codeRemediationStrategy":{ "shape":"CodeRemediationStrategy", "documentation":"

Strategy for code remediation on findings

" } }, "documentation":"

Input for creating a new pentest

" }, "CreatePentestOutput":{ "type":"structure", "members":{ "pentestId":{ "shape":"String", "documentation":"

Unique identifier of the created pentest

" }, "title":{ "shape":"String", "documentation":"

Title of the created pentest

" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the pentest was created

" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the pentest was last updated

" }, "assets":{ "shape":"Assets", "documentation":"

Assets to be tested in the created pentest

" }, "excludeRiskTypes":{ "shape":"RiskTypeList", "documentation":"

A list of risk types excluded from the pentest execution

" }, "serviceRole":{ "shape":"ServiceRole", "documentation":"

Service role ARN for accessing customer resources

" }, "logConfig":{ "shape":"CloudWatchLog", "documentation":"

CloudWatch log group and stream prefix where pentest execution logs are stored

" }, "agentSpaceId":{ "shape":"String", "documentation":"

ID of the agent space where the pentest was created

" } }, "documentation":"

Output for the CreatePentest operation

" }, "CreateTargetDomainInput":{ "type":"structure", "required":[ "targetDomainName", "verificationMethod" ], "members":{ "targetDomainName":{ "shape":"String", "documentation":"

Domain name of the target domain

" }, "verificationMethod":{ "shape":"DomainVerificationMethod", "documentation":"

Verification method for the target domain

" }, "tags":{ "shape":"TagMap", "documentation":"

Tags to associate with the target domain

" } }, "documentation":"

Input for creating a new target domain

" }, "CreateTargetDomainOutput":{ "type":"structure", "required":[ "targetDomainId", "domainName", "verificationStatus" ], "members":{ "targetDomainId":{ "shape":"TargetDomainId", "documentation":"

Unique identifier of the created target domain

" }, "domainName":{ "shape":"String", "documentation":"

Name of the created target domain

" }, "verificationStatus":{ "shape":"TargetDomainStatus", "documentation":"

Current verification status of the registered target domain

" }, "verificationDetails":{ "shape":"VerificationDetails", "documentation":"

Verification details to verify registered target domain

" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the target domain was registered

" }, "verifiedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the target domain was last successfully verified

" } }, "documentation":"

Output for the CreateTargetDomain operation

" }, "CsrfState":{ "type":"string", "documentation":"

CSRF state token for OAuth security

" }, "CustomHeader":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

Name of header to set value for

" }, "value":{ "shape":"String", "documentation":"

Value to set for header

" } }, "documentation":"

Custom headers to be set for network requests

" }, "CustomHeaderList":{ "type":"list", "member":{"shape":"CustomHeader"}, "documentation":"

List of custom headers

" }, "DNSRecordType":{ "type":"string", "documentation":"

Type of DNS record

", "enum":["TXT"] }, "DefaultKmsKeyId":{ "type":"string", "documentation":"

Identifier of a KMS key. Can be a key ID, key ARN, alias name, or alias ARN.

" }, "DeleteAgentSpaceInput":{ "type":"structure", "required":["agentSpaceId"], "members":{ "agentSpaceId":{ "shape":"AgentSpaceId", "documentation":"

Unique identifier of the agent space to delete

" } }, "documentation":"

Input for deleting an agent space

" }, "DeleteAgentSpaceOutput":{ "type":"structure", "members":{ "agentSpaceId":{ "shape":"AgentSpaceId", "documentation":"

Unique identifier of the deleted agent space

" } }, "documentation":"

Output for the DeleteAgentSpace operation

" }, "DeleteApplicationRequest":{ "type":"structure", "required":["applicationId"], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

Application ID

" } } }, "DeleteArtifactInput":{ "type":"structure", "required":[ "agentSpaceId", "artifactId" ], "members":{ "agentSpaceId":{ "shape":"AgentSpaceId", "documentation":"

Unique identifier of the agent space

" }, "artifactId":{ "shape":"ArtifactId", "documentation":"

Unique identifier of the artifact

" } } }, "DeleteArtifactOutput":{ "type":"structure", "members":{} }, "DeleteIntegrationInput":{ "type":"structure", "required":["integrationId"], "members":{ "integrationId":{ "shape":"IntegrationId", "documentation":"

Unique identifier of the integration

" } } }, "DeleteIntegrationOutput":{ "type":"structure", "members":{} }, "DeleteMembershipRequest":{ "type":"structure", "required":[ "applicationId", "agentSpaceId", "membershipId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

Application identifier

" }, "agentSpaceId":{ "shape":"AgentSpaceId", "documentation":"

Agent space identifier

" }, "membershipId":{ "shape":"MembershipId", "documentation":"

Member identifier (userId or agentSpaceId)

" }, "memberType":{ "shape":"MembershipType", "documentation":"

Type of member (USER or AGENT_SPACE)

" } }, "documentation":"

Request structure for removing a single member from an agent space

" }, "DeleteMembershipResponse":{ "type":"structure", "members":{}, "documentation":"

Response structure for removing a single member from an agent space

" }, "DeletePentestFailure":{ "type":"structure", "members":{ "pentestId":{ "shape":"String", "documentation":"

Identifier of the pentest that failed to delete

" }, "reason":{ "shape":"String", "documentation":"

Reason for the deletion failure

" } }, "documentation":"

Information about a failed pentest deletion attempt

" }, "DeletePentestFailureList":{ "type":"list", "member":{"shape":"DeletePentestFailure"} }, "DeleteTargetDomainInput":{ "type":"structure", "required":["targetDomainId"], "members":{ "targetDomainId":{ "shape":"TargetDomainId", "documentation":"

Unique identifier of the target domain to delete

" } }, "documentation":"

Input for deleting a target domain

" }, "DeleteTargetDomainOutput":{ "type":"structure", "members":{ "targetDomainId":{ "shape":"TargetDomainId", "documentation":"

Unique identifier of the deleted target domain

" } }, "documentation":"

Output for the DeleteTargetDomain operation

" }, "DiscoveredEndpoint":{ "type":"structure", "required":[ "uri", "pentestJobId", "taskId", "agentSpaceId" ], "members":{ "uri":{ "shape":"String", "documentation":"

The URI of the discovered endpoint

" }, "pentestJobId":{ "shape":"String", "documentation":"

Identifier of the pentest job that discovered this endpoint

" }, "taskId":{ "shape":"String", "documentation":"

Identifier of the task that discovered this endpoint

" }, "agentSpaceId":{ "shape":"String", "documentation":"

Identifier of the agent space where the endpoint was discovered

" }, "evidence":{ "shape":"String", "documentation":"

Optional evidence or additional information about the endpoint

" }, "operation":{ "shape":"String", "documentation":"

Operation or action associated with the endpoint

" }, "description":{ "shape":"String", "documentation":"

Additional description of the endpoint

" } }, "documentation":"

Represents a discovered endpoint during pentest execution

" }, "DiscoveredEndpointList":{ "type":"list", "member":{"shape":"DiscoveredEndpoint"} }, "DnsVerification":{ "type":"structure", "members":{ "token":{ "shape":"String", "documentation":"

Token used to verify domain ownership

" }, "dnsRecordName":{ "shape":"String", "documentation":"

Record name to be added in DNS for target domain

" }, "dnsRecordType":{ "shape":"DNSRecordType", "documentation":"

Type of record to be added in DNS for target domain

" } }, "documentation":"

Represents dns txt verification details

" }, "DocumentInfo":{ "type":"structure", "members":{ "s3Location":{ "shape":"String", "documentation":"

S3 storage location of the document

" }, "artifactId":{ "shape":"String", "documentation":"

Artifact ID of the document

" } }, "documentation":"

Information about a document relevant to security testing

" }, "DocumentList":{ "type":"list", "member":{"shape":"DocumentInfo"} }, "DomainVerificationMethod":{ "type":"string", "documentation":"

Method used to verify domain ownership

", "enum":[ "DNS_TXT", "HTTP_ROUTE" ] }, "Endpoint":{ "type":"structure", "members":{ "uri":{ "shape":"String", "documentation":"

URI of the endpoint to test

" } }, "documentation":"

Represents a web application endpoint to be tested

" }, "EndpointList":{ "type":"list", "member":{"shape":"Endpoint"} }, "ErrorCode":{ "type":"string", "documentation":"

Error code for pentest job failure

", "enum":[ "CLIENT_ERROR", "INTERNAL_ERROR", "STOPPED_BY_USER" ] }, "ErrorInformation":{ "type":"structure", "members":{ "code":{ "shape":"ErrorCode", "documentation":"

Pentest job failure error code

" }, "message":{ "shape":"String", "documentation":"

Pentest job failure error message

" } }, "documentation":"

Error information regarding the pentest job

" }, "ExecutionContext":{ "type":"structure", "members":{ "contextType":{ "shape":"ContextType", "documentation":"

The category of context

" }, "context":{ "shape":"String", "documentation":"

Context associated with a pentest or task execution

" }, "timestamp":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp associated with a pentest or task execution

" } }, "documentation":"

Additional context about a pentest or task execution

" }, "ExecutionContextList":{ "type":"list", "member":{"shape":"ExecutionContext"} }, "Finding":{ "type":"structure", "required":[ "findingId", "agentSpaceId" ], "members":{ "findingId":{ "shape":"String", "documentation":"

Unique identifier for the finding

" }, "agentSpaceId":{ "shape":"String", "documentation":"

Identifier of the agent space that created this finding

" }, "pentestId":{ "shape":"String", "documentation":"

Identifier of the parent pentest

" }, "pentestJobId":{ "shape":"String", "documentation":"

Identifier of the pentest job

" }, "taskId":{ "shape":"String", "documentation":"

Identifier of the associated task

" }, "name":{ "shape":"String", "documentation":"

Name or title of the finding

" }, "description":{ "shape":"String", "documentation":"

Detailed description of the security vulnerability

" }, "status":{ "shape":"FindingStatus", "documentation":"

Current status of the finding

" }, "riskType":{ "shape":"String", "documentation":"

Type of security risk identified

" }, "riskLevel":{ "shape":"RiskLevel", "documentation":"

Severity level of the identified risk

" }, "riskScore":{ "shape":"String", "documentation":"

Risk score associated with the finding

" }, "reasoning":{ "shape":"String", "documentation":"

Justification for the assigned risk score

" }, "confidence":{ "shape":"ConfidenceLevel", "documentation":"

Confidence level of the finding

" }, "attackScript":{ "shape":"String", "documentation":"

Proof-of-concept code demonstrating the vulnerability

" }, "codeRemediationTask":{ "shape":"CodeRemediationTask", "documentation":"

Code remediation task associated with this finding

" }, "lastUpdatedBy":{ "shape":"String", "documentation":"

Identifier of the task or agent that last updated this finding

" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the finding was created

" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the finding was last updated

" } }, "documentation":"

Represents a security vulnerability or issue discovered during testing

" }, "FindingIdList":{ "type":"list", "member":{"shape":"String"} }, "FindingList":{ "type":"list", "member":{"shape":"Finding"}, "documentation":"

List of findings

" }, "FindingStatus":{ "type":"string", "documentation":"

Finding status

", "enum":[ "ACTIVE", "RESOLVED", "ACCEPTED", "FALSE_POSITIVE" ] }, "FindingSummary":{ "type":"structure", "required":[ "findingId", "agentSpaceId" ], "members":{ "findingId":{ "shape":"String", "documentation":"

Unique identifier for the finding

" }, "agentSpaceId":{ "shape":"String", "documentation":"

Identifier of the agent space that created this finding

" }, "pentestId":{ "shape":"String", "documentation":"

Identifier of the parent pentest

" }, "pentestJobId":{ "shape":"String", "documentation":"

Identifier of the pentest job

" }, "name":{ "shape":"String", "documentation":"

Name or title of the finding

" }, "status":{ "shape":"FindingStatus", "documentation":"

Current status of the finding

" }, "riskType":{ "shape":"String", "documentation":"

Type of security risk identified

" }, "riskLevel":{ "shape":"RiskLevel", "documentation":"

Severity level of the identified risk

" }, "confidence":{ "shape":"ConfidenceLevel", "documentation":"

Confidence level of the finding

" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the finding was created

" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the finding was last updated

" } }, "documentation":"

Summary information for a security finding

" }, "FindingSummaryList":{ "type":"list", "member":{"shape":"FindingSummary"}, "documentation":"

List of finding summaries

" }, "GetApplicationRequest":{ "type":"structure", "required":["applicationId"], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

Application ID

" } } }, "GetApplicationResponse":{ "type":"structure", "required":[ "applicationId", "domain" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

Application ID

" }, "domain":{ "shape":"ApplicationDomain", "documentation":"

Domain where the application is available

" }, "applicationName":{ "shape":"String", "documentation":"

Name of the application, automatically assigned by the service

" }, "idcConfiguration":{ "shape":"IdCConfiguration", "documentation":"

IAM Identity Center configuration for the application

" }, "roleArn":{ "shape":"RoleArn", "documentation":"

ARN of the IAM role that the application uses to access AWS resources on your behalf

" }, "defaultKmsKeyId":{ "shape":"DefaultKmsKeyId", "documentation":"

Default KMS key identifier used to encrypt application data

" } } }, "GetArtifactInput":{ "type":"structure", "required":[ "agentSpaceId", "artifactId" ], "members":{ "agentSpaceId":{ "shape":"AgentSpaceId", "documentation":"

Unique identifier of the agent space

" }, "artifactId":{ "shape":"ArtifactId", "documentation":"

Unique identifier of the artifact

" } } }, "GetArtifactOutput":{ "type":"structure", "required":[ "agentSpaceId", "artifactId", "artifact", "fileName", "updatedAt" ], "members":{ "agentSpaceId":{ "shape":"AgentSpaceId", "documentation":"

Unique identifier of the agent space

" }, "artifactId":{ "shape":"ArtifactId", "documentation":"

Unique identifier of the artifact

" }, "artifact":{ "shape":"Artifact", "documentation":"

Artifact details

" }, "fileName":{ "shape":"String", "documentation":"

Name of the artifact file

" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the artifact was last updated

" } } }, "GetIntegrationInput":{ "type":"structure", "required":["integrationId"], "members":{ "integrationId":{ "shape":"IntegrationId", "documentation":"

Unique identifier of the integration

" } } }, "GetIntegrationOutput":{ "type":"structure", "required":[ "integrationId", "installationId", "provider", "providerType" ], "members":{ "integrationId":{ "shape":"IntegrationId", "documentation":"

Unique identifier of the integration

" }, "installationId":{ "shape":"String", "documentation":"

Installation identifier from the provider

" }, "provider":{ "shape":"Provider", "documentation":"

Provider type

" }, "providerType":{ "shape":"ProviderType", "documentation":"

Type of provider integration

" }, "displayName":{ "shape":"String", "documentation":"

Display name for the integration

" }, "kmsKeyId":{ "shape":"KmsKeyId", "documentation":"

KMS key ID for encrypting integration details

" } } }, "GitHubIntegrationInput":{ "type":"structure", "required":[ "code", "state" ], "members":{ "code":{ "shape":"AuthCode", "documentation":"

Authorization code from OAuth flow

" }, "state":{ "shape":"CsrfState", "documentation":"

CSRF state token for OAuth security

" }, "organizationName":{ "shape":"String", "documentation":"

Name of the GitHub organization

" } }, "documentation":"

Input parameters for GitHub integration

" }, "GitHubOwner":{ "type":"string", "documentation":"

Name of the GitHub Account or Organization

" }, "GitHubRepositoryMetadata":{ "type":"structure", "required":[ "name", "providerResourceId", "owner" ], "members":{ "name":{ "shape":"ProviderResourceName", "documentation":"

Name of the resource e.g. repository name, etc

" }, "providerResourceId":{ "shape":"ProviderResourceId", "documentation":"

Unique resource identifier from the vendor

" }, "owner":{ "shape":"GitHubOwner", "documentation":"

Owner of the repository

" }, "accessType":{ "shape":"AccessType", "documentation":"

Access / Visibility Type of the integrated resource

" } }, "documentation":"

Metadata specific to a GitHub repository integrated resource

" }, "GitHubRepositoryResource":{ "type":"structure", "required":[ "name", "owner" ], "members":{ "name":{ "shape":"ProviderResourceName", "documentation":"

Name of the resource e.g. repository name, etc

" }, "owner":{ "shape":"GitHubOwner", "documentation":"

Owner of the repository

" } }, "documentation":"

GitHub repository resource details

" }, "GitHubResourceCapabilities":{ "type":"structure", "members":{ "leaveComments":{ "shape":"Boolean", "documentation":"

Post code review comments on pull requests

" }, "remediateCode":{ "shape":"Boolean", "documentation":"

Create pull requests with automated fixes

" } }, "documentation":"

Capabilities for GitHub repositories

" }, "HttpVerification":{ "type":"structure", "members":{ "token":{ "shape":"String", "documentation":"

Token used to verify domain ownership

" }, "routePath":{ "shape":"String", "documentation":"

Route path where verification token should be placed

" } }, "documentation":"

Represents http route verification details

" }, "IamRoles":{ "type":"list", "member":{"shape":"ServiceRole"} }, "IdCApplicationArn":{ "type":"string", "documentation":"

ARN of the IAM Identity Center application associated with this application

" }, "IdCConfiguration":{ "type":"structure", "members":{ "idcApplicationArn":{ "shape":"IdCApplicationArn", "documentation":"

ARN of the IAM Identity Center application associated with this application

" }, "idcInstanceArn":{ "shape":"IdCInstanceArn", "documentation":"

ARN of the IAM Identity Center instance used for user authentication

" } }, "documentation":"

IdC configuration containing application and instance ARNs

" }, "IdCInstanceArn":{ "type":"string", "documentation":"

ARN of the IAM Identity Center instance used for user authentication

" }, "InitiateProviderRegistrationInput":{ "type":"structure", "required":["provider"], "members":{ "provider":{ "shape":"Provider", "documentation":"

Provider to register with

" } } }, "InitiateProviderRegistrationOutput":{ "type":"structure", "required":[ "redirectTo", "csrfState" ], "members":{ "redirectTo":{ "shape":"Location", "documentation":"

OAuth redirect URL

" }, "csrfState":{ "shape":"CsrfState", "documentation":"

CSRF state token for OAuth security

" } } }, "IntegratedRepository":{ "type":"structure", "required":[ "integrationId", "providerResourceId" ], "members":{ "integrationId":{ "shape":"String", "documentation":"

Integration identifier

" }, "providerResourceId":{ "shape":"String", "documentation":"

External provider resource identifier, e.g., Github repository identifier

" } }, "documentation":"

Information about an integrated repository

" }, "IntegratedRepositoryList":{ "type":"list", "member":{"shape":"IntegratedRepository"} }, "IntegratedResource":{ "type":"structure", "members":{ "githubRepository":{ "shape":"GitHubRepositoryResource", "documentation":"

GitHub repository resource

" } }, "documentation":"

Integrated resource details from a provider

", "union":true }, "IntegratedResourceInputItem":{ "type":"structure", "required":["resource"], "members":{ "resource":{ "shape":"IntegratedResource", "documentation":"

Configuration of the resource

" }, "capabilities":{ "shape":"ProviderResourceCapabilities", "documentation":"

Provider-specific capabilities for the resource

" } }, "documentation":"

Input item for updating an integrated resource

" }, "IntegratedResourceInputItemList":{ "type":"list", "member":{"shape":"IntegratedResourceInputItem"}, "documentation":"

List of integrated resources

" }, "IntegratedResourceMetadata":{ "type":"structure", "members":{ "githubRepository":{ "shape":"GitHubRepositoryMetadata", "documentation":"

Metadata for a GitHub repository resource

" } }, "documentation":"

Metadata about an integrated resource

", "union":true }, "IntegratedResourceSummary":{ "type":"structure", "required":[ "integrationId", "resource" ], "members":{ "integrationId":{ "shape":"IntegrationId", "documentation":"

Unique identifier of the integration

" }, "resource":{ "shape":"IntegratedResourceMetadata", "documentation":"

The integrated resource details

" }, "capabilities":{ "shape":"ProviderResourceCapabilities", "documentation":"

Capabilities of the integrated resource

" } }, "documentation":"

Summary information about an integrated resource

" }, "IntegratedResourceSummaryList":{ "type":"list", "member":{"shape":"IntegratedResourceSummary"}, "documentation":"

List of integrated resource items

" }, "IntegrationFilter":{ "type":"structure", "members":{ "provider":{ "shape":"Provider", "documentation":"

Filter by provider

" }, "providerType":{ "shape":"ProviderType", "documentation":"

Filter by provider type

" } }, "documentation":"

Filter criteria for integrations

", "union":true }, "IntegrationId":{ "type":"string", "documentation":"

Unique identifier for an integration

" }, "IntegrationSummary":{ "type":"structure", "required":[ "integrationId", "installationId", "provider", "providerType", "displayName" ], "members":{ "integrationId":{ "shape":"String", "documentation":"

Unique identifier of the integration

" }, "installationId":{ "shape":"String", "documentation":"

Installation identifier from the provider

" }, "provider":{ "shape":"Provider", "documentation":"

Provider type

" }, "providerType":{ "shape":"ProviderType", "documentation":"

Type of provider integration

" }, "displayName":{ "shape":"String", "documentation":"

Display name for the integration

" } }, "documentation":"

Summary information about an integration

" }, "IntegrationSummaryList":{ "type":"list", "member":{"shape":"IntegrationSummary"}, "documentation":"

List of integration summaries

" }, "InternalServerException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"String", "documentation":"

Error description

" } }, "documentation":"

Unexpected server error occurred

", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "JobStatus":{ "type":"string", "documentation":"

Status of a pentest job

", "enum":[ "IN_PROGRESS", "STOPPING", "STOPPED", "FAILED", "COMPLETED" ] }, "KmsKeyId":{ "type":"string", "documentation":"

Identifier of a KMS key. Can be a key ID, key ARN, alias name, or alias ARN.

" }, "LambdaFunctionArn":{ "type":"string", "documentation":"

Lambda function ARN or name for agent space AWS resources

" }, "LambdaFunctionArns":{ "type":"list", "member":{"shape":"LambdaFunctionArn"} }, "ListAgentSpacesInput":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

Token for pagination

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Maximum number of agent spaces to return

" } }, "documentation":"

Input for listing agent spaces

" }, "ListAgentSpacesOutput":{ "type":"structure", "members":{ "agentSpaceSummaries":{ "shape":"AgentSpaceSummaryList", "documentation":"

List of agent space summaries

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token for next page of results

" } }, "documentation":"

Output for the ListAgentSpaces operation

" }, "ListApplicationsRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

Token for pagination

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Maximum number of results to return

" } } }, "ListApplicationsResponse":{ "type":"structure", "required":["applicationSummaries"], "members":{ "applicationSummaries":{ "shape":"ApplicationSummaryList", "documentation":"

List of application summaries

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token for next page of results

" } } }, "ListArtifactsInput":{ "type":"structure", "required":["agentSpaceId"], "members":{ "agentSpaceId":{ "shape":"AgentSpaceId", "documentation":"

Unique identifier of the agent space

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token for pagination

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Maximum number of results to return

" } } }, "ListArtifactsOutput":{ "type":"structure", "required":["artifactSummaries"], "members":{ "artifactSummaries":{ "shape":"ArtifactSummaryList", "documentation":"

List of artifact summaries

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token for pagination to retrieve the next set of results

" } } }, "ListDiscoveredEndpointsInput":{ "type":"structure", "required":[ "pentestJobId", "agentSpaceId" ], "members":{ "maxResults":{ "shape":"MaxResults", "documentation":"

Maximum number of discovered endpoints to return in a single request (default: 50)

" }, "pentestJobId":{ "shape":"String", "documentation":"

Identifier of the pentest job for which to retrieve discovered endpoints

" }, "agentSpaceId":{ "shape":"String", "documentation":"

ID of the agent space where the pentest job exists

" }, "prefix":{ "shape":"String", "documentation":"

Optional URI prefix filter to narrow down results

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token for pagination

" } }, "documentation":"

Input for ListDiscoveredEndpoints operation

" }, "ListDiscoveredEndpointsOutput":{ "type":"structure", "members":{ "discoveredEndpoints":{ "shape":"DiscoveredEndpointList", "documentation":"

List of discovered endpoints for the pentest job

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token for pagination to retrieve the next set of results

" } }, "documentation":"

Output for the ListDiscoveredEndpoints operation

" }, "ListFindingsInput":{ "type":"structure", "required":[ "pentestJobId", "agentSpaceId" ], "members":{ "maxResults":{ "shape":"MaxResults", "documentation":"

Maximum number of findings to return in a single request (default: 50)

" }, "pentestJobId":{ "shape":"String", "documentation":"

Identifier of the pentest job for which to retrieve associated findings

" }, "agentSpaceId":{ "shape":"String", "documentation":"

ID of the agent space where the pentest job exists

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token for pagination

" }, "riskType":{ "shape":"String", "documentation":"

Filter findings by risk type

" }, "riskLevel":{ "shape":"RiskLevel", "documentation":"

Filter findings by risk level

" }, "status":{ "shape":"FindingStatus", "documentation":"

Filter findings by status

" }, "confidence":{ "shape":"ConfidenceLevel", "documentation":"

Filter findings by confidence level

" }, "name":{ "shape":"String", "documentation":"

Filter findings by name (case-insensitive substring search)

" } }, "documentation":"

Input for ListFindings operation with filtering support

" }, "ListFindingsOutput":{ "type":"structure", "members":{ "findingsSummaries":{ "shape":"FindingSummaryList", "documentation":"

List of finding summaries matching the filter criteria

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token for pagination to retrieve the next set of results

" } }, "documentation":"

Output for the ListFindings operation

" }, "ListIntegratedResourcesInput":{ "type":"structure", "required":["agentSpaceId"], "members":{ "agentSpaceId":{ "shape":"AgentSpaceId", "documentation":"

Unique identifier of the agent space

" }, "integrationId":{ "shape":"IntegrationId", "documentation":"

Filter integrated resources by a specific integration

" }, "resourceType":{ "shape":"ResourceType", "documentation":"

Filter integrated resources by resource type

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token for pagination

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Maximum number of results to return

" } } }, "ListIntegratedResourcesOutput":{ "type":"structure", "required":["integratedResourceSummaries"], "members":{ "integratedResourceSummaries":{ "shape":"IntegratedResourceSummaryList", "documentation":"

List of integrated resources

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token for pagination to retrieve the next set of results

" } } }, "ListIntegrationsInput":{ "type":"structure", "members":{ "filter":{ "shape":"IntegrationFilter", "documentation":"

Filter criteria for integrations

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token for pagination

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Maximum number of results to return

" } } }, "ListIntegrationsOutput":{ "type":"structure", "required":["integrationSummaries"], "members":{ "integrationSummaries":{ "shape":"IntegrationSummaryList", "documentation":"

List of integration summaries

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token for pagination to retrieve the next set of results

" } } }, "ListMembershipsRequest":{ "type":"structure", "required":[ "applicationId", "agentSpaceId" ], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

Application identifier

" }, "agentSpaceId":{ "shape":"AgentSpaceId", "documentation":"

Agent space identifier

" }, "memberType":{ "shape":"MembershipTypeFilter", "documentation":"

Filter by member type

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Maximum number of results to return

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token for pagination

" } }, "documentation":"

Request structure for listing agent space members

" }, "ListMembershipsResponse":{ "type":"structure", "required":["membershipSummaries"], "members":{ "membershipSummaries":{ "shape":"MembershipSummaryList", "documentation":"

List of membership summaries

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token for next page of results

" } }, "documentation":"

Response structure for listing members associated to an agent space

" }, "ListPentestJobTasksInput":{ "type":"structure", "required":["agentSpaceId"], "members":{ "agentSpaceId":{ "shape":"String", "documentation":"

ID of the agent space where the pentest exists

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Maximum number of tasks to return in a single request

" }, "pentestJobId":{ "shape":"String", "documentation":"

Identifier of the pentest job whose tasks to list

" }, "stepName":{ "shape":"StepName", "documentation":"

Filter tasks by step name

" }, "categoryName":{ "shape":"String", "documentation":"

Filter tasks by category name.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token for pagination to retrieve the next set of results

" } }, "documentation":"

Input for listing tasks associated with a specific pentest job

" }, "ListPentestJobTasksOutput":{ "type":"structure", "members":{ "taskSummaries":{ "shape":"TaskSummaryList", "documentation":"

List of task summaries associated with the specified pentest job

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token for pagination to retrieve the next set of results

" } }, "documentation":"

Output for the ListPentestJobTasks operation

" }, "ListPentestJobsForPentestInput":{ "type":"structure", "required":[ "pentestId", "agentSpaceId" ], "members":{ "maxResults":{ "shape":"MaxResults", "documentation":"

Maximum number of pentest jobs to return in a single request

" }, "pentestId":{ "shape":"String", "documentation":"

Identifier of the pentest for which to retrieve associated jobs

" }, "agentSpaceId":{ "shape":"String", "documentation":"

ID of the agent space where the pentest exists

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token for pagination

" } }, "documentation":"

Input for ListPentestJobsForPentest operation

" }, "ListPentestJobsForPentestOutput":{ "type":"structure", "members":{ "pentestJobSummaries":{ "shape":"PentestJobSummaryList", "documentation":"

List of pentest job summaries associated with the pentest

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token for pagination to retrieve the next set of results

" } }, "documentation":"

Output for the ListPentestJobsForPentest operation

" }, "ListPentestsInput":{ "type":"structure", "required":["agentSpaceId"], "members":{ "maxResults":{ "shape":"MaxResults", "documentation":"

Maximum number of pentests to return in a single request

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token for pagination

" }, "agentSpaceId":{ "shape":"String", "documentation":"

ID of the agent space where the pentest exists

" } }, "documentation":"

Input for listing pentests with optional filtering

" }, "ListPentestsOutput":{ "type":"structure", "members":{ "pentestSummaries":{ "shape":"PentestSummaryList", "documentation":"

List of pentest summaries matching the filter criteria

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token for pagination to retrieve the next set of results

" } }, "documentation":"

Output for the ListPentests operation

" }, "ListTagsForResourceInput":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"ResourceArn", "documentation":"

ARN of the resource to list tags for

", "location":"uri", "locationName":"resourceArn" } }, "documentation":"

Input for ListTagsForResource operation

" }, "ListTagsForResourceOutput":{ "type":"structure", "members":{ "tags":{ "shape":"TagMap", "documentation":"

Tags associated with the resource

" } }, "documentation":"

Output for ListTagsForResource operation

" }, "ListTargetDomainsInput":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

Token for pagination

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

Maximum number of target domains to return

" } }, "documentation":"

Input for listing target domains

" }, "ListTargetDomainsOutput":{ "type":"structure", "members":{ "targetDomainSummaries":{ "shape":"TargetDomainSummaryList", "documentation":"

List of target domain summaries

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token for next page of results

" } }, "documentation":"

Output for the ListTargetDomains operation

" }, "Location":{ "type":"string", "documentation":"

Location URL for OAuth redirect

" }, "LogGroupArn":{ "type":"string", "documentation":"

Log group ARN or name for agent space AWS resources

" }, "LogGroupArns":{ "type":"list", "member":{"shape":"LogGroupArn"} }, "LogLocation":{ "type":"structure", "members":{ "logType":{ "shape":"LogType", "documentation":"

Type of log storage

" }, "cloudWatchLog":{ "shape":"CloudWatchLog", "documentation":"

CloudWatch log information if logs are stored in CloudWatch

" } }, "documentation":"

Location information for execution logs

" }, "LogType":{ "type":"string", "documentation":"

Type of log storage

", "enum":["CLOUDWATCH"] }, "MaxResults":{ "type":"integer", "documentation":"

Maximum results for pagination

", "box":true }, "MemberMetadata":{ "type":"structure", "members":{ "user":{ "shape":"UserMetadata", "documentation":"

User metadata for USER members

" } }, "documentation":"

Metadata associated with the member

", "union":true }, "MembershipConfig":{ "type":"structure", "members":{ "user":{ "shape":"UserConfig", "documentation":"

Configuration for user members

" } }, "documentation":"

Member-specific configuration

", "union":true }, "MembershipId":{ "type":"string", "documentation":"

Member identifier

" }, "MembershipSummary":{ "type":"structure", "required":[ "membershipId", "applicationId", "agentSpaceId", "memberType", "createdAt", "updatedAt", "createdBy", "updatedBy" ], "members":{ "membershipId":{ "shape":"MembershipId", "documentation":"

Member identifier (userId or agentSpaceId)

" }, "applicationId":{ "shape":"ApplicationId", "documentation":"

Application identifier

" }, "agentSpaceId":{ "shape":"AgentSpaceId", "documentation":"

Agent space identifier

" }, "memberType":{ "shape":"MembershipType", "documentation":"

Type of member

" }, "config":{ "shape":"MembershipConfig", "documentation":"

Configuration specific to the member type

" }, "metadata":{ "shape":"MemberMetadata", "documentation":"

Member-specific metadata

" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the membership was created (ISO 8601)

" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the membership was last updated (ISO 8601)

" }, "createdBy":{ "shape":"String", "documentation":"

User ID who created the membership

" }, "updatedBy":{ "shape":"String", "documentation":"

User ID who last updated the membership

" } }, "documentation":"

Membership summary for list operations

" }, "MembershipSummaryList":{ "type":"list", "member":{"shape":"MembershipSummary"}, "documentation":"

List of membership summaries

" }, "MembershipType":{ "type":"string", "documentation":"

Type of membership

", "enum":["USER"] }, "MembershipTypeFilter":{ "type":"string", "documentation":"

Filter for member type in list operations

", "enum":[ "USER", "ALL" ] }, "NetworkTrafficConfig":{ "type":"structure", "members":{ "rules":{ "shape":"NetworkTrafficRuleList", "documentation":"

Traffic filtering rules

" }, "customHeaders":{ "shape":"CustomHeaderList", "documentation":"

Custom headers for requests

" } }, "documentation":"

Configuration for network traffic filtering

" }, "NetworkTrafficRule":{ "type":"structure", "members":{ "effect":{ "shape":"NetworkTrafficRuleEffect", "documentation":"

Action to take when the rule matches

" }, "pattern":{ "shape":"String", "documentation":"

Pattern to match against

" }, "networkTrafficRuleType":{ "shape":"NetworkTrafficRuleType", "documentation":"

Type of network traffic rule

" } }, "documentation":"

Network traffic filtering rule

" }, "NetworkTrafficRuleEffect":{ "type":"string", "documentation":"

Effect of a network traffic rule

", "enum":[ "ALLOW", "DENY" ] }, "NetworkTrafficRuleList":{ "type":"list", "member":{"shape":"NetworkTrafficRule"}, "documentation":"

List of network traffic rules

" }, "NetworkTrafficRuleType":{ "type":"string", "documentation":"

Type of network traffic rule

", "enum":["URL"] }, "NextToken":{ "type":"string", "documentation":"

Pagination token

" }, "Pentest":{ "type":"structure", "required":[ "pentestId", "agentSpaceId", "title", "assets" ], "members":{ "pentestId":{ "shape":"String", "documentation":"

Unique identifier for the pentest

" }, "agentSpaceId":{ "shape":"String", "documentation":"

ID of the agent space where the pentest exists

" }, "title":{ "shape":"String", "documentation":"

Title or name of the pentest

" }, "assets":{ "shape":"Assets", "documentation":"

Collection of assets to be tested or used during the pentest

" }, "excludeRiskTypes":{ "shape":"RiskTypeList", "documentation":"

A list of risk types excluded from the pentest execution

" }, "serviceRole":{ "shape":"ServiceRole", "documentation":"

Service role ARN for accessing customer resources

" }, "logConfig":{ "shape":"CloudWatchLog", "documentation":"

CloudWatch log group and stream prefix where pentest execution logs are stored

" }, "vpcConfig":{ "shape":"VpcConfig", "documentation":"

VPC configuration that the Security Agent accesses

" }, "networkTrafficConfig":{ "shape":"NetworkTrafficConfig", "documentation":"

Configuration for network traffic filtering

" }, "codeRemediationStrategy":{ "shape":"CodeRemediationStrategy", "documentation":"

Strategy for code remediation on findings

" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the pentest was created

" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the pentest was last updated

" } }, "documentation":"

Represents a pentest configuration and execution details

" }, "PentestIdList":{ "type":"list", "member":{"shape":"String"} }, "PentestJob":{ "type":"structure", "members":{ "pentestJobId":{ "shape":"String", "documentation":"

Unique identifier of the pentest job

" }, "pentestId":{ "shape":"String", "documentation":"

Identifier of the parent pentest

" }, "title":{ "shape":"String", "documentation":"

Title or name of the pentest

" }, "overview":{ "shape":"String", "documentation":"

Overview or description of the pentest job

" }, "status":{ "shape":"JobStatus", "documentation":"

Current status of the pentest job

" }, "endpoints":{ "shape":"EndpointList", "documentation":"

List of web application endpoints to test

" }, "actors":{ "shape":"ActorList", "documentation":"

List of actors that interact with the system

" }, "documents":{ "shape":"DocumentList", "documentation":"

List of documents providing context for testing

" }, "sourceCode":{ "shape":"SourceCodeRepositoryList", "documentation":"

List of source code repositories for static analysis

" }, "excludePaths":{ "shape":"EndpointList", "documentation":"

List of URL paths to exclude from testing

" }, "allowedDomains":{ "shape":"EndpointList", "documentation":"

List of allowed domains for network access

" }, "excludeRiskTypes":{ "shape":"RiskTypeList", "documentation":"

A list of risk types excluded from the pentest job

" }, "steps":{ "shape":"StepList", "documentation":"

List of execution steps for the pentest job

" }, "executionContext":{ "shape":"ExecutionContextList", "documentation":"

A list of execution context messages associated with the pentest job

" }, "serviceRole":{ "shape":"ServiceRole", "documentation":"

Service role ARN for accessing customer resources

" }, "logConfig":{ "shape":"CloudWatchLog", "documentation":"

CloudWatch log group and stream prefix where pentest job logs are stored

" }, "vpcConfig":{ "shape":"VpcConfig", "documentation":"

VPC configuration that the Security Agent accesses

" }, "networkTrafficConfig":{ "shape":"NetworkTrafficConfig", "documentation":"

Configuration for network traffic filtering

" }, "errorInformation":{ "shape":"ErrorInformation", "documentation":"

Error information regarding the pentest job

" }, "integratedRepositories":{ "shape":"IntegratedRepositoryList", "documentation":"

List of integrated code repositories

" }, "codeRemediationStrategy":{ "shape":"CodeRemediationStrategy", "documentation":"

Strategy for code remediation on findings

" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the pentest job was created

" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the pentest job was last updated

" } }, "documentation":"

Represents a pentest job

" }, "PentestJobIdList":{ "type":"list", "member":{"shape":"String"} }, "PentestJobList":{ "type":"list", "member":{"shape":"PentestJob"} }, "PentestJobSummary":{ "type":"structure", "required":[ "pentestJobId", "pentestId" ], "members":{ "pentestJobId":{ "shape":"String", "documentation":"

Unique identifier of the pentest job

" }, "pentestId":{ "shape":"String", "documentation":"

Identifier of the parent pentest

" }, "title":{ "shape":"String", "documentation":"

Title or name of the pentest

" }, "status":{ "shape":"JobStatus", "documentation":"

Current status of the pentest job

" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the pentest job was created

" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the pentest job was last updated

" } }, "documentation":"

Summary information for a pentest job

" }, "PentestJobSummaryList":{ "type":"list", "member":{"shape":"PentestJobSummary"} }, "PentestList":{ "type":"list", "member":{"shape":"Pentest"} }, "PentestSummary":{ "type":"structure", "required":[ "pentestId", "agentSpaceId", "title" ], "members":{ "pentestId":{ "shape":"String", "documentation":"

Unique identifier for the pentest

" }, "agentSpaceId":{ "shape":"String", "documentation":"

ID of the agent space where the pentest exists

" }, "title":{ "shape":"String", "documentation":"

Title or name of the pentest

" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the pentest was created

" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the pentest was last updated

" } }, "documentation":"

Summary information for a pentest

" }, "PentestSummaryList":{ "type":"list", "member":{"shape":"PentestSummary"} }, "Provider":{ "type":"string", "documentation":"

Third-party provider type

", "enum":["GITHUB"] }, "ProviderInput":{ "type":"structure", "members":{ "github":{ "shape":"GitHubIntegrationInput", "documentation":"

GitHub integration input

" } }, "documentation":"

Provider-specific input parameters for integration

", "union":true }, "ProviderResourceCapabilities":{ "type":"structure", "members":{ "github":{"shape":"GitHubResourceCapabilities"} }, "documentation":"

Provider-specific capabilities for integrated resources

", "union":true }, "ProviderResourceId":{ "type":"string", "documentation":"

Provider Id of the resource e.g. GitHub repository id, etc

" }, "ProviderResourceName":{ "type":"string", "documentation":"

Name of the resource e.g. repository name, etc

" }, "ProviderType":{ "type":"string", "documentation":"

Type of provider integration

", "enum":[ "SOURCE_CODE", "DOCUMENTATION" ] }, "ResourceArn":{ "type":"string", "documentation":"

ARN of a taggable resource

" }, "ResourceNotFoundException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"String", "documentation":"

Error description

" } }, "documentation":"

Specified resource was not found

", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "ResourceType":{ "type":"string", "documentation":"

Type of resource

", "enum":["CODE_REPOSITORY"] }, "RiskLevel":{ "type":"string", "documentation":"

Risk severity level

", "enum":[ "UNKNOWN", "INFORMATIONAL", "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "RiskType":{ "type":"string", "documentation":"

Type of security risk

", "enum":[ "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" ] }, "RiskTypeList":{ "type":"list", "member":{"shape":"RiskType"} }, "RoleArn":{ "type":"string", "documentation":"

ARN of the IAM role that the application uses to access AWS resources on your behalf

" }, "S3BucketArn":{ "type":"string", "documentation":"

S3 bucket ARN or name for agent space AWS resources

" }, "S3BucketArns":{ "type":"list", "member":{"shape":"S3BucketArn"} }, "SecretArn":{ "type":"string", "documentation":"

Secret ARN or name for agent space AWS resources

" }, "SecretArns":{ "type":"list", "member":{"shape":"SecretArn"} }, "SecurityGroupArn":{ "type":"string", "documentation":"

ARN or ID of a security group

" }, "SecurityGroupArns":{ "type":"list", "member":{"shape":"SecurityGroupArn"}, "documentation":"

A list of one or more security group ARNs or IDs in the customer VPC

" }, "SensitiveEmail":{ "type":"string", "documentation":"

Sensitive email address

" }, "ServiceRole":{ "type":"string", "documentation":"

ARN of an IAM role that the service can assume to access customer resources

" }, "SourceCodeRepository":{ "type":"structure", "members":{ "s3Location":{ "shape":"String", "documentation":"

S3 storage location of the repository

" } }, "documentation":"

Information about a source code repository for static analysis

" }, "SourceCodeRepositoryList":{ "type":"list", "member":{"shape":"SourceCodeRepository"} }, "StartCodeRemediationInput":{ "type":"structure", "required":[ "agentSpaceId", "pentestJobId", "findingIds" ], "members":{ "agentSpaceId":{ "shape":"String", "documentation":"

ID of the agent space where the pentest job exists

" }, "pentestJobId":{ "shape":"String", "documentation":"

Identifier of the pentest job to start code remediation for

" }, "findingIds":{ "shape":"FindingIdList", "documentation":"

Identifiers of the findings to start code remediation for

" } }, "documentation":"

Input for the StartCodeRemediation operation

" }, "StartCodeRemediationOutput":{ "type":"structure", "members":{}, "documentation":"

Output for the StartCodeRemediation operation

" }, "StartPentestJobInput":{ "type":"structure", "required":[ "agentSpaceId", "pentestId" ], "members":{ "agentSpaceId":{ "shape":"String", "documentation":"

ID of the agent space where the pentest exists

" }, "pentestId":{ "shape":"String", "documentation":"

Identifier of the pentest to execute

" } }, "documentation":"

Input for starting the execution of a pentest

" }, "StartPentestJobOutput":{ "type":"structure", "members":{ "title":{ "shape":"String", "documentation":"

Title of the pentest job

" }, "status":{ "shape":"JobStatus", "documentation":"

Current status of the pentest job

" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the pentest job was created

" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the pentest job was last updated

" }, "pentestId":{ "shape":"String", "documentation":"

Unique identifier of the pentest

" }, "pentestJobId":{ "shape":"String", "documentation":"

Unique identifier of the pentest job

" }, "agentSpaceId":{ "shape":"String", "documentation":"

ID of the agent space where the pentest exists

" } }, "documentation":"

Output for the StartPentestJob operation

" }, "Step":{ "type":"structure", "members":{ "name":{ "shape":"StepName", "documentation":"

Name of the execution step

" }, "status":{ "shape":"StepStatus", "documentation":"

Current status of the step

" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the step was created

" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the step was last updated

" } }, "documentation":"

Represents a single step in pentest job execution

" }, "StepList":{ "type":"list", "member":{"shape":"Step"}, "documentation":"

List of pentest job steps

" }, "StepName":{ "type":"string", "documentation":"

Pentest job step names

", "enum":[ "PREFLIGHT", "STATIC_ANALYSIS", "PENTEST", "FINALIZING" ] }, "StepStatus":{ "type":"string", "documentation":"

Pentest job step status

", "enum":[ "NOT_STARTED", "IN_PROGRESS", "COMPLETED", "FAILED", "STOPPED" ] }, "StopPentestJobInput":{ "type":"structure", "required":[ "agentSpaceId", "pentestJobId" ], "members":{ "agentSpaceId":{ "shape":"String", "documentation":"

ID of the agent space where the pentest exists

" }, "pentestJobId":{ "shape":"String", "documentation":"

Identifier of the pentest job to stop

" } }, "documentation":"

Input for stopping the execution of a pentest

" }, "StopPentestJobOutput":{ "type":"structure", "members":{}, "documentation":"

Output for the StopPentestJob operation

" }, "String":{"type":"string"}, "SubnetArn":{ "type":"string", "documentation":"

ARN or ID of a subnet

" }, "SubnetArns":{ "type":"list", "member":{"shape":"SubnetArn"}, "documentation":"

A list of one or more subnet ARNs or IDs in the customer VPC

" }, "SyntheticTimestamp_date_time":{ "type":"timestamp", "timestampFormat":"iso8601" }, "TagKey":{ "type":"string", "documentation":"

Key for a resource tag

" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "documentation":"

List of tag keys

" }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "documentation":"

Map of tags for a resource

" }, "TagResourceInput":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"ResourceArn", "documentation":"

ARN of the resource to tag

", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"TagMap", "documentation":"

Tags to add to the resource

" } }, "documentation":"

Input for TagResource operation

" }, "TagResourceOutput":{ "type":"structure", "members":{}, "documentation":"

Output for TagResource operation

" }, "TagValue":{ "type":"string", "documentation":"

Value for a resource tag

" }, "TargetDomain":{ "type":"structure", "required":[ "targetDomainId", "domainName" ], "members":{ "targetDomainId":{ "shape":"TargetDomainId", "documentation":"

Unique identifier of the target domain

" }, "domainName":{ "shape":"String", "documentation":"

Name of the registered target domain

" }, "verificationStatus":{ "shape":"TargetDomainStatus", "documentation":"

Current verification status of the registered target domain

" }, "verificationDetails":{ "shape":"VerificationDetails", "documentation":"

Verification details to verify registered target domain

" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the target domain was registered

" }, "verifiedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the target domain was last successfully verified

" } }, "documentation":"

Represents a target domain

" }, "TargetDomainId":{ "type":"string", "documentation":"

Unique identifier of the target domain

" }, "TargetDomainIdList":{ "type":"list", "member":{"shape":"String"}, "documentation":"

List of target domain IDs

" }, "TargetDomainList":{ "type":"list", "member":{"shape":"TargetDomain"}, "documentation":"

List of target domains

" }, "TargetDomainStatus":{ "type":"string", "documentation":"

Verification status of a target domain

", "enum":[ "PENDING", "VERIFIED", "FAILED", "UNREACHABLE" ] }, "TargetDomainSummary":{ "type":"structure", "required":[ "targetDomainId", "domainName" ], "members":{ "targetDomainId":{ "shape":"TargetDomainId", "documentation":"

Unique identifier of the target domain

" }, "domainName":{ "shape":"String", "documentation":"

Name of the registered target domain

" }, "verificationStatus":{ "shape":"TargetDomainStatus", "documentation":"

Current verification status of the registered target domain

" } }, "documentation":"

Summary information for a target domain

" }, "TargetDomainSummaryList":{ "type":"list", "member":{"shape":"TargetDomainSummary"} }, "Task":{ "type":"structure", "required":["taskId"], "members":{ "taskId":{ "shape":"String", "documentation":"

Unique identifier for the task

" }, "pentestId":{ "shape":"String", "documentation":"

Identifier of the parent pentest

" }, "pentestJobId":{ "shape":"String", "documentation":"

Identifier of the pentest job this task belongs to

" }, "agentSpaceId":{ "shape":"String", "documentation":"

Identifier of the agent space this task belongs to

" }, "title":{ "shape":"String", "documentation":"

Title or name of the task

" }, "description":{ "shape":"String", "documentation":"

Detailed description of the task's purpose and scope

" }, "categories":{ "shape":"CategoryList", "documentation":"

List of categories associated with this task

" }, "riskType":{ "shape":"RiskType", "documentation":"

Type of security risk this task is designed to test

" }, "targetEndpoint":{ "shape":"Endpoint", "documentation":"

Target endpoint for this security test

" }, "executionStatus":{ "shape":"TaskExecutionStatus", "documentation":"

Current status of the task execution

" }, "logsLocation":{ "shape":"LogLocation", "documentation":"

Location of execution logs for auditing and review

" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the task was created

" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the task was last updated

" } }, "documentation":"

Represents a task within a pentest job

" }, "TaskExecutionStatus":{ "type":"string", "documentation":"

Execution status of a task

", "enum":[ "IN_PROGRESS", "ABORTED", "COMPLETED", "INTERNAL_ERROR", "FAILED" ] }, "TaskIdList":{ "type":"list", "member":{"shape":"String"} }, "TaskList":{ "type":"list", "member":{"shape":"Task"} }, "TaskSummary":{ "type":"structure", "required":["taskId"], "members":{ "taskId":{ "shape":"String", "documentation":"

Unique identifier for the task

" }, "pentestId":{ "shape":"String", "documentation":"

Identifier of the parent pentest

" }, "pentestJobId":{ "shape":"String", "documentation":"

Identifier of the pentest job this task belongs to

" }, "agentSpaceId":{ "shape":"String", "documentation":"

Identifier of the agent space this task belongs to

" }, "title":{ "shape":"String", "documentation":"

Title or name of the task

" }, "riskType":{ "shape":"RiskType", "documentation":"

Type of security risk this task is designed to test

" }, "executionStatus":{ "shape":"TaskExecutionStatus", "documentation":"

Current status of the task execution

" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the task was created

" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the task was last updated

" } }, "documentation":"

Summary information for a task

" }, "TaskSummaryList":{ "type":"list", "member":{"shape":"TaskSummary"} }, "ThrottlingException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"String", "documentation":"

Error description

" }, "serviceCode":{ "shape":"String", "documentation":"

Service code for throttling limit

" }, "quotaCode":{ "shape":"String", "documentation":"

Quota code for throttling limit

" } }, "documentation":"

Request denied due to throttling

", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true }, "UntagResourceInput":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"ResourceArn", "documentation":"

ARN of the resource to untag

", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeyList", "documentation":"

List of tag keys to remove from the resource

", "location":"querystring", "locationName":"tagKeys" } }, "documentation":"

Input for UntagResource operation

" }, "UntagResourceOutput":{ "type":"structure", "members":{}, "documentation":"

Output for UntagResource operation

" }, "UpdateAgentSpaceInput":{ "type":"structure", "required":["agentSpaceId"], "members":{ "agentSpaceId":{ "shape":"AgentSpaceId", "documentation":"

ID of the agent space to update

" }, "name":{ "shape":"AgentName", "documentation":"

Name of the agent space

" }, "description":{ "shape":"String", "documentation":"

Description of the agent space

" }, "awsResources":{ "shape":"AWSResources", "documentation":"

AWS resource configurations associated with the agent space

" }, "targetDomainIds":{ "shape":"TargetDomainIdList", "documentation":"

Target domain IDs to associate with the agent space

" }, "codeReviewSettings":{ "shape":"CodeReviewSettings", "documentation":"

Configuration for code review analysis, including controls scanning and general purpose scanning settings

" } }, "documentation":"

Input for updating an agent space

" }, "UpdateAgentSpaceOutput":{ "type":"structure", "required":[ "agentSpaceId", "name" ], "members":{ "agentSpaceId":{ "shape":"AgentSpaceId", "documentation":"

Unique identifier of the agent space

" }, "name":{ "shape":"AgentName", "documentation":"

Name of the agent space

" }, "description":{ "shape":"String", "documentation":"

Description of the agent space

" }, "awsResources":{ "shape":"AWSResources", "documentation":"

AWS resource configurations associated with the agent space

" }, "targetDomainIds":{ "shape":"TargetDomainIdList", "documentation":"

List of target domain IDs registered with the agent space

" }, "codeReviewSettings":{ "shape":"CodeReviewSettings", "documentation":"

Configuration for code review analysis, including controls scanning and general purpose scanning settings

" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the agent space was created

" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the agent space was last updated

" } }, "documentation":"

Output for the UpdateAgentSpace operation

" }, "UpdateApplicationRequest":{ "type":"structure", "required":["applicationId"], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

Application ID

" }, "roleArn":{ "shape":"RoleArn", "documentation":"

ARN of the IAM role that the application uses to access AWS resources on your behalf

" }, "defaultKmsKeyId":{ "shape":"DefaultKmsKeyId", "documentation":"

Default KMS key identifier. Use an empty string to remove the default KMS key.

" } } }, "UpdateApplicationResponse":{ "type":"structure", "required":["applicationId"], "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

Application ID

" } } }, "UpdateFindingInput":{ "type":"structure", "required":[ "findingId", "agentSpaceId" ], "members":{ "findingId":{ "shape":"String", "documentation":"

Identifier of the finding to update

" }, "agentSpaceId":{ "shape":"String", "documentation":"

ID of the agent space where the finding exists

" }, "riskLevel":{ "shape":"RiskLevel", "documentation":"

Updated severity level of the identified risk

" }, "status":{ "shape":"FindingStatus", "documentation":"

Updated status of the finding

" } }, "documentation":"

Input for updating an existing security finding

" }, "UpdateFindingOutput":{ "type":"structure", "members":{}, "documentation":"

Output for the UpdateFinding operation

" }, "UpdateIntegratedResourcesInput":{ "type":"structure", "required":[ "agentSpaceId", "integrationId", "items" ], "members":{ "agentSpaceId":{ "shape":"AgentSpaceId", "documentation":"

Unique identifier of the agent space

" }, "integrationId":{ "shape":"IntegrationId", "documentation":"

Unique identifier of the integration

" }, "items":{ "shape":"IntegratedResourceInputItemList", "documentation":"

List of integrated resources to update

" } } }, "UpdateIntegratedResourcesOutput":{ "type":"structure", "members":{} }, "UpdatePentestInput":{ "type":"structure", "required":[ "pentestId", "agentSpaceId" ], "members":{ "pentestId":{ "shape":"String", "documentation":"

Identifier of the pentest to update

" }, "agentSpaceId":{ "shape":"String", "documentation":"

ID of the agent space where the pentest exists

" }, "title":{ "shape":"String", "documentation":"

New title for the pentest

" }, "assets":{ "shape":"Assets", "documentation":"

Updated assets to be tested

" }, "excludeRiskTypes":{ "shape":"RiskTypeList", "documentation":"

A list of risk types excluded from the pentest execution

" }, "serviceRole":{ "shape":"ServiceRole", "documentation":"

Updated service role ARN for accessing customer resources

" }, "logConfig":{ "shape":"CloudWatchLog", "documentation":"

CloudWatch log group and stream prefix where pentest execution logs are stored

" }, "vpcConfig":{ "shape":"VpcConfig", "documentation":"

VPC configuration that the Security Agent accesses

" }, "networkTrafficConfig":{ "shape":"NetworkTrafficConfig", "documentation":"

Configuration for network traffic filtering

" }, "codeRemediationStrategy":{ "shape":"CodeRemediationStrategy", "documentation":"

Strategy for code remediation on findings

" } }, "documentation":"

Input for updating an existing pentest

" }, "UpdatePentestOutput":{ "type":"structure", "members":{ "pentestId":{ "shape":"String", "documentation":"

Unique identifier of the updated pentest

" }, "title":{ "shape":"String", "documentation":"

Title of the updated pentest

" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the pentest was created

" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the pentest was last updated

" }, "assets":{ "shape":"Assets", "documentation":"

Assets to be tested in the updated pentest

" }, "excludeRiskTypes":{ "shape":"RiskTypeList", "documentation":"

A list of risk types excluded from the pentest execution

" }, "serviceRole":{ "shape":"ServiceRole", "documentation":"

Service role ARN for accessing customer resources

" }, "logConfig":{ "shape":"CloudWatchLog", "documentation":"

CloudWatch log group and stream prefix where pentest execution logs are stored

" }, "agentSpaceId":{ "shape":"String", "documentation":"

ID of the agent space where the pentest exists

" } }, "documentation":"

Output for the UpdatePentest operation

" }, "UpdateTargetDomainInput":{ "type":"structure", "required":[ "targetDomainId", "verificationMethod" ], "members":{ "targetDomainId":{ "shape":"TargetDomainId", "documentation":"

Unique identifier of the target domain to update

" }, "verificationMethod":{ "shape":"DomainVerificationMethod", "documentation":"

Verification method for the target domain

" } }, "documentation":"

Input for updating a target domain

" }, "UpdateTargetDomainOutput":{ "type":"structure", "required":[ "targetDomainId", "domainName", "verificationStatus" ], "members":{ "targetDomainId":{ "shape":"TargetDomainId", "documentation":"

Unique identifier of the target domain

" }, "domainName":{ "shape":"String", "documentation":"

Name of the target domain

" }, "verificationStatus":{ "shape":"TargetDomainStatus", "documentation":"

Current verification status of the registered target domain

" }, "verificationDetails":{ "shape":"VerificationDetails", "documentation":"

Verification details to verify registered target domain

" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the target domain was registered

" }, "verifiedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the target domain was last successfully verified

" } }, "documentation":"

Output for the UpdateTargetDomain operation

" }, "UriList":{ "type":"list", "member":{"shape":"String"} }, "UserConfig":{ "type":"structure", "members":{ "role":{ "shape":"UserRole", "documentation":"

Role of the user associated to the agent space

" } }, "documentation":"

User membership configuration

" }, "UserMetadata":{ "type":"structure", "required":[ "username", "email" ], "members":{ "username":{ "shape":"String", "documentation":"

User name/display name

" }, "email":{ "shape":"SensitiveEmail", "documentation":"

User email address

" } }, "documentation":"

User-specific metadata

" }, "UserRole":{ "type":"string", "documentation":"

Role of a user member associated to an agent space

", "enum":["MEMBER"] }, "ValidationException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"String", "documentation":"

A summary of the validation failure.

" }, "fieldList":{ "shape":"ValidationExceptionFieldList", "documentation":"

A list of specific failures encountered while validating the input. A member can appear in this list more than once if it failed to satisfy multiple constraints.

" } }, "documentation":"

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.

", "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "path", "message" ], "members":{ "path":{ "shape":"String", "documentation":"

A JSONPointer expression to the structure member whose value failed to satisfy the modeled constraints.

" }, "message":{ "shape":"String", "documentation":"

A detailed description of the validation failure.

" } }, "documentation":"

Describes one specific validation failure for an input member.

" }, "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"} }, "VerificationDetails":{ "type":"structure", "members":{ "method":{ "shape":"DomainVerificationMethod", "documentation":"

Type of domain ownership verification method

" }, "dnsTxt":{ "shape":"DnsVerification", "documentation":"

Represents dns txt verification details

" }, "httpRoute":{ "shape":"HttpVerification", "documentation":"

Represents http route verification details

" } }, "documentation":"

Verification details to verify registered target domain

" }, "VerifyTargetDomainInput":{ "type":"structure", "required":["targetDomainId"], "members":{ "targetDomainId":{ "shape":"TargetDomainId", "documentation":"

Unique identifier of the target domain

" } }, "documentation":"

Input for verifying ownership for a registered target domain in an agent space

" }, "VerifyTargetDomainOutput":{ "type":"structure", "members":{ "targetDomainId":{ "shape":"TargetDomainId", "documentation":"

Unique identifier of the target domain

" }, "domainName":{ "shape":"String", "documentation":"

Name of the registered target domain

" }, "createdAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the target domain was registered

" }, "updatedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the target domain was last updated

" }, "verifiedAt":{ "shape":"SyntheticTimestamp_date_time", "documentation":"

Timestamp when the target domain was last successfully verified

" }, "status":{ "shape":"TargetDomainStatus", "documentation":"

Current verification status of the registered target domain

" } }, "documentation":"

Output for verifying ownership for a registered target domain in an agent space

" }, "VpcArn":{ "type":"string", "documentation":"

ARN or ID of a VPC

" }, "VpcConfig":{ "type":"structure", "members":{ "vpcArn":{ "shape":"VpcArn", "documentation":"

ARN or ID of the customer VPC

" }, "securityGroupArns":{ "shape":"SecurityGroupArns", "documentation":"

List of security group ARNs or IDs in the customer VPC

" }, "subnetArns":{ "shape":"SubnetArns", "documentation":"

List of subnet ARNs or IDs in the customer VPC

" } }, "documentation":"

Customer VPC configuration that the Security Agent accesses

" }, "VpcConfigs":{ "type":"list", "member":{"shape":"VpcConfig"} } }, "documentation":"

AWS Security Agent service documentation.

" }