Pinpoint / Client / get_segment_import_jobs

get_segment_import_jobs#

Pinpoint.Client.get_segment_import_jobs(**kwargs)#

Retrieves information about the status and settings of the import jobs for a segment.

See also: AWS API Documentation

Request Syntax

response = client.get_segment_import_jobs(
    ApplicationId='string',
    PageSize='string',
    SegmentId='string',
    Token='string'
)
Parameters:

  • ApplicationId (string) –

    [REQUIRED]

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

  • PageSize (string) – The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

  • SegmentId (string) –

    [REQUIRED]

    The unique identifier for the segment.

  • Token (string) – The NextToken string that specifies which page of results to return in a paginated response.

Return type:

dict

Returns:

Response Syntax

{
    'ImportJobsResponse': {
        'Item': [
            {
                'ApplicationId': 'string',
                'CompletedPieces': 123,
                'CompletionDate': 'string',
                'CreationDate': 'string',
                'Definition': {
                    'DefineSegment': True|False,
                    'ExternalId': 'string',
                    'Format': 'CSV'|'JSON',
                    'RegisterEndpoints': True|False,
                    'RoleArn': 'string',
                    'S3Url': 'string',
                    'SegmentId': 'string',
                    'SegmentName': 'string'
                },
                'FailedPieces': 123,
                'Failures': [
                    'string',
                ],
                'Id': 'string',
                'JobStatus': 'CREATED'|'PREPARING_FOR_INITIALIZATION'|'INITIALIZING'|'PROCESSING'|'PENDING_JOB'|'COMPLETING'|'COMPLETED'|'FAILING'|'FAILED',
                'TotalFailures': 123,
                'TotalPieces': 123,
                'TotalProcessed': 123,
                'Type': 'string'
            },
        ],
        'NextToken': 'string'
    }
}

Response Structure

  • (dict) –

    The request succeeded.

    • ImportJobsResponse (dict) –

      Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.

      • Item (list) –

        An array of responses, one for each import job that’s associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).

        • (dict) –

          Provides information about the status and settings of 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.

          • ApplicationId (string) –

            The unique identifier for the application that’s associated with the import job.

          • CompletedPieces (integer) –

            The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.

          • CompletionDate (string) –

            The date, in ISO 8601 format, when the import job was completed.

          • CreationDate (string) –

            The date, in ISO 8601 format, when the import job was created.

          • Definition (dict) –

            The resource settings that apply to the import job.

            • DefineSegment (boolean) –

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

            • ExternalId (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 (string) –

              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.

            • RegisterEndpoints (boolean) –

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

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

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

            • SegmentId (string) –

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

            • SegmentName (string) –

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

          • FailedPieces (integer) –

            The number of pieces that weren’t processed successfully (failed) by the import job, as of the time of the request.

          • Failures (list) –

            An array of entries, one for each of the first 100 entries that weren’t processed successfully (failed) by the import job, if any.

            • (string) –

          • Id (string) –

            The unique identifier for the import job.

          • JobStatus (string) –

            The status of the import job. The job status is FAILED if Amazon Pinpoint wasn’t able to process one or more pieces in the job.

          • TotalFailures (integer) –

            The total number of endpoint definitions that weren’t processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.

          • TotalPieces (integer) –

            The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.

          • TotalProcessed (integer) –

            The total number of endpoint definitions that were processed by the import job.

          • Type (string) –

            The job type. This value is IMPORT for import jobs.

      • NextToken (string) –

        The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Exceptions