IoTSiteWise / Client / list_asset_models

list_asset_models

IoTSiteWise.Client.list_asset_models(**kwargs)

Retrieves a paginated list of summaries of all asset models.

See also: AWS API Documentation

Request Syntax

response = client.list_asset_models(
    nextToken='string',
    maxResults=123,
    assetModelTypes=[
        'ASSET_MODEL'|'COMPONENT_MODEL',
    ]
)

Parameters:

• nextToken (string) – The token to be used for the next set of paginated results.

• maxResults (integer) –

  The maximum number of results to return for each paginated request.

  Default: 50

• assetModelTypes (list) –

  The type of asset model.

  • ASSET_MODEL – (default) An asset model that you can use to create assets. Can’t be included as a component in another asset model.

  • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can’t create assets directly from this type of asset model.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'assetModelSummaries': [
        {
            'id': 'string',
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            'creationDate': datetime(2015, 1, 1),
            'lastUpdateDate': datetime(2015, 1, 1),
            'status': {
                'state': 'CREATING'|'ACTIVE'|'UPDATING'|'PROPAGATING'|'DELETING'|'FAILED',
                'error': {
                    'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
                    'message': 'string',
                    'details': [
                        {
                            'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
                            'message': 'string'
                        },
                    ]
                }
            },
            'assetModelType': 'ASSET_MODEL'|'COMPONENT_MODEL',
            'externalId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • assetModelSummaries (list) –

    A list that summarizes each asset model.

    • (dict) –

      Contains a summary of an asset model.

      • id (string) –

        The ID of the asset model (used with IoT SiteWise API operations).

      • arn (string) –

        The ARN of the asset model, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

      • name (string) –

        The name of the asset model.

      • description (string) –

        The asset model description.

      • creationDate (datetime) –

        The date the asset model was created, in Unix epoch time.

      • lastUpdateDate (datetime) –

        The date the asset model was last updated, in Unix epoch time.

      • status (dict) –

        The current status of the asset model.

        • state (string) –

          The current state of the asset model.

        • error (dict) –

          Contains associated error information, if any.

          • code (string) –

            The error code.

          • message (string) –

            The error message.

          • details (list) –

            A list of detailed errors.

            • (dict) –

              Contains detailed error information.

              • code (string) –

                The error code.

              • message (string) –

                The error message.

      • assetModelType (string) –

        The type of asset model.

        • ASSET_MODEL – (default) An asset model that you can use to create assets. Can’t be included as a component in another asset model.

        • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can’t create assets directly from this type of asset model.

      • externalId (string) –

        The external ID of the asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.

  • nextToken (string) –

    The token for the next set of results, or null if there are no additional results.

Exceptions

• IoTSiteWise.Client.exceptions.InvalidRequestException

• IoTSiteWise.Client.exceptions.InternalFailureException

• IoTSiteWise.Client.exceptions.ThrottlingException