Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Inspector.CreateAssessmentTemplate

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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 access to AWS Services needed to perform security assessments.

Synopsis

data CreateAssessmentTemplate = CreateAssessmentTemplate' {
- userAttributesForFindings :: Maybe [Attribute]
- assessmentTargetArn :: Text
- assessmentTemplateName :: Text
- durationInSeconds :: Natural
- rulesPackageArns :: [Text]
}
newCreateAssessmentTemplate :: Text -> Text -> Natural -> CreateAssessmentTemplate
createAssessmentTemplate_userAttributesForFindings :: Lens' CreateAssessmentTemplate (Maybe [Attribute])
createAssessmentTemplate_assessmentTargetArn :: Lens' CreateAssessmentTemplate Text
createAssessmentTemplate_assessmentTemplateName :: Lens' CreateAssessmentTemplate Text
createAssessmentTemplate_durationInSeconds :: Lens' CreateAssessmentTemplate Natural
createAssessmentTemplate_rulesPackageArns :: Lens' CreateAssessmentTemplate [Text]
data CreateAssessmentTemplateResponse = CreateAssessmentTemplateResponse' {
- httpStatus :: Int
- assessmentTemplateArn :: Text
}
newCreateAssessmentTemplateResponse :: Int -> Text -> CreateAssessmentTemplateResponse
createAssessmentTemplateResponse_httpStatus :: Lens' CreateAssessmentTemplateResponse Int
createAssessmentTemplateResponse_assessmentTemplateArn :: Lens' CreateAssessmentTemplateResponse Text

Creating a Request

data CreateAssessmentTemplate Source #

See: newCreateAssessmentTemplate smart constructor.

Constructors

CreateAssessmentTemplate'

Fields

userAttributesForFindings :: Maybe [Attribute]
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.
assessmentTargetArn :: Text
The ARN that specifies the assessment target for which you want to create the assessment template.
assessmentTemplateName :: Text
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.
durationInSeconds :: Natural
The duration of the assessment run in seconds.
rulesPackageArns :: [Text]
The ARNs that specify the rules packages that you want to attach to the assessment template.

Instances

Instances details

Eq CreateAssessmentTemplate Source #
Instance details Defined in Amazonka.Inspector.CreateAssessmentTemplate Methods (==) :: CreateAssessmentTemplate -> CreateAssessmentTemplate -> Bool # (/=) :: CreateAssessmentTemplate -> CreateAssessmentTemplate -> Bool #
Read CreateAssessmentTemplate Source #
Instance details Defined in Amazonka.Inspector.CreateAssessmentTemplate Methods readsPrec :: Int -> ReadS CreateAssessmentTemplate # readList :: ReadS [CreateAssessmentTemplate] # readPrec :: ReadPrec CreateAssessmentTemplate # readListPrec :: ReadPrec [CreateAssessmentTemplate] #
Show CreateAssessmentTemplate Source #
Instance details Defined in Amazonka.Inspector.CreateAssessmentTemplate Methods showsPrec :: Int -> CreateAssessmentTemplate -> ShowS # show :: CreateAssessmentTemplate -> String # showList :: [CreateAssessmentTemplate] -> ShowS #
Generic CreateAssessmentTemplate Source #
Instance details Defined in Amazonka.Inspector.CreateAssessmentTemplate Associated Types type Rep CreateAssessmentTemplate :: Type -> Type # Methods from :: CreateAssessmentTemplate -> Rep CreateAssessmentTemplate x # to :: Rep CreateAssessmentTemplate x -> CreateAssessmentTemplate #
NFData CreateAssessmentTemplate Source #
Instance details Defined in Amazonka.Inspector.CreateAssessmentTemplate Methods rnf :: CreateAssessmentTemplate -> () #
Hashable CreateAssessmentTemplate Source #
Instance details Defined in Amazonka.Inspector.CreateAssessmentTemplate Methods hashWithSalt :: Int -> CreateAssessmentTemplate -> Int # hash :: CreateAssessmentTemplate -> Int #
ToJSON CreateAssessmentTemplate Source #
Instance details Defined in Amazonka.Inspector.CreateAssessmentTemplate Methods toJSON :: CreateAssessmentTemplate -> Value # toEncoding :: CreateAssessmentTemplate -> Encoding # toJSONList :: [CreateAssessmentTemplate] -> Value # toEncodingList :: [CreateAssessmentTemplate] -> Encoding #
AWSRequest CreateAssessmentTemplate Source #
Instance details Defined in Amazonka.Inspector.CreateAssessmentTemplate Associated Types type AWSResponse CreateAssessmentTemplate # Methods request :: CreateAssessmentTemplate -> Request CreateAssessmentTemplate # response :: MonadResource m => Logger -> Service -> Proxy CreateAssessmentTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAssessmentTemplate))) #
ToHeaders CreateAssessmentTemplate Source #
Instance details Defined in Amazonka.Inspector.CreateAssessmentTemplate Methods toHeaders :: CreateAssessmentTemplate -> [Header] #
ToPath CreateAssessmentTemplate Source #
Instance details Defined in Amazonka.Inspector.CreateAssessmentTemplate Methods toPath :: CreateAssessmentTemplate -> ByteString #
ToQuery CreateAssessmentTemplate Source #
Instance details Defined in Amazonka.Inspector.CreateAssessmentTemplate Methods toQuery :: CreateAssessmentTemplate -> QueryString #
type Rep CreateAssessmentTemplate Source #
Instance details Defined in Amazonka.Inspector.CreateAssessmentTemplate type Rep CreateAssessmentTemplate = D1 ('MetaData "CreateAssessmentTemplate" "Amazonka.Inspector.CreateAssessmentTemplate" "libZSservicesZSamazonka-inspectorZSamazonka-inspector" 'False) (C1 ('MetaCons "CreateAssessmentTemplate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "userAttributesForFindings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Attribute])) :: S1 ('MetaSel ('Just "assessmentTargetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "assessmentTemplateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "durationInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :: S1 ('MetaSel ('Just "rulesPackageArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))))
type AWSResponse CreateAssessmentTemplate Source #
Instance details Defined in Amazonka.Inspector.CreateAssessmentTemplate type AWSResponse CreateAssessmentTemplate = CreateAssessmentTemplateResponse

newCreateAssessmentTemplate Source #

Arguments

:: Text	`$sel:assessmentTargetArn:CreateAssessmentTemplate'`
-> Text	`$sel:assessmentTemplateName:CreateAssessmentTemplate'`
-> Natural	`$sel:durationInSeconds:CreateAssessmentTemplate'`
-> CreateAssessmentTemplate

Create a value of CreateAssessmentTemplate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:userAttributesForFindings:CreateAssessmentTemplate', createAssessmentTemplate_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.

$sel:assessmentTargetArn:CreateAssessmentTemplate', createAssessmentTemplate_assessmentTargetArn - The ARN that specifies the assessment target for which you want to create the assessment template.

$sel:assessmentTemplateName:CreateAssessmentTemplate', createAssessmentTemplate_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.

$sel:durationInSeconds:CreateAssessmentTemplate', createAssessmentTemplate_durationInSeconds - The duration of the assessment run in seconds.

$sel:rulesPackageArns:CreateAssessmentTemplate', createAssessmentTemplate_rulesPackageArns - The ARNs that specify the rules packages that you want to attach to the assessment template.

Request Lenses

createAssessmentTemplate_userAttributesForFindings :: Lens' CreateAssessmentTemplate (Maybe [Attribute]) Source #

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.

createAssessmentTemplate_assessmentTargetArn :: Lens' CreateAssessmentTemplate Text Source #

The ARN that specifies the assessment target for which you want to create the assessment template.

createAssessmentTemplate_assessmentTemplateName :: Lens' CreateAssessmentTemplate Text Source #

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.

createAssessmentTemplate_durationInSeconds :: Lens' CreateAssessmentTemplate Natural Source #

The duration of the assessment run in seconds.

createAssessmentTemplate_rulesPackageArns :: Lens' CreateAssessmentTemplate [Text] Source #

The ARNs that specify the rules packages that you want to attach to the assessment template.

Destructuring the Response

data CreateAssessmentTemplateResponse Source #

See: newCreateAssessmentTemplateResponse smart constructor.

Constructors

CreateAssessmentTemplateResponse'
Fields httpStatus :: Int The response's http status code. assessmentTemplateArn :: Text The ARN that specifies the assessment template that is created.

Instances

Instances details

Eq CreateAssessmentTemplateResponse Source #
Instance details Defined in Amazonka.Inspector.CreateAssessmentTemplate Methods (==) :: CreateAssessmentTemplateResponse -> CreateAssessmentTemplateResponse -> Bool # (/=) :: CreateAssessmentTemplateResponse -> CreateAssessmentTemplateResponse -> Bool #
Read CreateAssessmentTemplateResponse Source #
Instance details Defined in Amazonka.Inspector.CreateAssessmentTemplate Methods readsPrec :: Int -> ReadS CreateAssessmentTemplateResponse # readList :: ReadS [CreateAssessmentTemplateResponse] # readPrec :: ReadPrec CreateAssessmentTemplateResponse # readListPrec :: ReadPrec [CreateAssessmentTemplateResponse] #
Show CreateAssessmentTemplateResponse Source #
Instance details Defined in Amazonka.Inspector.CreateAssessmentTemplate Methods showsPrec :: Int -> CreateAssessmentTemplateResponse -> ShowS # show :: CreateAssessmentTemplateResponse -> String # showList :: [CreateAssessmentTemplateResponse] -> ShowS #
Generic CreateAssessmentTemplateResponse Source #
Instance details Defined in Amazonka.Inspector.CreateAssessmentTemplate Associated Types type Rep CreateAssessmentTemplateResponse :: Type -> Type # Methods from :: CreateAssessmentTemplateResponse -> Rep CreateAssessmentTemplateResponse x # to :: Rep CreateAssessmentTemplateResponse x -> CreateAssessmentTemplateResponse #
NFData CreateAssessmentTemplateResponse Source #
Instance details Defined in Amazonka.Inspector.CreateAssessmentTemplate Methods rnf :: CreateAssessmentTemplateResponse -> () #
type Rep CreateAssessmentTemplateResponse Source #
Instance details Defined in Amazonka.Inspector.CreateAssessmentTemplate type Rep CreateAssessmentTemplateResponse = D1 ('MetaData "CreateAssessmentTemplateResponse" "Amazonka.Inspector.CreateAssessmentTemplate" "libZSservicesZSamazonka-inspectorZSamazonka-inspector" 'False) (C1 ('MetaCons "CreateAssessmentTemplateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "assessmentTemplateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateAssessmentTemplateResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateAssessmentTemplateResponse'`
-> Text	`$sel:assessmentTemplateArn:CreateAssessmentTemplateResponse'`
-> CreateAssessmentTemplateResponse

Create a value of CreateAssessmentTemplateResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateAssessmentTemplateResponse', createAssessmentTemplateResponse_httpStatus - The response's http status code.

$sel:assessmentTemplateArn:CreateAssessmentTemplateResponse', createAssessmentTemplateResponse_assessmentTemplateArn - The ARN that specifies the assessment template that is created.

Response Lenses

createAssessmentTemplateResponse_httpStatus :: Lens' CreateAssessmentTemplateResponse Int Source #

The response's http status code.

createAssessmentTemplateResponse_assessmentTemplateArn :: Lens' CreateAssessmentTemplateResponse Text Source #

The ARN that specifies the assessment template that is created.