{-# 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.GetSegmentVersions -- 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 the configuration, dimension, and other -- settings for all the versions of a specific segment that\'s associated -- with an application. module Amazonka.Pinpoint.GetSegmentVersions ( -- * Creating a Request GetSegmentVersions (..), newGetSegmentVersions, -- * Request Lenses getSegmentVersions_pageSize, getSegmentVersions_token, getSegmentVersions_segmentId, getSegmentVersions_applicationId, -- * Destructuring the Response GetSegmentVersionsResponse (..), newGetSegmentVersionsResponse, -- * Response Lenses getSegmentVersionsResponse_httpStatus, getSegmentVersionsResponse_segmentsResponse, ) 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:/ 'newGetSegmentVersions' smart constructor. data GetSegmentVersions = GetSegmentVersions' { -- | 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 segment. segmentId :: Prelude.Text, -- | The unique identifier for the application. This identifier is displayed -- as the __Project ID__ on the Amazon Pinpoint console. applicationId :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'GetSegmentVersions' 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', 'getSegmentVersions_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', 'getSegmentVersions_token' - The NextToken string that specifies which page of results to return in a -- paginated response. -- -- 'segmentId', 'getSegmentVersions_segmentId' - The unique identifier for the segment. -- -- 'applicationId', 'getSegmentVersions_applicationId' - The unique identifier for the application. This identifier is displayed -- as the __Project ID__ on the Amazon Pinpoint console. newGetSegmentVersions :: -- | 'segmentId' Prelude.Text -> -- | 'applicationId' Prelude.Text -> GetSegmentVersions newGetSegmentVersions pSegmentId_ pApplicationId_ = GetSegmentVersions' { pageSize = Prelude.Nothing, token = Prelude.Nothing, segmentId = pSegmentId_, applicationId = pApplicationId_ } -- | 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. getSegmentVersions_pageSize :: Lens.Lens' GetSegmentVersions (Prelude.Maybe Prelude.Text) getSegmentVersions_pageSize = Lens.lens (\GetSegmentVersions' {pageSize} -> pageSize) (\s@GetSegmentVersions' {} a -> s {pageSize = a} :: GetSegmentVersions) -- | The NextToken string that specifies which page of results to return in a -- paginated response. getSegmentVersions_token :: Lens.Lens' GetSegmentVersions (Prelude.Maybe Prelude.Text) getSegmentVersions_token = Lens.lens (\GetSegmentVersions' {token} -> token) (\s@GetSegmentVersions' {} a -> s {token = a} :: GetSegmentVersions) -- | The unique identifier for the segment. getSegmentVersions_segmentId :: Lens.Lens' GetSegmentVersions Prelude.Text getSegmentVersions_segmentId = Lens.lens (\GetSegmentVersions' {segmentId} -> segmentId) (\s@GetSegmentVersions' {} a -> s {segmentId = a} :: GetSegmentVersions) -- | The unique identifier for the application. This identifier is displayed -- as the __Project ID__ on the Amazon Pinpoint console. getSegmentVersions_applicationId :: Lens.Lens' GetSegmentVersions Prelude.Text getSegmentVersions_applicationId = Lens.lens (\GetSegmentVersions' {applicationId} -> applicationId) (\s@GetSegmentVersions' {} a -> s {applicationId = a} :: GetSegmentVersions) instance Core.AWSRequest GetSegmentVersions where type AWSResponse GetSegmentVersions = GetSegmentVersionsResponse request overrides = Request.get (overrides defaultService) response = Response.receiveJSON ( \s h x -> GetSegmentVersionsResponse' Prelude.<$> (Prelude.pure (Prelude.fromEnum s)) Prelude.<*> (Data.eitherParseJSON x) ) instance Prelude.Hashable GetSegmentVersions where hashWithSalt _salt GetSegmentVersions' {..} = _salt `Prelude.hashWithSalt` pageSize `Prelude.hashWithSalt` token `Prelude.hashWithSalt` segmentId `Prelude.hashWithSalt` applicationId instance Prelude.NFData GetSegmentVersions where rnf GetSegmentVersions' {..} = Prelude.rnf pageSize `Prelude.seq` Prelude.rnf token `Prelude.seq` Prelude.rnf segmentId `Prelude.seq` Prelude.rnf applicationId instance Data.ToHeaders GetSegmentVersions where toHeaders = Prelude.const ( Prelude.mconcat [ "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToPath GetSegmentVersions where toPath GetSegmentVersions' {..} = Prelude.mconcat [ "/v1/apps/", Data.toBS applicationId, "/segments/", Data.toBS segmentId, "/versions" ] instance Data.ToQuery GetSegmentVersions where toQuery GetSegmentVersions' {..} = Prelude.mconcat ["page-size" Data.=: pageSize, "token" Data.=: token] -- | /See:/ 'newGetSegmentVersionsResponse' smart constructor. data GetSegmentVersionsResponse = GetSegmentVersionsResponse' { -- | The response's http status code. httpStatus :: Prelude.Int, segmentsResponse :: SegmentsResponse } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'GetSegmentVersionsResponse' 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', 'getSegmentVersionsResponse_httpStatus' - The response's http status code. -- -- 'segmentsResponse', 'getSegmentVersionsResponse_segmentsResponse' - Undocumented member. newGetSegmentVersionsResponse :: -- | 'httpStatus' Prelude.Int -> -- | 'segmentsResponse' SegmentsResponse -> GetSegmentVersionsResponse newGetSegmentVersionsResponse pHttpStatus_ pSegmentsResponse_ = GetSegmentVersionsResponse' { httpStatus = pHttpStatus_, segmentsResponse = pSegmentsResponse_ } -- | The response's http status code. getSegmentVersionsResponse_httpStatus :: Lens.Lens' GetSegmentVersionsResponse Prelude.Int getSegmentVersionsResponse_httpStatus = Lens.lens (\GetSegmentVersionsResponse' {httpStatus} -> httpStatus) (\s@GetSegmentVersionsResponse' {} a -> s {httpStatus = a} :: GetSegmentVersionsResponse) -- | Undocumented member. getSegmentVersionsResponse_segmentsResponse :: Lens.Lens' GetSegmentVersionsResponse SegmentsResponse getSegmentVersionsResponse_segmentsResponse = Lens.lens (\GetSegmentVersionsResponse' {segmentsResponse} -> segmentsResponse) (\s@GetSegmentVersionsResponse' {} a -> s {segmentsResponse = a} :: GetSegmentVersionsResponse) instance Prelude.NFData GetSegmentVersionsResponse where rnf GetSegmentVersionsResponse' {..} = Prelude.rnf httpStatus `Prelude.seq` Prelude.rnf segmentsResponse