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
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.
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)
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
def associate_assets(
self,
*,
assetId: str,
hierarchyId: str,
childAssetId: str,
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
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 boto3.client("iotsitewise").associate_time_series_to_asset_property
method.
boto3 documentation
def associate_time_series_to_asset_property(
self,
*,
alias: str,
assetId: str,
propertyId: str,
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
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 boto3.client("iotsitewise").batch_associate_project_assets
method.
boto3 documentation
def batch_associate_project_assets(
self,
*,
projectId: str,
assetIds: Sequence[str],
clientToken: str = ...,
) -> BatchAssociateProjectAssetsResponseTypeDef: # (1)
...
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 boto3.client("iotsitewise").batch_disassociate_project_assets
method.
boto3 documentation
def batch_disassociate_project_assets(
self,
*,
projectId: str,
assetIds: Sequence[str],
clientToken: str = ...,
) -> BatchDisassociateProjectAssetsResponseTypeDef: # (1)
...
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 boto3.client("iotsitewise").batch_get_asset_property_aggregates
method.
boto3 documentation
def batch_get_asset_property_aggregates(
self,
*,
entries: Sequence[BatchGetAssetPropertyAggregatesEntryTypeDef], # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> BatchGetAssetPropertyAggregatesResponseTypeDef: # (2)
...
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 boto3.client("iotsitewise").batch_get_asset_property_value
method.
boto3 documentation
def batch_get_asset_property_value(
self,
*,
entries: Sequence[BatchGetAssetPropertyValueEntryTypeDef], # (1)
nextToken: str = ...,
) -> BatchGetAssetPropertyValueResponseTypeDef: # (2)
...
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 boto3.client("iotsitewise").batch_get_asset_property_value_history
method.
boto3 documentation
def batch_get_asset_property_value_history(
self,
*,
entries: Sequence[BatchGetAssetPropertyValueHistoryEntryTypeDef], # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> BatchGetAssetPropertyValueHistoryResponseTypeDef: # (2)
...
- See BatchGetAssetPropertyValueHistoryEntryTypeDef
- See BatchGetAssetPropertyValueHistoryResponseTypeDef
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 boto3.client("iotsitewise").batch_put_asset_property_value
method.
boto3 documentation
def batch_put_asset_property_value(
self,
*,
entries: Sequence[PutAssetPropertyValueEntryTypeDef], # (1)
) -> BatchPutAssetPropertyValueResponseTypeDef: # (2)
...
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 boto3.client("iotsitewise").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("iotsitewise").close
method.
boto3 documentation
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
def create_access_policy(
self,
*,
accessPolicyIdentity: IdentityTypeDef, # (1)
accessPolicyResource: ResourceTypeDef, # (2)
accessPolicyPermission: PermissionType, # (3)
clientToken: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateAccessPolicyResponseTypeDef: # (4)
...
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 boto3.client("iotsitewise").create_asset
method.
boto3 documentation
def create_asset(
self,
*,
assetName: str,
assetModelId: str,
clientToken: str = ...,
tags: Mapping[str, str] = ...,
assetDescription: str = ...,
) -> CreateAssetResponseTypeDef: # (1)
...
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 boto3.client("iotsitewise").create_asset_model
method.
boto3 documentation
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)
...
- See AssetModelPropertyDefinitionTypeDef
- See AssetModelHierarchyDefinitionTypeDef
- See AssetModelCompositeModelDefinitionTypeDef
- See CreateAssetModelResponseTypeDef
kwargs: CreateAssetModelRequestRequestTypeDef = { # (1)
"assetModelName": ...,
}
parent.create_asset_model(**kwargs)
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
def create_bulk_import_job(
self,
*,
jobName: str,
jobRoleArn: str,
files: Sequence[FileTypeDef], # (1)
errorReportLocation: ErrorReportLocationTypeDef, # (2)
jobConfiguration: JobConfigurationTypeDef, # (3)
) -> CreateBulkImportJobResponseTypeDef: # (4)
...
- See FileTypeDef
- See ErrorReportLocationTypeDef
- See JobConfigurationTypeDef
- See CreateBulkImportJobResponseTypeDef
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 boto3.client("iotsitewise").create_dashboard
method.
boto3 documentation
def create_dashboard(
self,
*,
projectId: str,
dashboardName: str,
dashboardDefinition: str,
dashboardDescription: str = ...,
clientToken: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateDashboardResponseTypeDef: # (1)
...
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 boto3.client("iotsitewise").create_gateway
method.
boto3 documentation
def create_gateway(
self,
*,
gatewayName: str,
gatewayPlatform: GatewayPlatformTypeDef, # (1)
tags: Mapping[str, str] = ...,
) -> CreateGatewayResponseTypeDef: # (2)
...
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 boto3.client("iotsitewise").create_portal
method.
boto3 documentation
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
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 boto3.client("iotsitewise").create_project
method.
boto3 documentation
def create_project(
self,
*,
portalId: str,
projectName: str,
projectDescription: str = ...,
clientToken: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateProjectResponseTypeDef: # (1)
...
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 boto3.client("iotsitewise").delete_access_policy
method.
boto3 documentation
def delete_access_policy(
self,
*,
accessPolicyId: str,
clientToken: str = ...,
) -> Dict[str, Any]:
...
kwargs: DeleteAccessPolicyRequestRequestTypeDef = { # (1)
"accessPolicyId": ...,
}
parent.delete_access_policy(**kwargs)
delete_asset
Deletes an asset.
Type annotations and code completion for boto3.client("iotsitewise").delete_asset
method.
boto3 documentation
def delete_asset(
self,
*,
assetId: str,
clientToken: str = ...,
) -> DeleteAssetResponseTypeDef: # (1)
...
kwargs: DeleteAssetRequestRequestTypeDef = { # (1)
"assetId": ...,
}
parent.delete_asset(**kwargs)
delete_asset_model
Deletes an asset model.
Type annotations and code completion for boto3.client("iotsitewise").delete_asset_model
method.
boto3 documentation
def delete_asset_model(
self,
*,
assetModelId: str,
clientToken: str = ...,
) -> DeleteAssetModelResponseTypeDef: # (1)
...
kwargs: DeleteAssetModelRequestRequestTypeDef = { # (1)
"assetModelId": ...,
}
parent.delete_asset_model(**kwargs)
delete_dashboard
Deletes a dashboard from IoT SiteWise Monitor.
Type annotations and code completion for boto3.client("iotsitewise").delete_dashboard
method.
boto3 documentation
def delete_dashboard(
self,
*,
dashboardId: str,
clientToken: str = ...,
) -> Dict[str, Any]:
...
kwargs: DeleteDashboardRequestRequestTypeDef = { # (1)
"dashboardId": ...,
}
parent.delete_dashboard(**kwargs)
delete_gateway
Deletes a gateway from IoT SiteWise.
Type annotations and code completion for boto3.client("iotsitewise").delete_gateway
method.
boto3 documentation
def delete_gateway(
self,
*,
gatewayId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteGatewayRequestRequestTypeDef = { # (1)
"gatewayId": ...,
}
parent.delete_gateway(**kwargs)
delete_portal
Deletes a portal from IoT SiteWise Monitor.
Type annotations and code completion for boto3.client("iotsitewise").delete_portal
method.
boto3 documentation
def delete_portal(
self,
*,
portalId: str,
clientToken: str = ...,
) -> DeletePortalResponseTypeDef: # (1)
...
kwargs: DeletePortalRequestRequestTypeDef = { # (1)
"portalId": ...,
}
parent.delete_portal(**kwargs)
delete_project
Deletes a project from IoT SiteWise Monitor.
Type annotations and code completion for boto3.client("iotsitewise").delete_project
method.
boto3 documentation
def delete_project(
self,
*,
projectId: str,
clientToken: str = ...,
) -> Dict[str, Any]:
...
kwargs: DeleteProjectRequestRequestTypeDef = { # (1)
"projectId": ...,
}
parent.delete_project(**kwargs)
delete_time_series
Deletes a time series (data stream).
Type annotations and code completion for boto3.client("iotsitewise").delete_time_series
method.
boto3 documentation
def delete_time_series(
self,
*,
alias: str = ...,
assetId: str = ...,
propertyId: str = ...,
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
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 boto3.client("iotsitewise").describe_access_policy
method.
boto3 documentation
def describe_access_policy(
self,
*,
accessPolicyId: str,
) -> DescribeAccessPolicyResponseTypeDef: # (1)
...
kwargs: DescribeAccessPolicyRequestRequestTypeDef = { # (1)
"accessPolicyId": ...,
}
parent.describe_access_policy(**kwargs)
describe_asset
Retrieves information about an asset.
Type annotations and code completion for boto3.client("iotsitewise").describe_asset
method.
boto3 documentation
def describe_asset(
self,
*,
assetId: str,
excludeProperties: bool = ...,
) -> DescribeAssetResponseTypeDef: # (1)
...
kwargs: DescribeAssetRequestRequestTypeDef = { # (1)
"assetId": ...,
}
parent.describe_asset(**kwargs)
describe_asset_model
Retrieves information about an asset model.
Type annotations and code completion for boto3.client("iotsitewise").describe_asset_model
method.
boto3 documentation
def describe_asset_model(
self,
*,
assetModelId: str,
excludeProperties: bool = ...,
) -> DescribeAssetModelResponseTypeDef: # (1)
...
kwargs: DescribeAssetModelRequestRequestTypeDef = { # (1)
"assetModelId": ...,
}
parent.describe_asset_model(**kwargs)
describe_asset_property
Retrieves information about an asset property.
Type annotations and code completion for boto3.client("iotsitewise").describe_asset_property
method.
boto3 documentation
def describe_asset_property(
self,
*,
assetId: str,
propertyId: str,
) -> DescribeAssetPropertyResponseTypeDef: # (1)
...
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 boto3.client("iotsitewise").describe_bulk_import_job
method.
boto3 documentation
def describe_bulk_import_job(
self,
*,
jobId: str,
) -> DescribeBulkImportJobResponseTypeDef: # (1)
...
kwargs: DescribeBulkImportJobRequestRequestTypeDef = { # (1)
"jobId": ...,
}
parent.describe_bulk_import_job(**kwargs)
describe_dashboard
Retrieves information about a dashboard.
Type annotations and code completion for boto3.client("iotsitewise").describe_dashboard
method.
boto3 documentation
def describe_dashboard(
self,
*,
dashboardId: str,
) -> DescribeDashboardResponseTypeDef: # (1)
...
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 boto3.client("iotsitewise").describe_default_encryption_configuration
method.
boto3 documentation
def describe_default_encryption_configuration(
self,
) -> DescribeDefaultEncryptionConfigurationResponseTypeDef: # (1)
...
describe_gateway
Retrieves information about a gateway.
Type annotations and code completion for boto3.client("iotsitewise").describe_gateway
method.
boto3 documentation
def describe_gateway(
self,
*,
gatewayId: str,
) -> DescribeGatewayResponseTypeDef: # (1)
...
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 boto3.client("iotsitewise").describe_gateway_capability_configuration
method.
boto3 documentation
def describe_gateway_capability_configuration(
self,
*,
gatewayId: str,
capabilityNamespace: str,
) -> DescribeGatewayCapabilityConfigurationResponseTypeDef: # (1)
...
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 boto3.client("iotsitewise").describe_logging_options
method.
boto3 documentation
def describe_logging_options(
self,
) -> DescribeLoggingOptionsResponseTypeDef: # (1)
...
describe_portal
Retrieves information about a portal.
Type annotations and code completion for boto3.client("iotsitewise").describe_portal
method.
boto3 documentation
def describe_portal(
self,
*,
portalId: str,
) -> DescribePortalResponseTypeDef: # (1)
...
kwargs: DescribePortalRequestRequestTypeDef = { # (1)
"portalId": ...,
}
parent.describe_portal(**kwargs)
describe_project
Retrieves information about a project.
Type annotations and code completion for boto3.client("iotsitewise").describe_project
method.
boto3 documentation
def describe_project(
self,
*,
projectId: str,
) -> DescribeProjectResponseTypeDef: # (1)
...
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 boto3.client("iotsitewise").describe_storage_configuration
method.
boto3 documentation
def describe_storage_configuration(
self,
) -> DescribeStorageConfigurationResponseTypeDef: # (1)
...
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
def describe_time_series(
self,
*,
alias: str = ...,
assetId: str = ...,
propertyId: str = ...,
) -> DescribeTimeSeriesResponseTypeDef: # (1)
...
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 boto3.client("iotsitewise").disassociate_assets
method.
boto3 documentation
def disassociate_assets(
self,
*,
assetId: str,
hierarchyId: str,
childAssetId: str,
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
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 boto3.client("iotsitewise").disassociate_time_series_from_asset_property
method.
boto3 documentation
def disassociate_time_series_from_asset_property(
self,
*,
alias: str,
assetId: str,
propertyId: str,
clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DisassociateTimeSeriesFromAssetPropertyRequestRequestTypeDef = { # (1)
"alias": ...,
"assetId": ...,
"propertyId": ...,
}
parent.disassociate_time_series_from_asset_property(**kwargs)
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
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
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
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 boto3.client("iotsitewise").get_asset_property_value
method.
boto3 documentation
def get_asset_property_value(
self,
*,
assetId: str = ...,
propertyId: str = ...,
propertyAlias: str = ...,
) -> GetAssetPropertyValueResponseTypeDef: # (1)
...
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 boto3.client("iotsitewise").get_asset_property_value_history
method.
boto3 documentation
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)
...
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 boto3.client("iotsitewise").get_interpolated_asset_property_values
method.
boto3 documentation
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)
...
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 boto3.client("iotsitewise").list_access_policies
method.
boto3 documentation
def list_access_policies(
self,
*,
identityType: IdentityTypeType = ..., # (1)
identityId: str = ...,
resourceType: ResourceTypeType = ..., # (2)
resourceId: str = ...,
iamArn: str = ...,
nextToken: str = ...,
maxResults: int = ...,
) -> ListAccessPoliciesResponseTypeDef: # (3)
...
kwargs: ListAccessPoliciesRequestRequestTypeDef = { # (1)
"identityType": ...,
}
parent.list_access_policies(**kwargs)
list_asset_model_properties
Retrieves a paginated list of properties associated with an asset model.
Type annotations and code completion for boto3.client("iotsitewise").list_asset_model_properties
method.
boto3 documentation
def list_asset_model_properties(
self,
*,
assetModelId: str,
nextToken: str = ...,
maxResults: int = ...,
filter: ListAssetModelPropertiesFilterType = ..., # (1)
) -> ListAssetModelPropertiesResponseTypeDef: # (2)
...
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 boto3.client("iotsitewise").list_asset_models
method.
boto3 documentation
def list_asset_models(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListAssetModelsResponseTypeDef: # (1)
...
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 boto3.client("iotsitewise").list_asset_properties
method.
boto3 documentation
def list_asset_properties(
self,
*,
assetId: str,
nextToken: str = ...,
maxResults: int = ...,
filter: ListAssetPropertiesFilterType = ..., # (1)
) -> ListAssetPropertiesResponseTypeDef: # (2)
...
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 boto3.client("iotsitewise").list_asset_relationships
method.
boto3 documentation
def list_asset_relationships(
self,
*,
assetId: str,
traversalType: TraversalTypeType, # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> ListAssetRelationshipsResponseTypeDef: # (2)
...
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 boto3.client("iotsitewise").list_assets
method.
boto3 documentation
def list_assets(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
assetModelId: str = ...,
filter: ListAssetsFilterType = ..., # (1)
) -> ListAssetsResponseTypeDef: # (2)
...
kwargs: ListAssetsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_assets(**kwargs)
list_associated_assets
Retrieves a paginated list of associated assets.
Type annotations and code completion for boto3.client("iotsitewise").list_associated_assets
method.
boto3 documentation
def list_associated_assets(
self,
*,
assetId: str,
hierarchyId: str = ...,
traversalDirection: TraversalDirectionType = ..., # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> ListAssociatedAssetsResponseTypeDef: # (2)
...
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 boto3.client("iotsitewise").list_bulk_import_jobs
method.
boto3 documentation
def list_bulk_import_jobs(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
filter: ListBulkImportJobsFilterType = ..., # (1)
) -> ListBulkImportJobsResponseTypeDef: # (2)
...
kwargs: ListBulkImportJobsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_bulk_import_jobs(**kwargs)
list_dashboards
Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
Type annotations and code completion for boto3.client("iotsitewise").list_dashboards
method.
boto3 documentation
def list_dashboards(
self,
*,
projectId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListDashboardsResponseTypeDef: # (1)
...
kwargs: ListDashboardsRequestRequestTypeDef = { # (1)
"projectId": ...,
}
parent.list_dashboards(**kwargs)
list_gateways
Retrieves a paginated list of gateways.
Type annotations and code completion for boto3.client("iotsitewise").list_gateways
method.
boto3 documentation
def list_gateways(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListGatewaysResponseTypeDef: # (1)
...
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 boto3.client("iotsitewise").list_portals
method.
boto3 documentation
def list_portals(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListPortalsResponseTypeDef: # (1)
...
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 boto3.client("iotsitewise").list_project_assets
method.
boto3 documentation
def list_project_assets(
self,
*,
projectId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListProjectAssetsResponseTypeDef: # (1)
...
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 boto3.client("iotsitewise").list_projects
method.
boto3 documentation
def list_projects(
self,
*,
portalId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListProjectsResponseTypeDef: # (1)
...
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 boto3.client("iotsitewise").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
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 boto3.client("iotsitewise").list_time_series
method.
boto3 documentation
def list_time_series(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
assetId: str = ...,
aliasPrefix: str = ...,
timeSeriesType: ListTimeSeriesTypeType = ..., # (1)
) -> ListTimeSeriesResponseTypeDef: # (2)
...
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 boto3.client("iotsitewise").put_default_encryption_configuration
method.
boto3 documentation
def put_default_encryption_configuration(
self,
*,
encryptionType: EncryptionTypeType, # (1)
kmsKeyId: str = ...,
) -> PutDefaultEncryptionConfigurationResponseTypeDef: # (2)
...
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 boto3.client("iotsitewise").put_logging_options
method.
boto3 documentation
def put_logging_options(
self,
*,
loggingOptions: LoggingOptionsTypeDef, # (1)
) -> Dict[str, Any]:
...
kwargs: PutLoggingOptionsRequestRequestTypeDef = { # (1)
"loggingOptions": ...,
}
parent.put_logging_options(**kwargs)
put_storage_configuration
Configures storage settings for IoT SiteWise.
Type annotations and code completion for boto3.client("iotsitewise").put_storage_configuration
method.
boto3 documentation
def put_storage_configuration(
self,
*,
storageType: StorageTypeType, # (1)
multiLayerStorage: MultiLayerStorageTypeDef = ..., # (2)
disassociatedDataStorage: DisassociatedDataStorageStateType = ..., # (3)
retentionPeriod: RetentionPeriodTypeDef = ..., # (4)
) -> PutStorageConfigurationResponseTypeDef: # (5)
...
- See StorageTypeType
- See MultiLayerStorageTypeDef
- See DisassociatedDataStorageStateType
- See RetentionPeriodTypeDef
- See PutStorageConfigurationResponseTypeDef
kwargs: PutStorageConfigurationRequestRequestTypeDef = { # (1)
"storageType": ...,
}
parent.put_storage_configuration(**kwargs)
tag_resource
Adds tags to an IoT SiteWise resource.
Type annotations and code completion for boto3.client("iotsitewise").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
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 boto3.client("iotsitewise").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
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 boto3.client("iotsitewise").update_access_policy
method.
boto3 documentation
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
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 boto3.client("iotsitewise").update_asset
method.
boto3 documentation
def update_asset(
self,
*,
assetId: str,
assetName: str,
clientToken: str = ...,
assetDescription: str = ...,
) -> UpdateAssetResponseTypeDef: # (1)
...
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 boto3.client("iotsitewise").update_asset_model
method.
boto3 documentation
def update_asset_model(
self,
*,
assetModelId: str,
assetModelName: str,
assetModelDescription: str = ...,
assetModelProperties: Sequence[AssetModelPropertyTypeDef] = ..., # (1)
assetModelHierarchies: Sequence[AssetModelHierarchyTypeDef] = ..., # (2)
assetModelCompositeModels: Sequence[AssetModelCompositeModelTypeDef] = ..., # (3)
clientToken: str = ...,
) -> UpdateAssetModelResponseTypeDef: # (4)
...
- See AssetModelPropertyTypeDef
- See AssetModelHierarchyTypeDef
- See AssetModelCompositeModelTypeDef
- See UpdateAssetModelResponseTypeDef
kwargs: UpdateAssetModelRequestRequestTypeDef = { # (1)
"assetModelId": ...,
"assetModelName": ...,
}
parent.update_asset_model(**kwargs)
update_asset_property
Updates an asset property's alias and notification state.
Type annotations and code completion for boto3.client("iotsitewise").update_asset_property
method.
boto3 documentation
def update_asset_property(
self,
*,
assetId: str,
propertyId: str,
propertyAlias: str = ...,
propertyNotificationState: PropertyNotificationStateType = ..., # (1)
clientToken: str = ...,
propertyUnit: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateAssetPropertyRequestRequestTypeDef = { # (1)
"assetId": ...,
"propertyId": ...,
}
parent.update_asset_property(**kwargs)
update_dashboard
Updates an IoT SiteWise Monitor dashboard.
Type annotations and code completion for boto3.client("iotsitewise").update_dashboard
method.
boto3 documentation
def update_dashboard(
self,
*,
dashboardId: str,
dashboardName: str,
dashboardDefinition: str,
dashboardDescription: str = ...,
clientToken: str = ...,
) -> Dict[str, Any]:
...
kwargs: UpdateDashboardRequestRequestTypeDef = { # (1)
"dashboardId": ...,
"dashboardName": ...,
"dashboardDefinition": ...,
}
parent.update_dashboard(**kwargs)
update_gateway
Updates a gateway's name.
Type annotations and code completion for boto3.client("iotsitewise").update_gateway
method.
boto3 documentation
def update_gateway(
self,
*,
gatewayId: str,
gatewayName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
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 boto3.client("iotsitewise").update_gateway_capability_configuration
method.
boto3 documentation
def update_gateway_capability_configuration(
self,
*,
gatewayId: str,
capabilityNamespace: str,
capabilityConfiguration: str,
) -> UpdateGatewayCapabilityConfigurationResponseTypeDef: # (1)
...
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 boto3.client("iotsitewise").update_portal
method.
boto3 documentation
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
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 boto3.client("iotsitewise").update_project
method.
boto3 documentation
def update_project(
self,
*,
projectId: str,
projectName: str,
projectDescription: str = ...,
clientToken: str = ...,
) -> Dict[str, Any]:
...
kwargs: UpdateProjectRequestRequestTypeDef = { # (1)
"projectId": ...,
"projectName": ...,
}
parent.update_project(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("iotsitewise").get_paginator
method with overloads.
client.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_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_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 boto3.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