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 |
Returns a list of ARNs for the reports that belong to a ReportGroup
.
This operation returns paginated results.
Synopsis
- data ListReportsForReportGroup = ListReportsForReportGroup' {}
- newListReportsForReportGroup :: Text -> ListReportsForReportGroup
- listReportsForReportGroup_filter :: Lens' ListReportsForReportGroup (Maybe ReportFilter)
- listReportsForReportGroup_maxResults :: Lens' ListReportsForReportGroup (Maybe Natural)
- listReportsForReportGroup_nextToken :: Lens' ListReportsForReportGroup (Maybe Text)
- listReportsForReportGroup_sortOrder :: Lens' ListReportsForReportGroup (Maybe SortOrderType)
- listReportsForReportGroup_reportGroupArn :: Lens' ListReportsForReportGroup Text
- data ListReportsForReportGroupResponse = ListReportsForReportGroupResponse' {}
- newListReportsForReportGroupResponse :: Int -> ListReportsForReportGroupResponse
- listReportsForReportGroupResponse_nextToken :: Lens' ListReportsForReportGroupResponse (Maybe Text)
- listReportsForReportGroupResponse_reports :: Lens' ListReportsForReportGroupResponse (Maybe (NonEmpty Text))
- listReportsForReportGroupResponse_httpStatus :: Lens' ListReportsForReportGroupResponse Int
Creating a Request
data ListReportsForReportGroup Source #
See: newListReportsForReportGroup
smart constructor.
ListReportsForReportGroup' | |
|
Instances
newListReportsForReportGroup Source #
Create a value of ListReportsForReportGroup
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:filter':ListReportsForReportGroup'
, listReportsForReportGroup_filter
- A ReportFilter
object used to filter the returned reports.
$sel:maxResults:ListReportsForReportGroup'
, listReportsForReportGroup_maxResults
- The maximum number of paginated reports in this report group returned
per response. Use nextToken
to iterate pages in the list of returned
Report
objects. The default value is 100.
ListReportsForReportGroup
, listReportsForReportGroup_nextToken
- During a previous call, the maximum number of items that can be returned
is the value specified in maxResults
. If there more items in the list,
then a unique string called a nextToken is returned. To get the next
batch of items in the list, call this operation again, adding the next
token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until
no more next tokens are returned.
$sel:sortOrder:ListReportsForReportGroup'
, listReportsForReportGroup_sortOrder
- Use to specify whether the results are returned in ascending or
descending order.
ListReportsForReportGroup
, listReportsForReportGroup_reportGroupArn
- The ARN of the report group for which you want to return report ARNs.
Request Lenses
listReportsForReportGroup_filter :: Lens' ListReportsForReportGroup (Maybe ReportFilter) Source #
A ReportFilter
object used to filter the returned reports.
listReportsForReportGroup_maxResults :: Lens' ListReportsForReportGroup (Maybe Natural) Source #
The maximum number of paginated reports in this report group returned
per response. Use nextToken
to iterate pages in the list of returned
Report
objects. The default value is 100.
listReportsForReportGroup_nextToken :: Lens' ListReportsForReportGroup (Maybe Text) Source #
During a previous call, the maximum number of items that can be returned
is the value specified in maxResults
. If there more items in the list,
then a unique string called a nextToken is returned. To get the next
batch of items in the list, call this operation again, adding the next
token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until
no more next tokens are returned.
listReportsForReportGroup_sortOrder :: Lens' ListReportsForReportGroup (Maybe SortOrderType) Source #
Use to specify whether the results are returned in ascending or descending order.
listReportsForReportGroup_reportGroupArn :: Lens' ListReportsForReportGroup Text Source #
The ARN of the report group for which you want to return report ARNs.
Destructuring the Response
data ListReportsForReportGroupResponse Source #
See: newListReportsForReportGroupResponse
smart constructor.
ListReportsForReportGroupResponse' | |
|
Instances
newListReportsForReportGroupResponse Source #
Create a value of ListReportsForReportGroupResponse
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:
ListReportsForReportGroup
, listReportsForReportGroupResponse_nextToken
- During a previous call, the maximum number of items that can be returned
is the value specified in maxResults
. If there more items in the list,
then a unique string called a nextToken is returned. To get the next
batch of items in the list, call this operation again, adding the next
token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until
no more next tokens are returned.
$sel:reports:ListReportsForReportGroupResponse'
, listReportsForReportGroupResponse_reports
- The list of report ARNs.
$sel:httpStatus:ListReportsForReportGroupResponse'
, listReportsForReportGroupResponse_httpStatus
- The response's http status code.
Response Lenses
listReportsForReportGroupResponse_nextToken :: Lens' ListReportsForReportGroupResponse (Maybe Text) Source #
During a previous call, the maximum number of items that can be returned
is the value specified in maxResults
. If there more items in the list,
then a unique string called a nextToken is returned. To get the next
batch of items in the list, call this operation again, adding the next
token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until
no more next tokens are returned.
listReportsForReportGroupResponse_reports :: Lens' ListReportsForReportGroupResponse (Maybe (NonEmpty Text)) Source #
The list of report ARNs.
listReportsForReportGroupResponse_httpStatus :: Lens' ListReportsForReportGroupResponse Int Source #
The response's http status code.