Network.AWS.Inspector.GetAssessmentReport

Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.

Creating a Request

getAssessmentReport

Arguments

:: Text

garAssessmentRunARN

-> ReportFileFormat

garReportFileFormat

-> ReportType

garReportType

-> GetAssessmentReport

Creates a value of GetAssessmentReport with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• garAssessmentRunARN - The ARN that specifies the assessment run for which you want to generate a report.
• garReportFileFormat - Specifies the file format (html or pdf) of the assessment report that you want to generate.
• garReportType - Specifies the type of the assessment report that you want to generate. There are two types of assessment reports: a finding report and a full report. For more information, see Assessment Reports .

data GetAssessmentReport

See: getAssessmentReport smart constructor.

Instances

Eq GetAssessmentReport

Methods

(==) :: GetAssessmentReport -> GetAssessmentReport -> Bool

(/=) :: GetAssessmentReport -> GetAssessmentReport -> Bool

Data GetAssessmentReport

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetAssessmentReport -> c GetAssessmentReport

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetAssessmentReport

toConstr :: GetAssessmentReport -> Constr

dataTypeOf :: GetAssessmentReport -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetAssessmentReport)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetAssessmentReport)

gmapT :: (forall b. Data b => b -> b) -> GetAssessmentReport -> GetAssessmentReport

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetAssessmentReport -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetAssessmentReport -> r

gmapQ :: (forall d. Data d => d -> u) -> GetAssessmentReport -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetAssessmentReport -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetAssessmentReport -> m GetAssessmentReport

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetAssessmentReport -> m GetAssessmentReport

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetAssessmentReport -> m GetAssessmentReport

Read GetAssessmentReport

Methods

readsPrec :: Int -> ReadS GetAssessmentReport

readList :: ReadS [GetAssessmentReport]

readPrec :: ReadPrec GetAssessmentReport

readListPrec :: ReadPrec [GetAssessmentReport]

Show GetAssessmentReport

Methods

showsPrec :: Int -> GetAssessmentReport -> ShowS

show :: GetAssessmentReport -> String

showList :: [GetAssessmentReport] -> ShowS

Generic GetAssessmentReport

Associated Types

type Rep GetAssessmentReport :: * -> *

Methods

from :: GetAssessmentReport -> Rep GetAssessmentReport x

to :: Rep GetAssessmentReport x -> GetAssessmentReport

Hashable GetAssessmentReport

Methods

hashWithSalt :: Int -> GetAssessmentReport -> Int

hash :: GetAssessmentReport -> Int

ToJSON GetAssessmentReport

Methods

toJSON :: GetAssessmentReport -> Value

toEncoding :: GetAssessmentReport -> Encoding

toJSONList :: [GetAssessmentReport] -> Value

toEncodingList :: [GetAssessmentReport] -> Encoding

NFData GetAssessmentReport

Methods

rnf :: GetAssessmentReport -> ()

AWSRequest GetAssessmentReport

Associated Types

type Rs GetAssessmentReport :: *

Methods

request :: GetAssessmentReport -> Request GetAssessmentReport

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * GetAssessmentReport -> ClientResponse -> m (Response GetAssessmentReport)

ToHeaders GetAssessmentReport

Methods

toHeaders :: GetAssessmentReport -> [Header]

ToPath GetAssessmentReport

Methods

toPath :: GetAssessmentReport -> ByteString

ToQuery GetAssessmentReport

Methods

toQuery :: GetAssessmentReport -> QueryString

type Rep GetAssessmentReport

type Rep GetAssessmentReport = D1 * (MetaData "GetAssessmentReport" "Network.AWS.Inspector.GetAssessmentReport" "amazonka-inspector-1.6.0-8Y6k5Gy4CSfF3xkxqKMWTi" False) (C1 * (MetaCons "GetAssessmentReport'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_garAssessmentRunARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "_garReportFileFormat") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ReportFileFormat)) (S1 * (MetaSel (Just Symbol "_garReportType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ReportType)))))

type Rs GetAssessmentReport

type Rs GetAssessmentReport = GetAssessmentReportResponse

Request Lenses

garAssessmentRunARN :: Lens' GetAssessmentReport Text

The ARN that specifies the assessment run for which you want to generate a report.

garReportFileFormat :: Lens' GetAssessmentReport ReportFileFormat

Specifies the file format (html or pdf) of the assessment report that you want to generate.

garReportType :: Lens' GetAssessmentReport ReportType

Specifies the type of the assessment report that you want to generate. There are two types of assessment reports: a finding report and a full report. For more information, see Assessment Reports .

Destructuring the Response

getAssessmentReportResponse

Arguments

:: Int

garrsResponseStatus

-> ReportStatus

garrsStatus

-> GetAssessmentReportResponse

Creates a value of GetAssessmentReportResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• garrsUrl - Specifies the URL where you can find the generated assessment report. This parameter is only returned if the report is successfully generated.
• garrsResponseStatus - -- | The response status code.
• garrsStatus - Specifies the status of the request to generate an assessment report.

data GetAssessmentReportResponse

See: getAssessmentReportResponse smart constructor.

Instances

Eq GetAssessmentReportResponse

Methods

(==) :: GetAssessmentReportResponse -> GetAssessmentReportResponse -> Bool

(/=) :: GetAssessmentReportResponse -> GetAssessmentReportResponse -> Bool

Data GetAssessmentReportResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetAssessmentReportResponse -> c GetAssessmentReportResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetAssessmentReportResponse

toConstr :: GetAssessmentReportResponse -> Constr

dataTypeOf :: GetAssessmentReportResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetAssessmentReportResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetAssessmentReportResponse)

gmapT :: (forall b. Data b => b -> b) -> GetAssessmentReportResponse -> GetAssessmentReportResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetAssessmentReportResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetAssessmentReportResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GetAssessmentReportResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetAssessmentReportResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetAssessmentReportResponse -> m GetAssessmentReportResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetAssessmentReportResponse -> m GetAssessmentReportResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetAssessmentReportResponse -> m GetAssessmentReportResponse

Read GetAssessmentReportResponse

Methods

readsPrec :: Int -> ReadS GetAssessmentReportResponse

readList :: ReadS [GetAssessmentReportResponse]

readPrec :: ReadPrec GetAssessmentReportResponse

readListPrec :: ReadPrec [GetAssessmentReportResponse]

Show GetAssessmentReportResponse

Methods

showsPrec :: Int -> GetAssessmentReportResponse -> ShowS

show :: GetAssessmentReportResponse -> String

showList :: [GetAssessmentReportResponse] -> ShowS

Generic GetAssessmentReportResponse

Associated Types

type Rep GetAssessmentReportResponse :: * -> *

Methods

from :: GetAssessmentReportResponse -> Rep GetAssessmentReportResponse x

to :: Rep GetAssessmentReportResponse x -> GetAssessmentReportResponse

NFData GetAssessmentReportResponse

Methods

rnf :: GetAssessmentReportResponse -> ()

type Rep GetAssessmentReportResponse

type Rep GetAssessmentReportResponse = D1 * (MetaData "GetAssessmentReportResponse" "Network.AWS.Inspector.GetAssessmentReport" "amazonka-inspector-1.6.0-8Y6k5Gy4CSfF3xkxqKMWTi" False) (C1 * (MetaCons "GetAssessmentReportResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_garrsUrl") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_garrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_garrsStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ReportStatus)))))

Response Lenses

garrsUrl :: Lens' GetAssessmentReportResponse (Maybe Text)

Specifies the URL where you can find the generated assessment report. This parameter is only returned if the report is successfully generated.

garrsResponseStatus :: Lens' GetAssessmentReportResponse Int

• - | The response status code.

garrsStatus :: Lens' GetAssessmentReportResponse ReportStatus

Specifies the status of the request to generate an assessment report.