| 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.Personalize.ListCampaigns
Description
Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.
This operation returns paginated results.
Synopsis
- data ListCampaigns = ListCampaigns' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- solutionArn :: Maybe Text
- newListCampaigns :: ListCampaigns
- listCampaigns_maxResults :: Lens' ListCampaigns (Maybe Natural)
- listCampaigns_nextToken :: Lens' ListCampaigns (Maybe Text)
- listCampaigns_solutionArn :: Lens' ListCampaigns (Maybe Text)
- data ListCampaignsResponse = ListCampaignsResponse' {
- campaigns :: Maybe [CampaignSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListCampaignsResponse :: Int -> ListCampaignsResponse
- listCampaignsResponse_campaigns :: 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.
Constructors
| ListCampaigns' | |
Fields
| |
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 campaigns to return.
ListCampaigns, listCampaigns_nextToken - A token returned from the previous call to
ListCampaigns
for getting the next set of campaigns (if they exist).
ListCampaigns, listCampaigns_solutionArn - The Amazon Resource Name (ARN) of the solution to list the campaigns
for. When a solution is not specified, all the campaigns associated with
the account are listed.
Request Lenses
listCampaigns_maxResults :: Lens' ListCampaigns (Maybe Natural) Source #
The maximum number of campaigns to return.
listCampaigns_nextToken :: Lens' ListCampaigns (Maybe Text) Source #
A token returned from the previous call to ListCampaigns for getting the next set of campaigns (if they exist).
listCampaigns_solutionArn :: Lens' ListCampaigns (Maybe Text) Source #
The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a solution is not specified, all the campaigns associated with the account are listed.
Destructuring the Response
data ListCampaignsResponse Source #
See: newListCampaignsResponse smart constructor.
Constructors
| ListCampaignsResponse' | |
Fields
| |
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:campaigns:ListCampaignsResponse', listCampaignsResponse_campaigns - A list of the campaigns.
ListCampaigns, listCampaignsResponse_nextToken - A token for getting the next set of campaigns (if they exist).
$sel:httpStatus:ListCampaignsResponse', listCampaignsResponse_httpStatus - The response's http status code.
Response Lenses
listCampaignsResponse_campaigns :: Lens' ListCampaignsResponse (Maybe [CampaignSummary]) Source #
A list of the campaigns.
listCampaignsResponse_nextToken :: Lens' ListCampaignsResponse (Maybe Text) Source #
A token for getting the next set of campaigns (if they exist).
listCampaignsResponse_httpStatus :: Lens' ListCampaignsResponse Int Source #
The response's http status code.