ImportJobRequest class

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

Constructors

ImportJobRequest({required Format format, required String roleArn, required String s3Url, bool? defineSegment, String? externalId, bool? registerEndpoints, String? segmentId, String? segmentName})

Properties

defineSegment → bool?

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

final

externalId → String?

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

final

format → Format

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.

final

hashCode → int

The hash code for this object.

no setter, inherited

registerEndpoints → bool?

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

final

roleArn → 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 to import endpoint definitions from.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

s3Url → String

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.

final

segmentId → String?

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.

final

segmentName → String?

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

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited