SESV2 / Client / list_export_jobs

list_export_jobs#

SESV2.Client.list_export_jobs(**kwargs)#

Lists all of the export jobs.

See also: AWS API Documentation

Request Syntax

response = client.list_export_jobs(
    NextToken='string',
    PageSize=123,
    ExportSourceType='METRICS_DATA'|'MESSAGE_INSIGHTS',
    JobStatus='CREATED'|'PROCESSING'|'COMPLETED'|'FAILED'|'CANCELLED'
)
Parameters:

  • NextToken (string) – The pagination token returned from a previous call to ListExportJobs to indicate the position in the list of export jobs.

  • PageSize (integer) – Maximum number of export jobs to return at once. Use this parameter to paginate results. If additional export jobs exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent calls to ListExportJobs to retrieve additional export jobs.

  • ExportSourceType (string) – A value used to list export jobs that have a certain ExportSourceType.

  • JobStatus (string) – A value used to list export jobs that have a certain JobStatus.

Return type:

dict

Returns:

Response Syntax

{
    'ExportJobs': [
        {
            'JobId': 'string',
            'ExportSourceType': 'METRICS_DATA'|'MESSAGE_INSIGHTS',
            'JobStatus': 'CREATED'|'PROCESSING'|'COMPLETED'|'FAILED'|'CANCELLED',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'CompletedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    An HTTP 200 response if the request succeeds, or an error message if the request fails.

    • ExportJobs (list) –

      A list of the export job summaries.

      • (dict) –

        A summary of the export job.

        • JobId (string) –

          The export job ID.

        • ExportSourceType (string) –

          The source type of the export job.

        • JobStatus (string) –

          The status of the export job.

        • CreatedTimestamp (datetime) –

          The timestamp of when the export job was created.

        • CompletedTimestamp (datetime) –

          The timestamp of when the export job was completed.

    • NextToken (string) –

      A string token indicating that there might be additional export jobs available to be listed. Use this token to a subsequent call to ListExportJobs with the same parameters to retrieve the next page of export jobs.

Exceptions