2026/10/12 - AWS Security Agent - 2 new7 updated api methods
Changes Adds support for Jira integration provider in AWS Security Agent.
Exports a batch of findings to the connected issue tracker as issues.
See also: AWS API Documentation
Request Syntax
client.batch_export_findings(
agentSpaceId='string',
pentestJobId='string',
codeReviewJobId='string',
issueDestination={
'integrationId': 'string',
'projectKey': 'string'
},
findingIds=[
'string',
]
)
string
[REQUIRED]
The identifier of the agent space where the job exists.
string
The identifier of the penetration test job. This parameter is mutually exclusive with codeReviewJobId.
string
The identifier of the code review job. This parameter is mutually exclusive with pentestJobId.
dict
[REQUIRED]
The destination issue-tracker project the findings are exported to. Must be a connected capability of the agent space.
integrationId (string) -- [REQUIRED]
The integration identifier for the issue-tracker provider.
projectKey (string) -- [REQUIRED]
The identifier of the project the issues are filed under.
list
[REQUIRED]
The identifiers of the findings to export. Each must belong to the specified job.
(string) --
dict
Response Syntax
{
'results': [
{
'findingId': 'string',
'linkedIssue': {
'provider': 'GITHUB'|'GITLAB'|'BITBUCKET'|'CONFLUENCE'|'AZURE_DEVOPS'|'JIRA',
'integrationId': 'string',
'projectKey': 'string',
'issueKey': 'string',
'issueId': 'string',
'issueUrl': 'string',
'siteUrl': 'string'
}
},
],
'errors': [
{
'findingId': 'string',
'code': 'CLIENT_ERROR'|'INTERNAL_ERROR'|'STOPPED_BY_USER',
'message': 'string'
},
]
}
Response Structure
(dict) --
The output for the BatchExportFindings operation.
results (list) --
The findings whose issue was created, each with its linked issue.
(dict) --
A finding whose issue was created.
findingId (string) --
The identifier of the finding this result corresponds to.
linkedIssue (dict) --
The issue that was created for the finding.
provider (string) --
The issue-tracker provider.
integrationId (string) --
The integration identifier for the issue-tracker provider.
projectKey (string) --
The key of the project the issue belongs to.
issueKey (string) --
The issue key.
issueId (string) --
The stable numeric issue identifier.
issueUrl (string) --
The issue URL.
siteUrl (string) --
The Atlassian Cloud site URL.
errors (list) --
The findings whose issue could not be created, each with a customer-facing reason.
(dict) --
A finding whose issue could not be created, with the cause of the failure.
findingId (string) --
The identifier of the finding this error corresponds to.
code (string) --
The machine-readable failure category.
message (string) --
A customer-facing explanation of why the issue could not be created.
Disassociates a batch of findings from their linked issues.
See also: AWS API Documentation
Request Syntax
client.batch_disassociate_finding_issue(
agentSpaceId='string',
pentestJobId='string',
codeReviewJobId='string',
findingIds=[
'string',
]
)
string
[REQUIRED]
The identifier of the agent space where the job exists.
string
The identifier of the penetration test job. This parameter is mutually exclusive with codeReviewJobId.
string
The identifier of the code review job. This parameter is mutually exclusive with pentestJobId.
list
[REQUIRED]
The identifiers of the findings to disassociate from their issues. Each must belong to the specified job.
(string) --
dict
Response Syntax
{
'errors': [
{
'findingId': 'string',
'code': 'CLIENT_ERROR'|'INTERNAL_ERROR'|'STOPPED_BY_USER',
'message': 'string'
},
]
}
Response Structure
(dict) --
The output for the BatchDisassociateFindingIssue operation.
errors (list) --
The findings whose issue could not be disassociated.
(dict) --
A finding that failed to disassociate, with the cause of the failure.
findingId (string) --
The identifier of the finding that failed to disassociate.
code (string) --
The machine-readable failure category.
message (string) --
A customer-facing explanation of the failure.
{'findings': {'linkedIssue': {'integrationId': 'string',
'issueId': 'string',
'issueKey': 'string',
'issueUrl': 'string',
'projectKey': 'string',
'provider': 'GITHUB | GITLAB | BITBUCKET | '
'CONFLUENCE | AZURE_DEVOPS | JIRA',
'siteUrl': 'string'}}}
Retrieves information about one or more security findings in an agent space.
See also: AWS API Documentation
Request Syntax
client.batch_get_findings(
findingIds=[
'string',
],
agentSpaceId='string'
)
list
[REQUIRED]
The list of finding identifiers to retrieve.
(string) --
string
[REQUIRED]
The unique identifier of the agent space that contains the findings.
dict
Response Syntax
{
'findings': [
{
'findingId': 'string',
'agentSpaceId': 'string',
'pentestId': 'string',
'pentestJobId': 'string',
'codeReviewId': 'string',
'codeReviewJobId': 'string',
'taskId': 'string',
'name': 'string',
'description': 'string',
'status': 'ACTIVE'|'RESOLVED'|'ACCEPTED'|'FALSE_POSITIVE',
'riskType': 'string',
'riskLevel': 'UNKNOWN'|'INFORMATIONAL'|'LOW'|'MEDIUM'|'HIGH'|'CRITICAL',
'riskScore': 'string',
'reasoning': 'string',
'confidence': 'FALSE_POSITIVE'|'UNCONFIRMED'|'LOW'|'MEDIUM'|'HIGH',
'validationStatus': 'CONFIRMED'|'NOT_REPRODUCED'|'VALIDATION_FAILED'|'VALIDATING'|'NOT_VALIDATED',
'attackScript': 'string',
'remediationCode': 'string',
'codeRemediationTask': {
'status': 'IN_PROGRESS'|'COMPLETED'|'FAILED',
'statusReason': 'string',
'taskDetails': [
{
'repoName': 'string',
'codeDiffLink': 'string',
'pullRequestLink': 'string'
},
]
},
'lastUpdatedBy': 'string',
'customerNote': 'string',
'codeLocations': [
{
'filePath': 'string',
'lineStart': 123,
'lineEnd': 123,
'label': 'string'
},
],
'verificationScript': {
'scriptType': 'string',
'scriptUrl': 'string',
'instructions': 'string',
'envVars': [
{
'name': 'string',
'value': 'string'
},
]
},
'alignmentRationale': 'string',
'revalidationJobIds': [
'string',
],
'originalFindingId': 'string',
'linkedIssue': {
'provider': 'GITHUB'|'GITLAB'|'BITBUCKET'|'CONFLUENCE'|'AZURE_DEVOPS'|'JIRA',
'integrationId': 'string',
'projectKey': 'string',
'issueKey': 'string',
'issueId': 'string',
'issueUrl': 'string',
'siteUrl': 'string'
},
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'notFound': [
'string',
]
}
Response Structure
(dict) --
Output for the BatchGetFindings operation.
findings (list) --
The list of findings that were found.
(dict) --
Represents a security finding discovered during a pentest job. A finding contains details about a vulnerability, including its risk level, confidence, and remediation status.
findingId (string) --
The unique identifier of the finding.
agentSpaceId (string) --
The unique identifier of the agent space associated with the finding.
pentestId (string) --
The unique identifier of the pentest associated with the finding.
pentestJobId (string) --
The unique identifier of the pentest job that produced the finding.
codeReviewId (string) --
The unique identifier of the code review associated with the finding.
codeReviewJobId (string) --
The unique identifier of the code review job that produced the finding.
taskId (string) --
The unique identifier of the task that produced the finding.
name (string) --
The name of the finding.
description (string) --
A description of the finding.
status (string) --
The current status of the finding. Valid values include ACTIVE, RESOLVED, ACCEPTED, and FALSE_POSITIVE.
riskType (string) --
The type of security risk identified by the finding.
riskLevel (string) --
The risk level of the finding. Valid values include UNKNOWN, INFORMATIONAL, LOW, MEDIUM, HIGH, and CRITICAL.
riskScore (string) --
The numerical risk score of the finding.
reasoning (string) --
The reasoning behind the finding, explaining why it was identified as a vulnerability.
confidence (string) --
The confidence level of the finding. Valid values include FALSE_POSITIVE, UNCONFIRMED, LOW, MEDIUM, and HIGH.
validationStatus (string) --
The simulated validation status of the finding. Valid values are NOT_VALIDATED, VALIDATING, CONFIRMED, NOT_REPRODUCED, and VALIDATION_FAILED.
attackScript (string) --
The attack script used to reproduce the finding.
remediationCode (string) --
The suggested fix for the finding, describing the changes recommended to remediate the vulnerability, with example code or configuration.
codeRemediationTask (dict) --
The code remediation task associated with the finding, if code remediation was initiated.
status (string) --
The current status of the code remediation task.
statusReason (string) --
The reason for the current status of the code remediation task.
taskDetails (list) --
The list of details for the code remediation task, including repository name, code diff link, and pull request link.
(dict) --
Contains details about a code remediation task, including links to the code diff and pull request.
repoName (string) --
The name of the repository where the remediation was applied.
codeDiffLink (string) --
The link to the code diff for the remediation.
pullRequestLink (string) --
The link to the pull request created for the remediation.
lastUpdatedBy (string) --
The identifier of the entity that last updated the finding.
customerNote (string) --
A customer-provided note on the finding.
codeLocations (list) --
The file locations involved in the vulnerability, as reported by the code scanner.
(dict) --
Represents a location in source code associated with a security finding.
filePath (string) --
The absolute path to the file containing the code location.
lineStart (integer) --
The starting line number of the code location.
lineEnd (integer) --
The ending line number of the code location.
label (string) --
The role of this location in the vulnerability, such as source or sink.
verificationScript (dict) --
The verification script metadata for reproducing the finding, including download URL, instructions, and required environment variables.
scriptType (string) --
The type of script. Valid values are python and bash.
scriptUrl (string) --
URL to download the verification script.
instructions (string) --
Instructions for running the verification script, including prerequisites and how to interpret results.
envVars (list) --
The list of environment variables required to run the verification script.
(dict) --
Represents an environment variable required to run a verification script.
name (string) --
The name of the environment variable.
value (string) --
The value of the environment variable.
alignmentRationale (string) --
The rationale provided by the alignment agent explaining how the finding was adjusted based on customer preferences.
revalidationJobIds (list) --
The list of pentest job identifiers for revalidation jobs that retested this finding.
(string) --
originalFindingId (string) --
The identifier of the original finding that this revalidation finding was produced from.
linkedIssue (dict) --
The issue in a third-party issue tracker that this finding has been exported to.
provider (string) --
The issue-tracker provider.
integrationId (string) --
The integration identifier for the issue-tracker provider.
projectKey (string) --
The key of the project the issue belongs to.
issueKey (string) --
The issue key.
issueId (string) --
The stable numeric issue identifier.
issueUrl (string) --
The issue URL.
siteUrl (string) --
The Atlassian Cloud site URL.
createdAt (datetime) --
The date and time the finding was created, in UTC format.
updatedAt (datetime) --
The date and time the finding was last updated, in UTC format.
notFound (list) --
The list of finding identifiers that were not found.
(string) --
{'input': {'jira': {'code': 'string',
'installationId': 'string',
'siteUrl': 'string',
'state': 'string'}},
'provider': {'JIRA'}}
Creates a new integration with a third-party provider, such as GitHub, for code review and remediation.
See also: AWS API Documentation
Request Syntax
client.create_integration(
provider='GITHUB'|'GITLAB'|'BITBUCKET'|'CONFLUENCE'|'AZURE_DEVOPS'|'JIRA',
input={
'github': {
'code': 'string',
'state': 'string',
'organizationName': 'string',
'targetUrl': 'string',
'installationId': 'string'
},
'gitlab': {
'accessToken': 'string',
'targetUrl': 'string',
'tokenType': 'PERSONAL'|'GROUP',
'groupId': 'string'
},
'bitbucket': {
'installationId': 'string',
'workspace': 'string',
'code': 'string',
'state': 'string'
},
'confluence': {
'installationId': 'string',
'code': 'string',
'state': 'string',
'siteUrl': 'string'
},
'azureDevOps': {
'code': 'string',
'state': 'string',
'organizationName': 'string'
},
'bitbucketDataCenter': {
'targetUrl': 'string',
'code': 'string',
'state': 'string'
},
'jira': {
'installationId': 'string',
'code': 'string',
'state': 'string',
'siteUrl': 'string'
}
},
integrationDisplayName='string',
kmsKeyId='string',
tags={
'string': 'string'
},
privateConnectionName='string'
)
string
[REQUIRED]
The integration provider.
dict
[REQUIRED]
The provider-specific input required to create the integration.
github (dict) --
The GitHub-specific input for creating an integration.
code (string) -- [REQUIRED]
The OAuth authorization code received from GitHub.
state (string) -- [REQUIRED]
The CSRF state token for validating the OAuth flow.
organizationName (string) --
The name of the GitHub organization to integrate with.
targetUrl (string) --
The HTTPS URL of a self-hosted GitHub Enterprise Server instance. Omit this value for GitHub.com.
installationId (string) --
The installation identifier provided by GitHub Enterprise Server on the install callback. Required for GitHub Enterprise Server integrations and ignored for GitHub.com.
gitlab (dict) --
The configuration for a GitLab integration.
accessToken (string) -- [REQUIRED]
The GitLab access token used to authenticate. This can be a personal access token or a group access token.
targetUrl (string) --
The HTTPS URL of a self-managed GitLab instance. Omit this value for GitLab SaaS (gitlab.com).
tokenType (string) -- [REQUIRED]
The type of GitLab access token provided in accessToken.
groupId (string) --
The identifier of the GitLab group. Required when tokenType is group and ignored for personal tokens.
bitbucket (dict) --
The configuration for a Bitbucket integration.
installationId (string) -- [REQUIRED]
The Atlassian installation identifier, available from the Atlassian administration console.
workspace (string) -- [REQUIRED]
The Bitbucket workspace slug that identifies the workspace to integrate, for example acme-corp.
code (string) -- [REQUIRED]
The OAuth 2.0 authorization code returned from the consent redirect.
state (string) -- [REQUIRED]
The CSRF state token echoed back from the OAuth redirect.
confluence (dict) --
The configuration for a Confluence integration.
installationId (string) -- [REQUIRED]
The Atlassian installation identifier, available from the Atlassian administration console.
code (string) -- [REQUIRED]
The OAuth 2.0 authorization code returned from the consent redirect.
state (string) -- [REQUIRED]
The CSRF state token echoed back from the OAuth redirect.
siteUrl (string) -- [REQUIRED]
The Confluence Cloud site URL, for example https://mysite.atlassian.net.
azureDevOps (dict) --
The Azure DevOps-specific input for creating an integration.
code (string) -- [REQUIRED]
The OAuth 2.0 authorization code returned to your redirect URL after the connection is authorized.
state (string) -- [REQUIRED]
The CSRF state value returned by InitiateProviderRegistration and echoed back on the authorization redirect.
organizationName (string) -- [REQUIRED]
The name of the Azure DevOps organization to connect, for example my-org.
bitbucketDataCenter (dict) --
The Bitbucket Data Center-specific input for creating an integration.
targetUrl (string) -- [REQUIRED]
The HTTPS URL of your Bitbucket Data Center instance, for example https://bitbucket.example.com.
code (string) -- [REQUIRED]
The OAuth 2.0 authorization code returned to your redirect URL after the connection is authorized.
state (string) -- [REQUIRED]
The CSRF state value returned by InitiateProviderRegistration and echoed back on the authorization redirect.
jira (dict) --
The configuration for a Jira integration.
installationId (string) -- [REQUIRED]
The Atlassian installation identifier, available from the Atlassian administration console.
code (string) -- [REQUIRED]
The OAuth 2.0 authorization code returned from the consent redirect.
state (string) -- [REQUIRED]
The CSRF state token echoed back from the OAuth redirect.
siteUrl (string) -- [REQUIRED]
The Jira Cloud site URL, for example https://mysite.atlassian.net.
string
[REQUIRED]
The display name for the integration.
string
The identifier of the AWS KMS key to use for encrypting data associated with the integration.
dict
The tags to associate with the integration.
(string) --
Key for a resource tag.
(string) --
Value for a resource tag.
string
The name of an active private connection used to reach a self-hosted provider instance over private networking. Specify this when the instance is not publicly reachable.
dict
Response Syntax
{
'integrationId': 'string'
}
Response Structure
(dict) --
integrationId (string) --
The unique identifier of the created integration.
{'provider': {'JIRA'}, 'providerType': {'ISSUE_TRACKING'}, 'siteUrl': 'string'}
Retrieves information about an integration.
See also: AWS API Documentation
Request Syntax
client.get_integration(
integrationId='string'
)
string
[REQUIRED]
The unique identifier of the integration to retrieve.
dict
Response Syntax
{
'integrationId': 'string',
'installationId': 'string',
'provider': 'GITHUB'|'GITLAB'|'BITBUCKET'|'CONFLUENCE'|'AZURE_DEVOPS'|'JIRA',
'providerType': 'SOURCE_CODE'|'DOCUMENTATION'|'ISSUE_TRACKING',
'displayName': 'string',
'kmsKeyId': 'string',
'targetUrl': 'string',
'siteUrl': 'string',
'webhookUrl': 'string',
'privateConnectionName': 'string'
}
Response Structure
(dict) --
integrationId (string) --
The unique identifier of the integration.
installationId (string) --
The installation identifier from the integration provider.
provider (string) --
The integration provider.
providerType (string) --
The type of the integration provider.
displayName (string) --
The display name of the integration.
kmsKeyId (string) --
The identifier of the AWS KMS key used to encrypt data associated with the integration.
targetUrl (string) --
The HTTPS URL of the customer self-hosted instance, such as a GitHub Enterprise Server or self-managed GitLab instance. This value is absent for SaaS integrations.
siteUrl (string) --
The Atlassian Cloud site URL for Atlassian integrations.
webhookUrl (string) --
The payload URL of the integration's webhook, once it has been created. The signing secret is never returned on a read.
privateConnectionName (string) --
The name of the private connection used to reach the integration's self-hosted instance over private networking, if one is configured.
{'provider': {'JIRA'}}
Initiates the OAuth registration flow with a third-party provider. Returns a redirect URL and CSRF state token for completing the authorization.
See also: AWS API Documentation
Request Syntax
client.initiate_provider_registration(
provider='GITHUB'|'GITLAB'|'BITBUCKET'|'CONFLUENCE'|'AZURE_DEVOPS'|'JIRA',
targetUrl='string',
organizationName='string',
clientId='string',
clientSecret='string'
)
string
[REQUIRED]
The provider to initiate registration with.
string
The HTTPS URL of a self-managed provider instance. Omit for SaaS providers.
string
The name of the organization to connect.
string
The client ID of the OAuth application registered on your self-managed provider instance.
string
The client secret of the OAuth application registered on your self-managed provider instance.
dict
Response Syntax
{
'redirectTo': 'string',
'csrfState': 'string'
}
Response Structure
(dict) --
redirectTo (string) --
The URL to redirect the user to for completing the OAuth authorization.
csrfState (string) --
The CSRF state token to use when completing the OAuth flow.
{'resourceType': {'PROJECT'}}
Response {'integratedResourceSummaries': {'capabilities': {'jira': {'commentIssue': 'boolean',
'createIssue': 'boolean'}},
'resource': {'jiraProject': {'name': 'string',
'projectId': 'string',
'projectKey': 'string',
'projectName': 'string',
'providerResourceId': 'string'}}}}
Lists the integrated resources for an agent space, optionally filtered by integration or resource type.
See also: AWS API Documentation
Request Syntax
client.list_integrated_resources(
agentSpaceId='string',
integrationId='string',
resourceType='CODE_REPOSITORY'|'DOCUMENT'|'PROJECT',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The unique identifier of the agent space to list integrated resources for.
string
The unique identifier of the integration to filter by.
string
The type of resource to filter by.
string
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.
integer
The maximum number of results to return in a single call.
dict
Response Syntax
{
'integratedResourceSummaries': [
{
'integrationId': 'string',
'resource': {
'githubRepository': {
'name': 'string',
'providerResourceId': 'string',
'owner': 'string',
'accessType': 'PRIVATE'|'PUBLIC'
},
'gitlabRepository': {
'name': 'string',
'providerResourceId': 'string',
'namespace': 'string',
'accessType': 'PRIVATE'|'PUBLIC'
},
'bitbucketRepository': {
'name': 'string',
'providerResourceId': 'string',
'workspace': 'string',
'accessType': 'PRIVATE'|'PUBLIC'
},
'confluenceDocument': {
'name': 'string',
'providerResourceId': 'string',
'spaceKey': 'string',
'pageId': 'string',
'title': 'string',
'spaceTitle': 'string'
},
'azureDevOpsRepository': {
'name': 'string',
'providerResourceId': 'string',
'organization': 'string',
'project': 'string',
'projectId': 'string',
'accessType': 'PRIVATE'|'PUBLIC'
},
'jiraProject': {
'name': 'string',
'providerResourceId': 'string',
'projectKey': 'string',
'projectId': 'string',
'projectName': 'string'
}
},
'capabilities': {
'github': {
'triggerFilterGroups': [
{
'events': [
'PULL_REQUEST_READY_FOR_REVIEW'|'PULL_REQUEST_DRAFT'|'PULL_REQUEST_LABEL_ADDED',
],
'filters': [
{
'type': 'TARGET_BRANCH'|'LABEL',
'patterns': [
'string',
],
'matchMode': 'INCLUDE'|'EXCLUDE'
},
]
},
],
'leaveComments': True|False,
'remediateCode': True|False
},
'gitlab': {
'triggerFilterGroups': [
{
'events': [
'PULL_REQUEST_READY_FOR_REVIEW'|'PULL_REQUEST_DRAFT'|'PULL_REQUEST_LABEL_ADDED',
],
'filters': [
{
'type': 'TARGET_BRANCH'|'LABEL',
'patterns': [
'string',
],
'matchMode': 'INCLUDE'|'EXCLUDE'
},
]
},
],
'leaveComments': True|False,
'remediateCode': True|False
},
'bitbucket': {
'triggerFilterGroups': [
{
'events': [
'PULL_REQUEST_READY_FOR_REVIEW'|'PULL_REQUEST_DRAFT'|'PULL_REQUEST_LABEL_ADDED',
],
'filters': [
{
'type': 'TARGET_BRANCH'|'LABEL',
'patterns': [
'string',
],
'matchMode': 'INCLUDE'|'EXCLUDE'
},
]
},
],
'leaveComments': True|False,
'remediateCode': True|False
},
'confluence': {
'fetchDocument': True|False,
'createDocument': True|False,
'updateDocument': True|False
},
'azureDevOps': {
'triggerFilterGroups': [
{
'events': [
'PULL_REQUEST_READY_FOR_REVIEW'|'PULL_REQUEST_DRAFT'|'PULL_REQUEST_LABEL_ADDED',
],
'filters': [
{
'type': 'TARGET_BRANCH'|'LABEL',
'patterns': [
'string',
],
'matchMode': 'INCLUDE'|'EXCLUDE'
},
]
},
],
'leaveComments': True|False,
'remediateCode': True|False
},
'jira': {
'createIssue': True|False,
'commentIssue': True|False
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
integratedResourceSummaries (list) --
The list of integrated resource summaries.
(dict) --
Contains summary information about an integrated resource.
integrationId (string) --
The unique identifier of the integration that provides access to the resource.
resource (dict) --
The metadata for the integrated resource.
githubRepository (dict) --
The GitHub repository metadata.
name (string) --
The name of the GitHub repository.
providerResourceId (string) --
The provider-specific resource identifier for the GitHub repository.
owner (string) --
The owner of the GitHub repository.
accessType (string) --
The access type of the GitHub repository. Valid values are PRIVATE and PUBLIC.
gitlabRepository (dict) --
Metadata for an integrated GitLab repository.
name (string) --
Name of the resource e.g. repository name, etc.
providerResourceId (string) --
Provider Id of the resource e.g. GitHub repository id, etc.
namespace (string) --
The namespace (group or user path) that owns the project.
accessType (string) --
Defines the visibility level of provider resources. PRIVATE indicates restricted access, while PUBLIC indicates open access.
bitbucketRepository (dict) --
Metadata for an integrated Bitbucket repository.
name (string) --
Name of the resource e.g. repository name, etc.
providerResourceId (string) --
Provider Id of the resource e.g. GitHub repository id, etc.
workspace (string) --
The workspace slug that owns the repository.
accessType (string) --
Defines the visibility level of provider resources. PRIVATE indicates restricted access, while PUBLIC indicates open access.
confluenceDocument (dict) --
Metadata for an integrated Confluence document.
name (string) --
Name of the resource e.g. repository name, etc.
providerResourceId (string) --
Provider Id of the resource e.g. GitHub repository id, etc.
spaceKey (string) --
The Confluence space key containing the document.
pageId (string) --
The Confluence page identifier.
title (string) --
The display title of the Confluence page.
spaceTitle (string) --
The display title of the Confluence space.
azureDevOpsRepository (dict) --
The Azure DevOps repository metadata.
name (string) --
Name of the resource e.g. repository name, etc.
providerResourceId (string) --
Provider Id of the resource e.g. GitHub repository id, etc.
organization (string) --
The name of the Azure DevOps organization that owns the repository.
project (string) --
The name of the Azure DevOps project that contains the repository.
projectId (string) --
The GUID of the Azure DevOps project that contains the repository.
accessType (string) --
Defines the visibility level of provider resources. PRIVATE indicates restricted access, while PUBLIC indicates open access.
jiraProject (dict) --
The Jira project metadata.
name (string) --
Name of the resource e.g. repository name, etc.
providerResourceId (string) --
Provider Id of the resource e.g. GitHub repository id, etc.
projectKey (string) --
The Jira project key, for example PROJ.
projectId (string) --
The Jira project identifier.
projectName (string) --
The display name of the Jira project.
capabilities (dict) --
The capabilities enabled for the integrated resource.
github (dict) --
The GitHub-specific resource capabilities.
triggerFilterGroups (list) --
The filter groups that control which pull request events start an automatic code review when leaveComments is enabled. A review starts when any group matches. If you omit this, a review starts on PULL_REQUEST_READY_FOR_REVIEW events.
(dict) --
A set of conditions that start an automatic code review when they all pass. A filter group must include events, filters, or both.
events (list) --
Passes when the pull request event is one of the listed events. If you omit this, the group matches PULL_REQUEST_READY_FOR_REVIEW and PULL_REQUEST_DRAFT events only.
(string) --
A pull request event that can start an automatic code review. For GitLab repositories, pull request refers to a merge request.
filters (list) --
Passes when every filter passes. If you omit this, the group matches its events on any target branch and with any labels.
(dict) --
A condition on a pull request value.
type (string) --
The pull request value to match.
patterns (list) --
The regular expressions to match against the value.
(string) --
A regular expression in RE2 syntax that must match the entire value, for example main or release/.*.
matchMode (string) --
Whether the value must match the patterns. The default is INCLUDE.
leaveComments (boolean) --
Indicates whether the integration can leave comments on pull requests.
remediateCode (boolean) --
Indicates whether the integration can create code remediation pull requests.
gitlab (dict) --
Capabilities for an integrated GitLab repository.
triggerFilterGroups (list) --
The filter groups that control which merge request events start an automatic code review when leaveComments is enabled. A review starts when any group matches. If you omit this, a review starts on PULL_REQUEST_READY_FOR_REVIEW events.
(dict) --
A set of conditions that start an automatic code review when they all pass. A filter group must include events, filters, or both.
events (list) --
Passes when the pull request event is one of the listed events. If you omit this, the group matches PULL_REQUEST_READY_FOR_REVIEW and PULL_REQUEST_DRAFT events only.
(string) --
A pull request event that can start an automatic code review. For GitLab repositories, pull request refers to a merge request.
filters (list) --
Passes when every filter passes. If you omit this, the group matches its events on any target branch and with any labels.
(dict) --
A condition on a pull request value.
type (string) --
The pull request value to match.
patterns (list) --
The regular expressions to match against the value.
(string) --
A regular expression in RE2 syntax that must match the entire value, for example main or release/.*.
matchMode (string) --
Whether the value must match the patterns. The default is INCLUDE.
leaveComments (boolean) --
Whether to post code review comments on merge request discussions.
remediateCode (boolean) --
Whether to create merge requests with automated fixes.
bitbucket (dict) --
Capabilities for an integrated Bitbucket repository.
triggerFilterGroups (list) --
The filter groups that control which pull request events start an automatic code review when leaveComments is enabled. A review starts when any group matches. If you omit this, a review starts on PULL_REQUEST_READY_FOR_REVIEW events.
(dict) --
A set of conditions that start an automatic code review when they all pass. A filter group must include events, filters, or both.
events (list) --
Passes when the pull request event is one of the listed events. If you omit this, the group matches PULL_REQUEST_READY_FOR_REVIEW and PULL_REQUEST_DRAFT events only.
(string) --
A pull request event that can start an automatic code review. For GitLab repositories, pull request refers to a merge request.
filters (list) --
Passes when every filter passes. If you omit this, the group matches its events on any target branch and with any labels.
(dict) --
A condition on a pull request value.
type (string) --
The pull request value to match.
patterns (list) --
The regular expressions to match against the value.
(string) --
A regular expression in RE2 syntax that must match the entire value, for example main or release/.*.
matchMode (string) --
Whether the value must match the patterns. The default is INCLUDE.
leaveComments (boolean) --
Whether to post code review comments on pull requests.
remediateCode (boolean) --
Whether to create pull requests with automated fixes.
confluence (dict) --
Capabilities for an integrated Confluence space.
fetchDocument (boolean) --
Whether to fetch documents from this space.
createDocument (boolean) --
Whether to create documents in this space.
updateDocument (boolean) --
Whether to update documents in this space.
azureDevOps (dict) --
The Azure DevOps-specific resource capabilities.
triggerFilterGroups (list) --
The filter groups that control which pull request events start an automatic code review when leaveComments is enabled. A review starts when any group matches. If you omit this, a review starts on PULL_REQUEST_READY_FOR_REVIEW events.
(dict) --
A set of conditions that start an automatic code review when they all pass. A filter group must include events, filters, or both.
events (list) --
Passes when the pull request event is one of the listed events. If you omit this, the group matches PULL_REQUEST_READY_FOR_REVIEW and PULL_REQUEST_DRAFT events only.
(string) --
A pull request event that can start an automatic code review. For GitLab repositories, pull request refers to a merge request.
filters (list) --
Passes when every filter passes. If you omit this, the group matches its events on any target branch and with any labels.
(dict) --
A condition on a pull request value.
type (string) --
The pull request value to match.
patterns (list) --
The regular expressions to match against the value.
(string) --
A regular expression in RE2 syntax that must match the entire value, for example main or release/.*.
matchMode (string) --
Whether the value must match the patterns. The default is INCLUDE.
leaveComments (boolean) --
Whether to post code review comments on pull requests.
remediateCode (boolean) --
Whether to create pull requests with automated fixes.
jira (dict) --
The Jira-specific resource capabilities.
createIssue (boolean) --
Whether to create issues in the integrated jira project.
commentIssue (boolean) --
Whether to post comments on issues in the integrated jira project.
nextToken (string) --
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.
{'filter': {'provider': {'JIRA'}, 'providerType': {'ISSUE_TRACKING'}}}
Response {'integrationSummaries': {'provider': {'JIRA'},
'providerType': {'ISSUE_TRACKING'}}}
Lists the integrations in your account, optionally filtered by provider or provider type.
See also: AWS API Documentation
Request Syntax
client.list_integrations(
filter={
'provider': 'GITHUB'|'GITLAB'|'BITBUCKET'|'CONFLUENCE'|'AZURE_DEVOPS'|'JIRA',
'providerType': 'SOURCE_CODE'|'DOCUMENTATION'|'ISSUE_TRACKING'
},
nextToken='string',
maxResults=123
)
dict
A filter to apply to the list of integrations.
provider (string) --
Filter integrations by provider.
providerType (string) --
Filter integrations by provider type.
string
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.
integer
The maximum number of results to return in a single call.
dict
Response Syntax
{
'integrationSummaries': [
{
'integrationId': 'string',
'installationId': 'string',
'provider': 'GITHUB'|'GITLAB'|'BITBUCKET'|'CONFLUENCE'|'AZURE_DEVOPS'|'JIRA',
'providerType': 'SOURCE_CODE'|'DOCUMENTATION'|'ISSUE_TRACKING',
'displayName': 'string',
'targetUrl': 'string',
'webhookUrl': 'string',
'privateConnectionName': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
integrationSummaries (list) --
The list of integration summaries.
(dict) --
Contains summary information about an integration.
integrationId (string) --
The unique identifier of the integration.
installationId (string) --
The installation identifier from the integration provider.
provider (string) --
The integration provider.
providerType (string) --
The type of the integration provider.
displayName (string) --
The display name of the integration.
targetUrl (string) --
The HTTPS URL of the customer self-hosted instance, such as a GitHub Enterprise Server or self-managed GitLab instance. This value is absent for SaaS integrations.
webhookUrl (string) --
The payload URL of the integration's webhook, once it has been created. The signing secret is never returned on a read.
privateConnectionName (string) --
The name of the private connection used to reach the integration's self-hosted instance over private networking, if one is configured.
nextToken (string) --
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.
{'items': {'capabilities': {'jira': {'commentIssue': 'boolean',
'createIssue': 'boolean'}},
'resource': {'jiraProject': {'name': 'string',
'projectId': 'string',
'projectKey': 'string',
'projectName': 'string'}}}}
Updates the integrated resources for an agent space, including their capabilities.
See also: AWS API Documentation
Request Syntax
client.update_integrated_resources(
agentSpaceId='string',
integrationId='string',
items=[
{
'resource': {
'githubRepository': {
'name': 'string',
'owner': 'string'
},
'gitlabRepository': {
'name': 'string',
'namespace': 'string'
},
'bitbucketRepository': {
'name': 'string',
'workspace': 'string'
},
'confluenceDocument': {
'name': 'string',
'spaceKey': 'string',
'pageId': 'string',
'title': 'string',
'spaceTitle': 'string'
},
'azureDevOpsRepository': {
'name': 'string',
'organization': 'string',
'project': 'string'
},
'jiraProject': {
'name': 'string',
'projectKey': 'string',
'projectId': 'string',
'projectName': 'string'
}
},
'capabilities': {
'github': {
'triggerFilterGroups': [
{
'events': [
'PULL_REQUEST_READY_FOR_REVIEW'|'PULL_REQUEST_DRAFT'|'PULL_REQUEST_LABEL_ADDED',
],
'filters': [
{
'type': 'TARGET_BRANCH'|'LABEL',
'patterns': [
'string',
],
'matchMode': 'INCLUDE'|'EXCLUDE'
},
]
},
],
'leaveComments': True|False,
'remediateCode': True|False
},
'gitlab': {
'triggerFilterGroups': [
{
'events': [
'PULL_REQUEST_READY_FOR_REVIEW'|'PULL_REQUEST_DRAFT'|'PULL_REQUEST_LABEL_ADDED',
],
'filters': [
{
'type': 'TARGET_BRANCH'|'LABEL',
'patterns': [
'string',
],
'matchMode': 'INCLUDE'|'EXCLUDE'
},
]
},
],
'leaveComments': True|False,
'remediateCode': True|False
},
'bitbucket': {
'triggerFilterGroups': [
{
'events': [
'PULL_REQUEST_READY_FOR_REVIEW'|'PULL_REQUEST_DRAFT'|'PULL_REQUEST_LABEL_ADDED',
],
'filters': [
{
'type': 'TARGET_BRANCH'|'LABEL',
'patterns': [
'string',
],
'matchMode': 'INCLUDE'|'EXCLUDE'
},
]
},
],
'leaveComments': True|False,
'remediateCode': True|False
},
'confluence': {
'fetchDocument': True|False,
'createDocument': True|False,
'updateDocument': True|False
},
'azureDevOps': {
'triggerFilterGroups': [
{
'events': [
'PULL_REQUEST_READY_FOR_REVIEW'|'PULL_REQUEST_DRAFT'|'PULL_REQUEST_LABEL_ADDED',
],
'filters': [
{
'type': 'TARGET_BRANCH'|'LABEL',
'patterns': [
'string',
],
'matchMode': 'INCLUDE'|'EXCLUDE'
},
]
},
],
'leaveComments': True|False,
'remediateCode': True|False
},
'jira': {
'createIssue': True|False,
'commentIssue': True|False
}
}
},
]
)
string
[REQUIRED]
The unique identifier of the agent space.
string
[REQUIRED]
The unique identifier of the integration.
list
[REQUIRED]
The list of integrated resource items to update.
(dict) --
Represents an input item for updating integrated resources, including the resource and its capabilities.
resource (dict) -- [REQUIRED]
The integrated resource to update.
githubRepository (dict) --
The GitHub repository resource information.
name (string) -- [REQUIRED]
The name of the GitHub repository.
owner (string) -- [REQUIRED]
The owner of the GitHub repository.
gitlabRepository (dict) --
A GitLab repository integrated as a resource.
name (string) -- [REQUIRED]
Name of the resource e.g. repository name, etc.
namespace (string) -- [REQUIRED]
The namespace (group or user path) that owns the project.
bitbucketRepository (dict) --
A Bitbucket repository integrated as a resource.
name (string) -- [REQUIRED]
Name of the resource e.g. repository name, etc.
workspace (string) -- [REQUIRED]
The workspace slug that owns the repository.
confluenceDocument (dict) --
A Confluence document (page) integrated as a resource.
name (string) -- [REQUIRED]
Name of the resource e.g. repository name, etc.
spaceKey (string) -- [REQUIRED]
The Confluence space key containing the document.
pageId (string) -- [REQUIRED]
The Confluence page identifier.
title (string) --
The display title of the Confluence page.
spaceTitle (string) --
The display title of the Confluence space.
azureDevOpsRepository (dict) --
The Azure DevOps repository resource information.
name (string) -- [REQUIRED]
Name of the resource e.g. repository name, etc.
organization (string) -- [REQUIRED]
The name of the Azure DevOps organization that owns the repository.
project (string) --
The name of the Azure DevOps project that contains the repository.
jiraProject (dict) --
The Jira project resource information.
name (string) -- [REQUIRED]
Name of the resource e.g. repository name, etc.
projectKey (string) -- [REQUIRED]
The Jira project key, for example PROJ.
projectId (string) -- [REQUIRED]
The Jira project identifier.
projectName (string) --
The display name of the Jira project.
capabilities (dict) --
The capabilities to enable for the integrated resource.
github (dict) --
The GitHub-specific resource capabilities.
triggerFilterGroups (list) --
The filter groups that control which pull request events start an automatic code review when leaveComments is enabled. A review starts when any group matches. If you omit this, a review starts on PULL_REQUEST_READY_FOR_REVIEW events.
(dict) --
A set of conditions that start an automatic code review when they all pass. A filter group must include events, filters, or both.
events (list) --
Passes when the pull request event is one of the listed events. If you omit this, the group matches PULL_REQUEST_READY_FOR_REVIEW and PULL_REQUEST_DRAFT events only.
(string) --
A pull request event that can start an automatic code review. For GitLab repositories, pull request refers to a merge request.
filters (list) --
Passes when every filter passes. If you omit this, the group matches its events on any target branch and with any labels.
(dict) --
A condition on a pull request value.
type (string) -- [REQUIRED]
The pull request value to match.
patterns (list) -- [REQUIRED]
The regular expressions to match against the value.
(string) --
A regular expression in RE2 syntax that must match the entire value, for example main or release/.*.
matchMode (string) --
Whether the value must match the patterns. The default is INCLUDE.
leaveComments (boolean) --
Indicates whether the integration can leave comments on pull requests.
remediateCode (boolean) --
Indicates whether the integration can create code remediation pull requests.
gitlab (dict) --
Capabilities for an integrated GitLab repository.
triggerFilterGroups (list) --
The filter groups that control which merge request events start an automatic code review when leaveComments is enabled. A review starts when any group matches. If you omit this, a review starts on PULL_REQUEST_READY_FOR_REVIEW events.
(dict) --
A set of conditions that start an automatic code review when they all pass. A filter group must include events, filters, or both.
events (list) --
Passes when the pull request event is one of the listed events. If you omit this, the group matches PULL_REQUEST_READY_FOR_REVIEW and PULL_REQUEST_DRAFT events only.
(string) --
A pull request event that can start an automatic code review. For GitLab repositories, pull request refers to a merge request.
filters (list) --
Passes when every filter passes. If you omit this, the group matches its events on any target branch and with any labels.
(dict) --
A condition on a pull request value.
type (string) -- [REQUIRED]
The pull request value to match.
patterns (list) -- [REQUIRED]
The regular expressions to match against the value.
(string) --
A regular expression in RE2 syntax that must match the entire value, for example main or release/.*.
matchMode (string) --
Whether the value must match the patterns. The default is INCLUDE.
leaveComments (boolean) --
Whether to post code review comments on merge request discussions.
remediateCode (boolean) --
Whether to create merge requests with automated fixes.
bitbucket (dict) --
Capabilities for an integrated Bitbucket repository.
triggerFilterGroups (list) --
The filter groups that control which pull request events start an automatic code review when leaveComments is enabled. A review starts when any group matches. If you omit this, a review starts on PULL_REQUEST_READY_FOR_REVIEW events.
(dict) --
A set of conditions that start an automatic code review when they all pass. A filter group must include events, filters, or both.
events (list) --
Passes when the pull request event is one of the listed events. If you omit this, the group matches PULL_REQUEST_READY_FOR_REVIEW and PULL_REQUEST_DRAFT events only.
(string) --
A pull request event that can start an automatic code review. For GitLab repositories, pull request refers to a merge request.
filters (list) --
Passes when every filter passes. If you omit this, the group matches its events on any target branch and with any labels.
(dict) --
A condition on a pull request value.
type (string) -- [REQUIRED]
The pull request value to match.
patterns (list) -- [REQUIRED]
The regular expressions to match against the value.
(string) --
A regular expression in RE2 syntax that must match the entire value, for example main or release/.*.
matchMode (string) --
Whether the value must match the patterns. The default is INCLUDE.
leaveComments (boolean) --
Whether to post code review comments on pull requests.
remediateCode (boolean) --
Whether to create pull requests with automated fixes.
confluence (dict) --
Capabilities for an integrated Confluence space.
fetchDocument (boolean) --
Whether to fetch documents from this space.
createDocument (boolean) --
Whether to create documents in this space.
updateDocument (boolean) --
Whether to update documents in this space.
azureDevOps (dict) --
The Azure DevOps-specific resource capabilities.
triggerFilterGroups (list) --
The filter groups that control which pull request events start an automatic code review when leaveComments is enabled. A review starts when any group matches. If you omit this, a review starts on PULL_REQUEST_READY_FOR_REVIEW events.
(dict) --
A set of conditions that start an automatic code review when they all pass. A filter group must include events, filters, or both.
events (list) --
Passes when the pull request event is one of the listed events. If you omit this, the group matches PULL_REQUEST_READY_FOR_REVIEW and PULL_REQUEST_DRAFT events only.
(string) --
A pull request event that can start an automatic code review. For GitLab repositories, pull request refers to a merge request.
filters (list) --
Passes when every filter passes. If you omit this, the group matches its events on any target branch and with any labels.
(dict) --
A condition on a pull request value.
type (string) -- [REQUIRED]
The pull request value to match.
patterns (list) -- [REQUIRED]
The regular expressions to match against the value.
(string) --
A regular expression in RE2 syntax that must match the entire value, for example main or release/.*.
matchMode (string) --
Whether the value must match the patterns. The default is INCLUDE.
leaveComments (boolean) --
Whether to post code review comments on pull requests.
remediateCode (boolean) --
Whether to create pull requests with automated fixes.
jira (dict) --
The Jira-specific resource capabilities.
createIssue (boolean) --
Whether to create issues in the integrated jira project.
commentIssue (boolean) --
Whether to post comments on issues in the integrated jira project.
dict
Response Syntax
{}
Response Structure
(dict) --