Class: Aws::Pinpoint::Types::ImportJobResource
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::ImportJobResource
- Defined in:
- gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb
Overview
Provides information about the resource settings for a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#define_segment ⇒ Boolean
Specifies whether the import job creates 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.
-
#format ⇒ String
The format of the files that contain the endpoint definitions to import.
-
#register_endpoints ⇒ Boolean
Specifies whether the import job registers 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.
-
#s3_url ⇒ 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 that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.
-
#segment_name ⇒ String
The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
Instance Attribute Details
#define_segment ⇒ Boolean
Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.
7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7687 class ImportJobResource < Struct.new( :define_segment, :external_id, :format, :register_endpoints, :role_arn, :s3_url, :segment_id, :segment_name) SENSITIVE = [] include Aws::Structure end |
#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.
7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7687 class ImportJobResource < Struct.new( :define_segment, :external_id, :format, :register_endpoints, :role_arn, :s3_url, :segment_id, :segment_name) SENSITIVE = [] include Aws::Structure end |
#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 files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7687 class ImportJobResource < Struct.new( :define_segment, :external_id, :format, :register_endpoints, :role_arn, :s3_url, :segment_id, :segment_name) SENSITIVE = [] include Aws::Structure end |
#register_endpoints ⇒ Boolean
Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7687 class ImportJobResource < Struct.new( :define_segment, :external_id, :format, :register_endpoints, :role_arn, :s3_url, :segment_id, :segment_name) SENSITIVE = [] include Aws::Structure end |
#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.
7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7687 class ImportJobResource < Struct.new( :define_segment, :external_id, :format, :register_endpoints, :role_arn, :s3_url, :segment_id, :segment_name) SENSITIVE = [] include Aws::Structure end |
#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.
7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7687 class ImportJobResource < Struct.new( :define_segment, :external_id, :format, :register_endpoints, :role_arn, :s3_url, :segment_id, :segment_name) SENSITIVE = [] include Aws::Structure end |
#segment_id ⇒ String
The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.
7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7687 class ImportJobResource < Struct.new( :define_segment, :external_id, :format, :register_endpoints, :role_arn, :s3_url, :segment_id, :segment_name) SENSITIVE = [] include Aws::Structure end |
#segment_name ⇒ String
The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 7687 class ImportJobResource < Struct.new( :define_segment, :external_id, :format, :register_endpoints, :role_arn, :s3_url, :segment_id, :segment_name) SENSITIVE = [] include Aws::Structure end |