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.Types.SegmentResponse

Description

Synopsis

data SegmentResponse = SegmentResponse' {
- dimensions :: Maybe SegmentDimensions
- importDefinition :: Maybe SegmentImportResource
- lastModifiedDate :: Maybe Text
- name :: Maybe Text
- segmentGroups :: Maybe SegmentGroupList
- version :: Maybe Int
- tags :: Maybe (HashMap Text Text)
- segmentType :: SegmentType
- creationDate :: Text
- id :: Text
- arn :: Text
- applicationId :: Text
}
newSegmentResponse :: SegmentType -> Text -> Text -> Text -> Text -> SegmentResponse
segmentResponse_dimensions :: Lens' SegmentResponse (Maybe SegmentDimensions)
segmentResponse_importDefinition :: Lens' SegmentResponse (Maybe SegmentImportResource)
segmentResponse_lastModifiedDate :: Lens' SegmentResponse (Maybe Text)
segmentResponse_name :: Lens' SegmentResponse (Maybe Text)
segmentResponse_segmentGroups :: Lens' SegmentResponse (Maybe SegmentGroupList)
segmentResponse_version :: Lens' SegmentResponse (Maybe Int)
segmentResponse_tags :: Lens' SegmentResponse (Maybe (HashMap Text Text))
segmentResponse_segmentType :: Lens' SegmentResponse SegmentType
segmentResponse_creationDate :: Lens' SegmentResponse Text
segmentResponse_id :: Lens' SegmentResponse Text
segmentResponse_arn :: Lens' SegmentResponse Text
segmentResponse_applicationId :: Lens' SegmentResponse Text

Documentation

data SegmentResponse Source #

Provides information about the configuration, dimension, and other settings for a segment.

See: newSegmentResponse smart constructor.

Constructors

SegmentResponse'

Fields

dimensions :: Maybe SegmentDimensions
The dimension settings for the segment.
importDefinition :: Maybe SegmentImportResource
The settings for the import job that's associated with the segment.
lastModifiedDate :: Maybe Text
The date and time when the segment was last modified.
name :: Maybe Text
The name of the segment.
segmentGroups :: Maybe SegmentGroupList
A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
version :: Maybe Int
The version number of the segment.
tags :: Maybe (HashMap Text Text)
A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.
segmentType :: SegmentType
The segment type. Valid values are:
- DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.
- IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.
creationDate :: Text
The date and time when the segment was created.
id :: Text
The unique identifier for the segment.
arn :: Text
The Amazon Resource Name (ARN) of the segment.
applicationId :: Text
The unique identifier for the application that the segment is associated with.

Instances

Instances details

FromJSON SegmentResponse Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentResponse Methods parseJSON :: Value -> Parser SegmentResponse # parseJSONList :: Value -> Parser [SegmentResponse] #
Generic SegmentResponse Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentResponse Associated Types type Rep SegmentResponse :: Type -> Type # Methods from :: SegmentResponse -> Rep SegmentResponse x # to :: Rep SegmentResponse x -> SegmentResponse #
Read SegmentResponse Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentResponse Methods readsPrec :: Int -> ReadS SegmentResponse # readList :: ReadS [SegmentResponse] # readPrec :: ReadPrec SegmentResponse # readListPrec :: ReadPrec [SegmentResponse] #
Show SegmentResponse Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentResponse Methods showsPrec :: Int -> SegmentResponse -> ShowS # show :: SegmentResponse -> String # showList :: [SegmentResponse] -> ShowS #
NFData SegmentResponse Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentResponse Methods rnf :: SegmentResponse -> () #
Eq SegmentResponse Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentResponse Methods (==) :: SegmentResponse -> SegmentResponse -> Bool # (/=) :: SegmentResponse -> SegmentResponse -> Bool #
Hashable SegmentResponse Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentResponse Methods hashWithSalt :: Int -> SegmentResponse -> Int # hash :: SegmentResponse -> Int #
type Rep SegmentResponse Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentResponse type Rep SegmentResponse = D1 ('MetaData "SegmentResponse" "Amazonka.Pinpoint.Types.SegmentResponse" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "SegmentResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SegmentDimensions)) :: (S1 ('MetaSel ('Just "importDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SegmentImportResource)) :: S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "segmentGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SegmentGroupList)) :: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "segmentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SegmentType) :: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newSegmentResponse Source #

Arguments

:: SegmentType	`$sel:segmentType:SegmentResponse'`
-> Text	`$sel:creationDate:SegmentResponse'`
-> Text	`$sel:id:SegmentResponse'`
-> Text	`$sel:arn:SegmentResponse'`
-> Text	`$sel:applicationId:SegmentResponse'`
-> SegmentResponse

Create a value of SegmentResponse 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:dimensions:SegmentResponse', segmentResponse_dimensions - The dimension settings for the segment.

$sel:importDefinition:SegmentResponse', segmentResponse_importDefinition - The settings for the import job that's associated with the segment.

$sel:lastModifiedDate:SegmentResponse', segmentResponse_lastModifiedDate - The date and time when the segment was last modified.

$sel:name:SegmentResponse', segmentResponse_name - The name of the segment.

$sel:segmentGroups:SegmentResponse', segmentResponse_segmentGroups - A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.

$sel:version:SegmentResponse', segmentResponse_version - The version number of the segment.

$sel:tags:SegmentResponse', segmentResponse_tags - A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.

$sel:segmentType:SegmentResponse', segmentResponse_segmentType - The segment type. Valid values are:

DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.
IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.

$sel:creationDate:SegmentResponse', segmentResponse_creationDate - The date and time when the segment was created.

$sel:id:SegmentResponse', segmentResponse_id - The unique identifier for the segment.

$sel:arn:SegmentResponse', segmentResponse_arn - The Amazon Resource Name (ARN) of the segment.

$sel:applicationId:SegmentResponse', segmentResponse_applicationId - The unique identifier for the application that the segment is associated with.

segmentResponse_dimensions :: Lens' SegmentResponse (Maybe SegmentDimensions) Source #

The dimension settings for the segment.

segmentResponse_importDefinition :: Lens' SegmentResponse (Maybe SegmentImportResource) Source #

The settings for the import job that's associated with the segment.

segmentResponse_lastModifiedDate :: Lens' SegmentResponse (Maybe Text) Source #

The date and time when the segment was last modified.

segmentResponse_name :: Lens' SegmentResponse (Maybe Text) Source #

The name of the segment.

segmentResponse_segmentGroups :: Lens' SegmentResponse (Maybe SegmentGroupList) Source #

A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.

segmentResponse_version :: Lens' SegmentResponse (Maybe Int) Source #

The version number of the segment.

segmentResponse_tags :: Lens' SegmentResponse (Maybe (HashMap Text Text)) Source #

A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.

segmentResponse_segmentType :: Lens' SegmentResponse SegmentType Source #

The segment type. Valid values are:

DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.
IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.

segmentResponse_creationDate :: Lens' SegmentResponse Text Source #

The date and time when the segment was created.

segmentResponse_id :: Lens' SegmentResponse Text Source #

The unique identifier for the segment.

segmentResponse_arn :: Lens' SegmentResponse Text Source #

The Amazon Resource Name (ARN) of the segment.

segmentResponse_applicationId :: Lens' SegmentResponse Text Source #

The unique identifier for the application that the segment is associated with.