products

Creates, updates, deletes, gets or lists a products resource.

Overview

Name	products
Type	Resource
Id	aws.securityhub.products

Fields

The following fields are returned by SELECT queries:

describe_products

Name	Datatype	Description
activation_url	string	The URL to the service or product documentation about the integration with Security Hub CSPM, including how to activate the integration. (pattern: <code>.\S.</code>)
categories	array	The categories assigned to the product.
company_name	string	The name of the company that provides the product. (pattern: <code>.\S.</code>)
description	string	A description of the product. (pattern: <code>.\S.</code>)
integration_types	array	The types of integration that the product supports. Available values are the following. SEND_FINDINGS_TO_SECURITY_HUB - The integration sends findings to Security Hub CSPM. RECEIVE_FINDINGS_FROM_SECURITY_HUB - The integration receives findings from Security Hub CSPM. UPDATE_FINDINGS_IN_SECURITY_HUB - The integration does not send new findings to Security Hub CSPM, but does make updates to the findings that it receives from Security Hub CSPM.
marketplace_url	string	For integrations with Amazon Web Services services, the Amazon Web Services Console URL from which to activate the service. For integrations with third-party products, the Amazon Web Services Marketplace URL from which to subscribe to or purchase the product. (pattern: <code>.\S.</code>)
product_arn	string	The ARN assigned to the product. (pattern: <code>.\S.</code>)
product_name	string	The name of the product. (pattern: <code>.\S.</code>)
product_subscription_resource_policy	string	The resource policy associated with the product. (pattern: <code>.\S.</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_products	select	region	NextToken, MaxResults, ProductArn	Returns information about product integrations in Security Hub CSPM. You can optionally provide an integration ARN. If you provide an integration ARN, then the results only include that integration. If you don't provide an integration ARN, then the results include all of the available product integrations.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
MaxResults	integer	The maximum number of results to return.
NextToken	string	The token that is required for pagination. On your first call to the DescribeProducts operation, set the value of this parameter to NULL. For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
ProductArn	string	The ARN of the integration to return.

SELECT examples

describe_products

Returns information about product integrations in Security Hub CSPM. You can optionally provide an integration ARN. If you provide an integration ARN, then the results only include that integration. If you don't provide an integration ARN, then the results include all of the available product integrations.

SELECT
activation_url,
categories,
company_name,
description,
integration_types,
marketplace_url,
product_arn,
product_name,
product_subscription_resource_policy
FROM aws.securityhub.products
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
AND ProductArn = '{{ ProductArn }}'
;