Personalize / Client / describe_dataset_export_job

describe_dataset_export_job

Personalize.Client.describe_dataset_export_job(**kwargs)

Describes the dataset export job created by CreateDatasetExportJob, including the export job status.

See also: AWS API Documentation

Request Syntax

response = client.describe_dataset_export_job(
    datasetExportJobArn='string'
)

Parameters:

datasetExportJobArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the dataset export job to describe.

Return type:

dict

Returns:

Response Syntax

{
    'datasetExportJob': {
        'jobName': 'string',
        'datasetExportJobArn': 'string',
        'datasetArn': 'string',
        'ingestionMode': 'BULK'|'PUT'|'ALL',
        'roleArn': 'string',
        'status': 'string',
        'jobOutput': {
            's3DataDestination': {
                'path': 'string',
                'kmsKeyArn': 'string'
            }
        },
        'creationDateTime': datetime(2015, 1, 1),
        'lastUpdatedDateTime': datetime(2015, 1, 1),
        'failureReason': 'string'
    }
}

Response Structure

• (dict) –

  • datasetExportJob (dict) –

    Information about the dataset export job, including the status.

    The status is one of the following values:

    • CREATE PENDING

    • CREATE IN_PROGRESS

    • ACTIVE

    • CREATE FAILED

    • jobName (string) –

      The name of the export job.

    • datasetExportJobArn (string) –

      The Amazon Resource Name (ARN) of the dataset export job.

    • datasetArn (string) –

      The Amazon Resource Name (ARN) of the dataset to export.

    • ingestionMode (string) –

      The data to export, based on how you imported the data. You can choose to export BULK data that you imported using a dataset import job, PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

    • roleArn (string) –

      The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.

    • status (string) –

      The status of the dataset export job.

      A dataset export job can be in one of the following states:

      • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

    • jobOutput (dict) –

      The path to the Amazon S3 bucket where the job’s output is stored. For example:

      s3://bucket-name/folder-name/

      • s3DataDestination (dict) –

        The configuration details of an Amazon S3 input or output bucket.

        • path (string) –

          The file path of the Amazon S3 bucket.

        • kmsKeyArn (string) –

          The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files.

    • creationDateTime (datetime) –

      The creation date and time (in Unix time) of the dataset export job.

    • lastUpdatedDateTime (datetime) –

      The date and time (in Unix time) the status of the dataset export job was last updated.

    • failureReason (string) –

      If a dataset export job fails, provides the reason why.

Exceptions

• Personalize.Client.exceptions.InvalidInputException

• Personalize.Client.exceptions.ResourceNotFoundException