Lists the metadata transfer jobs.
Request Syntax
POST /metadata-transfer-jobs-list HTTP/1.1
Content-type: application/json
{
"destinationType": "string",
"filters": [
{ ... }
],
"maxResults": number,
"nextToken": "string",
"sourceType": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- destinationType
-
The metadata transfer job's destination type.
Type: String
Valid Values:
s3 | iotsitewise | iottwinmakerRequired: Yes
- filters
-
An object that filters metadata transfer jobs.
Type: Array of ListMetadataTransferJobsFilter objects
Required: No
- maxResults
-
The maximum number of results to return at one time.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 200.
Required: No
- nextToken
-
The string that specifies the next page of results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 17880.
Pattern:
.*Required: No
- sourceType
-
The metadata transfer job's source type.
Type: String
Valid Values:
s3 | iotsitewise | iottwinmakerRequired: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"metadataTransferJobSummaries": [
{
"arn": "string",
"creationDateTime": number,
"metadataTransferJobId": "string",
"progress": {
"failedCount": number,
"skippedCount": number,
"succeededCount": number,
"totalCount": number
},
"status": {
"error": {
"code": "string",
"message": "string"
},
"queuedPosition": number,
"state": "string"
},
"updateDateTime": 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.
- metadataTransferJobSummaries
-
The metadata transfer job summaries.
Type: Array of MetadataTransferJobSummary objects
- nextToken
-
The string that specifies the next page of results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 17880.
Pattern:
.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
Access is denied.
HTTP Status Code: 403
- InternalServerException
-
An unexpected error has occurred.
HTTP Status Code: 500
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 429
- ValidationException
-
Failed
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
