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

Overview

Import job resource

Instance Attribute Summary collapse

Instance Attribute Details

#define_segmentBoolean

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

Returns:

  • (Boolean)


5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5851

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

(Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.

Returns:

  • (String)


5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5851

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)


5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5851

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)


5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5851

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)


5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5851

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

The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name Amazon Pinpoint imports endpoints from this location and any subfolders it contains.

Returns:

  • (String)


5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5851

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)


5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5851

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)


5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5851

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