Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

CreateAssessmentTarget

Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target. If the service-linked role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector Classic access to AWS Services needed to perform security assessments. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see Amazon Inspector Classic Assessment Targets.

Request Syntax


{
   "assessmentTargetName": "string",
   "resourceGroupArn": "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.

assessmentTargetName

The user-defined name that identifies the assessment target that you want to create. The name must be unique within the AWS account.

Type: String

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

Required: Yes

resourceGroupArn

The ARN that specifies the resource group that is used to create the assessment target. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target.

Type: String

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

Required: No

Response Syntax


{
   "assessmentTargetArn": "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.

assessmentTargetArn

The ARN that specifies the assessment target that is created.

Type: String

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

InvalidCrossAccountRoleException

Amazon Inspector Classic cannot assume the cross-account role that it needs to list your EC2 instances during the assessment run.

HTTP Status Code: 400

InvalidInputException

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

HTTP Status Code: 400

LimitExceededException

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

HTTP Status Code: 400

NoSuchEntityException

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

HTTP Status Code: 400

ServiceTemporarilyUnavailableException

The serice is temporary unavailable.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of CreateAssessmentTarget.

Sample Request



               
                  POST / HTTP/1.1
                  Host: inspector.us-west-2.amazonaws.com
                  Accept-Encoding: identity
                  Content-Length: 129
                  X-Amz-Target: InspectorService.CreateAssessmentTarget
                  X-Amz-Date: 20160331T174054Z
                  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
                  {
                    "assessmentTargetName": "ExampleAssessmentTarget",
                    "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv"
                  }

Sample Response



               
                  HTTP/1.1 200 OK
                  x-amzn-RequestId: b87f981e-f767-11e5-82d7-bb83264505be
                  Content-Type: application/x-amz-json-1.1
                  Content-Length: 84
                  Date: Thu, 31 Mar 2016 17:40:55 GMT
                  {
                    "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX"
                  }