Describes the assessment targets that are specified by the ARNs of the assessment targets.
Request Syntax
{
"assessmentTargetArns": [ "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.
- assessmentTargetArns
-
The ARNs that specifies the assessment targets 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
{
"assessmentTargets": [
{
"arn": "string",
"createdAt": number,
"name": "string",
"resourceGroupArn": "string",
"updatedAt": number
}
],
"failedItems": {
"string" : {
"failureCode": "string",
"retryable": boolean
}
}
}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.
- assessmentTargets
-
Information about the assessment targets.
Type: Array of AssessmentTarget objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
- failedItems
-
Assessment target 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.
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
Examples
Example
This example illustrates one usage of DescribeAssessmentTargets.
Sample Request
POST / HTTP/1.1
Host: inspector.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 88
X-Amz-Target: InspectorService.DescribeAssessmentTargets
X-Amz-Date: 20160323T214315Z
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
{
"assessmentTargetArns": [
"arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq"
]
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: 407ddf01-f140-11e5-823c-bd257ba1495d
Content-Type: application/x-amz-json-1.1
Content-Length: 287
Date: Wed, 23 Mar 2016 21:43:16 GMT
{
"assessmentTargets": [
{
"arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq",
"createdAt": 1458074191.459,
"name": "ExampleAssessmentTarget",
"resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI",
"updatedAt": 1458074191.459
}
],
"failedItems": {}
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
