Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AuditManager.CreateAssessment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an assessment in Audit Manager.

Synopsis

data CreateAssessment = CreateAssessment' {
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- name :: Text
- assessmentReportsDestination :: AssessmentReportsDestination
- scope :: Scope
- roles :: [Role]
- frameworkId :: Text
}
newCreateAssessment :: Text -> AssessmentReportsDestination -> Scope -> Text -> CreateAssessment
createAssessment_description :: Lens' CreateAssessment (Maybe Text)
createAssessment_tags :: Lens' CreateAssessment (Maybe (HashMap Text Text))
createAssessment_name :: Lens' CreateAssessment Text
createAssessment_assessmentReportsDestination :: Lens' CreateAssessment AssessmentReportsDestination
createAssessment_scope :: Lens' CreateAssessment Scope
createAssessment_roles :: Lens' CreateAssessment [Role]
createAssessment_frameworkId :: Lens' CreateAssessment Text
data CreateAssessmentResponse = CreateAssessmentResponse' {
- assessment :: Maybe Assessment
- httpStatus :: Int
}
newCreateAssessmentResponse :: Int -> CreateAssessmentResponse
createAssessmentResponse_assessment :: Lens' CreateAssessmentResponse (Maybe Assessment)
createAssessmentResponse_httpStatus :: Lens' CreateAssessmentResponse Int

Creating a Request

data CreateAssessment Source #

See: newCreateAssessment smart constructor.

Constructors

CreateAssessment'

Fields

description :: Maybe Text
The optional description of the assessment to be created.
tags :: Maybe (HashMap Text Text)
The tags that are associated with the assessment.
name :: Text
The name of the assessment to be created.
assessmentReportsDestination :: AssessmentReportsDestination
The assessment report storage destination for the assessment that's being created.
scope :: Scope
roles :: [Role]
The list of roles for the assessment.
frameworkId :: Text
The identifier for the framework that the assessment will be created from.

Instances

Instances details

ToJSON CreateAssessment Source #
Instance details Defined in Amazonka.AuditManager.CreateAssessment Methods toJSON :: CreateAssessment -> Value # toEncoding :: CreateAssessment -> Encoding # toJSONList :: [CreateAssessment] -> Value # toEncodingList :: [CreateAssessment] -> Encoding #
ToHeaders CreateAssessment Source #
Instance details Defined in Amazonka.AuditManager.CreateAssessment Methods toHeaders :: CreateAssessment -> [Header] #
ToPath CreateAssessment Source #
Instance details Defined in Amazonka.AuditManager.CreateAssessment Methods toPath :: CreateAssessment -> ByteString #
ToQuery CreateAssessment Source #
Instance details Defined in Amazonka.AuditManager.CreateAssessment Methods toQuery :: CreateAssessment -> QueryString #
AWSRequest CreateAssessment Source #
Instance details Defined in Amazonka.AuditManager.CreateAssessment Associated Types type AWSResponse CreateAssessment # Methods request :: (Service -> Service) -> CreateAssessment -> Request CreateAssessment # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateAssessment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAssessment))) #
Generic CreateAssessment Source #
Instance details Defined in Amazonka.AuditManager.CreateAssessment Associated Types type Rep CreateAssessment :: Type -> Type # Methods from :: CreateAssessment -> Rep CreateAssessment x # to :: Rep CreateAssessment x -> CreateAssessment #
Read CreateAssessment Source #
Instance details Defined in Amazonka.AuditManager.CreateAssessment Methods readsPrec :: Int -> ReadS CreateAssessment # readList :: ReadS [CreateAssessment] # readPrec :: ReadPrec CreateAssessment # readListPrec :: ReadPrec [CreateAssessment] #
Show CreateAssessment Source #
Instance details Defined in Amazonka.AuditManager.CreateAssessment Methods showsPrec :: Int -> CreateAssessment -> ShowS # show :: CreateAssessment -> String # showList :: [CreateAssessment] -> ShowS #
NFData CreateAssessment Source #
Instance details Defined in Amazonka.AuditManager.CreateAssessment Methods rnf :: CreateAssessment -> () #
Eq CreateAssessment Source #
Instance details Defined in Amazonka.AuditManager.CreateAssessment Methods (==) :: CreateAssessment -> CreateAssessment -> Bool # (/=) :: CreateAssessment -> CreateAssessment -> Bool #
Hashable CreateAssessment Source #
Instance details Defined in Amazonka.AuditManager.CreateAssessment Methods hashWithSalt :: Int -> CreateAssessment -> Int # hash :: CreateAssessment -> Int #
type AWSResponse CreateAssessment Source #
Instance details Defined in Amazonka.AuditManager.CreateAssessment type AWSResponse CreateAssessment = CreateAssessmentResponse
type Rep CreateAssessment Source #
Instance details Defined in Amazonka.AuditManager.CreateAssessment type Rep CreateAssessment = D1 ('MetaData "CreateAssessment" "Amazonka.AuditManager.CreateAssessment" "amazonka-auditmanager-2.0-FZ7GH2VR8PBBaoTT7BhtJQ" 'False) (C1 ('MetaCons "CreateAssessment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "assessmentReportsDestination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AssessmentReportsDestination) :: S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Scope)) :: (S1 ('MetaSel ('Just "roles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Role]) :: S1 ('MetaSel ('Just "frameworkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateAssessment Source #

Arguments

:: Text	`CreateAssessment`
-> AssessmentReportsDestination	`CreateAssessment`
-> Scope	`CreateAssessment`
-> Text	`CreateAssessment`
-> CreateAssessment

Create a value of CreateAssessment 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:

CreateAssessment, createAssessment_description - The optional description of the assessment to be created.

CreateAssessment, createAssessment_tags - The tags that are associated with the assessment.

CreateAssessment, createAssessment_name - The name of the assessment to be created.

CreateAssessment, createAssessment_assessmentReportsDestination - The assessment report storage destination for the assessment that's being created.

CreateAssessment, createAssessment_scope - Undocumented member.

CreateAssessment, createAssessment_roles - The list of roles for the assessment.

CreateAssessment, createAssessment_frameworkId - The identifier for the framework that the assessment will be created from.

Request Lenses

createAssessment_description :: Lens' CreateAssessment (Maybe Text) Source #

The optional description of the assessment to be created.

createAssessment_tags :: Lens' CreateAssessment (Maybe (HashMap Text Text)) Source #

The tags that are associated with the assessment.

createAssessment_name :: Lens' CreateAssessment Text Source #

The name of the assessment to be created.

createAssessment_assessmentReportsDestination :: Lens' CreateAssessment AssessmentReportsDestination Source #

The assessment report storage destination for the assessment that's being created.

createAssessment_scope :: Lens' CreateAssessment Scope Source #

Undocumented member.

createAssessment_roles :: Lens' CreateAssessment [Role] Source #

The list of roles for the assessment.

createAssessment_frameworkId :: Lens' CreateAssessment Text Source #

The identifier for the framework that the assessment will be created from.

Destructuring the Response

data CreateAssessmentResponse Source #

See: newCreateAssessmentResponse smart constructor.

Constructors

CreateAssessmentResponse'
Fields assessment :: Maybe Assessment httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateAssessmentResponse Source #
Instance details Defined in Amazonka.AuditManager.CreateAssessment Associated Types type Rep CreateAssessmentResponse :: Type -> Type # Methods from :: CreateAssessmentResponse -> Rep CreateAssessmentResponse x # to :: Rep CreateAssessmentResponse x -> CreateAssessmentResponse #
Read CreateAssessmentResponse Source #
Instance details Defined in Amazonka.AuditManager.CreateAssessment Methods readsPrec :: Int -> ReadS CreateAssessmentResponse # readList :: ReadS [CreateAssessmentResponse] # readPrec :: ReadPrec CreateAssessmentResponse # readListPrec :: ReadPrec [CreateAssessmentResponse] #
Show CreateAssessmentResponse Source #
Instance details Defined in Amazonka.AuditManager.CreateAssessment Methods showsPrec :: Int -> CreateAssessmentResponse -> ShowS # show :: CreateAssessmentResponse -> String # showList :: [CreateAssessmentResponse] -> ShowS #
NFData CreateAssessmentResponse Source #
Instance details Defined in Amazonka.AuditManager.CreateAssessment Methods rnf :: CreateAssessmentResponse -> () #
Eq CreateAssessmentResponse Source #
Instance details Defined in Amazonka.AuditManager.CreateAssessment Methods (==) :: CreateAssessmentResponse -> CreateAssessmentResponse -> Bool # (/=) :: CreateAssessmentResponse -> CreateAssessmentResponse -> Bool #
type Rep CreateAssessmentResponse Source #
Instance details Defined in Amazonka.AuditManager.CreateAssessment type Rep CreateAssessmentResponse = D1 ('MetaData "CreateAssessmentResponse" "Amazonka.AuditManager.CreateAssessment" "amazonka-auditmanager-2.0-FZ7GH2VR8PBBaoTT7BhtJQ" 'False) (C1 ('MetaCons "CreateAssessmentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "assessment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Assessment)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateAssessmentResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateAssessmentResponse'`
-> CreateAssessmentResponse

Create a value of CreateAssessmentResponse 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:assessment:CreateAssessmentResponse', createAssessmentResponse_assessment - Undocumented member.

$sel:httpStatus:CreateAssessmentResponse', createAssessmentResponse_httpStatus - The response's http status code.

Response Lenses

createAssessmentResponse_assessment :: Lens' CreateAssessmentResponse (Maybe Assessment) Source #

Undocumented member.

createAssessmentResponse_httpStatus :: Lens' CreateAssessmentResponse Int Source #

The response's http status code.