/AWS1/CL_PPTEXPORTJOBREQUEST¶
Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.
CONSTRUCTOR
¶
IMPORTING¶
Required arguments:¶
iv_rolearn
TYPE /AWS1/PPT__STRING
/AWS1/PPT__STRING
¶
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.
iv_s3urlprefix
TYPE /AWS1/PPT__STRING
/AWS1/PPT__STRING
¶
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 /.
Optional arguments:¶
iv_segmentid
TYPE /AWS1/PPT__STRING
/AWS1/PPT__STRING
¶
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.
iv_segmentversion
TYPE /AWS1/PPT__INTEGER
/AWS1/PPT__INTEGER
¶
The version of the segment to export endpoint definitions from, if specified.
Queryable Attributes¶
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.
Accessible with the following methods¶
Method | Description |
---|---|
GET_ROLEARN() |
Getter for ROLEARN, with configurable default |
ASK_ROLEARN() |
Getter for ROLEARN w/ exceptions if field has no value |
HAS_ROLEARN() |
Determine if ROLEARN has a value |
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 /.
Accessible with the following methods¶
Method | Description |
---|---|
GET_S3URLPREFIX() |
Getter for S3URLPREFIX, with configurable default |
ASK_S3URLPREFIX() |
Getter for S3URLPREFIX w/ exceptions if field has no value |
HAS_S3URLPREFIX() |
Determine if S3URLPREFIX has a value |
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.
Accessible with the following methods¶
Method | Description |
---|---|
GET_SEGMENTID() |
Getter for SEGMENTID, with configurable default |
ASK_SEGMENTID() |
Getter for SEGMENTID w/ exceptions if field has no value |
HAS_SEGMENTID() |
Determine if SEGMENTID has a value |
SegmentVersion¶
The version of the segment to export endpoint definitions from, if specified.
Accessible with the following methods¶
Method | Description |
---|---|
GET_SEGMENTVERSION() |
Getter for SEGMENTVERSION, with configurable default |
ASK_SEGMENTVERSION() |
Getter for SEGMENTVERSION w/ exceptions if field has no valu |
HAS_SEGMENTVERSION() |
Determine if SEGMENTVERSION has a value |