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

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::ImportJobRequest

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

Note:

When making an API call, you may pass ImportJobRequest data as a hash:

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

Instance Attribute Summary

• #define_segment ⇒ Boolean

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

• #external_id ⇒ String

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

• #format ⇒ String

  The format of the files that contain the endpoint definitions.

• #register_endpoints ⇒ Boolean

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

• #role_arn ⇒ 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_url ⇒ String

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

• #segment_id ⇒ String

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

• #segment_name ⇒ String

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

Instance Attribute Details

#define_segment ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3100

class ImportJobRequest < Struct.new(
  :define_segment,
  :external_id,
  :format,
  :register_endpoints,
  :role_arn,
  :s3_url,
  :segment_id,
  :segment_name)
  include Aws::Structure
end

#external_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3100

class ImportJobRequest < Struct.new(
  :define_segment,
  :external_id,
  :format,
  :register_endpoints,
  :role_arn,
  :s3_url,
  :segment_id,
  :segment_name)
  include Aws::Structure
end

#format ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3100

class ImportJobRequest < Struct.new(
  :define_segment,
  :external_id,
  :format,
  :register_endpoints,
  :role_arn,
  :s3_url,
  :segment_id,
  :segment_name)
  include Aws::Structure
end

#register_endpoints ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3100

class ImportJobRequest < Struct.new(
  :define_segment,
  :external_id,
  :format,
  :register_endpoints,
  :role_arn,
  :s3_url,
  :segment_id,
  :segment_name)
  include Aws::Structure
end

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

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3100

class ImportJobRequest < Struct.new(
  :define_segment,
  :external_id,
  :format,
  :register_endpoints,
  :role_arn,
  :s3_url,
  :segment_id,
  :segment_name)
  include Aws::Structure
end

#s3_url ⇒ String

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)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3100

class ImportJobRequest < Struct.new(
  :define_segment,
  :external_id,
  :format,
  :register_endpoints,
  :role_arn,
  :s3_url,
  :segment_id,
  :segment_name)
  include Aws::Structure
end

#segment_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3100

class ImportJobRequest < Struct.new(
  :define_segment,
  :external_id,
  :format,
  :register_endpoints,
  :role_arn,
  :s3_url,
  :segment_id,
  :segment_name)
  include Aws::Structure
end

#segment_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 3100

class ImportJobRequest < Struct.new(
  :define_segment,
  :external_id,
  :format,
  :register_endpoints,
  :role_arn,
  :s3_url,
  :segment_id,
  :segment_name)
  include Aws::Structure
end