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

Class: Aws::Pinpoint::Types::ExportJobRequest

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

Overview

Note:

When making an API call, you may pass ExportJobRequest data as a hash:

{
  role_arn: "__string",
  s3_url_prefix: "__string",
  segment_id: "__string",
  segment_version: 1,
}

Export job request.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#role_arn ⇒ String

The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.

Returns:

  • (String) 


4247
4248
4249
4250
4251
4252
4253
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4247

class ExportJobRequest < Struct.new(
  :role_arn,
  :s3_url_prefix,
  :segment_id,
  :segment_version)
  include Aws::Structure
end

#s3_url_prefix ⇒ String

A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.

Returns:

  • (String) 


4247
4248
4249
4250
4251
4252
4253
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4247

class ExportJobRequest < Struct.new(
  :role_arn,
  :s3_url_prefix,
  :segment_id,
  :segment_version)
  include Aws::Structure
end

#segment_id ⇒ String

The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.

Returns:

  • (String) 


4247
4248
4249
4250
4251
4252
4253
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4247

class ExportJobRequest < Struct.new(
  :role_arn,
  :s3_url_prefix,
  :segment_id,
  :segment_version)
  include Aws::Structure
end

#segment_version ⇒ Integer

The version of the segment to export if specified.

Returns:

  • (Integer) 


4247
4248
4249
4250
4251
4252
4253
 
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 4247

class ExportJobRequest < Struct.new(
  :role_arn,
  :s3_url_prefix,
  :segment_id,
  :segment_version)
  include Aws::Structure
end