Amazonka.Pinpoint.GetSegments

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

Creating a Request

data GetSegments

See: newGetSegments smart constructor.

Constructors

GetSegments'

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 GetSegments

Defined in Amazonka.Pinpoint.GetSegments

Methods

toHeaders :: GetSegments -> [Header]

ToPath GetSegments

Defined in Amazonka.Pinpoint.GetSegments

Methods

toPath :: GetSegments -> ByteString

ToQuery GetSegments

Defined in Amazonka.Pinpoint.GetSegments

Methods

toQuery :: GetSegments -> QueryString

AWSRequest GetSegments

Defined in Amazonka.Pinpoint.GetSegments

Associated Types

type AWSResponse GetSegments

Methods

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

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

Generic GetSegments

Defined in Amazonka.Pinpoint.GetSegments

Associated Types

type Rep GetSegments :: Type -> Type

Methods

from :: GetSegments -> Rep GetSegments x

to :: Rep GetSegments x -> GetSegments

Read GetSegments

Defined in Amazonka.Pinpoint.GetSegments

Methods

readsPrec :: Int -> ReadS GetSegments

readList :: ReadS [GetSegments]

readPrec :: ReadPrec GetSegments

readListPrec :: ReadPrec [GetSegments]

Show GetSegments

Defined in Amazonka.Pinpoint.GetSegments

Methods

showsPrec :: Int -> GetSegments -> ShowS

show :: GetSegments -> String

showList :: [GetSegments] -> ShowS

NFData GetSegments

Defined in Amazonka.Pinpoint.GetSegments

Methods

rnf :: GetSegments -> ()

Eq GetSegments

Defined in Amazonka.Pinpoint.GetSegments

Methods

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

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

Hashable GetSegments

Defined in Amazonka.Pinpoint.GetSegments

Methods

hashWithSalt :: Int -> GetSegments -> Int

hash :: GetSegments -> Int

type AWSResponse GetSegments

Defined in Amazonka.Pinpoint.GetSegments

type AWSResponse GetSegments = GetSegmentsResponse

type Rep GetSegments

Defined in Amazonka.Pinpoint.GetSegments

type Rep GetSegments = D1 ('MetaData "GetSegments" "Amazonka.Pinpoint.GetSegments" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "GetSegments'" '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))))

newGetSegments

Arguments

:: Text

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

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

getSegments_token :: Lens' GetSegments (Maybe Text)

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

getSegments_applicationId :: Lens' GetSegments Text

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

Destructuring the Response

data GetSegmentsResponse

See: newGetSegmentsResponse smart constructor.

Constructors

GetSegmentsResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• segmentsResponse :: SegmentsResponse

Instances

Generic GetSegmentsResponse

Defined in Amazonka.Pinpoint.GetSegments

Associated Types

type Rep GetSegmentsResponse :: Type -> Type

Methods

from :: GetSegmentsResponse -> Rep GetSegmentsResponse x

to :: Rep GetSegmentsResponse x -> GetSegmentsResponse

Read GetSegmentsResponse

Defined in Amazonka.Pinpoint.GetSegments

Methods

readsPrec :: Int -> ReadS GetSegmentsResponse

readList :: ReadS [GetSegmentsResponse]

readPrec :: ReadPrec GetSegmentsResponse

readListPrec :: ReadPrec [GetSegmentsResponse]

Show GetSegmentsResponse

Defined in Amazonka.Pinpoint.GetSegments

Methods

showsPrec :: Int -> GetSegmentsResponse -> ShowS

show :: GetSegmentsResponse -> String

showList :: [GetSegmentsResponse] -> ShowS

NFData GetSegmentsResponse

Defined in Amazonka.Pinpoint.GetSegments

Methods

rnf :: GetSegmentsResponse -> ()

Eq GetSegmentsResponse

Defined in Amazonka.Pinpoint.GetSegments

Methods

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

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

type Rep GetSegmentsResponse

Defined in Amazonka.Pinpoint.GetSegments

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

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

The response's http status code.

getSegmentsResponse_segmentsResponse :: Lens' GetSegmentsResponse SegmentsResponse

Undocumented member.