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

Description

Documentation

data ExportJobResource Source #

Provides information about the resource settings for a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.

See: newExportJobResource smart constructor.

Constructors

ExportJobResource'

Fields

segmentId :: Maybe Text
The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.
segmentVersion :: Maybe Int
The version of the segment that the endpoint definitions were exported from.
s3UrlPrefix :: Text
The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.
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 where the endpoint definitions were exported to.

Instances

Instances details

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

newExportJobResource Source #

Arguments

:: Text	`$sel:s3UrlPrefix:ExportJobResource'`
-> Text	`$sel:roleArn:ExportJobResource'`
-> ExportJobResource

Create a value of ExportJobResource 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:segmentId:ExportJobResource', exportJobResource_segmentId - The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.

$sel:segmentVersion:ExportJobResource', exportJobResource_segmentVersion - The version of the segment that the endpoint definitions were exported from.

$sel:s3UrlPrefix:ExportJobResource', exportJobResource_s3UrlPrefix - The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

$sel:roleArn:ExportJobResource', exportJobResource_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 where the endpoint definitions were exported to.

exportJobResource_segmentId :: Lens' ExportJobResource (Maybe Text) Source #

The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.

exportJobResource_segmentVersion :: Lens' ExportJobResource (Maybe Int) Source #

The version of the segment that the endpoint definitions were exported from.

exportJobResource_s3UrlPrefix :: Lens' ExportJobResource Text Source #

The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

exportJobResource_roleArn :: Lens' ExportJobResource 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 where the endpoint definitions were exported to.