AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Class: Aws::Pinpoint::Types::SegmentImportResource

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Provides information about the import job that created a segment. An import job is a job that creates a user segment by importing endpoint definitions.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#channel_countsHash<String,Integer>

The number of channel types in the endpoint definitions that were imported to create the segment.

Returns:

  • (Hash<String,Integer>)

    The number of channel types in the endpoint definitions that were imported to create the segment.

#external_idString

(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.

Returns:

  • (String)

    (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy.

#formatString

The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

Possible values:

  • CSV
  • JSON

Returns:

  • (String)

    The format of the files that were imported to create the segment.

#role_arnString

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

#s3_urlString

The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.

Returns:

  • (String)

    The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.

#sizeInteger

The number of endpoint definitions that were imported successfully to create the segment.

Returns:

  • (Integer)

    The number of endpoint definitions that were imported successfully to create the segment.