DescribeFindings
Describes the findings that are specified by the ARNs of the findings.
Request Syntax
{ "findingArns": [ "
string
" ], "locale": "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.
- findingArns
-
The ARN that specifies the finding 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
- locale
-
The locale into which you want to translate a finding description, recommendation, and the short description that identifies the finding.
Type: String
Valid Values:
EN_US
Required: No
Response Syntax
{ "failedItems": { "string" : { "failureCode": "string", "retryable": boolean } }, "findings": [ { "arn": "string", "assetAttributes": { "agentId": "string", "amiId": "string", "autoScalingGroup": "string", "hostname": "string", "ipv4Addresses": [ "string" ], "networkInterfaces": [ { "ipv6Addresses": [ "string" ], "networkInterfaceId": "string", "privateDnsName": "string", "privateIpAddress": "string", "privateIpAddresses": [ { "privateDnsName": "string", "privateIpAddress": "string" } ], "publicDnsName": "string", "publicIp": "string", "securityGroups": [ { "groupId": "string", "groupName": "string" } ], "subnetId": "string", "vpcId": "string" } ], "schemaVersion": number, "tags": [ { "key": "string", "value": "string" } ] }, "assetType": "string", "attributes": [ { "key": "string", "value": "string" } ], "confidence": number, "createdAt": number, "description": "string", "id": "string", "indicatorOfCompromise": boolean, "numericSeverity": number, "recommendation": "string", "schemaVersion": number, "service": "string", "serviceAttributes": { "assessmentRunArn": "string", "rulesPackageArn": "string", "schemaVersion": number }, "severity": "string", "title": "string", "updatedAt": number, "userAttributes": [ { "key": "string", "value": "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
-
Finding 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.
- findings
-
Information about the finding.
Type: Array of Finding objects
Array Members: Minimum number of 0 items. Maximum number of 100 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: 133 X-Amz-Target: InspectorService.DescribeFindings X-Amz-Date: 20160323T215809Z 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 { "findingArns": [ "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4" ] }
Sample Response
HTTP/1.1 200 OK x-amzn-RequestId: 555dbc27-f142-11e5-9dc2-6746fe4b2002 Content-Type: application/x-amz-json-1.1 Content-Length: 892 Date: Wed, 23 Mar 2016 21:58:10 GMT { "failedItems": {}, "findings": [ { "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4", "assetAttributes": { "agentId": "i-092e1184e67721f24", "amiId": "ami-0ad99772", "autoScalingGroup": "auto scaling group", "hostname": "ec2-54-202-242-173.us-west-2.compute.amazonaws.com", "ipv4Addresses": [], "networkInterfaces": [ { "ipv6Addresses": [], "networkInterfaceId": "eni-09b5ad02", "privateDnsName": "ip-172-31-36-75.us-west-2.compute.internal", "privateIpAddress": "172.31.36.75", "privateIpAddresses": [ { "privateDnsName": "ip-172-31-36-75.us-west-2.compute.internal", "privateIpAddress": "172.31.36.75" } ], "publicDnsName": "ec2-54-202-242-173.us-west-2.compute.amazonaws.com", "publicIp": "54.202.242.173", "securityGroups": [ { "groupId": "sg-48578931", "groupName": "default" } ], "subnetId": "subnet-8aeebbfc", "vpcId": "vpc-05515b61" } ], "schemaVersion": 1, "tags": [ { "key": "scaling", "value": "yes" }, { "key": "aws:autoscaling:groupName", "value": "auto scaling group" }, { "key": "Name", "value": "beta_amazon_linux_201803_scaling" }, { "key": "beta", "value": "true" } ] }, "assetType": "ec2-instance", "attributes": [], "confidence": 10, "createdAt": 1458680301.37, "description": "Amazon Inspector did not find any potential security issues during this assessment.", "indicatorOfCompromise": false, "numericSeverity": 0, "recommendation": "No remediation needed.", "schemaVersion": 1, "service": "Inspector", "serviceAttributes": { "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", "rulesPackageArn": "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP", "schemaVersion": 1 }, "severity": "Informational", "title": "No potential security issues found", "updatedAt": 1458680301.37, "userAttributes": [] } ] }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: