aws-samples/amazon-guardduty-alexa-sample

Name: amazon-guardduty-alexa-sample

Owner: AWS Samples

Description: Alexa GuardDuty Sample Skill

Created: 2018-02-14 04:51:26.0

Updated: 2018-05-08 14:40:27.0

Pushed: 2018-05-03 18:26:18.0

Homepage:

Size: 3405

Language: Python

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Ask GuardDuty Sample Alexa Skill

Deploy a sample custom Alexa skill and use an Alexa-enabled device, such as Amazon Echo to obtain information about GuardDuty findings across your AWS accounts and regions. This will enable you to quickly understand current GuardDuty finding statistics and details through the Alexa voice interface. The information provided by this sample skill is intended to give you a broad overview of GuardDuty finding statistics, severities and descriptions. With this information, you may wish to log into the GuardDuty console or another analysis tool to drill further into the findings data.

Note: A basic understanding of Alexa Custom Skills is helpful for deploying the sample skill described in this blog post. If you are not already familiar with Alexa custom skill concepts and terminology, you may want to review the documentation resources.

Solution overview The solution diagram below is followed by a description of the flow of events. The CloudFormation template creates the Lambda function for the sample Alexa skill.

Solution Diagram

Here is how the solution works, as shown in the preceding numbered diagram:

1. The user opens the skill; “Alexa, ask GuardDuty” or “Alexa, open GuardDuty”.
2. After opening the skill, the user states a supported intent, such as “Get flash briefing.”
3. The Alexa service passes the intent and the custom skill uses the Lambda function to call the GuardDuty API and request the information.
4. The GuardDuty service returns the requested information and the Lambda function returns the response to the Alexa service.
5. The Alexa service delivers the audio response via the Alexa-enabled device.

Prerequisites In order to complete the steps in this blog post, make sure you have the following prerequisites:

1. An AWS account with GuardDuty enabled in one or more AWS regions.
2. An Alexa-enabled device, such as an Amazon Echo.
3. An Amazon Developer Account.
4. (Optional) An AWS account configured with Alexa for Business.

Features

• Multi-Region support
• DetectorId auto discovery
• “Ask GuardDuty to get Flash Briefing” powered by get_findings_statistics. Uses an environment variable with comma separated region ids.
• Response provides high / med / low severity labels
• Instance Id / IP redaction
• Help
• Error detection for disabled / regions not configured
• CloudFormation deployment for Lambda component

Intent examples

• Open GuardDuty
• Ask GuardDuty to get Flash Briefing
• Get statistics for Virginia
• Get high severity findings for Oregon
• help

Variables

MAXRESP = os.environ['MAXRESP']

Max number of findings to return. Although 50 can be returned without paginating, keeping this below 15 is a good idea to avoid Alexa size limit and general sanity preservation.

FLASHREGIONS = os.environ['FLASHREGIONS']

Comma separated list of region codes with NO spaces to include in flash briefing stats. Make sure GuardDuty is enabled in regions declared

Deployment into Personal Amazon Developer Account

1. Deploy CloudFormation Template.
2. Go to Amazon Dev Console
3. Click Create Skill.
4. For the name, enter Ask Amazon GuardDuty and click Next.
5. Paste Skill JSON into Skill Builder JSON Editor in Build. Save / Build
6. Get Outputs: AlexaAskGDSkillArn from stack and paste into Lambda Default Region endpoint field in the skill Endpoint. Save
7. Test with Alexa-enabled device.

Note: Since you are not publishing this skill, you do not need to complete the Launch section of the configuration. The skill will remain in the Development status and will only be available for Alexa devices linked to the Amazon developer account used to create the skill. Anyone with physical access to the linked Alexa-enabled device can use the custom skill. As a best practice, we recommend that you delete the Lambda trigger created by the CloudFormation template and add a new one with Skill ID verification enabled. Learn more. You can also deploy this sample skill using Alexa for Business. For more info, check out Alexa for Business Deployment

License

This library is licensed under the Apache 2.0 License.