{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.Pinpoint.GetCampaignActivities -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Retrieves information about all the activities for a campaign. module Amazonka.Pinpoint.GetCampaignActivities ( -- * Creating a Request GetCampaignActivities (..), newGetCampaignActivities, -- * Request Lenses getCampaignActivities_pageSize, getCampaignActivities_token, getCampaignActivities_applicationId, getCampaignActivities_campaignId, -- * Destructuring the Response GetCampaignActivitiesResponse (..), newGetCampaignActivitiesResponse, -- * Response Lenses getCampaignActivitiesResponse_httpStatus, getCampaignActivitiesResponse_activitiesResponse, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import Amazonka.Pinpoint.Types import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newGetCampaignActivities' smart constructor. data GetCampaignActivities = GetCampaignActivities' { -- | 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. pageSize :: Prelude.Maybe Prelude.Text, -- | The NextToken string that specifies which page of results to return in a -- paginated response. token :: Prelude.Maybe Prelude.Text, -- | The unique identifier for the application. This identifier is displayed -- as the __Project ID__ on the Amazon Pinpoint console. applicationId :: Prelude.Text, -- | The unique identifier for the campaign. campaignId :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'GetCampaignActivities' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'pageSize', '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. -- -- 'token', 'getCampaignActivities_token' - The NextToken string that specifies which page of results to return in a -- paginated response. -- -- 'applicationId', 'getCampaignActivities_applicationId' - The unique identifier for the application. This identifier is displayed -- as the __Project ID__ on the Amazon Pinpoint console. -- -- 'campaignId', 'getCampaignActivities_campaignId' - The unique identifier for the campaign. newGetCampaignActivities :: -- | 'applicationId' Prelude.Text -> -- | 'campaignId' Prelude.Text -> GetCampaignActivities newGetCampaignActivities pApplicationId_ pCampaignId_ = GetCampaignActivities' { pageSize = Prelude.Nothing, token = Prelude.Nothing, applicationId = pApplicationId_, campaignId = pCampaignId_ } -- | 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_pageSize :: Lens.Lens' GetCampaignActivities (Prelude.Maybe Prelude.Text) getCampaignActivities_pageSize = Lens.lens (\GetCampaignActivities' {pageSize} -> pageSize) (\s@GetCampaignActivities' {} a -> s {pageSize = a} :: GetCampaignActivities) -- | The NextToken string that specifies which page of results to return in a -- paginated response. getCampaignActivities_token :: Lens.Lens' GetCampaignActivities (Prelude.Maybe Prelude.Text) getCampaignActivities_token = Lens.lens (\GetCampaignActivities' {token} -> token) (\s@GetCampaignActivities' {} a -> s {token = a} :: GetCampaignActivities) -- | The unique identifier for the application. This identifier is displayed -- as the __Project ID__ on the Amazon Pinpoint console. getCampaignActivities_applicationId :: Lens.Lens' GetCampaignActivities Prelude.Text getCampaignActivities_applicationId = Lens.lens (\GetCampaignActivities' {applicationId} -> applicationId) (\s@GetCampaignActivities' {} a -> s {applicationId = a} :: GetCampaignActivities) -- | The unique identifier for the campaign. getCampaignActivities_campaignId :: Lens.Lens' GetCampaignActivities Prelude.Text getCampaignActivities_campaignId = Lens.lens (\GetCampaignActivities' {campaignId} -> campaignId) (\s@GetCampaignActivities' {} a -> s {campaignId = a} :: GetCampaignActivities) instance Core.AWSRequest GetCampaignActivities where type AWSResponse GetCampaignActivities = GetCampaignActivitiesResponse request overrides = Request.get (overrides defaultService) response = Response.receiveJSON ( \s h x -> GetCampaignActivitiesResponse' Prelude.<$> (Prelude.pure (Prelude.fromEnum s)) Prelude.<*> (Data.eitherParseJSON x) ) instance Prelude.Hashable GetCampaignActivities where hashWithSalt _salt GetCampaignActivities' {..} = _salt `Prelude.hashWithSalt` pageSize `Prelude.hashWithSalt` token `Prelude.hashWithSalt` applicationId `Prelude.hashWithSalt` campaignId instance Prelude.NFData GetCampaignActivities where rnf GetCampaignActivities' {..} = Prelude.rnf pageSize `Prelude.seq` Prelude.rnf token `Prelude.seq` Prelude.rnf applicationId `Prelude.seq` Prelude.rnf campaignId instance Data.ToHeaders GetCampaignActivities where toHeaders = Prelude.const ( Prelude.mconcat [ "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToPath GetCampaignActivities where toPath GetCampaignActivities' {..} = Prelude.mconcat [ "/v1/apps/", Data.toBS applicationId, "/campaigns/", Data.toBS campaignId, "/activities" ] instance Data.ToQuery GetCampaignActivities where toQuery GetCampaignActivities' {..} = Prelude.mconcat ["page-size" Data.=: pageSize, "token" Data.=: token] -- | /See:/ 'newGetCampaignActivitiesResponse' smart constructor. data GetCampaignActivitiesResponse = GetCampaignActivitiesResponse' { -- | The response's http status code. httpStatus :: Prelude.Int, activitiesResponse :: ActivitiesResponse } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'GetCampaignActivitiesResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'httpStatus', 'getCampaignActivitiesResponse_httpStatus' - The response's http status code. -- -- 'activitiesResponse', 'getCampaignActivitiesResponse_activitiesResponse' - Undocumented member. newGetCampaignActivitiesResponse :: -- | 'httpStatus' Prelude.Int -> -- | 'activitiesResponse' ActivitiesResponse -> GetCampaignActivitiesResponse newGetCampaignActivitiesResponse pHttpStatus_ pActivitiesResponse_ = GetCampaignActivitiesResponse' { httpStatus = pHttpStatus_, activitiesResponse = pActivitiesResponse_ } -- | The response's http status code. getCampaignActivitiesResponse_httpStatus :: Lens.Lens' GetCampaignActivitiesResponse Prelude.Int getCampaignActivitiesResponse_httpStatus = Lens.lens (\GetCampaignActivitiesResponse' {httpStatus} -> httpStatus) (\s@GetCampaignActivitiesResponse' {} a -> s {httpStatus = a} :: GetCampaignActivitiesResponse) -- | Undocumented member. getCampaignActivitiesResponse_activitiesResponse :: Lens.Lens' GetCampaignActivitiesResponse ActivitiesResponse getCampaignActivitiesResponse_activitiesResponse = Lens.lens (\GetCampaignActivitiesResponse' {activitiesResponse} -> activitiesResponse) (\s@GetCampaignActivitiesResponse' {} a -> s {activitiesResponse = a} :: GetCampaignActivitiesResponse) instance Prelude.NFData GetCampaignActivitiesResponse where rnf GetCampaignActivitiesResponse' {..} = Prelude.rnf httpStatus `Prelude.seq` Prelude.rnf activitiesResponse