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.CodeGuruProfiler.ListFindingsReports

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

List the available reports for a given profiling group and time range.

Synopsis

data ListFindingsReports = ListFindingsReports' {
- dailyReportsOnly :: Maybe Bool
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- endTime :: ISO8601
- profilingGroupName :: Text
- startTime :: ISO8601
}
newListFindingsReports :: UTCTime -> Text -> UTCTime -> ListFindingsReports
listFindingsReports_dailyReportsOnly :: Lens' ListFindingsReports (Maybe Bool)
listFindingsReports_maxResults :: Lens' ListFindingsReports (Maybe Natural)
listFindingsReports_nextToken :: Lens' ListFindingsReports (Maybe Text)
listFindingsReports_endTime :: Lens' ListFindingsReports UTCTime
listFindingsReports_profilingGroupName :: Lens' ListFindingsReports Text
listFindingsReports_startTime :: Lens' ListFindingsReports UTCTime
data ListFindingsReportsResponse = ListFindingsReportsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- findingsReportSummaries :: [FindingsReportSummary]
}
newListFindingsReportsResponse :: Int -> ListFindingsReportsResponse
listFindingsReportsResponse_nextToken :: Lens' ListFindingsReportsResponse (Maybe Text)
listFindingsReportsResponse_httpStatus :: Lens' ListFindingsReportsResponse Int
listFindingsReportsResponse_findingsReportSummaries :: Lens' ListFindingsReportsResponse [FindingsReportSummary]

Creating a Request

data ListFindingsReports Source #

The structure representing the ListFindingsReportsRequest.

See: newListFindingsReports smart constructor.

Constructors

ListFindingsReports'

Fields

dailyReportsOnly :: Maybe Bool
A Boolean value indicating whether to only return reports from daily profiles. If set to True, only analysis data from daily profiles is returned. If set to False, analysis data is returned from smaller time windows (for example, one hour).
maxResults :: Maybe Natural
The maximum number of report results returned by ListFindingsReports in paginated output. When this parameter is used, ListFindingsReports only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListFindingsReports request with the returned nextToken value.
nextToken :: Maybe Text
The nextToken value returned from a previous paginated ListFindingsReportsRequest request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
endTime :: ISO8601
The end time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
profilingGroupName :: Text
The name of the profiling group from which to search for analysis data.
startTime :: ISO8601
The start time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

Instances

Instances details

ToHeaders ListFindingsReports Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListFindingsReports Methods toHeaders :: ListFindingsReports -> [Header] #
ToPath ListFindingsReports Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListFindingsReports Methods toPath :: ListFindingsReports -> ByteString #
ToQuery ListFindingsReports Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListFindingsReports Methods toQuery :: ListFindingsReports -> QueryString #
AWSRequest ListFindingsReports Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListFindingsReports Associated Types type AWSResponse ListFindingsReports # Methods request :: (Service -> Service) -> ListFindingsReports -> Request ListFindingsReports # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListFindingsReports -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListFindingsReports))) #
Generic ListFindingsReports Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListFindingsReports Associated Types type Rep ListFindingsReports :: Type -> Type # Methods from :: ListFindingsReports -> Rep ListFindingsReports x # to :: Rep ListFindingsReports x -> ListFindingsReports #
Read ListFindingsReports Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListFindingsReports Methods readsPrec :: Int -> ReadS ListFindingsReports # readList :: ReadS [ListFindingsReports] # readPrec :: ReadPrec ListFindingsReports # readListPrec :: ReadPrec [ListFindingsReports] #
Show ListFindingsReports Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListFindingsReports Methods showsPrec :: Int -> ListFindingsReports -> ShowS # show :: ListFindingsReports -> String # showList :: [ListFindingsReports] -> ShowS #
NFData ListFindingsReports Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListFindingsReports Methods rnf :: ListFindingsReports -> () #
Eq ListFindingsReports Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListFindingsReports Methods (==) :: ListFindingsReports -> ListFindingsReports -> Bool # (/=) :: ListFindingsReports -> ListFindingsReports -> Bool #
Hashable ListFindingsReports Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListFindingsReports Methods hashWithSalt :: Int -> ListFindingsReports -> Int # hash :: ListFindingsReports -> Int #
type AWSResponse ListFindingsReports Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListFindingsReports type AWSResponse ListFindingsReports = ListFindingsReportsResponse
type Rep ListFindingsReports Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListFindingsReports type Rep ListFindingsReports = D1 ('MetaData "ListFindingsReports" "Amazonka.CodeGuruProfiler.ListFindingsReports" "amazonka-codeguruprofiler-2.0-DsjyOqDx8Zb8uCUpe33U62" 'False) (C1 ('MetaCons "ListFindingsReports'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dailyReportsOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601) :: (S1 ('MetaSel ('Just "profilingGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601)))))

newListFindingsReports Source #

Arguments

:: UTCTime	`ListFindingsReports`
-> Text	`ListFindingsReports`
-> UTCTime	`ListFindingsReports`
-> ListFindingsReports

Create a value of ListFindingsReports 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:dailyReportsOnly:ListFindingsReports', listFindingsReports_dailyReportsOnly - A Boolean value indicating whether to only return reports from daily profiles. If set to True, only analysis data from daily profiles is returned. If set to False, analysis data is returned from smaller time windows (for example, one hour).

$sel:maxResults:ListFindingsReports', listFindingsReports_maxResults - The maximum number of report results returned by ListFindingsReports in paginated output. When this parameter is used, ListFindingsReports only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListFindingsReports request with the returned nextToken value.

ListFindingsReports, listFindingsReports_nextToken - The nextToken value returned from a previous paginated ListFindingsReportsRequest request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

ListFindingsReports, listFindingsReports_endTime - The end time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

ListFindingsReports, listFindingsReports_profilingGroupName - The name of the profiling group from which to search for analysis data.

ListFindingsReports, listFindingsReports_startTime - The start time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

Request Lenses

listFindingsReports_dailyReportsOnly :: Lens' ListFindingsReports (Maybe Bool) Source #

A Boolean value indicating whether to only return reports from daily profiles. If set to True, only analysis data from daily profiles is returned. If set to False, analysis data is returned from smaller time windows (for example, one hour).

listFindingsReports_maxResults :: Lens' ListFindingsReports (Maybe Natural) Source #

The maximum number of report results returned by ListFindingsReports in paginated output. When this parameter is used, ListFindingsReports only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListFindingsReports request with the returned nextToken value.

listFindingsReports_nextToken :: Lens' ListFindingsReports (Maybe Text) Source #

The nextToken value returned from a previous paginated ListFindingsReportsRequest request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

listFindingsReports_endTime :: Lens' ListFindingsReports UTCTime Source #

The end time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

listFindingsReports_profilingGroupName :: Lens' ListFindingsReports Text Source #

The name of the profiling group from which to search for analysis data.

listFindingsReports_startTime :: Lens' ListFindingsReports UTCTime Source #

The start time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

Destructuring the Response

data ListFindingsReportsResponse Source #

The structure representing the ListFindingsReportsResponse.

See: newListFindingsReportsResponse smart constructor.

Constructors

ListFindingsReportsResponse'

Fields

nextToken :: Maybe Text
The nextToken value to include in a future ListFindingsReports request. When the results of a ListFindingsReports request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
httpStatus :: Int
The response's http status code.
findingsReportSummaries :: [FindingsReportSummary]
The list of analysis results summaries.

Instances

Instances details

Generic ListFindingsReportsResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListFindingsReports Associated Types type Rep ListFindingsReportsResponse :: Type -> Type # Methods from :: ListFindingsReportsResponse -> Rep ListFindingsReportsResponse x # to :: Rep ListFindingsReportsResponse x -> ListFindingsReportsResponse #
Read ListFindingsReportsResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListFindingsReports Methods readsPrec :: Int -> ReadS ListFindingsReportsResponse # readList :: ReadS [ListFindingsReportsResponse] # readPrec :: ReadPrec ListFindingsReportsResponse # readListPrec :: ReadPrec [ListFindingsReportsResponse] #
Show ListFindingsReportsResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListFindingsReports Methods showsPrec :: Int -> ListFindingsReportsResponse -> ShowS # show :: ListFindingsReportsResponse -> String # showList :: [ListFindingsReportsResponse] -> ShowS #
NFData ListFindingsReportsResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListFindingsReports Methods rnf :: ListFindingsReportsResponse -> () #
Eq ListFindingsReportsResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListFindingsReports Methods (==) :: ListFindingsReportsResponse -> ListFindingsReportsResponse -> Bool # (/=) :: ListFindingsReportsResponse -> ListFindingsReportsResponse -> Bool #
type Rep ListFindingsReportsResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListFindingsReports type Rep ListFindingsReportsResponse = D1 ('MetaData "ListFindingsReportsResponse" "Amazonka.CodeGuruProfiler.ListFindingsReports" "amazonka-codeguruprofiler-2.0-DsjyOqDx8Zb8uCUpe33U62" 'False) (C1 ('MetaCons "ListFindingsReportsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "findingsReportSummaries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [FindingsReportSummary]))))

newListFindingsReportsResponse Source #

Arguments

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

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

ListFindingsReports, listFindingsReportsResponse_nextToken - The nextToken value to include in a future ListFindingsReports request. When the results of a ListFindingsReports request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

$sel:httpStatus:ListFindingsReportsResponse', listFindingsReportsResponse_httpStatus - The response's http status code.

$sel:findingsReportSummaries:ListFindingsReportsResponse', listFindingsReportsResponse_findingsReportSummaries - The list of analysis results summaries.

Response Lenses

listFindingsReportsResponse_nextToken :: Lens' ListFindingsReportsResponse (Maybe Text) Source #

The nextToken value to include in a future ListFindingsReports request. When the results of a ListFindingsReports request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

listFindingsReportsResponse_httpStatus :: Lens' ListFindingsReportsResponse Int Source #

The response's http status code.

listFindingsReportsResponse_findingsReportSummaries :: Lens' ListFindingsReportsResponse [FindingsReportSummary] Source #

The list of analysis results summaries.