libZSservicesZSamazonka-pinpointZSamazonka-pinpoint
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Pinpoint.Types.ImportJobResource

Description

 
Synopsis

Documentation

data ImportJobResource Source #

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.

See: newImportJobResource smart constructor.

Constructors

ImportJobResource' 

Fields

  • segmentName :: Maybe Text

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

  • defineSegment :: Maybe Bool

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

  • registerEndpoints :: Maybe Bool

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

  • externalId :: Maybe Text

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

  • segmentId :: Maybe Text

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

  • format :: DefinitionFormat

    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.

  • s3Url :: Text

    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.

  • roleArn :: Text

    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.

Instances

Instances details
Eq ImportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResource

Read ImportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResource

Show ImportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResource

Generic ImportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResource

Associated Types

type Rep ImportJobResource :: Type -> Type #

NFData ImportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResource

Methods

rnf :: ImportJobResource -> () #

Hashable ImportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResource

FromJSON ImportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResource

type Rep ImportJobResource Source # 
Instance details

Defined in Amazonka.Pinpoint.Types.ImportJobResource

newImportJobResource Source #

Create a value of ImportJobResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:segmentName:ImportJobResource', importJobResource_segmentName - The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

$sel:defineSegment:ImportJobResource', importJobResource_defineSegment - Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.

$sel:registerEndpoints:ImportJobResource', importJobResource_registerEndpoints - Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

$sel:externalId:ImportJobResource', importJobResource_externalId - (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.

$sel:segmentId:ImportJobResource', importJobResource_segmentId - The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.

$sel:format:ImportJobResource', importJobResource_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.

$sel:s3Url:ImportJobResource', importJobResource_s3Url - 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.

$sel:roleArn:ImportJobResource', importJobResource_roleArn - 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.

importJobResource_segmentName :: Lens' ImportJobResource (Maybe Text) Source #

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

importJobResource_defineSegment :: Lens' ImportJobResource (Maybe Bool) Source #

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

importJobResource_registerEndpoints :: Lens' ImportJobResource (Maybe Bool) Source #

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

importJobResource_externalId :: Lens' ImportJobResource (Maybe Text) Source #

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

importJobResource_segmentId :: Lens' ImportJobResource (Maybe Text) Source #

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

importJobResource_format :: Lens' ImportJobResource DefinitionFormat Source #

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.

importJobResource_s3Url :: Lens' ImportJobResource Text Source #

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.

importJobResource_roleArn :: Lens' ImportJobResource Text Source #

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.