describe_products ¶

def describe_products(
    self,
    *,
    config_overrides: Optional[SecurityHubClientConfig] = None,
    next_token: Optional["capo_securityhub.types.next_token.NextToken"] = None,
    max_results: Optional["capo_securityhub.types.max_results.MaxResults"] = None,
    product_arn: Optional[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ] = None,
) -> "capo_securityhub.types.describe_products_response.DescribeProductsResponse":
    """<p>Returns information about product integrations in Security Hub CSPM.</p> <p>You can optionally provide an integration ARN. If you provide an integration ARN, then the results only include that integration.</p> <p>If you don't provide an integration ARN, then the results include all of the available product integrations. </p>

    Args:
        next_token: <p>The token that is required for pagination. On your first call to the <code>DescribeProducts</code> operation, set the value of this parameter to <code>NULL</code>.</p> <p>For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.</p>
        max_results: <p>The maximum number of results to return.</p>
        product_arn: <p>The ARN of the integration to return.</p>

    Raises:
        capo_securityhub.errors.internal_exception.InternalException: <p>Internal server error.</p>
        capo_securityhub.errors.invalid_access_exception.InvalidAccessException: <p>The account doesn't have permission to perform this action.</p>
        capo_securityhub.errors.invalid_input_exception.InvalidInputException: <p>The request was rejected because you supplied an invalid or out-of-range value for an input parameter.</p>
        capo_securityhub.errors.limit_exceeded_exception.LimitExceededException: <p>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.</p>
        capo_securityhub.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To get information about Security Hub integrations
        The following example returns details about AWS services and third-party products that Security Hub integrates with.

        >>> client.describe_products(next_token='NULL', max_results=1, product_arn='arn:aws:securityhub:us-east-1:517716713836:product/crowdstrike/crowdstrike-falcon')
    """

    def _handler(
        req: "OperationRequest[capo_securityhub.types.describe_products_request.DescribeProductsRequest]",
    ) -> OperationResponse[
        "capo_securityhub.types.describe_products_response.DescribeProductsResponse"
    ]:
        import capo_securityhub._operations.security_hub_api_service.describe_products

        output, http_response = (
            capo_securityhub._operations.security_hub_api_service.describe_products.describe_products(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeProducts")
    )
    input_: capo_securityhub.types.describe_products_request.DescribeProductsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if product_arn is not None:
        input_["product_arn"] = product_arn

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output