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.Pinpoint.GetCampaignActivities

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about all the activities for a campaign.

Synopsis

data GetCampaignActivities = GetCampaignActivities' {
- pageSize :: Maybe Text
- token :: Maybe Text
- applicationId :: Text
- campaignId :: Text
}
newGetCampaignActivities :: Text -> Text -> GetCampaignActivities
getCampaignActivities_pageSize :: Lens' GetCampaignActivities (Maybe Text)
getCampaignActivities_token :: Lens' GetCampaignActivities (Maybe Text)
getCampaignActivities_applicationId :: Lens' GetCampaignActivities Text
getCampaignActivities_campaignId :: Lens' GetCampaignActivities Text
data GetCampaignActivitiesResponse = GetCampaignActivitiesResponse' {
- httpStatus :: Int
- activitiesResponse :: ActivitiesResponse
}
newGetCampaignActivitiesResponse :: Int -> ActivitiesResponse -> GetCampaignActivitiesResponse
getCampaignActivitiesResponse_httpStatus :: Lens' GetCampaignActivitiesResponse Int
getCampaignActivitiesResponse_activitiesResponse :: Lens' GetCampaignActivitiesResponse ActivitiesResponse

Creating a Request

data GetCampaignActivities Source #

See: newGetCampaignActivities smart constructor.

Constructors

GetCampaignActivities'

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.
campaignId :: Text
The unique identifier for the campaign.

Instances

Instances details

ToHeaders GetCampaignActivities Source #
Instance details Defined in Amazonka.Pinpoint.GetCampaignActivities Methods toHeaders :: GetCampaignActivities -> [Header] #
ToPath GetCampaignActivities Source #
Instance details Defined in Amazonka.Pinpoint.GetCampaignActivities Methods toPath :: GetCampaignActivities -> ByteString #
ToQuery GetCampaignActivities Source #
Instance details Defined in Amazonka.Pinpoint.GetCampaignActivities Methods toQuery :: GetCampaignActivities -> QueryString #
AWSRequest GetCampaignActivities Source #
Instance details Defined in Amazonka.Pinpoint.GetCampaignActivities Associated Types type AWSResponse GetCampaignActivities # Methods request :: (Service -> Service) -> GetCampaignActivities -> Request GetCampaignActivities # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetCampaignActivities -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetCampaignActivities))) #
Generic GetCampaignActivities Source #
Instance details Defined in Amazonka.Pinpoint.GetCampaignActivities Associated Types type Rep GetCampaignActivities :: Type -> Type # Methods from :: GetCampaignActivities -> Rep GetCampaignActivities x # to :: Rep GetCampaignActivities x -> GetCampaignActivities #
Read GetCampaignActivities Source #
Instance details Defined in Amazonka.Pinpoint.GetCampaignActivities Methods readsPrec :: Int -> ReadS GetCampaignActivities # readList :: ReadS [GetCampaignActivities] # readPrec :: ReadPrec GetCampaignActivities # readListPrec :: ReadPrec [GetCampaignActivities] #
Show GetCampaignActivities Source #
Instance details Defined in Amazonka.Pinpoint.GetCampaignActivities Methods showsPrec :: Int -> GetCampaignActivities -> ShowS # show :: GetCampaignActivities -> String # showList :: [GetCampaignActivities] -> ShowS #
NFData GetCampaignActivities Source #
Instance details Defined in Amazonka.Pinpoint.GetCampaignActivities Methods rnf :: GetCampaignActivities -> () #
Eq GetCampaignActivities Source #
Instance details Defined in Amazonka.Pinpoint.GetCampaignActivities Methods (==) :: GetCampaignActivities -> GetCampaignActivities -> Bool # (/=) :: GetCampaignActivities -> GetCampaignActivities -> Bool #
Hashable GetCampaignActivities Source #
Instance details Defined in Amazonka.Pinpoint.GetCampaignActivities Methods hashWithSalt :: Int -> GetCampaignActivities -> Int # hash :: GetCampaignActivities -> Int #
type AWSResponse GetCampaignActivities Source #
Instance details Defined in Amazonka.Pinpoint.GetCampaignActivities type AWSResponse GetCampaignActivities = GetCampaignActivitiesResponse
type Rep GetCampaignActivities Source #
Instance details Defined in Amazonka.Pinpoint.GetCampaignActivities type Rep GetCampaignActivities = D1 ('MetaData "GetCampaignActivities" "Amazonka.Pinpoint.GetCampaignActivities" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "GetCampaignActivities'" '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) :*: S1 ('MetaSel ('Just "campaignId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetCampaignActivities Source #

Arguments

:: Text	`GetCampaignActivities`
-> Text	`GetCampaignActivities`
-> GetCampaignActivities

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

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

GetCampaignActivities, getCampaignActivities_campaignId - The unique identifier for the campaign.

Request Lenses

getCampaignActivities_pageSize :: Lens' GetCampaignActivities (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.

getCampaignActivities_token :: Lens' GetCampaignActivities (Maybe Text) Source #

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

getCampaignActivities_applicationId :: Lens' GetCampaignActivities Text Source #

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

getCampaignActivities_campaignId :: Lens' GetCampaignActivities Text Source #

The unique identifier for the campaign.

Destructuring the Response

data GetCampaignActivitiesResponse Source #

See: newGetCampaignActivitiesResponse smart constructor.

Constructors

GetCampaignActivitiesResponse'
Fields httpStatus :: Int The response's http status code. activitiesResponse :: ActivitiesResponse

Instances

Instances details

Generic GetCampaignActivitiesResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetCampaignActivities Associated Types type Rep GetCampaignActivitiesResponse :: Type -> Type # Methods from :: GetCampaignActivitiesResponse -> Rep GetCampaignActivitiesResponse x # to :: Rep GetCampaignActivitiesResponse x -> GetCampaignActivitiesResponse #
Read GetCampaignActivitiesResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetCampaignActivities Methods readsPrec :: Int -> ReadS GetCampaignActivitiesResponse # readList :: ReadS [GetCampaignActivitiesResponse] # readPrec :: ReadPrec GetCampaignActivitiesResponse # readListPrec :: ReadPrec [GetCampaignActivitiesResponse] #
Show GetCampaignActivitiesResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetCampaignActivities Methods showsPrec :: Int -> GetCampaignActivitiesResponse -> ShowS # show :: GetCampaignActivitiesResponse -> String # showList :: [GetCampaignActivitiesResponse] -> ShowS #
NFData GetCampaignActivitiesResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetCampaignActivities Methods rnf :: GetCampaignActivitiesResponse -> () #
Eq GetCampaignActivitiesResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetCampaignActivities Methods (==) :: GetCampaignActivitiesResponse -> GetCampaignActivitiesResponse -> Bool # (/=) :: GetCampaignActivitiesResponse -> GetCampaignActivitiesResponse -> Bool #
type Rep GetCampaignActivitiesResponse Source #
Instance details Defined in Amazonka.Pinpoint.GetCampaignActivities type Rep GetCampaignActivitiesResponse = D1 ('MetaData "GetCampaignActivitiesResponse" "Amazonka.Pinpoint.GetCampaignActivities" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "GetCampaignActivitiesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "activitiesResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ActivitiesResponse)))

newGetCampaignActivitiesResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetCampaignActivitiesResponse'`
-> ActivitiesResponse	`$sel:activitiesResponse:GetCampaignActivitiesResponse'`
-> GetCampaignActivitiesResponse

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

$sel:activitiesResponse:GetCampaignActivitiesResponse', getCampaignActivitiesResponse_activitiesResponse - Undocumented member.

Response Lenses

getCampaignActivitiesResponse_httpStatus :: Lens' GetCampaignActivitiesResponse Int Source #

The response's http status code.

getCampaignActivitiesResponse_activitiesResponse :: Lens' GetCampaignActivitiesResponse ActivitiesResponse Source #

Undocumented member.