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

Description

Synopsis

Documentation

data ExportJobRequest Source #

Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.

See: newExportJobRequest smart constructor.

Constructors

ExportJobRequest'

Fields

segmentId :: Maybe Text
The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.
segmentVersion :: Maybe Int
The version of the segment to export endpoint definitions from, if specified.
s3UrlPrefix :: Text
The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions 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 authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.

Instances

Instances details

Eq ExportJobRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.ExportJobRequest Methods (==) :: ExportJobRequest -> ExportJobRequest -> Bool # (/=) :: ExportJobRequest -> ExportJobRequest -> Bool #
Read ExportJobRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.ExportJobRequest Methods readsPrec :: Int -> ReadS ExportJobRequest # readList :: ReadS [ExportJobRequest] # readPrec :: ReadPrec ExportJobRequest # readListPrec :: ReadPrec [ExportJobRequest] #
Show ExportJobRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.ExportJobRequest Methods showsPrec :: Int -> ExportJobRequest -> ShowS # show :: ExportJobRequest -> String # showList :: [ExportJobRequest] -> ShowS #
Generic ExportJobRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.ExportJobRequest Associated Types type Rep ExportJobRequest :: Type -> Type # Methods from :: ExportJobRequest -> Rep ExportJobRequest x # to :: Rep ExportJobRequest x -> ExportJobRequest #
NFData ExportJobRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.ExportJobRequest Methods rnf :: ExportJobRequest -> () #
Hashable ExportJobRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.ExportJobRequest Methods hashWithSalt :: Int -> ExportJobRequest -> Int # hash :: ExportJobRequest -> Int #
ToJSON ExportJobRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.ExportJobRequest Methods toJSON :: ExportJobRequest -> Value # toEncoding :: ExportJobRequest -> Encoding # toJSONList :: [ExportJobRequest] -> Value # toEncodingList :: [ExportJobRequest] -> Encoding #
type Rep ExportJobRequest Source #
Instance details Defined in Amazonka.Pinpoint.Types.ExportJobRequest type Rep ExportJobRequest = D1 ('MetaData "ExportJobRequest" "Amazonka.Pinpoint.Types.ExportJobRequest" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "ExportJobRequest'" '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))))

newExportJobRequest Source #

Arguments

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

Create a value of ExportJobRequest 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:ExportJobRequest', exportJobRequest_segmentId - The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.

$sel:segmentVersion:ExportJobRequest', exportJobRequest_segmentVersion - The version of the segment to export endpoint definitions from, if specified.

$sel:s3UrlPrefix:ExportJobRequest', exportJobRequest_s3UrlPrefix - The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions 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:ExportJobRequest', exportJobRequest_roleArn - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.

exportJobRequest_segmentId :: Lens' ExportJobRequest (Maybe Text) Source #

The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.

exportJobRequest_segmentVersion :: Lens' ExportJobRequest (Maybe Int) Source #

The version of the segment to export endpoint definitions from, if specified.

exportJobRequest_s3UrlPrefix :: Lens' ExportJobRequest Text Source #

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

exportJobRequest_roleArn :: Lens' ExportJobRequest Text Source #

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.