Amazonka.Pinpoint.GetSegment

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

Creating a Request

data GetSegment

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

ToHeaders GetSegment

Defined in Amazonka.Pinpoint.GetSegment

Methods

toHeaders :: GetSegment -> [Header]

ToPath GetSegment

Defined in Amazonka.Pinpoint.GetSegment

Methods

toPath :: GetSegment -> ByteString

ToQuery GetSegment

Defined in Amazonka.Pinpoint.GetSegment

Methods

toQuery :: GetSegment -> QueryString

AWSRequest GetSegment

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

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

Defined in Amazonka.Pinpoint.GetSegment

Methods

readsPrec :: Int -> ReadS GetSegment

readList :: ReadS [GetSegment]

readPrec :: ReadPrec GetSegment

readListPrec :: ReadPrec [GetSegment]

Show GetSegment

Defined in Amazonka.Pinpoint.GetSegment

Methods

showsPrec :: Int -> GetSegment -> ShowS

show :: GetSegment -> String

showList :: [GetSegment] -> ShowS

NFData GetSegment

Defined in Amazonka.Pinpoint.GetSegment

Methods

rnf :: GetSegment -> ()

Eq GetSegment

Defined in Amazonka.Pinpoint.GetSegment

Methods

(==) :: GetSegment -> GetSegment -> Bool

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

Hashable GetSegment

Defined in Amazonka.Pinpoint.GetSegment

Methods

hashWithSalt :: Int -> GetSegment -> Int

hash :: GetSegment -> Int

type AWSResponse GetSegment

Defined in Amazonka.Pinpoint.GetSegment

type AWSResponse GetSegment = GetSegmentResponse

type Rep GetSegment

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

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

The unique identifier for the segment.

getSegment_applicationId :: Lens' GetSegment Text

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

Destructuring the Response

data GetSegmentResponse

See: newGetSegmentResponse smart constructor.

Constructors

GetSegmentResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• segmentResponse :: SegmentResponse

Instances

Generic GetSegmentResponse

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

Defined in Amazonka.Pinpoint.GetSegment

Methods

readsPrec :: Int -> ReadS GetSegmentResponse

readList :: ReadS [GetSegmentResponse]

readPrec :: ReadPrec GetSegmentResponse

readListPrec :: ReadPrec [GetSegmentResponse]

Show GetSegmentResponse

Defined in Amazonka.Pinpoint.GetSegment

Methods

showsPrec :: Int -> GetSegmentResponse -> ShowS

show :: GetSegmentResponse -> String

showList :: [GetSegmentResponse] -> ShowS

NFData GetSegmentResponse

Defined in Amazonka.Pinpoint.GetSegment

Methods

rnf :: GetSegmentResponse -> ()

Eq GetSegmentResponse

Defined in Amazonka.Pinpoint.GetSegment

Methods

(==) :: GetSegmentResponse -> GetSegmentResponse -> Bool

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

type Rep GetSegmentResponse

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

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

The response's http status code.

getSegmentResponse_segmentResponse :: Lens' GetSegmentResponse SegmentResponse

Undocumented member.