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

CreateMetadataTransferJob

Creates a new metadata transfer job.

Request Syntax


POST /metadata-transfer-jobs HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "destination": { 
      "iotTwinMakerConfiguration": { 
         "workspace": "string"
      },
      "s3Configuration": { 
         "location": "string"
      },
      "type": "string"
   },
   "metadataTransferJobId": "string",
   "sources": [ 
      { 
         "iotSiteWiseConfiguration": { 
            "filters": [ 
               { ... }
            ]
         },
         "iotTwinMakerConfiguration": { 
            "filters": [ 
               { ... }
            ],
            "workspace": "string"
         },
         "s3Configuration": { 
            "location": "string"
         },
         "type": "string"
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

description

The metadata transfer job description.

Type: String

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

Pattern: .*

Required: No

destination

The metadata transfer job destination.

Type: DestinationConfiguration object

Required: Yes

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]+

Required: No

sources

The metadata transfer job sources.

Type: Array of SourceConfiguration objects

Array Members: Fixed number of 1 item.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "creationDateTime": number,
   "metadataTransferJobId": "string",
   "status": { 
      "error": { 
         "code": "string",
         "message": "string"
      },
      "queuedPosition": number,
      "state": "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.

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 The metadata transfer job creation DateTime property.

Type: Timestamp

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]+

status

The metadata transfer job response status.

Type: MetadataTransferJobStatus object

Errors

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

AccessDeniedException

Access is denied.

HTTP Status Code: 403

ConflictException

A conflict occurred.

HTTP Status Code: 409

InternalServerException

An unexpected error has occurred.

HTTP Status Code: 500

ResourceNotFoundException

The resource wasn't found.

HTTP Status Code: 404

ServiceQuotaExceededException

The service quota was exceeded.

HTTP Status Code: 402

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

ValidationException

Failed

HTTP Status Code: 400