Within the period of AI and machine studying (ML), there’s a rising emphasis on enhancing safety— particularly in IT contexts. On this submit, we reveal how your group can cut back the end-to-end burden of resolving common challenges skilled by your IT assist groups—from understanding errors and reviewing diagnoses, remediation steps, and related documentation, to opening exterior assist tickets utilizing frequent third-party providers comparable to Jira.
We present how Amazon Q Enterprise can streamline your end-to-end troubleshooting processes by utilizing your preexisting documentation and ticketing techniques whereas approaching advanced IT points in a conversational dialogue. This resolution illustrates the advantages of incorporating Amazon Q as a supplemental instrument in your IT stack.
Advantages of Amazon Q Enterprise
The next are some related advantages of Amazon Q Enterprise:
- Scalability – As an AWS cloud-based service, Amazon Q is very scalable and in a position to deal with quite a few concurrent requests from a number of workers with out efficiency degradation. This makes it appropriate for organizations with a big IT division consisting of many workers who intend to make use of Amazon Q as an clever agent assistant.
- Elevated productiveness – As a result of Amazon Q can deal with a big quantity of buyer inquiries concurrently, this frees up human workers (comparable to IT assist engineers) to concentrate on extra advanced or specialised duties, thereby bettering total productiveness.
- Pure language understanding (NLU) – Customers can work together with the Amazon Q Enterprise utility utilizing pure language (comparable to English). This permits extra pure and intuitive conversational experiences with out requiring your brokers to study new APIs or languages.
- Customization and personalization – Builders can customise the information base and responses to cater to the precise wants of their utility and customers, enabling extra customized experiences. On this submit, we focus on an IT assist use case for Amazon Q Enterprise and the best way to configure it to index and search customized audit logs.
Answer overview
Our use case focuses on the challenges round troubleshooting, particularly inside techniques and functions for IT assist and assist desk operations. We use Amazon Q Enterprise to coach on our inner documentation and runbooks to create a tailor-made Amazon Q utility that gives customized directions, supply hyperlinks to related documentation, and seamless integration with ticketing providers like Jira for escalation necessities. Our aim is to cut back the effort and time required for IT assist groups and others to diagnose challenges, assessment runbooks for remediation, and automate the escalation and ticketing course of.
The next diagram illustrates the answer structure.
The answer consists of the next key integrations:
- Jira plugin – Amazon Q Enterprise helps integration with Jira; you need to use the AI assistant UI to look, learn, create, and delete Jira tickets. Adjustments made utilizing this plugin by Amazon Q can then be considered inside your Jira console.
- Internet crawling – Amazon Q Enterprise makes use of net crawlers to index and ingest product documentation web sites, ensuring that the most recent info is obtainable for answering queries.
- Amazon S3 connector – Organizations can add product paperwork on to Amazon Easy Storage Service (Amazon S3), enabling Amazon Q Enterprise to entry and incorporate this info into its information base.
- Jira information supply – In case your Jira setting hardly ever adjustments, or if you wish to have extra granular management over Amazon Q interactions with Jira, then you need to use Jira as a easy information supply. Right here, Amazon Q may have read-only entry to Jira.
Stipulations
As a prerequisite to deploying this resolution, you will have to arrange Jira and Confluence utilizing an Atlassian account. If you have already got these arrange, you need to use your current account. In any other case, you’ll be able to create an Atlassian account and arrange Jira and Confluence utilizing the free model.
- Join along with your electronic mail or by way of a social id supplier. In the event you join utilizing electronic mail, you could confirm your electronic mail by way of a One Time Password (OTP).
- Enter a reputation to your website and select Proceed.
- Select Different and select Proceed.
- If requested for a beginning template, you’ll be able to select the Undertaking administration template and select Begin now.
- Enter a reputation to your challenge and select Get began.
Your UI ought to now appear to be the next screenshot.
Now you’ve created an Atlassian account and Jira challenge.
For instance functions, we created a couple of duties inside the Jira console. We’ll come again to those later.
Create an Amazon Q utility
You at the moment are able to create an Amazon Q utility:
- Check in to your AWS account on the AWS Administration Console and set your most popular AWS Area.
- Open the Amazon Q console.
- In the event you haven’t already, full the steps to hook up with AWS IAM Id Heart, creating both a corporation occasion or account occasion.
After you’ve accomplished your configuration of IAM Id Heart and linked it inside Amazon Q, it’s best to see the next success message on the Amazon Q console.
- On the Amazon Q Enterprise console, select Functions within the navigation pane, then select Create an utility.
- For Software identify, enter a reputation (for instance,
QforITTeams
). - Go away the remaining choices as default and select Subsequent.
- You have got the selection of choosing an current Amazon Kendra retriever or utilizing the Amazon Q native retriever. For extra info on the retriever choices, see Creating an index for an Amazon Q Enterprise utility. For this submit, we use the native retriever.
- Maintain the opposite default choices and select Subsequent.
Amazon Q provides a collection of default information sources so that you can select from, together with Amazon S3, Amazon Relational Database Service (Amazon RDS), Slack, Salesforce, Confluence, code repositories in GitHub, on-premises shops (comparable to IBM DB2), and extra. For our pattern arrange, we’re utilizing pattern AWS Effectively-Architected documentation, for which we are able to use an online crawler. We additionally wish to use some pattern runbooks (we’ve got already generated and uploaded these to an S3 bucket).
Let’s arrange our Amazon S3 information supply first.
- For Add an information supply, select Amazon S3.
- Beneath Identify and outline, enter a reputation and outline.
- Full the steps so as to add your Amazon S3 information supply. For our use case, we create a brand new AWS Id and Entry Administration (IAM) service function in response to the AWS suggestions for traditional use circumstances. AWS will mechanically propagate the function for us following the precept of least privilege.
- After you add the information supply, run the sync by selecting Sync now.
Wait 5–10 minutes to your information to complete syncing to Amazon Q.
Now let’s add our net crawler and hyperlink to some AWS Effectively-Architected documentation.
- Add a second information supply and select Internet crawlers.
- Beneath Supply, choose Supply URLs and enter the supply URLs you wish to crawl.
For this use case, we entered some hyperlinks to public AWS documentation; you’ve the choice to configure authentication and an online proxy so as to crawl intranet paperwork as effectively.
- After you create the information supply, select Sync now to run the sync.
Add an IAM Id Heart person
Whereas our information sources are busy syncing, let’s create an IAM Id Heart person for us to check the Amazon Q Enterprise utility net expertise:
- On the Amazon Q Enterprise console, navigate to your utility.
- Beneath Teams and customers, select Handle entry and subscriptions, and select Add teams and customers.
- Choose Add new customers and select Subsequent.
- After you create the person, you’ll be able to add it by selecting Assign current customers and teams and looking for the person by first identify.
- After you add the person, you’ll be able to edit their subscription entry. We improve our person’s entry to Q Enterprise Professional for our testing.
Deploy the net expertise
After the information sources have accomplished their sync, you’ll be able to transfer to the testing stage to substantiate issues are working up to now:
- On the Amazon Q Enterprise console, select Functions within the navigation pane.
- Choose your utility and select Deploy net expertise.
- On the applying particulars web page, select Customise net expertise.
- Customise the title, subtitle, and welcome message as wanted, then select Save.
- Select View net expertise.
Let’s take a look at some prompts on the information that our Amazon Q utility has seen.
First, let’s ask some questions across the supplied runbooks saved in our S3 bucket that we beforehand added as an information supply to our utility. Within the following instance, we ask about info for restarting an Amazon Elastic Compute Cloud (Amazon EC2) occasion.
As proven within the following screenshot, Amazon Q has not solely answered our query, but it surely additionally cited its supply for us, offering a hyperlink to the .txt file that accommodates the runbook for Restarting an EC2 Occasion.
Let’s ask a query concerning the Effectively-Architected webpages that we crawled. For this question, we are able to ask if there’s a instrument we are able to use to enhance our AWS structure. The next screenshot reveals the reply.
Arrange Jira as an information supply
On this part, we arrange Jira as an information supply for our Amazon Q utility. It will enable Amazon Q to look information in Jira. For directions, see Connecting Jira to Amazon Q Enterprise.
After you’ve arrange Jira as an information supply, take a look at out your Amazon Q Enterprise utility. Go to the net expertise chat interface URL and ask it about one in every of your Jira tickets. The next screenshot reveals an instance.
Arrange a Jira plugin
What for those who encounter a state of affairs the place your person, an IT assist skilled, can’t discover the answer with the supplied inner paperwork and runbooks that Amazon Q has been skilled on? The next step could be to open a ticket in Jira. Let’s add a plugin for Jira that permits you to submit a Jira ticket by way of the Amazon Q chat interface. For extra particulars, see Configuring a Jira Cloud plugin for Amazon Q Enterprise. Within the earlier part, we added Jira as an information supply, permitting Amazon Q to look information contained in Jira. By including Jira as a plugin, we are going to enable Amazon Q to carry out actions inside Jira.
Full the next steps so as to add the Jira plugin:
- On the Amazon Q Enterprise console, navigate to your utility.
- Select Plugins within the navigation pane.
- Select Add plugin.
- For Plugin identify, enter a reputation.
- For Area URL, enter
https://api.atlassian.com/ex/jira/yourInstanceID
, the place the worth ofyourInstanceID
is the worth athttps://my-site-name.atlassian.web/_edge/tenant_info
. - For OAuth2.0, choose Create a brand new secret, and enter your Jira shopper ID and shopper secret.
In the event you require help retrieving these values, seek advice from the conditions.
- Full creating your plugin.
After you’ve created the plugin, return to the applying net expertise to attempt it out. The primary time you employ the Jira plugin inside the Amazon Q chat interface, you could be requested to authorize entry. The request will look just like the next screenshots.
After you present Amazon Q authorization to entry Jira, you’re prepared to check out the plugin.
First, let’s ask Amazon Q to create some draft textual content for our ticket.
Subsequent, we ask Amazon Q to make use of this context to create a activity in Jira. That is the place we use the plugin. Select the choices menu (three dots) subsequent to the chat window and select the Jira plugin.
Ask it to generate a Jira activity. Amazon Q will mechanically acknowledge the dialog and enter its information inside the Jira ticket template for you, as proven within the following screenshot. You’ll be able to customise the fields as wanted and select Submit.
You must obtain a response just like the next screenshot.
Amazon Q has created a brand new activity for us in Jira. We are able to affirm that by viewing our Jira console. There’s a activity for updating the IT runbooks to fulfill catastrophe restoration goals.
If we open that activity, we are able to affirm that the knowledge supplied matches the knowledge we handed to the Jira plugin.
Now, let’s take a look at out retrieving an current ticket and modifying it. Within the following screenshot, Amazon Q is ready to search by way of our Jira Points and appropriately establish the precise activity we have been referring to.
We are able to ask Amazon Q about some attainable actions we are able to take.
Let’s ask Amazon Q to maneuver the duty to the “In Progress” stage.
The next screenshot reveals the up to date view of our Jira duties on the Jira console. The ticket for debugging the Amazon DynamoDB utility has been moved to the In Progress stage.
Now, suppose we wished to view extra info for this activity. We are able to merely ask Amazon Q. This protects us the difficulty of getting to navigate our approach across the Jira UI.
Amazon Q is even in a position to extract metadata concerning the ticket, comparable to last-updated timestamps, its creator, and different elements.
You may also delete duties in Jira utilizing the Amazon Q chat interface. The next is an instance of deleting the DynamoDB ticket. You’ll be prompted to substantiate the duty ID (key). The duty will probably be deleted after you affirm.
Now, if we view our Jira console, the corresponding activity is gone.
Clear up
To scrub up the sources that you’ve got provisioned, full the next steps:
- Empty and delete any S3 buckets you created.
- Downgrade your IAM Id Heart person subscription to Amazon Q.
- Delete any Amazon Q associated sources, together with your Amazon Q Enterprise utility.
- Delete any extra providers or storage provisioned throughout your assessments.
Conclusion
On this submit, we configured IAM Id Heart for Amazon Q and created an Amazon Q utility with connectors to Amazon S3, net crawlers, and Jira. We then personalized our Amazon Q utility for a use case concentrating on IT specialists, and we despatched some take a look at prompts to assessment our runbooks for problem decision in addition to to get solutions to questions relating to AWS Effectively-Architected practices. We additionally added a plugin for Jira in order that IT assist groups can create Jira points and tickets mechanically with Amazon Q, taking into consideration the complete context of our dialog.
Check out Amazon Q Enterprise to your personal use case, and share your suggestions within the feedback. For extra details about utilizing Amazon Q Enterprise with Jira, see Enhance the productiveness of your buyer assist and challenge administration groups utilizing Amazon Q Enterprise and Atlassian Jira.
Concerning the Authors
Dylan Martin is a Options Architect (SA) at Amazon Internet Companies based mostly within the Seattle space. Dylan focuses on creating Generative AI options for brand new service and have launches. Exterior of labor, Dylan enjoys motorcycling and learning languages.
Ankit Patel is a Options Developer at AWS based mostly within the NYC space. As a part of the Prototyping and Buyer Engineering (PACE) staff, he helps prospects convey their modern concepts to life by fast prototyping; utilizing the AWS platform to construct, orchestrate, and handle customized functions.