Menu
Amazon Inspector
API Reference (API Version 2016-02-16)

DescribeRulesPackages

Describes the rules packages that are specified by the ARNs of the rules packages.

Request Syntax

{ "locale": "string", "rulesPackageArns": [ "string" ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

locale

The locale that you want to translate a rules package description into.

Type: String

Valid Values: EN_US

Required: No

rulesPackageArns

The ARN that specifies the rules package that you want to describe.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 300.

Required: Yes

Response Syntax

{ "failedItems": { "string" : { "failureCode": "string", "retryable": boolean } }, "rulesPackages": [ { "arn": "string", "description": "string", "name": "string", "provider": "string", "version": "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.

failedItems

Rules package details that cannot be described. An error code is provided for each failed item.

Type: String to FailedItemDetails object map

Key Length Constraints: Minimum length of 1. Maximum length of 300.

rulesPackages

Information about the rules package.

Type: Array of RulesPackage objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalException

Internal server error.

HTTP Status Code: 500

InvalidInputException

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

HTTP Status Code: 400

Example

Sample Request

POST / HTTP/1.1 Host: inspector.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 90 X-Amz-Target: InspectorService.DescribeRulesPackages X-Amz-Date: 20160323T220919Z User-Agent: aws-cli/1.10.12 Python/2.7.9 Windows/7 botocore/1.4.3 Content-Type: application/x-amz-json-1.1 Authorization: AUTHPARAMS { "rulesPackageArns": [ "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p" ] }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: e4a6aee0-f143-11e5-a5ad-73b7f19c946c Content-Type: application/x-amz-json-1.1 Content-Length: 387 Date: Wed, 23 Mar 2016 22:09:20 GMT { "failedItems": {}, "rulesPackages": [ { "arn": "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p", "description": "The rules in this package help verify whether the EC2 instances in your application are exposed to Common Vulnerabilities and Exposures (CVEs). Attacks can exploit unpatched vulnerabilities to compromise the confidentiality, integrity, or availability of your service or data. The CVE system provides a reference for publicly known information security vulnerabilities and exposures. For more information, see [https://cve.mitre.org/](https://cve.mitre.org/). If a particular CVE appears in one of the produced Findings at the end of a completed Inspector assessment, you can search [https://cve.mitre.org/](https://cve.mitre.org/) using the CVE's ID (for example, \"CVE-2009-0021\") to find detailed information about this CVE, its severity, and how to mitigate it. ", "name": "Common Vulnerabilities and Exposures", "provider": "Amazon Web Services, Inc.", "version": "1.1" } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: