---
title: "POST /metadata-transfer-jobs"
method: POST
path: "/metadata-transfer-jobs"
---

# POST /metadata-transfer-jobs

`POST /metadata-transfer-jobs`

Creates a new metadata transfer job.

## Request body

- object
  - `metadataTransferJobId` string — The metadata transfer job Id.
  - `description` string — The metadata transfer job description.
  - `sources` SourceConfiguration[], required — The metadata transfer job sources.
    - `type` 's3' | 'iotsitewise' | 'iottwinmaker', required — The source configuration type.
    - `s3Configuration` object — The source configuration S3 configuration.
      - `location` string, required — The S3 destination source configuration location.
    - `iotSiteWiseConfiguration` object — The source configuration IoT SiteWise configuration.
      - `filters` IotSiteWiseSourceConfigurationFilter[] — The AWS IoT SiteWise soucre configuration filters.
        - `filterByAssetModel` object — Filter by asset model.
          - `assetModelId` string — The asset model Id.
          - `assetModelExternalId` string — The external-Id property of an asset model.
          - `includeOffspring` boolean — Include asset offspring. [need desc.]
          - `includeAssets` boolean — Bolean to include assets.
        - `filterByAsset` object — Filter by asset.
          - `assetId` string — Filter by asset Id.
          - `assetExternalId` string — The external-Id property of an asset.
          - `includeOffspring` boolean — Includes sub-assets.[need description hekp for this]
          - `includeAssetModel` boolean — Boolean to include the asset model.
    - `iotTwinMakerConfiguration` object — The source configuration IoT TwinMaker configuration.
      - `workspace` string, required — The IoT TwinMaker workspace.
      - `filters` IotTwinMakerSourceConfigurationFilter[] — The metadata transfer job AWS IoT TwinMaker source configuration filters.
        - `filterByComponentType` object — Filter by component type.
          - `componentTypeId` string, required — The component type Id.
        - `filterByEntity` object — Filter by entity.
          - `entityId` string, required — The entity Id.
  - `destination` object, required — The [link to action] metadata transfer job destination configuration.
    - `type` 's3' | 'iotsitewise' | 'iottwinmaker' — The destination type.
    - `s3Configuration` object — The metadata transfer job S3 configuration. [need to add S3 entity]
      - `location` string, required — The S3 destination configuration location.
    - `iotTwinMakerConfiguration` object — The metadata transfer job Amazon Web Services IoT TwinMaker configuration.
      - `workspace` string, required — The IoT TwinMaker workspace.

## Response `200`

Success

- CreateMetadataTransferJobResponse
  - `metadataTransferJobId` string, required — The metadata transfer job Id.
  - `arn` string, required — The metadata transfer job ARN.
  - `creationDateTime` string, date-time, required — The The metadata transfer job creation DateTime property.
  - `status` object, required — The metadata transfer job response status.
    - `state` 'VALIDATING' | 'PENDING' | 'RUNNING' | 'CANCELLING' | 'ERROR' | 'COMPLETED' | 'CANCELLED' — The metadata transfer job state.
    - `error` object — The metadata transfer job error.
      - `code` 'VALIDATION_ERROR' | 'INTERNAL_FAILURE' | 'SYNC_INITIALIZING_ERROR' | 'SYNC_CREATING_ERROR' | 'SYNC_PROCESSING_ERROR' | 'SYNC_DELETING_ERROR' | 'PROCESSING_ERROR' | 'COMPOSITE_COMPONENT_FAILURE' — The error code.
      - `message` string — The error message.
    - `queuedPosition` integer — The queued position.

## Other responses

- `480` — InternalServerException
- `481` — AccessDeniedException
- `482` — ResourceNotFoundException
- `483` — ThrottlingException
- `484` — ValidationException
- `485` — ConflictException
- `486` — ServiceQuotaExceededException

---

[API](https://skmtc.net/aws/apis/iottwinmaker.md) · [All operations](https://skmtc.net/aws/apis/iottwinmaker/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/iottwinmaker/versions/a66a26fd65ea/schema)