You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Pinpoint::Types::ImportJobResource

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#define_segmentBoolean

Sets whether the endpoints create a segment when they are imported.

Returns:

  • (Boolean)

    Sets whether the endpoints create a segment when they are imported.

#external_idString

A unique, custom ID assigned to the IAM role that restricts who can assume the role.

Returns:

  • (String)

    A unique, custom ID assigned to the IAM role that restricts who can assume the role.

#formatString

The format of the files that contain the endpoint definitions. Valid values: CSV, JSON

Possible values:

  • CSV
  • JSON

Returns:

  • (String)

    The format of the files that contain the endpoint definitions.

#register_endpointsBoolean

Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.

Returns:

  • (Boolean)

    Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.

#role_arnString

The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.

#s3_urlString

A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import. The location can be a folder or a single file. The URL should follow this format: s3://bucket-name/folder-name/file-name Amazon Pinpoint will import endpoints from this location and any subfolders it contains.

Returns:

  • (String)

    A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import.

#segment_idString

The ID of the segment to update if the import job is meant to update an existing segment.

Returns:

  • (String)

    The ID of the segment to update if the import job is meant to update an existing segment.

#segment_nameString

A custom name for the segment created by the import job. Use if DefineSegment is true.

Returns:

  • (String)

    A custom name for the segment created by the import job.