Amazonka.Pinpoint.GetCampaigns

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

Creating a Request

data GetCampaigns

See: newGetCampaigns smart constructor.

Constructors

GetCampaigns'

Fields

• 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.

• token :: Maybe Text

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

• applicationId :: Text

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

Instances

ToHeaders GetCampaigns

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

toHeaders :: GetCampaigns -> [Header]

ToPath GetCampaigns

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

toPath :: GetCampaigns -> ByteString

ToQuery GetCampaigns

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

toQuery :: GetCampaigns -> QueryString

AWSRequest GetCampaigns

Defined in Amazonka.Pinpoint.GetCampaigns

Associated Types

type AWSResponse GetCampaigns

Methods

request :: (Service -> Service) -> GetCampaigns -> Request GetCampaigns

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

Generic GetCampaigns

Defined in Amazonka.Pinpoint.GetCampaigns

Associated Types

type Rep GetCampaigns :: Type -> Type

Methods

from :: GetCampaigns -> Rep GetCampaigns x

to :: Rep GetCampaigns x -> GetCampaigns

Read GetCampaigns

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

readsPrec :: Int -> ReadS GetCampaigns

readList :: ReadS [GetCampaigns]

readPrec :: ReadPrec GetCampaigns

readListPrec :: ReadPrec [GetCampaigns]

Show GetCampaigns

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

showsPrec :: Int -> GetCampaigns -> ShowS

show :: GetCampaigns -> String

showList :: [GetCampaigns] -> ShowS

NFData GetCampaigns

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

rnf :: GetCampaigns -> ()

Eq GetCampaigns

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

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

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

Hashable GetCampaigns

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

hashWithSalt :: Int -> GetCampaigns -> Int

hash :: GetCampaigns -> Int

type AWSResponse GetCampaigns

Defined in Amazonka.Pinpoint.GetCampaigns

type AWSResponse GetCampaigns = GetCampaignsResponse

type Rep GetCampaigns

Defined in Amazonka.Pinpoint.GetCampaigns

type Rep GetCampaigns = D1 ('MetaData "GetCampaigns" "Amazonka.Pinpoint.GetCampaigns" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "GetCampaigns'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetCampaigns

Arguments

:: Text

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

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_pageSize :: Lens' GetCampaigns (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.

getCampaigns_token :: Lens' GetCampaigns (Maybe Text)

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

getCampaigns_applicationId :: Lens' GetCampaigns Text

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

Destructuring the Response

data GetCampaignsResponse

See: newGetCampaignsResponse smart constructor.

Constructors

GetCampaignsResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• campaignsResponse :: CampaignsResponse

Instances

Generic GetCampaignsResponse

Defined in Amazonka.Pinpoint.GetCampaigns

Associated Types

type Rep GetCampaignsResponse :: Type -> Type

Methods

from :: GetCampaignsResponse -> Rep GetCampaignsResponse x

to :: Rep GetCampaignsResponse x -> GetCampaignsResponse

Read GetCampaignsResponse

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

readsPrec :: Int -> ReadS GetCampaignsResponse

readList :: ReadS [GetCampaignsResponse]

readPrec :: ReadPrec GetCampaignsResponse

readListPrec :: ReadPrec [GetCampaignsResponse]

Show GetCampaignsResponse

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

showsPrec :: Int -> GetCampaignsResponse -> ShowS

show :: GetCampaignsResponse -> String

showList :: [GetCampaignsResponse] -> ShowS

NFData GetCampaignsResponse

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

rnf :: GetCampaignsResponse -> ()

Eq GetCampaignsResponse

Defined in Amazonka.Pinpoint.GetCampaigns

Methods

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

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

type Rep GetCampaignsResponse

Defined in Amazonka.Pinpoint.GetCampaigns

type Rep GetCampaignsResponse = D1 ('MetaData "GetCampaignsResponse" "Amazonka.Pinpoint.GetCampaigns" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" '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

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

The response's http status code.

getCampaignsResponse_campaignsResponse :: Lens' GetCampaignsResponse CampaignsResponse

Undocumented member.