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

Description

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

Synopsis

Creating a Request

data GetSegments Source #

See: newGetSegments smart constructor.

Constructors

GetSegments' 

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 GetSegments Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegments

Methods

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

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

Read GetSegments Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegments

Methods

readsPrec :: Int -> ReadS GetSegments #

readList :: ReadS [GetSegments] #

readPrec :: ReadPrec GetSegments #

readListPrec :: ReadPrec [GetSegments] #

Show GetSegments Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegments

Methods

showsPrec :: Int -> GetSegments -> ShowS #

show :: GetSegments -> String #

showList :: [GetSegments] -> ShowS #

Generic GetSegments Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegments

Associated Types

type Rep GetSegments :: Type -> Type #

Methods

from :: GetSegments -> Rep GetSegments x #

to :: Rep GetSegments x -> GetSegments #

NFData GetSegments Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegments

Methods

rnf :: GetSegments -> () #

Hashable GetSegments Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegments

Methods

hashWithSalt :: Int -> GetSegments -> Int #

hash :: GetSegments -> Int #

AWSRequest GetSegments Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegments

Associated Types

type AWSResponse GetSegments #

Methods

request :: GetSegments -> Request GetSegments #

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

ToHeaders GetSegments Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegments

Methods

toHeaders :: GetSegments -> [Header] #

ToPath GetSegments Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegments

Methods

toPath :: GetSegments -> ByteString #

ToQuery GetSegments Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegments

Methods

toQuery :: GetSegments -> QueryString #

type Rep GetSegments Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegments

type Rep GetSegments = D1 ('MetaData "GetSegments" "Amazonka.Pinpoint.GetSegments" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "GetSegments'" '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 GetSegments Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegments

type AWSResponse GetSegments = GetSegmentsResponse

newGetSegments Source #

Arguments

:: Text

$sel:applicationId:GetSegments'

-> GetSegments 

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

$sel:pageSize:GetSegments', getSegments_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:GetSegments', getSegments_applicationId - The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Request Lenses

getSegments_token :: Lens' GetSegments (Maybe Text) Source #

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

getSegments_pageSize :: Lens' GetSegments (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.

getSegments_applicationId :: Lens' GetSegments 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 GetSegmentsResponse Source #

See: newGetSegmentsResponse smart constructor.

Constructors

GetSegmentsResponse' 

Fields

Instances

Instances details
Eq GetSegmentsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegments

Methods

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

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

Read GetSegmentsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegments

Methods

readsPrec :: Int -> ReadS GetSegmentsResponse #

readList :: ReadS [GetSegmentsResponse] #

readPrec :: ReadPrec GetSegmentsResponse #

readListPrec :: ReadPrec [GetSegmentsResponse] #

Show GetSegmentsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegments

Methods

showsPrec :: Int -> GetSegmentsResponse -> ShowS #

show :: GetSegmentsResponse -> String #

showList :: [GetSegmentsResponse] -> ShowS #

Generic GetSegmentsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegments

Associated Types

type Rep GetSegmentsResponse :: Type -> Type #

Methods

from :: GetSegmentsResponse -> Rep GetSegmentsResponse x #

to :: Rep GetSegmentsResponse x -> GetSegmentsResponse #

NFData GetSegmentsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegments

Methods

rnf :: GetSegmentsResponse -> () #

type Rep GetSegmentsResponse Source # 
Instance details

Defined in Amazonka.Pinpoint.GetSegments

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

newGetSegmentsResponse Source #

Arguments

:: Int

$sel:httpStatus:GetSegmentsResponse'

-> SegmentsResponse

$sel:segmentsResponse:GetSegmentsResponse'

-> GetSegmentsResponse 

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

$sel:segmentsResponse:GetSegmentsResponse', getSegmentsResponse_segmentsResponse - Undocumented member.

Response Lenses

getSegmentsResponse_httpStatus :: Lens' GetSegmentsResponse Int Source #

The response's http status code.

getSegmentsResponse_segmentsResponse :: Lens' GetSegmentsResponse SegmentsResponse Source #

Undocumented member.