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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Instance Attribute Summary collapse

Instance Attribute Details

#define_segmentBoolean

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

Returns:

  • (Boolean)


3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3155

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

#external_idString

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

Returns:

  • (String)


3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3155

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

#formatString

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

Returns:

  • (String)


3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3155

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

#register_endpointsBoolean

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

Returns:

  • (Boolean)


3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3155

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

#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)


3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3155

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

#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)


3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3155

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

#segment_idString

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

Returns:

  • (String)


3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3155

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

#segment_nameString

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

Returns:

  • (String)


3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 3155

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