IoTTwinMaker / Client / get_metadata_transfer_job

get_metadata_transfer_job#

IoTTwinMaker.Client.get_metadata_transfer_job(**kwargs)#

Gets a nmetadata transfer job.

See also: AWS API Documentation

Request Syntax

response = client.get_metadata_transfer_job(
    metadataTransferJobId='string'
)
Parameters:

metadataTransferJobId (string) –

[REQUIRED]

The metadata transfer job Id.

Return type:

dict

Returns:

Response Syntax

{
    'metadataTransferJobId': 'string',
    'arn': 'string',
    'description': 'string',
    'sources': [
        {
            'type': 's3'|'iotsitewise'|'iottwinmaker',
            's3Configuration': {
                'location': 'string'
            },
            'iotSiteWiseConfiguration': {
                'filters': [
                    {
                        'filterByAssetModel': {
                            'assetModelId': 'string',
                            'assetModelExternalId': 'string',
                            'includeOffspring': True|False,
                            'includeAssets': True|False
                        },
                        'filterByAsset': {
                            'assetId': 'string',
                            'assetExternalId': 'string',
                            'includeOffspring': True|False,
                            'includeAssetModel': True|False
                        }
                    },
                ]
            },
            'iotTwinMakerConfiguration': {
                'workspace': 'string',
                'filters': [
                    {
                        'filterByComponentType': {
                            'componentTypeId': 'string'
                        },
                        'filterByEntity': {
                            'entityId': 'string'
                        }
                    },
                ]
            }
        },
    ],
    'destination': {
        'type': 's3'|'iotsitewise'|'iottwinmaker',
        's3Configuration': {
            'location': 'string'
        },
        'iotTwinMakerConfiguration': {
            'workspace': 'string'
        }
    },
    'metadataTransferJobRole': 'string',
    'reportUrl': 'string',
    'creationDateTime': datetime(2015, 1, 1),
    'updateDateTime': datetime(2015, 1, 1),
    'status': {
        'state': 'VALIDATING'|'PENDING'|'RUNNING'|'CANCELLING'|'ERROR'|'COMPLETED'|'CANCELLED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE',
            'message': 'string'
        },
        'queuedPosition': 123
    },
    'progress': {
        'totalCount': 123,
        'succeededCount': 123,
        'skippedCount': 123,
        'failedCount': 123
    }
}

Response Structure

  • (dict) –

    • metadataTransferJobId (string) –

      The metadata transfer job Id.

    • arn (string) –

      The metadata transfer job ARN.

    • description (string) –

      The metadata transfer job description.

    • sources (list) –

      The metadata transfer job’s sources.

      • (dict) –

        The source configuration.

        • type (string) –

          The source configuration type.

        • s3Configuration (dict) –

          The source configuration S3 configuration.

          • location (string) –

            The S3 destination source configuration location.

        • iotSiteWiseConfiguration (dict) –

          The source configuration IoT SiteWise configuration.

          • filters (list) –

            The AWS IoT SiteWise soucre configuration filters.

            • (dict) –

              The AWS IoT SiteWise soucre configuration filter.[need held with desc here]

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: filterByAssetModel, filterByAsset. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
              
              • filterByAssetModel (dict) –

                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 (dict) –

                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 (dict) –

          The source configuration IoT TwinMaker configuration.

          • workspace (string) –

            The IoT TwinMaker workspace.

          • filters (list) –

            The metadata transfer job AWS IoT TwinMaker source configuration filters.

            • (dict) –

              The metadata transfer job AWS IoT TwinMaker source configuration filter.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: filterByComponentType, filterByEntity. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
              
              • filterByComponentType (dict) –

                Filter by component type.

                • componentTypeId (string) –

                  The component type Id.

              • filterByEntity (dict) –

                Filter by entity.

                • entityId (string) –

                  The entity Id.

    • destination (dict) –

      The metadata transfer job’s destination.

      • type (string) –

        The destination type.

      • s3Configuration (dict) –

        The metadata transfer job S3 configuration. [need to add S3 entity]

        • location (string) –

          The S3 destination configuration location.

      • iotTwinMakerConfiguration (dict) –

        The metadata transfer job Amazon Web Services IoT TwinMaker configuration.

        • workspace (string) –

          The IoT TwinMaker workspace.

    • metadataTransferJobRole (string) –

      The metadata transfer job’s role.

    • reportUrl (string) –

      The metadata transfer job’s report URL.

    • creationDateTime (datetime) –

      The metadata transfer job’s creation DateTime property.

    • updateDateTime (datetime) –

      The metadata transfer job’s update DateTime property.

    • status (dict) –

      The metadata transfer job’s status.

      • state (string) –

        The metadata transfer job state.

      • error (dict) –

        The metadata transfer job error.

        • code (string) –

          The error code.

        • message (string) –

          The error message.

      • queuedPosition (integer) –

        The queued position.

    • progress (dict) –

      The metadata transfer job’s progress.

      • totalCount (integer) –

        The total count. [of what]

      • succeededCount (integer) –

        The succeeded count.

      • skippedCount (integer) –

        The skipped count.

      • failedCount (integer) –

        The failed count.

Exceptions

  • IoTTwinMaker.Client.exceptions.InternalServerException

  • IoTTwinMaker.Client.exceptions.AccessDeniedException

  • IoTTwinMaker.Client.exceptions.ResourceNotFoundException

  • IoTTwinMaker.Client.exceptions.ThrottlingException

  • IoTTwinMaker.Client.exceptions.ValidationException