ImportJobRequest

public struct ImportJobRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let defineSegment: Bool?

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

    Declaration

    Swift

    public let externalId: String?

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

    Declaration

    Swift

    public let format: Format

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

    Declaration

    Swift

    public let registerEndpoints: Bool?

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

    Declaration

    Swift

    public let roleArn: 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. The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.

    Declaration

    Swift

    public let s3Url: 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.

    Declaration

    Swift

    public let segmentId: String?

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

    Declaration

    Swift

    public let segmentName: String?

  • Undocumented

    Declaration

    Swift

    public init(defineSegment: Bool? = nil, externalId: String? = nil, format: Format, registerEndpoints: Bool? = nil, roleArn: String, s3Url: String, segmentId: String? = nil, segmentName: String? = nil)