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

ListRulesPackages

Lists all available Amazon Inspector rules packages.

Request Syntax

{
   "maxResults": number,
   "nextToken": "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.

maxResults

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

Type: Integer

Required: No

nextToken

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListRulesPackages action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

Type: String

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

Required: No

Response Syntax

{
   "nextToken": "string",
   "rulesPackageArns": [ "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.

nextToken

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

Type: String

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

rulesPackageArns

The list of ARNs that specifies the rules packages returned by the action.

Type: Array of strings

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

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

Errors

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

AccessDeniedException

You do not have required permissions to access the requested resource.

HTTP Status Code: 400

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: 2
                  X-Amz-Target: InspectorService.ListRulesPackages
                  X-Amz-Date: 20160323T203727Z
                  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
                  {}
               
            

Sample Response


               
                  HTTP/1.1 200 OK
                  x-amzn-RequestId: 0e3779a9-f137-11e5-be28-e130082e2a98
                  Content-Type: application/x-amz-json-1.1
                  Content-Length: 424
                  Date: Wed, 23 Mar 2016 20:37:26 GMT
                  {
                    "rulesPackageArns": [
                      "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p",
                      "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-H5hpSawc",
                      "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ",
                      "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-vg5GGHSD"
                    ]
                  }
               
            

See Also

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