IoTSiteWise

Client

class IoTSiteWise.Client

A low-level client representing AWS IoT SiteWise

Welcome to the AWS IoT SiteWise API Reference. AWS IoT SiteWise is an AWS service that connects Industrial Internet of Things (IIoT) devices to the power of the AWS Cloud. For more information, see the AWS IoT SiteWise User Guide . For information about AWS IoT SiteWise quotas, see Quotas in the AWS IoT SiteWise User Guide .

client = session.create_client('iotsitewise')

These are the available methods:

associate_assets(**kwargs)

Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the AWS IoT SiteWise User Guide .

See also: AWS API Documentation

Request Syntax

response = client.associate_assets(
    assetId='string',
    hierarchyId='string',
    childAssetId='string',
    clientToken='string'
)
Parameters
  • assetId (string) --

    [REQUIRED]

    The ID of the parent asset.

  • hierarchyId (string) --

    [REQUIRED]

    The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide .

  • childAssetId (string) --

    [REQUIRED]

    The ID of the child asset to be associated.

  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

Returns

None

Exceptions

batch_associate_project_assets(**kwargs)

Associates a group (batch) of assets with an AWS IoT SiteWise Monitor project.

See also: AWS API Documentation

Request Syntax

response = client.batch_associate_project_assets(
    projectId='string',
    assetIds=[
        'string',
    ],
    clientToken='string'
)
Parameters
  • projectId (string) --

    [REQUIRED]

    The ID of the project to which to associate the assets.

  • assetIds (list) --

    [REQUIRED]

    The IDs of the assets to be associated to the project.

    • (string) --
  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'errors': [
        {
            'assetId': 'string',
            'code': 'INTERNAL_FAILURE',
            'message': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • errors (list) --

      A list of associated error information, if any.

      • (dict) --

        Contains error details for the requested associate project asset action.

        • assetId (string) --

          The ID of the asset.

        • code (string) --

          The error code.

        • message (string) --

          The error message.

Exceptions

batch_disassociate_project_assets(**kwargs)

Disassociates a group (batch) of assets from an AWS IoT SiteWise Monitor project.

See also: AWS API Documentation

Request Syntax

response = client.batch_disassociate_project_assets(
    projectId='string',
    assetIds=[
        'string',
    ],
    clientToken='string'
)
Parameters
  • projectId (string) --

    [REQUIRED]

    The ID of the project from which to disassociate the assets.

  • assetIds (list) --

    [REQUIRED]

    The IDs of the assets to be disassociated from the project.

    • (string) --
  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'errors': [
        {
            'assetId': 'string',
            'code': 'INTERNAL_FAILURE',
            'message': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • errors (list) --

      A list of associated error information, if any.

      • (dict) --

        Contains error details for the requested associate project asset action.

        • assetId (string) --

          The ID of the asset.

        • code (string) --

          The error code.

        • message (string) --

          The error message.

Exceptions

batch_put_asset_property_value(**kwargs)

Sends a list of asset property values to AWS IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the AWS IoT SiteWise User Guide .

To identify an asset property, you must specify one of the following:

  • The assetId and propertyId of an asset property.
  • A propertyAlias , which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature ). To define an asset property's alias, see UpdateAssetProperty .

Warning

With respect to Unix epoch time, AWS IoT SiteWise accepts only TQVs that have a timestamp of no more than 15 minutes in the past and no more than 5 minutes in the future. AWS IoT SiteWise rejects timestamps outside of the inclusive range of [-15, +5] minutes and returns a TimestampOutOfRangeException error.

For each asset property, AWS IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1} , then storing {T1, GOOD, V2} replaces the existing TQV.

AWS IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorization in the AWS IoT SiteWise User Guide .

See also: AWS API Documentation

Request Syntax

response = client.batch_put_asset_property_value(
    entries=[
        {
            'entryId': 'string',
            'assetId': 'string',
            'propertyId': 'string',
            'propertyAlias': 'string',
            'propertyValues': [
                {
                    'value': {
                        'stringValue': 'string',
                        'integerValue': 123,
                        'doubleValue': 123.0,
                        'booleanValue': True|False
                    },
                    'timestamp': {
                        'timeInSeconds': 123,
                        'offsetInNanos': 123
                    },
                    'quality': 'GOOD'|'BAD'|'UNCERTAIN'
                },
            ]
        },
    ]
)
Parameters
entries (list) --

[REQUIRED]

The list of asset property value entries for the batch put request. You can specify up to 10 entries per request.

  • (dict) --

    Contains a list of value updates for an asset property in the list of asset entries consumed by the BatchPutAssetPropertyValue API operation.

    • entryId (string) -- [REQUIRED]

      The user specified ID for the entry. You can use this ID to identify which entries failed.

    • assetId (string) --

      The ID of the asset to update.

    • propertyId (string) --

      The ID of the asset property for this entry.

    • propertyAlias (string) --

      The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide .

    • propertyValues (list) -- [REQUIRED]

      The list of property values to upload. You can specify up to 10 propertyValues array elements.

      • (dict) --

        Contains asset property value information.

        • value (dict) -- [REQUIRED]

          The value of the asset property (see Variant ).

          • stringValue (string) --

            Asset property data of type string (sequence of characters).

          • integerValue (integer) --

            Asset property data of type integer (whole number).

          • doubleValue (float) --

            Asset property data of type double (floating point number).

          • booleanValue (boolean) --

            Asset property data of type Boolean (true or false).

        • timestamp (dict) -- [REQUIRED]

          The timestamp of the asset property value.

          • timeInSeconds (integer) -- [REQUIRED]

            The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos .

          • offsetInNanos (integer) --

            The nanosecond offset from timeInSeconds .

        • quality (string) --

          The quality of the asset property value.

Return type
dict
Returns
Response Syntax
{
    'errorEntries': [
        {
            'entryId': 'string',
            'errors': [
                {
                    'errorCode': 'ResourceNotFoundException'|'InvalidRequestException'|'InternalFailureException'|'ServiceUnavailableException'|'ThrottlingException'|'LimitExceededException'|'ConflictingOperationException'|'TimestampOutOfRangeException'|'AccessDeniedException',
                    'errorMessage': 'string',
                    'timestamps': [
                        {
                            'timeInSeconds': 123,
                            'offsetInNanos': 123
                        },
                    ]
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --
    • errorEntries (list) --

      A list of the errors (if any) associated with the batch put request. Each error entry contains the entryId of the entry that failed.

      • (dict) --

        Contains error information for asset property value entries that are associated with the BatchPutAssetPropertyValue API.

        • entryId (string) --

          The ID of the failed entry.

        • errors (list) --

          The list of update property value errors.

          • (dict) --

            Contains error information from updating a batch of asset property values.

            • errorCode (string) --

              The error code.

            • errorMessage (string) --

              The associated error message.

            • timestamps (list) --

              A list of timestamps for each error, if any.

              • (dict) --

                Contains a timestamp with optional nanosecond granularity.

                • timeInSeconds (integer) --

                  The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos .

                • offsetInNanos (integer) --

                  The nanosecond offset from timeInSeconds .

Exceptions

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_access_policy(**kwargs)

Creates an access policy that grants the specified identity (AWS SSO user, AWS SSO group, or IAM user) access to the specified AWS IoT SiteWise Monitor portal or project resource.

See also: AWS API Documentation

Request Syntax

response = client.create_access_policy(
    accessPolicyIdentity={
        'user': {
            'id': 'string'
        },
        'group': {
            'id': 'string'
        },
        'iamUser': {
            'arn': 'string'
        }
    },
    accessPolicyResource={
        'portal': {
            'id': 'string'
        },
        'project': {
            'id': 'string'
        }
    },
    accessPolicyPermission='ADMINISTRATOR'|'VIEWER',
    clientToken='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • accessPolicyIdentity (dict) --

    [REQUIRED]

    The identity for this access policy. Choose an AWS SSO user, an AWS SSO group, or an IAM user.

    • user (dict) --

      An AWS SSO user identity.

      • id (string) -- [REQUIRED]

        The AWS SSO ID of the user.

    • group (dict) --

      An AWS SSO group identity.

      • id (string) -- [REQUIRED]

        The AWS SSO ID of the group.

    • iamUser (dict) --

      An IAM user identity.

      • arn (string) -- [REQUIRED]

        The ARN of the IAM user. IAM users must have the iotsitewise:CreatePresignedPortalUrl permission to sign in to the portal. For more information, see IAM ARNs in the IAM User Guide .

        Note

        If you delete the IAM user, access policies that contain this identity include an empty arn . You can delete the access policy for the IAM user that no longer exists.

  • accessPolicyResource (dict) --

    [REQUIRED]

    The AWS IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.

    • portal (dict) --

      A portal resource.

      • id (string) -- [REQUIRED]

        The ID of the portal.

    • project (dict) --

      A project resource.

      • id (string) -- [REQUIRED]

        The ID of the project.

  • accessPolicyPermission (string) --

    [REQUIRED]

    The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.

  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

  • tags (dict) --

    A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'accessPolicyId': 'string',
    'accessPolicyArn': 'string'
}

Response Structure

  • (dict) --

    • accessPolicyId (string) --

      The ID of the access policy.

    • accessPolicyArn (string) --

      The ARN of the access policy, which has the following format.

      arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}

Exceptions

create_asset(**kwargs)

Creates an asset from an existing asset model. For more information, see Creating assets in the AWS IoT SiteWise User Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_asset(
    assetName='string',
    assetModelId='string',
    clientToken='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • assetName (string) --

    [REQUIRED]

    A unique, friendly name for the asset.

  • assetModelId (string) --

    [REQUIRED]

    The ID of the asset model from which to create the asset.

  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

  • tags (dict) --

    A list of key-value pairs that contain metadata for the asset. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'assetId': 'string',
    'assetArn': 'string',
    'assetStatus': {
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • assetId (string) --

      The ID of the asset. This ID uniquely identifies the asset within AWS IoT SiteWise and can be used with other AWS IoT SiteWise APIs.

    • assetArn (string) --

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

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

    • assetStatus (dict) --

      The status of the asset, which contains a state (CREATING after successfully calling this operation) and any error message.

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

Exceptions

create_asset_model(**kwargs)

Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the AWS IoT SiteWise User Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_asset_model(
    assetModelName='string',
    assetModelDescription='string',
    assetModelProperties=[
        {
            'name': 'string',
            'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN',
            'unit': 'string',
            'type': {
                'attribute': {
                    'defaultValue': 'string'
                },
                'measurement': {}
                ,
                'transform': {
                    'expression': 'string',
                    'variables': [
                        {
                            'name': 'string',
                            'value': {
                                'propertyId': 'string',
                                'hierarchyId': 'string'
                            }
                        },
                    ]
                },
                'metric': {
                    'expression': 'string',
                    'variables': [
                        {
                            'name': 'string',
                            'value': {
                                'propertyId': 'string',
                                'hierarchyId': 'string'
                            }
                        },
                    ],
                    'window': {
                        'tumbling': {
                            'interval': 'string'
                        }
                    }
                }
            }
        },
    ],
    assetModelHierarchies=[
        {
            'name': 'string',
            'childAssetModelId': 'string'
        },
    ],
    clientToken='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • assetModelName (string) --

    [REQUIRED]

    A unique, friendly name for the asset model.

  • assetModelDescription (string) -- A description for the asset model.
  • assetModelProperties (list) --

    The property definitions of the asset model. For more information, see Asset properties in the AWS IoT SiteWise User Guide .

    You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide .

    • (dict) --

      Contains an asset model property definition. This property definition is applied to all assets created from the asset model.

      • name (string) -- [REQUIRED]

        The name of the property definition.

      • dataType (string) -- [REQUIRED]

        The data type of the property definition.

      • unit (string) --

        The unit of the property definition, such as Newtons or RPM .

      • type (dict) -- [REQUIRED]

        The property definition type (see PropertyType ). You can only specify one type in a property definition.

        • attribute (dict) --

          Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.

          • defaultValue (string) --

            The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide .

        • measurement (dict) --

          Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.

        • transform (dict) --

          Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.

          • expression (string) -- [REQUIRED]

            The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

            For more information, see Quotas in the AWS IoT SiteWise User Guide .

          • variables (list) -- [REQUIRED]

            The list of variables used in the expression.

            • (dict) --

              Contains expression variable information.

              • name (string) -- [REQUIRED]

                The friendly name of the variable to be used in the expression.

              • value (dict) -- [REQUIRED]

                The variable that identifies an asset property from which to use values.

                • propertyId (string) -- [REQUIRED]

                  The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

                • hierarchyId (string) --

                  The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

                  You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide .

        • metric (dict) --

          Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.

          • expression (string) -- [REQUIRED]

            The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

            For more information, see Quotas in the AWS IoT SiteWise User Guide .

          • variables (list) -- [REQUIRED]

            The list of variables used in the expression.

            • (dict) --

              Contains expression variable information.

              • name (string) -- [REQUIRED]

                The friendly name of the variable to be used in the expression.

              • value (dict) -- [REQUIRED]

                The variable that identifies an asset property from which to use values.

                • propertyId (string) -- [REQUIRED]

                  The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

                • hierarchyId (string) --

                  The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

                  You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide .

          • window (dict) -- [REQUIRED]

            The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression. AWS IoT SiteWise computes one data point per window .

            • tumbling (dict) --

              The tumbling time interval window.

              • interval (string) -- [REQUIRED]

                The time interval for the tumbling window. Note that w represents weeks, d represents days, h represents hours, and m represents minutes. AWS IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

                When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.

  • assetModelHierarchies (list) --

    The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide .

    You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide .

    • (dict) --

      Contains an asset model hierarchy used in asset model creation. An asset model hierarchy determines the kind (or type) of asset that can belong to a hierarchy.

      • name (string) -- [REQUIRED]

        The name of the asset model hierarchy definition (as specified in the CreateAssetModel or UpdateAssetModel API operation).

      • childAssetModelId (string) -- [REQUIRED]

        The ID of an asset model for this hierarchy.

  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

  • tags (dict) --

    A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'assetModelId': 'string',
    'assetModelArn': 'string',
    'assetModelStatus': {
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'PROPAGATING'|'DELETING'|'FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • assetModelId (string) --

      The ID of the asset model. You can use this ID when you call other AWS IoT SiteWise APIs.

    • assetModelArn (string) --

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

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

    • assetModelStatus (dict) --

      The status of the asset model, which contains a state (CREATING after successfully calling this operation) and any error message.

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

Exceptions

create_dashboard(**kwargs)

Creates a dashboard in an AWS IoT SiteWise Monitor project.

See also: AWS API Documentation

Request Syntax

response = client.create_dashboard(
    projectId='string',
    dashboardName='string',
    dashboardDescription='string',
    dashboardDefinition='string',
    clientToken='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • projectId (string) --

    [REQUIRED]

    The ID of the project in which to create the dashboard.

  • dashboardName (string) --

    [REQUIRED]

    A friendly name for the dashboard.

  • dashboardDescription (string) -- A description for the dashboard.
  • dashboardDefinition (string) --

    [REQUIRED]

    The dashboard definition specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide .

  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

  • tags (dict) --

    A list of key-value pairs that contain metadata for the dashboard. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'dashboardId': 'string',
    'dashboardArn': 'string'
}

Response Structure

  • (dict) --

    • dashboardId (string) --

      The ID of the dashboard.

    • dashboardArn (string) --

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

      arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}

Exceptions

create_gateway(**kwargs)

Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS IoT SiteWise. For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_gateway(
    gatewayName='string',
    gatewayPlatform={
        'greengrass': {
            'groupArn': 'string'
        }
    },
    tags={
        'string': 'string'
    }
)
Parameters
  • gatewayName (string) --

    [REQUIRED]

    A unique, friendly name for the gateway.

  • gatewayPlatform (dict) --

    [REQUIRED]

    The gateway's platform. You can only specify one platform in a gateway.

    • greengrass (dict) -- [REQUIRED]

      A gateway that runs on AWS IoT Greengrass.

      • groupArn (string) -- [REQUIRED]

        The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the AWS IoT Greengrass API Reference .

  • tags (dict) --

    A list of key-value pairs that contain metadata for the gateway. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'gatewayId': 'string',
    'gatewayArn': 'string'
}

Response Structure

  • (dict) --

    • gatewayId (string) --

      The ID of the gateway device. You can use this ID when you call other AWS IoT SiteWise APIs.

    • gatewayArn (string) --

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

      arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}

Exceptions

create_portal(**kwargs)

Creates a portal, which can contain projects and dashboards. AWS IoT SiteWise Monitor uses AWS SSO or IAM to authenticate portal users and manage user permissions.

Note

Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the AWS IoT SiteWise User Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_portal(
    portalName='string',
    portalDescription='string',
    portalContactEmail='string',
    clientToken='string',
    portalLogoImageFile={
        'data': b'bytes',
        'type': 'PNG'
    },
    roleArn='string',
    tags={
        'string': 'string'
    },
    portalAuthMode='IAM'|'SSO'
)
Parameters
  • portalName (string) --

    [REQUIRED]

    A friendly name for the portal.

  • portalDescription (string) -- A description for the portal.
  • portalContactEmail (string) --

    [REQUIRED]

    The AWS administrator's contact email address.

  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

  • portalLogoImageFile (dict) --

    A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.

    • data (bytes) -- [REQUIRED]

      The image file contents, represented as a base64-encoded string. The file size must be less than 1 MB.

    • type (string) -- [REQUIRED]

      The file type of the image.

  • roleArn (string) --

    [REQUIRED]

    The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide .

  • tags (dict) --

    A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .

    • (string) --
      • (string) --
  • portalAuthMode (string) --

    The service to use to authenticate users to the portal. Choose from the following options:

    • SSO – The portal uses AWS Single Sign-On to authenticate users and manage user permissions. Before you can create a portal that uses AWS SSO, you must enable AWS SSO. For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide . This option is only available in AWS Regions other than the China Regions.
    • IAM – The portal uses AWS Identity and Access Management (IAM) to authenticate users and manage user permissions. IAM users must have the iotsitewise:CreatePresignedPortalUrl permission to sign in to the portal. This option is only available in the China Regions.

    You can't change this value after you create a portal.

    Default: SSO

Return type

dict

Returns

Response Syntax

{
    'portalId': 'string',
    'portalArn': 'string',
    'portalStartUrl': 'string',
    'portalStatus': {
        'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
        'error': {
            'code': 'INTERNAL_FAILURE'|'VALIDATION_ERROR'|'LIMIT_EXCEEDED',
            'message': 'string'
        }
    },
    'ssoApplicationId': 'string'
}

Response Structure

  • (dict) --

    • portalId (string) --

      The ID of the created portal.

    • portalArn (string) --

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

      arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

    • portalStartUrl (string) --

      The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

    • portalStatus (dict) --

      The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.

      • state (string) --

        The current state of the portal.

      • error (dict) --

        Contains associated error information, if any.

        • code (string) --

          The error code.

        • message (string) --

          The error message.

    • ssoApplicationId (string) --

      The associated AWS SSO application ID, if the portal uses AWS SSO.

Exceptions

create_presigned_portal_url(**kwargs)

Creates a pre-signed URL to a portal. Use this operation to create URLs to portals that use AWS Identity and Access Management (IAM) to authenticate users. An IAM user with access to a portal can call this API to get a URL to that portal. The URL contains an authentication token that lets the IAM user access the portal.

See also: AWS API Documentation

Request Syntax

response = client.create_presigned_portal_url(
    portalId='string',
    sessionDurationSeconds=123
)
Parameters
  • portalId (string) --

    [REQUIRED]

    The ID of the portal to access.

  • sessionDurationSeconds (integer) --

    The duration (in seconds) for which the session at the URL is valid.

    Default: 43,200 seconds (12 hours)

Return type

dict

Returns

Response Syntax

{
    'presignedPortalUrl': 'string'
}

Response Structure

  • (dict) --

    • presignedPortalUrl (string) --

      The pre-signed URL to the portal. The URL contains the portal ID and an authentication token that lets you access the portal. The URL has the following format.

      https://<portal-id>.app.iotsitewise.aws/iam?token=<encrypted-token>

Exceptions

create_project(**kwargs)

Creates a project in the specified portal.

See also: AWS API Documentation

Request Syntax

response = client.create_project(
    portalId='string',
    projectName='string',
    projectDescription='string',
    clientToken='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • portalId (string) --

    [REQUIRED]

    The ID of the portal in which to create the project.

  • projectName (string) --

    [REQUIRED]

    A friendly name for the project.

  • projectDescription (string) -- A description for the project.
  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

  • tags (dict) --

    A list of key-value pairs that contain metadata for the project. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'projectId': 'string',
    'projectArn': 'string'
}

Response Structure

  • (dict) --

    • projectId (string) --

      The ID of the project.

    • projectArn (string) --

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

      arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}

Exceptions

delete_access_policy(**kwargs)

Deletes an access policy that grants the specified identity access to the specified AWS IoT SiteWise Monitor resource. You can use this operation to revoke access to an AWS IoT SiteWise Monitor resource.

See also: AWS API Documentation

Request Syntax

response = client.delete_access_policy(
    accessPolicyId='string',
    clientToken='string'
)
Parameters
  • accessPolicyId (string) --

    [REQUIRED]

    The ID of the access policy to be deleted.

  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_asset(**kwargs)

Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the AWS IoT SiteWise User Guide .

Note

You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets .

See also: AWS API Documentation

Request Syntax

response = client.delete_asset(
    assetId='string',
    clientToken='string'
)
Parameters
  • assetId (string) --

    [REQUIRED]

    The ID of the asset to delete.

  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'assetStatus': {
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • assetStatus (dict) --

      The status of the asset, which contains a state (DELETING after successfully calling this operation) and any error message.

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

Exceptions

delete_asset_model(**kwargs)

Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the AWS IoT SiteWise User Guide .

See also: AWS API Documentation

Request Syntax

response = client.delete_asset_model(
    assetModelId='string',
    clientToken='string'
)
Parameters
  • assetModelId (string) --

    [REQUIRED]

    The ID of the asset model to delete.

  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'assetModelStatus': {
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'PROPAGATING'|'DELETING'|'FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • assetModelStatus (dict) --

      The status of the asset model, which contains a state (DELETING after successfully calling this operation) and any error message.

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

Exceptions

delete_dashboard(**kwargs)

Deletes a dashboard from AWS IoT SiteWise Monitor.

See also: AWS API Documentation

Request Syntax

response = client.delete_dashboard(
    dashboardId='string',
    clientToken='string'
)
Parameters
  • dashboardId (string) --

    [REQUIRED]

    The ID of the dashboard to delete.

  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_gateway(**kwargs)

Deletes a gateway from AWS IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.

See also: AWS API Documentation

Request Syntax

response = client.delete_gateway(
    gatewayId='string'
)
Parameters
gatewayId (string) --

[REQUIRED]

The ID of the gateway to delete.

Returns
None

Exceptions

delete_portal(**kwargs)

Deletes a portal from AWS IoT SiteWise Monitor.

See also: AWS API Documentation

Request Syntax

response = client.delete_portal(
    portalId='string',
    clientToken='string'
)
Parameters
  • portalId (string) --

    [REQUIRED]

    The ID of the portal to delete.

  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'portalStatus': {
        'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
        'error': {
            'code': 'INTERNAL_FAILURE'|'VALIDATION_ERROR'|'LIMIT_EXCEEDED',
            'message': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • portalStatus (dict) --

      The status of the portal, which contains a state (DELETING after successfully calling this operation) and any error message.

      • state (string) --

        The current state of the portal.

      • error (dict) --

        Contains associated error information, if any.

        • code (string) --

          The error code.

        • message (string) --

          The error message.

Exceptions

delete_project(**kwargs)

Deletes a project from AWS IoT SiteWise Monitor.

See also: AWS API Documentation

Request Syntax

response = client.delete_project(
    projectId='string',
    clientToken='string'
)
Parameters
  • projectId (string) --

    [REQUIRED]

    The ID of the project.

  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

describe_access_policy(**kwargs)

Describes an access policy, which specifies an identity's access to an AWS IoT SiteWise Monitor portal or project.

See also: AWS API Documentation

Request Syntax

response = client.describe_access_policy(
    accessPolicyId='string'
)
Parameters
accessPolicyId (string) --

[REQUIRED]

The ID of the access policy.

Return type
dict
Returns
Response Syntax
{
    'accessPolicyId': 'string',
    'accessPolicyArn': 'string',
    'accessPolicyIdentity': {
        'user': {
            'id': 'string'
        },
        'group': {
            'id': 'string'
        },
        'iamUser': {
            'arn': 'string'
        }
    },
    'accessPolicyResource': {
        'portal': {
            'id': 'string'
        },
        'project': {
            'id': 'string'
        }
    },
    'accessPolicyPermission': 'ADMINISTRATOR'|'VIEWER',
    'accessPolicyCreationDate': datetime(2015, 1, 1),
    'accessPolicyLastUpdateDate': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • accessPolicyId (string) --

      The ID of the access policy.

    • accessPolicyArn (string) --

      The ARN of the access policy, which has the following format.

      arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}
    • accessPolicyIdentity (dict) --

      The identity (AWS SSO user, AWS SSO group, or IAM user) to which this access policy applies.

      • user (dict) --

        An AWS SSO user identity.

        • id (string) --

          The AWS SSO ID of the user.

      • group (dict) --

        An AWS SSO group identity.

        • id (string) --

          The AWS SSO ID of the group.

      • iamUser (dict) --

        An IAM user identity.

        • arn (string) --

          The ARN of the IAM user. IAM users must have the iotsitewise:CreatePresignedPortalUrl permission to sign in to the portal. For more information, see IAM ARNs in the IAM User Guide .

          Note

          If you delete the IAM user, access policies that contain this identity include an empty arn . You can delete the access policy for the IAM user that no longer exists.

    • accessPolicyResource (dict) --

      The AWS IoT SiteWise Monitor resource (portal or project) to which this access policy provides access.

      • portal (dict) --

        A portal resource.

        • id (string) --

          The ID of the portal.

      • project (dict) --

        A project resource.

        • id (string) --

          The ID of the project.

    • accessPolicyPermission (string) --

      The access policy permission. Note that a project ADMINISTRATOR is also known as a project owner.

    • accessPolicyCreationDate (datetime) --

      The date the access policy was created, in Unix epoch time.

    • accessPolicyLastUpdateDate (datetime) --

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

Exceptions

describe_asset(**kwargs)

Retrieves information about an asset.

See also: AWS API Documentation

Request Syntax

response = client.describe_asset(
    assetId='string'
)
Parameters
assetId (string) --

[REQUIRED]

The ID of the asset.

Return type
dict
Returns
Response Syntax
{
    'assetId': 'string',
    'assetArn': 'string',
    'assetName': 'string',
    'assetModelId': 'string',
    'assetProperties': [
        {
            'id': 'string',
            'name': 'string',
            'alias': 'string',
            'notification': {
                'topic': 'string',
                'state': 'ENABLED'|'DISABLED'
            },
            'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN',
            'unit': 'string'
        },
    ],
    'assetHierarchies': [
        {
            'id': 'string',
            'name': 'string'
        },
    ],
    'assetCreationDate': datetime(2015, 1, 1),
    'assetLastUpdateDate': datetime(2015, 1, 1),
    'assetStatus': {
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string'
        }
    }
}

Response Structure

  • (dict) --
    • assetId (string) --

      The ID of the asset.

    • assetArn (string) --

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

      arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
    • assetName (string) --

      The name of the asset.

    • assetModelId (string) --

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

    • assetProperties (list) --

      The list of asset properties for the asset.

      • (dict) --

        Contains asset property information.

        • id (string) --

          The ID of the asset property.

        • name (string) --

          The name of the property.

        • alias (string) --

          The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide .

        • notification (dict) --

          The asset property's notification topic and state. For more information, see UpdateAssetProperty .

          • topic (string) --

            The MQTT topic to which AWS IoT SiteWise publishes property value update notifications.

          • state (string) --

            The current notification state.

        • dataType (string) --

          The data type of the asset property.

        • unit (string) --

          The unit (such as Newtons or RPM ) of the asset property.

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

    • assetCreationDate (datetime) --

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

    • assetLastUpdateDate (datetime) --

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

    • assetStatus (dict) --

      The current status of the asset, which contains a state and any error message.

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

Exceptions

describe_asset_model(**kwargs)

Retrieves information about an asset model.

See also: AWS API Documentation

Request Syntax

response = client.describe_asset_model(
    assetModelId='string'
)
Parameters
assetModelId (string) --

[REQUIRED]

The ID of the asset model.

Return type
dict
Returns
Response Syntax
{
    'assetModelId': 'string',
    'assetModelArn': 'string',
    'assetModelName': 'string',
    'assetModelDescription': 'string',
    'assetModelProperties': [
        {
            'id': 'string',
            'name': 'string',
            'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN',
            'unit': 'string',
            'type': {
                'attribute': {
                    'defaultValue': 'string'
                },
                'measurement': {},
                'transform': {
                    'expression': 'string',
                    'variables': [
                        {
                            'name': 'string',
                            'value': {
                                'propertyId': 'string',
                                'hierarchyId': 'string'
                            }
                        },
                    ]
                },
                'metric': {
                    'expression': 'string',
                    'variables': [
                        {
                            'name': 'string',
                            'value': {
                                'propertyId': 'string',
                                'hierarchyId': 'string'
                            }
                        },
                    ],
                    'window': {
                        'tumbling': {
                            'interval': 'string'
                        }
                    }
                }
            }
        },
    ],
    'assetModelHierarchies': [
        {
            'id': 'string',
            'name': 'string',
            'childAssetModelId': 'string'
        },
    ],
    'assetModelCreationDate': datetime(2015, 1, 1),
    'assetModelLastUpdateDate': datetime(2015, 1, 1),
    'assetModelStatus': {
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'PROPAGATING'|'DELETING'|'FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string'
        }
    }
}

Response Structure

  • (dict) --
    • assetModelId (string) --

      The ID of the asset model.

    • assetModelArn (string) --

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

      arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
    • assetModelName (string) --

      The name of the asset model.

    • assetModelDescription (string) --

      The asset model's description.

    • assetModelProperties (list) --

      The list of asset properties for the asset model.

      • (dict) --

        Contains information about an asset model property.

        • id (string) --

          The ID of the asset model property.

        • name (string) --

          The name of the asset model property.

        • dataType (string) --

          The data type of the asset model property.

        • unit (string) --

          The unit of the asset model property, such as Newtons or RPM .

        • type (dict) --

          The property type (see PropertyType ).

          • attribute (dict) --

            Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.

            • defaultValue (string) --

              The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide .

          • measurement (dict) --

            Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.

          • transform (dict) --

            Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.

            • expression (string) --

              The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

              For more information, see Quotas in the AWS IoT SiteWise User Guide .

            • variables (list) --

              The list of variables used in the expression.

              • (dict) --

                Contains expression variable information.

                • name (string) --

                  The friendly name of the variable to be used in the expression.

                • value (dict) --

                  The variable that identifies an asset property from which to use values.

                  • propertyId (string) --

                    The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

                  • hierarchyId (string) --

                    The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

                    You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide .

          • metric (dict) --

            Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.

            • expression (string) --

              The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

              For more information, see Quotas in the AWS IoT SiteWise User Guide .

            • variables (list) --

              The list of variables used in the expression.

              • (dict) --

                Contains expression variable information.

                • name (string) --

                  The friendly name of the variable to be used in the expression.

                • value (dict) --

                  The variable that identifies an asset property from which to use values.

                  • propertyId (string) --

                    The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

                  • hierarchyId (string) --

                    The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

                    You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide .

            • window (dict) --

              The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression. AWS IoT SiteWise computes one data point per window .

              • tumbling (dict) --

                The tumbling time interval window.

                • interval (string) --

                  The time interval for the tumbling window. Note that w represents weeks, d represents days, h represents hours, and m represents minutes. AWS IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

                  When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.

    • assetModelHierarchies (list) --

      A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id ). A hierarchy specifies allowed parent/child asset relationships for an asset model.

      • (dict) --

        Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.

        • id (string) --

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

        • name (string) --

          The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.

        • childAssetModelId (string) --

          The ID of the asset model. All assets in this hierarchy must be instances of the childAssetModelId asset model.

    • assetModelCreationDate (datetime) --

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

    • assetModelLastUpdateDate (datetime) --

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

    • assetModelStatus (dict) --

      The current status of the asset model, which contains a state and any error message.

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

Exceptions

describe_asset_property(**kwargs)

Retrieves information about an asset property.

Note

When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.

This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue .

See also: AWS API Documentation

Request Syntax

response = client.describe_asset_property(
    assetId='string',
    propertyId='string'
)
Parameters
  • assetId (string) --

    [REQUIRED]

    The ID of the asset.

  • propertyId (string) --

    [REQUIRED]

    The ID of the asset property.

Return type

dict

Returns

Response Syntax

{
    'assetId': 'string',
    'assetName': 'string',
    'assetModelId': 'string',
    'assetProperty': {
        'id': 'string',
        'name': 'string',
        'alias': 'string',
        'notification': {
            'topic': 'string',
            'state': 'ENABLED'|'DISABLED'
        },
        'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN',
        'unit': 'string',
        'type': {
            'attribute': {
                'defaultValue': 'string'
            },
            'measurement': {},
            'transform': {
                'expression': 'string',
                'variables': [
                    {
                        'name': 'string',
                        'value': {
                            'propertyId': 'string',
                            'hierarchyId': 'string'
                        }
                    },
                ]
            },
            'metric': {
                'expression': 'string',
                'variables': [
                    {
                        'name': 'string',
                        'value': {
                            'propertyId': 'string',
                            'hierarchyId': 'string'
                        }
                    },
                ],
                'window': {
                    'tumbling': {
                        'interval': 'string'
                    }
                }
            }
        }
    }
}

Response Structure

  • (dict) --

    • assetId (string) --

      The ID of the asset.

    • assetName (string) --

      The name of the asset.

    • assetModelId (string) --

      The ID of the asset model.

    • assetProperty (dict) --

      The asset property's definition, alias, and notification state.

      • id (string) --

        The ID of the asset property.

      • name (string) --

        The name of the property.

      • alias (string) --

        The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide .

      • notification (dict) --

        The asset property's notification topic and state. For more information, see UpdateAssetProperty .

        • topic (string) --

          The MQTT topic to which AWS IoT SiteWise publishes property value update notifications.

        • state (string) --

          The current notification state.

      • dataType (string) --

        The property data type.

      • unit (string) --

        The unit (such as Newtons or RPM ) of the asset property.

      • type (dict) --

        The property type (see PropertyType ). A property contains one type.

        • attribute (dict) --

          Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.

          • defaultValue (string) --

            The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide .

        • measurement (dict) --

          Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.

        • transform (dict) --

          Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.

          • expression (string) --

            The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

            For more information, see Quotas in the AWS IoT SiteWise User Guide .

          • variables (list) --

            The list of variables used in the expression.

            • (dict) --

              Contains expression variable information.

              • name (string) --

                The friendly name of the variable to be used in the expression.

              • value (dict) --

                The variable that identifies an asset property from which to use values.

                • propertyId (string) --

                  The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

                • hierarchyId (string) --

                  The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

                  You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide .

        • metric (dict) --

          Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.

          • expression (string) --

            The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

            For more information, see Quotas in the AWS IoT SiteWise User Guide .

          • variables (list) --

            The list of variables used in the expression.

            • (dict) --

              Contains expression variable information.

              • name (string) --

                The friendly name of the variable to be used in the expression.

              • value (dict) --

                The variable that identifies an asset property from which to use values.

                • propertyId (string) --

                  The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

                • hierarchyId (string) --

                  The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

                  You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide .

          • window (dict) --

            The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression. AWS IoT SiteWise computes one data point per window .

            • tumbling (dict) --

              The tumbling time interval window.

              • interval (string) --

                The time interval for the tumbling window. Note that w represents weeks, d represents days, h represents hours, and m represents minutes. AWS IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

                When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.

Exceptions

describe_dashboard(**kwargs)

Retrieves information about a dashboard.

See also: AWS API Documentation

Request Syntax

response = client.describe_dashboard(
    dashboardId='string'
)
Parameters
dashboardId (string) --

[REQUIRED]

The ID of the dashboard.

Return type
dict
Returns
Response Syntax
{
    'dashboardId': 'string',
    'dashboardArn': 'string',
    'dashboardName': 'string',
    'projectId': 'string',
    'dashboardDescription': 'string',
    'dashboardDefinition': 'string',
    'dashboardCreationDate': datetime(2015, 1, 1),
    'dashboardLastUpdateDate': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • dashboardId (string) --

      The ID of the dashboard.

    • dashboardArn (string) --

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

      arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}
    • dashboardName (string) --

      The name of the dashboard.

    • projectId (string) --

      The ID of the project that the dashboard is in.

    • dashboardDescription (string) --

      The dashboard's description.

    • dashboardDefinition (string) --

      The dashboard's definition JSON literal. For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide .

    • dashboardCreationDate (datetime) --

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

    • dashboardLastUpdateDate (datetime) --

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

Exceptions

describe_default_encryption_configuration()

Retrieves information about the default encryption configuration for the AWS account in the default or specified region. For more information, see Key management in the AWS IoT SiteWise User Guide .

See also: AWS API Documentation

Request Syntax

response = client.describe_default_encryption_configuration()
Return type
dict
Returns
Response Syntax
{
    'encryptionType': 'SITEWISE_DEFAULT_ENCRYPTION'|'KMS_BASED_ENCRYPTION',
    'kmsKeyArn': 'string',
    'configurationStatus': {
        'state': 'ACTIVE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string'
        }
    }
}

Response Structure

  • (dict) --
    • encryptionType (string) --

      The type of encryption used for the encryption configuration.

    • kmsKeyArn (string) --

      The key ARN of the customer managed customer master key (CMK) used for AWS KMS encryption if you use KMS_BASED_ENCRYPTION .

    • configurationStatus (dict) --

      The status of the account configuration. This contains the ConfigurationState . If there's an error, it also contains the ErrorDetails .

      • state (string) --
      • error (dict) --
        • code (string) --
        • message (string) --

Exceptions

describe_gateway(**kwargs)

Retrieves information about a gateway.

See also: AWS API Documentation

Request Syntax

response = client.describe_gateway(
    gatewayId='string'
)
Parameters
gatewayId (string) --

[REQUIRED]

The ID of the gateway device.

Return type
dict
Returns
Response Syntax
{
    'gatewayId': 'string',
    'gatewayName': 'string',
    'gatewayArn': 'string',
    'gatewayPlatform': {
        'greengrass': {
            'groupArn': 'string'
        }
    },
    'gatewayCapabilitySummaries': [
        {
            'capabilityNamespace': 'string',
            'capabilitySyncStatus': 'IN_SYNC'|'OUT_OF_SYNC'|'SYNC_FAILED'
        },
    ],
    'creationDate': datetime(2015, 1, 1),
    'lastUpdateDate': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • gatewayId (string) --

      The ID of the gateway device.

    • gatewayName (string) --

      The name of the gateway.

    • gatewayArn (string) --

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

      arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}
    • gatewayPlatform (dict) --

      The gateway's platform.

      • greengrass (dict) --

        A gateway that runs on AWS IoT Greengrass.

        • groupArn (string) --

          The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the AWS IoT Greengrass API Reference .

    • gatewayCapabilitySummaries (list) --

      A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration .

      • (dict) --

        Contains a summary of a gateway capability configuration.

        • capabilityNamespace (string) --

          The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .

        • capabilitySyncStatus (string) --

          The synchronization status of the capability configuration. The sync status can be one of the following:

          • IN_SYNC – The gateway is running the capability configuration.
          • OUT_OF_SYNC – The gateway hasn't received the capability configuration.
          • SYNC_FAILED – The gateway rejected the capability configuration.
    • creationDate (datetime) --

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

    • lastUpdateDate (datetime) --

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

Exceptions

describe_gateway_capability_configuration(**kwargs)

Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the AWS IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway .

See also: AWS API Documentation

Request Syntax

response = client.describe_gateway_capability_configuration(
    gatewayId='string',
    capabilityNamespace='string'
)
Parameters
  • gatewayId (string) --

    [REQUIRED]

    The ID of the gateway that defines the capability configuration.

  • capabilityNamespace (string) --

    [REQUIRED]

    The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .

Return type

dict

Returns

Response Syntax

{
    'gatewayId': 'string',
    'capabilityNamespace': 'string',
    'capabilityConfiguration': 'string',
    'capabilitySyncStatus': 'IN_SYNC'|'OUT_OF_SYNC'|'SYNC_FAILED'
}

Response Structure

  • (dict) --

    • gatewayId (string) --

      The ID of the gateway that defines the capability configuration.

    • capabilityNamespace (string) --

      The namespace of the gateway capability.

    • capabilityConfiguration (string) --

      The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the AWS IoT SiteWise User Guide .

    • capabilitySyncStatus (string) --

      The synchronization status of the capability configuration. The sync status can be one of the following:

      • IN_SYNC – The gateway is running the capability configuration.
      • OUT_OF_SYNC – The gateway hasn't received the capability configuration.
      • SYNC_FAILED – The gateway rejected the capability configuration.

Exceptions

describe_logging_options()

Retrieves the current AWS IoT SiteWise logging options.

See also: AWS API Documentation

Request Syntax

response = client.describe_logging_options()
Return type
dict
Returns
Response Syntax
{
    'loggingOptions': {
        'level': 'ERROR'|'INFO'|'OFF'
    }
}

Response Structure

  • (dict) --
    • loggingOptions (dict) --

      The current logging options.

      • level (string) --

        The AWS IoT SiteWise logging verbosity level.

Exceptions

describe_portal(**kwargs)

Retrieves information about a portal.

See also: AWS API Documentation

Request Syntax

response = client.describe_portal(
    portalId='string'
)
Parameters
portalId (string) --

[REQUIRED]

The ID of the portal.

Return type
dict
Returns
Response Syntax
{
    'portalId': 'string',
    'portalArn': 'string',
    'portalName': 'string',
    'portalDescription': 'string',
    'portalClientId': 'string',
    'portalStartUrl': 'string',
    'portalContactEmail': 'string',
    'portalStatus': {
        'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
        'error': {
            'code': 'INTERNAL_FAILURE'|'VALIDATION_ERROR'|'LIMIT_EXCEEDED',
            'message': 'string'
        }
    },
    'portalCreationDate': datetime(2015, 1, 1),
    'portalLastUpdateDate': datetime(2015, 1, 1),
    'portalLogoImageLocation': {
        'id': 'string',
        'url': 'string'
    },
    'roleArn': 'string',
    'portalAuthMode': 'IAM'|'SSO'
}

Response Structure

  • (dict) --
    • portalId (string) --

      The ID of the portal.

    • portalArn (string) --

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

      arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
    • portalName (string) --

      The name of the portal.

    • portalDescription (string) --

      The portal's description.

    • portalClientId (string) --

      The AWS SSO application generated client ID (used with AWS SSO APIs). AWS IoT SiteWise includes portalClientId for only portals that use AWS SSO to authenticate users.

    • portalStartUrl (string) --

      The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

    • portalContactEmail (string) --

      The AWS administrator's contact email address.

    • portalStatus (dict) --

      The current status of the portal, which contains a state and any error message.

      • state (string) --

        The current state of the portal.

      • error (dict) --

        Contains associated error information, if any.

        • code (string) --

          The error code.

        • message (string) --

          The error message.

    • portalCreationDate (datetime) --

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

    • portalLastUpdateDate (datetime) --

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

    • portalLogoImageLocation (dict) --

      The portal's logo image, which is available at a URL.

      • id (string) --

        The ID of the image.

      • url (string) --

        The URL where the image is available. The URL is valid for 15 minutes so that you can view and download the image

    • roleArn (string) --

      The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide .

    • portalAuthMode (string) --

      The service to use to authenticate users to the portal.

Exceptions

describe_project(**kwargs)

Retrieves information about a project.

See also: AWS API Documentation

Request Syntax

response = client.describe_project(
    projectId='string'
)
Parameters
projectId (string) --

[REQUIRED]

The ID of the project.

Return type
dict
Returns
Response Syntax
{
    'projectId': 'string',
    'projectArn': 'string',
    'projectName': 'string',
    'portalId': 'string',
    'projectDescription': 'string',
    'projectCreationDate': datetime(2015, 1, 1),
    'projectLastUpdateDate': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • projectId (string) --

      The ID of the project.

    • projectArn (string) --

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

      arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}
    • projectName (string) --

      The name of the project.

    • portalId (string) --

      The ID of the portal that the project is in.

    • projectDescription (string) --

      The project's description.

    • projectCreationDate (datetime) --

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

    • projectLastUpdateDate (datetime) --

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

Exceptions

disassociate_assets(**kwargs)

Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_assets(
    assetId='string',
    hierarchyId='string',
    childAssetId='string',
    clientToken='string'
)
Parameters
  • assetId (string) --

    [REQUIRED]

    The ID of the parent asset from which to disassociate the child asset.

  • hierarchyId (string) --

    [REQUIRED]

    The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. You can use the hierarchy ID to identify the correct asset to disassociate. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide .

  • childAssetId (string) --

    [REQUIRED]

    The ID of the child asset to disassociate.

  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

Returns

None

Exceptions

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_asset_property_aggregates(**kwargs)

Gets aggregated values for an asset property. For more information, see Querying aggregates in the AWS IoT SiteWise User Guide .

To identify an asset property, you must specify one of the following:

  • The assetId and propertyId of an asset property.
  • A propertyAlias , which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature ). To define an asset property's alias, see UpdateAssetProperty .

See also: AWS API Documentation

Request Syntax

response = client.get_asset_property_aggregates(
    assetId='string',
    propertyId='string',
    propertyAlias='string',
    aggregateTypes=[
        'AVERAGE'|'COUNT'|'MAXIMUM'|'MINIMUM'|'SUM'|'STANDARD_DEVIATION',
    ],
    resolution='string',
    qualities=[
        'GOOD'|'BAD'|'UNCERTAIN',
    ],
    startDate=datetime(2015, 1, 1),
    endDate=datetime(2015, 1, 1),
    timeOrdering='ASCENDING'|'DESCENDING',
    nextToken='string',
    maxResults=123
)
Parameters
  • assetId (string) -- The ID of the asset.
  • propertyId (string) -- The ID of the asset property.
  • propertyAlias (string) -- The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide .
  • aggregateTypes (list) --

    [REQUIRED]

    The data aggregating function.

    • (string) --
  • resolution (string) --

    [REQUIRED]

    The time interval over which to aggregate data.

  • qualities (list) --

    The quality by which to filter asset data.

    • (string) --
  • startDate (datetime) --

    [REQUIRED]

    The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

  • endDate (datetime) --

    [REQUIRED]

    The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

  • timeOrdering (string) --

    The chronological sorting order of the requested information.

    Default: ASCENDING

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

    The maximum number of results to be returned per paginated request.

    Default: 100

Return type

dict

Returns

Response Syntax

{
    'aggregatedValues': [
        {
            'timestamp': datetime(2015, 1, 1),
            'quality': 'GOOD'|'BAD'|'UNCERTAIN',
            'value': {
                'average': 123.0,
                'count': 123.0,
                'maximum': 123.0,
                'minimum': 123.0,
                'sum': 123.0,
                'standardDeviation': 123.0
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • aggregatedValues (list) --

      The requested aggregated values.

      • (dict) --

        Contains aggregated asset property values (for example, average, minimum, and maximum).

        • timestamp (datetime) --

          The date the aggregating computations occurred, in Unix epoch time.

        • quality (string) --

          The quality of the aggregated data.

        • value (dict) --

          The value of the aggregates.

          • average (float) --

            The average (mean) value of the time series over a time interval window.

          • count (float) --

            The count of data points in the time series over a time interval window.

          • maximum (float) --

            The maximum value of the time series over a time interval window.

          • minimum (float) --

            The minimum value of the time series over a time interval window.

          • sum (float) --

            The sum of the time series over a time interval window.

          • standardDeviation (float) --

            The standard deviation of the time series over a time interval window.

    • nextToken (string) --

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

Exceptions

get_asset_property_value(**kwargs)

Gets an asset property's current value. For more information, see Querying current values in the AWS IoT SiteWise User Guide .

To identify an asset property, you must specify one of the following:

  • The assetId and propertyId of an asset property.
  • A propertyAlias , which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature ). To define an asset property's alias, see UpdateAssetProperty .

See also: AWS API Documentation

Request Syntax

response = client.get_asset_property_value(
    assetId='string',
    propertyId='string',
    propertyAlias='string'
)
Parameters
  • assetId (string) -- The ID of the asset.
  • propertyId (string) -- The ID of the asset property.
  • propertyAlias (string) -- The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide .
Return type

dict

Returns

Response Syntax

{
    'propertyValue': {
        'value': {
            'stringValue': 'string',
            'integerValue': 123,
            'doubleValue': 123.0,
            'booleanValue': True|False
        },
        'timestamp': {
            'timeInSeconds': 123,
            'offsetInNanos': 123
        },
        'quality': 'GOOD'|'BAD'|'UNCERTAIN'
    }
}

Response Structure

  • (dict) --

    • propertyValue (dict) --

      The current asset property value.

      • value (dict) --

        The value of the asset property (see Variant ).

        • stringValue (string) --

          Asset property data of type string (sequence of characters).

        • integerValue (integer) --

          Asset property data of type integer (whole number).

        • doubleValue (float) --

          Asset property data of type double (floating point number).

        • booleanValue (boolean) --

          Asset property data of type Boolean (true or false).

      • timestamp (dict) --

        The timestamp of the asset property value.

        • timeInSeconds (integer) --

          The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos .

        • offsetInNanos (integer) --

          The nanosecond offset from timeInSeconds .

      • quality (string) --

        The quality of the asset property value.

Exceptions

get_asset_property_value_history(**kwargs)

Gets the history of an asset property's values. For more information, see Querying historical values in the AWS IoT SiteWise User Guide .

To identify an asset property, you must specify one of the following:

  • The assetId and propertyId of an asset property.
  • A propertyAlias , which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature ). To define an asset property's alias, see UpdateAssetProperty .

See also: AWS API Documentation

Request Syntax

response = client.get_asset_property_value_history(
    assetId='string',
    propertyId='string',
    propertyAlias='string',
    startDate=datetime(2015, 1, 1),
    endDate=datetime(2015, 1, 1),
    qualities=[
        'GOOD'|'BAD'|'UNCERTAIN',
    ],
    timeOrdering='ASCENDING'|'DESCENDING',
    nextToken='string',
    maxResults=123
)
Parameters
  • assetId (string) -- The ID of the asset.
  • propertyId (string) -- The ID of the asset property.
  • propertyAlias (string) -- The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide .
  • startDate (datetime) -- The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
  • endDate (datetime) -- The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
  • qualities (list) --

    The quality by which to filter asset data.

    • (string) --
  • timeOrdering (string) --

    The chronological sorting order of the requested information.

    Default: ASCENDING

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

    The maximum number of results to be returned per paginated request.

    Default: 100

Return type

dict

Returns

Response Syntax

{
    'assetPropertyValueHistory': [
        {
            'value': {
                'stringValue': 'string',
                'integerValue': 123,
                'doubleValue': 123.0,
                'booleanValue': True|False
            },
            'timestamp': {
                'timeInSeconds': 123,
                'offsetInNanos': 123
            },
            'quality': 'GOOD'|'BAD'|'UNCERTAIN'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • assetPropertyValueHistory (list) --

      The asset property's value history.

      • (dict) --

        Contains asset property value information.

        • value (dict) --

          The value of the asset property (see Variant ).

          • stringValue (string) --

            Asset property data of type string (sequence of characters).

          • integerValue (integer) --

            Asset property data of type integer (whole number).

          • doubleValue (float) --

            Asset property data of type double (floating point number).

          • booleanValue (boolean) --

            Asset property data of type Boolean (true or false).

        • timestamp (dict) --

          The timestamp of the asset property value.

          • timeInSeconds (integer) --

            The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos .

          • offsetInNanos (integer) --

            The nanosecond offset from timeInSeconds .

        • quality (string) --

          The quality of the asset property value.

    • nextToken (string) --

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

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_access_policies(**kwargs)

Retrieves a paginated list of access policies for an identity (an AWS SSO user, an AWS SSO group, or an IAM user) or an AWS IoT SiteWise Monitor resource (a portal or project).

See also: AWS API Documentation

Request Syntax

response = client.list_access_policies(
    identityType='USER'|'GROUP'|'IAM',
    identityId='string',
    resourceType='PORTAL'|'PROJECT',
    resourceId='string',
    iamArn='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • identityType (string) -- The type of identity (AWS SSO user, AWS SSO group, or IAM user). This parameter is required if you specify identityId .
  • identityId (string) -- The ID of the identity. This parameter is required if you specify USER or GROUP for identityType .
  • resourceType (string) -- The type of resource (portal or project). This parameter is required if you specify resourceId .
  • resourceId (string) -- The ID of the resource. This parameter is required if you specify resourceType .
  • iamArn (string) -- The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide . This parameter is required if you specify IAM for identityType .
  • nextToken (string) -- The token to be used for the next set of paginated results.
  • maxResults (integer) --

    The maximum number of results to be returned per paginated request.

    Default: 50

Return type

dict

Returns

Response Syntax

{
    'accessPolicySummaries': [
        {
            'id': 'string',
            'identity': {
                'user': {
                    'id': 'string'
                },
                'group': {
                    'id': 'string'
                },
                'iamUser': {
                    'arn': 'string'
                }
            },
            'resource': {
                'portal': {
                    'id': 'string'
                },
                'project': {
                    'id': 'string'
                }
            },
            'permission': 'ADMINISTRATOR'|'VIEWER',
            'creationDate': datetime(2015, 1, 1),
            'lastUpdateDate': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • accessPolicySummaries (list) --

      A list that summarizes each access policy.

      • (dict) --

        Contains an access policy that defines an identity's access to an AWS IoT SiteWise Monitor resource.

        • id (string) --

          The ID of the access policy.

        • identity (dict) --

          The identity (an AWS SSO user, an AWS SSO group, or an IAM user).

          • user (dict) --

            An AWS SSO user identity.

            • id (string) --

              The AWS SSO ID of the user.

          • group (dict) --

            An AWS SSO group identity.

            • id (string) --

              The AWS SSO ID of the group.

          • iamUser (dict) --

            An IAM user identity.

            • arn (string) --

              The ARN of the IAM user. IAM users must have the iotsitewise:CreatePresignedPortalUrl permission to sign in to the portal. For more information, see IAM ARNs in the IAM User Guide .

              Note

              If you delete the IAM user, access policies that contain this identity include an empty arn . You can delete the access policy for the IAM user that no longer exists.

        • resource (dict) --

          The AWS IoT SiteWise Monitor resource (a portal or project).

          • portal (dict) --

            A portal resource.

            • id (string) --

              The ID of the portal.

          • project (dict) --

            A project resource.

            • id (string) --

              The ID of the project.

        • permission (string) --

          The permissions for the access policy. Note that a project ADMINISTRATOR is also known as a project owner.

        • creationDate (datetime) --

          The date the access policy was created, in Unix epoch time.

        • lastUpdateDate (datetime) --

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

    • nextToken (string) --

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

Exceptions

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
)
Parameters
  • nextToken (string) -- The token to be used for the next set of paginated results.
  • maxResults (integer) --

    The maximum number of results to be returned per paginated request.

    Default: 50

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'
                }
            }
        },
    ],
    '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 AWS IoT SiteWise APIs).

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

    • nextToken (string) --

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

Exceptions

list_assets(**kwargs)

Retrieves a paginated list of asset summaries.

You can use this operation to do the following:

  • List assets based on a specific asset model.
  • List top-level assets.

You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.

See also: AWS API Documentation

Request Syntax

response = client.list_assets(
    nextToken='string',
    maxResults=123,
    assetModelId='string',
    filter='ALL'|'TOP_LEVEL'
)
Parameters
  • nextToken (string) -- The token to be used for the next set of paginated results.
  • maxResults (integer) --

    The maximum number of results to be returned per paginated request.

    Default: 50

  • assetModelId (string) -- The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter .
  • filter (string) --

    The filter for the requested list of assets. Choose one of the following options:

    • ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL .
    • TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

    Default: ALL

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'
                }
            },
            'hierarchies': [
                {
                    'id': 'string',
                    'name': 'string'
                },
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • assetSummaries (list) --

      A list that summarizes each asset.

      • (dict) --

        Contains a summary of an asset.

        • id (string) --

          The ID of the asset.

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

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

    • nextToken (string) --

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

Exceptions

list_associated_assets(**kwargs)

Retrieves a paginated list of associated assets.

You can use this operation to do the following:

  • List child assets associated to a parent asset by a hierarchy that you specify.
  • List an asset's parent asset.

See also: AWS API Documentation

Request Syntax

response = client.list_associated_assets(
    assetId='string',
    hierarchyId='string',
    traversalDirection='PARENT'|'CHILD',
    nextToken='string',
    maxResults=123
)
Parameters
  • assetId (string) --

    [REQUIRED]

    The ID of the asset to query.

  • hierarchyId (string) --

    The ID of the hierarchy by which child assets are associated to the asset. 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 AWS 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

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

    The maximum number of results to be returned per paginated request.

    Default: 50

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'
                }
            },
            'hierarchies': [
                {
                    'id': 'string',
                    'name': '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.

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

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

    • nextToken (string) --

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

Exceptions

list_dashboards(**kwargs)

Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.

See also: AWS API Documentation

Request Syntax

response = client.list_dashboards(
    projectId='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • projectId (string) --

    [REQUIRED]

    The ID of the project.

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

    The maximum number of results to be returned per paginated request.

    Default: 50

Return type

dict

Returns

Response Syntax

{
    'dashboardSummaries': [
        {
            'id': 'string',
            'name': 'string',
            'description': 'string',
            'creationDate': datetime(2015, 1, 1),
            'lastUpdateDate': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • dashboardSummaries (list) --

      A list that summarizes each dashboard in the project.

      • (dict) --

        Contains a dashboard summary.

        • id (string) --

          The ID of the dashboard.

        • name (string) --

          The name of the dashboard

        • description (string) --

          The dashboard's description.

        • creationDate (datetime) --

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

        • lastUpdateDate (datetime) --

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

    • nextToken (string) --

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

Exceptions

list_gateways(**kwargs)

Retrieves a paginated list of gateways.

See also: AWS API Documentation

Request Syntax

response = client.list_gateways(
    nextToken='string',
    maxResults=123
)
Parameters
  • nextToken (string) -- The token to be used for the next set of paginated results.
  • maxResults (integer) --

    The maximum number of results to be returned per paginated request.

    Default: 50

Return type

dict

Returns

Response Syntax

{
    'gatewaySummaries': [
        {
            'gatewayId': 'string',
            'gatewayName': 'string',
            'gatewayCapabilitySummaries': [
                {
                    'capabilityNamespace': 'string',
                    'capabilitySyncStatus': 'IN_SYNC'|'OUT_OF_SYNC'|'SYNC_FAILED'
                },
            ],
            'creationDate': datetime(2015, 1, 1),
            'lastUpdateDate': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • gatewaySummaries (list) --

      A list that summarizes each gateway.

      • (dict) --

        Contains a summary of a gateway.

        • gatewayId (string) --

          The ID of the gateway device.

        • gatewayName (string) --

          The name of the asset.

        • gatewayCapabilitySummaries (list) --

          A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration .

          • (dict) --

            Contains a summary of a gateway capability configuration.

            • capabilityNamespace (string) --

              The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .

            • capabilitySyncStatus (string) --

              The synchronization status of the capability configuration. The sync status can be one of the following:

              • IN_SYNC – The gateway is running the capability configuration.
              • OUT_OF_SYNC – The gateway hasn't received the capability configuration.
              • SYNC_FAILED – The gateway rejected the capability configuration.
        • creationDate (datetime) --

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

        • lastUpdateDate (datetime) --

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

    • nextToken (string) --

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

Exceptions

list_portals(**kwargs)

Retrieves a paginated list of AWS IoT SiteWise Monitor portals.

See also: AWS API Documentation

Request Syntax

response = client.list_portals(
    nextToken='string',
    maxResults=123
)
Parameters
  • nextToken (string) -- The token to be used for the next set of paginated results.
  • maxResults (integer) --

    The maximum number of results to be returned per paginated request.

    Default: 50

Return type

dict

Returns

Response Syntax

{
    'portalSummaries': [
        {
            'id': 'string',
            'name': 'string',
            'description': 'string',
            'startUrl': 'string',
            'creationDate': datetime(2015, 1, 1),
            'lastUpdateDate': datetime(2015, 1, 1),
            'roleArn': 'string',
            'status': {
                'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
                'error': {
                    'code': 'INTERNAL_FAILURE'|'VALIDATION_ERROR'|'LIMIT_EXCEEDED',
                    'message': 'string'
                }
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • portalSummaries (list) --

      A list that summarizes each portal.

      • (dict) --

        Contains a portal summary.

        • id (string) --

          The ID of the portal.

        • name (string) --

          The name of the portal.

        • description (string) --

          The portal's description.

        • startUrl (string) --

          The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

        • creationDate (datetime) --

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

        • lastUpdateDate (datetime) --

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

        • roleArn (string) --

          The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide .

        • status (dict) --

          Contains information about the current status of a portal.

          • state (string) --

            The current state of the portal.

          • error (dict) --

            Contains associated error information, if any.

            • code (string) --

              The error code.

            • message (string) --

              The error message.

    • nextToken (string) --

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

Exceptions

list_project_assets(**kwargs)

Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.

See also: AWS API Documentation

Request Syntax

response = client.list_project_assets(
    projectId='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • projectId (string) --

    [REQUIRED]

    The ID of the project.

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

    The maximum number of results to be returned per paginated request.

    Default: 50

Return type

dict

Returns

Response Syntax

{
    'assetIds': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • assetIds (list) --

      A list that contains the IDs of each asset associated with the project.

      • (string) --
    • nextToken (string) --

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

Exceptions

list_projects(**kwargs)

Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.

See also: AWS API Documentation

Request Syntax

response = client.list_projects(
    portalId='string',
    nextToken='string',
    maxResults=123
)
Parameters
  • portalId (string) --

    [REQUIRED]

    The ID of the portal.

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

    The maximum number of results to be returned per paginated request.

    Default: 50

Return type

dict

Returns

Response Syntax

{
    'projectSummaries': [
        {
            'id': 'string',
            'name': 'string',
            'description': 'string',
            'creationDate': datetime(2015, 1, 1),
            'lastUpdateDate': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • projectSummaries (list) --

      A list that summarizes each project in the portal.

      • (dict) --

        Contains project summary information.

        • id (string) --

          The ID of the project.

        • name (string) --

          The name of the project.

        • description (string) --

          The project's description.

        • creationDate (datetime) --

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

        • lastUpdateDate (datetime) --

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

    • nextToken (string) --

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

Exceptions

list_tags_for_resource(**kwargs)

Retrieves the list of tags for an AWS IoT SiteWise resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    resourceArn='string'
)
Parameters
resourceArn (string) --

[REQUIRED]

The ARN of the resource.

Return type
dict
Returns
Response Syntax
{
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • tags (dict) --

      The list of key-value pairs that contain metadata for the resource. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .

      • (string) --
        • (string) --

Exceptions

put_default_encryption_configuration(**kwargs)

Sets the default encryption configuration for the AWS account. For more information, see Key management in the AWS IoT SiteWise User Guide .

See also: AWS API Documentation

Request Syntax

response = client.put_default_encryption_configuration(
    encryptionType='SITEWISE_DEFAULT_ENCRYPTION'|'KMS_BASED_ENCRYPTION',
    kmsKeyId='string'
)
Parameters
  • encryptionType (string) --

    [REQUIRED]

    The type of encryption used for the encryption configuration.

  • kmsKeyId (string) -- The Key ID of the customer managed customer master key (CMK) used for AWS KMS encryption. This is required if you use KMS_BASED_ENCRYPTION .
Return type

dict

Returns

Response Syntax

{
    'encryptionType': 'SITEWISE_DEFAULT_ENCRYPTION'|'KMS_BASED_ENCRYPTION',
    'kmsKeyArn': 'string',
    'configurationStatus': {
        'state': 'ACTIVE'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • encryptionType (string) --

      The type of encryption used for the encryption configuration.

    • kmsKeyArn (string) --

      The Key ARN of the AWS KMS CMK used for AWS KMS encryption if you use KMS_BASED_ENCRYPTION .

    • configurationStatus (dict) --

      The status of the account configuration. This contains the ConfigurationState . If there is an error, it also contains the ErrorDetails .

      • state (string) --
      • error (dict) --
        • code (string) --
        • message (string) --

Exceptions

put_logging_options(**kwargs)

Sets logging options for AWS IoT SiteWise.

See also: AWS API Documentation

Request Syntax

response = client.put_logging_options(
    loggingOptions={
        'level': 'ERROR'|'INFO'|'OFF'
    }
)
Parameters
loggingOptions (dict) --

[REQUIRED]

The logging options to set.

  • level (string) -- [REQUIRED]

    The AWS IoT SiteWise logging verbosity level.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

tag_resource(**kwargs)

Adds tags to an AWS IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The ARN of the resource to tag.

  • tags (dict) --

    [REQUIRED]

    A list of key-value pairs that contain metadata for the resource. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes a tag from an AWS IoT SiteWise resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)
Parameters
  • resourceArn (string) --

    [REQUIRED]

    The ARN of the resource to untag.

  • tagKeys (list) --

    [REQUIRED]

    A list of keys for tags to remove from the resource.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_access_policy(**kwargs)

Updates an existing access policy that specifies an identity's access to an AWS IoT SiteWise Monitor portal or project resource.

See also: AWS API Documentation

Request Syntax

response = client.update_access_policy(
    accessPolicyId='string',
    accessPolicyIdentity={
        'user': {
            'id': 'string'
        },
        'group': {
            'id': 'string'
        },
        'iamUser': {
            'arn': 'string'
        }
    },
    accessPolicyResource={
        'portal': {
            'id': 'string'
        },
        'project': {
            'id': 'string'
        }
    },
    accessPolicyPermission='ADMINISTRATOR'|'VIEWER',
    clientToken='string'
)
Parameters
  • accessPolicyId (string) --

    [REQUIRED]

    The ID of the access policy.

  • accessPolicyIdentity (dict) --

    [REQUIRED]

    The identity for this access policy. Choose an AWS SSO user, an AWS SSO group, or an IAM user.

    • user (dict) --

      An AWS SSO user identity.

      • id (string) -- [REQUIRED]

        The AWS SSO ID of the user.

    • group (dict) --

      An AWS SSO group identity.

      • id (string) -- [REQUIRED]

        The AWS SSO ID of the group.

    • iamUser (dict) --

      An IAM user identity.

      • arn (string) -- [REQUIRED]

        The ARN of the IAM user. IAM users must have the iotsitewise:CreatePresignedPortalUrl permission to sign in to the portal. For more information, see IAM ARNs in the IAM User Guide .

        Note

        If you delete the IAM user, access policies that contain this identity include an empty arn . You can delete the access policy for the IAM user that no longer exists.

  • accessPolicyResource (dict) --

    [REQUIRED]

    The AWS IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.

    • portal (dict) --

      A portal resource.

      • id (string) -- [REQUIRED]

        The ID of the portal.

    • project (dict) --

      A project resource.

      • id (string) -- [REQUIRED]

        The ID of the project.

  • accessPolicyPermission (string) --

    [REQUIRED]

    The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.

  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_asset(**kwargs)

Updates an asset's name. For more information, see Updating assets and models in the AWS IoT SiteWise User Guide .

See also: AWS API Documentation

Request Syntax

response = client.update_asset(
    assetId='string',
    assetName='string',
    clientToken='string'
)
Parameters
  • assetId (string) --

    [REQUIRED]

    The ID of the asset to update.

  • assetName (string) --

    [REQUIRED]

    A unique, friendly name for the asset.

  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'assetStatus': {
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • assetStatus (dict) --

      The status of the asset, which contains a state (UPDATING after successfully calling this operation) and any error message.

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

Exceptions

update_asset_model(**kwargs)

Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the AWS IoT SiteWise User Guide .

Warning

This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel .

If you remove a property from an asset model, AWS IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, AWS IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.

See also: AWS API Documentation

Request Syntax

response = client.update_asset_model(
    assetModelId='string',
    assetModelName='string',
    assetModelDescription='string',
    assetModelProperties=[
        {
            'id': 'string',
            'name': 'string',
            'dataType': 'STRING'|'INTEGER'|'DOUBLE'|'BOOLEAN',
            'unit': 'string',
            'type': {
                'attribute': {
                    'defaultValue': 'string'
                },
                'measurement': {}
                ,
                'transform': {
                    'expression': 'string',
                    'variables': [
                        {
                            'name': 'string',
                            'value': {
                                'propertyId': 'string',
                                'hierarchyId': 'string'
                            }
                        },
                    ]
                },
                'metric': {
                    'expression': 'string',
                    'variables': [
                        {
                            'name': 'string',
                            'value': {
                                'propertyId': 'string',
                                'hierarchyId': 'string'
                            }
                        },
                    ],
                    'window': {
                        'tumbling': {
                            'interval': 'string'
                        }
                    }
                }
            }
        },
    ],
    assetModelHierarchies=[
        {
            'id': 'string',
            'name': 'string',
            'childAssetModelId': 'string'
        },
    ],
    clientToken='string'
)
Parameters
  • assetModelId (string) --

    [REQUIRED]

    The ID of the asset model to update.

  • assetModelName (string) --

    [REQUIRED]

    A unique, friendly name for the asset model.

  • assetModelDescription (string) -- A description for the asset model.
  • assetModelProperties (list) --

    The updated property definitions of the asset model. For more information, see Asset properties in the AWS IoT SiteWise User Guide .

    You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide .

    • (dict) --

      Contains information about an asset model property.

      • id (string) --

        The ID of the asset model property.

      • name (string) -- [REQUIRED]

        The name of the asset model property.

      • dataType (string) -- [REQUIRED]

        The data type of the asset model property.

      • unit (string) --

        The unit of the asset model property, such as Newtons or RPM .

      • type (dict) -- [REQUIRED]

        The property type (see PropertyType ).

        • attribute (dict) --

          Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.

          • defaultValue (string) --

            The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide .

        • measurement (dict) --

          Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.

        • transform (dict) --

          Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.

          • expression (string) -- [REQUIRED]

            The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

            For more information, see Quotas in the AWS IoT SiteWise User Guide .

          • variables (list) -- [REQUIRED]

            The list of variables used in the expression.

            • (dict) --

              Contains expression variable information.

              • name (string) -- [REQUIRED]

                The friendly name of the variable to be used in the expression.

              • value (dict) -- [REQUIRED]

                The variable that identifies an asset property from which to use values.

                • propertyId (string) -- [REQUIRED]

                  The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

                • hierarchyId (string) --

                  The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

                  You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide .

        • metric (dict) --

          Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.

          • expression (string) -- [REQUIRED]

            The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression.

            For more information, see Quotas in the AWS IoT SiteWise User Guide .

          • variables (list) -- [REQUIRED]

            The list of variables used in the expression.

            • (dict) --

              Contains expression variable information.

              • name (string) -- [REQUIRED]

                The friendly name of the variable to be used in the expression.

              • value (dict) -- [REQUIRED]

                The variable that identifies an asset property from which to use values.

                • propertyId (string) -- [REQUIRED]

                  The ID of the property to use as the variable. You can use the property name if it's from the same asset model.

                • hierarchyId (string) --

                  The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID.

                  You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide .

          • window (dict) -- [REQUIRED]

            The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression. AWS IoT SiteWise computes one data point per window .

            • tumbling (dict) --

              The tumbling time interval window.

              • interval (string) -- [REQUIRED]

                The time interval for the tumbling window. Note that w represents weeks, d represents days, h represents hours, and m represents minutes. AWS IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

                When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.

  • assetModelHierarchies (list) --

    The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide .

    You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide .

    • (dict) --

      Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.

      • id (string) --

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

      • name (string) -- [REQUIRED]

        The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.

      • childAssetModelId (string) -- [REQUIRED]

        The ID of the asset model. All assets in this hierarchy must be instances of the childAssetModelId asset model.

  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'assetModelStatus': {
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'PROPAGATING'|'DELETING'|'FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • assetModelStatus (dict) --

      The status of the asset model, which contains a state (UPDATING after successfully calling this operation) and any error message.

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

Exceptions

update_asset_property(**kwargs)

Updates an asset property's alias and notification state.

Warning

This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty .

See also: AWS API Documentation

Request Syntax

response = client.update_asset_property(
    assetId='string',
    propertyId='string',
    propertyAlias='string',
    propertyNotificationState='ENABLED'|'DISABLED',
    clientToken='string'
)
Parameters
  • assetId (string) --

    [REQUIRED]

    The ID of the asset to be updated.

  • propertyId (string) --

    [REQUIRED]

    The ID of the asset property to be updated.

  • propertyAlias (string) --

    The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide .

    If you omit this parameter, the alias is removed from the property.

  • propertyNotificationState (string) --

    The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the AWS IoT SiteWise User Guide .

    If you omit this parameter, the notification state is set to DISABLED .

  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

Returns

None

Exceptions

update_dashboard(**kwargs)

Updates an AWS IoT SiteWise Monitor dashboard.

See also: AWS API Documentation

Request Syntax

response = client.update_dashboard(
    dashboardId='string',
    dashboardName='string',
    dashboardDescription='string',
    dashboardDefinition='string',
    clientToken='string'
)
Parameters
  • dashboardId (string) --

    [REQUIRED]

    The ID of the dashboard to update.

  • dashboardName (string) --

    [REQUIRED]

    A new friendly name for the dashboard.

  • dashboardDescription (string) -- A new description for the dashboard.
  • dashboardDefinition (string) --

    [REQUIRED]

    The new dashboard definition, as specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide .

  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_gateway(**kwargs)

Updates a gateway's name.

See also: AWS API Documentation

Request Syntax

response = client.update_gateway(
    gatewayId='string',
    gatewayName='string'
)
Parameters
  • gatewayId (string) --

    [REQUIRED]

    The ID of the gateway to update.

  • gatewayName (string) --

    [REQUIRED]

    A unique, friendly name for the gateway.

Returns

None

Exceptions

update_gateway_capability_configuration(**kwargs)

Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the AWS IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway .

See also: AWS API Documentation

Request Syntax

response = client.update_gateway_capability_configuration(
    gatewayId='string',
    capabilityNamespace='string',
    capabilityConfiguration='string'
)
Parameters
  • gatewayId (string) --

    [REQUIRED]

    The ID of the gateway to be updated.

  • capabilityNamespace (string) --

    [REQUIRED]

    The namespace of the gateway capability configuration to be updated. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .

  • capabilityConfiguration (string) --

    [REQUIRED]

    The JSON document that defines the configuration for the gateway capability. For more information, see Configuring data sources (CLI) in the AWS IoT SiteWise User Guide .

Return type

dict

Returns

Response Syntax

{
    'capabilityNamespace': 'string',
    'capabilitySyncStatus': 'IN_SYNC'|'OUT_OF_SYNC'|'SYNC_FAILED'
}

Response Structure

  • (dict) --

    • capabilityNamespace (string) --

      The namespace of the gateway capability.

    • capabilitySyncStatus (string) --

      The synchronization status of the capability configuration. The sync status can be one of the following:

      • IN_SYNC – The gateway is running the capability configuration.
      • OUT_OF_SYNC – The gateway hasn't received the capability configuration.
      • SYNC_FAILED – The gateway rejected the capability configuration.

      After you update a capability configuration, its sync status is OUT_OF_SYNC until the gateway receives and applies or rejects the updated configuration.

Exceptions

update_portal(**kwargs)

Updates an AWS IoT SiteWise Monitor portal.

See also: AWS API Documentation

Request Syntax

response = client.update_portal(
    portalId='string',
    portalName='string',
    portalDescription='string',
    portalContactEmail='string',
    portalLogoImage={
        'id': 'string',
        'file': {
            'data': b'bytes',
            'type': 'PNG'
        }
    },
    roleArn='string',
    clientToken='string'
)
Parameters
  • portalId (string) --

    [REQUIRED]

    The ID of the portal to update.

  • portalName (string) --

    [REQUIRED]

    A new friendly name for the portal.

  • portalDescription (string) -- A new description for the portal.
  • portalContactEmail (string) --

    [REQUIRED]

    The AWS administrator's contact email address.

  • portalLogoImage (dict) --

    Contains an image that is one of the following:

    • An image file. Choose this option to upload a new image.
    • The ID of an existing image. Choose this option to keep an existing image.
    • id (string) --

      The ID of an existing image. Specify this parameter to keep an existing image.

    • file (dict) --

      Contains an image file.

      • data (bytes) -- [REQUIRED]

        The image file contents, represented as a base64-encoded string. The file size must be less than 1 MB.

      • type (string) -- [REQUIRED]

        The file type of the image.

  • roleArn (string) --

    [REQUIRED]

    The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide .

  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'portalStatus': {
        'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
        'error': {
            'code': 'INTERNAL_FAILURE'|'VALIDATION_ERROR'|'LIMIT_EXCEEDED',
            'message': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • portalStatus (dict) --

      The status of the portal, which contains a state (UPDATING after successfully calling this operation) and any error message.

      • state (string) --

        The current state of the portal.

      • error (dict) --

        Contains associated error information, if any.

        • code (string) --

          The error code.

        • message (string) --

          The error message.

Exceptions

update_project(**kwargs)

Updates an AWS IoT SiteWise Monitor project.

See also: AWS API Documentation

Request Syntax

response = client.update_project(
    projectId='string',
    projectName='string',
    projectDescription='string',
    clientToken='string'
)
Parameters
  • projectId (string) --

    [REQUIRED]

    The ID of the project to update.

  • projectName (string) --

    [REQUIRED]

    A new friendly name for the project.

  • projectDescription (string) -- A new description for the project.
  • clientToken (string) --

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class IoTSiteWise.Client.exceptions.ConflictingOperationException

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

Example

try:
  ...
except client.exceptions.ConflictingOperationException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'resourceId': 'string',
    'resourceArn': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

    • message (string) --

    • resourceId (string) --

      The ID of the resource that conflicts with this operation.

    • resourceArn (string) --

      The ARN of the resource that conflicts with this operation.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTSiteWise.Client.exceptions.InternalFailureException

AWS IoT SiteWise can't process your request right now. Try again later.

Example

try:
  ...
except client.exceptions.InternalFailureException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    AWS IoT SiteWise can't process your request right now. Try again later.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTSiteWise.Client.exceptions.InvalidRequestException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

Example

try:
  ...
except client.exceptions.InvalidRequestException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTSiteWise.Client.exceptions.LimitExceededException

You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

For more information, see Quotas in the AWS IoT SiteWise User Guide .

Example

try:
  ...
except client.exceptions.LimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You've reached the limit for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.

    For more information, see Quotas in the AWS IoT SiteWise User Guide .

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTSiteWise.Client.exceptions.ResourceAlreadyExistsException

The resource already exists.

Example

try:
  ...
except client.exceptions.ResourceAlreadyExistsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'resourceId': 'string',
    'resourceArn': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The resource already exists.

    • message (string) --

    • resourceId (string) --

      The ID of the resource that already exists.

    • resourceArn (string) --

      The ARN of the resource that already exists.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTSiteWise.Client.exceptions.ResourceNotFoundException

The requested resource can't be found.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The requested resource can't be found.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTSiteWise.Client.exceptions.ServiceUnavailableException

The requested service is unavailable.

Example

try:
  ...
except client.exceptions.ServiceUnavailableException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The requested service is unavailable.

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTSiteWise.Client.exceptions.ThrottlingException

Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the AWS IoT SiteWise User Guide .

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

    For more information, see Quotas in the AWS IoT SiteWise User Guide .

    • message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class IoTSiteWise.Client.exceptions.TooManyTagsException

You've reached the limit for the number of tags allowed for a resource. For more information, see Tag naming limits and requirements in the AWS General Reference .

Example

try:
  ...
except client.exceptions.TooManyTagsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'message': 'string',
    'resourceName': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You've reached the limit for the number of tags allowed for a resource. For more information, see Tag naming limits and requirements in the AWS General Reference .

    • message (string) --

    • resourceName (string) --

      The name of the resource with too many tags.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class IoTSiteWise.Paginator.GetAssetPropertyAggregates
paginator = client.get_paginator('get_asset_property_aggregates')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    assetId='string',
    propertyId='string',
    propertyAlias='string',
    aggregateTypes=[
        'AVERAGE'|'COUNT'|'MAXIMUM'|'MINIMUM'|'SUM'|'STANDARD_DEVIATION',
    ],
    resolution='string',
    qualities=[
        'GOOD'|'BAD'|'UNCERTAIN',
    ],
    startDate=datetime(2015, 1, 1),
    endDate=datetime(2015, 1, 1),
    timeOrdering='ASCENDING'|'DESCENDING',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • assetId (string) -- The ID of the asset.
  • propertyId (string) -- The ID of the asset property.
  • propertyAlias (string) -- The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide .
  • aggregateTypes (list) --

    [REQUIRED]

    The data aggregating function.

    • (string) --
  • resolution (string) --

    [REQUIRED]

    The time interval over which to aggregate data.

  • qualities (list) --

    The quality by which to filter asset data.

    • (string) --
  • startDate (datetime) --

    [REQUIRED]

    The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

  • endDate (datetime) --

    [REQUIRED]

    The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

  • timeOrdering (string) --

    The chronological sorting order of the requested information.

    Default: ASCENDING

  • 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

{
    'aggregatedValues': [
        {
            'timestamp': datetime(2015, 1, 1),
            'quality': 'GOOD'|'BAD'|'UNCERTAIN',
            'value': {
                'average': 123.0,
                'count': 123.0,
                'maximum': 123.0,
                'minimum': 123.0,
                'sum': 123.0,
                'standardDeviation': 123.0
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • aggregatedValues (list) --

      The requested aggregated values.

      • (dict) --

        Contains aggregated asset property values (for example, average, minimum, and maximum).

        • timestamp (datetime) --

          The date the aggregating computations occurred, in Unix epoch time.

        • quality (string) --

          The quality of the aggregated data.

        • value (dict) --

          The value of the aggregates.

          • average (float) --

            The average (mean) value of the time series over a time interval window.

          • count (float) --

            The count of data points in the time series over a time interval window.

          • maximum (float) --

            The maximum value of the time series over a time interval window.

          • minimum (float) --

            The minimum value of the time series over a time interval window.

          • sum (float) --

            The sum of the time series over a time interval window.

          • standardDeviation (float) --

            The standard deviation of the time series over a time interval window.

    • NextToken (string) --

      A token to resume pagination.

class IoTSiteWise.Paginator.GetAssetPropertyValueHistory
paginator = client.get_paginator('get_asset_property_value_history')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    assetId='string',
    propertyId='string',
    propertyAlias='string',
    startDate=datetime(2015, 1, 1),
    endDate=datetime(2015, 1, 1),
    qualities=[
        'GOOD'|'BAD'|'UNCERTAIN',
    ],
    timeOrdering='ASCENDING'|'DESCENDING',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • assetId (string) -- The ID of the asset.
  • propertyId (string) -- The ID of the asset property.
  • propertyAlias (string) -- The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide .
  • startDate (datetime) -- The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
  • endDate (datetime) -- The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
  • qualities (list) --

    The quality by which to filter asset data.

    • (string) --
  • timeOrdering (string) --

    The chronological sorting order of the requested information.

    Default: ASCENDING

  • 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

{
    'assetPropertyValueHistory': [
        {
            'value': {
                'stringValue': 'string',
                'integerValue': 123,
                'doubleValue': 123.0,
                'booleanValue': True|False
            },
            'timestamp': {
                'timeInSeconds': 123,
                'offsetInNanos': 123
            },
            'quality': 'GOOD'|'BAD'|'UNCERTAIN'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • assetPropertyValueHistory (list) --

      The asset property's value history.

      • (dict) --

        Contains asset property value information.

        • value (dict) --

          The value of the asset property (see Variant ).

          • stringValue (string) --

            Asset property data of type string (sequence of characters).

          • integerValue (integer) --

            Asset property data of type integer (whole number).

          • doubleValue (float) --

            Asset property data of type double (floating point number).

          • booleanValue (boolean) --

            Asset property data of type Boolean (true or false).

        • timestamp (dict) --

          The timestamp of the asset property value.

          • timeInSeconds (integer) --

            The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos .

          • offsetInNanos (integer) --

            The nanosecond offset from timeInSeconds .

        • quality (string) --

          The quality of the asset property value.

    • NextToken (string) --

      A token to resume pagination.

class IoTSiteWise.Paginator.ListAccessPolicies
paginator = client.get_paginator('list_access_policies')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    identityType='USER'|'GROUP'|'IAM',
    identityId='string',
    resourceType='PORTAL'|'PROJECT',
    resourceId='string',
    iamArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • identityType (string) -- The type of identity (AWS SSO user, AWS SSO group, or IAM user). This parameter is required if you specify identityId .
  • identityId (string) -- The ID of the identity. This parameter is required if you specify USER or GROUP for identityType .
  • resourceType (string) -- The type of resource (portal or project). This parameter is required if you specify resourceId .
  • resourceId (string) -- The ID of the resource. This parameter is required if you specify resourceType .
  • iamArn (string) -- The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide . This parameter is required if you specify IAM for identityType .
  • 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

{
    'accessPolicySummaries': [
        {
            'id': 'string',
            'identity': {
                'user': {
                    'id': 'string'
                },
                'group': {
                    'id': 'string'
                },
                'iamUser': {
                    'arn': 'string'
                }
            },
            'resource': {
                'portal': {
                    'id': 'string'
                },
                'project': {
                    'id': 'string'
                }
            },
            'permission': 'ADMINISTRATOR'|'VIEWER',
            'creationDate': datetime(2015, 1, 1),
            'lastUpdateDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • accessPolicySummaries (list) --

      A list that summarizes each access policy.

      • (dict) --

        Contains an access policy that defines an identity's access to an AWS IoT SiteWise Monitor resource.

        • id (string) --

          The ID of the access policy.

        • identity (dict) --

          The identity (an AWS SSO user, an AWS SSO group, or an IAM user).

          • user (dict) --

            An AWS SSO user identity.

            • id (string) --

              The AWS SSO ID of the user.

          • group (dict) --

            An AWS SSO group identity.

            • id (string) --

              The AWS SSO ID of the group.

          • iamUser (dict) --

            An IAM user identity.

            • arn (string) --

              The ARN of the IAM user. IAM users must have the iotsitewise:CreatePresignedPortalUrl permission to sign in to the portal. For more information, see IAM ARNs in the IAM User Guide .

              Note

              If you delete the IAM user, access policies that contain this identity include an empty arn . You can delete the access policy for the IAM user that no longer exists.

        • resource (dict) --

          The AWS IoT SiteWise Monitor resource (a portal or project).

          • portal (dict) --

            A portal resource.

            • id (string) --

              The ID of the portal.

          • project (dict) --

            A project resource.

            • id (string) --

              The ID of the project.

        • permission (string) --

          The permissions for the access policy. Note that a project ADMINISTRATOR is also known as a project owner.

        • creationDate (datetime) --

          The date the access policy was created, in Unix epoch time.

        • lastUpdateDate (datetime) --

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

    • NextToken (string) --

      A token to resume pagination.

class IoTSiteWise.Paginator.ListAssetModels
paginator = client.get_paginator('list_asset_models')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
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
{
    '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'
                }
            }
        },
    ],
    '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 AWS IoT SiteWise APIs).

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

    • NextToken (string) --

      A token to resume pagination.

class IoTSiteWise.Paginator.ListAssets
paginator = client.get_paginator('list_assets')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    assetModelId='string',
    filter='ALL'|'TOP_LEVEL',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • assetModelId (string) -- The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter .
  • filter (string) --

    The filter for the requested list of assets. Choose one of the following options:

    • ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL .
    • TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

    Default: ALL

  • 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'
                }
            },
            'hierarchies': [
                {
                    'id': 'string',
                    'name': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • assetSummaries (list) --

      A list that summarizes each asset.

      • (dict) --

        Contains a summary of an asset.

        • id (string) --

          The ID of the asset.

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

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

    • NextToken (string) --

      A token to resume pagination.

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.

  • hierarchyId (string) --

    The ID of the hierarchy by which child assets are associated to the asset. 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 AWS 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'
                }
            },
            'hierarchies': [
                {
                    'id': 'string',
                    'name': '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.

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

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

    • NextToken (string) --

      A token to resume pagination.

class IoTSiteWise.Paginator.ListDashboards
paginator = client.get_paginator('list_dashboards')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    projectId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • projectId (string) --

    [REQUIRED]

    The ID of the project.

  • 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

{
    'dashboardSummaries': [
        {
            'id': 'string',
            'name': 'string',
            'description': 'string',
            'creationDate': datetime(2015, 1, 1),
            'lastUpdateDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • dashboardSummaries (list) --

      A list that summarizes each dashboard in the project.

      • (dict) --

        Contains a dashboard summary.

        • id (string) --

          The ID of the dashboard.

        • name (string) --

          The name of the dashboard

        • description (string) --

          The dashboard's description.

        • creationDate (datetime) --

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

        • lastUpdateDate (datetime) --

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

    • NextToken (string) --

      A token to resume pagination.

class IoTSiteWise.Paginator.ListGateways
paginator = client.get_paginator('list_gateways')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
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
{
    'gatewaySummaries': [
        {
            'gatewayId': 'string',
            'gatewayName': 'string',
            'gatewayCapabilitySummaries': [
                {
                    'capabilityNamespace': 'string',
                    'capabilitySyncStatus': 'IN_SYNC'|'OUT_OF_SYNC'|'SYNC_FAILED'
                },
            ],
            'creationDate': datetime(2015, 1, 1),
            'lastUpdateDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • gatewaySummaries (list) --

      A list that summarizes each gateway.

      • (dict) --

        Contains a summary of a gateway.

        • gatewayId (string) --

          The ID of the gateway device.

        • gatewayName (string) --

          The name of the asset.

        • gatewayCapabilitySummaries (list) --

          A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration .

          • (dict) --

            Contains a summary of a gateway capability configuration.

            • capabilityNamespace (string) --

              The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version , where version is a number such as 1 .

            • capabilitySyncStatus (string) --

              The synchronization status of the capability configuration. The sync status can be one of the following:

              • IN_SYNC – The gateway is running the capability configuration.
              • OUT_OF_SYNC – The gateway hasn't received the capability configuration.
              • SYNC_FAILED – The gateway rejected the capability configuration.
        • creationDate (datetime) --

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

        • lastUpdateDate (datetime) --

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

    • NextToken (string) --

      A token to resume pagination.

class IoTSiteWise.Paginator.ListPortals
paginator = client.get_paginator('list_portals')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
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
{
    'portalSummaries': [
        {
            'id': 'string',
            'name': 'string',
            'description': 'string',
            'startUrl': 'string',
            'creationDate': datetime(2015, 1, 1),
            'lastUpdateDate': datetime(2015, 1, 1),
            'roleArn': 'string',
            'status': {
                'state': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
                'error': {
                    'code': 'INTERNAL_FAILURE'|'VALIDATION_ERROR'|'LIMIT_EXCEEDED',
                    'message': 'string'
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --
    • portalSummaries (list) --

      A list that summarizes each portal.

      • (dict) --

        Contains a portal summary.

        • id (string) --

          The ID of the portal.

        • name (string) --

          The name of the portal.

        • description (string) --

          The portal's description.

        • startUrl (string) --

          The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.

        • creationDate (datetime) --

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

        • lastUpdateDate (datetime) --

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

        • roleArn (string) --

          The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide .

        • status (dict) --

          Contains information about the current status of a portal.

          • state (string) --

            The current state of the portal.

          • error (dict) --

            Contains associated error information, if any.

            • code (string) --

              The error code.

            • message (string) --

              The error message.

    • NextToken (string) --

      A token to resume pagination.

class IoTSiteWise.Paginator.ListProjectAssets
paginator = client.get_paginator('list_project_assets')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    projectId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • projectId (string) --

    [REQUIRED]

    The ID of the project.

  • 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

{
    'assetIds': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • assetIds (list) --

      A list that contains the IDs of each asset associated with the project.

      • (string) --
    • NextToken (string) --

      A token to resume pagination.

class IoTSiteWise.Paginator.ListProjects
paginator = client.get_paginator('list_projects')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    portalId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • portalId (string) --

    [REQUIRED]

    The ID of the portal.

  • 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

{
    'projectSummaries': [
        {
            'id': 'string',
            'name': 'string',
            'description': 'string',
            'creationDate': datetime(2015, 1, 1),
            'lastUpdateDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • projectSummaries (list) --

      A list that summarizes each project in the portal.

      • (dict) --

        Contains project summary information.

        • id (string) --

          The ID of the project.

        • name (string) --

          The name of the project.

        • description (string) --

          The project's description.

        • creationDate (datetime) --

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

        • lastUpdateDate (datetime) --

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

    • NextToken (string) --

      A token to resume pagination.

Waiters

The available waiters are:

class IoTSiteWise.Waiter.AssetActive
waiter = client.get_waiter('asset_active')
wait(**kwargs)

Polls IoTSiteWise.Client.describe_asset() every 3 seconds until a successful state is reached. An error is returned after 20 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    assetId='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters
  • assetId (string) --

    [REQUIRED]

    The ID of the asset.

  • WaiterConfig (dict) --

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) --

      The amount of time in seconds to wait between attempts. Default: 3

    • MaxAttempts (integer) --

      The maximum number of attempts to be made. Default: 20

Returns

None

class IoTSiteWise.Waiter.AssetModelActive
waiter = client.get_waiter('asset_model_active')
wait(**kwargs)

Polls IoTSiteWise.Client.describe_asset_model() every 3 seconds until a successful state is reached. An error is returned after 20 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    assetModelId='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters
  • assetModelId (string) --

    [REQUIRED]

    The ID of the asset model.

  • WaiterConfig (dict) --

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) --

      The amount of time in seconds to wait between attempts. Default: 3

    • MaxAttempts (integer) --

      The maximum number of attempts to be made. Default: 20

Returns

None

class IoTSiteWise.Waiter.AssetModelNotExists
waiter = client.get_waiter('asset_model_not_exists')
wait(**kwargs)

Polls IoTSiteWise.Client.describe_asset_model() every 3 seconds until a successful state is reached. An error is returned after 20 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    assetModelId='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters
  • assetModelId (string) --

    [REQUIRED]

    The ID of the asset model.

  • WaiterConfig (dict) --

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) --

      The amount of time in seconds to wait between attempts. Default: 3

    • MaxAttempts (integer) --

      The maximum number of attempts to be made. Default: 20

Returns

None

class IoTSiteWise.Waiter.AssetNotExists
waiter = client.get_waiter('asset_not_exists')
wait(**kwargs)

Polls IoTSiteWise.Client.describe_asset() every 3 seconds until a successful state is reached. An error is returned after 20 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    assetId='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters
  • assetId (string) --

    [REQUIRED]

    The ID of the asset.

  • WaiterConfig (dict) --

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) --

      The amount of time in seconds to wait between attempts. Default: 3

    • MaxAttempts (integer) --

      The maximum number of attempts to be made. Default: 20

Returns

None

class IoTSiteWise.Waiter.PortalActive
waiter = client.get_waiter('portal_active')
wait(**kwargs)

Polls IoTSiteWise.Client.describe_portal() every 3 seconds until a successful state is reached. An error is returned after 20 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    portalId='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters
  • portalId (string) --

    [REQUIRED]

    The ID of the portal.

  • WaiterConfig (dict) --

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) --

      The amount of time in seconds to wait between attempts. Default: 3

    • MaxAttempts (integer) --

      The maximum number of attempts to be made. Default: 20

Returns

None

class IoTSiteWise.Waiter.PortalNotExists
waiter = client.get_waiter('portal_not_exists')
wait(**kwargs)

Polls IoTSiteWise.Client.describe_portal() every 3 seconds until a successful state is reached. An error is returned after 20 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    portalId='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters
  • portalId (string) --

    [REQUIRED]

    The ID of the portal.

  • WaiterConfig (dict) --

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) --

      The amount of time in seconds to wait between attempts. Default: 3

    • MaxAttempts (integer) --

      The maximum number of attempts to be made. Default: 20

Returns

None