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 |
Lists information about created campaigns.
This API operation uses pagination. Specify the nextToken
parameter in
the request to return more results.
This operation returns paginated results.
Synopsis
- data ListCampaigns = ListCampaigns' {}
- newListCampaigns :: ListCampaigns
- listCampaigns_maxResults :: Lens' ListCampaigns (Maybe Natural)
- listCampaigns_nextToken :: Lens' ListCampaigns (Maybe Text)
- listCampaigns_status :: Lens' ListCampaigns (Maybe Text)
- data ListCampaignsResponse = ListCampaignsResponse' {}
- newListCampaignsResponse :: Int -> ListCampaignsResponse
- listCampaignsResponse_campaignSummaries :: Lens' ListCampaignsResponse (Maybe [CampaignSummary])
- listCampaignsResponse_nextToken :: Lens' ListCampaignsResponse (Maybe Text)
- listCampaignsResponse_httpStatus :: Lens' ListCampaignsResponse Int
Creating a Request
data ListCampaigns Source #
See: newListCampaigns
smart constructor.
ListCampaigns' | |
|
Instances
newListCampaigns :: ListCampaigns Source #
Create a value of ListCampaigns
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:maxResults:ListCampaigns'
, listCampaigns_maxResults
- The maximum number of items to return, between 1 and 100, inclusive.
ListCampaigns
, listCampaigns_nextToken
- A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are
returned, and a nextToken
pagination token is returned in the
response. To retrieve the next set of results, reissue the search
request and include the returned token. When all results have been
returned, the response does not contain a pagination token value.
ListCampaigns
, listCampaigns_status
- Optional parameter to filter the results by the status of each created
campaign in your account. The status can be one of: CREATING
,
WAITING_FOR_APPROVAL
, RUNNING
, or SUSPENDED
.
Request Lenses
listCampaigns_maxResults :: Lens' ListCampaigns (Maybe Natural) Source #
The maximum number of items to return, between 1 and 100, inclusive.
listCampaigns_nextToken :: Lens' ListCampaigns (Maybe Text) Source #
A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are
returned, and a nextToken
pagination token is returned in the
response. To retrieve the next set of results, reissue the search
request and include the returned token. When all results have been
returned, the response does not contain a pagination token value.
listCampaigns_status :: Lens' ListCampaigns (Maybe Text) Source #
Optional parameter to filter the results by the status of each created
campaign in your account. The status can be one of: CREATING
,
WAITING_FOR_APPROVAL
, RUNNING
, or SUSPENDED
.
Destructuring the Response
data ListCampaignsResponse Source #
See: newListCampaignsResponse
smart constructor.
ListCampaignsResponse' | |
|
Instances
newListCampaignsResponse Source #
Create a value of ListCampaignsResponse
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:campaignSummaries:ListCampaignsResponse'
, listCampaignsResponse_campaignSummaries
- A summary of information about each campaign.
ListCampaigns
, listCampaignsResponse_nextToken
- The token to retrieve the next set of results, or null
if there are no
more results.
$sel:httpStatus:ListCampaignsResponse'
, listCampaignsResponse_httpStatus
- The response's http status code.
Response Lenses
listCampaignsResponse_campaignSummaries :: Lens' ListCampaignsResponse (Maybe [CampaignSummary]) Source #
A summary of information about each campaign.
listCampaignsResponse_nextToken :: Lens' ListCampaignsResponse (Maybe Text) Source #
The token to retrieve the next set of results, or null
if there are no
more results.
listCampaignsResponse_httpStatus :: Lens' ListCampaignsResponse Int Source #
The response's http status code.