Querying inventory data from multiple Regions and accounts - AWS Systems Manager

Querying inventory data from multiple Regions and accounts

AWS Systems Manager Inventory integrates with Amazon Athena to help you query inventory data from multiple AWS Regions and AWS accounts. Athena integration uses resource data sync so that you can view inventory data from all of your managed nodes on the Detailed View page in the AWS Systems Manager console.

Important

This feature uses AWS Glue to crawl the data in your Amazon Simple Storage Service (Amazon S3) bucket, and Amazon Athena to query the data. Depending on how much data is crawled and queried, you can be charged for using these services. With AWS Glue, you pay an hourly rate, billed by the second, for crawlers (discovering data) and ETL jobs (processing and loading data). With Athena, you're charged based on the amount of data scanned by each query. We encourage you to view the pricing guidelines for these services before you use Amazon Athena integration with Systems Manager Inventory. For more information, see Amazon Athena pricing and AWS Glue pricing.

You can view inventory data on the Detailed View page in all AWS Regions where Amazon Athena is available. For a list of supported Regions, see Amazon Athena Service Endpoints in the Amazon Web Services General Reference.

Before you begin

Athena integration uses resource data sync. You must set up and configure resource data sync to use this feature. For more information, see Configuring resource data sync for Inventory.

Also, be aware that the Detailed View page displays inventory data for the owner of the central Amazon S3 bucket used by resource data sync. If you aren't the owner of the central Amazon S3 bucket, then you won't see inventory data on the Detailed View page.

Configuring access

Before you can query and view data from multiple accounts and Regions on the Detailed View page in the Systems Manager console, you must configure your AWS Identity and Access Management (IAM) user account with permission to view the data.

Optionally, if the inventory data is stored in an Amazon S3 bucket that uses AWS Key Management Service (AWS KMS) encryption, you must also configure your IAM account and the Amazon-GlueServiceRoleForSSM service role for AWS KMS encryption. If you don't configure your IAM account and this role, Systems Manager displays Cannot load Glue tables when you choose the Detailed View tab in the console.

Configuring your IAM user account to access the Detailed View page

The following procedure describes how to use the IAM console to configure your IAM user account so that you can view inventory data on the Detailed View page.

To configure IAM user account access to the Detailed View page

  1. Open the IAM console at https://console.aws.amazon.com/iam/.

  2. In the navigation pane, choose Users, and then choose the user account you want to configure. The Summary page opens.

  3. On the Permissions tab, choose Add permissions.

  4. On the Grant permissions page, choose Attach existing policies directly.

  5. In the Search field, search for AWSQuicksightAthenaAccess.

  6. Choose the option next to this policy, and then choose Next: Review.

  7. Choose Add permissions.

  8. Choose the user name again to return to the Summary page.

  9. Now add an inline policy so that AWS Glue can crawl your inventory data. On the Permissions tab, choose Add inline policy. The Create policy page opens.

  10. Choose the JSON tab.

  11. Delete the existing JSON text in the editor, and then copy and paste the following policy into the JSON editor.

    { "Version": "2012-10-17", "Statement": [ { "Sid": "AllowGlue", "Effect": "Allow", "Action": [ "glue:GetCrawler", "glue:GetCrawlers", "glue:GetTables", "glue:StartCrawler", "glue:CreateCrawler" ], "Resource": "*" }, { "Sid": "iamPassRole", "Effect": "Allow", "Action": "iam:PassRole", "Resource": "*", "Condition": { "StringEquals": { "iam:PassedToService": "glue.amazonaws.com" } } }, { "Sid": "iamRoleCreation", "Effect": "Allow", "Action": [ "iam:CreateRole", "iam:AttachRolePolicy" ], "Resource": "arn:aws:iam::account_ID:role/*" }, { "Sid": "iamPolicyCreation", "Effect": "Allow", "Action": "iam:CreatePolicy", "Resource": "arn:aws:iam::account_ID:policy/*" } ] }
    Note

    (Optional) If the Amazon S3 bucket used to store inventory data is encrypted by using AWS KMS, you must also add the following block to the policy.

    { "Effect": "Allow", "Action": [ "kms:Decrypt" ], "Resource": [ "arn:aws:kms:Region:account_ID:key/key_ARN" ] }

    If you paste this block after the last block in the policy, be sure to separate the blocks with a comma (,).

  12. On the Review Policy page, enter a name in the Name field.

  13. Choose Create policy.

Important

When you choose a resource data sync on the Inventory Detail View page, Systems Manager automatically creates the Amazon-GlueServiceRoleForSSM role. This role allows AWS Glue to access the Amazon S3 bucket for resource data sync. Systems Manager automatically attaches the following policies to the role:

  • Amazon-GlueServicePolicyForSSM-{Amazon S3 bucket name}: This policy allows communication between AWS Glue and Systems Manager Inventory.

  • AWSGlueServiceRole: This is an AWS managed policy that allows access to AWS Glue.

If a policy with the name Amazon-GlueServicePolicyForSSM-{Amazon S3 bucket name} already exists in your IAM user account, and this policy isn't attached to the Amazon-GlueServiceRoleForSSM role, then the system returns an error. To resolve this issue, use the IAM console to verify that the contents of the Amazon-GlueServicePolicyForSSM-{Amazon S3 bucket name} policy match the inline policy in this procedure. Then attach the policy to the Amazon-GlueServiceRoleForSSM role.

(Optional) Configure permissions for viewing AWS KMS encrypted data

If the Amazon S3 bucket used to store inventory data is encrypted by using the AWS Key Management Service (AWS KMS), you must configure your IAM user account and the Amazon-GlueServiceRoleForSSM role with kms:Decrypt permissions for the AWS KMS key. If you don't configure your IAM account and this role, Systems Manager displays Cannot load Glue tables when you choose the Detailed View tab in the console.

Before you begin

To configure your IAM user account with kms:Decrypt permissions for the AWS KMS key, you add the following policy block to your IAM account as an inline policy, as described in the previous procedure (Configuring your IAM user account to access the Detailed View page).

{ "Effect": "Allow", "Action": [ "kms:Decrypt" ], "Resource": [ "arn:aws:kms:Region:account_ID:key/key_ARN" ] }

If you haven't done so already, complete that procedure and add kms:Decrypt permissions for the AWS KMS key.

Use the following procedure to configure the Amazon-GlueServiceRoleForSSM role with kms:Decrypt permissions for the AWS KMS key.

To configure the Amazon-GlueServiceRoleForSSM role with kms:Decrypt permissions

  1. Open the IAM console at https://console.aws.amazon.com/iam/.

  2. In the navigation pane, choose Roles, and then use the search field to locate the Amazon-GlueServiceRoleForSSM role. The Summary page opens.

  3. Use the search field to find the Amazon-GlueServiceRoleForSSM role. Choose the role name. The Summary page opens.

  4. Choose the role name. The Summary page opens.

  5. Choose Add inline policy. The Create policy page opens.

  6. Choose the JSON tab.

  7. Delete the existing JSON text in the editor, and then copy and paste the following policy into the JSON editor.

    { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "kms:Decrypt" ], "Resource": [ "arn:aws:kms:Region:account_ID:key/key_ARN" ] } ] }
  8. Choose Review policy

  9. On the Review Policy page, enter a name in the Name field.

  10. Choose Create policy.

Querying data on the inventory detailed view page

Use the following procedure to view inventory data from multiple AWS Regions and AWS accounts on the Systems Manager Inventory Detailed View page.

Important

The Inventory Detailed View page is only available in AWS Regions that offer Amazon Athena. If the following tabs aren't displayed on the Systems Manager Inventory page, it means Athena isn't available in the Region and you can't use the Detailed View to query data.


                            Displaying Inventory Dashboard | Detailed View | Settings
                                tabs

To view inventory data from multiple Regions and accounts in the AWS Systems Manager console

  1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems-manager/.

  2. In the navigation pane, choose Inventory.

    -or-

    If the AWS Systems Manager home page opens first, choose the menu icon ( ) to open the navigation pane, and then choose Inventory in the navigation pane.

  3. Choose the Detailed View tab.

    
                                Accessing the AWS Systems Manager Inventory Detailed View
                                    page
  4. Choose the resource data sync for which you want to query data.

    
                                Displaying inventory data in the AWS Systems Manager console
  5. In the Inventory Type list, choose the type of inventory data that you want to query, and then press Enter.

    
                                Choosing an inventory type in the AWS Systems Manager console
  6. To filter the data, choose the Filter bar, and then choose a filter option.

    
                                Filtering inventory data in the AWS Systems Manager console

You can use the Export to CSV button to view the current query set in a spreadsheet application such as Microsoft Excel. You can also use the Query History and Run Advanced Queries buttons to view history details and interact with your data in Amazon Athena.

Editing the AWS Glue crawler schedule

AWS Glue crawls the inventory data in the central Amazon S3 bucket twice daily, by default. If you frequently change the types of data to collect on your nodes then you might want to crawl the data more frequently, as described in the following procedure.

Important

AWS Glue charges your AWS account based on an hourly rate, billed by the second, for crawlers (discovering data) and ETL jobs (processing and loading data). Before you change the crawler schedule, view the AWS Glue pricing page.

To change the inventory data crawler schedule

  1. Open the AWS Glue console at https://console.aws.amazon.com/glue/.

  2. In the navigation pane, choose Crawlers.

  3. In the crawlers list, choose the option next to the Systems Manager Inventory data crawler. The crawler name uses the following format:

    AWSSystemsManager-DOC-EXAMPLE-BUCKET-Region-account_ID

  4. Choose Action, and then choose Edit crawler.

  5. In the navigation pane, choose Schedule.

  6. In the Cron expression field, specify a new schedule by using a cron format. For more information about the cron format, see Time-Based Schedules for Jobs and Crawlers in the AWS Glue Developer Guide.

Important

You can pause the crawler to stop incurring charges from AWS Glue. If you pause the crawler, or if you change the frequency so that the data is crawled less often, then the Inventory Detailed View might display data that isn't current.