libZSservicesZSamazonka-personalizeZSamazonka-personalize
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

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

Creating a Request

data ListCampaigns Source #

See: newListCampaigns smart constructor.

Constructors

ListCampaigns' 

Fields

  • solutionArn :: Maybe Text

    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.

  • nextToken :: Maybe Text

    A token returned from the previous call to ListCampaigns for getting the next set of campaigns (if they exist).

  • maxResults :: Maybe Natural

    The maximum number of campaigns to return.

Instances

Instances details
Eq ListCampaigns Source # 
Instance details

Defined in Amazonka.Personalize.ListCampaigns

Methods

(==) :: ListCampaigns -> ListCampaigns -> Bool #

(/=) :: ListCampaigns -> ListCampaigns -> Bool #

Read ListCampaigns Source # 
Instance details

Defined in Amazonka.Personalize.ListCampaigns

Methods

readsPrec :: Int -> ReadS ListCampaigns #

readList :: ReadS [ListCampaigns] #

readPrec :: ReadPrec ListCampaigns #

readListPrec :: ReadPrec [ListCampaigns] #

Show ListCampaigns Source # 
Instance details

Defined in Amazonka.Personalize.ListCampaigns

Methods

showsPrec :: Int -> ListCampaigns -> ShowS #

show :: ListCampaigns -> String #

showList :: [ListCampaigns] -> ShowS #

Generic ListCampaigns Source # 
Instance details

Defined in Amazonka.Personalize.ListCampaigns

Associated Types

type Rep ListCampaigns :: Type -> Type #

Methods

from :: ListCampaigns -> Rep ListCampaigns x #

to :: Rep ListCampaigns x -> ListCampaigns #

NFData ListCampaigns Source # 
Instance details

Defined in Amazonka.Personalize.ListCampaigns

Methods

rnf :: ListCampaigns -> () #

Hashable ListCampaigns Source # 
Instance details

Defined in Amazonka.Personalize.ListCampaigns

Methods

hashWithSalt :: Int -> ListCampaigns -> Int #

hash :: ListCampaigns -> Int #

ToJSON ListCampaigns Source # 
Instance details

Defined in Amazonka.Personalize.ListCampaigns

Methods

toJSON :: ListCampaigns -> Value #

toEncoding :: ListCampaigns -> Encoding #

toJSONList :: [ListCampaigns] -> Value #

toEncodingList :: [ListCampaigns] -> Encoding #

AWSPager ListCampaigns Source # 
Instance details

Defined in Amazonka.Personalize.ListCampaigns

Methods

page :: ListCampaigns -> AWSResponse ListCampaigns -> Maybe ListCampaigns #

AWSRequest ListCampaigns Source # 
Instance details

Defined in Amazonka.Personalize.ListCampaigns

Associated Types

type AWSResponse ListCampaigns #

Methods

request :: ListCampaigns -> Request ListCampaigns #

response :: MonadResource m => Logger -> Service -> Proxy ListCampaigns -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListCampaigns))) #

ToHeaders ListCampaigns Source # 
Instance details

Defined in Amazonka.Personalize.ListCampaigns

Methods

toHeaders :: ListCampaigns -> [Header] #

ToPath ListCampaigns Source # 
Instance details

Defined in Amazonka.Personalize.ListCampaigns

Methods

toPath :: ListCampaigns -> ByteString #

ToQuery ListCampaigns Source # 
Instance details

Defined in Amazonka.Personalize.ListCampaigns

Methods

toQuery :: ListCampaigns -> QueryString #

type Rep ListCampaigns Source # 
Instance details

Defined in Amazonka.Personalize.ListCampaigns

type Rep ListCampaigns = D1 ('MetaData "ListCampaigns" "Amazonka.Personalize.ListCampaigns" "libZSservicesZSamazonka-personalizeZSamazonka-personalize" 'False) (C1 ('MetaCons "ListCampaigns'" 'PrefixI 'True) (S1 ('MetaSel ('Just "solutionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListCampaigns Source # 
Instance details

Defined in Amazonka.Personalize.ListCampaigns

type AWSResponse ListCampaigns = ListCampaignsResponse

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:solutionArn: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.

$sel:nextToken:ListCampaigns', listCampaigns_nextToken - A token returned from the previous call to ListCampaigns for getting the next set of campaigns (if they exist).

$sel:maxResults:ListCampaigns', listCampaigns_maxResults - The maximum number of campaigns to return.

Request Lenses

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.

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_maxResults :: Lens' ListCampaigns (Maybe Natural) Source #

The maximum number of campaigns to return.

Destructuring the Response

data ListCampaignsResponse Source #

See: newListCampaignsResponse smart constructor.

Constructors

ListCampaignsResponse' 

Fields

Instances

Instances details
Eq ListCampaignsResponse Source # 
Instance details

Defined in Amazonka.Personalize.ListCampaigns

Methods

(==) :: ListCampaignsResponse -> ListCampaignsResponse -> Bool #

(/=) :: ListCampaignsResponse -> ListCampaignsResponse -> Bool #

Read ListCampaignsResponse Source # 
Instance details

Defined in Amazonka.Personalize.ListCampaigns

Methods

readsPrec :: Int -> ReadS ListCampaignsResponse #

readList :: ReadS [ListCampaignsResponse] #

readPrec :: ReadPrec ListCampaignsResponse #

readListPrec :: ReadPrec [ListCampaignsResponse] #

Show ListCampaignsResponse Source # 
Instance details

Defined in Amazonka.Personalize.ListCampaigns

Methods

showsPrec :: Int -> ListCampaignsResponse -> ShowS #

show :: ListCampaignsResponse -> String #

showList :: [ListCampaignsResponse] -> ShowS #

Generic ListCampaignsResponse Source # 
Instance details

Defined in Amazonka.Personalize.ListCampaigns

Associated Types

type Rep ListCampaignsResponse :: Type -> Type #

Methods

from :: ListCampaignsResponse -> Rep ListCampaignsResponse x #

to :: Rep ListCampaignsResponse x -> ListCampaignsResponse #

NFData ListCampaignsResponse Source # 
Instance details

Defined in Amazonka.Personalize.ListCampaigns

Methods

rnf :: ListCampaignsResponse -> () #

type Rep ListCampaignsResponse Source # 
Instance details

Defined in Amazonka.Personalize.ListCampaigns

type Rep ListCampaignsResponse = D1 ('MetaData "ListCampaignsResponse" "Amazonka.Personalize.ListCampaigns" "libZSservicesZSamazonka-personalizeZSamazonka-personalize" 'False) (C1 ('MetaCons "ListCampaignsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "campaigns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CampaignSummary])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListCampaignsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListCampaignsResponse'

-> ListCampaignsResponse 

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.

$sel:nextToken: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.