Amazonka.Inspector.GetAssessmentReport

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

Creating a Request

data GetAssessmentReport

See: newGetAssessmentReport smart constructor.

Constructors

GetAssessmentReport'

Fields

• assessmentRunArn :: Text

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

• reportFileFormat :: ReportFileFormat

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

• reportType :: 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.

Instances

ToJSON GetAssessmentReport

Defined in Amazonka.Inspector.GetAssessmentReport

Methods

toJSON :: GetAssessmentReport -> Value

toEncoding :: GetAssessmentReport -> Encoding

toJSONList :: [GetAssessmentReport] -> Value

toEncodingList :: [GetAssessmentReport] -> Encoding

ToHeaders GetAssessmentReport

Defined in Amazonka.Inspector.GetAssessmentReport

Methods

toHeaders :: GetAssessmentReport -> [Header]

ToPath GetAssessmentReport

Defined in Amazonka.Inspector.GetAssessmentReport

Methods

toPath :: GetAssessmentReport -> ByteString

ToQuery GetAssessmentReport

Defined in Amazonka.Inspector.GetAssessmentReport

Methods

toQuery :: GetAssessmentReport -> QueryString

AWSRequest GetAssessmentReport

Defined in Amazonka.Inspector.GetAssessmentReport

Associated Types

type AWSResponse GetAssessmentReport

Methods

request :: (Service -> Service) -> GetAssessmentReport -> Request GetAssessmentReport

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetAssessmentReport -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetAssessmentReport)))

Generic GetAssessmentReport

Defined in Amazonka.Inspector.GetAssessmentReport

Associated Types

type Rep GetAssessmentReport :: Type -> Type

Methods

from :: GetAssessmentReport -> Rep GetAssessmentReport x

to :: Rep GetAssessmentReport x -> GetAssessmentReport

Read GetAssessmentReport

Defined in Amazonka.Inspector.GetAssessmentReport

Methods

readsPrec :: Int -> ReadS GetAssessmentReport

readList :: ReadS [GetAssessmentReport]

readPrec :: ReadPrec GetAssessmentReport

readListPrec :: ReadPrec [GetAssessmentReport]

Show GetAssessmentReport

Defined in Amazonka.Inspector.GetAssessmentReport

Methods

showsPrec :: Int -> GetAssessmentReport -> ShowS

show :: GetAssessmentReport -> String

showList :: [GetAssessmentReport] -> ShowS

NFData GetAssessmentReport

Defined in Amazonka.Inspector.GetAssessmentReport

Methods

rnf :: GetAssessmentReport -> ()

Eq GetAssessmentReport

Defined in Amazonka.Inspector.GetAssessmentReport

Methods

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

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

Hashable GetAssessmentReport

Defined in Amazonka.Inspector.GetAssessmentReport

Methods

hashWithSalt :: Int -> GetAssessmentReport -> Int

hash :: GetAssessmentReport -> Int

type AWSResponse GetAssessmentReport

Defined in Amazonka.Inspector.GetAssessmentReport

type AWSResponse GetAssessmentReport = GetAssessmentReportResponse

type Rep GetAssessmentReport

Defined in Amazonka.Inspector.GetAssessmentReport

type Rep GetAssessmentReport = D1 ('MetaData "GetAssessmentReport" "Amazonka.Inspector.GetAssessmentReport" "amazonka-inspector-2.0-DbkSB2KDR0U54GYFqTMz6L" 'False) (C1 ('MetaCons "GetAssessmentReport'" 'PrefixI 'True) (S1 ('MetaSel ('Just "assessmentRunArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "reportFileFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ReportFileFormat) :*: S1 ('MetaSel ('Just "reportType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ReportType))))

newGetAssessmentReport

Arguments

:: Text

GetAssessmentReport

-> ReportFileFormat

$sel:reportFileFormat:GetAssessmentReport'

-> ReportType

$sel:reportType:GetAssessmentReport'

-> GetAssessmentReport

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

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

$sel:reportFileFormat:GetAssessmentReport', getAssessmentReport_reportFileFormat - Specifies the file format (html or pdf) of the assessment report that you want to generate.

$sel:reportType:GetAssessmentReport', 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.

Request Lenses

getAssessmentReport_assessmentRunArn :: Lens' GetAssessmentReport Text

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

getAssessmentReport_reportFileFormat :: Lens' GetAssessmentReport ReportFileFormat

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

getAssessmentReport_reportType :: 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

data GetAssessmentReportResponse

See: newGetAssessmentReportResponse smart constructor.

Constructors

GetAssessmentReportResponse'

Fields

• url :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

• status :: ReportStatus

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

Instances

Generic GetAssessmentReportResponse

Defined in Amazonka.Inspector.GetAssessmentReport

Associated Types

type Rep GetAssessmentReportResponse :: Type -> Type

Methods

from :: GetAssessmentReportResponse -> Rep GetAssessmentReportResponse x

to :: Rep GetAssessmentReportResponse x -> GetAssessmentReportResponse

Read GetAssessmentReportResponse

Defined in Amazonka.Inspector.GetAssessmentReport

Methods

readsPrec :: Int -> ReadS GetAssessmentReportResponse

readList :: ReadS [GetAssessmentReportResponse]

readPrec :: ReadPrec GetAssessmentReportResponse

readListPrec :: ReadPrec [GetAssessmentReportResponse]

Show GetAssessmentReportResponse

Defined in Amazonka.Inspector.GetAssessmentReport

Methods

showsPrec :: Int -> GetAssessmentReportResponse -> ShowS

show :: GetAssessmentReportResponse -> String

showList :: [GetAssessmentReportResponse] -> ShowS

NFData GetAssessmentReportResponse

Defined in Amazonka.Inspector.GetAssessmentReport

Methods

rnf :: GetAssessmentReportResponse -> ()

Eq GetAssessmentReportResponse

Defined in Amazonka.Inspector.GetAssessmentReport

Methods

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

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

type Rep GetAssessmentReportResponse

Defined in Amazonka.Inspector.GetAssessmentReport

type Rep GetAssessmentReportResponse = D1 ('MetaData "GetAssessmentReportResponse" "Amazonka.Inspector.GetAssessmentReport" "amazonka-inspector-2.0-DbkSB2KDR0U54GYFqTMz6L" 'False) (C1 ('MetaCons "GetAssessmentReportResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ReportStatus))))

newGetAssessmentReportResponse

Arguments

:: Int

$sel:httpStatus:GetAssessmentReportResponse'

-> ReportStatus

$sel:status:GetAssessmentReportResponse'

-> GetAssessmentReportResponse

Create a value of GetAssessmentReportResponse 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:url:GetAssessmentReportResponse', getAssessmentReportResponse_url - Specifies the URL where you can find the generated assessment report. This parameter is only returned if the report is successfully generated.

$sel:httpStatus:GetAssessmentReportResponse', getAssessmentReportResponse_httpStatus - The response's http status code.

$sel:status:GetAssessmentReportResponse', getAssessmentReportResponse_status - Specifies the status of the request to generate an assessment report.

Response Lenses

getAssessmentReportResponse_url :: 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.

getAssessmentReportResponse_httpStatus :: Lens' GetAssessmentReportResponse Int

The response's http status code.

getAssessmentReportResponse_status :: Lens' GetAssessmentReportResponse ReportStatus

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