DescribeProducts
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.
Request Syntax
GET /products?MaxResults=MaxResults&NextToken=NextToken&ProductArn=ProductArn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- MaxResults
-
The maximum number of results to return.
Valid Range: Minimum value of 1. Maximum value of 100.
- NextToken
-
The token that is required for pagination. On your first call to the
DescribeProductsoperation, set the value of this parameter toNULL.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
-
The ARN of the integration to return.
Pattern:
.*\S.*
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Products": [
{
"ActivationUrl": "string",
"Categories": [ "string" ],
"CompanyName": "string",
"Description": "string",
"IntegrationTypes": [ "string" ],
"MarketplaceUrl": "string",
"ProductArn": "string",
"ProductName": "string",
"ProductSubscriptionResourcePolicy": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalException
-
Internal server error.
HTTP Status Code: 500
- InvalidAccessException
-
The account doesn't have permission to perform this action.
HTTP Status Code: 401
- InvalidInputException
-
The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
HTTP Status Code: 400
- LimitExceededException
-
The request was rejected because it attempted to create resources beyond the current AWS account or throttling limits. The error code describes the limit exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
