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

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::SegmentImportResource

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #channel_counts ⇒ Hash<String,Integer>

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

• #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 were imported to create the segment.

• #role_arn ⇒ 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_url ⇒ String

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

• #size ⇒ Integer

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

Instance Attribute Details

#channel_counts ⇒ Hash<String,Integer>

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

Returns:

• (Hash<String,Integer>)

# File 'lib/aws-sdk-pinpoint/types.rb', line 11252

class SegmentImportResource < Struct.new(
  :channel_counts,
  :external_id,
  :format,
  :role_arn,
  :s3_url,
  :size)
  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.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 11252

class SegmentImportResource < Struct.new(
  :channel_counts,
  :external_id,
  :format,
  :role_arn,
  :s3_url,
  :size)
  SENSITIVE = []
  include Aws::Structure
end

#format ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 11252

class SegmentImportResource < Struct.new(
  :channel_counts,
  :external_id,
  :format,
  :role_arn,
  :s3_url,
  :size)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 11252

class SegmentImportResource < Struct.new(
  :channel_counts,
  :external_id,
  :format,
  :role_arn,
  :s3_url,
  :size)
  SENSITIVE = []
  include Aws::Structure
end

#s3_url ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 11252

class SegmentImportResource < Struct.new(
  :channel_counts,
  :external_id,
  :format,
  :role_arn,
  :s3_url,
  :size)
  SENSITIVE = []
  include Aws::Structure
end

#size ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-pinpoint/types.rb', line 11252

class SegmentImportResource < Struct.new(
  :channel_counts,
  :external_id,
  :format,
  :role_arn,
  :s3_url,
  :size)
  SENSITIVE = []
  include Aws::Structure
end