IoTSiteWiseClient

Index > IoTSiteWise > IoTSiteWiseClient

Auto-generated documentation for IoTSiteWise type annotations stubs module types-aiobotocore-iotsitewise.

IoTSiteWiseClient

Type annotations and code completion for session.client("iotsitewise") boto3 documentation

Usage example

from aioboto3.session import Session
from types_aiobotocore_iotsitewise.client import IoTSiteWiseClient

session = Session()
async with session.client("iotsitewise") as client:
    client: IoTSiteWiseClient

Exceptions

aioboto3 client exceptions are generated in runtime. This class provides code completion for session.client("iotsitewise").exceptions structure.

Usage example

async with session.client("iotsitewise") as client:
    try:
        do_something(client)
    except (
            client.ClientError,
        client.ConflictingOperationException,
        client.InternalFailureException,
        client.InvalidRequestException,
        client.LimitExceededException,
        client.ResourceAlreadyExistsException,
        client.ResourceNotFoundException,
        client.ServiceUnavailableException,
        client.ThrottlingException,
        client.TooManyTagsException,
        client.UnauthorizedException,
    ) as e:
        print(e)

Type checking example

from types_aiobotocore_iotsitewise.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

associate_assets

Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model.

Type annotations and code completion for session.client("iotsitewise").associate_assets method. boto3 documentation

Method definition

await def associate_assets(
    self,
    *,
    assetId: str,
    hierarchyId: str,
    childAssetId: str,
    clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: AssociateAssetsRequestRequestTypeDef = {  # (1)
    "assetId": ...,
    "hierarchyId": ...,
    "childAssetId": ...,
}

parent.associate_assets(**kwargs)

1. See AssociateAssetsRequestRequestTypeDef

associate_time_series_to_asset_property

Associates a time series (data stream) with an asset property.

Type annotations and code completion for session.client("iotsitewise").associate_time_series_to_asset_property method. boto3 documentation

Method definition

await def associate_time_series_to_asset_property(
    self,
    *,
    alias: str,
    assetId: str,
    propertyId: str,
    clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: AssociateTimeSeriesToAssetPropertyRequestRequestTypeDef = {  # (1)
    "alias": ...,
    "assetId": ...,
    "propertyId": ...,
}

parent.associate_time_series_to_asset_property(**kwargs)

1. See AssociateTimeSeriesToAssetPropertyRequestRequestTypeDef

batch_associate_project_assets

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

Type annotations and code completion for session.client("iotsitewise").batch_associate_project_assets method. boto3 documentation

Method definition

await def batch_associate_project_assets(
    self,
    *,
    projectId: str,
    assetIds: Sequence[str],
    clientToken: str = ...,
) -> BatchAssociateProjectAssetsResponseTypeDef:  # (1)
    ...

1. See BatchAssociateProjectAssetsResponseTypeDef

Usage example with kwargs

kwargs: BatchAssociateProjectAssetsRequestRequestTypeDef = {  # (1)
    "projectId": ...,
    "assetIds": ...,
}

parent.batch_associate_project_assets(**kwargs)

1. See BatchAssociateProjectAssetsRequestRequestTypeDef

batch_disassociate_project_assets

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

Type annotations and code completion for session.client("iotsitewise").batch_disassociate_project_assets method. boto3 documentation

Method definition

await def batch_disassociate_project_assets(
    self,
    *,
    projectId: str,
    assetIds: Sequence[str],
    clientToken: str = ...,
) -> BatchDisassociateProjectAssetsResponseTypeDef:  # (1)
    ...

1. See BatchDisassociateProjectAssetsResponseTypeDef

Usage example with kwargs

kwargs: BatchDisassociateProjectAssetsRequestRequestTypeDef = {  # (1)
    "projectId": ...,
    "assetIds": ...,
}

parent.batch_disassociate_project_assets(**kwargs)

1. See BatchDisassociateProjectAssetsRequestRequestTypeDef

batch_get_asset_property_aggregates

Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties.

Type annotations and code completion for session.client("iotsitewise").batch_get_asset_property_aggregates method. boto3 documentation

Method definition

await def batch_get_asset_property_aggregates(
    self,
    *,
    entries: Sequence[BatchGetAssetPropertyAggregatesEntryTypeDef],  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> BatchGetAssetPropertyAggregatesResponseTypeDef:  # (2)
    ...

1. See BatchGetAssetPropertyAggregatesEntryTypeDef
2. See BatchGetAssetPropertyAggregatesResponseTypeDef

Usage example with kwargs

kwargs: BatchGetAssetPropertyAggregatesRequestRequestTypeDef = {  # (1)
    "entries": ...,
}

parent.batch_get_asset_property_aggregates(**kwargs)

1. See BatchGetAssetPropertyAggregatesRequestRequestTypeDef

batch_get_asset_property_value

Gets the current value for one or more asset properties.

Type annotations and code completion for session.client("iotsitewise").batch_get_asset_property_value method. boto3 documentation

Method definition

await def batch_get_asset_property_value(
    self,
    *,
    entries: Sequence[BatchGetAssetPropertyValueEntryTypeDef],  # (1)
    nextToken: str = ...,
) -> BatchGetAssetPropertyValueResponseTypeDef:  # (2)
    ...

1. See BatchGetAssetPropertyValueEntryTypeDef
2. See BatchGetAssetPropertyValueResponseTypeDef

Usage example with kwargs

kwargs: BatchGetAssetPropertyValueRequestRequestTypeDef = {  # (1)
    "entries": ...,
}

parent.batch_get_asset_property_value(**kwargs)

1. See BatchGetAssetPropertyValueRequestRequestTypeDef

batch_get_asset_property_value_history

Gets the historical values for one or more asset properties.

Type annotations and code completion for session.client("iotsitewise").batch_get_asset_property_value_history method. boto3 documentation

Method definition

await def batch_get_asset_property_value_history(
    self,
    *,
    entries: Sequence[BatchGetAssetPropertyValueHistoryEntryTypeDef],  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> BatchGetAssetPropertyValueHistoryResponseTypeDef:  # (2)
    ...

1. See BatchGetAssetPropertyValueHistoryEntryTypeDef
2. See BatchGetAssetPropertyValueHistoryResponseTypeDef

Usage example with kwargs

kwargs: BatchGetAssetPropertyValueHistoryRequestRequestTypeDef = {  # (1)
    "entries": ...,
}

parent.batch_get_asset_property_value_history(**kwargs)

1. See BatchGetAssetPropertyValueHistoryRequestRequestTypeDef

batch_put_asset_property_value

Sends a list of asset property values to IoT SiteWise.

Type annotations and code completion for session.client("iotsitewise").batch_put_asset_property_value method. boto3 documentation

Method definition

await def batch_put_asset_property_value(
    self,
    *,
    entries: Sequence[PutAssetPropertyValueEntryTypeDef],  # (1)
) -> BatchPutAssetPropertyValueResponseTypeDef:  # (2)
    ...

1. See PutAssetPropertyValueEntryTypeDef
2. See BatchPutAssetPropertyValueResponseTypeDef

Usage example with kwargs

kwargs: BatchPutAssetPropertyValueRequestRequestTypeDef = {  # (1)
    "entries": ...,
}

parent.batch_put_asset_property_value(**kwargs)

1. See BatchPutAssetPropertyValueRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for session.client("iotsitewise").can_paginate method. boto3 documentation

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for session.client("iotsitewise").close method. boto3 documentation

Method definition

await def close(
    self,
) -> None:
    ...

create_access_policy

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

Type annotations and code completion for session.client("iotsitewise").create_access_policy method. boto3 documentation

Method definition

await def create_access_policy(
    self,
    *,
    accessPolicyIdentity: IdentityTypeDef,  # (1)
    accessPolicyResource: ResourceTypeDef,  # (2)
    accessPolicyPermission: PermissionType,  # (3)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateAccessPolicyResponseTypeDef:  # (4)
    ...

1. See IdentityTypeDef
2. See ResourceTypeDef
3. See PermissionType
4. See CreateAccessPolicyResponseTypeDef

Usage example with kwargs

kwargs: CreateAccessPolicyRequestRequestTypeDef = {  # (1)
    "accessPolicyIdentity": ...,
    "accessPolicyResource": ...,
    "accessPolicyPermission": ...,
}

parent.create_access_policy(**kwargs)

1. See CreateAccessPolicyRequestRequestTypeDef

create_asset

Creates an asset from an existing asset model.

Type annotations and code completion for session.client("iotsitewise").create_asset method. boto3 documentation

Method definition

await def create_asset(
    self,
    *,
    assetName: str,
    assetModelId: str,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
    assetDescription: str = ...,
) -> CreateAssetResponseTypeDef:  # (1)
    ...

1. See CreateAssetResponseTypeDef

Usage example with kwargs

kwargs: CreateAssetRequestRequestTypeDef = {  # (1)
    "assetName": ...,
    "assetModelId": ...,
}

parent.create_asset(**kwargs)

1. See CreateAssetRequestRequestTypeDef

create_asset_model

Creates an asset model from specified property and hierarchy definitions.

Type annotations and code completion for session.client("iotsitewise").create_asset_model method. boto3 documentation

Method definition

await def create_asset_model(
    self,
    *,
    assetModelName: str,
    assetModelDescription: str = ...,
    assetModelProperties: Sequence[AssetModelPropertyDefinitionTypeDef] = ...,  # (1)
    assetModelHierarchies: Sequence[AssetModelHierarchyDefinitionTypeDef] = ...,  # (2)
    assetModelCompositeModels: Sequence[AssetModelCompositeModelDefinitionTypeDef] = ...,  # (3)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateAssetModelResponseTypeDef:  # (4)
    ...

1. See AssetModelPropertyDefinitionTypeDef
2. See AssetModelHierarchyDefinitionTypeDef
3. See AssetModelCompositeModelDefinitionTypeDef
4. See CreateAssetModelResponseTypeDef

Usage example with kwargs

kwargs: CreateAssetModelRequestRequestTypeDef = {  # (1)
    "assetModelName": ...,
}

parent.create_asset_model(**kwargs)

1. See CreateAssetModelRequestRequestTypeDef

create_bulk_import_job

.

Type annotations and code completion for session.client("iotsitewise").create_bulk_import_job method. boto3 documentation

Method definition

await def create_bulk_import_job(
    self,
    *,
    jobName: str,
    jobRoleArn: str,
    files: Sequence[FileTypeDef],  # (1)
    errorReportLocation: ErrorReportLocationTypeDef,  # (2)
    jobConfiguration: JobConfigurationTypeDef,  # (3)
) -> CreateBulkImportJobResponseTypeDef:  # (4)
    ...

1. See FileTypeDef
2. See ErrorReportLocationTypeDef
3. See JobConfigurationTypeDef
4. See CreateBulkImportJobResponseTypeDef

Usage example with kwargs

kwargs: CreateBulkImportJobRequestRequestTypeDef = {  # (1)
    "jobName": ...,
    "jobRoleArn": ...,
    "files": ...,
    "errorReportLocation": ...,
    "jobConfiguration": ...,
}

parent.create_bulk_import_job(**kwargs)

1. See CreateBulkImportJobRequestRequestTypeDef

create_dashboard

Creates a dashboard in an IoT SiteWise Monitor project.

Type annotations and code completion for session.client("iotsitewise").create_dashboard method. boto3 documentation

Method definition

await def create_dashboard(
    self,
    *,
    projectId: str,
    dashboardName: str,
    dashboardDefinition: str,
    dashboardDescription: str = ...,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateDashboardResponseTypeDef:  # (1)
    ...

1. See CreateDashboardResponseTypeDef

Usage example with kwargs

kwargs: CreateDashboardRequestRequestTypeDef = {  # (1)
    "projectId": ...,
    "dashboardName": ...,
    "dashboardDefinition": ...,
}

parent.create_dashboard(**kwargs)

1. See CreateDashboardRequestRequestTypeDef

create_gateway

Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise.

Type annotations and code completion for session.client("iotsitewise").create_gateway method. boto3 documentation

Method definition

await def create_gateway(
    self,
    *,
    gatewayName: str,
    gatewayPlatform: GatewayPlatformTypeDef,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateGatewayResponseTypeDef:  # (2)
    ...

1. See GatewayPlatformTypeDef
2. See CreateGatewayResponseTypeDef

Usage example with kwargs

kwargs: CreateGatewayRequestRequestTypeDef = {  # (1)
    "gatewayName": ...,
    "gatewayPlatform": ...,
}

parent.create_gateway(**kwargs)

1. See CreateGatewayRequestRequestTypeDef

create_portal

Creates a portal, which can contain projects and dashboards.

Type annotations and code completion for session.client("iotsitewise").create_portal method. boto3 documentation

Method definition

await def create_portal(
    self,
    *,
    portalName: str,
    portalContactEmail: str,
    roleArn: str,
    portalDescription: str = ...,
    clientToken: str = ...,
    portalLogoImageFile: ImageFileTypeDef = ...,  # (1)
    tags: Mapping[str, str] = ...,
    portalAuthMode: AuthModeType = ...,  # (2)
    notificationSenderEmail: str = ...,
    alarms: AlarmsTypeDef = ...,  # (3)
) -> CreatePortalResponseTypeDef:  # (4)
    ...

1. See ImageFileTypeDef
2. See AuthModeType
3. See AlarmsTypeDef
4. See CreatePortalResponseTypeDef

Usage example with kwargs

kwargs: CreatePortalRequestRequestTypeDef = {  # (1)
    "portalName": ...,
    "portalContactEmail": ...,
    "roleArn": ...,
}

parent.create_portal(**kwargs)

1. See CreatePortalRequestRequestTypeDef

create_project

Creates a project in the specified portal.

Type annotations and code completion for session.client("iotsitewise").create_project method. boto3 documentation

Method definition

await def create_project(
    self,
    *,
    portalId: str,
    projectName: str,
    projectDescription: str = ...,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateProjectResponseTypeDef:  # (1)
    ...

1. See CreateProjectResponseTypeDef

Usage example with kwargs

kwargs: CreateProjectRequestRequestTypeDef = {  # (1)
    "portalId": ...,
    "projectName": ...,
}

parent.create_project(**kwargs)

1. See CreateProjectRequestRequestTypeDef

delete_access_policy

Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource.

Type annotations and code completion for session.client("iotsitewise").delete_access_policy method. boto3 documentation

Method definition

await def delete_access_policy(
    self,
    *,
    accessPolicyId: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteAccessPolicyRequestRequestTypeDef = {  # (1)
    "accessPolicyId": ...,
}

parent.delete_access_policy(**kwargs)

1. See DeleteAccessPolicyRequestRequestTypeDef

delete_asset

Deletes an asset.

Type annotations and code completion for session.client("iotsitewise").delete_asset method. boto3 documentation

Method definition

await def delete_asset(
    self,
    *,
    assetId: str,
    clientToken: str = ...,
) -> DeleteAssetResponseTypeDef:  # (1)
    ...

1. See DeleteAssetResponseTypeDef

Usage example with kwargs

kwargs: DeleteAssetRequestRequestTypeDef = {  # (1)
    "assetId": ...,
}

parent.delete_asset(**kwargs)

1. See DeleteAssetRequestRequestTypeDef

delete_asset_model

Deletes an asset model.

Type annotations and code completion for session.client("iotsitewise").delete_asset_model method. boto3 documentation

Method definition

await def delete_asset_model(
    self,
    *,
    assetModelId: str,
    clientToken: str = ...,
) -> DeleteAssetModelResponseTypeDef:  # (1)
    ...

1. See DeleteAssetModelResponseTypeDef

Usage example with kwargs

kwargs: DeleteAssetModelRequestRequestTypeDef = {  # (1)
    "assetModelId": ...,
}

parent.delete_asset_model(**kwargs)

1. See DeleteAssetModelRequestRequestTypeDef

delete_dashboard

Deletes a dashboard from IoT SiteWise Monitor.

Type annotations and code completion for session.client("iotsitewise").delete_dashboard method. boto3 documentation

Method definition

await def delete_dashboard(
    self,
    *,
    dashboardId: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteDashboardRequestRequestTypeDef = {  # (1)
    "dashboardId": ...,
}

parent.delete_dashboard(**kwargs)

1. See DeleteDashboardRequestRequestTypeDef

delete_gateway

Deletes a gateway from IoT SiteWise.

Type annotations and code completion for session.client("iotsitewise").delete_gateway method. boto3 documentation

Method definition

await def delete_gateway(
    self,
    *,
    gatewayId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteGatewayRequestRequestTypeDef = {  # (1)
    "gatewayId": ...,
}

parent.delete_gateway(**kwargs)

1. See DeleteGatewayRequestRequestTypeDef

delete_portal

Deletes a portal from IoT SiteWise Monitor.

Type annotations and code completion for session.client("iotsitewise").delete_portal method. boto3 documentation

Method definition

await def delete_portal(
    self,
    *,
    portalId: str,
    clientToken: str = ...,
) -> DeletePortalResponseTypeDef:  # (1)
    ...

1. See DeletePortalResponseTypeDef

Usage example with kwargs

kwargs: DeletePortalRequestRequestTypeDef = {  # (1)
    "portalId": ...,
}

parent.delete_portal(**kwargs)

1. See DeletePortalRequestRequestTypeDef

delete_project

Deletes a project from IoT SiteWise Monitor.

Type annotations and code completion for session.client("iotsitewise").delete_project method. boto3 documentation

Method definition

await def delete_project(
    self,
    *,
    projectId: str,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteProjectRequestRequestTypeDef = {  # (1)
    "projectId": ...,
}

parent.delete_project(**kwargs)

1. See DeleteProjectRequestRequestTypeDef

delete_time_series

Deletes a time series (data stream).

Type annotations and code completion for session.client("iotsitewise").delete_time_series method. boto3 documentation

Method definition

await def delete_time_series(
    self,
    *,
    alias: str = ...,
    assetId: str = ...,
    propertyId: str = ...,
    clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteTimeSeriesRequestRequestTypeDef = {  # (1)
    "alias": ...,
}

parent.delete_time_series(**kwargs)

1. See DeleteTimeSeriesRequestRequestTypeDef

describe_access_policy

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

Type annotations and code completion for session.client("iotsitewise").describe_access_policy method. boto3 documentation

Method definition

await def describe_access_policy(
    self,
    *,
    accessPolicyId: str,
) -> DescribeAccessPolicyResponseTypeDef:  # (1)
    ...

1. See DescribeAccessPolicyResponseTypeDef

Usage example with kwargs

kwargs: DescribeAccessPolicyRequestRequestTypeDef = {  # (1)
    "accessPolicyId": ...,
}

parent.describe_access_policy(**kwargs)

1. See DescribeAccessPolicyRequestRequestTypeDef

describe_asset

Retrieves information about an asset.

Type annotations and code completion for session.client("iotsitewise").describe_asset method. boto3 documentation

Method definition

await def describe_asset(
    self,
    *,
    assetId: str,
) -> DescribeAssetResponseTypeDef:  # (1)
    ...

1. See DescribeAssetResponseTypeDef

Usage example with kwargs

kwargs: DescribeAssetRequestRequestTypeDef = {  # (1)
    "assetId": ...,
}

parent.describe_asset(**kwargs)

1. See DescribeAssetRequestRequestTypeDef

describe_asset_model

Retrieves information about an asset model.

Type annotations and code completion for session.client("iotsitewise").describe_asset_model method. boto3 documentation

Method definition

await def describe_asset_model(
    self,
    *,
    assetModelId: str,
) -> DescribeAssetModelResponseTypeDef:  # (1)
    ...

1. See DescribeAssetModelResponseTypeDef

Usage example with kwargs

kwargs: DescribeAssetModelRequestRequestTypeDef = {  # (1)
    "assetModelId": ...,
}

parent.describe_asset_model(**kwargs)

1. See DescribeAssetModelRequestRequestTypeDef

describe_asset_property

Retrieves information about an asset property.

Type annotations and code completion for session.client("iotsitewise").describe_asset_property method. boto3 documentation

Method definition

await def describe_asset_property(
    self,
    *,
    assetId: str,
    propertyId: str,
) -> DescribeAssetPropertyResponseTypeDef:  # (1)
    ...

1. See DescribeAssetPropertyResponseTypeDef

Usage example with kwargs

kwargs: DescribeAssetPropertyRequestRequestTypeDef = {  # (1)
    "assetId": ...,
    "propertyId": ...,
}

parent.describe_asset_property(**kwargs)

1. See DescribeAssetPropertyRequestRequestTypeDef

describe_bulk_import_job

.

Type annotations and code completion for session.client("iotsitewise").describe_bulk_import_job method. boto3 documentation

Method definition

await def describe_bulk_import_job(
    self,
    *,
    jobId: str,
) -> DescribeBulkImportJobResponseTypeDef:  # (1)
    ...

1. See DescribeBulkImportJobResponseTypeDef

Usage example with kwargs

kwargs: DescribeBulkImportJobRequestRequestTypeDef = {  # (1)
    "jobId": ...,
}

parent.describe_bulk_import_job(**kwargs)

1. See DescribeBulkImportJobRequestRequestTypeDef

describe_dashboard

Retrieves information about a dashboard.

Type annotations and code completion for session.client("iotsitewise").describe_dashboard method. boto3 documentation

Method definition

await def describe_dashboard(
    self,
    *,
    dashboardId: str,
) -> DescribeDashboardResponseTypeDef:  # (1)
    ...

1. See DescribeDashboardResponseTypeDef

Usage example with kwargs

kwargs: DescribeDashboardRequestRequestTypeDef = {  # (1)
    "dashboardId": ...,
}

parent.describe_dashboard(**kwargs)

1. See DescribeDashboardRequestRequestTypeDef

describe_default_encryption_configuration

Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region.

Type annotations and code completion for session.client("iotsitewise").describe_default_encryption_configuration method. boto3 documentation

Method definition

await def describe_default_encryption_configuration(
    self,
) -> DescribeDefaultEncryptionConfigurationResponseTypeDef:  # (1)
    ...

1. See DescribeDefaultEncryptionConfigurationResponseTypeDef

describe_gateway

Retrieves information about a gateway.

Type annotations and code completion for session.client("iotsitewise").describe_gateway method. boto3 documentation

Method definition

await def describe_gateway(
    self,
    *,
    gatewayId: str,
) -> DescribeGatewayResponseTypeDef:  # (1)
    ...

1. See DescribeGatewayResponseTypeDef

Usage example with kwargs

kwargs: DescribeGatewayRequestRequestTypeDef = {  # (1)
    "gatewayId": ...,
}

parent.describe_gateway(**kwargs)

1. See DescribeGatewayRequestRequestTypeDef

describe_gateway_capability_configuration

Retrieves information about a gateway capability configuration.

Type annotations and code completion for session.client("iotsitewise").describe_gateway_capability_configuration method. boto3 documentation

Method definition

await def describe_gateway_capability_configuration(
    self,
    *,
    gatewayId: str,
    capabilityNamespace: str,
) -> DescribeGatewayCapabilityConfigurationResponseTypeDef:  # (1)
    ...

1. See DescribeGatewayCapabilityConfigurationResponseTypeDef

Usage example with kwargs

kwargs: DescribeGatewayCapabilityConfigurationRequestRequestTypeDef = {  # (1)
    "gatewayId": ...,
    "capabilityNamespace": ...,
}

parent.describe_gateway_capability_configuration(**kwargs)

1. See DescribeGatewayCapabilityConfigurationRequestRequestTypeDef

describe_logging_options

Retrieves the current IoT SiteWise logging options.

Type annotations and code completion for session.client("iotsitewise").describe_logging_options method. boto3 documentation

Method definition

await def describe_logging_options(
    self,
) -> DescribeLoggingOptionsResponseTypeDef:  # (1)
    ...

1. See DescribeLoggingOptionsResponseTypeDef

describe_portal

Retrieves information about a portal.

Type annotations and code completion for session.client("iotsitewise").describe_portal method. boto3 documentation

Method definition

await def describe_portal(
    self,
    *,
    portalId: str,
) -> DescribePortalResponseTypeDef:  # (1)
    ...

1. See DescribePortalResponseTypeDef

Usage example with kwargs

kwargs: DescribePortalRequestRequestTypeDef = {  # (1)
    "portalId": ...,
}

parent.describe_portal(**kwargs)

1. See DescribePortalRequestRequestTypeDef

describe_project

Retrieves information about a project.

Type annotations and code completion for session.client("iotsitewise").describe_project method. boto3 documentation

Method definition

await def describe_project(
    self,
    *,
    projectId: str,
) -> DescribeProjectResponseTypeDef:  # (1)
    ...

1. See DescribeProjectResponseTypeDef

Usage example with kwargs

kwargs: DescribeProjectRequestRequestTypeDef = {  # (1)
    "projectId": ...,
}

parent.describe_project(**kwargs)

1. See DescribeProjectRequestRequestTypeDef

describe_storage_configuration

Retrieves information about the storage configuration for IoT SiteWise.

Type annotations and code completion for session.client("iotsitewise").describe_storage_configuration method. boto3 documentation

Method definition

await def describe_storage_configuration(
    self,
) -> DescribeStorageConfigurationResponseTypeDef:  # (1)
    ...

1. See DescribeStorageConfigurationResponseTypeDef

describe_time_series

Retrieves information about a time series (data stream).

Type annotations and code completion for session.client("iotsitewise").describe_time_series method. boto3 documentation

Method definition

await def describe_time_series(
    self,
    *,
    alias: str = ...,
    assetId: str = ...,
    propertyId: str = ...,
) -> DescribeTimeSeriesResponseTypeDef:  # (1)
    ...

1. See DescribeTimeSeriesResponseTypeDef

Usage example with kwargs

kwargs: DescribeTimeSeriesRequestRequestTypeDef = {  # (1)
    "alias": ...,
}

parent.describe_time_series(**kwargs)

1. See DescribeTimeSeriesRequestRequestTypeDef

disassociate_assets

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

Type annotations and code completion for session.client("iotsitewise").disassociate_assets method. boto3 documentation

Method definition

await def disassociate_assets(
    self,
    *,
    assetId: str,
    hierarchyId: str,
    childAssetId: str,
    clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DisassociateAssetsRequestRequestTypeDef = {  # (1)
    "assetId": ...,
    "hierarchyId": ...,
    "childAssetId": ...,
}

parent.disassociate_assets(**kwargs)

1. See DisassociateAssetsRequestRequestTypeDef

disassociate_time_series_from_asset_property

Disassociates a time series (data stream) from an asset property.

Type annotations and code completion for session.client("iotsitewise").disassociate_time_series_from_asset_property method. boto3 documentation

Method definition

await def disassociate_time_series_from_asset_property(
    self,
    *,
    alias: str,
    assetId: str,
    propertyId: str,
    clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DisassociateTimeSeriesFromAssetPropertyRequestRequestTypeDef = {  # (1)
    "alias": ...,
    "assetId": ...,
    "propertyId": ...,
}

parent.disassociate_time_series_from_asset_property(**kwargs)

1. See DisassociateTimeSeriesFromAssetPropertyRequestRequestTypeDef

generate_presigned_url

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

Type annotations and code completion for session.client("iotsitewise").generate_presigned_url method. boto3 documentation

Method definition

await def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_asset_property_aggregates

Gets aggregated values for an asset property.

Type annotations and code completion for session.client("iotsitewise").get_asset_property_aggregates method. boto3 documentation

Method definition

await def get_asset_property_aggregates(
    self,
    *,
    aggregateTypes: Sequence[AggregateTypeType],  # (1)
    resolution: str,
    startDate: Union[datetime, str],
    endDate: Union[datetime, str],
    assetId: str = ...,
    propertyId: str = ...,
    propertyAlias: str = ...,
    qualities: Sequence[QualityType] = ...,  # (2)
    timeOrdering: TimeOrderingType = ...,  # (3)
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetAssetPropertyAggregatesResponseTypeDef:  # (4)
    ...

1. See AggregateTypeType
2. See QualityType
3. See TimeOrderingType
4. See GetAssetPropertyAggregatesResponseTypeDef

Usage example with kwargs

kwargs: GetAssetPropertyAggregatesRequestRequestTypeDef = {  # (1)
    "aggregateTypes": ...,
    "resolution": ...,
    "startDate": ...,
    "endDate": ...,
}

parent.get_asset_property_aggregates(**kwargs)

1. See GetAssetPropertyAggregatesRequestRequestTypeDef

get_asset_property_value

Gets an asset property's current value.

Type annotations and code completion for session.client("iotsitewise").get_asset_property_value method. boto3 documentation

Method definition

await def get_asset_property_value(
    self,
    *,
    assetId: str = ...,
    propertyId: str = ...,
    propertyAlias: str = ...,
) -> GetAssetPropertyValueResponseTypeDef:  # (1)
    ...

1. See GetAssetPropertyValueResponseTypeDef

Usage example with kwargs

kwargs: GetAssetPropertyValueRequestRequestTypeDef = {  # (1)
    "assetId": ...,
}

parent.get_asset_property_value(**kwargs)

1. See GetAssetPropertyValueRequestRequestTypeDef

get_asset_property_value_history

Gets the history of an asset property's values.

Type annotations and code completion for session.client("iotsitewise").get_asset_property_value_history method. boto3 documentation

Method definition

await def get_asset_property_value_history(
    self,
    *,
    assetId: str = ...,
    propertyId: str = ...,
    propertyAlias: str = ...,
    startDate: Union[datetime, str] = ...,
    endDate: Union[datetime, str] = ...,
    qualities: Sequence[QualityType] = ...,  # (1)
    timeOrdering: TimeOrderingType = ...,  # (2)
    nextToken: str = ...,
    maxResults: int = ...,
) -> GetAssetPropertyValueHistoryResponseTypeDef:  # (3)
    ...

1. See QualityType
2. See TimeOrderingType
3. See GetAssetPropertyValueHistoryResponseTypeDef

Usage example with kwargs

kwargs: GetAssetPropertyValueHistoryRequestRequestTypeDef = {  # (1)
    "assetId": ...,
}

parent.get_asset_property_value_history(**kwargs)

1. See GetAssetPropertyValueHistoryRequestRequestTypeDef

get_interpolated_asset_property_values

Get interpolated values for an asset property for a specified time interval, during a period of time.

Type annotations and code completion for session.client("iotsitewise").get_interpolated_asset_property_values method. boto3 documentation

Method definition

await def get_interpolated_asset_property_values(
    self,
    *,
    startTimeInSeconds: int,
    endTimeInSeconds: int,
    quality: QualityType,  # (1)
    intervalInSeconds: int,
    type: str,
    assetId: str = ...,
    propertyId: str = ...,
    propertyAlias: str = ...,
    startTimeOffsetInNanos: int = ...,
    endTimeOffsetInNanos: int = ...,
    nextToken: str = ...,
    maxResults: int = ...,
    intervalWindowInSeconds: int = ...,
) -> GetInterpolatedAssetPropertyValuesResponseTypeDef:  # (2)
    ...

1. See QualityType
2. See GetInterpolatedAssetPropertyValuesResponseTypeDef

Usage example with kwargs

kwargs: GetInterpolatedAssetPropertyValuesRequestRequestTypeDef = {  # (1)
    "startTimeInSeconds": ...,
    "endTimeInSeconds": ...,
    "quality": ...,
    "intervalInSeconds": ...,
    "type": ...,
}

parent.get_interpolated_asset_property_values(**kwargs)

1. See GetInterpolatedAssetPropertyValuesRequestRequestTypeDef

list_access_policies

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

Type annotations and code completion for session.client("iotsitewise").list_access_policies method. boto3 documentation

Method definition

await def list_access_policies(
    self,
    *,
    identityType: IdentityTypeType = ...,  # (1)
    identityId: str = ...,
    resourceType: ResourceTypeType = ...,  # (2)
    resourceId: str = ...,
    iamArn: str = ...,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAccessPoliciesResponseTypeDef:  # (3)
    ...

1. See IdentityTypeType
2. See ResourceTypeType
3. See ListAccessPoliciesResponseTypeDef

Usage example with kwargs

kwargs: ListAccessPoliciesRequestRequestTypeDef = {  # (1)
    "identityType": ...,
}

parent.list_access_policies(**kwargs)

1. See ListAccessPoliciesRequestRequestTypeDef

list_asset_models

Retrieves a paginated list of summaries of all asset models.

Type annotations and code completion for session.client("iotsitewise").list_asset_models method. boto3 documentation

Method definition

await def list_asset_models(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAssetModelsResponseTypeDef:  # (1)
    ...

1. See ListAssetModelsResponseTypeDef

Usage example with kwargs

kwargs: ListAssetModelsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_asset_models(**kwargs)

1. See ListAssetModelsRequestRequestTypeDef

list_asset_relationships

Retrieves a paginated list of asset relationships for an asset.

Type annotations and code completion for session.client("iotsitewise").list_asset_relationships method. boto3 documentation

Method definition

await def list_asset_relationships(
    self,
    *,
    assetId: str,
    traversalType: TraversalTypeType,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAssetRelationshipsResponseTypeDef:  # (2)
    ...

1. See TraversalTypeType
2. See ListAssetRelationshipsResponseTypeDef

Usage example with kwargs

kwargs: ListAssetRelationshipsRequestRequestTypeDef = {  # (1)
    "assetId": ...,
    "traversalType": ...,
}

parent.list_asset_relationships(**kwargs)

1. See ListAssetRelationshipsRequestRequestTypeDef

list_assets

Retrieves a paginated list of asset summaries.

Type annotations and code completion for session.client("iotsitewise").list_assets method. boto3 documentation

Method definition

await def list_assets(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    assetModelId: str = ...,
    filter: ListAssetsFilterType = ...,  # (1)
) -> ListAssetsResponseTypeDef:  # (2)
    ...

1. See ListAssetsFilterType
2. See ListAssetsResponseTypeDef

Usage example with kwargs

kwargs: ListAssetsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_assets(**kwargs)

1. See ListAssetsRequestRequestTypeDef

list_associated_assets

Retrieves a paginated list of associated assets.

Type annotations and code completion for session.client("iotsitewise").list_associated_assets method. boto3 documentation

Method definition

await def list_associated_assets(
    self,
    *,
    assetId: str,
    hierarchyId: str = ...,
    traversalDirection: TraversalDirectionType = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAssociatedAssetsResponseTypeDef:  # (2)
    ...

1. See TraversalDirectionType
2. See ListAssociatedAssetsResponseTypeDef

Usage example with kwargs

kwargs: ListAssociatedAssetsRequestRequestTypeDef = {  # (1)
    "assetId": ...,
}

parent.list_associated_assets(**kwargs)

1. See ListAssociatedAssetsRequestRequestTypeDef

list_bulk_import_jobs

.

Type annotations and code completion for session.client("iotsitewise").list_bulk_import_jobs method. boto3 documentation

Method definition

await def list_bulk_import_jobs(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    filter: ListBulkImportJobsFilterType = ...,  # (1)
) -> ListBulkImportJobsResponseTypeDef:  # (2)
    ...

1. See ListBulkImportJobsFilterType
2. See ListBulkImportJobsResponseTypeDef

Usage example with kwargs

kwargs: ListBulkImportJobsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_bulk_import_jobs(**kwargs)

1. See ListBulkImportJobsRequestRequestTypeDef

list_dashboards

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

Type annotations and code completion for session.client("iotsitewise").list_dashboards method. boto3 documentation

Method definition

await def list_dashboards(
    self,
    *,
    projectId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDashboardsResponseTypeDef:  # (1)
    ...

1. See ListDashboardsResponseTypeDef

Usage example with kwargs

kwargs: ListDashboardsRequestRequestTypeDef = {  # (1)
    "projectId": ...,
}

parent.list_dashboards(**kwargs)

1. See ListDashboardsRequestRequestTypeDef

list_gateways

Retrieves a paginated list of gateways.

Type annotations and code completion for session.client("iotsitewise").list_gateways method. boto3 documentation

Method definition

await def list_gateways(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListGatewaysResponseTypeDef:  # (1)
    ...

1. See ListGatewaysResponseTypeDef

Usage example with kwargs

kwargs: ListGatewaysRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_gateways(**kwargs)

1. See ListGatewaysRequestRequestTypeDef

list_portals

Retrieves a paginated list of IoT SiteWise Monitor portals.

Type annotations and code completion for session.client("iotsitewise").list_portals method. boto3 documentation

Method definition

await def list_portals(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListPortalsResponseTypeDef:  # (1)
    ...

1. See ListPortalsResponseTypeDef

Usage example with kwargs

kwargs: ListPortalsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_portals(**kwargs)

1. See ListPortalsRequestRequestTypeDef

list_project_assets

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

Type annotations and code completion for session.client("iotsitewise").list_project_assets method. boto3 documentation

Method definition

await def list_project_assets(
    self,
    *,
    projectId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListProjectAssetsResponseTypeDef:  # (1)
    ...

1. See ListProjectAssetsResponseTypeDef

Usage example with kwargs

kwargs: ListProjectAssetsRequestRequestTypeDef = {  # (1)
    "projectId": ...,
}

parent.list_project_assets(**kwargs)

1. See ListProjectAssetsRequestRequestTypeDef

list_projects

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

Type annotations and code completion for session.client("iotsitewise").list_projects method. boto3 documentation

Method definition

await def list_projects(
    self,
    *,
    portalId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListProjectsResponseTypeDef:  # (1)
    ...

1. See ListProjectsResponseTypeDef

Usage example with kwargs

kwargs: ListProjectsRequestRequestTypeDef = {  # (1)
    "portalId": ...,
}

parent.list_projects(**kwargs)

1. See ListProjectsRequestRequestTypeDef

list_tags_for_resource

Retrieves the list of tags for an IoT SiteWise resource.

Type annotations and code completion for session.client("iotsitewise").list_tags_for_resource method. boto3 documentation

Method definition

await def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

list_time_series

Retrieves a paginated list of time series (data streams).

Type annotations and code completion for session.client("iotsitewise").list_time_series method. boto3 documentation

Method definition

await def list_time_series(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    assetId: str = ...,
    aliasPrefix: str = ...,
    timeSeriesType: ListTimeSeriesTypeType = ...,  # (1)
) -> ListTimeSeriesResponseTypeDef:  # (2)
    ...

1. See ListTimeSeriesTypeType
2. See ListTimeSeriesResponseTypeDef

Usage example with kwargs

kwargs: ListTimeSeriesRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_time_series(**kwargs)

1. See ListTimeSeriesRequestRequestTypeDef

put_default_encryption_configuration

Sets the default encryption configuration for the Amazon Web Services account.

Type annotations and code completion for session.client("iotsitewise").put_default_encryption_configuration method. boto3 documentation

Method definition

await def put_default_encryption_configuration(
    self,
    *,
    encryptionType: EncryptionTypeType,  # (1)
    kmsKeyId: str = ...,
) -> PutDefaultEncryptionConfigurationResponseTypeDef:  # (2)
    ...

1. See EncryptionTypeType
2. See PutDefaultEncryptionConfigurationResponseTypeDef

Usage example with kwargs

kwargs: PutDefaultEncryptionConfigurationRequestRequestTypeDef = {  # (1)
    "encryptionType": ...,
}

parent.put_default_encryption_configuration(**kwargs)

1. See PutDefaultEncryptionConfigurationRequestRequestTypeDef

put_logging_options

Sets logging options for IoT SiteWise.

Type annotations and code completion for session.client("iotsitewise").put_logging_options method. boto3 documentation

Method definition

await def put_logging_options(
    self,
    *,
    loggingOptions: LoggingOptionsTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

1. See LoggingOptionsTypeDef

Usage example with kwargs

kwargs: PutLoggingOptionsRequestRequestTypeDef = {  # (1)
    "loggingOptions": ...,
}

parent.put_logging_options(**kwargs)

1. See PutLoggingOptionsRequestRequestTypeDef

put_storage_configuration

Configures storage settings for IoT SiteWise.

Type annotations and code completion for session.client("iotsitewise").put_storage_configuration method. boto3 documentation

Method definition

await def put_storage_configuration(
    self,
    *,
    storageType: StorageTypeType,  # (1)
    multiLayerStorage: MultiLayerStorageTypeDef = ...,  # (2)
    disassociatedDataStorage: DisassociatedDataStorageStateType = ...,  # (3)
    retentionPeriod: RetentionPeriodTypeDef = ...,  # (4)
) -> PutStorageConfigurationResponseTypeDef:  # (5)
    ...

1. See StorageTypeType
2. See MultiLayerStorageTypeDef
3. See DisassociatedDataStorageStateType
4. See RetentionPeriodTypeDef
5. See PutStorageConfigurationResponseTypeDef

Usage example with kwargs

kwargs: PutStorageConfigurationRequestRequestTypeDef = {  # (1)
    "storageType": ...,
}

parent.put_storage_configuration(**kwargs)

1. See PutStorageConfigurationRequestRequestTypeDef

tag_resource

Adds tags to an IoT SiteWise resource.

Type annotations and code completion for session.client("iotsitewise").tag_resource method. boto3 documentation

Method definition

await def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes a tag from an IoT SiteWise resource.

Type annotations and code completion for session.client("iotsitewise").untag_resource method. boto3 documentation

Method definition

await def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_access_policy

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

Type annotations and code completion for session.client("iotsitewise").update_access_policy method. boto3 documentation

Method definition

await def update_access_policy(
    self,
    *,
    accessPolicyId: str,
    accessPolicyIdentity: IdentityTypeDef,  # (1)
    accessPolicyResource: ResourceTypeDef,  # (2)
    accessPolicyPermission: PermissionType,  # (3)
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

1. See IdentityTypeDef
2. See ResourceTypeDef
3. See PermissionType

Usage example with kwargs

kwargs: UpdateAccessPolicyRequestRequestTypeDef = {  # (1)
    "accessPolicyId": ...,
    "accessPolicyIdentity": ...,
    "accessPolicyResource": ...,
    "accessPolicyPermission": ...,
}

parent.update_access_policy(**kwargs)

1. See UpdateAccessPolicyRequestRequestTypeDef

update_asset

Updates an asset's name.

Type annotations and code completion for session.client("iotsitewise").update_asset method. boto3 documentation

Method definition

await def update_asset(
    self,
    *,
    assetId: str,
    assetName: str,
    clientToken: str = ...,
    assetDescription: str = ...,
) -> UpdateAssetResponseTypeDef:  # (1)
    ...

1. See UpdateAssetResponseTypeDef

Usage example with kwargs

kwargs: UpdateAssetRequestRequestTypeDef = {  # (1)
    "assetId": ...,
    "assetName": ...,
}

parent.update_asset(**kwargs)

1. See UpdateAssetRequestRequestTypeDef

update_asset_model

Updates an asset model and all of the assets that were created from the model.

Type annotations and code completion for session.client("iotsitewise").update_asset_model method. boto3 documentation

Method definition

await def update_asset_model(
    self,
    *,
    assetModelId: str,
    assetModelName: str,
    assetModelDescription: str = ...,
    assetModelProperties: Sequence[AssetModelPropertyTypeDef] = ...,  # (1)
    assetModelHierarchies: Sequence[AssetModelHierarchyTypeDef] = ...,  # (2)
    assetModelCompositeModels: Sequence[AssetModelCompositeModelTypeDef] = ...,  # (3)
    clientToken: str = ...,
) -> UpdateAssetModelResponseTypeDef:  # (4)
    ...

1. See AssetModelPropertyTypeDef
2. See AssetModelHierarchyTypeDef
3. See AssetModelCompositeModelTypeDef
4. See UpdateAssetModelResponseTypeDef

Usage example with kwargs

kwargs: UpdateAssetModelRequestRequestTypeDef = {  # (1)
    "assetModelId": ...,
    "assetModelName": ...,
}

parent.update_asset_model(**kwargs)

1. See UpdateAssetModelRequestRequestTypeDef

update_asset_property

Updates an asset property's alias and notification state.

Type annotations and code completion for session.client("iotsitewise").update_asset_property method. boto3 documentation

Method definition

await def update_asset_property(
    self,
    *,
    assetId: str,
    propertyId: str,
    propertyAlias: str = ...,
    propertyNotificationState: PropertyNotificationStateType = ...,  # (1)
    clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See PropertyNotificationStateType
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: UpdateAssetPropertyRequestRequestTypeDef = {  # (1)
    "assetId": ...,
    "propertyId": ...,
}

parent.update_asset_property(**kwargs)

1. See UpdateAssetPropertyRequestRequestTypeDef

update_dashboard

Updates an IoT SiteWise Monitor dashboard.

Type annotations and code completion for session.client("iotsitewise").update_dashboard method. boto3 documentation

Method definition

await def update_dashboard(
    self,
    *,
    dashboardId: str,
    dashboardName: str,
    dashboardDefinition: str,
    dashboardDescription: str = ...,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UpdateDashboardRequestRequestTypeDef = {  # (1)
    "dashboardId": ...,
    "dashboardName": ...,
    "dashboardDefinition": ...,
}

parent.update_dashboard(**kwargs)

1. See UpdateDashboardRequestRequestTypeDef

update_gateway

Updates a gateway's name.

Type annotations and code completion for session.client("iotsitewise").update_gateway method. boto3 documentation

Method definition

await def update_gateway(
    self,
    *,
    gatewayId: str,
    gatewayName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: UpdateGatewayRequestRequestTypeDef = {  # (1)
    "gatewayId": ...,
    "gatewayName": ...,
}

parent.update_gateway(**kwargs)

1. See UpdateGatewayRequestRequestTypeDef

update_gateway_capability_configuration

Updates a gateway capability configuration or defines a new capability configuration.

Type annotations and code completion for session.client("iotsitewise").update_gateway_capability_configuration method. boto3 documentation

Method definition

await def update_gateway_capability_configuration(
    self,
    *,
    gatewayId: str,
    capabilityNamespace: str,
    capabilityConfiguration: str,
) -> UpdateGatewayCapabilityConfigurationResponseTypeDef:  # (1)
    ...

1. See UpdateGatewayCapabilityConfigurationResponseTypeDef

Usage example with kwargs

kwargs: UpdateGatewayCapabilityConfigurationRequestRequestTypeDef = {  # (1)
    "gatewayId": ...,
    "capabilityNamespace": ...,
    "capabilityConfiguration": ...,
}

parent.update_gateway_capability_configuration(**kwargs)

1. See UpdateGatewayCapabilityConfigurationRequestRequestTypeDef

update_portal

Updates an IoT SiteWise Monitor portal.

Type annotations and code completion for session.client("iotsitewise").update_portal method. boto3 documentation

Method definition

await def update_portal(
    self,
    *,
    portalId: str,
    portalName: str,
    portalContactEmail: str,
    roleArn: str,
    portalDescription: str = ...,
    portalLogoImage: ImageTypeDef = ...,  # (1)
    clientToken: str = ...,
    notificationSenderEmail: str = ...,
    alarms: AlarmsTypeDef = ...,  # (2)
) -> UpdatePortalResponseTypeDef:  # (3)
    ...

1. See ImageTypeDef
2. See AlarmsTypeDef
3. See UpdatePortalResponseTypeDef

Usage example with kwargs

kwargs: UpdatePortalRequestRequestTypeDef = {  # (1)
    "portalId": ...,
    "portalName": ...,
    "portalContactEmail": ...,
    "roleArn": ...,
}

parent.update_portal(**kwargs)

1. See UpdatePortalRequestRequestTypeDef

update_project

Updates an IoT SiteWise Monitor project.

Type annotations and code completion for session.client("iotsitewise").update_project method. boto3 documentation

Method definition

await def update_project(
    self,
    *,
    projectId: str,
    projectName: str,
    projectDescription: str = ...,
    clientToken: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UpdateProjectRequestRequestTypeDef = {  # (1)
    "projectId": ...,
    "projectName": ...,
}

parent.update_project(**kwargs)

1. See UpdateProjectRequestRequestTypeDef

__aenter__

Type annotations and code completion for session.client("iotsitewise").__aenter__ method. boto3 documentation

Method definition

await def __aenter__(
    self,
) -> IoTSiteWiseClient:
    ...

__aexit__

Type annotations and code completion for session.client("iotsitewise").__aexit__ method. boto3 documentation

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

Type annotations and code completion for session.client("iotsitewise").get_paginator method with overloads.

• client.get_paginator("get_asset_property_aggregates") -> GetAssetPropertyAggregatesPaginator
• client.get_paginator("get_asset_property_value_history") -> GetAssetPropertyValueHistoryPaginator
• client.get_paginator("get_interpolated_asset_property_values") -> GetInterpolatedAssetPropertyValuesPaginator
• client.get_paginator("list_access_policies") -> ListAccessPoliciesPaginator
• client.get_paginator("list_asset_models") -> ListAssetModelsPaginator
• client.get_paginator("list_asset_relationships") -> ListAssetRelationshipsPaginator
• client.get_paginator("list_assets") -> ListAssetsPaginator
• client.get_paginator("list_associated_assets") -> ListAssociatedAssetsPaginator
• client.get_paginator("list_bulk_import_jobs") -> ListBulkImportJobsPaginator
• client.get_paginator("list_dashboards") -> ListDashboardsPaginator
• client.get_paginator("list_gateways") -> ListGatewaysPaginator
• client.get_paginator("list_portals") -> ListPortalsPaginator
• client.get_paginator("list_project_assets") -> ListProjectAssetsPaginator
• client.get_paginator("list_projects") -> ListProjectsPaginator
• client.get_paginator("list_time_series") -> ListTimeSeriesPaginator

get_waiter

Type annotations and code completion for session.client("iotsitewise").get_waiter method with overloads.

• client.get_waiter("asset_active") -> AssetActiveWaiter
• client.get_waiter("asset_model_active") -> AssetModelActiveWaiter
• client.get_waiter("asset_model_not_exists") -> AssetModelNotExistsWaiter
• client.get_waiter("asset_not_exists") -> AssetNotExistsWaiter
• client.get_waiter("portal_active") -> PortalActiveWaiter
• client.get_waiter("portal_not_exists") -> PortalNotExistsWaiter