create_export_job

create_export_job(**kwargs)

Creates an export job for an application.

See also: AWS API Documentation

Request Syntax

response = client.create_export_job(
    ApplicationId='string',
    ExportJobRequest={
        'RoleArn': 'string',
        'S3UrlPrefix': 'string',
        'SegmentId': 'string',
        'SegmentVersion': 123
    }
)

Parameters

• ApplicationId (string) --

  [REQUIRED]

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

• ExportJobRequest (dict) --

  [REQUIRED]

  Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.

  • RoleArn (string) -- [REQUIRED]

    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.

  • S3UrlPrefix (string) -- [REQUIRED]

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

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

  • SegmentVersion (integer) --

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

Return type

dict

Returns

Response Syntax

{
    'ExportJobResponse': {
        'ApplicationId': 'string',
        'CompletedPieces': 123,
        'CompletionDate': 'string',
        'CreationDate': 'string',
        'Definition': {
            'RoleArn': 'string',
            'S3UrlPrefix': 'string',
            'SegmentId': 'string',
            'SegmentVersion': 123
        },
        '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'
    }
}

Response Structure

• (dict) --

  The request was accepted for processing. Processing may not be complete.

  • ExportJobResponse (dict) --

    Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.

    • ApplicationId (string) --

      The unique identifier for the application that's associated with the export job.

    • CompletedPieces (integer) --

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

    • CompletionDate (string) --

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

    • CreationDate (string) --

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

    • Definition (dict) --

      The resource settings that apply to the export job.

      • RoleArn (string) --

        The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.

      • S3UrlPrefix (string) --

        The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

      • SegmentId (string) --

        The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.

      • SegmentVersion (integer) --

        The version of the segment that the endpoint definitions were exported from.

    • FailedPieces (integer) --

      The number of pieces that weren't processed successfully (failed) by the export 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 export job, if any.

      • (string) --

    • Id (string) --

      The unique identifier for the export job.

    • JobStatus (string) --

      The status of the export 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 export 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 export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.

    • TotalProcessed (integer) --

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

    • Type (string) --

      The job type. This value is EXPORT for export jobs.

Exceptions

• Pinpoint.Client.exceptions.BadRequestException
• Pinpoint.Client.exceptions.InternalServerErrorException
• Pinpoint.Client.exceptions.PayloadTooLargeException
• Pinpoint.Client.exceptions.ForbiddenException
• Pinpoint.Client.exceptions.NotFoundException
• Pinpoint.Client.exceptions.MethodNotAllowedException
• Pinpoint.Client.exceptions.TooManyRequestsException