Class: Aws::Pinpoint::Types::ImportJobResource
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::ImportJobResource
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-pinpoint/types.rb
Overview
Instance Attribute Summary collapse
-
#define_segment ⇒ Boolean
Sets whether the endpoints create a segment when they are imported.
-
#external_id ⇒ String
DEPRECATED.
-
#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.
5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5098 class ImportJobResource < Struct.new( :define_segment, :external_id, :format, :register_endpoints, :role_arn, :s3_url, :segment_id, :segment_name) include Aws::Structure end |
#external_id ⇒ String
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.
5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5098 class ImportJobResource < 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
5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5098 class ImportJobResource < 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.
5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5098 class ImportJobResource < 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.
5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5098 class ImportJobResource < 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.
5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5098 class ImportJobResource < 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.
5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5098 class ImportJobResource < 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.
5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 |
# File 'lib/aws-sdk-pinpoint/types.rb', line 5098 class ImportJobResource < Struct.new( :define_segment, :external_id, :format, :register_endpoints, :role_arn, :s3_url, :segment_id, :segment_name) include Aws::Structure end |