ImportJobRequest

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

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.

Link copied to clipboard

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

Link copied to clipboard

The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

Link copied to clipboard

Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

Link copied to clipboard

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

Link copied to clipboard

The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.

Link copied to clipboard

The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.

Link copied to clipboard

A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

Functions

Link copied to clipboard
inline fun copy(block: ImportJobRequest.Builder.() -> Unit = {}): ImportJobRequest
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String