CreateAssessmentTemplate
Creates an assessment template for the assessment target that is specified by the ARN of 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.
Request Syntax
{
"assessmentTargetArn": "string",
"assessmentTemplateName": "string",
"durationInSeconds": number,
"rulesPackageArns": [ "string" ],
"userAttributesForFindings": [
{
"key": "string",
"value": "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.
- assessmentTargetArn
-
The ARN that specifies the assessment target for which you want to create the assessment template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: Yes
- assessmentTemplateName
-
The user-defined name that identifies the assessment template that you want to create. You can create several assessment templates for an assessment target. The names of the assessment templates that correspond to a particular assessment target must be unique.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 140.
Required: Yes
- durationInSeconds
-
The duration of the assessment run in seconds.
Type: Integer
Valid Range: Minimum value of 180. Maximum value of 86400.
Required: Yes
- rulesPackageArns
-
The ARNs that specify the rules packages that you want to attach to the assessment template.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: Yes
- userAttributesForFindings
-
The user-defined attributes that are assigned to every finding that is generated by the assessment run that uses this assessment template. An attribute is a key and value pair (an Attribute object). Within an assessment template, each key must be unique.
Type: Array of Attribute objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
Response Syntax
{
"assessmentTemplateArn": "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.
- assessmentTemplateArn
-
The ARN that specifies the assessment template 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
- 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 CreateAssessmentTemplate.
Sample Request
POST / HTTP/1.1
Host: inspector.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 335
X-Amz-Target: InspectorService.CreateAssessmentTemplate
X-Amz-Date: 20160331T175559Z
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
{
"assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX",
"assessmentTemplateName": "ExampleAssessmentTemplate",
"userAttributesForFindings": [
{
"key": "Example",
"value": "example"
}
],
"durationInSeconds": 180,
"rulesPackageArns": [
"arn:aws:inspector:us-west-2:758058086616:rulespackage/0-11B9DBXp"
]
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: d3d3d58e-f769-11e5-9da0-9bde5220d15c
Content-Type: application/x-amz-json-1.1
Content-Length: 106
Date: Thu, 31 Mar 2016 17:56:00 GMT
{
"assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
