Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Pinpoint.Types.SegmentImportResource

Description

Documentation

data SegmentImportResource Source #

Provides information about the import job that created a segment. An import job is a job that creates a user segment by importing endpoint definitions.

See: newSegmentImportResource smart constructor.

Constructors

SegmentImportResource'

Fields

channelCounts :: Maybe (HashMap Text Int)
The number of channel types in the endpoint definitions that were imported to create the segment.
format :: DefinitionFormat
The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
s3Url :: Text
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
size :: Int
The number of endpoint definitions that were imported successfully to create the segment.
externalId :: Text
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
roleArn :: Text
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

Instances

Instances details

Eq SegmentImportResource Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentImportResource Methods (==) :: SegmentImportResource -> SegmentImportResource -> Bool # (/=) :: SegmentImportResource -> SegmentImportResource -> Bool #
Read SegmentImportResource Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentImportResource Methods readsPrec :: Int -> ReadS SegmentImportResource # readList :: ReadS [SegmentImportResource] # readPrec :: ReadPrec SegmentImportResource # readListPrec :: ReadPrec [SegmentImportResource] #
Show SegmentImportResource Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentImportResource Methods showsPrec :: Int -> SegmentImportResource -> ShowS # show :: SegmentImportResource -> String # showList :: [SegmentImportResource] -> ShowS #
Generic SegmentImportResource Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentImportResource Associated Types type Rep SegmentImportResource :: Type -> Type # Methods from :: SegmentImportResource -> Rep SegmentImportResource x # to :: Rep SegmentImportResource x -> SegmentImportResource #
NFData SegmentImportResource Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentImportResource Methods rnf :: SegmentImportResource -> () #
Hashable SegmentImportResource Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentImportResource Methods hashWithSalt :: Int -> SegmentImportResource -> Int # hash :: SegmentImportResource -> Int #
FromJSON SegmentImportResource Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentImportResource Methods parseJSON :: Value -> Parser SegmentImportResource # parseJSONList :: Value -> Parser [SegmentImportResource] #
type Rep SegmentImportResource Source #
Instance details Defined in Amazonka.Pinpoint.Types.SegmentImportResource type Rep SegmentImportResource = D1 ('MetaData "SegmentImportResource" "Amazonka.Pinpoint.Types.SegmentImportResource" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "SegmentImportResource'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "channelCounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Int))) :: (S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DefinitionFormat) :: S1 ('MetaSel ('Just "s3Url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "externalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newSegmentImportResource Source #

Arguments

:: DefinitionFormat	`$sel:format:SegmentImportResource'`
-> Text	`$sel:s3Url:SegmentImportResource'`
-> Int	`$sel:size:SegmentImportResource'`
-> Text	`$sel:externalId:SegmentImportResource'`
-> Text	`$sel:roleArn:SegmentImportResource'`
-> SegmentImportResource

Create a value of SegmentImportResource 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:channelCounts:SegmentImportResource', segmentImportResource_channelCounts - The number of channel types in the endpoint definitions that were imported to create the segment.

$sel:format:SegmentImportResource', segmentImportResource_format - The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

$sel:s3Url:SegmentImportResource', segmentImportResource_s3Url - The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.

$sel:size:SegmentImportResource', segmentImportResource_size - The number of endpoint definitions that were imported successfully to create the segment.

$sel:externalId:SegmentImportResource', segmentImportResource_externalId - (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

$sel:roleArn:SegmentImportResource', segmentImportResource_roleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

segmentImportResource_channelCounts :: Lens' SegmentImportResource (Maybe (HashMap Text Int)) Source #

The number of channel types in the endpoint definitions that were imported to create the segment.

segmentImportResource_format :: Lens' SegmentImportResource DefinitionFormat Source #

The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

segmentImportResource_s3Url :: Lens' SegmentImportResource Text Source #

The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.

segmentImportResource_size :: Lens' SegmentImportResource Int Source #

The number of endpoint definitions that were imported successfully to create the segment.

segmentImportResource_externalId :: Lens' SegmentImportResource Text Source #

(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

segmentImportResource_roleArn :: Lens' SegmentImportResource Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.