Struct ImportJobResource 

#[non_exhaustive]
pub struct ImportJobResource {
    pub define_segment: Option<bool>,
    pub external_id: Option<String>,
    pub format: Option<Format>,
    pub register_endpoints: Option<bool>,
    pub role_arn: Option<String>,
    pub s3_url: Option<String>,
    pub segment_id: Option<String>,
    pub segment_name: Option<String>,
}

Provides information about the resource settings for a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

define_segment: Option<bool>

Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.

external_id: Option<String>

(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

format: Option<Format>

The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

register_endpoints: Option<bool>

Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

role_arn: Option<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 to import endpoint definitions from.

s3_url: Option<String>

The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.

The URL should be in the following format: s3:// bucket-name / folder-name / file-name . The location can end with the key for an individual object or a prefix that qualifies multiple objects.

segment_id: Option<String>

The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.

segment_name: Option<String>

The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

Implementations

impl ImportJobResource

pub fn define_segment(&self) -> Option<bool>

Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.

pub fn external_id(&self) -> Option<&str>

(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

pub fn format(&self) -> Option<&Format>

The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

pub fn register_endpoints(&self) -> Option<bool>

Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

pub fn role_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

pub fn s3_url(&self) -> Option<&str>

The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.

The URL should be in the following format: s3:// bucket-name / folder-name / file-name . The location can end with the key for an individual object or a prefix that qualifies multiple objects.

pub fn segment_id(&self) -> Option<&str>

The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.

pub fn segment_name(&self) -> Option<&str>

The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

impl ImportJobResource

pub fn builder() -> ImportJobResourceBuilder

Creates a new builder-style object to manufacture ImportJobResource.

Trait Implementations

impl Clone for ImportJobResource

fn clone(&self) -> ImportJobResource

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ImportJobResource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ImportJobResource

fn eq(&self, other: &ImportJobResource) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ImportJobResource