AWS Security Agent service documentation.
", "operations": { "AddArtifact": "Adds an Artifact for the given agent space
", "BatchDeletePentests": "Deletes multiple pentests in a single request
", "BatchGetAgentSpaces": "Retrieves multiple agent spaces in a single request
", "BatchGetArtifactMetadata": "Retrieve the list of artifact metadata for the given agent space
", "BatchGetFindings": "Retrieves multiple findings in a single request
", "BatchGetPentestJobTasks": "Retrieves multiple tasks for a pentest job in a single request
", "BatchGetPentestJobs": "Retrieves multiple pentest jobs in a single request
", "BatchGetPentests": "Retrieves multiple pentests in a single request
", "BatchGetTargetDomains": "Retrieves multiple target domains in a single request
", "CreateAgentSpace": "Creates an agent space record
", "CreateApplication": "Creates a new application
", "CreateIntegration": "Creates the Integration of the Security Agent App with an external Provider
", "CreateMembership": "Adds a single member to an agent space with specified role
", "CreatePentest": "Creates a new pentest configuration
", "CreateTargetDomain": "Creates a target domain record
", "DeleteAgentSpace": "Deletes an agent space record
", "DeleteApplication": "Deletes an application
", "DeleteArtifact": "Delete an Artifact from the given agent space
", "DeleteIntegration": "Deletes the Integration of the Security Agent App with an external Provider
", "DeleteMembership": "Removes a single member associated to an agent space
", "DeleteTargetDomain": "Deletes a target domain record
", "GetApplication": "Retrieves application details by application ID
", "GetArtifact": "Retrieve an Artifact for the given agent space
", "GetIntegration": "Gets Integration metadata from the provided id
", "InitiateProviderRegistration": "Initiates the registration of Security Agent App for an external Provider
", "ListAgentSpaces": "Lists agent spaces
", "ListApplications": "Lists all applications in the account
", "ListArtifacts": "Lists the artifacts for the associated agent space
", "ListDiscoveredEndpoints": "Lists discovered endpoints associated with a pentest job with optional URI prefix filtering
", "ListFindings": "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": "Lists the integrated resources for an agent space
", "ListIntegrations": "Retrieves the Integrations associated with the user's account
", "ListMemberships": "Lists all members associated to an agent space with pagination support
", "ListPentestJobTasks": "Lists tasks associated with a specific pentest job
", "ListPentestJobsForPentest": "Lists pentest jobs associated with a pentest
", "ListPentests": "Lists pentests with optional filtering by status
", "ListTagsForResource": "Lists tags for a Security Agent resource
", "ListTargetDomains": "Lists target domains
", "StartCodeRemediation": "Starts code remediation for the specified findings
", "StartPentestJob": "Initiates the execution of a pentest
", "StopPentestJob": "Stops the execution of a running pentest
", "TagResource": "Adds tags to a Security Agent resource
", "UntagResource": "Removes tags from a Security Agent resource
", "UpdateAgentSpace": "Updates an agent space record
", "UpdateApplication": "Updates application configuration
", "UpdateFinding": "Updates an existing security finding with new details or status
", "UpdateIntegratedResources": "Updates the integrated resources for an agent space
", "UpdatePentest": "Updates an existing pentest with new configuration or settings
", "UpdateTargetDomain": "Updates a target domain record
", "VerifyTargetDomain": "Verifies ownership for a registered target domain
" }, "shapes": { "AWSResources": { "base": "AWS resource configurations associated with the agent space
", "refs": { "AgentSpace$awsResources": "AWS resource configurations
", "CreateAgentSpaceInput$awsResources": "AWS resource configurations associated with the agent space
", "CreateAgentSpaceOutput$awsResources": "AWS resource configurations associated with the agent space
", "UpdateAgentSpaceInput$awsResources": "AWS resource configurations associated with the agent space
", "UpdateAgentSpaceOutput$awsResources": "AWS resource configurations associated with the agent space
" } }, "AccessDeniedException": { "base": "Request denied due to insufficient permissions
", "refs": {} }, "AccessType": { "base": "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)
", "refs": { "GitHubRepositoryMetadata$accessType": "Access / Visibility Type of the integrated resource
" } }, "Actor": { "base": "Represents an entity that interacts with the system during security testing
", "refs": { "ActorList$member": null } }, "ActorList": { "base": null, "refs": { "Assets$actors": "List of actors that interact with the system
", "PentestJob$actors": "List of actors that interact with the system
" } }, "AddArtifactInput": { "base": null, "refs": {} }, "AddArtifactOutput": { "base": null, "refs": {} }, "AgentName": { "base": "Name of an agent space
", "refs": { "CreateAgentSpaceInput$name": "Name of the agent space
", "CreateAgentSpaceOutput$name": "Name of the created agent space
", "UpdateAgentSpaceInput$name": "Name of the agent space
", "UpdateAgentSpaceOutput$name": "Name of the agent space
" } }, "AgentSpace": { "base": "Agent space structure
", "refs": { "AgentSpaceList$member": null } }, "AgentSpaceId": { "base": "Unique identifier of the agent space
", "refs": { "AddArtifactInput$agentSpaceId": "Unique identifier of the agent space
", "AgentSpace$agentSpaceId": "Unique identifier of the agent space
", "AgentSpaceIdList$member": null, "AgentSpaceSummary$agentSpaceId": "Unique identifier of the agent space
", "ArtifactMetadataItem$agentSpaceId": "Unique identifier of the agent space
", "BatchGetArtifactMetadataInput$agentSpaceId": "Unique identifier of the agent space
", "CreateAgentSpaceOutput$agentSpaceId": "Unique identifier of the created agent space
", "CreateMembershipRequest$agentSpaceId": "Agent space identifier
", "DeleteAgentSpaceInput$agentSpaceId": "Unique identifier of the agent space to delete
", "DeleteAgentSpaceOutput$agentSpaceId": "Unique identifier of the deleted agent space
", "DeleteArtifactInput$agentSpaceId": "Unique identifier of the agent space
", "DeleteMembershipRequest$agentSpaceId": "Agent space identifier
", "GetArtifactInput$agentSpaceId": "Unique identifier of the agent space
", "GetArtifactOutput$agentSpaceId": "Unique identifier of the agent space
", "ListArtifactsInput$agentSpaceId": "Unique identifier of the agent space
", "ListIntegratedResourcesInput$agentSpaceId": "Unique identifier of the agent space
", "ListMembershipsRequest$agentSpaceId": "Agent space identifier
", "MembershipSummary$agentSpaceId": "Agent space identifier
", "UpdateAgentSpaceInput$agentSpaceId": "ID of the agent space to update
", "UpdateAgentSpaceOutput$agentSpaceId": "Unique identifier of the agent space
", "UpdateIntegratedResourcesInput$agentSpaceId": "Unique identifier of the agent space
" } }, "AgentSpaceIdList": { "base": null, "refs": { "BatchGetAgentSpacesInput$agentSpaceIds": "List of agent space IDs to retrieve
", "BatchGetAgentSpacesOutput$notFound": "List of agent space IDs that could not be found
" } }, "AgentSpaceList": { "base": null, "refs": { "BatchGetAgentSpacesOutput$agentSpaces": "List of agent spaces that were successfully retrieved
" } }, "AgentSpaceSummary": { "base": "Summary information for an agent space
", "refs": { "AgentSpaceSummaryList$member": null } }, "AgentSpaceSummaryList": { "base": null, "refs": { "ListAgentSpacesOutput$agentSpaceSummaries": "List of agent space summaries
" } }, "ApplicationDomain": { "base": "Domain where the application is available
", "refs": { "ApplicationSummary$domain": "Domain where the application is available
", "GetApplicationResponse$domain": "Domain where the application is available
" } }, "ApplicationId": { "base": "Application identifier
", "refs": { "ApplicationSummary$applicationId": "Unique identifier of the application
", "CreateApplicationResponse$applicationId": "Application ID
", "CreateMembershipRequest$applicationId": "Application identifier
", "DeleteApplicationRequest$applicationId": "Application ID
", "DeleteMembershipRequest$applicationId": "Application identifier
", "GetApplicationRequest$applicationId": "Application ID
", "GetApplicationResponse$applicationId": "Application ID
", "ListMembershipsRequest$applicationId": "Application identifier
", "MembershipSummary$applicationId": "Application identifier
", "UpdateApplicationRequest$applicationId": "Application ID
", "UpdateApplicationResponse$applicationId": "Application ID
" } }, "ApplicationSummary": { "base": "Application summary for list operations
", "refs": { "ApplicationSummaryList$member": null } }, "ApplicationSummaryList": { "base": "List of application summaries
", "refs": { "ListApplicationsResponse$applicationSummaries": "List of application summaries
" } }, "Artifact": { "base": "Files containing relevant data for review
", "refs": { "GetArtifactOutput$artifact": "Artifact details
" } }, "ArtifactId": { "base": "The id of the artifact
", "refs": { "AddArtifactOutput$artifactId": "Unique identifier of the created artifact
", "ArtifactIds$member": null, "ArtifactMetadataItem$artifactId": "Unique identifier of the artifact
", "ArtifactSummary$artifactId": "Unique identifier of the artifact
", "DeleteArtifactInput$artifactId": "Unique identifier of the artifact
", "GetArtifactInput$artifactId": "Unique identifier of the artifact
", "GetArtifactOutput$artifactId": "Unique identifier of the artifact
" } }, "ArtifactIds": { "base": null, "refs": { "BatchGetArtifactMetadataInput$artifactIds": "List of artifact identifiers
" } }, "ArtifactMetadataItem": { "base": "Metadata in relation to the artifact
", "refs": { "ArtifactMetadataList$member": null } }, "ArtifactMetadataList": { "base": "List of metadata objects containing artifacts details
", "refs": { "BatchGetArtifactMetadataOutput$artifactMetadataList": "List of artifact metadata
" } }, "ArtifactSummary": { "base": "Summary information about an artifact
", "refs": { "ArtifactSummaryList$member": null } }, "ArtifactSummaryList": { "base": "List of artifact summaries
", "refs": { "ListArtifactsOutput$artifactSummaries": "List of artifact summaries
" } }, "ArtifactType": { "base": "Supported file extension types for artifacts
", "refs": { "AddArtifactInput$artifactType": "Type of the artifact file
", "Artifact$type": "The file type of the artifact
", "ArtifactSummary$artifactType": "Type of the artifact file
" } }, "Assets": { "base": "Collection of assets to be tested or used during a pentest
", "refs": { "CreatePentestInput$assets": "Assets to be tested during the pentest
", "CreatePentestOutput$assets": "Assets to be tested in the created pentest
", "Pentest$assets": "Collection of assets to be tested or used during the pentest
", "UpdatePentestInput$assets": "Updated assets to be tested
", "UpdatePentestOutput$assets": "Assets to be tested in the updated pentest
" } }, "AuthCode": { "base": "Authorization code from OAuth flow
", "refs": { "GitHubIntegrationInput$code": "Authorization code from OAuth flow
" } }, "Authentication": { "base": "Authentication information used to access protected resources
", "refs": { "Actor$authentication": "Authentication information used by the actor to access resources
" } }, "AuthenticationProviderType": { "base": "Type of authentication provider
", "refs": { "Authentication$providerType": "Provider type for the authentication credentials
" } }, "BatchDeletePentestsInput": { "base": "Input for deleting multiple pentests
", "refs": {} }, "BatchDeletePentestsOutput": { "base": "Output for the BatchDeletePentests operation
", "refs": {} }, "BatchGetAgentSpacesInput": { "base": "Input for batch retrieving agent spaces
", "refs": {} }, "BatchGetAgentSpacesOutput": { "base": "Output for the BatchGetAgentSpaces operation
", "refs": {} }, "BatchGetArtifactMetadataInput": { "base": null, "refs": {} }, "BatchGetArtifactMetadataOutput": { "base": null, "refs": {} }, "BatchGetFindingsInput": { "base": "Input for BatchGetFindings operation
", "refs": {} }, "BatchGetFindingsOutput": { "base": "Output for the BatchGetFindings operation
", "refs": {} }, "BatchGetPentestJobTasksInput": { "base": "Input for retrieving multiple tasks by their IDs for a pentest job
", "refs": {} }, "BatchGetPentestJobTasksOutput": { "base": "Output for the BatchGetPentestJobTasks operation
", "refs": {} }, "BatchGetPentestJobsInput": { "base": "Input for BatchGetPentestJobs operation
", "refs": {} }, "BatchGetPentestJobsOutput": { "base": "Output for the BatchGetPentestJobs operation
", "refs": {} }, "BatchGetPentestsInput": { "base": "Input for retrieving multiple pentests by their IDs
", "refs": {} }, "BatchGetPentestsOutput": { "base": "Output for the BatchGetPentests operation
", "refs": {} }, "BatchGetTargetDomainsInput": { "base": "Input for batch retrieving target domains
", "refs": {} }, "BatchGetTargetDomainsOutput": { "base": "Output for the BatchGetTargetDomains operation
", "refs": {} }, "Blob": { "base": null, "refs": { "AddArtifactInput$artifactContent": "Binary content of the artifact
" } }, "Boolean": { "base": null, "refs": { "Category$isPrimary": "Whether this is the primary category for the task
", "CodeReviewSettings$controlsScanning": "Whether Controls are utilized for code review analysis
", "CodeReviewSettings$generalPurposeScanning": "Whether general purpose analysis is performed for code review
", "GitHubResourceCapabilities$leaveComments": "Post code review comments on pull requests
", "GitHubResourceCapabilities$remediateCode": "Create pull requests with automated fixes
" } }, "Category": { "base": "Represents a category classification for tasks
", "refs": { "CategoryList$member": null } }, "CategoryList": { "base": null, "refs": { "Task$categories": "List of categories associated with this task
" } }, "CloudWatchLog": { "base": "Reference to logs stored in CloudWatch
", "refs": { "CreatePentestInput$logConfig": "CloudWatch log group and stream prefix where pentest execution logs are stored
", "CreatePentestOutput$logConfig": "CloudWatch log group and stream prefix where pentest execution logs are stored
", "LogLocation$cloudWatchLog": "CloudWatch log information if logs are stored in CloudWatch
", "Pentest$logConfig": "CloudWatch log group and stream prefix where pentest execution logs are stored
", "PentestJob$logConfig": "CloudWatch log group and stream prefix where pentest job logs are stored
", "UpdatePentestInput$logConfig": "CloudWatch log group and stream prefix where pentest execution logs are stored
", "UpdatePentestOutput$logConfig": "CloudWatch log group and stream prefix where pentest execution logs are stored
" } }, "CodeRemediationStrategy": { "base": "Strategy for automated code remediation
", "refs": { "CreatePentestInput$codeRemediationStrategy": "Strategy for code remediation on findings
", "Pentest$codeRemediationStrategy": "Strategy for code remediation on findings
", "PentestJob$codeRemediationStrategy": "Strategy for code remediation on findings
", "UpdatePentestInput$codeRemediationStrategy": "Strategy for code remediation on findings
" } }, "CodeRemediationTask": { "base": "Information about task for code remediation
", "refs": { "Finding$codeRemediationTask": "Code remediation task associated with this finding
" } }, "CodeRemediationTaskDetails": { "base": "Code remediation details for a single repository
", "refs": { "CodeRemediationTaskDetailsList$member": null } }, "CodeRemediationTaskDetailsList": { "base": null, "refs": { "CodeRemediationTask$taskDetails": "Details of the code remediation for each repository
" } }, "CodeRemediationTaskStatus": { "base": "Code remediation task status
", "refs": { "CodeRemediationTask$status": "Current status of the code remediation task
" } }, "CodeReviewSettings": { "base": "Details of code review settings
", "refs": { "AgentSpace$codeReviewSettings": "Configuration for code review analysis, including controls scanning and general purpose scanning settings
", "CreateAgentSpaceInput$codeReviewSettings": "Configuration for code review analysis, including controls scanning and general purpose scanning settings
", "CreateAgentSpaceOutput$codeReviewSettings": "Configuration for code review analysis, including controls scanning and general purpose scanning settings
", "UpdateAgentSpaceInput$codeReviewSettings": "Configuration for code review analysis, including controls scanning and general purpose scanning settings
", "UpdateAgentSpaceOutput$codeReviewSettings": "Configuration for code review analysis, including controls scanning and general purpose scanning settings
" } }, "ConfidenceLevel": { "base": "Finding confidence level
", "refs": { "Finding$confidence": "Confidence level of the finding
", "FindingSummary$confidence": "Confidence level of the finding
", "ListFindingsInput$confidence": "Filter findings by confidence level
" } }, "ConflictException": { "base": "Request conflicts with current resource state
", "refs": {} }, "ContextType": { "base": "Category of execution context
", "refs": { "ExecutionContext$contextType": "The category of context
" } }, "CreateAgentSpaceInput": { "base": "Input for creating a new agent space
", "refs": {} }, "CreateAgentSpaceOutput": { "base": "Output for the CreateAgentSpace operation
", "refs": {} }, "CreateApplicationRequest": { "base": null, "refs": {} }, "CreateApplicationResponse": { "base": null, "refs": {} }, "CreateIntegrationInput": { "base": null, "refs": {} }, "CreateIntegrationOutput": { "base": null, "refs": {} }, "CreateMembershipRequest": { "base": "Request structure for adding a single member to an agent space
", "refs": {} }, "CreateMembershipResponse": { "base": "Response structure for adding a single member to an agent space
", "refs": {} }, "CreatePentestInput": { "base": "Input for creating a new pentest
", "refs": {} }, "CreatePentestOutput": { "base": "Output for the CreatePentest operation
", "refs": {} }, "CreateTargetDomainInput": { "base": "Input for creating a new target domain
", "refs": {} }, "CreateTargetDomainOutput": { "base": "Output for the CreateTargetDomain operation
", "refs": {} }, "CsrfState": { "base": "CSRF state token for OAuth security
", "refs": { "GitHubIntegrationInput$state": "CSRF state token for OAuth security
", "InitiateProviderRegistrationOutput$csrfState": "CSRF state token for OAuth security
" } }, "CustomHeader": { "base": "Custom headers to be set for network requests
", "refs": { "CustomHeaderList$member": null } }, "CustomHeaderList": { "base": "List of custom headers
", "refs": { "NetworkTrafficConfig$customHeaders": "Custom headers for requests
" } }, "DNSRecordType": { "base": "Type of DNS record
", "refs": { "DnsVerification$dnsRecordType": "Type of record to be added in DNS for target domain
" } }, "DefaultKmsKeyId": { "base": "Identifier of a KMS key. Can be a key ID, key ARN, alias name, or alias ARN.
", "refs": { "ApplicationSummary$defaultKmsKeyId": "Default KMS key identifier used to encrypt application data
", "CreateApplicationRequest$defaultKmsKeyId": "Default KMS key identifier used to encrypt application data
", "GetApplicationResponse$defaultKmsKeyId": "Default KMS key identifier used to encrypt application data
", "UpdateApplicationRequest$defaultKmsKeyId": "Default KMS key identifier. Use an empty string to remove the default KMS key.
" } }, "DeleteAgentSpaceInput": { "base": "Input for deleting an agent space
", "refs": {} }, "DeleteAgentSpaceOutput": { "base": "Output for the DeleteAgentSpace operation
", "refs": {} }, "DeleteApplicationRequest": { "base": null, "refs": {} }, "DeleteArtifactInput": { "base": null, "refs": {} }, "DeleteArtifactOutput": { "base": null, "refs": {} }, "DeleteIntegrationInput": { "base": null, "refs": {} }, "DeleteIntegrationOutput": { "base": null, "refs": {} }, "DeleteMembershipRequest": { "base": "Request structure for removing a single member from an agent space
", "refs": {} }, "DeleteMembershipResponse": { "base": "Response structure for removing a single member from an agent space
", "refs": {} }, "DeletePentestFailure": { "base": "Information about a failed pentest deletion attempt
", "refs": { "DeletePentestFailureList$member": null } }, "DeletePentestFailureList": { "base": null, "refs": { "BatchDeletePentestsOutput$failed": "List of pentests that could not be deleted and the reasons for failure
" } }, "DeleteTargetDomainInput": { "base": "Input for deleting a target domain
", "refs": {} }, "DeleteTargetDomainOutput": { "base": "Output for the DeleteTargetDomain operation
", "refs": {} }, "DiscoveredEndpoint": { "base": "Represents a discovered endpoint during pentest execution
", "refs": { "DiscoveredEndpointList$member": null } }, "DiscoveredEndpointList": { "base": null, "refs": { "ListDiscoveredEndpointsOutput$discoveredEndpoints": "List of discovered endpoints for the pentest job
" } }, "DnsVerification": { "base": "Represents dns txt verification details
", "refs": { "VerificationDetails$dnsTxt": "Represents dns txt verification details
" } }, "DocumentInfo": { "base": "Information about a document relevant to security testing
", "refs": { "DocumentList$member": null } }, "DocumentList": { "base": null, "refs": { "Assets$documents": "List of documents providing context for testing
", "PentestJob$documents": "List of documents providing context for testing
" } }, "DomainVerificationMethod": { "base": "Method used to verify domain ownership
", "refs": { "CreateTargetDomainInput$verificationMethod": "Verification method for the target domain
", "UpdateTargetDomainInput$verificationMethod": "Verification method for the target domain
", "VerificationDetails$method": "Type of domain ownership verification method
" } }, "Endpoint": { "base": "Represents a web application endpoint to be tested
", "refs": { "EndpointList$member": null, "Task$targetEndpoint": "Target endpoint for this security test
" } }, "EndpointList": { "base": null, "refs": { "Assets$endpoints": "List of web application endpoints to test
", "PentestJob$endpoints": "List of web application endpoints to test
", "PentestJob$excludePaths": "List of URL paths to exclude from testing
", "PentestJob$allowedDomains": "List of allowed domains for network access
" } }, "ErrorCode": { "base": "Error code for pentest job failure
", "refs": { "ErrorInformation$code": "Pentest job failure error code
" } }, "ErrorInformation": { "base": "Error information regarding the pentest job
", "refs": { "PentestJob$errorInformation": "Error information regarding the pentest job
" } }, "ExecutionContext": { "base": "Additional context about a pentest or task execution
", "refs": { "ExecutionContextList$member": null } }, "ExecutionContextList": { "base": null, "refs": { "PentestJob$executionContext": "A list of execution context messages associated with the pentest job
" } }, "Finding": { "base": "Represents a security vulnerability or issue discovered during testing
", "refs": { "FindingList$member": null } }, "FindingIdList": { "base": null, "refs": { "BatchGetFindingsInput$findingIds": "List of finding IDs to retrieve
", "BatchGetFindingsOutput$notFound": "List of finding IDs that could not be found
", "StartCodeRemediationInput$findingIds": "Identifiers of the findings to start code remediation for
" } }, "FindingList": { "base": "List of findings
", "refs": { "BatchGetFindingsOutput$findings": "List of successfully retrieved findings
" } }, "FindingStatus": { "base": "Finding status
", "refs": { "Finding$status": "Current status of the finding
", "FindingSummary$status": "Current status of the finding
", "ListFindingsInput$status": "Filter findings by status
", "UpdateFindingInput$status": "Updated status of the finding
" } }, "FindingSummary": { "base": "Summary information for a security finding
", "refs": { "FindingSummaryList$member": null } }, "FindingSummaryList": { "base": "List of finding summaries
", "refs": { "ListFindingsOutput$findingsSummaries": "List of finding summaries matching the filter criteria
" } }, "GetApplicationRequest": { "base": null, "refs": {} }, "GetApplicationResponse": { "base": null, "refs": {} }, "GetArtifactInput": { "base": null, "refs": {} }, "GetArtifactOutput": { "base": null, "refs": {} }, "GetIntegrationInput": { "base": null, "refs": {} }, "GetIntegrationOutput": { "base": null, "refs": {} }, "GitHubIntegrationInput": { "base": "Input parameters for GitHub integration
", "refs": { "ProviderInput$github": "GitHub integration input
" } }, "GitHubOwner": { "base": "Name of the GitHub Account or Organization
", "refs": { "GitHubRepositoryMetadata$owner": "Owner of the repository
", "GitHubRepositoryResource$owner": "Owner of the repository
" } }, "GitHubRepositoryMetadata": { "base": "Metadata specific to a GitHub repository integrated resource
", "refs": { "IntegratedResourceMetadata$githubRepository": "Metadata for a GitHub repository resource
" } }, "GitHubRepositoryResource": { "base": "GitHub repository resource details
", "refs": { "IntegratedResource$githubRepository": "GitHub repository resource
" } }, "GitHubResourceCapabilities": { "base": "Capabilities for GitHub repositories
", "refs": { "ProviderResourceCapabilities$github": null } }, "HttpVerification": { "base": "Represents http route verification details
", "refs": { "VerificationDetails$httpRoute": "Represents http route verification details
" } }, "IamRoles": { "base": null, "refs": { "AWSResources$iamRoles": "IAM role ARNs that the Security Agent can assume to access customer resources
" } }, "IdCApplicationArn": { "base": "ARN of the IAM Identity Center application associated with this application
", "refs": { "IdCConfiguration$idcApplicationArn": "ARN of the IAM Identity Center application associated with this application
" } }, "IdCConfiguration": { "base": "IdC configuration containing application and instance ARNs
", "refs": { "GetApplicationResponse$idcConfiguration": "IAM Identity Center configuration for the application
" } }, "IdCInstanceArn": { "base": "ARN of the IAM Identity Center instance used for user authentication
", "refs": { "CreateApplicationRequest$idcInstanceArn": "ARN of the IAM Identity Center instance used for user authentication. Optional for non-IdC applications
", "IdCConfiguration$idcInstanceArn": "ARN of the IAM Identity Center instance used for user authentication
" } }, "InitiateProviderRegistrationInput": { "base": null, "refs": {} }, "InitiateProviderRegistrationOutput": { "base": null, "refs": {} }, "IntegratedRepository": { "base": "Information about an integrated repository
", "refs": { "IntegratedRepositoryList$member": null } }, "IntegratedRepositoryList": { "base": null, "refs": { "Assets$integratedRepositories": "List of integrated code repositories
", "PentestJob$integratedRepositories": "List of integrated code repositories
" } }, "IntegratedResource": { "base": "Integrated resource details from a provider
", "refs": { "IntegratedResourceInputItem$resource": "Configuration of the resource
" } }, "IntegratedResourceInputItem": { "base": "Input item for updating an integrated resource
", "refs": { "IntegratedResourceInputItemList$member": null } }, "IntegratedResourceInputItemList": { "base": "List of integrated resources
", "refs": { "UpdateIntegratedResourcesInput$items": "List of integrated resources to update
" } }, "IntegratedResourceMetadata": { "base": "Metadata about an integrated resource
", "refs": { "IntegratedResourceSummary$resource": "The integrated resource details
" } }, "IntegratedResourceSummary": { "base": "Summary information about an integrated resource
", "refs": { "IntegratedResourceSummaryList$member": null } }, "IntegratedResourceSummaryList": { "base": "List of integrated resource items
", "refs": { "ListIntegratedResourcesOutput$integratedResourceSummaries": "List of integrated resources
" } }, "IntegrationFilter": { "base": "Filter criteria for integrations
", "refs": { "ListIntegrationsInput$filter": "Filter criteria for integrations
" } }, "IntegrationId": { "base": "Unique identifier for an integration
", "refs": { "CreateIntegrationOutput$integrationId": "Unique identifier of the created integration
", "DeleteIntegrationInput$integrationId": "Unique identifier of the integration
", "GetIntegrationInput$integrationId": "Unique identifier of the integration
", "GetIntegrationOutput$integrationId": "Unique identifier of the integration
", "IntegratedResourceSummary$integrationId": "Unique identifier of the integration
", "ListIntegratedResourcesInput$integrationId": "Filter integrated resources by a specific integration
", "UpdateIntegratedResourcesInput$integrationId": "Unique identifier of the integration
" } }, "IntegrationSummary": { "base": "Summary information about an integration
", "refs": { "IntegrationSummaryList$member": null } }, "IntegrationSummaryList": { "base": "List of integration summaries
", "refs": { "ListIntegrationsOutput$integrationSummaries": "List of integration summaries
" } }, "InternalServerException": { "base": "Unexpected server error occurred
", "refs": {} }, "JobStatus": { "base": "Status of a pentest job
", "refs": { "PentestJob$status": "Current status of the pentest job
", "PentestJobSummary$status": "Current status of the pentest job
", "StartPentestJobOutput$status": "Current status of the pentest job
" } }, "KmsKeyId": { "base": "Identifier of a KMS key. Can be a key ID, key ARN, alias name, or alias ARN.
", "refs": { "AgentSpace$kmsKeyId": "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.
", "CreateAgentSpaceInput$kmsKeyId": "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.
", "CreateAgentSpaceOutput$kmsKeyId": "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.
", "CreateIntegrationInput$kmsKeyId": "KMS key ID for encrypting integration details
", "GetIntegrationOutput$kmsKeyId": "KMS key ID for encrypting integration details
" } }, "LambdaFunctionArn": { "base": "Lambda function ARN or name for agent space AWS resources
", "refs": { "LambdaFunctionArns$member": null } }, "LambdaFunctionArns": { "base": null, "refs": { "AWSResources$lambdaFunctionArns": "Lambda function ARNs or names used to retrieve tester credentials for pentests
" } }, "ListAgentSpacesInput": { "base": "Input for listing agent spaces
", "refs": {} }, "ListAgentSpacesOutput": { "base": "Output for the ListAgentSpaces operation
", "refs": {} }, "ListApplicationsRequest": { "base": null, "refs": {} }, "ListApplicationsResponse": { "base": null, "refs": {} }, "ListArtifactsInput": { "base": null, "refs": {} }, "ListArtifactsOutput": { "base": null, "refs": {} }, "ListDiscoveredEndpointsInput": { "base": "Input for ListDiscoveredEndpoints operation
", "refs": {} }, "ListDiscoveredEndpointsOutput": { "base": "Output for the ListDiscoveredEndpoints operation
", "refs": {} }, "ListFindingsInput": { "base": "Input for ListFindings operation with filtering support
", "refs": {} }, "ListFindingsOutput": { "base": "Output for the ListFindings operation
", "refs": {} }, "ListIntegratedResourcesInput": { "base": null, "refs": {} }, "ListIntegratedResourcesOutput": { "base": null, "refs": {} }, "ListIntegrationsInput": { "base": null, "refs": {} }, "ListIntegrationsOutput": { "base": null, "refs": {} }, "ListMembershipsRequest": { "base": "Request structure for listing agent space members
", "refs": {} }, "ListMembershipsResponse": { "base": "Response structure for listing members associated to an agent space
", "refs": {} }, "ListPentestJobTasksInput": { "base": "Input for listing tasks associated with a specific pentest job
", "refs": {} }, "ListPentestJobTasksOutput": { "base": "Output for the ListPentestJobTasks operation
", "refs": {} }, "ListPentestJobsForPentestInput": { "base": "Input for ListPentestJobsForPentest operation
", "refs": {} }, "ListPentestJobsForPentestOutput": { "base": "Output for the ListPentestJobsForPentest operation
", "refs": {} }, "ListPentestsInput": { "base": "Input for listing pentests with optional filtering
", "refs": {} }, "ListPentestsOutput": { "base": "Output for the ListPentests operation
", "refs": {} }, "ListTagsForResourceInput": { "base": "Input for ListTagsForResource operation
", "refs": {} }, "ListTagsForResourceOutput": { "base": "Output for ListTagsForResource operation
", "refs": {} }, "ListTargetDomainsInput": { "base": "Input for listing target domains
", "refs": {} }, "ListTargetDomainsOutput": { "base": "Output for the ListTargetDomains operation
", "refs": {} }, "Location": { "base": "Location URL for OAuth redirect
", "refs": { "InitiateProviderRegistrationOutput$redirectTo": "OAuth redirect URL
" } }, "LogGroupArn": { "base": "Log group ARN or name for agent space AWS resources
", "refs": { "LogGroupArns$member": null } }, "LogGroupArns": { "base": null, "refs": { "AWSResources$logGroups": "CloudWatch log group ARNs or names used to store Security Agent logs
" } }, "LogLocation": { "base": "Location information for execution logs
", "refs": { "Task$logsLocation": "Location of execution logs for auditing and review
" } }, "LogType": { "base": "Type of log storage
", "refs": { "LogLocation$logType": "Type of log storage
" } }, "MaxResults": { "base": "Maximum results for pagination
", "refs": { "ListAgentSpacesInput$maxResults": "Maximum number of agent spaces to return
", "ListApplicationsRequest$maxResults": "Maximum number of results to return
", "ListArtifactsInput$maxResults": "Maximum number of results to return
", "ListDiscoveredEndpointsInput$maxResults": "Maximum number of discovered endpoints to return in a single request (default: 50)
", "ListFindingsInput$maxResults": "Maximum number of findings to return in a single request (default: 50)
", "ListIntegratedResourcesInput$maxResults": "Maximum number of results to return
", "ListIntegrationsInput$maxResults": "Maximum number of results to return
", "ListMembershipsRequest$maxResults": "Maximum number of results to return
", "ListPentestJobTasksInput$maxResults": "Maximum number of tasks to return in a single request
", "ListPentestJobsForPentestInput$maxResults": "Maximum number of pentest jobs to return in a single request
", "ListPentestsInput$maxResults": "Maximum number of pentests to return in a single request
", "ListTargetDomainsInput$maxResults": "Maximum number of target domains to return
" } }, "MemberMetadata": { "base": "Metadata associated with the member
", "refs": { "MembershipSummary$metadata": "Member-specific metadata
" } }, "MembershipConfig": { "base": "Member-specific configuration
", "refs": { "CreateMembershipRequest$config": "Membership details (user or agent specific)
", "MembershipSummary$config": "Configuration specific to the member type
" } }, "MembershipId": { "base": "Member identifier
", "refs": { "CreateMembershipRequest$membershipId": "Member identifier (userId or agentSpaceId)
", "DeleteMembershipRequest$membershipId": "Member identifier (userId or agentSpaceId)
", "MembershipSummary$membershipId": "Member identifier (userId or agentSpaceId)
" } }, "MembershipSummary": { "base": "Membership summary for list operations
", "refs": { "MembershipSummaryList$member": null } }, "MembershipSummaryList": { "base": "List of membership summaries
", "refs": { "ListMembershipsResponse$membershipSummaries": "List of membership summaries
" } }, "MembershipType": { "base": "Type of membership
", "refs": { "CreateMembershipRequest$memberType": "Type of member (USER or AGENT_SPACE)
", "DeleteMembershipRequest$memberType": "Type of member (USER or AGENT_SPACE)
", "MembershipSummary$memberType": "Type of member
" } }, "MembershipTypeFilter": { "base": "Filter for member type in list operations
", "refs": { "ListMembershipsRequest$memberType": "Filter by member type
" } }, "NetworkTrafficConfig": { "base": "Configuration for network traffic filtering
", "refs": { "CreatePentestInput$networkTrafficConfig": "Configuration for network traffic filtering
", "Pentest$networkTrafficConfig": "Configuration for network traffic filtering
", "PentestJob$networkTrafficConfig": "Configuration for network traffic filtering
", "UpdatePentestInput$networkTrafficConfig": "Configuration for network traffic filtering
" } }, "NetworkTrafficRule": { "base": "Network traffic filtering rule
", "refs": { "NetworkTrafficRuleList$member": null } }, "NetworkTrafficRuleEffect": { "base": "Effect of a network traffic rule
", "refs": { "NetworkTrafficRule$effect": "Action to take when the rule matches
" } }, "NetworkTrafficRuleList": { "base": "List of network traffic rules
", "refs": { "NetworkTrafficConfig$rules": "Traffic filtering rules
" } }, "NetworkTrafficRuleType": { "base": "Type of network traffic rule
", "refs": { "NetworkTrafficRule$networkTrafficRuleType": "Type of network traffic rule
" } }, "NextToken": { "base": "Pagination token
", "refs": { "ListAgentSpacesInput$nextToken": "Token for pagination
", "ListAgentSpacesOutput$nextToken": "Token for next page of results
", "ListApplicationsRequest$nextToken": "Token for pagination
", "ListApplicationsResponse$nextToken": "Token for next page of results
", "ListArtifactsInput$nextToken": "Token for pagination
", "ListArtifactsOutput$nextToken": "Token for pagination to retrieve the next set of results
", "ListDiscoveredEndpointsInput$nextToken": "Token for pagination
", "ListDiscoveredEndpointsOutput$nextToken": "Token for pagination to retrieve the next set of results
", "ListFindingsInput$nextToken": "Token for pagination
", "ListFindingsOutput$nextToken": "Token for pagination to retrieve the next set of results
", "ListIntegratedResourcesInput$nextToken": "Token for pagination
", "ListIntegratedResourcesOutput$nextToken": "Token for pagination to retrieve the next set of results
", "ListIntegrationsInput$nextToken": "Token for pagination
", "ListIntegrationsOutput$nextToken": "Token for pagination to retrieve the next set of results
", "ListMembershipsRequest$nextToken": "Token for pagination
", "ListMembershipsResponse$nextToken": "Token for next page of results
", "ListPentestJobTasksInput$nextToken": "Token for pagination to retrieve the next set of results
", "ListPentestJobTasksOutput$nextToken": "Token for pagination to retrieve the next set of results
", "ListPentestJobsForPentestInput$nextToken": "Token for pagination
", "ListPentestJobsForPentestOutput$nextToken": "Token for pagination to retrieve the next set of results
", "ListPentestsInput$nextToken": "Token for pagination
", "ListPentestsOutput$nextToken": "Token for pagination to retrieve the next set of results
", "ListTargetDomainsInput$nextToken": "Token for pagination
", "ListTargetDomainsOutput$nextToken": "Token for next page of results
" } }, "Pentest": { "base": "Represents a pentest configuration and execution details
", "refs": { "PentestList$member": null } }, "PentestIdList": { "base": null, "refs": { "BatchDeletePentestsInput$pentestIds": "List of pentest IDs to delete
", "BatchGetPentestsInput$pentestIds": "List of pentest IDs to retrieve
", "BatchGetPentestsOutput$notFound": "List of pentest IDs that could not be found
" } }, "PentestJob": { "base": "Represents a pentest job
", "refs": { "PentestJobList$member": null } }, "PentestJobIdList": { "base": null, "refs": { "BatchGetPentestJobsInput$pentestJobIds": "List of pentest job IDs to retrieve
", "BatchGetPentestJobsOutput$notFound": "List of pentest job IDs that could not be found
" } }, "PentestJobList": { "base": null, "refs": { "BatchGetPentestJobsOutput$pentestJobs": "List of successfully retrieved pentest jobs
" } }, "PentestJobSummary": { "base": "Summary information for a pentest job
", "refs": { "PentestJobSummaryList$member": null } }, "PentestJobSummaryList": { "base": null, "refs": { "ListPentestJobsForPentestOutput$pentestJobSummaries": "List of pentest job summaries associated with the pentest
" } }, "PentestList": { "base": null, "refs": { "BatchDeletePentestsOutput$deleted": "List of successfully deleted pentests
", "BatchGetPentestsOutput$pentests": "List of successfully retrieved pentests
" } }, "PentestSummary": { "base": "Summary information for a pentest
", "refs": { "PentestSummaryList$member": null } }, "PentestSummaryList": { "base": null, "refs": { "ListPentestsOutput$pentestSummaries": "List of pentest summaries matching the filter criteria
" } }, "Provider": { "base": "Third-party provider type
", "refs": { "CreateIntegrationInput$provider": "Provider to integrate with
", "GetIntegrationOutput$provider": "Provider type
", "InitiateProviderRegistrationInput$provider": "Provider to register with
", "IntegrationFilter$provider": "Filter by provider
", "IntegrationSummary$provider": "Provider type
" } }, "ProviderInput": { "base": "Provider-specific input parameters for integration
", "refs": { "CreateIntegrationInput$input": "Provider-specific input parameters
" } }, "ProviderResourceCapabilities": { "base": "Provider-specific capabilities for integrated resources
", "refs": { "IntegratedResourceInputItem$capabilities": "Provider-specific capabilities for the resource
", "IntegratedResourceSummary$capabilities": "Capabilities of the integrated resource
" } }, "ProviderResourceId": { "base": "Provider Id of the resource e.g. GitHub repository id, etc
", "refs": { "GitHubRepositoryMetadata$providerResourceId": "Unique resource identifier from the vendor
" } }, "ProviderResourceName": { "base": "Name of the resource e.g. repository name, etc
", "refs": { "GitHubRepositoryMetadata$name": "Name of the resource e.g. repository name, etc
", "GitHubRepositoryResource$name": "Name of the resource e.g. repository name, etc
" } }, "ProviderType": { "base": "Type of provider integration
", "refs": { "GetIntegrationOutput$providerType": "Type of provider integration
", "IntegrationFilter$providerType": "Filter by provider type
", "IntegrationSummary$providerType": "Type of provider integration
" } }, "ResourceArn": { "base": "ARN of a taggable resource
", "refs": { "ListTagsForResourceInput$resourceArn": "ARN of the resource to list tags for
", "TagResourceInput$resourceArn": "ARN of the resource to tag
", "UntagResourceInput$resourceArn": "ARN of the resource to untag
" } }, "ResourceNotFoundException": { "base": "Specified resource was not found
", "refs": {} }, "ResourceType": { "base": "Type of resource
", "refs": { "ListIntegratedResourcesInput$resourceType": "Filter integrated resources by resource type
" } }, "RiskLevel": { "base": "Risk severity level
", "refs": { "Finding$riskLevel": "Severity level of the identified risk
", "FindingSummary$riskLevel": "Severity level of the identified risk
", "ListFindingsInput$riskLevel": "Filter findings by risk level
", "UpdateFindingInput$riskLevel": "Updated severity level of the identified risk
" } }, "RiskType": { "base": "Type of security risk
", "refs": { "RiskTypeList$member": null, "Task$riskType": "Type of security risk this task is designed to test
", "TaskSummary$riskType": "Type of security risk this task is designed to test
" } }, "RiskTypeList": { "base": null, "refs": { "CreatePentestInput$excludeRiskTypes": "A list of risk types excluded from the pentest execution
", "CreatePentestOutput$excludeRiskTypes": "A list of risk types excluded from the pentest execution
", "Pentest$excludeRiskTypes": "A list of risk types excluded from the pentest execution
", "PentestJob$excludeRiskTypes": "A list of risk types excluded from the pentest job
", "UpdatePentestInput$excludeRiskTypes": "A list of risk types excluded from the pentest execution
", "UpdatePentestOutput$excludeRiskTypes": "A list of risk types excluded from the pentest execution
" } }, "RoleArn": { "base": "ARN of the IAM role that the application uses to access AWS resources on your behalf
", "refs": { "CreateApplicationRequest$roleArn": "ARN of the IAM role that the application uses to access AWS resources on your behalf
", "GetApplicationResponse$roleArn": "ARN of the IAM role that the application uses to access AWS resources on your behalf
", "UpdateApplicationRequest$roleArn": "ARN of the IAM role that the application uses to access AWS resources on your behalf
" } }, "S3BucketArn": { "base": "S3 bucket ARN or name for agent space AWS resources
", "refs": { "S3BucketArns$member": null } }, "S3BucketArns": { "base": null, "refs": { "AWSResources$s3Buckets": "S3 bucket ARNs or names used to store Security Agent artifacts
" } }, "SecretArn": { "base": "Secret ARN or name for agent space AWS resources
", "refs": { "SecretArns$member": null } }, "SecretArns": { "base": null, "refs": { "AWSResources$secretArns": "SecretsManager secret ARNs or names used to store tester credentials for pentests
" } }, "SecurityGroupArn": { "base": "ARN or ID of a security group
", "refs": { "SecurityGroupArns$member": null } }, "SecurityGroupArns": { "base": "A list of one or more security group ARNs or IDs in the customer VPC
", "refs": { "VpcConfig$securityGroupArns": "List of security group ARNs or IDs in the customer VPC
" } }, "SensitiveEmail": { "base": "Sensitive email address
", "refs": { "UserMetadata$email": "User email address
" } }, "ServiceRole": { "base": "ARN of an IAM role that the service can assume to access customer resources
", "refs": { "CreatePentestInput$serviceRole": "Service role ARN for accessing customer resources
", "CreatePentestOutput$serviceRole": "Service role ARN for accessing customer resources
", "IamRoles$member": null, "Pentest$serviceRole": "Service role ARN for accessing customer resources
", "PentestJob$serviceRole": "Service role ARN for accessing customer resources
", "UpdatePentestInput$serviceRole": "Updated service role ARN for accessing customer resources
", "UpdatePentestOutput$serviceRole": "Service role ARN for accessing customer resources
" } }, "SourceCodeRepository": { "base": "Information about a source code repository for static analysis
", "refs": { "SourceCodeRepositoryList$member": null } }, "SourceCodeRepositoryList": { "base": null, "refs": { "Assets$sourceCode": "List of source code repositories for static analysis
", "PentestJob$sourceCode": "List of source code repositories for static analysis
" } }, "StartCodeRemediationInput": { "base": "Input for the StartCodeRemediation operation
", "refs": {} }, "StartCodeRemediationOutput": { "base": "Output for the StartCodeRemediation operation
", "refs": {} }, "StartPentestJobInput": { "base": "Input for starting the execution of a pentest
", "refs": {} }, "StartPentestJobOutput": { "base": "Output for the StartPentestJob operation
", "refs": {} }, "Step": { "base": "Represents a single step in pentest job execution
", "refs": { "StepList$member": null } }, "StepList": { "base": "List of pentest job steps
", "refs": { "PentestJob$steps": "List of execution steps for the pentest job
" } }, "StepName": { "base": "Pentest job step names
", "refs": { "ListPentestJobTasksInput$stepName": "Filter tasks by step name
", "Step$name": "Name of the execution step
" } }, "StepStatus": { "base": "Pentest job step status
", "refs": { "Step$status": "Current status of the step
" } }, "StopPentestJobInput": { "base": "Input for stopping the execution of a pentest
", "refs": {} }, "StopPentestJobOutput": { "base": "Output for the StopPentestJob operation
", "refs": {} }, "String": { "base": null, "refs": { "AccessDeniedException$message": "Error description
", "Actor$identifier": "Unique identifier for the actor (case-insensitive)
", "Actor$description": "Additional description or details about the actor
", "AddArtifactInput$fileName": "Name of the artifact file
", "AgentSpace$name": "Name of the agent space
", "AgentSpace$description": "Description of the agent space
", "AgentSpaceSummary$name": "Name of the agent space
", "ApplicationSummary$applicationName": "Name of the application, automatically assigned by the service
", "Artifact$contents": "The content of the artifact
", "ArtifactMetadataItem$fileName": "Name of the artifact file
", "ArtifactSummary$fileName": "Name of the artifact file
", "Authentication$value": "Authentication credential value or reference
", "BatchDeletePentestsInput$agentSpaceId": "ID of the agent space where the pentests exist
", "BatchGetFindingsInput$agentSpaceId": "ID of the agent space where the findings exist
", "BatchGetPentestJobTasksInput$agentSpaceId": "ID of the agent space where the pentest exists
", "BatchGetPentestJobsInput$agentSpaceId": "ID of the agent space where the pentest exists
", "BatchGetPentestsInput$agentSpaceId": "ID of the agent space where the pentest exists
", "Category$name": "Name of the category
", "CloudWatchLog$logGroup": "Name of the CloudWatch log group
", "CloudWatchLog$logStream": "Name of the CloudWatch log stream
", "CodeRemediationTask$statusReason": "Reason for the current code remediation task status
", "CodeRemediationTaskDetails$repoName": "Name of the repository
", "CodeRemediationTaskDetails$codeDiffLink": "Link to the code diff for the remediation
", "CodeRemediationTaskDetails$pullRequestLink": "Link to the pull request for the remediation
", "ConflictException$message": "Error description
", "CreateAgentSpaceInput$description": "Description of the agent space
", "CreateAgentSpaceOutput$description": "Description of the created agent space
", "CreateIntegrationInput$integrationDisplayName": "Display name for the integration
", "CreatePentestInput$title": "Title of the pentest
", "CreatePentestInput$agentSpaceId": "ID of the agent space where the pentest should be created
", "CreatePentestOutput$pentestId": "Unique identifier of the created pentest
", "CreatePentestOutput$title": "Title of the created pentest
", "CreatePentestOutput$agentSpaceId": "ID of the agent space where the pentest was created
", "CreateTargetDomainInput$targetDomainName": "Domain name of the target domain
", "CreateTargetDomainOutput$domainName": "Name of the created target domain
", "CustomHeader$name": "Name of header to set value for
", "CustomHeader$value": "Value to set for header
", "DeletePentestFailure$pentestId": "Identifier of the pentest that failed to delete
", "DeletePentestFailure$reason": "Reason for the deletion failure
", "DiscoveredEndpoint$uri": "The URI of the discovered endpoint
", "DiscoveredEndpoint$pentestJobId": "Identifier of the pentest job that discovered this endpoint
", "DiscoveredEndpoint$taskId": "Identifier of the task that discovered this endpoint
", "DiscoveredEndpoint$agentSpaceId": "Identifier of the agent space where the endpoint was discovered
", "DiscoveredEndpoint$evidence": "Optional evidence or additional information about the endpoint
", "DiscoveredEndpoint$operation": "Operation or action associated with the endpoint
", "DiscoveredEndpoint$description": "Additional description of the endpoint
", "DnsVerification$token": "Token used to verify domain ownership
", "DnsVerification$dnsRecordName": "Record name to be added in DNS for target domain
", "DocumentInfo$s3Location": "S3 storage location of the document
", "DocumentInfo$artifactId": "Artifact ID of the document
", "Endpoint$uri": "URI of the endpoint to test
", "ErrorInformation$message": "Pentest job failure error message
", "ExecutionContext$context": "Context associated with a pentest or task execution
", "Finding$findingId": "Unique identifier for the finding
", "Finding$agentSpaceId": "Identifier of the agent space that created this finding
", "Finding$pentestId": "Identifier of the parent pentest
", "Finding$pentestJobId": "Identifier of the pentest job
", "Finding$taskId": "Identifier of the associated task
", "Finding$name": "Name or title of the finding
", "Finding$description": "Detailed description of the security vulnerability
", "Finding$riskType": "Type of security risk identified
", "Finding$riskScore": "Risk score associated with the finding
", "Finding$reasoning": "Justification for the assigned risk score
", "Finding$attackScript": "Proof-of-concept code demonstrating the vulnerability
", "Finding$lastUpdatedBy": "Identifier of the task or agent that last updated this finding
", "FindingIdList$member": null, "FindingSummary$findingId": "Unique identifier for the finding
", "FindingSummary$agentSpaceId": "Identifier of the agent space that created this finding
", "FindingSummary$pentestId": "Identifier of the parent pentest
", "FindingSummary$pentestJobId": "Identifier of the pentest job
", "FindingSummary$name": "Name or title of the finding
", "FindingSummary$riskType": "Type of security risk identified
", "GetApplicationResponse$applicationName": "Name of the application, automatically assigned by the service
", "GetArtifactOutput$fileName": "Name of the artifact file
", "GetIntegrationOutput$installationId": "Installation identifier from the provider
", "GetIntegrationOutput$displayName": "Display name for the integration
", "GitHubIntegrationInput$organizationName": "Name of the GitHub organization
", "HttpVerification$token": "Token used to verify domain ownership
", "HttpVerification$routePath": "Route path where verification token should be placed
", "IntegratedRepository$integrationId": "Integration identifier
", "IntegratedRepository$providerResourceId": "External provider resource identifier, e.g., Github repository identifier
", "IntegrationSummary$integrationId": "Unique identifier of the integration
", "IntegrationSummary$installationId": "Installation identifier from the provider
", "IntegrationSummary$displayName": "Display name for the integration
", "InternalServerException$message": "Error description
", "ListDiscoveredEndpointsInput$pentestJobId": "Identifier of the pentest job for which to retrieve discovered endpoints
", "ListDiscoveredEndpointsInput$agentSpaceId": "ID of the agent space where the pentest job exists
", "ListDiscoveredEndpointsInput$prefix": "Optional URI prefix filter to narrow down results
", "ListFindingsInput$pentestJobId": "Identifier of the pentest job for which to retrieve associated findings
", "ListFindingsInput$agentSpaceId": "ID of the agent space where the pentest job exists
", "ListFindingsInput$riskType": "Filter findings by risk type
", "ListFindingsInput$name": "Filter findings by name (case-insensitive substring search)
", "ListPentestJobTasksInput$agentSpaceId": "ID of the agent space where the pentest exists
", "ListPentestJobTasksInput$pentestJobId": "Identifier of the pentest job whose tasks to list
", "ListPentestJobTasksInput$categoryName": "Filter tasks by category name.
", "ListPentestJobsForPentestInput$pentestId": "Identifier of the pentest for which to retrieve associated jobs
", "ListPentestJobsForPentestInput$agentSpaceId": "ID of the agent space where the pentest exists
", "ListPentestsInput$agentSpaceId": "ID of the agent space where the pentest exists
", "MembershipSummary$createdBy": "User ID who created the membership
", "MembershipSummary$updatedBy": "User ID who last updated the membership
", "NetworkTrafficRule$pattern": "Pattern to match against
", "Pentest$pentestId": "Unique identifier for the pentest
", "Pentest$agentSpaceId": "ID of the agent space where the pentest exists
", "Pentest$title": "Title or name of the pentest
", "PentestIdList$member": null, "PentestJob$pentestJobId": "Unique identifier of the pentest job
", "PentestJob$pentestId": "Identifier of the parent pentest
", "PentestJob$title": "Title or name of the pentest
", "PentestJob$overview": "Overview or description of the pentest job
", "PentestJobIdList$member": null, "PentestJobSummary$pentestJobId": "Unique identifier of the pentest job
", "PentestJobSummary$pentestId": "Identifier of the parent pentest
", "PentestJobSummary$title": "Title or name of the pentest
", "PentestSummary$pentestId": "Unique identifier for the pentest
", "PentestSummary$agentSpaceId": "ID of the agent space where the pentest exists
", "PentestSummary$title": "Title or name of the pentest
", "ResourceNotFoundException$message": "Error description
", "SourceCodeRepository$s3Location": "S3 storage location of the repository
", "StartCodeRemediationInput$agentSpaceId": "ID of the agent space where the pentest job exists
", "StartCodeRemediationInput$pentestJobId": "Identifier of the pentest job to start code remediation for
", "StartPentestJobInput$agentSpaceId": "ID of the agent space where the pentest exists
", "StartPentestJobInput$pentestId": "Identifier of the pentest to execute
", "StartPentestJobOutput$title": "Title of the pentest job
", "StartPentestJobOutput$pentestId": "Unique identifier of the pentest
", "StartPentestJobOutput$pentestJobId": "Unique identifier of the pentest job
", "StartPentestJobOutput$agentSpaceId": "ID of the agent space where the pentest exists
", "StopPentestJobInput$agentSpaceId": "ID of the agent space where the pentest exists
", "StopPentestJobInput$pentestJobId": "Identifier of the pentest job to stop
", "TargetDomain$domainName": "Name of the registered target domain
", "TargetDomainIdList$member": null, "TargetDomainSummary$domainName": "Name of the registered target domain
", "Task$taskId": "Unique identifier for the task
", "Task$pentestId": "Identifier of the parent pentest
", "Task$pentestJobId": "Identifier of the pentest job this task belongs to
", "Task$agentSpaceId": "Identifier of the agent space this task belongs to
", "Task$title": "Title or name of the task
", "Task$description": "Detailed description of the task's purpose and scope
", "TaskIdList$member": null, "TaskSummary$taskId": "Unique identifier for the task
", "TaskSummary$pentestId": "Identifier of the parent pentest
", "TaskSummary$pentestJobId": "Identifier of the pentest job this task belongs to
", "TaskSummary$agentSpaceId": "Identifier of the agent space this task belongs to
", "TaskSummary$title": "Title or name of the task
", "ThrottlingException$message": "Error description
", "ThrottlingException$serviceCode": "Service code for throttling limit
", "ThrottlingException$quotaCode": "Quota code for throttling limit
", "UpdateAgentSpaceInput$description": "Description of the agent space
", "UpdateAgentSpaceOutput$description": "Description of the agent space
", "UpdateFindingInput$findingId": "Identifier of the finding to update
", "UpdateFindingInput$agentSpaceId": "ID of the agent space where the finding exists
", "UpdatePentestInput$pentestId": "Identifier of the pentest to update
", "UpdatePentestInput$agentSpaceId": "ID of the agent space where the pentest exists
", "UpdatePentestInput$title": "New title for the pentest
", "UpdatePentestOutput$pentestId": "Unique identifier of the updated pentest
", "UpdatePentestOutput$title": "Title of the updated pentest
", "UpdatePentestOutput$agentSpaceId": "ID of the agent space where the pentest exists
", "UpdateTargetDomainOutput$domainName": "Name of the target domain
", "UriList$member": null, "UserMetadata$username": "User name/display name
", "ValidationException$message": "A summary of the validation failure.
", "ValidationExceptionField$path": "A JSONPointer expression to the structure member whose value failed to satisfy the modeled constraints.
", "ValidationExceptionField$message": "A detailed description of the validation failure.
", "VerifyTargetDomainOutput$domainName": "Name of the registered target domain
" } }, "SubnetArn": { "base": "ARN or ID of a subnet
", "refs": { "SubnetArns$member": null } }, "SubnetArns": { "base": "A list of one or more subnet ARNs or IDs in the customer VPC
", "refs": { "VpcConfig$subnetArns": "List of subnet ARNs or IDs in the customer VPC
" } }, "SyntheticTimestamp_date_time": { "base": null, "refs": { "AgentSpace$createdAt": "Timestamp when the agent space was created
", "AgentSpace$updatedAt": "Timestamp when the agent space was last updated
", "AgentSpaceSummary$createdAt": "Timestamp when the agent space was created
", "AgentSpaceSummary$updatedAt": "Timestamp when the agent space was last updated
", "ArtifactMetadataItem$updatedAt": "Timestamp when the artifact was last updated
", "CreateAgentSpaceOutput$createdAt": "Timestamp when the agent space was created
", "CreateAgentSpaceOutput$updatedAt": "Timestamp when the agent space was last updated
", "CreatePentestOutput$createdAt": "Timestamp when the pentest was created
", "CreatePentestOutput$updatedAt": "Timestamp when the pentest was last updated
", "CreateTargetDomainOutput$createdAt": "Timestamp when the target domain was registered
", "CreateTargetDomainOutput$verifiedAt": "Timestamp when the target domain was last successfully verified
", "ExecutionContext$timestamp": "Timestamp associated with a pentest or task execution
", "Finding$createdAt": "Timestamp when the finding was created
", "Finding$updatedAt": "Timestamp when the finding was last updated
", "FindingSummary$createdAt": "Timestamp when the finding was created
", "FindingSummary$updatedAt": "Timestamp when the finding was last updated
", "GetArtifactOutput$updatedAt": "Timestamp when the artifact was last updated
", "MembershipSummary$createdAt": "Timestamp when the membership was created (ISO 8601)
", "MembershipSummary$updatedAt": "Timestamp when the membership was last updated (ISO 8601)
", "Pentest$createdAt": "Timestamp when the pentest was created
", "Pentest$updatedAt": "Timestamp when the pentest was last updated
", "PentestJob$createdAt": "Timestamp when the pentest job was created
", "PentestJob$updatedAt": "Timestamp when the pentest job was last updated
", "PentestJobSummary$createdAt": "Timestamp when the pentest job was created
", "PentestJobSummary$updatedAt": "Timestamp when the pentest job was last updated
", "PentestSummary$createdAt": "Timestamp when the pentest was created
", "PentestSummary$updatedAt": "Timestamp when the pentest was last updated
", "StartPentestJobOutput$createdAt": "Timestamp when the pentest job was created
", "StartPentestJobOutput$updatedAt": "Timestamp when the pentest job was last updated
", "Step$createdAt": "Timestamp when the step was created
", "Step$updatedAt": "Timestamp when the step was last updated
", "TargetDomain$createdAt": "Timestamp when the target domain was registered
", "TargetDomain$verifiedAt": "Timestamp when the target domain was last successfully verified
", "Task$createdAt": "Timestamp when the task was created
", "Task$updatedAt": "Timestamp when the task was last updated
", "TaskSummary$createdAt": "Timestamp when the task was created
", "TaskSummary$updatedAt": "Timestamp when the task was last updated
", "UpdateAgentSpaceOutput$createdAt": "Timestamp when the agent space was created
", "UpdateAgentSpaceOutput$updatedAt": "Timestamp when the agent space was last updated
", "UpdatePentestOutput$createdAt": "Timestamp when the pentest was created
", "UpdatePentestOutput$updatedAt": "Timestamp when the pentest was last updated
", "UpdateTargetDomainOutput$createdAt": "Timestamp when the target domain was registered
", "UpdateTargetDomainOutput$verifiedAt": "Timestamp when the target domain was last successfully verified
", "VerifyTargetDomainOutput$createdAt": "Timestamp when the target domain was registered
", "VerifyTargetDomainOutput$updatedAt": "Timestamp when the target domain was last updated
", "VerifyTargetDomainOutput$verifiedAt": "Timestamp when the target domain was last successfully verified
" } }, "TagKey": { "base": "Key for a resource tag
", "refs": { "TagKeyList$member": null, "TagMap$key": null } }, "TagKeyList": { "base": "List of tag keys
", "refs": { "UntagResourceInput$tagKeys": "List of tag keys to remove from the resource
" } }, "TagMap": { "base": "Map of tags for a resource
", "refs": { "CreateAgentSpaceInput$tags": "Tags to associate with the agent space
", "CreateApplicationRequest$tags": "Tags to associate with the application
", "CreateIntegrationInput$tags": "Tags to associate with the integration
", "CreateTargetDomainInput$tags": "Tags to associate with the target domain
", "ListTagsForResourceOutput$tags": "Tags associated with the resource
", "TagResourceInput$tags": "Tags to add to the resource
" } }, "TagResourceInput": { "base": "Input for TagResource operation
", "refs": {} }, "TagResourceOutput": { "base": "Output for TagResource operation
", "refs": {} }, "TagValue": { "base": "Value for a resource tag
", "refs": { "TagMap$value": null } }, "TargetDomain": { "base": "Represents a target domain
", "refs": { "TargetDomainList$member": null } }, "TargetDomainId": { "base": "Unique identifier of the target domain
", "refs": { "CreateTargetDomainOutput$targetDomainId": "Unique identifier of the created target domain
", "DeleteTargetDomainInput$targetDomainId": "Unique identifier of the target domain to delete
", "DeleteTargetDomainOutput$targetDomainId": "Unique identifier of the deleted target domain
", "TargetDomain$targetDomainId": "Unique identifier of the target domain
", "TargetDomainSummary$targetDomainId": "Unique identifier of the target domain
", "UpdateTargetDomainInput$targetDomainId": "Unique identifier of the target domain to update
", "UpdateTargetDomainOutput$targetDomainId": "Unique identifier of the target domain
", "VerifyTargetDomainInput$targetDomainId": "Unique identifier of the target domain
", "VerifyTargetDomainOutput$targetDomainId": "Unique identifier of the target domain
" } }, "TargetDomainIdList": { "base": "List of target domain IDs
", "refs": { "AgentSpace$targetDomainIds": "List of target domain IDs registered with the agent space
", "BatchGetTargetDomainsInput$targetDomainIds": "List of target domain IDs to retrieve
", "BatchGetTargetDomainsOutput$notFound": "List of target domain IDs that could not be found
", "CreateAgentSpaceInput$targetDomainIds": "Target domain IDs to associate with the agent space
", "CreateAgentSpaceOutput$targetDomainIds": "List of target domain IDs registered with the agent space
", "UpdateAgentSpaceInput$targetDomainIds": "Target domain IDs to associate with the agent space
", "UpdateAgentSpaceOutput$targetDomainIds": "List of target domain IDs registered with the agent space
" } }, "TargetDomainList": { "base": "List of target domains
", "refs": { "BatchGetTargetDomainsOutput$targetDomains": "List of target domains that were successfully retrieved
" } }, "TargetDomainStatus": { "base": "Verification status of a target domain
", "refs": { "CreateTargetDomainOutput$verificationStatus": "Current verification status of the registered target domain
", "TargetDomain$verificationStatus": "Current verification status of the registered target domain
", "TargetDomainSummary$verificationStatus": "Current verification status of the registered target domain
", "UpdateTargetDomainOutput$verificationStatus": "Current verification status of the registered target domain
", "VerifyTargetDomainOutput$status": "Current verification status of the registered target domain
" } }, "TargetDomainSummary": { "base": "Summary information for a target domain
", "refs": { "TargetDomainSummaryList$member": null } }, "TargetDomainSummaryList": { "base": null, "refs": { "ListTargetDomainsOutput$targetDomainSummaries": "List of target domain summaries
" } }, "Task": { "base": "Represents a task within a pentest job
", "refs": { "TaskList$member": null } }, "TaskExecutionStatus": { "base": "Execution status of a task
", "refs": { "Task$executionStatus": "Current status of the task execution
", "TaskSummary$executionStatus": "Current status of the task execution
" } }, "TaskIdList": { "base": null, "refs": { "BatchGetPentestJobTasksInput$taskIds": "List of task IDs to retrieve
", "BatchGetPentestJobTasksOutput$notFound": "List of task IDs that could not be found
" } }, "TaskList": { "base": null, "refs": { "BatchGetPentestJobTasksOutput$tasks": "List of successfully retrieved tasks
" } }, "TaskSummary": { "base": "Summary information for a task
", "refs": { "TaskSummaryList$member": null } }, "TaskSummaryList": { "base": null, "refs": { "ListPentestJobTasksOutput$taskSummaries": "List of task summaries associated with the specified pentest job
" } }, "ThrottlingException": { "base": "Request denied due to throttling
", "refs": {} }, "UntagResourceInput": { "base": "Input for UntagResource operation
", "refs": {} }, "UntagResourceOutput": { "base": "Output for UntagResource operation
", "refs": {} }, "UpdateAgentSpaceInput": { "base": "Input for updating an agent space
", "refs": {} }, "UpdateAgentSpaceOutput": { "base": "Output for the UpdateAgentSpace operation
", "refs": {} }, "UpdateApplicationRequest": { "base": null, "refs": {} }, "UpdateApplicationResponse": { "base": null, "refs": {} }, "UpdateFindingInput": { "base": "Input for updating an existing security finding
", "refs": {} }, "UpdateFindingOutput": { "base": "Output for the UpdateFinding operation
", "refs": {} }, "UpdateIntegratedResourcesInput": { "base": null, "refs": {} }, "UpdateIntegratedResourcesOutput": { "base": null, "refs": {} }, "UpdatePentestInput": { "base": "Input for updating an existing pentest
", "refs": {} }, "UpdatePentestOutput": { "base": "Output for the UpdatePentest operation
", "refs": {} }, "UpdateTargetDomainInput": { "base": "Input for updating a target domain
", "refs": {} }, "UpdateTargetDomainOutput": { "base": "Output for the UpdateTargetDomain operation
", "refs": {} }, "UriList": { "base": null, "refs": { "Actor$uris": "List of URIs accessible with the actor's credentials
" } }, "UserConfig": { "base": "User membership configuration
", "refs": { "MembershipConfig$user": "Configuration for user members
" } }, "UserMetadata": { "base": "User-specific metadata
", "refs": { "MemberMetadata$user": "User metadata for USER members
" } }, "UserRole": { "base": "Role of a user member associated to an agent space
", "refs": { "UserConfig$role": "Role of the user associated to the agent space
" } }, "ValidationException": { "base": "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.
", "refs": {} }, "ValidationExceptionField": { "base": "Describes one specific validation failure for an input member.
", "refs": { "ValidationExceptionFieldList$member": null } }, "ValidationExceptionFieldList": { "base": null, "refs": { "ValidationException$fieldList": "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.
" } }, "VerificationDetails": { "base": "Verification details to verify registered target domain
", "refs": { "CreateTargetDomainOutput$verificationDetails": "Verification details to verify registered target domain
", "TargetDomain$verificationDetails": "Verification details to verify registered target domain
", "UpdateTargetDomainOutput$verificationDetails": "Verification details to verify registered target domain
" } }, "VerifyTargetDomainInput": { "base": "Input for verifying ownership for a registered target domain in an agent space
", "refs": {} }, "VerifyTargetDomainOutput": { "base": "Output for verifying ownership for a registered target domain in an agent space
", "refs": {} }, "VpcArn": { "base": "ARN or ID of a VPC
", "refs": { "VpcConfig$vpcArn": "ARN or ID of the customer VPC
" } }, "VpcConfig": { "base": "Customer VPC configuration that the Security Agent accesses
", "refs": { "CreatePentestInput$vpcConfig": "VPC configuration that the Security Agent accesses
", "Pentest$vpcConfig": "VPC configuration that the Security Agent accesses
", "PentestJob$vpcConfig": "VPC configuration that the Security Agent accesses
", "UpdatePentestInput$vpcConfig": "VPC configuration that the Security Agent accesses
", "VpcConfigs$member": null } }, "VpcConfigs": { "base": null, "refs": { "AWSResources$vpcs": "VPC configurations that the Security Agent accesses in the customer environment
" } } } }