Class: Aws::Pinpoint::Types::ExportJobRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::ExportJobRequest
- Defined in:
- gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb
Overview
When making an API call, you may pass ExportJobRequest data as a hash:
{
role_arn: "__string", # required
s3_url_prefix: "__string", # required
segment_id: "__string",
segment_version: 1,
}
Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.
-
#s3_url_prefix ⇒ String
The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to.
-
#segment_id ⇒ String
The identifier for the segment to export endpoint definitions from.
-
#segment_version ⇒ Integer
The version of the segment to export endpoint definitions from, if specified.
Instance Attribute Details
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.
8429 8430 8431 8432 8433 8434 8435 8436 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 8429 class ExportJobRequest < 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 you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.
8429 8430 8431 8432 8433 8434 8435 8436 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 8429 class ExportJobRequest < Struct.new( :role_arn, :s3_url_prefix, :segment_id, :segment_version) SENSITIVE = [] include Aws::Structure end |
#segment_id ⇒ String
The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.
8429 8430 8431 8432 8433 8434 8435 8436 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 8429 class ExportJobRequest < Struct.new( :role_arn, :s3_url_prefix, :segment_id, :segment_version) SENSITIVE = [] include Aws::Structure end |
#segment_version ⇒ Integer
The version of the segment to export endpoint definitions from, if specified.
8429 8430 8431 8432 8433 8434 8435 8436 |
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 8429 class ExportJobRequest < Struct.new( :role_arn, :s3_url_prefix, :segment_id, :segment_version) SENSITIVE = [] include Aws::Structure end |