GetMetadataTransferJob
Retrieves information about a metadata transfer job.
Request Syntax
GET /metadata-transfer-jobs/metadataTransferJobId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- metadataTransferJobId
-
The metadata transfer job Id.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"creationDateTime": number,
"description": "string",
"destination": {
"iotTwinMakerConfiguration": {
"workspace": "string"
},
"s3Configuration": {
"location": "string"
},
"type": "string"
},
"metadataTransferJobId": "string",
"metadataTransferJobRole": "string",
"progress": {
"failedCount": number,
"skippedCount": number,
"succeededCount": number,
"totalCount": number
},
"reportUrl": "string",
"sources": [
{
"iotSiteWiseConfiguration": {
"filters": [
{ ... }
]
},
"iotTwinMakerConfiguration": {
"filters": [
{ ... }
],
"workspace": "string"
},
"s3Configuration": {
"location": "string"
},
"type": "string"
}
],
"status": {
"error": {
"code": "string",
"message": "string"
},
"queuedPosition": number,
"state": "string"
},
"updateDateTime": number
}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.
- arn
-
The metadata transfer job ARN.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[\/a-zA-Z0-9_\-\.:]+ - creationDateTime
-
The metadata transfer job's creation DateTime property.
Type: Timestamp
- description
-
The metadata transfer job description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
.* - destination
-
The metadata transfer job's destination.
Type: DestinationConfiguration object
- metadataTransferJobId
-
The metadata transfer job Id.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+ - metadataTransferJobRole
-
The metadata transfer job's role.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:((aws)|(aws-cn)|(aws-us-gov)):iam::[0-9]{12}:role/.* - progress
-
The metadata transfer job's progress.
Type: MetadataTransferJobProgress object
- reportUrl
-
The metadata transfer job's report URL.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
.* - sources
-
The metadata transfer job's sources.
Type: Array of SourceConfiguration objects
Array Members: Fixed number of 1 item.
- status
-
The metadata transfer job's status.
Type: MetadataTransferJobStatus object
- updateDateTime
-
The metadata transfer job's update DateTime property.
Type: Timestamp
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
- ResourceNotFoundException
-
The resource wasn't found.
HTTP Status Code: 404
- 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 Amazon SDKs, see the following: