Add table aws_trusted_advisor_check_summary Closes #1831

aws/plugin.go

@@ -452,6 +452,7 @@ func Plugin(ctx context.Context) *plugin.Plugin {
 			"aws_sts_caller_identity":                                      tableAwsSTSCallerIdentity(ctx),
 			"aws_tagging_resource":                                         tableAwsTaggingResource(ctx),
 			"aws_transfer_server":                                          tableAwsTransferServer(ctx),
+			"aws_trusted_advisor_check_summary":                            tableAwsTrustedAdvisorCheckSummary(ctx),
 			"aws_vpc":                                                      tableAwsVpc(ctx),
 			"aws_vpc_customer_gateway":                                     tableAwsVpcCustomerGateway(ctx),
 			"aws_vpc_dhcp_options":                                         tableAwsVpcDhcpOptions(ctx),

aws/service.go

@@ -125,6 +125,7 @@ import (
 	"github.com/aws/aws-sdk-go-v2/service/ssm"
 	"github.com/aws/aws-sdk-go-v2/service/ssoadmin"
 	"github.com/aws/aws-sdk-go-v2/service/sts"
+	"github.com/aws/aws-sdk-go-v2/service/support"
 	"github.com/aws/aws-sdk-go-v2/service/transfer"
 	"github.com/aws/aws-sdk-go-v2/service/waf"
 	"github.com/aws/aws-sdk-go-v2/service/wafregional"
@@ -1439,6 +1440,20 @@ func SSOAdminClient(ctx context.Context, d *plugin.QueryData) (*ssoadmin.Client,
 	return ssoadmin.NewFromConfig(*cfg), nil
 }
 
+func SupportClient(ctx context.Context, d *plugin.QueryData) (*support.Client, error) {
+// AWS Support is a global service. This means that any endpoint that you use will update your support cases in the Support Center Console.
+// For example, if you use the US East (N. Virginia) endpoint to create a case, you can use the US West (Oregon) or Europe (Ireland) endpoint to add a correspondence to the same case.
+// https://docs.aws.amazon.com/awssupport/latest/user/about-support-api.html#endpoint
+	cfg, err := getClientForDefaultRegion(ctx, d)
+	if err != nil {
+		return nil, err
+	}
+	if cfg == nil {
+		return nil, nil
+	}
+	return support.NewFromConfig(*cfg), nil
+}
+
 func TransferClient(ctx context.Context, d *plugin.QueryData) (*transfer.Client, error) {
 	// AWS Transfer Family
 	cfg, err := getClientForQuerySupportedRegion(ctx, d, transferEndpoint.EndpointsID)

aws/table_aws_trusted_advisor_check_summary.go

@@ -0,0 +1,219 @@
+package aws
+
+import (
+	"context"
+
+	"github.com/aws/aws-sdk-go-v2/aws"
+	"github.com/aws/aws-sdk-go-v2/service/support"
+	"github.com/aws/aws-sdk-go-v2/service/support/types"
+
+	"github.com/turbot/steampipe-plugin-sdk/v5/grpc/proto"
+	"github.com/turbot/steampipe-plugin-sdk/v5/plugin"
+	"github.com/turbot/steampipe-plugin-sdk/v5/plugin/transform"
+)
+
+//// TABLE DEFINITION
+
+func tableAwsTrustedAdvisorCheckSummary(_ context.Context) *plugin.Table {
+	return &plugin.Table{
+		Name:        "aws_trusted_advisor_check_summary",
+		Description: "AWS Trusted Advisor Check Summary",
+		Get: &plugin.GetConfig{
+			KeyColumns: plugin.SingleColumn("check_id"),
+			Hydrate:    getTrustedAdvisorCheckSummary,
+			Tags:       map[string]string{"service": "support", "action": "DescribeTrustedAdvisorCheckSummaries"},
+		},
+		List: &plugin.ListConfig{
+			Hydrate: listTrustedAdvisorCheckSummaries,
+			Tags:    map[string]string{"service": "support", "action": "DescribeTrustedAdvisorChecks"},
+			KeyColumns: plugin.KeyColumnSlice{
+				{
+					Name:    "language",
+					Require: plugin.Required,
+				},
+			},
+		},
+		HydrateConfig: []plugin.HydrateConfig{
+			{
+				Func: getTrustedAdvisorCheckSummary,
+				Tags: map[string]string{"service": "support", "action": "DescribeTrustedAdvisorCheckSummaries"},
+			},
+		},
+		Columns: awsAccountColumns([]*plugin.Column{
+			{
+				Name:        "name",
+				Description: "The display name for the Trusted Advisor check.",
+				Type:        proto.ColumnType_STRING,
+			},
+			{
+				Name:        "check_id",
+				Description: "The unique identifier for the Trusted Advisor check.",
+				Type:        proto.ColumnType_STRING,
+				Transform:   transform.FromField("Id", "CheckId"),
+			},
+			{
+				Name:        "category",
+				Description: "The category of the Trusted Advisor check.",
+				Type:        proto.ColumnType_STRING,
+			},
+			{
+				Name:        "language",
+				Description: "The ISO 639-1 code for the language that you want your checks to appear in.",
+				Type:        proto.ColumnType_STRING,
+				Transform:   transform.FromQual("language"),
+			},
+			{
+				Name:        "description",
+				Description: "The description of the Trusted Advisor check, which includes the alert criteria and recommended operations (contains HTML markup).",
+				Type:        proto.ColumnType_STRING,
+			},
+			{
+				Name:        "status",
+				Description: "The alert status of the check: 'ok' (green), 'warning' (yellow), 'error' (red), or 'not_available'.",
+				Type:        proto.ColumnType_STRING,
+				Hydrate:     getTrustedAdvisorCheckSummary,
+			},
+			{
+				Name:        "timestamp",
+				Description: "The time of the last refresh of the check.",
+				Type:        proto.ColumnType_TIMESTAMP,
+				Hydrate:     getTrustedAdvisorCheckSummary,
+			},
+			{
+				Name:        "resources_flagged",
+				Description: "The number of Amazon Web Services resources that were flagged (listed) by the Trusted Advisor check.",
+				Type:        proto.ColumnType_INT,
+				Hydrate:     getTrustedAdvisorCheckSummary,
+				Transform:   transform.FromField("ResourcesSummary.ResourcesFlagged"),
+			},
+			{
+				Name:        "resources_ignored",
+				Description: "The number of Amazon Web Services resources ignored by Trusted Advisor because information was unavailable.",
+				Type:        proto.ColumnType_INT,
+				Hydrate:     getTrustedAdvisorCheckSummary,
+				Transform:   transform.FromField("ResourcesSummary.ResourcesIgnored"),
+			},
+			{
+				Name:        "resources_processed",
+				Description: "The number of Amazon Web Services resources that were analyzed by the Trusted Advisor check.",
+				Type:        proto.ColumnType_INT,
+				Hydrate:     getTrustedAdvisorCheckSummary,
+				Transform:   transform.FromField("ResourcesSummary.ResourcesProcessed"),
+			},
+			{
+				Name:        "resources_suppressed",
+				Description: "The number of Amazon Web Services resources ignored by Trusted Advisor because they were marked as suppressed by the user.",
+				Type:        proto.ColumnType_INT,
+				Hydrate:     getTrustedAdvisorCheckSummary,
+				Transform:   transform.FromField("ResourcesSummary.ResourcesSuppressed"),
+			},
+			{
+				Name:        "category_specific_summary",
+				Description: "Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.",
+				Type:        proto.ColumnType_JSON,
+				Hydrate:     getTrustedAdvisorCheckSummary,
+			},
+			{
+				Name:        "metadata",
+				Description: "The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the Metadata element of the TrustedAdvisorResourceDetail for the check. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.",
+				Type:        proto.ColumnType_JSON,
+			},
+
+			// Steampipe standard columns
+			{
+				Name:        "title",
+				Description: resourceInterfaceDescription("title"),
+				Type:        proto.ColumnType_STRING,
+				Transform:   transform.FromField("Name"),
+			},
+		}),
+	}
+}
+
+//// LIST FUNCTION
+
+func listTrustedAdvisorCheckSummaries(ctx context.Context, d *plugin.QueryData, _ *plugin.HydrateData) (interface{}, error) {
+	// Create session
+	svc, err := SupportClient(ctx, d)
+	if err != nil {
+		plugin.Logger(ctx).Error("aws_trusted_advisor_check_summary.listTrustedAdvisorCheckSummaries", "client_error", err)
+		return nil, err
+	}
+	if svc == nil {
+		return nil, nil
+	}
+
+	language := d.EqualsQualString("language")
+
+	// Empty check
+	if language == "" {
+		return nil, nil
+	}
+
+	input := &support.DescribeTrustedAdvisorChecksInput{
+		Language: aws.String(language),
+	}
+
+	// List call
+	result, err := svc.DescribeTrustedAdvisorChecks(ctx, input)
+	if err != nil {
+		plugin.Logger(ctx).Error("aws_trusted_advisor_check_summary.listTrustedAdvisorCheckSummaries", "api_error", err)
+		return nil, err
+	}
+
+	for _, check := range result.Checks {
+		d.StreamListItem(ctx, check)
+
+		// Context can be cancelled due to manual cancellation or the limit has been hit
+		if d.RowsRemaining(ctx) == 0 {
+			return nil, nil
+		}
+	}
+
+	return nil, err
+}
+
+//// HYDRATE FUNCTIONS
+
+func getTrustedAdvisorCheckSummary(ctx context.Context, d *plugin.QueryData, h *plugin.HydrateData) (interface{}, error) {
+
+	checkId := ""
+
+	if h.Item != nil {
+		checkSummary := h.Item.(types.TrustedAdvisorCheckDescription)
+		checkId = *checkSummary.Id
+	} else {
+		checkId = d.EqualsQualString("check_id")
+	}
+
+	// Empty check
+	if checkId == "" {
+		return nil, nil
+	}
+
+	// Create session
+	svc, err := SupportClient(ctx, d)
+	if err != nil {
+		plugin.Logger(ctx).Error("aws_trusted_advisor_check_summary.getTrustedAdvisorCheckSummary", "client_error", err)
+		return nil, err
+	}
+	if svc == nil {
+		return nil, nil
+	}
+
+	input := &support.DescribeTrustedAdvisorCheckSummariesInput{
+		CheckIds: []*string{aws.String(checkId)},
+	}
+
+	// Get call
+	result, err := svc.DescribeTrustedAdvisorCheckSummaries(ctx, input)
+	if err != nil {
+		plugin.Logger(ctx).Error("aws_trusted_advisor_check_summary.getTrustedAdvisorCheckSummary", "api_error", err)
+		return nil, err
+	}
+
+	if result != nil && len(result.Summaries) > 0 {
+		return result.Summaries[0], nil
+	}
+	return nil, nil
+}

docs/tables/aws_trusted_advisor_check_summary.md

@@ -0,0 +1,141 @@
+---
+title: "Steampipe Table: aws_trusted_advisor_check_summary - Query AWS Trusted Advisor Check Summaries using SQL"
+description: "A Trusted Advisor check is a specific evaluation or assessment performed by Trusted Advisor in different categories. These checks cover various areas, including cost optimization, security, performance, and fault tolerance. Each check examines a specific aspect of your AWS resources and provides recommendations for improvement."
+---
+
+# Table: aws_trusted_advisor_check_summary - Query AWS Trusted Advisor Check Summaries using SQL
+
+A Trusted Advisor check is a specific evaluation or assessment performed by Trusted Advisor in different categories. These checks cover various areas, including cost optimization, security, performance, and fault tolerance. Each check examines a specific aspect of your AWS resources and provides recommendations for improvement.
+
+## Table Usage Guide
+
+The `aws_trusted_advisor_check_summary` table in Steampipe allows users to query information about AWS Trusted Advisor Check Summaries. These summaries provide insights into the status and details of Trusted Advisor checks, including the check name, check ID, category, description, status, timestamp, and the number of resources flagged, ignored, processed, and suppressed.
+
+**Important Notes**
+- You must specify `language` in a `where` clause in order to use this table.
+- Amazon Web Services Support API currently supports the following languages for Trusted Advisor:
+  - Chinese, Simplified - zh
+  - Chinese, Traditional - zh_TW
+  - English - en
+  - French - fr
+  - German - de
+  - Indonesian - id
+  - Italian - it
+  - Japanese - ja
+  - Korean - ko
+  - Portuguese, Brazilian - pt_BR
+  - Spanish - es
+
+## Examples
+
+### Basic info
+Retrieve basic information about AWS Trusted Advisor Check Summaries, including the check name, check ID, category, description, status, timestamp, and the number of resources flagged.
+
+```sql+postgres
+select
+  name,
+  check_id,
+  category,
+  description,
+  status,
+  timestamp,
+  resources_flagged
+from
+  aws_trusted_advisor_check_summary;
+```
+
+```sql+sqlite
+select
+  name,
+  check_id,
+  category,
+  description,
+  status,
+  timestamp,
+  resources_flagged
+from
+  aws_trusted_advisor_check_summary;
+```
+
+### Get error check summaries
+Retrieve AWS Trusted Advisor Check Summaries with an "error" status. This query helps you identify checks that require attention due to errors.
+
+```sql+postgres
+select
+  name,
+  check_id,
+  category,
+  status
+from
+  aws_trusted_advisor_check_summary
+where
+  status = 'error';
+```
+
+```sql+sqlite
+select
+  name,
+  check_id,
+  category,
+  status
+from
+  aws_trusted_advisor_check_summary
+where
+  status = 'error';
+```
+
+### Get check summaries for the last 5 days
+Retrieve AWS Trusted Advisor Check Summaries from the last 5 days. This query allows you to review recent check summaries and their details.
+
+```sql+postgres
+select
+  name,
+  check_id,
+  description,
+  status,
+  timestamp
+from
+  aws_trusted_advisor_check_summary
+where
+  timestamp >= now() - interval '5 day';
+```
+
+```sql+sqlite
+select
+  name,
+  check_id,
+  description,
+  status,
+  timestamp
+from
+  aws_trusted_advisor_check_summary
+where
+  timestamp >= datetime('now', '-5 day');
+```
+
+### Get resource summaries of each check
+Retrieve resource summaries for each AWS Trusted Advisor Check. This includes the number of resources flagged, ignored, processed, and suppressed for each check.
+
+```sql+postgres
+select
+  name,
+  check_id,
+  resources_flagged,
+  resources_ignored,
+  resources_processed,
+  resources_suppressed
+from
+  aws_trusted_advisor_check_summary;
+```
+
+```sql+sqlite
+select
+  name,
+  check_id,
+  resources_flagged,
+  resources_ignored,
+  resources_processed,
+  resources_suppressed
+from
+  aws_trusted_advisor_check_summary;
+```