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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.

Synopsis

Creating a Request

data GetSegment Source #

See: newGetSegment smart constructor.

Constructors

GetSegment'
Fields segmentId :: Text The unique identifier for the segment. applicationId :: Text The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Instances

Instances details

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

newGetSegment Source #

Arguments

:: Text	`GetSegment`
-> Text	`GetSegment`
-> GetSegment

Create a value of GetSegment 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:

GetSegment, getSegment_segmentId - The unique identifier for the segment.

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

Request Lenses

getSegment_segmentId :: Lens' GetSegment Text Source #

The unique identifier for the segment.

getSegment_applicationId :: Lens' GetSegment 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 GetSegmentResponse Source #

See: newGetSegmentResponse smart constructor.

Constructors

GetSegmentResponse'
Fields httpStatus :: Int The response's http status code. segmentResponse :: SegmentResponse

Instances

Instances details

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

newGetSegmentResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetSegmentResponse'`
-> SegmentResponse	`$sel:segmentResponse:GetSegmentResponse'`
-> GetSegmentResponse

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

$sel:segmentResponse:GetSegmentResponse', getSegmentResponse_segmentResponse - Undocumented member.

Response Lenses

getSegmentResponse_httpStatus :: Lens' GetSegmentResponse Int Source #

The response's http status code.

getSegmentResponse_segmentResponse :: Lens' GetSegmentResponse SegmentResponse Source #

Undocumented member.