Skip to content

IoTSiteWiseClient

Index > IoTSiteWise > IoTSiteWiseClient

Auto-generated documentation for IoTSiteWise type annotations stubs module mypy-boto3-iotsitewise.

IoTSiteWiseClient

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

Usage example
from boto3.session import Session
from mypy_boto3_iotsitewise.client import IoTSiteWiseClient

def get_iotsitewise_client() -> IoTSiteWiseClient:
    return Session().client("iotsitewise")

Exceptions

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

Usage example
client = boto3.client("iotsitewise")

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 mypy_boto3_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 boto3.client("iotsitewise").associate_assets method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").associate_time_series_to_asset_property method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").batch_associate_project_assets method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").batch_disassociate_project_assets method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").batch_get_asset_property_aggregates method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").batch_get_asset_property_value method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").batch_get_asset_property_value_history method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").batch_put_asset_property_value method. boto3 documentation

Method definition
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 boto3.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 boto3.client("iotsitewise").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

create_access_policy

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

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

Method definition
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 boto3.client("iotsitewise").create_asset method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").create_asset_model method. boto3 documentation

Method definition
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

Defines a job to ingest data to IoT SiteWise from Amazon S3.

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

Method definition
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 boto3.client("iotsitewise").create_dashboard method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").create_gateway method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").create_portal method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").create_project method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").delete_access_policy method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").delete_asset method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").delete_asset_model method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").delete_dashboard method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").delete_gateway method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").delete_portal method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").delete_project method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").delete_time_series method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").describe_access_policy method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").describe_asset method. boto3 documentation

Method definition
def describe_asset(
    self,
    *,
    assetId: str,
    excludeProperties: bool = ...,
) -> 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 boto3.client("iotsitewise").describe_asset_model method. boto3 documentation

Method definition
def describe_asset_model(
    self,
    *,
    assetModelId: str,
    excludeProperties: bool = ...,
) -> 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 boto3.client("iotsitewise").describe_asset_property method. boto3 documentation

Method definition
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

Retrieves information about a bulk import job request.

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

Method definition
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 boto3.client("iotsitewise").describe_dashboard method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").describe_default_encryption_configuration method. boto3 documentation

Method definition
def describe_default_encryption_configuration(
    self,
) -> DescribeDefaultEncryptionConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeDefaultEncryptionConfigurationResponseTypeDef

describe_gateway

Retrieves information about a gateway.

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

Method definition
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 boto3.client("iotsitewise").describe_gateway_capability_configuration method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").describe_logging_options method. boto3 documentation

Method definition
def describe_logging_options(
    self,
) -> DescribeLoggingOptionsResponseTypeDef:  # (1)
    ...
  1. See DescribeLoggingOptionsResponseTypeDef

describe_portal

Retrieves information about a portal.

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

Method definition
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 boto3.client("iotsitewise").describe_project method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").describe_storage_configuration method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").describe_time_series method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").disassociate_assets method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").disassociate_time_series_from_asset_property method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").generate_presigned_url method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").get_asset_property_aggregates method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").get_asset_property_value method. boto3 documentation

Method definition
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 boto3.client("iotsitewise").get_asset_property_value_history method.