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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ExportJobRequest as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

See Also:

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 authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.

Returns:

  • (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. 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) —

    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. If you don\'t specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.

Returns:

  • (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.

Returns:

  • (Integer) —

    The version of the segment to export endpoint definitions from, if specified.