IoTTwinMaker / Client / list_metadata_transfer_jobs

list_metadata_transfer_jobs#

IoTTwinMaker.Client.list_metadata_transfer_jobs(**kwargs)#

Lists the metadata transfer jobs.

See also: AWS API Documentation

Request Syntax

response = client.list_metadata_transfer_jobs(
    sourceType='s3'|'iotsitewise'|'iottwinmaker',
    destinationType='s3'|'iotsitewise'|'iottwinmaker',
    filters=[
        {
            'workspaceId': 'string',
            'state': 'VALIDATING'|'PENDING'|'RUNNING'|'CANCELLING'|'ERROR'|'COMPLETED'|'CANCELLED'
        },
    ],
    nextToken='string',
    maxResults=123
)
Parameters:

  • sourceType (string) –

    [REQUIRED]

    The metadata transfer job’s source type.

  • destinationType (string) –

    [REQUIRED]

    The metadata transfer job’s destination type.

  • filters (list) –

    An object that filters metadata transfer jobs.

    • (dict) –

      The ListMetadataTransferJobs filter.

      Note

      This is a Tagged Union structure. Only one of the following top level keys can be set: workspaceId, state.

      • workspaceId (string) –

        The workspace Id.

      • state (string) –

        The filter state.

  • nextToken (string) – The string that specifies the next page of results.

  • maxResults (integer) – The maximum number of results to return at one time.

Return type:

dict

Returns:

Response Syntax

{
    'metadataTransferJobSummaries': [
        {
            'metadataTransferJobId': 'string',
            'arn': '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
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • metadataTransferJobSummaries (list) –

      The metadata transfer job summaries.

      • (dict) –

        The metadata transfer job summary.

        • metadataTransferJobId (string) –

          The metadata transfer job summary Id.

        • arn (string) –

          The metadata transfer job summary ARN.

        • creationDateTime (datetime) –

          The metadata transfer job summary creation DateTime object.

        • updateDateTime (datetime) –

          The metadata transfer job summary update DateTime object

        • status (dict) –

          The metadata transfer job summary 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 summary progess.

          • totalCount (integer) –

            The total count. [of what]

          • succeededCount (integer) –

            The succeeded count.

          • skippedCount (integer) –

            The skipped count.

          • failedCount (integer) –

            The failed count.

    • nextToken (string) –

      The string that specifies the next page of results.

Exceptions