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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

Creating a Request

data UpdateSegment Source #

See: newUpdateSegment smart constructor.

Constructors

UpdateSegment'
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. writeSegmentRequest :: WriteSegmentRequest

Instances

Instances details

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

newUpdateSegment Source #

Arguments

:: Text	`UpdateSegment`
-> Text	`UpdateSegment`
-> WriteSegmentRequest	`$sel:writeSegmentRequest:UpdateSegment'`
-> UpdateSegment

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

UpdateSegment, updateSegment_segmentId - The unique identifier for the segment.

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

$sel:writeSegmentRequest:UpdateSegment', updateSegment_writeSegmentRequest - Undocumented member.

Request Lenses

updateSegment_segmentId :: Lens' UpdateSegment Text Source #

The unique identifier for the segment.

updateSegment_applicationId :: Lens' UpdateSegment Text Source #

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

updateSegment_writeSegmentRequest :: Lens' UpdateSegment WriteSegmentRequest Source #

Undocumented member.

Destructuring the Response

data UpdateSegmentResponse Source #

See: newUpdateSegmentResponse smart constructor.

Constructors

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

Instances

Instances details

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

newUpdateSegmentResponse Source #

Arguments

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

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

$sel:segmentResponse:UpdateSegmentResponse', updateSegmentResponse_segmentResponse - Undocumented member.

Response Lenses

updateSegmentResponse_httpStatus :: Lens' UpdateSegmentResponse Int Source #

The response's http status code.

updateSegmentResponse_segmentResponse :: Lens' UpdateSegmentResponse SegmentResponse Source #

Undocumented member.