Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Preferences
Contact Us
Feedback
AWS Documentation
Create an AWS Account

Connecting Amazon Q Business to Jira using APIs

PDF
RSS
Focus mode
Connecting Amazon Q Business to Jira using APIs - Amazon Q Business
Jira configuration propertiesJira JSON schema

You use the CreateDataSource action to connect a data source to your Amazon Q application.

Then, you use the configuration parameter to provide a JSON blob that conforms the AWS-defined JSON schema.

For an example of the API request, see CreateDataSource in the Amazon Q API Reference.

Jira configuration properties

The following provides information about important configuration properties required in the schema.

Configuration Description Type Required

connectionConfiguration

 Configuration information for the endpoint for the data source.

object

This property has the following sub-property: repositoryEndpointMetadata.

 Yes

repositoryEndpointMetadata

 The endpoint information for the data source.

object

This property has the following sub-property: jiraAccountUrl.

 Yes

jiraAccountUrl

 Enter the Jira account URL from your Jira account settings. For example, https://company.atlassian.net/.

string

 Yes

repositoryConfigurations

 Configuration information for the content of the data source. For example, configuring specific types of content and field mappings.

object

This property has the following sub-properties: project, attachment, comment, issue, worklog.

 Yes

  • project

  • attachment

  • comment

  • issue

  • worklog

 A list of objects that map the attributes or field names of your Jira pages and assets to Amazon Q index field names.

object

These properties have the following sub-properties.

  • indexFieldName

  • indexFieldType

  • dataSourceFieldName

  • dateFieldFormat

 Yes

indexFieldName

 The field name of your Jira project, attachment, comment, issue, or worklog.

string

 Yes

indexFieldType

 The field type of your Jira project, attachment, comment, issue, or worklog.

string

The allowed values are STRING, STRING_LIST, and DATE.

 Yes

dataSourceFieldName

 The data source field name of your Jira project, attachment, comment, issue, or worklog.

string

 Yes

dateFieldFormat

 The date format of your Jira project, attachment, comment, issue, or worklog.

string

Specify the date format in the form yyyy-MM-dd'T'HH:mm:ss'Z'

 No

additionalProperties

 Additional configuration options for your content in your data source.

object

This property has the following sub-properties:

  • isCrawlAcl

  • isRotateSecret

  • issuetype

  • status

  • fieldForUserId

  • maxFileSizeInMegaBytes

  • project

  • issueSubEntityFilter

  • inclusionPatterns

  • exclusionPatterns

 Yes

isCrawlAcl

 Specify true to crawl access control information from documents.
Note

Amazon Q Business crawls ACL information by default to ensure responses are generated only from documents your end users have access to. See Authorization for more details.

boolean

 No

isRotateSecret

 Specify true if you want to automatically rotate the secret.

boolean

 No

issuetype

 Customize the issue types to crawl.

array

The allowed values are Bug, Story, Epic, Task.

 No

  • status

  • project

  • issueSubEntityFilter

 Customize the status types, projects, and additional elements to crawl.

array

 No

maxFileSizeInMegaBytes

 Specify the maximum single file size limit in MBs that Amazon Q will crawl. Amazon Q will crawl only the files within the size limit you define. The default file size is 50MB. The maximum file size should be greater than 0MB and less than or equal to 50MB.

string

 No

fieldForUserId

 Specify field to use for UserId for ACL crawling.

string

 No

inclusionPatterns

 A list of regular expression patterns to include specific content in your Jira data source. Content that matches the patterns are included in the index. Contents that doesn't match the pattern are excluded from the index. If any content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence, and the content isn't included in the index.

array

 No

exclusionPatterns

 A list of regular expression patterns to exclude specific content in your Jira data source. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns are included in the index. If any content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence, and the content isn't included in the index.

array

 No

type

 The type of data source. Specify JIRA as your data source type.

string

 Yes

enableIdentityCrawler

 Specify true to use the Amazon Q identity crawler to sync identity/principal information on users and groups with access to specific documents.
Note

Amazon Q Business crawls identity information from your data source by default to ensure responses are generated only from documents end users have access to. For more information, see Identity crawler.

boolean

 Yes

syncMode

Specify whether Amazon Q should update your index by syncing all documents or only new, modified, and deleted documents.

string

You can choose between the following options:

  • Use FORCED_FULL_CRAWL to freshly re-crawl all content and replace existing content each time your data source syncs with your index

  • Use FULL_CRAWL to incrementally crawl only new, modified, and deleted content each time your data source syncs with your index

  • Use CHANGE_LOG to incrementally crawl only new and modified content each time your data source syncs with your index.

 Yes

secretArn

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key-value pairs required to connect to your Jira.

string

The secret must contain a JSON structure with the following keys:

{
    "Jira ID": "Jira user name or email host URL",
    "Password/Token": "Jira API token"
}
 Yes

version

 The version of this template that's currently supported.

string

 No

Jira JSON schema

You use the CreateDataSource action to connect a data source to your Amazon Q application.

Then, you use the configuration parameter to provide a JSON blob that conforms the AWS-defined JSON schema.

For an example of the API request, see CreateDataSource in the Amazon Q API Reference.

Jira configuration properties

The following provides information about important configuration properties required in the schema.

Configuration Description Type Required

connectionConfiguration

 Configuration information for the endpoint for the data source.

object

This property has the following sub-property: repositoryEndpointMetadata.

 Yes

repositoryEndpointMetadata

 The endpoint information for the data source.

object

This property has the following sub-property: jiraAccountUrl.

 Yes

jiraAccountUrl

 Enter the Jira account URL from your Jira account settings. For example, https://company.atlassian.net/.

string

 Yes

repositoryConfigurations

 Configuration information for the content of the data source. For example, configuring specific types of content and field mappings.

object

This property has the following sub-properties: project, attachment, comment, issue, worklog.

 Yes

  • project

  • attachment

  • comment

  • issue

  • worklog

 A list of objects that map the attributes or field names of your Jira pages and assets to Amazon Q index field names.

object

These properties have the following sub-properties.

  • indexFieldName

  • indexFieldType

  • dataSourceFieldName

  • dateFieldFormat

 Yes

indexFieldName

 The field name of your Jira project, attachment, comment, issue, or worklog.

string

 Yes

indexFieldType

 The field type of your Jira project, attachment, comment, issue, or worklog.

string

The allowed values are STRING, STRING_LIST, and DATE.

 Yes

dataSourceFieldName

 The data source field name of your Jira project, attachment, comment, issue, or worklog.

string

 Yes

dateFieldFormat

 The date format of your Jira project, attachment, comment, issue, or worklog.

string

Specify the date format in the form yyyy-MM-dd'T'HH:mm:ss'Z'

 No

additionalProperties

 Additional configuration options for your content in your data source.

object

This property has the following sub-properties:

  • isCrawlAcl

  • isRotateSecret

  • issuetype

  • status

  • fieldForUserId

  • maxFileSizeInMegaBytes

  • project

  • issueSubEntityFilter

  • inclusionPatterns

  • exclusionPatterns

 Yes

isCrawlAcl

 Specify true to crawl access control information from documents.
Note

Amazon Q Business crawls ACL information by default to ensure responses are generated only from documents your end users have access to. See Authorization for more details.

boolean

 No

isRotateSecret

 Specify true if you want to automatically rotate the secret.

boolean

 No

issuetype

 Customize the issue types to crawl.

array

The allowed values are Bug, Story, Epic, Task.

 No

  • status

  • project

  • issueSubEntityFilter

 Customize the status types, projects, and additional elements to crawl.

array

 No

maxFileSizeInMegaBytes

 Specify the maximum single file size limit in MBs that Amazon Q will crawl. Amazon Q will crawl only the files within the size limit you define. The default file size is 50MB. The maximum file size should be greater than 0MB and less than or equal to 50MB.

string

 No

fieldForUserId

 Specify field to use for UserId for ACL crawling.

string

 No

inclusionPatterns

 A list of regular expression patterns to include specific content in your Jira data source. Content that matches the patterns are included in the index. Contents that doesn't match the pattern are excluded from the index. If any content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence, and the content isn't included in the index.

array

 No

exclusionPatterns

 A list of regular expression patterns to exclude specific content in your Jira data source. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns are included in the index. If any content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence, and the content isn't included in the index.

array

 No

type

 The type of data source. Specify JIRA as your data source type.

string

 Yes

enableIdentityCrawler

 Specify true to use the Amazon Q identity crawler to sync identity/principal information on users and groups with access to specific documents.
Note

Amazon Q Business crawls identity information from your data source by default to ensure responses are generated only from documents end users have access to. For more information, see Identity crawler.

boolean

 Yes

syncMode

Specify whether Amazon Q should update your index by syncing all documents or only new, modified, and deleted documents.

string

You can choose between the following options:

  • Use FORCED_FULL_CRAWL to freshly re-crawl all content and replace existing content each time your data source syncs with your index

  • Use FULL_CRAWL to incrementally crawl only new, modified, and deleted content each time your data source syncs with your index

  • Use CHANGE_LOG to incrementally crawl only new and modified content each time your data source syncs with your index.

 Yes

secretArn

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key-value pairs required to connect to your Jira.

string

The secret must contain a JSON structure with the following keys:

{
    "Jira ID": "Jira user name or email host URL",
    "Password/Token": "Jira API token"
}
 Yes

version

 The version of this template that's currently supported.

string

 No

Jira JSON schema

The following is the Jira JSON schema:

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "pattern": "JIRA"
    },
    "syncMode": {
      "type": "string",
      "enum": ["FULL_CRAWL", "FORCED_FULL_CRAWL", "CHANGE_LOG"]
    },
    "secretArn": {
      "type": "string",
      "minLength": 20,
      "maxLength": 2048
    },
    "enableIdentityCrawler": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "string",
          "enum": ["true", "false"]
        }
      ]
    },
    "connectionConfiguration": {
      "type": "object",
      "properties": {
        "repositoryEndpointMetadata": {
          "type": "object",
          "properties": {
            "jiraAccountUrl": {
              "type": "string",
              "pattern": "https://.*"
            }
          },
          "required": ["jiraAccountUrl"]
        }
      },
      "required": ["repositoryEndpointMetadata"]
    },
    "repositoryConfigurations": {
      "type": "object",
      "properties": {
        "attachment": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": ["STRING", "STRING_LIST", "DATE"]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": ["fieldMappings"]
        },
        "comment": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": ["STRING", "STRING_LIST", "DATE"]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": ["fieldMappings"]
        },
        "issue": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": ["STRING", "STRING_LIST", "DATE"]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": ["fieldMappings"]
        },
        "project": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": ["STRING", "STRING_LIST", "DATE"]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": ["fieldMappings"]
        },
        "worklog": {
          "type": "object",
          "properties": {
            "fieldMappings": {
              "type": "array",
              "items": [
                {
                  "type": "object",
                  "properties": {
                    "indexFieldName": {
                      "type": "string"
                    },
                    "indexFieldType": {
                      "type": "string",
                      "enum": ["STRING", "STRING_LIST", "DATE"]
                    },
                    "dataSourceFieldName": {
                      "type": "string"
                    },
                    "dateFieldFormat": {
                      "type": "string",
                      "pattern": "yyyy-MM-dd'T'HH:mm:ss'Z'"
                    }
                  },
                  "required": [
                    "indexFieldName",
                    "indexFieldType",
                    "dataSourceFieldName"
                  ]
                }
              ]
            }
          },
          "required": ["fieldMappings"]
        }
      }
    },
    "additionalProperties": {
      "type": "object",
      "properties": {
        "isCrawlAcl": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "string",
              "enum": ["true", "false"]
            }
          ]
        },
        "maxFileSizeInMegaBytes": {
          "type": "string"
        },
        "fieldForUserId": {
          "type": "string"
        },
        "issuetype": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": ["Bug", "Story", "Epic", "Task"]
          }
        },
        "status": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "project": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "issueSubEntityFilter": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inclusionPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "exclusionPatterns": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "enableDeletionProtection": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "string",
              "enum": ["true", "false"]
            }
          ],
          "default": false
        },
        "deletionProtectionThreshold": {
          "type": "string",
          "default": "15"
        }
      },
      "required": []
    },
    "version": {
      "type": "string",
      "anyOf": [
        {
          "pattern": "1.0.0"
        }
      ]
    }
  },
  "required": [
    "type",
    "syncMode",
    "secretArn",
    "enableIdentityCrawler",
    "connectionConfiguration",
    "repositoryConfigurations",
    "additionalProperties"
  ]
}

Jira JSON schema example

The following is the Jira JSON schema example:

{
  "type": "JIRA",
  "syncMode": "FULL_CRAWL",
  "secretArn": "arn:aws:secretsmanager:us-west-2:123456789012:secret:my-jira-secret",
  "enableIdentityCrawler": "true",
  "connectionConfiguration": {
    "repositoryEndpointMetadata": {
      "jiraAccountUrl": "https://mycompany.atlassian.net"
    }
  },
  "repositoryConfigurations": {
    "attachment": {
      "fieldMappings": [
        {
          "indexFieldName": "attachment_id",
          "indexFieldType": "STRING",
          "dataSourceFieldName": "id",
          "dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'"
        }
      ]
    },
    "comment": {
      "fieldMappings": [
        {
          "indexFieldName": "comment_body",
          "indexFieldType": "STRING",
          "dataSourceFieldName": "body",
          "dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'"
        }
      ]
    },
    "issue": {
      "fieldMappings": [
        {
          "indexFieldName": "issue_key",
          "indexFieldType": "STRING",
          "dataSourceFieldName": "key",
          "dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'"
        }
      ]
    },
    "project": {
      "fieldMappings": [
        {
          "indexFieldName": "project_name",
          "indexFieldType": "STRING",
          "dataSourceFieldName": "name",
          "dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'"
        }
      ]
    },
    "worklog": {
      "fieldMappings": [
        {
          "indexFieldName": "worklog_time_spent",
          "indexFieldType": "STRING",
          "dataSourceFieldName": "timeSpent",
          "dateFieldFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'"
        }
      ]
    }
  },
  "additionalProperties": {
    "isCrawlAcl": "true",
    "maxFileSizeInMegaBytes": "50",
    "fieldForUserId": "user_id",
    "issuetype": ["Bug", "Story"],
    "status": ["Open", "In Progress"],
    "project": ["Project1", "Project2"],
    "issueSubEntityFilter": ["SubEntity1"],
    "inclusionPatterns": ["*"],
    "exclusionPatterns": ["*.tmp"],
    "enableDeletionProtection": "false",
    "deletionProtectionThreshold": "15"
  }
}

On this page

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.