DescribeProductsCommand

Returns information about product integrations in Security Hub.

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SecurityHubClient, DescribeProductsCommand } from "@aws-sdk/client-securityhub"; // ES Modules import
// const { SecurityHubClient, DescribeProductsCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import
const client = new SecurityHubClient(config);
const input = { // DescribeProductsRequest
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
  ProductArn: "STRING_VALUE",
};
const command = new DescribeProductsCommand(input);
const response = await client.send(command);
// { // DescribeProductsResponse
//   Products: [ // ProductsList // required
//     { // Product
//       ProductArn: "STRING_VALUE", // required
//       ProductName: "STRING_VALUE",
//       CompanyName: "STRING_VALUE",
//       Description: "STRING_VALUE",
//       Categories: [ // CategoryList
//         "STRING_VALUE",
//       ],
//       IntegrationTypes: [ // IntegrationTypeList
//         "SEND_FINDINGS_TO_SECURITY_HUB" || "RECEIVE_FINDINGS_FROM_SECURITY_HUB" || "UPDATE_FINDINGS_IN_SECURITY_HUB",
//       ],
//       MarketplaceUrl: "STRING_VALUE",
//       ActivationUrl: "STRING_VALUE",
//       ProductSubscriptionResourcePolicy: "STRING_VALUE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

Example Usage

 Loading code editor

DescribeProductsCommand Input

See DescribeProductsCommandInput for more details

Parameter
Type
Description
MaxResults
number | undefined

The maximum number of results to return.

NextToken
string | undefined

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 | undefined

The ARN of the integration to return.

DescribeProductsCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Products
Required
Product[] | undefined

A list of products, including details for each product.

NextToken
string | undefined

The pagination token to use to request the next page of results.

Throws

Name
Fault
Details
InternalException
server

Internal server error.

InvalidAccessException
client

The account doesn't have permission to perform this action.

InvalidInputException
client

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

LimitExceededException
client

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

SecurityHubServiceException
Base exception class for all service exceptions from SecurityHub service.