libZSservicesZSamazonka-pinpointZSamazonka-pinpoint
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.Pinpoint.GetCampaigns

Description

Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.

Synopsis

Creating a Request

data GetCampaigns Source #

See: newGetCampaigns smart constructor.

Constructors

GetCampaigns' 

Fields

  • token :: Maybe Text

    The NextToken string that specifies which page of results to return in a paginated response.

  • pageSize :: Maybe Text

    The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

  • applicationId :: Text

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Instances

Instances details
Eq GetCampaigns Source # 
Instance details

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

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

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

Read GetCampaigns Source # 
Instance details

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

readsPrec :: Int -> ReadS GetCampaigns #

readList :: ReadS [GetCampaigns] #

readPrec :: ReadPrec GetCampaigns #

readListPrec :: ReadPrec [GetCampaigns] #

Show GetCampaigns Source # 
Instance details

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

showsPrec :: Int -> GetCampaigns -> ShowS #

show :: GetCampaigns -> String #

showList :: [GetCampaigns] -> ShowS #

Generic GetCampaigns Source # 
Instance details

Defined in Amazonka.Pinpoint.GetCampaigns

Associated Types

type Rep GetCampaigns :: Type -> Type #

Methods

from :: GetCampaigns -> Rep GetCampaigns x #

to :: Rep GetCampaigns x -> GetCampaigns #

NFData GetCampaigns Source # 
Instance details

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

rnf :: GetCampaigns -> () #

Hashable GetCampaigns Source # 
Instance details

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

hashWithSalt :: Int -> GetCampaigns -> Int #

hash :: GetCampaigns -> Int #

AWSRequest GetCampaigns Source # 
Instance details

Defined in Amazonka.Pinpoint.GetCampaigns

Associated Types

type AWSResponse GetCampaigns #

Methods

request :: GetCampaigns -> Request GetCampaigns #

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

ToHeaders GetCampaigns Source # 
Instance details

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

toHeaders :: GetCampaigns -> [Header] #

ToPath GetCampaigns Source # 
Instance details

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

toPath :: GetCampaigns -> ByteString #

ToQuery GetCampaigns Source # 
Instance details

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

toQuery :: GetCampaigns -> QueryString #

type Rep GetCampaigns Source # 
Instance details

Defined in Amazonka.Pinpoint.GetCampaigns

type Rep GetCampaigns = D1 ('MetaData "GetCampaigns" "Amazonka.Pinpoint.GetCampaigns" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "GetCampaigns'" 'PrefixI 'True) (S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "pageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse GetCampaigns Source # 
Instance details

Defined in Amazonka.Pinpoint.GetCampaigns

type AWSResponse GetCampaigns = GetCampaignsResponse

newGetCampaigns Source #

Arguments

:: Text

$sel:applicationId:GetCampaigns'

-> GetCampaigns 

Create a value of GetCampaigns 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:token:GetCampaigns', getCampaigns_token - The NextToken string that specifies which page of results to return in a paginated response.

$sel:pageSize:GetCampaigns', getCampaigns_pageSize - The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

$sel:applicationId:GetCampaigns', getCampaigns_applicationId - The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Request Lenses

getCampaigns_token :: Lens' GetCampaigns (Maybe Text) Source #

The NextToken string that specifies which page of results to return in a paginated response.

getCampaigns_pageSize :: Lens' GetCampaigns (Maybe Text) Source #

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

getCampaigns_applicationId :: Lens' GetCampaigns Text Source #

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Destructuring the Response

data GetCampaignsResponse Source #

See: newGetCampaignsResponse smart constructor.

Constructors

GetCampaignsResponse' 

Fields

Instances

Instances details
Eq GetCampaignsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

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

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

Read GetCampaignsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

readsPrec :: Int -> ReadS GetCampaignsResponse #

readList :: ReadS [GetCampaignsResponse] #

readPrec :: ReadPrec GetCampaignsResponse #

readListPrec :: ReadPrec [GetCampaignsResponse] #

Show GetCampaignsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

showsPrec :: Int -> GetCampaignsResponse -> ShowS #

show :: GetCampaignsResponse -> String #

showList :: [GetCampaignsResponse] -> ShowS #

Generic GetCampaignsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetCampaigns

Associated Types

type Rep GetCampaignsResponse :: Type -> Type #

Methods

from :: GetCampaignsResponse -> Rep GetCampaignsResponse x #

to :: Rep GetCampaignsResponse x -> GetCampaignsResponse #

NFData GetCampaignsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

rnf :: GetCampaignsResponse -> () #

type Rep GetCampaignsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetCampaigns

type Rep GetCampaignsResponse = D1 ('MetaData "GetCampaignsResponse" "Amazonka.Pinpoint.GetCampaigns" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "GetCampaignsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "campaignsResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CampaignsResponse)))

newGetCampaignsResponse Source #

Arguments

:: Int

$sel:httpStatus:GetCampaignsResponse'

-> CampaignsResponse

$sel:campaignsResponse:GetCampaignsResponse'

-> GetCampaignsResponse 

Create a value of GetCampaignsResponse 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:httpStatus:GetCampaignsResponse', getCampaignsResponse_httpStatus - The response's http status code.

$sel:campaignsResponse:GetCampaignsResponse', getCampaignsResponse_campaignsResponse - Undocumented member.

Response Lenses

getCampaignsResponse_httpStatus :: Lens' GetCampaignsResponse Int Source #

The response's http status code.

getCampaignsResponse_campaignsResponse :: Lens' GetCampaignsResponse CampaignsResponse Source #

Undocumented member.