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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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",
}

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) 


3626
3627
3628
3629
3630
3631
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 3626

class ExportJobRequest < Struct.new(
  :role_arn,
  :s3_url_prefix,
  :segment_id)
  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) 


3626
3627
3628
3629
3630
3631
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 3626

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

#segment_id ⇒ String

The ID of the segment to export endpoints from. If not present, all endpoints will be exported.

Returns:

  • (String) 


3626
3627
3628
3629
3630
3631
 
# File 'lib/aws-sdk-pinpoint/types.rb', line 3626

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