CustomerProfiles / Client / list_upload_jobs

list_upload_jobs

CustomerProfiles.Client.list_upload_jobs(**kwargs)

This API retrieves a list of upload jobs for the specified domain.

See also: AWS API Documentation

Request Syntax

response = client.list_upload_jobs(
    DomainName='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The unique name of the domain to list upload jobs for.

  • MaxResults (integer) – The maximum number of upload jobs to return per page.

  • NextToken (string) – The pagination token from the previous call to retrieve the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'Items': [
        {
            'JobId': 'string',
            'DisplayName': 'string',
            'Status': 'CREATED'|'IN_PROGRESS'|'PARTIALLY_SUCCEEDED'|'SUCCEEDED'|'FAILED'|'STOPPED',
            'StatusReason': 'VALIDATION_FAILURE'|'INTERNAL_FAILURE',
            'CreatedAt': datetime(2015, 1, 1),
            'CompletedAt': datetime(2015, 1, 1),
            'DataExpiry': 123
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      The pagination token to use to retrieve the next page of results.

    • Items (list) –

      The list of upload jobs for the specified domain.

      • (dict) –

        The summary information for an individual upload job.

        • JobId (string) –

          The unique identifier of the upload job.

        • DisplayName (string) –

          The name of the upload job.

        • Status (string) –

          The current status of the upload job.

        • StatusReason (string) –

          The reason for the current status of the upload job.

        • CreatedAt (datetime) –

          The timestamp when the upload job was created.

        • CompletedAt (datetime) –

          The timestamp when the upload job was completed.

        • DataExpiry (integer) –

          The expiry duration for the profiles ingested with the upload job.

Exceptions