Class: Aws::Pinpoint::Types::ExportJobResource

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb

Overview

Provides information about the resource settings for a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#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 where the endpoint definitions were exported to.

Returns:

  • (String) 


5544
5545
5546
5547
5548
5549
5550
5551
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5544

class ExportJobResource < Struct.new(
  :role_arn,
  :s3_url_prefix,
  :segment_id,
  :segment_version)
  SENSITIVE = []
  include Aws::Structure
end

#s3_url_prefix ⇒ String

The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

Returns:

  • (String) 


5544
5545
5546
5547
5548
5549
5550
5551
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5544

class ExportJobResource < Struct.new(
  :role_arn,
  :s3_url_prefix,
  :segment_id,
  :segment_version)
  SENSITIVE = []
  include Aws::Structure
end

#segment_id ⇒ String

The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.

Returns:

  • (String) 


5544
5545
5546
5547
5548
5549
5550
5551
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5544

class ExportJobResource < Struct.new(
  :role_arn,
  :s3_url_prefix,
  :segment_id,
  :segment_version)
  SENSITIVE = []
  include Aws::Structure
end

#segment_version ⇒ Integer

The version of the segment that the endpoint definitions were exported from.

Returns:

  • (Integer) 


5544
5545
5546
5547
5548
5549
5550
5551
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 5544

class ExportJobResource < Struct.new(
  :role_arn,
  :s3_url_prefix,
  :segment_id,
  :segment_version)
  SENSITIVE = []
  include Aws::Structure
end