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

Class: Aws::Pinpoint::Types::ImportJobRequest

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

Overview

Note:

When passing ImportJobRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  define_segment: false,
  external_id: "__string",
  format: "CSV", # required, accepts CSV, JSON
  register_endpoints: false,
  role_arn: "__string", # required
  s3_url: "__string", # required
  segment_id: "__string",
  segment_name: "__string",
}

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#define_segment ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#external_id ⇒ 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.

Returns:

  • (String) —

    (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy.

#format ⇒ 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.

Possible values:

  • CSV
  • JSON

Returns:

  • (String) —

    The format of the files that contain the endpoint definitions to import.

#register_endpoints ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#role_arn ⇒ 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.

Returns:

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

#s3_url ⇒ 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.

Returns:

  • (String) —

    The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import.

#segment_id ⇒ 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.

Returns:

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

#segment_name ⇒ String

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

Returns:

  • (String) —

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