IoTSiteWise / Paginator / ListAssociatedAssets

ListAssociatedAssets

class IoTSiteWise.Paginator.ListAssociatedAssets

paginator = client.get_paginator('list_associated_assets')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IoTSiteWise.Client.list_associated_assets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    assetId='string',
    hierarchyId='string',
    traversalDirection='PARENT'|'CHILD',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• assetId (string) –

  [REQUIRED]

  The ID of the asset to query. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

• hierarchyId (string) –

  The ID of the hierarchy by which child assets are associated to the asset. (This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.) To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection.

  For more information, see Asset hierarchies in the IoT SiteWise User Guide.

• traversalDirection (string) –

  The direction to list associated assets. Choose one of the following options:

  • CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD.

  • PARENT – The list includes the asset’s parent asset.

  Default: CHILD

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'assetSummaries': [
        {
            'id': 'string',
            'arn': 'string',
            'name': 'string',
            'assetModelId': 'string',
            'creationDate': datetime(2015, 1, 1),
            'lastUpdateDate': datetime(2015, 1, 1),
            'status': {
                'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
                'error': {
                    'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
                    'message': 'string',
                    'details': [
                        {
                            'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
                            'message': 'string'
                        },
                    ]
                }
            },
            'hierarchies': [
                {
                    'id': 'string',
                    'name': 'string',
                    'externalId': 'string'
                },
            ],
            'description': 'string',
            'externalId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • assetSummaries (list) –

    A list that summarizes the associated assets.

    • (dict) –

      Contains a summary of an associated asset.

      • id (string) –

        The ID of the asset, in UUID format.

      • arn (string) –

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

        arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

      • name (string) –

        The name of the asset.

      • assetModelId (string) –

        The ID of the asset model used to create the asset.

      • creationDate (datetime) –

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

      • lastUpdateDate (datetime) –

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

      • status (dict) –

        The current status of the asset.

        • state (string) –

          The current status of the asset.

        • 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.

      • hierarchies (list) –

        A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.

        • (dict) –

          Describes an asset hierarchy that contains a hierarchy’s name and ID.

          • id (string) –

            The ID of the hierarchy. This ID is a hierarchyId.

          • name (string) –

            The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API operation.

          • externalId (string) –

            The external ID of the hierarchy, if it has one. When you update an asset hierarchy, you may assign an external ID if it doesn’t already have one. You can’t change the external ID of an asset hierarchy that already has one. For more information, see Using external IDs in the IoT SiteWise User Guide.

      • description (string) –

        A description for the asset.

      • externalId (string) –

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

  • NextToken (string) –

    A token to resume pagination.