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
# IoTSiteWiseClient 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.
# IoTSiteWiseClient.exceptions usage example
async with session.client("iotsitewise") as client:
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictingOperationException,
client.exceptions.InternalFailureException,
client.exceptions.InvalidRequestException,
client.exceptions.LimitExceededException,
client.exceptions.QueryTimeoutException,
client.exceptions.ResourceAlreadyExistsException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceUnavailableException,
client.exceptions.ThrottlingException,
client.exceptions.TooManyTagsException,
client.exceptions.UnauthorizedException,
client.exceptions.ValidationException,
) as e:
print(e)
# IoTSiteWiseClient.exceptions type checking example
from types_aiobotocore_iotsitewise.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> 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
# associate_assets method definition
await def associate_assets(
self,
*,
assetId: str,
hierarchyId: str,
childAssetId: str,
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# associate_assets method usage example with argument unpacking
kwargs: AssociateAssetsRequestRequestTypeDef = { # (1)
"assetId": ...,
"hierarchyId": ...,
"childAssetId": ...,
}
parent.associate_assets(**kwargs)
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
# associate_time_series_to_asset_property method definition
await def associate_time_series_to_asset_property(
self,
*,
alias: str,
assetId: str,
propertyId: str,
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# associate_time_series_to_asset_property method usage example with argument unpacking
kwargs: AssociateTimeSeriesToAssetPropertyRequestRequestTypeDef = { # (1)
"alias": ...,
"assetId": ...,
"propertyId": ...,
}
parent.associate_time_series_to_asset_property(**kwargs)
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
# batch_associate_project_assets method definition
await def batch_associate_project_assets(
self,
*,
projectId: str,
assetIds: Sequence[str],
clientToken: str = ...,
) -> BatchAssociateProjectAssetsResponseTypeDef: # (1)
...
# batch_associate_project_assets method usage example with argument unpacking
kwargs: BatchAssociateProjectAssetsRequestRequestTypeDef = { # (1)
"projectId": ...,
"assetIds": ...,
}
parent.batch_associate_project_assets(**kwargs)
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
# batch_disassociate_project_assets method definition
await def batch_disassociate_project_assets(
self,
*,
projectId: str,
assetIds: Sequence[str],
clientToken: str = ...,
) -> BatchDisassociateProjectAssetsResponseTypeDef: # (1)
...
# batch_disassociate_project_assets method usage example with argument unpacking
kwargs: BatchDisassociateProjectAssetsRequestRequestTypeDef = { # (1)
"projectId": ...,
"assetIds": ...,
}
parent.batch_disassociate_project_assets(**kwargs)
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
# batch_get_asset_property_aggregates method definition
await def batch_get_asset_property_aggregates(
self,
*,
entries: Sequence[BatchGetAssetPropertyAggregatesEntryTypeDef], # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> BatchGetAssetPropertyAggregatesResponseTypeDef: # (2)
...
# batch_get_asset_property_aggregates method usage example with argument unpacking
kwargs: BatchGetAssetPropertyAggregatesRequestRequestTypeDef = { # (1)
"entries": ...,
}
parent.batch_get_asset_property_aggregates(**kwargs)
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
# batch_get_asset_property_value method definition
await def batch_get_asset_property_value(
self,
*,
entries: Sequence[BatchGetAssetPropertyValueEntryTypeDef], # (1)
nextToken: str = ...,
) -> BatchGetAssetPropertyValueResponseTypeDef: # (2)
...
# batch_get_asset_property_value method usage example with argument unpacking
kwargs: BatchGetAssetPropertyValueRequestRequestTypeDef = { # (1)
"entries": ...,
}
parent.batch_get_asset_property_value(**kwargs)
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
# batch_get_asset_property_value_history method definition
await def batch_get_asset_property_value_history(
self,
*,
entries: Sequence[BatchGetAssetPropertyValueHistoryEntryTypeDef], # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> BatchGetAssetPropertyValueHistoryResponseTypeDef: # (2)
...
- See BatchGetAssetPropertyValueHistoryEntryTypeDef
- See BatchGetAssetPropertyValueHistoryResponseTypeDef
# batch_get_asset_property_value_history method usage example with argument unpacking
kwargs: BatchGetAssetPropertyValueHistoryRequestRequestTypeDef = { # (1)
"entries": ...,
}
parent.batch_get_asset_property_value_history(**kwargs)
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
# batch_put_asset_property_value method definition
await def batch_put_asset_property_value(
self,
*,
entries: Sequence[PutAssetPropertyValueEntryTypeDef], # (1)
) -> BatchPutAssetPropertyValueResponseTypeDef: # (2)
...
# batch_put_asset_property_value method usage example with argument unpacking
kwargs: BatchPutAssetPropertyValueRequestRequestTypeDef = { # (1)
"entries": ...,
}
parent.batch_put_asset_property_value(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for session.client("iotsitewise").can_paginate
method.
boto3 documentation
# can_paginate 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
# close method definition
await 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 session.client("iotsitewise").create_access_policy
method.
boto3 documentation
# create_access_policy 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)
...
# create_access_policy method usage example with argument unpacking
kwargs: CreateAccessPolicyRequestRequestTypeDef = { # (1)
"accessPolicyIdentity": ...,
"accessPolicyResource": ...,
"accessPolicyPermission": ...,
}
parent.create_access_policy(**kwargs)
create_asset#
Creates an asset from an existing asset model.
Type annotations and code completion for session.client("iotsitewise").create_asset
method.
boto3 documentation
# create_asset method definition
await def create_asset(
self,
*,
assetName: str,
assetModelId: str,
clientToken: str = ...,
tags: Mapping[str, str] = ...,
assetDescription: str = ...,
assetId: str = ...,
assetExternalId: str = ...,
) -> CreateAssetResponseTypeDef: # (1)
...
# create_asset method usage example with argument unpacking
kwargs: CreateAssetRequestRequestTypeDef = { # (1)
"assetName": ...,
"assetModelId": ...,
}
parent.create_asset(**kwargs)
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
# create_asset_model 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] = ...,
assetModelId: str = ...,
assetModelExternalId: str = ...,
assetModelType: AssetModelTypeType = ..., # (4)
) -> CreateAssetModelResponseTypeDef: # (5)
...
- See AssetModelPropertyDefinitionTypeDef
- See AssetModelHierarchyDefinitionTypeDef
- See AssetModelCompositeModelDefinitionTypeDef
- See AssetModelTypeType
- See CreateAssetModelResponseTypeDef
# create_asset_model method usage example with argument unpacking
kwargs: CreateAssetModelRequestRequestTypeDef = { # (1)
"assetModelName": ...,
}
parent.create_asset_model(**kwargs)
create_asset_model_composite_model#
Creates a custom composite model from specified property and hierarchy definitions.
Type annotations and code completion for session.client("iotsitewise").create_asset_model_composite_model
method.
boto3 documentation
# create_asset_model_composite_model method definition
await def create_asset_model_composite_model(
self,
*,
assetModelId: str,
assetModelCompositeModelName: str,
assetModelCompositeModelType: str,
parentAssetModelCompositeModelId: str = ...,
assetModelCompositeModelExternalId: str = ...,
assetModelCompositeModelId: str = ...,
assetModelCompositeModelDescription: str = ...,
clientToken: str = ...,
composedAssetModelId: str = ...,
assetModelCompositeModelProperties: Sequence[AssetModelPropertyDefinitionTypeDef] = ..., # (1)
) -> CreateAssetModelCompositeModelResponseTypeDef: # (2)
...
# create_asset_model_composite_model method usage example with argument unpacking
kwargs: CreateAssetModelCompositeModelRequestRequestTypeDef = { # (1)
"assetModelId": ...,
"assetModelCompositeModelName": ...,
"assetModelCompositeModelType": ...,
}
parent.create_asset_model_composite_model(**kwargs)
create_bulk_import_job#
Defines a job to ingest data to IoT SiteWise from Amazon S3.
Type annotations and code completion for session.client("iotsitewise").create_bulk_import_job
method.
boto3 documentation
# create_bulk_import_job method definition
await def create_bulk_import_job(
self,
*,
jobName: str,
jobRoleArn: str,
files: Sequence[FileTypeDef], # (1)
errorReportLocation: ErrorReportLocationTypeDef, # (2)
jobConfiguration: JobConfigurationTypeDef, # (3)
adaptiveIngestion: bool = ...,
deleteFilesAfterImport: bool = ...,
) -> CreateBulkImportJobResponseTypeDef: # (4)
...
- See FileTypeDef
- See ErrorReportLocationTypeDef
- See JobConfigurationTypeDef
- See CreateBulkImportJobResponseTypeDef
# create_bulk_import_job method usage example with argument unpacking
kwargs: CreateBulkImportJobRequestRequestTypeDef = { # (1)
"jobName": ...,
"jobRoleArn": ...,
"files": ...,
"errorReportLocation": ...,
"jobConfiguration": ...,
}
parent.create_bulk_import_job(**kwargs)
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
# create_dashboard method definition
await def create_dashboard(
self,
*,
projectId: str,
dashboardName: str,
dashboardDefinition: str,
dashboardDescription: str = ...,
clientToken: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateDashboardResponseTypeDef: # (1)
...
# create_dashboard method usage example with argument unpacking
kwargs: CreateDashboardRequestRequestTypeDef = { # (1)
"projectId": ...,
"dashboardName": ...,
"dashboardDefinition": ...,
}
parent.create_dashboard(**kwargs)
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
# create_gateway method definition
await def create_gateway(
self,
*,
gatewayName: str,
gatewayPlatform: GatewayPlatformTypeDef, # (1)
tags: Mapping[str, str] = ...,
) -> CreateGatewayResponseTypeDef: # (2)
...
# create_gateway method usage example with argument unpacking
kwargs: CreateGatewayRequestRequestTypeDef = { # (1)
"gatewayName": ...,
"gatewayPlatform": ...,
}
parent.create_gateway(**kwargs)
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
# create_portal 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)
...
- See ImageFileTypeDef
- See AuthModeType
- See AlarmsTypeDef
- See CreatePortalResponseTypeDef
# create_portal method usage example with argument unpacking
kwargs: CreatePortalRequestRequestTypeDef = { # (1)
"portalName": ...,
"portalContactEmail": ...,
"roleArn": ...,
}
parent.create_portal(**kwargs)
create_project#
Creates a project in the specified portal.
Type annotations and code completion for session.client("iotsitewise").create_project
method.
boto3 documentation
# create_project method definition
await def create_project(
self,
*,
portalId: str,
projectName: str,
projectDescription: str = ...,
clientToken: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateProjectResponseTypeDef: # (1)
...
# create_project method usage example with argument unpacking
kwargs: CreateProjectRequestRequestTypeDef = { # (1)
"portalId": ...,
"projectName": ...,
}
parent.create_project(**kwargs)
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
# delete_access_policy method definition
await def delete_access_policy(
self,
*,
accessPolicyId: str,
clientToken: str = ...,
) -> Dict[str, Any]:
...
# delete_access_policy method usage example with argument unpacking
kwargs: DeleteAccessPolicyRequestRequestTypeDef = { # (1)
"accessPolicyId": ...,
}
parent.delete_access_policy(**kwargs)
delete_asset#
Deletes an asset.
Type annotations and code completion for session.client("iotsitewise").delete_asset
method.
boto3 documentation
# delete_asset method definition
await def delete_asset(
self,
*,
assetId: str,
clientToken: str = ...,
) -> DeleteAssetResponseTypeDef: # (1)
...
# delete_asset method usage example with argument unpacking
kwargs: DeleteAssetRequestRequestTypeDef = { # (1)
"assetId": ...,
}
parent.delete_asset(**kwargs)
delete_asset_model#
Deletes an asset model.
Type annotations and code completion for session.client("iotsitewise").delete_asset_model
method.
boto3 documentation
# delete_asset_model method definition
await def delete_asset_model(
self,
*,
assetModelId: str,
clientToken: str = ...,
) -> DeleteAssetModelResponseTypeDef: # (1)
...
# delete_asset_model method usage example with argument unpacking
kwargs: DeleteAssetModelRequestRequestTypeDef = { # (1)
"assetModelId": ...,
}
parent.delete_asset_model(**kwargs)
delete_asset_model_composite_model#
Deletes a composite model.
Type annotations and code completion for session.client("iotsitewise").delete_asset_model_composite_model
method.
boto3 documentation
# delete_asset_model_composite_model method definition
await def delete_asset_model_composite_model(
self,
*,
assetModelId: str,
assetModelCompositeModelId: str,
clientToken: str = ...,
) -> DeleteAssetModelCompositeModelResponseTypeDef: # (1)
...
# delete_asset_model_composite_model method usage example with argument unpacking
kwargs: DeleteAssetModelCompositeModelRequestRequestTypeDef = { # (1)
"assetModelId": ...,
"assetModelCompositeModelId": ...,
}
parent.delete_asset_model_composite_model(**kwargs)
delete_dashboard#
Deletes a dashboard from IoT SiteWise Monitor.
Type annotations and code completion for session.client("iotsitewise").delete_dashboard
method.
boto3 documentation
# delete_dashboard method definition
await def delete_dashboard(
self,
*,
dashboardId: str,
clientToken: str = ...,
) -> Dict[str, Any]:
...
# delete_dashboard method usage example with argument unpacking
kwargs: DeleteDashboardRequestRequestTypeDef = { # (1)
"dashboardId": ...,
}
parent.delete_dashboard(**kwargs)
delete_gateway#
Deletes a gateway from IoT SiteWise.
Type annotations and code completion for session.client("iotsitewise").delete_gateway
method.
boto3 documentation
# delete_gateway method definition
await def delete_gateway(
self,
*,
gatewayId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_gateway method usage example with argument unpacking
kwargs: DeleteGatewayRequestRequestTypeDef = { # (1)
"gatewayId": ...,
}
parent.delete_gateway(**kwargs)
delete_portal#
Deletes a portal from IoT SiteWise Monitor.
Type annotations and code completion for session.client("iotsitewise").delete_portal
method.
boto3 documentation
# delete_portal method definition
await def delete_portal(
self,
*,
portalId: str,
clientToken: str = ...,
) -> DeletePortalResponseTypeDef: # (1)
...
# delete_portal method usage example with argument unpacking
kwargs: DeletePortalRequestRequestTypeDef = { # (1)
"portalId": ...,
}
parent.delete_portal(**kwargs)
delete_project#
Deletes a project from IoT SiteWise Monitor.
Type annotations and code completion for session.client("iotsitewise").delete_project
method.
boto3 documentation
# delete_project method definition
await def delete_project(
self,
*,
projectId: str,
clientToken: str = ...,
) -> Dict[str, Any]:
...
# delete_project method usage example with argument unpacking
kwargs: DeleteProjectRequestRequestTypeDef = { # (1)
"projectId": ...,
}
parent.delete_project(**kwargs)
delete_time_series#
Deletes a time series (data stream).
Type annotations and code completion for session.client("iotsitewise").delete_time_series
method.
boto3 documentation
# delete_time_series method definition
await def delete_time_series(
self,
*,
alias: str = ...,
assetId: str = ...,
propertyId: str = ...,
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_time_series method usage example with argument unpacking
kwargs: DeleteTimeSeriesRequestRequestTypeDef = { # (1)
"alias": ...,
}
parent.delete_time_series(**kwargs)
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
# describe_access_policy method definition
await def describe_access_policy(
self,
*,
accessPolicyId: str,
) -> DescribeAccessPolicyResponseTypeDef: # (1)
...
# describe_access_policy method usage example with argument unpacking
kwargs: DescribeAccessPolicyRequestRequestTypeDef = { # (1)
"accessPolicyId": ...,
}
parent.describe_access_policy(**kwargs)
describe_action#
Retrieves information about an action.
Type annotations and code completion for session.client("iotsitewise").describe_action
method.
boto3 documentation
# describe_action method definition
await def describe_action(
self,
*,
actionId: str,
) -> DescribeActionResponseTypeDef: # (1)
...
# describe_action method usage example with argument unpacking
kwargs: DescribeActionRequestRequestTypeDef = { # (1)
"actionId": ...,
}
parent.describe_action(**kwargs)
describe_asset#
Retrieves information about an asset.
Type annotations and code completion for session.client("iotsitewise").describe_asset
method.
boto3 documentation
# describe_asset method definition
await def describe_asset(
self,
*,
assetId: str,
excludeProperties: bool = ...,
) -> DescribeAssetResponseTypeDef: # (1)
...
# describe_asset method usage example with argument unpacking
kwargs: DescribeAssetRequestRequestTypeDef = { # (1)
"assetId": ...,
}
parent.describe_asset(**kwargs)
describe_asset_composite_model#
Retrieves information about an asset composite model (also known as an asset component).
Type annotations and code completion for session.client("iotsitewise").describe_asset_composite_model
method.
boto3 documentation
# describe_asset_composite_model method definition
await def describe_asset_composite_model(
self,
*,
assetId: str,
assetCompositeModelId: str,
) -> DescribeAssetCompositeModelResponseTypeDef: # (1)
...
# describe_asset_composite_model method usage example with argument unpacking
kwargs: DescribeAssetCompositeModelRequestRequestTypeDef = { # (1)
"assetId": ...,
"assetCompositeModelId": ...,
}
parent.describe_asset_composite_model(**kwargs)
describe_asset_model#
Retrieves information about an asset model.
Type annotations and code completion for session.client("iotsitewise").describe_asset_model
method.
boto3 documentation
# describe_asset_model method definition
await def describe_asset_model(
self,
*,
assetModelId: str,
excludeProperties: bool = ...,
) -> DescribeAssetModelResponseTypeDef: # (1)
...
# describe_asset_model method usage example with argument unpacking
kwargs: DescribeAssetModelRequestRequestTypeDef = { # (1)
"assetModelId": ...,
}
parent.describe_asset_model(**kwargs)
describe_asset_model_composite_model#
Retrieves information about an asset model composite model (also known as an asset model component).
Type annotations and code completion for session.client("iotsitewise").describe_asset_model_composite_model
method.
boto3 documentation
# describe_asset_model_composite_model method definition
await def describe_asset_model_composite_model(
self,
*,
assetModelId: str,
assetModelCompositeModelId: str,
) -> DescribeAssetModelCompositeModelResponseTypeDef: # (1)
...
# describe_asset_model_composite_model method usage example with argument unpacking
kwargs: DescribeAssetModelCompositeModelRequestRequestTypeDef = { # (1)
"assetModelId": ...,
"assetModelCompositeModelId": ...,
}
parent.describe_asset_model_composite_model(**kwargs)
describe_asset_property#
Retrieves information about an asset property.
Type annotations and code completion for session.client("iotsitewise").describe_asset_property
method.
boto3 documentation
# describe_asset_property method definition
await def describe_asset_property(
self,
*,
assetId: str,
propertyId: str,
) -> DescribeAssetPropertyResponseTypeDef: # (1)
...
# describe_asset_property method usage example with argument unpacking
kwargs: DescribeAssetPropertyRequestRequestTypeDef = { # (1)
"assetId": ...,
"propertyId": ...,
}
parent.describe_asset_property(**kwargs)
describe_bulk_import_job#
Retrieves information about a bulk import job request.
Type annotations and code completion for session.client("iotsitewise").describe_bulk_import_job
method.
boto3 documentation
# describe_bulk_import_job method definition
await def describe_bulk_import_job(
self,
*,
jobId: str,
) -> DescribeBulkImportJobResponseTypeDef: # (1)
...
# describe_bulk_import_job method usage example with argument unpacking
kwargs: DescribeBulkImportJobRequestRequestTypeDef = { # (1)
"jobId": ...,
}
parent.describe_bulk_import_job(**kwargs)
describe_dashboard#
Retrieves information about a dashboard.
Type annotations and code completion for session.client("iotsitewise").describe_dashboard
method.
boto3 documentation
# describe_dashboard method definition
await def describe_dashboard(
self,
*,
dashboardId: str,
) -> DescribeDashboardResponseTypeDef: # (1)
...
# describe_dashboard method usage example with argument unpacking
kwargs: DescribeDashboardRequestRequestTypeDef = { # (1)
"dashboardId": ...,
}
parent.describe_dashboard(**kwargs)
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
# describe_default_encryption_configuration method definition
await def describe_default_encryption_configuration(
self,
) -> DescribeDefaultEncryptionConfigurationResponseTypeDef: # (1)
...
describe_gateway#
Retrieves information about a gateway.
Type annotations and code completion for session.client("iotsitewise").describe_gateway
method.
boto3 documentation
# describe_gateway method definition
await def describe_gateway(
self,
*,
gatewayId: str,
) -> DescribeGatewayResponseTypeDef: # (1)
...
# describe_gateway method usage example with argument unpacking
kwargs: DescribeGatewayRequestRequestTypeDef = { # (1)
"gatewayId": ...,
}
parent.describe_gateway(**kwargs)
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
# describe_gateway_capability_configuration method definition
await def describe_gateway_capability_configuration(
self,
*,
gatewayId: str,
capabilityNamespace: str,
) -> DescribeGatewayCapabilityConfigurationResponseTypeDef: # (1)
...
# describe_gateway_capability_configuration method usage example with argument unpacking
kwargs: DescribeGatewayCapabilityConfigurationRequestRequestTypeDef = { # (1)
"gatewayId": ...,
"capabilityNamespace": ...,
}
parent.describe_gateway_capability_configuration(**kwargs)
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
# describe_logging_options method definition
await def describe_logging_options(
self,
) -> DescribeLoggingOptionsResponseTypeDef: # (1)
...
describe_portal#
Retrieves information about a portal.
Type annotations and code completion for session.client("iotsitewise").describe_portal
method.
boto3 documentation
# describe_portal method definition
await def describe_portal(
self,
*,
portalId: str,
) -> DescribePortalResponseTypeDef: # (1)
...
# describe_portal method usage example with argument unpacking
kwargs: DescribePortalRequestRequestTypeDef = { # (1)
"portalId": ...,
}
parent.describe_portal(**kwargs)
describe_project#
Retrieves information about a project.
Type annotations and code completion for session.client("iotsitewise").describe_project
method.
boto3 documentation
# describe_project method definition
await def describe_project(
self,
*,
projectId: str,
) -> DescribeProjectResponseTypeDef: # (1)
...
# describe_project method usage example with argument unpacking
kwargs: DescribeProjectRequestRequestTypeDef = { # (1)
"projectId": ...,
}
parent.describe_project(**kwargs)
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
# describe_storage_configuration method definition
await def describe_storage_configuration(
self,
) -> DescribeStorageConfigurationResponseTypeDef: # (1)
...
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
# describe_time_series method definition
await def describe_time_series(
self,
*,
alias: str = ...,
assetId: str = ...,
propertyId: str = ...,
) -> DescribeTimeSeriesResponseTypeDef: # (1)
...
# describe_time_series method usage example with argument unpacking
kwargs: DescribeTimeSeriesRequestRequestTypeDef = { # (1)
"alias": ...,
}
parent.describe_time_series(**kwargs)
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
# disassociate_assets method definition
await def disassociate_assets(
self,
*,
assetId: str,
hierarchyId: str,
childAssetId: str,
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# disassociate_assets method usage example with argument unpacking
kwargs: DisassociateAssetsRequestRequestTypeDef = { # (1)
"assetId": ...,
"hierarchyId": ...,
"childAssetId": ...,
}
parent.disassociate_assets(**kwargs)
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
# disassociate_time_series_from_asset_property method definition
await def disassociate_time_series_from_asset_property(
self,
*,
alias: str,
assetId: str,
propertyId: str,
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# disassociate_time_series_from_asset_property method usage example with argument unpacking
kwargs: DisassociateTimeSeriesFromAssetPropertyRequestRequestTypeDef = { # (1)
"alias": ...,
"assetId": ...,
"propertyId": ...,
}
parent.disassociate_time_series_from_asset_property(**kwargs)
execute_action#
Executes an action on a target resource.
Type annotations and code completion for session.client("iotsitewise").execute_action
method.
boto3 documentation
# execute_action method definition
await def execute_action(
self,
*,
targetResource: TargetResourceTypeDef, # (1)
actionDefinitionId: str,
actionPayload: ActionPayloadTypeDef, # (2)
clientToken: str = ...,
) -> ExecuteActionResponseTypeDef: # (3)
...
# execute_action method usage example with argument unpacking
kwargs: ExecuteActionRequestRequestTypeDef = { # (1)
"targetResource": ...,
"actionDefinitionId": ...,
"actionPayload": ...,
}
parent.execute_action(**kwargs)
execute_query#
Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.
Type annotations and code completion for session.client("iotsitewise").execute_query
method.
boto3 documentation
# execute_query method definition
await def execute_query(
self,
*,
queryStatement: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ExecuteQueryResponseTypeDef: # (1)
...
# execute_query method usage example with argument unpacking
kwargs: ExecuteQueryRequestRequestTypeDef = { # (1)
"queryStatement": ...,
}
parent.execute_query(**kwargs)
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
# generate_presigned_url 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
# get_asset_property_aggregates 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)
...
- See AggregateTypeType
- See QualityType
- See TimeOrderingType
- See GetAssetPropertyAggregatesResponseTypeDef
# get_asset_property_aggregates method usage example with argument unpacking
kwargs: GetAssetPropertyAggregatesRequestRequestTypeDef = { # (1)
"aggregateTypes": ...,
"resolution": ...,
"startDate": ...,
"endDate": ...,
}
parent.get_asset_property_aggregates(**kwargs)
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
# get_asset_property_value method definition
await def get_asset_property_value(
self,
*,
assetId: str = ...,
propertyId: str = ...,
propertyAlias: str = ...,
) -> GetAssetPropertyValueResponseTypeDef: # (1)
...
# get_asset_property_value method usage example with argument unpacking
kwargs: GetAssetPropertyValueRequestRequestTypeDef = { # (1)
"assetId": ...,
}
parent.get_asset_property_value(**kwargs)
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
# get_asset_property_value_history 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)
...
# get_asset_property_value_history method usage example with argument unpacking
kwargs: GetAssetPropertyValueHistoryRequestRequestTypeDef = { # (1)
"assetId": ...,
}
parent.get_asset_property_value_history(**kwargs)
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
# get_interpolated_asset_property_values 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)
...
# get_interpolated_asset_property_values method usage example with argument unpacking
kwargs: GetInterpolatedAssetPropertyValuesRequestRequestTypeDef = { # (1)
"startTimeInSeconds": ...,
"endTimeInSeconds": ...,
"quality": ...,
"intervalInSeconds": ...,
"type": ...,
}
parent.get_interpolated_asset_property_values(**kwargs)
list_access_policies#
Retrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity Center 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
# list_access_policies 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)
...
# list_access_policies method usage example with argument unpacking
kwargs: ListAccessPoliciesRequestRequestTypeDef = { # (1)
"identityType": ...,
}
parent.list_access_policies(**kwargs)
list_actions#
Retrieves a paginated list of actions for a specific target resource.
Type annotations and code completion for session.client("iotsitewise").list_actions
method.
boto3 documentation
# list_actions method definition
await def list_actions(
self,
*,
targetResourceType: TargetResourceTypeType, # (1)
targetResourceId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListActionsResponseTypeDef: # (2)
...
# list_actions method usage example with argument unpacking
kwargs: ListActionsRequestRequestTypeDef = { # (1)
"targetResourceType": ...,
"targetResourceId": ...,
}
parent.list_actions(**kwargs)
list_asset_model_composite_models#
Retrieves a paginated list of composite models associated with the asset model See also: AWS API Documentation.
Type annotations and code completion for session.client("iotsitewise").list_asset_model_composite_models
method.
boto3 documentation
# list_asset_model_composite_models method definition
await def list_asset_model_composite_models(
self,
*,
assetModelId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListAssetModelCompositeModelsResponseTypeDef: # (1)
...
# list_asset_model_composite_models method usage example with argument unpacking
kwargs: ListAssetModelCompositeModelsRequestRequestTypeDef = { # (1)
"assetModelId": ...,
}
parent.list_asset_model_composite_models(**kwargs)
list_asset_model_properties#
Retrieves a paginated list of properties associated with an asset model.
Type annotations and code completion for session.client("iotsitewise").list_asset_model_properties
method.
boto3 documentation
# list_asset_model_properties method definition
await def list_asset_model_properties(
self,
*,
assetModelId: str,
nextToken: str = ...,
maxResults: int = ...,
filter: ListAssetModelPropertiesFilterType = ..., # (1)
) -> ListAssetModelPropertiesResponseTypeDef: # (2)
...
# list_asset_model_properties method usage example with argument unpacking
kwargs: ListAssetModelPropertiesRequestRequestTypeDef = { # (1)
"assetModelId": ...,
}
parent.list_asset_model_properties(**kwargs)
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
# list_asset_models method definition
await def list_asset_models(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
assetModelTypes: Sequence[AssetModelTypeType] = ..., # (1)
) -> ListAssetModelsResponseTypeDef: # (2)
...
# list_asset_models method usage example with argument unpacking
kwargs: ListAssetModelsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_asset_models(**kwargs)
list_asset_properties#
Retrieves a paginated list of properties associated with an asset.
Type annotations and code completion for session.client("iotsitewise").list_asset_properties
method.
boto3 documentation
# list_asset_properties method definition
await def list_asset_properties(
self,
*,
assetId: str,
nextToken: str = ...,
maxResults: int = ...,
filter: ListAssetPropertiesFilterType = ..., # (1)
) -> ListAssetPropertiesResponseTypeDef: # (2)
...
# list_asset_properties method usage example with argument unpacking
kwargs: ListAssetPropertiesRequestRequestTypeDef = { # (1)
"assetId": ...,
}
parent.list_asset_properties(**kwargs)
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
# list_asset_relationships method definition
await def list_asset_relationships(
self,
*,
assetId: str,
traversalType: TraversalTypeType, # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> ListAssetRelationshipsResponseTypeDef: # (2)
...
# list_asset_relationships method usage example with argument unpacking
kwargs: ListAssetRelationshipsRequestRequestTypeDef = { # (1)
"assetId": ...,
"traversalType": ...,
}
parent.list_asset_relationships(**kwargs)
list_assets#
Retrieves a paginated list of asset summaries.
Type annotations and code completion for session.client("iotsitewise").list_assets
method.
boto3 documentation
# list_assets method definition
await def list_assets(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
assetModelId: str = ...,
filter: ListAssetsFilterType = ..., # (1)
) -> ListAssetsResponseTypeDef: # (2)
...
# list_assets method usage example with argument unpacking
kwargs: ListAssetsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_assets(**kwargs)
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
# list_associated_assets method definition
await def list_associated_assets(
self,
*,
assetId: str,
hierarchyId: str = ...,
traversalDirection: TraversalDirectionType = ..., # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> ListAssociatedAssetsResponseTypeDef: # (2)
...
# list_associated_assets method usage example with argument unpacking
kwargs: ListAssociatedAssetsRequestRequestTypeDef = { # (1)
"assetId": ...,
}
parent.list_associated_assets(**kwargs)
list_bulk_import_jobs#
Retrieves a paginated list of bulk import job requests.
Type annotations and code completion for session.client("iotsitewise").list_bulk_import_jobs
method.
boto3 documentation
# list_bulk_import_jobs method definition
await def list_bulk_import_jobs(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
filter: ListBulkImportJobsFilterType = ..., # (1)
) -> ListBulkImportJobsResponseTypeDef: # (2)
...
# list_bulk_import_jobs method usage example with argument unpacking
kwargs: ListBulkImportJobsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_bulk_import_jobs(**kwargs)
list_composition_relationships#
Retrieves a paginated list of composition relationships for an asset model of
type
COMPONENT_MODEL
.
Type annotations and code completion for session.client("iotsitewise").list_composition_relationships
method.
boto3 documentation
# list_composition_relationships method definition
await def list_composition_relationships(
self,
*,
assetModelId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListCompositionRelationshipsResponseTypeDef: # (1)
...
# list_composition_relationships method usage example with argument unpacking
kwargs: ListCompositionRelationshipsRequestRequestTypeDef = { # (1)
"assetModelId": ...,
}
parent.list_composition_relationships(**kwargs)
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
# list_dashboards method definition
await def list_dashboards(
self,
*,
projectId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListDashboardsResponseTypeDef: # (1)
...
# list_dashboards method usage example with argument unpacking
kwargs: ListDashboardsRequestRequestTypeDef = { # (1)
"projectId": ...,
}
parent.list_dashboards(**kwargs)
list_gateways#
Retrieves a paginated list of gateways.
Type annotations and code completion for session.client("iotsitewise").list_gateways
method.
boto3 documentation
# list_gateways method definition
await def list_gateways(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListGatewaysResponseTypeDef: # (1)
...
# list_gateways method usage example with argument unpacking
kwargs: ListGatewaysRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_gateways(**kwargs)
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
# list_portals method definition
await def list_portals(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListPortalsResponseTypeDef: # (1)
...
# list_portals method usage example with argument unpacking
kwargs: ListPortalsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_portals(**kwargs)
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
# list_project_assets method definition
await def list_project_assets(
self,
*,
projectId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListProjectAssetsResponseTypeDef: # (1)
...
# list_project_assets method usage example with argument unpacking
kwargs: ListProjectAssetsRequestRequestTypeDef = { # (1)
"projectId": ...,
}
parent.list_project_assets(**kwargs)
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
# list_projects method definition
await def list_projects(
self,
*,
portalId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListProjectsResponseTypeDef: # (1)
...
# list_projects method usage example with argument unpacking
kwargs: ListProjectsRequestRequestTypeDef = { # (1)
"portalId": ...,
}
parent.list_projects(**kwargs)
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
# list_tags_for_resource method definition
await def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
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
# list_time_series method definition
await def list_time_series(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
assetId: str = ...,
aliasPrefix: str = ...,
timeSeriesType: ListTimeSeriesTypeType = ..., # (1)
) -> ListTimeSeriesResponseTypeDef: # (2)
...
# list_time_series method usage example with argument unpacking
kwargs: ListTimeSeriesRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_time_series(**kwargs)
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
# put_default_encryption_configuration method definition
await def put_default_encryption_configuration(
self,
*,
encryptionType: EncryptionTypeType, # (1)
kmsKeyId: str = ...,
) -> PutDefaultEncryptionConfigurationResponseTypeDef: # (2)
...
# put_default_encryption_configuration method usage example with argument unpacking
kwargs: PutDefaultEncryptionConfigurationRequestRequestTypeDef = { # (1)
"encryptionType": ...,
}
parent.put_default_encryption_configuration(**kwargs)
put_logging_options#
Sets logging options for IoT SiteWise.
Type annotations and code completion for session.client("iotsitewise").put_logging_options
method.
boto3 documentation
# put_logging_options method definition
await def put_logging_options(
self,
*,
loggingOptions: LoggingOptionsTypeDef, # (1)
) -> Dict[str, Any]:
...
# put_logging_options method usage example with argument unpacking
kwargs: PutLoggingOptionsRequestRequestTypeDef = { # (1)
"loggingOptions": ...,
}
parent.put_logging_options(**kwargs)
put_storage_configuration#
Configures storage settings for IoT SiteWise.
Type annotations and code completion for session.client("iotsitewise").put_storage_configuration
method.
boto3 documentation
# put_storage_configuration method definition
await def put_storage_configuration(
self,
*,
storageType: StorageTypeType, # (1)
multiLayerStorage: MultiLayerStorageTypeDef = ..., # (2)
disassociatedDataStorage: DisassociatedDataStorageStateType = ..., # (3)
retentionPeriod: RetentionPeriodTypeDef = ..., # (4)
warmTier: WarmTierStateType = ..., # (5)
warmTierRetentionPeriod: WarmTierRetentionPeriodTypeDef = ..., # (6)
) -> PutStorageConfigurationResponseTypeDef: # (7)
...
- See StorageTypeType
- See MultiLayerStorageTypeDef
- See DisassociatedDataStorageStateType
- See RetentionPeriodTypeDef
- See WarmTierStateType
- See WarmTierRetentionPeriodTypeDef
- See PutStorageConfigurationResponseTypeDef
# put_storage_configuration method usage example with argument unpacking
kwargs: PutStorageConfigurationRequestRequestTypeDef = { # (1)
"storageType": ...,
}
parent.put_storage_configuration(**kwargs)
tag_resource#
Adds tags to an IoT SiteWise resource.
Type annotations and code completion for session.client("iotsitewise").tag_resource
method.
boto3 documentation
# tag_resource method definition
await def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Removes a tag from an IoT SiteWise resource.
Type annotations and code completion for session.client("iotsitewise").untag_resource
method.
boto3 documentation
# untag_resource method definition
await def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
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
# update_access_policy method definition
await def update_access_policy(
self,
*,
accessPolicyId: str,
accessPolicyIdentity: IdentityTypeDef, # (1)
accessPolicyResource: ResourceTypeDef, # (2)
accessPolicyPermission: PermissionType, # (3)
clientToken: str = ...,
) -> Dict[str, Any]:
...
- See IdentityTypeDef
- See ResourceTypeDef
- See PermissionType
# update_access_policy method usage example with argument unpacking
kwargs: UpdateAccessPolicyRequestRequestTypeDef = { # (1)
"accessPolicyId": ...,
"accessPolicyIdentity": ...,
"accessPolicyResource": ...,
"accessPolicyPermission": ...,
}
parent.update_access_policy(**kwargs)
update_asset#
Updates an asset's name.
Type annotations and code completion for session.client("iotsitewise").update_asset
method.
boto3 documentation
# update_asset method definition
await def update_asset(
self,
*,
assetId: str,
assetName: str,
clientToken: str = ...,
assetDescription: str = ...,
assetExternalId: str = ...,
) -> UpdateAssetResponseTypeDef: # (1)
...
# update_asset method usage example with argument unpacking
kwargs: UpdateAssetRequestRequestTypeDef = { # (1)
"assetId": ...,
"assetName": ...,
}
parent.update_asset(**kwargs)
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
# update_asset_model 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 = ...,
assetModelExternalId: str = ...,
) -> UpdateAssetModelResponseTypeDef: # (4)
...
- See AssetModelPropertyTypeDef
- See AssetModelHierarchyTypeDef
- See AssetModelCompositeModelTypeDef
- See UpdateAssetModelResponseTypeDef
# update_asset_model method usage example with argument unpacking
kwargs: UpdateAssetModelRequestRequestTypeDef = { # (1)
"assetModelId": ...,
"assetModelName": ...,
}
parent.update_asset_model(**kwargs)
update_asset_model_composite_model#
Updates a composite model and all of the assets that were created from the model.
Type annotations and code completion for session.client("iotsitewise").update_asset_model_composite_model
method.
boto3 documentation
# update_asset_model_composite_model method definition
await def update_asset_model_composite_model(
self,
*,
assetModelId: str,
assetModelCompositeModelId: str,
assetModelCompositeModelName: str,
assetModelCompositeModelExternalId: str = ...,
assetModelCompositeModelDescription: str = ...,
clientToken: str = ...,
assetModelCompositeModelProperties: Sequence[AssetModelPropertyTypeDef] = ..., # (1)
) -> UpdateAssetModelCompositeModelResponseTypeDef: # (2)
...
# update_asset_model_composite_model method usage example with argument unpacking
kwargs: UpdateAssetModelCompositeModelRequestRequestTypeDef = { # (1)
"assetModelId": ...,
"assetModelCompositeModelId": ...,
"assetModelCompositeModelName": ...,
}
parent.update_asset_model_composite_model(**kwargs)
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
# update_asset_property method definition
await def update_asset_property(
self,
*,
assetId: str,
propertyId: str,
propertyAlias: str = ...,
propertyNotificationState: PropertyNotificationStateType = ..., # (1)
clientToken: str = ...,
propertyUnit: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...
# update_asset_property method usage example with argument unpacking
kwargs: UpdateAssetPropertyRequestRequestTypeDef = { # (1)
"assetId": ...,
"propertyId": ...,
}
parent.update_asset_property(**kwargs)
update_dashboard#
Updates an IoT SiteWise Monitor dashboard.
Type annotations and code completion for session.client("iotsitewise").update_dashboard
method.
boto3 documentation
# update_dashboard method definition
await def update_dashboard(
self,
*,
dashboardId: str,
dashboardName: str,
dashboardDefinition: str,
dashboardDescription: str = ...,
clientToken: str = ...,
) -> Dict[str, Any]:
...
# update_dashboard method usage example with argument unpacking
kwargs: UpdateDashboardRequestRequestTypeDef = { # (1)
"dashboardId": ...,
"dashboardName": ...,
"dashboardDefinition": ...,
}
parent.update_dashboard(**kwargs)
update_gateway#
Updates a gateway's name.
Type annotations and code completion for session.client("iotsitewise").update_gateway
method.
boto3 documentation
# update_gateway method definition
await def update_gateway(
self,
*,
gatewayId: str,
gatewayName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# update_gateway method usage example with argument unpacking
kwargs: UpdateGatewayRequestRequestTypeDef = { # (1)
"gatewayId": ...,
"gatewayName": ...,
}
parent.update_gateway(**kwargs)
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
# update_gateway_capability_configuration method definition
await def update_gateway_capability_configuration(
self,
*,
gatewayId: str,
capabilityNamespace: str,
capabilityConfiguration: str,
) -> UpdateGatewayCapabilityConfigurationResponseTypeDef: # (1)
...
# update_gateway_capability_configuration method usage example with argument unpacking
kwargs: UpdateGatewayCapabilityConfigurationRequestRequestTypeDef = { # (1)
"gatewayId": ...,
"capabilityNamespace": ...,
"capabilityConfiguration": ...,
}
parent.update_gateway_capability_configuration(**kwargs)
update_portal#
Updates an IoT SiteWise Monitor portal.
Type annotations and code completion for session.client("iotsitewise").update_portal
method.
boto3 documentation
# update_portal 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)
...
- See ImageTypeDef
- See AlarmsTypeDef
- See UpdatePortalResponseTypeDef
# update_portal method usage example with argument unpacking
kwargs: UpdatePortalRequestRequestTypeDef = { # (1)
"portalId": ...,
"portalName": ...,
"portalContactEmail": ...,
"roleArn": ...,
}
parent.update_portal(**kwargs)
update_project#
Updates an IoT SiteWise Monitor project.
Type annotations and code completion for session.client("iotsitewise").update_project
method.
boto3 documentation
# update_project method definition
await def update_project(
self,
*,
projectId: str,
projectName: str,
projectDescription: str = ...,
clientToken: str = ...,
) -> Dict[str, Any]:
...
# update_project method usage example with argument unpacking
kwargs: UpdateProjectRequestRequestTypeDef = { # (1)
"projectId": ...,
"projectName": ...,
}
parent.update_project(**kwargs)
__aenter__#
Type annotations and code completion for session.client("iotsitewise").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> IoTSiteWiseClient:
...
__aexit__#
Type annotations and code completion for session.client("iotsitewise").__aexit__
method.
boto3 documentation
# __aexit__ 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("execute_query")
-> ExecuteQueryPaginatorclient.get_paginator("get_asset_property_aggregates")
-> GetAssetPropertyAggregatesPaginatorclient.get_paginator("get_asset_property_value_history")
-> GetAssetPropertyValueHistoryPaginatorclient.get_paginator("get_interpolated_asset_property_values")
-> GetInterpolatedAssetPropertyValuesPaginatorclient.get_paginator("list_access_policies")
-> ListAccessPoliciesPaginatorclient.get_paginator("list_actions")
-> ListActionsPaginatorclient.get_paginator("list_asset_model_composite_models")
-> ListAssetModelCompositeModelsPaginatorclient.get_paginator("list_asset_model_properties")
-> ListAssetModelPropertiesPaginatorclient.get_paginator("list_asset_models")
-> ListAssetModelsPaginatorclient.get_paginator("list_asset_properties")
-> ListAssetPropertiesPaginatorclient.get_paginator("list_asset_relationships")
-> ListAssetRelationshipsPaginatorclient.get_paginator("list_assets")
-> ListAssetsPaginatorclient.get_paginator("list_associated_assets")
-> ListAssociatedAssetsPaginatorclient.get_paginator("list_bulk_import_jobs")
-> ListBulkImportJobsPaginatorclient.get_paginator("list_composition_relationships")
-> ListCompositionRelationshipsPaginatorclient.get_paginator("list_dashboards")
-> ListDashboardsPaginatorclient.get_paginator("list_gateways")
-> ListGatewaysPaginatorclient.get_paginator("list_portals")
-> ListPortalsPaginatorclient.get_paginator("list_project_assets")
-> ListProjectAssetsPaginatorclient.get_paginator("list_projects")
-> ListProjectsPaginatorclient.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")
-> AssetActiveWaiterclient.get_waiter("asset_model_active")
-> AssetModelActiveWaiterclient.get_waiter("asset_model_not_exists")
-> AssetModelNotExistsWaiterclient.get_waiter("asset_not_exists")
-> AssetNotExistsWaiterclient.get_waiter("portal_active")
-> PortalActiveWaiterclient.get_waiter("portal_not_exists")
-> PortalNotExistsWaiter