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

ListVectorEnrichmentJobs

Retrieves a list of vector enrichment jobs.

Request Syntax


POST /list-vector-enrichment-jobs HTTP/1.1
Content-type: application/json

{
   "MaxResults": number,
   "NextToken": "string",
   "SortBy": "string",
   "SortOrder": "string",
   "StatusEquals": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

MaxResults

The maximum number of items to return.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 20.

Required: No

NextToken

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Required: No

SortBy

The parameter by which to sort the results.

Type: String

Required: No

SortOrder

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

Type: String

Valid Values: ASCENDING | DESCENDING

Required: No

StatusEquals

A filter that retrieves only jobs with a specific status.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "VectorEnrichmentJobSummaries": [ 
      { 
         "Arn": "string",
         "CreationTime": "string",
         "DurationInSeconds": number,
         "Name": "string",
         "Status": "string",
         "Tags": { 
            "string" : "string" 
         },
         "Type": "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.

NextToken

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

VectorEnrichmentJobSummaries

Contains summary information about the Vector Enrichment jobs.

Type: Array of ListVectorEnrichmentJobOutputConfig objects

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource which does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400