Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListImportJobs

Lists all of the import jobs.

Request Syntax


POST /v2/email/import-jobs/list HTTP/1.1
Content-type: application/json

{
   "ImportDestinationType": "string",
   "NextToken": "string",
   "PageSize": number
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ImportDestinationType

The destination of the import job, which can be used to list import jobs that have a certain ImportDestinationType.

Type: String

Valid Values: SUPPRESSION_LIST | CONTACT_LIST

Required: No

NextToken

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

Type: String

Required: No

PageSize

Maximum number of import jobs to return at once. Use this parameter to paginate results. If additional import jobs exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional addresses.

Type: Integer

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ImportJobs": [ 
      { 
         "CreatedTimestamp": number,
         "FailedRecordsCount": number,
         "ImportDestination": { 
            "ContactListDestination": { 
               "ContactListImportAction": "string",
               "ContactListName": "string"
            },
            "SuppressionListDestination": { 
               "SuppressionListImportAction": "string"
            }
         },
         "JobId": "string",
         "JobStatus": "string",
         "ProcessedRecordsCount": number
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ImportJobs

A list of the import job summaries.

Type: Array of ImportJobSummary objects

NextToken

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429