| 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.CodeBuild.ListReports
Description
Returns a list of ARNs for the reports in the current Amazon Web Services account.
This operation returns paginated results.
Synopsis
- data ListReports = ListReports' {}
- newListReports :: ListReports
- listReports_filter :: Lens' ListReports (Maybe ReportFilter)
- listReports_maxResults :: Lens' ListReports (Maybe Natural)
- listReports_nextToken :: Lens' ListReports (Maybe Text)
- listReports_sortOrder :: Lens' ListReports (Maybe SortOrderType)
- data ListReportsResponse = ListReportsResponse' {}
- newListReportsResponse :: Int -> ListReportsResponse
- listReportsResponse_nextToken :: Lens' ListReportsResponse (Maybe Text)
- listReportsResponse_reports :: Lens' ListReportsResponse (Maybe (NonEmpty Text))
- listReportsResponse_httpStatus :: Lens' ListReportsResponse Int
Creating a Request
data ListReports Source #
See: newListReports smart constructor.
Constructors
| ListReports' | |
Fields
| |
Instances
newListReports :: ListReports Source #
Create a value of ListReports 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':ListReports', listReports_filter - A ReportFilter object used to filter the returned reports.
$sel:maxResults:ListReports', listReports_maxResults - The maximum number of paginated reports returned per response. Use
nextToken to iterate pages in the list of returned Report objects.
The default value is 100.
ListReports, listReports_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:ListReports', listReports_sortOrder - Specifies the sort order for the list of returned reports. Valid values
are:
ASCENDING: return reports in chronological order based on their creation date.DESCENDING: return reports in the reverse chronological order based on their creation date.
Request Lenses
listReports_filter :: Lens' ListReports (Maybe ReportFilter) Source #
A ReportFilter object used to filter the returned reports.
listReports_maxResults :: Lens' ListReports (Maybe Natural) Source #
The maximum number of paginated reports returned per response. Use
nextToken to iterate pages in the list of returned Report objects.
The default value is 100.
listReports_nextToken :: Lens' ListReports (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.
listReports_sortOrder :: Lens' ListReports (Maybe SortOrderType) Source #
Specifies the sort order for the list of returned reports. Valid values are:
ASCENDING: return reports in chronological order based on their creation date.DESCENDING: return reports in the reverse chronological order based on their creation date.
Destructuring the Response
data ListReportsResponse Source #
See: newListReportsResponse smart constructor.
Constructors
| ListReportsResponse' | |
Fields
| |
Instances
newListReportsResponse Source #
Arguments
| :: Int | |
| -> ListReportsResponse |
Create a value of ListReportsResponse 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:
ListReports, listReportsResponse_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:ListReportsResponse', listReportsResponse_reports - The list of returned ARNs for the reports in the current Amazon Web
Services account.
$sel:httpStatus:ListReportsResponse', listReportsResponse_httpStatus - The response's http status code.
Response Lenses
listReportsResponse_nextToken :: Lens' ListReportsResponse (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.
listReportsResponse_reports :: Lens' ListReportsResponse (Maybe (NonEmpty Text)) Source #
The list of returned ARNs for the reports in the current Amazon Web Services account.
listReportsResponse_httpStatus :: Lens' ListReportsResponse Int Source #
The response's http status code.