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

# IoTSiteWiseClient usage example

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

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

Exceptions

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

# Exceptions.exceptions usage example

client = boto3.client("iotsitewise")

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.PreconditionFailedException,
    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)

# Exceptions.exceptions type checking example

from mypy_boto3_iotsitewise.client import Exceptions

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

Methods

can_paginate

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

# can_paginate method definition

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

generate_presigned_url

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

# generate_presigned_url method definition

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

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

# associate_assets method definition

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

1. See EmptyResponseMetadataTypeDef

# associate_assets method usage example with argument unpacking

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

parent.associate_assets(**kwargs)

1. See AssociateAssetsRequestRequestTypeDef

associate_time_series_to_asset_property

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

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

# associate_time_series_to_asset_property method definition

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

1. See EmptyResponseMetadataTypeDef

# 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)

1. See AssociateTimeSeriesToAssetPropertyRequestRequestTypeDef

batch_associate_project_assets

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

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

# batch_associate_project_assets method definition

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

1. See BatchAssociateProjectAssetsResponseTypeDef

# batch_associate_project_assets method usage example with argument unpacking

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

parent.batch_associate_project_assets(**kwargs)

1. See BatchAssociateProjectAssetsRequestRequestTypeDef

batch_disassociate_project_assets

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

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

# batch_disassociate_project_assets method definition

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

1. See BatchDisassociateProjectAssetsResponseTypeDef

# batch_disassociate_project_assets method usage example with argument unpacking

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

parent.batch_disassociate_project_assets(**kwargs)

1. See BatchDisassociateProjectAssetsRequestRequestTypeDef

batch_get_asset_property_aggregates

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

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

# batch_get_asset_property_aggregates method definition

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

1. See BatchGetAssetPropertyAggregatesEntryTypeDef
2. See BatchGetAssetPropertyAggregatesResponseTypeDef

# batch_get_asset_property_aggregates method usage example with argument unpacking

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

parent.batch_get_asset_property_aggregates(**kwargs)

1. See BatchGetAssetPropertyAggregatesRequestRequestTypeDef

batch_get_asset_property_value

Gets the current value for one or more asset properties.

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

# batch_get_asset_property_value method definition

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

1. See BatchGetAssetPropertyValueEntryTypeDef
2. See BatchGetAssetPropertyValueResponseTypeDef

# batch_get_asset_property_value method usage example with argument unpacking

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

parent.batch_get_asset_property_value(**kwargs)

1. See BatchGetAssetPropertyValueRequestRequestTypeDef

batch_get_asset_property_value_history

Gets the historical values for one or more asset properties.

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

# batch_get_asset_property_value_history method definition

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

1. See BatchGetAssetPropertyValueHistoryEntryTypeDef
2. See BatchGetAssetPropertyValueHistoryResponseTypeDef

# batch_get_asset_property_value_history method usage example with argument unpacking

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

parent.batch_get_asset_property_value_history(**kwargs)

1. See BatchGetAssetPropertyValueHistoryRequestRequestTypeDef

batch_put_asset_property_value

Sends a list of asset property values to IoT SiteWise.

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

# batch_put_asset_property_value method definition

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

1. See PutAssetPropertyValueEntryTypeDef
2. See BatchPutAssetPropertyValueResponseTypeDef

# batch_put_asset_property_value method usage example with argument unpacking

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

parent.batch_put_asset_property_value(**kwargs)

1. See BatchPutAssetPropertyValueRequestRequestTypeDef

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

# create_access_policy method definition

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

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

# create_access_policy method usage example with argument unpacking

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

parent.create_access_policy(**kwargs)

1. See CreateAccessPolicyRequestRequestTypeDef

create_asset

Creates an asset from an existing asset model.

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

# create_asset method definition

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

1. See CreateAssetResponseTypeDef

# create_asset method usage example with argument unpacking

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

parent.create_asset(**kwargs)

1. See CreateAssetRequestRequestTypeDef

create_asset_model

Creates an asset model from specified property and hierarchy definitions.

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

# create_asset_model method definition

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

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

# create_asset_model method usage example with argument unpacking

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

parent.create_asset_model(**kwargs)

1. See CreateAssetModelRequestRequestTypeDef

create_asset_model_composite_model

Creates a custom composite model from specified property and hierarchy definitions.

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

# create_asset_model_composite_model method definition

def create_asset_model_composite_model(
    self,
    *,
    assetModelId: str,
    assetModelCompositeModelName: str,
    assetModelCompositeModelType: str,
    assetModelCompositeModelExternalId: str = ...,
    parentAssetModelCompositeModelId: str = ...,
    assetModelCompositeModelId: str = ...,
    assetModelCompositeModelDescription: str = ...,
    clientToken: str = ...,
    composedAssetModelId: str = ...,
    assetModelCompositeModelProperties: Sequence[AssetModelPropertyDefinitionTypeDef] = ...,  # (1)
    ifMatch: str = ...,
    ifNoneMatch: str = ...,
    matchForVersionType: AssetModelVersionTypeType = ...,  # (2)
) -> CreateAssetModelCompositeModelResponseTypeDef:  # (3)
    ...

1. See AssetModelPropertyDefinitionTypeDef
2. See AssetModelVersionTypeType
3. See CreateAssetModelCompositeModelResponseTypeDef

# create_asset_model_composite_model method usage example with argument unpacking

kwargs: CreateAssetModelCompositeModelRequestRequestTypeDef = {  # (1)
    "assetModelId": ...,
    "assetModelCompositeModelName": ...,
    "assetModelCompositeModelType": ...,
}

parent.create_asset_model_composite_model(**kwargs)

1. See CreateAssetModelCompositeModelRequestRequestTypeDef

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

# create_bulk_import_job method definition

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

1. See FileTypeDef
2. See ErrorReportLocationTypeDef
3. See JobConfigurationTypeDef
4. 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)

1. See CreateBulkImportJobRequestRequestTypeDef

create_dashboard

Creates a dashboard in an IoT SiteWise Monitor project.

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

# create_dashboard method definition

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

1. See CreateDashboardResponseTypeDef

# create_dashboard method usage example with argument unpacking

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

parent.create_dashboard(**kwargs)

1. See CreateDashboardRequestRequestTypeDef

create_dataset

Creates a dataset to connect an external datasource.

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

# create_dataset method definition

def create_dataset(
    self,
    *,
    datasetName: str,
    datasetSource: DatasetSourceTypeDef,  # (1)
    datasetId: str = ...,
    datasetDescription: str = ...,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateDatasetResponseTypeDef:  # (2)
    ...

1. See DatasetSourceTypeDef
2. See CreateDatasetResponseTypeDef

# create_dataset method usage example with argument unpacking

kwargs: CreateDatasetRequestRequestTypeDef = {  # (1)
    "datasetName": ...,
    "datasetSource": ...,
}

parent.create_dataset(**kwargs)

1. See CreateDatasetRequestRequestTypeDef

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

# create_gateway method definition

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

1. See GatewayPlatformTypeDef
2. See CreateGatewayResponseTypeDef

# create_gateway method usage example with argument unpacking

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

parent.create_gateway(**kwargs)

1. See CreateGatewayRequestRequestTypeDef

create_portal

Creates a portal, which can contain projects and dashboards.

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

# create_portal method definition

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

1. See ImageFileTypeDef
2. See AuthModeType
3. See AlarmsTypeDef
4. See PortalTypeType
5. See PortalTypeEntryTypeDef PortalTypeEntryOutputTypeDef
6. See CreatePortalResponseTypeDef

# create_portal method usage example with argument unpacking

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

parent.create_portal(**kwargs)

1. See CreatePortalRequestRequestTypeDef

create_project

Creates a project in the specified portal.

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

# create_project method definition

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

1. See CreateProjectResponseTypeDef

# create_project method usage example with argument unpacking

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

parent.create_project(**kwargs)

1. See CreateProjectRequestRequestTypeDef

delete_access_policy

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

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

# delete_access_policy method definition

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)

1. See DeleteAccessPolicyRequestRequestTypeDef

delete_asset

Deletes an asset.

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

# delete_asset method definition

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

1. See DeleteAssetResponseTypeDef

# delete_asset method usage example with argument unpacking

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

parent.delete_asset(**kwargs)

1. See DeleteAssetRequestRequestTypeDef

delete_asset_model

Deletes an asset model.

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

# delete_asset_model method definition

def delete_asset_model(
    self,
    *,
    assetModelId: str,
    clientToken: str = ...,
    ifMatch: str = ...,
    ifNoneMatch: str = ...,
    matchForVersionType: AssetModelVersionTypeType = ...,  # (1)
) -> DeleteAssetModelResponseTypeDef:  # (2)
    ...

1. See AssetModelVersionTypeType
2. See DeleteAssetModelResponseTypeDef

# delete_asset_model method usage example with argument unpacking

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

parent.delete_asset_model(**kwargs)

1. See DeleteAssetModelRequestRequestTypeDef

delete_asset_model_composite_model

Deletes a composite model.

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

# delete_asset_model_composite_model method definition

def delete_asset_model_composite_model(
    self,
    *,
    assetModelId: str,
    assetModelCompositeModelId: str,
    clientToken: str = ...,
    ifMatch: str = ...,
    ifNoneMatch: str = ...,
    matchForVersionType: AssetModelVersionTypeType = ...,  # (1)
) -> DeleteAssetModelCompositeModelResponseTypeDef:  # (2)
    ...

1. See AssetModelVersionTypeType
2. See DeleteAssetModelCompositeModelResponseTypeDef

# delete_asset_model_composite_model method usage example with argument unpacking

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

parent.delete_asset_model_composite_model(**kwargs)

1. See DeleteAssetModelCompositeModelRequestRequestTypeDef

delete_dashboard

Deletes a dashboard from IoT SiteWise Monitor.

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

# delete_dashboard method definition

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)

1. See DeleteDashboardRequestRequestTypeDef

delete_dataset

Deletes a dataset.

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

# delete_dataset method definition

def delete_dataset(
    self,
    *,
    datasetId: str,
    clientToken: str = ...,
) -> DeleteDatasetResponseTypeDef:  # (1)
    ...

1. See DeleteDatasetResponseTypeDef

# delete_dataset method usage example with argument unpacking

kwargs: DeleteDatasetRequestRequestTypeDef = {  # (1)
    "datasetId": ...,
}

parent.delete_dataset(**kwargs)

1. See DeleteDatasetRequestRequestTypeDef

delete_gateway

Deletes a gateway from IoT SiteWise.

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

# delete_gateway method definition

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

1. See EmptyResponseMetadataTypeDef

# delete_gateway method usage example with argument unpacking

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

parent.delete_gateway(**kwargs)

1. See DeleteGatewayRequestRequestTypeDef

delete_portal

Deletes a portal from IoT SiteWise Monitor.

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

# delete_portal method definition

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

1. See DeletePortalResponseTypeDef

# delete_portal method usage example with argument unpacking

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

parent.delete_portal(**kwargs)

1. See DeletePortalRequestRequestTypeDef

delete_project

Deletes a project from IoT SiteWise Monitor.

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

# delete_project method definition

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)

1. See DeleteProjectRequestRequestTypeDef

delete_time_series

Deletes a time series (data stream).

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

# delete_time_series method definition

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

1. See EmptyResponseMetadataTypeDef

# delete_time_series method usage example with argument unpacking

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

parent.delete_time_series(**kwargs)

1. See DeleteTimeSeriesRequestRequestTypeDef

describe_access_policy

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

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

# describe_access_policy method definition

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

1. See DescribeAccessPolicyResponseTypeDef

# describe_access_policy method usage example with argument unpacking

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

parent.describe_access_policy(**kwargs)

1. See DescribeAccessPolicyRequestRequestTypeDef

describe_action

Retrieves information about an action.

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

# describe_action method definition

def describe_action(
    self,
    *,
    actionId: str,
) -> DescribeActionResponseTypeDef:  # (1)
    ...

1. See DescribeActionResponseTypeDef

# describe_action method usage example with argument unpacking

kwargs: DescribeActionRequestRequestTypeDef = {  # (1)
    "actionId": ...,
}

parent.describe_action(**kwargs)

1. See DescribeActionRequestRequestTypeDef

describe_asset

Retrieves information about an asset.

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

# describe_asset method definition

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

1. See DescribeAssetResponseTypeDef

# describe_asset method usage example with argument unpacking

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

parent.describe_asset(**kwargs)

1. See DescribeAssetRequestRequestTypeDef

describe_asset_composite_model

Retrieves information about an asset composite model (also known as an asset component).

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

# describe_asset_composite_model method definition

def describe_asset_composite_model(
    self,
    *,
    assetId: str,
    assetCompositeModelId: str,
) -> DescribeAssetCompositeModelResponseTypeDef:  # (1)
    ...

1. See DescribeAssetCompositeModelResponseTypeDef

# describe_asset_composite_model method usage example with argument unpacking

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

parent.describe_asset_composite_model(**kwargs)

1. See DescribeAssetCompositeModelRequestRequestTypeDef

describe_asset_model

Retrieves information about an asset model.

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

# describe_asset_model method definition

def describe_asset_model(
    self,
    *,
    assetModelId: str,
    excludeProperties: bool = ...,
    assetModelVersion: str = ...,
) -> DescribeAssetModelResponseTypeDef:  # (1)
    ...

1. See DescribeAssetModelResponseTypeDef

# describe_asset_model method usage example with argument unpacking

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

parent.describe_asset_model(**kwargs)

1. See DescribeAssetModelRequestRequestTypeDef

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

# describe_asset_model_composite_model method definition

def describe_asset_model_composite_model(
    self,
    *,
    assetModelId: str,
    assetModelCompositeModelId: str,
    assetModelVersion: str = ...,
) -> DescribeAssetModelCompositeModelResponseTypeDef:  # (1)
    ...

1. See DescribeAssetModelCompositeModelResponseTypeDef

# describe_asset_model_composite_model method usage example with argument unpacking

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

parent.describe_asset_model_composite_model(**kwargs)

1. See DescribeAssetModelCompositeModelRequestRequestTypeDef

describe_asset_property

Retrieves information about an asset property.

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

# describe_asset_property method definition

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

1. See DescribeAssetPropertyResponseTypeDef

# describe_asset_property method usage example with argument unpacking

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

parent.describe_asset_property(**kwargs)

1. See DescribeAssetPropertyRequestRequestTypeDef

describe_bulk_import_job

Retrieves information about a bulk import job request.

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

# describe_bulk_import_job method definition

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

1. See DescribeBulkImportJobResponseTypeDef

# describe_bulk_import_job method usage example with argument unpacking

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

parent.describe_bulk_import_job(**kwargs)

1. See DescribeBulkImportJobRequestRequestTypeDef

describe_dashboard

Retrieves information about a dashboard.

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

# describe_dashboard method definition

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

1. See DescribeDashboardResponseTypeDef

# describe_dashboard method usage example with argument unpacking

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

parent.describe_dashboard(**kwargs)

1. See DescribeDashboardRequestRequestTypeDef

describe_dataset

Retrieves information about a dataset.

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

# describe_dataset method definition

def describe_dataset(
    self,
    *,
    datasetId: str,
) -> DescribeDatasetResponseTypeDef:  # (1)
    ...

1. See DescribeDatasetResponseTypeDef

# describe_dataset method usage example with argument unpacking

kwargs: DescribeDatasetRequestRequestTypeDef = {  # (1)
    "datasetId": ...,
}

parent.describe_dataset(**kwargs)

1. See DescribeDatasetRequestRequestTypeDef

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

# describe_default_encryption_configuration method definition

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

1. See DescribeDefaultEncryptionConfigurationResponseTypeDef

describe_gateway

Retrieves information about a gateway.

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

# describe_gateway method definition

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

1. See DescribeGatewayResponseTypeDef

# describe_gateway method usage example with argument unpacking

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

parent.describe_gateway(**kwargs)

1. See DescribeGatewayRequestRequestTypeDef

describe_gateway_capability_configuration

Retrieves information about a gateway capability configuration.

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

# describe_gateway_capability_configuration method definition

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

1. See DescribeGatewayCapabilityConfigurationResponseTypeDef

# describe_gateway_capability_configuration method usage example with argument unpacking

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

parent.describe_gateway_capability_configuration(**kwargs)

1. See DescribeGatewayCapabilityConfigurationRequestRequestTypeDef

describe_logging_options

Retrieves the current IoT SiteWise logging options.

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

# describe_logging_options method definition

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

1. See DescribeLoggingOptionsResponseTypeDef

describe_portal

Retrieves information about a portal.

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

# describe_portal method definition

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

1. See DescribePortalResponseTypeDef

# describe_portal method usage example with argument unpacking

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

parent.describe_portal(**kwargs)

1. See DescribePortalRequestRequestTypeDef

describe_project

Retrieves information about a project.

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

# describe_project method definition

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

1. See DescribeProjectResponseTypeDef

# describe_project method usage example with argument unpacking

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

parent.describe_project(**kwargs)

1. See DescribeProjectRequestRequestTypeDef

describe_storage_configuration

Retrieves information about the storage configuration for IoT SiteWise.

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

# describe_storage_configuration method definition

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

1. See DescribeStorageConfigurationResponseTypeDef

describe_time_series

Retrieves information about a time series (data stream).

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

# describe_time_series method definition

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

1. See DescribeTimeSeriesResponseTypeDef

# describe_time_series method usage example with argument unpacking

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

parent.describe_time_series(**kwargs)

1. See DescribeTimeSeriesRequestRequestTypeDef

disassociate_assets

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

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

# disassociate_assets method definition

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

1. See EmptyResponseMetadataTypeDef

# disassociate_assets method usage example with argument unpacking

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

parent.disassociate_assets(**kwargs)

1. See DisassociateAssetsRequestRequestTypeDef

disassociate_time_series_from_asset_property

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

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

# disassociate_time_series_from_asset_property method definition

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

1. See EmptyResponseMetadataTypeDef

# 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)

1. See DisassociateTimeSeriesFromAssetPropertyRequestRequestTypeDef

execute_action

Executes an action on a target resource.

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

# execute_action method definition

def execute_action(
    self,
    *,
    targetResource: TargetResourceTypeDef,  # (1)
    actionDefinitionId: str,
    actionPayload: ActionPayloadTypeDef,  # (2)
    clientToken: str = ...,
) -> ExecuteActionResponseTypeDef:  # (3)
    ...

1. See TargetResourceTypeDef
2. See ActionPayloadTypeDef
3. See ExecuteActionResponseTypeDef

# execute_action method usage example with argument unpacking

kwargs: ExecuteActionRequestRequestTypeDef = {  # (1)
    "targetResource": ...,
    "actionDefinitionId": ...,
    "actionPayload": ...,
}

parent.execute_action(**kwargs)

1. See ExecuteActionRequestRequestTypeDef

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

# execute_query method definition

def execute_query(
    self,
    *,
    queryStatement: str,
    nextToken: str = ...,
    maxResults: int = ...,
    clientToken: str = ...,
) -> ExecuteQueryResponseTypeDef:  # (1)
    ...

1. See ExecuteQueryResponseTypeDef

# execute_query method usage example with argument unpacking

kwargs: ExecuteQueryRequestRequestTypeDef = {  # (1)
    "queryStatement": ...,
}

parent.execute_query(**kwargs)

1. See ExecuteQueryRequestRequestTypeDef

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

# get_asset_property_aggregates method definition

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

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

# get_asset_property_aggregates method usage example with argument unpacking

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

parent.get_asset_property_aggregates(**kwargs)

1. See GetAssetPropertyAggregatesRequestRequestTypeDef

get_asset_property_value

Gets an asset property's current value.

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

# get_asset_property_value method definition

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

1. See GetAssetPropertyValueResponseTypeDef

# get_asset_property_value method usage example with argument unpacking

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

parent.get_asset_property_value(**kwargs)

1. See GetAssetPropertyValueRequestRequestTypeDef

get_asset_property_value_history

Gets the history of an asset property's values.

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

# get_asset_property_value_history method definition

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

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

# get_asset_property_value_history method usage example with argument unpacking

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

parent.get_asset_property_value_history(**kwargs)

1. See GetAssetPropertyValueHistoryRequestRequestTypeDef

get_interpolated_asset_property_values

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

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

# get_interpolated_asset_property_values method definition

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

1. See QualityType
2. See GetInterpolatedAssetPropertyValuesResponseTypeDef

# 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)

1. See GetInterpolatedAssetPropertyValuesRequestRequestTypeDef

invoke_assistant

Invokes SiteWise Assistant to start or continue a conversation.

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

# invoke_assistant method definition

def invoke_assistant(
    self,
    *,
    message: str,
    conversationId: str = ...,
    enableTrace: bool = ...,
) -> InvokeAssistantResponseTypeDef:  # (1)
    ...

1. See InvokeAssistantResponseTypeDef

# invoke_assistant method usage example with argument unpacking

kwargs: InvokeAssistantRequestRequestTypeDef = {  # (1)
    "message": ...,
}

parent.invoke_assistant(**kwargs)

1. See InvokeAssistantRequestRequestTypeDef

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

# list_access_policies method definition

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

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

# list_access_policies method usage example with argument unpacking

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

parent.list_access_policies(**kwargs)

1. See ListAccessPoliciesRequestRequestTypeDef

list_actions

Retrieves a paginated list of actions for a specific target resource.

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

# list_actions method definition

def list_actions(
    self,
    *,
    targetResourceType: TargetResourceTypeType,  # (1)
    targetResourceId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListActionsResponseTypeDef:  # (2)
    ...

1. See TargetResourceTypeType
2. See ListActionsResponseTypeDef

# list_actions method usage example with argument unpacking

kwargs: ListActionsRequestRequestTypeDef = {  # (1)
    "targetResourceType": ...,
    "targetResourceId": ...,
}

parent.list_actions(**kwargs)

1. See ListActionsRequestRequestTypeDef

list_asset_model_composite_models

Retrieves a paginated list of composite models associated with the asset model.

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

# list_asset_model_composite_models method definition

def list_asset_model_composite_models(
    self,
    *,
    assetModelId: str,
    nextToken: str = ...,
    maxResults: int = ...,
    assetModelVersion: str = ...,
) -> ListAssetModelCompositeModelsResponseTypeDef:  # (1)
    ...

1. See ListAssetModelCompositeModelsResponseTypeDef

# list_asset_model_composite_models method usage example with argument unpacking

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

parent.list_asset_model_composite_models(**kwargs)

1. See ListAssetModelCompositeModelsRequestRequestTypeDef

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

# list_asset_model_properties method definition

def list_asset_model_properties(
    self,
    *,
    assetModelId: str,
    nextToken: str = ...,
    maxResults: int = ...,
    filter: ListAssetModelPropertiesFilterType = ...,  # (1)
    assetModelVersion: str = ...,
) -> ListAssetModelPropertiesResponseTypeDef:  # (2)
    ...

1. See ListAssetModelPropertiesFilterType
2. See ListAssetModelPropertiesResponseTypeDef

# list_asset_model_properties method usage example with argument unpacking

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

parent.list_asset_model_properties(**kwargs)

1. See ListAssetModelPropertiesRequestRequestTypeDef

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

# list_asset_models method definition

def list_asset_models(
    self,
    *,
    assetModelTypes: Sequence[AssetModelTypeType] = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
    assetModelVersion: str = ...,
) -> ListAssetModelsResponseTypeDef:  # (2)
    ...

1. See AssetModelTypeType
2. See ListAssetModelsResponseTypeDef

# list_asset_models method usage example with argument unpacking

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

parent.list_asset_models(**kwargs)

1. See ListAssetModelsRequestRequestTypeDef

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

# list_asset_properties method definition

def list_asset_properties(
    self,
    *,
    assetId: str,
    nextToken: str = ...,
    maxResults: int = ...,
    filter: ListAssetPropertiesFilterType = ...,  # (1)
) -> ListAssetPropertiesResponseTypeDef:  # (2)
    ...

1. See ListAssetPropertiesFilterType
2. See ListAssetPropertiesResponseTypeDef

# list_asset_properties method usage example with argument unpacking

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

parent.list_asset_properties(**kwargs)

1. See ListAssetPropertiesRequestRequestTypeDef

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

# list_asset_relationships method definition

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

1. See TraversalTypeType
2. See ListAssetRelationshipsResponseTypeDef

# list_asset_relationships method usage example with argument unpacking

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

parent.list_asset_relationships(**kwargs)

1. See ListAssetRelationshipsRequestRequestTypeDef

list_assets

Retrieves a paginated list of asset summaries.

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

# list_assets method definition

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

1. See ListAssetsFilterType
2. See ListAssetsResponseTypeDef

# list_assets method usage example with argument unpacking

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

parent.list_assets(**kwargs)

1. See ListAssetsRequestRequestTypeDef

list_associated_assets

Retrieves a paginated list of associated assets.

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

# list_associated_assets method definition

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

1. See TraversalDirectionType
2. See ListAssociatedAssetsResponseTypeDef

# list_associated_assets method usage example with argument unpacking

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

parent.list_associated_assets(**kwargs)

1. See ListAssociatedAssetsRequestRequestTypeDef

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

# list_bulk_import_jobs method definition

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

1. See ListBulkImportJobsFilterType
2. See ListBulkImportJobsResponseTypeDef

# list_bulk_import_jobs method usage example with argument unpacking

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

parent.list_bulk_import_jobs(**kwargs)

1. See ListBulkImportJobsRequestRequestTypeDef

list_composition_relationships

Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.

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

# list_composition_relationships method definition

def list_composition_relationships(
    self,
    *,
    assetModelId: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListCompositionRelationshipsResponseTypeDef:  # (1)
    ...

1. See ListCompositionRelationshipsResponseTypeDef

# list_composition_relationships method usage example with argument unpacking

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

parent.list_composition_relationships(**kwargs)

1. See ListCompositionRelationshipsRequestRequestTypeDef

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

# list_dashboards method definition

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

1. See ListDashboardsResponseTypeDef

# list_dashboards method usage example with argument unpacking

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

parent.list_dashboards(**kwargs)

1. See ListDashboardsRequestRequestTypeDef

list_datasets

Retrieves a paginated list of datasets for a specific target resource.

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

# list_datasets method definition

def list_datasets(
    self,
    *,
    sourceType: DatasetSourceTypeType,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListDatasetsResponseTypeDef:  # (2)
    ...

1. See DatasetSourceTypeType
2. See ListDatasetsResponseTypeDef

# list_datasets method usage example with argument unpacking

kwargs: ListDatasetsRequestRequestTypeDef = {  # (1)
    "sourceType": ...,
}

parent.list_datasets(**kwargs)

1. See ListDatasetsRequestRequestTypeDef

list_gateways

Retrieves a paginated list of gateways.

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

# list_gateways method definition

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

1. See ListGatewaysResponseTypeDef

# list_gateways method usage example with argument unpacking

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

parent.list_gateways(**kwargs)

1. See ListGatewaysRequestRequestTypeDef

list_portals

Retrieves a paginated list of IoT SiteWise Monitor portals.

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

# list_portals method definition

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

1. See ListPortalsResponseTypeDef

# list_portals method usage example with argument unpacking

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

parent.list_portals(**kwargs)

1. See ListPortalsRequestRequestTypeDef

list_project_assets

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

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

# list_project_assets method definition

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

1. See ListProjectAssetsResponseTypeDef

# list_project_assets method usage example with argument unpacking

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

parent.list_project_assets(**kwargs)

1. See ListProjectAssetsRequestRequestTypeDef

list_projects

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

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

# list_projects method definition

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

1. See ListProjectsResponseTypeDef

# list_projects method usage example with argument unpacking

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

parent.list_projects(**kwargs)

1. See ListProjectsRequestRequestTypeDef

list_tags_for_resource

Retrieves the list of tags for an IoT SiteWise resource.

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

# list_tags_for_resource method definition

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

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

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

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

list_time_series

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

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

# list_time_series method definition

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

1. See ListTimeSeriesTypeType
2. See ListTimeSeriesResponseTypeDef

# list_time_series method usage example with argument unpacking

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

parent.list_time_series(**kwargs)

1. See ListTimeSeriesRequestRequestTypeDef

put_default_encryption_configuration

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

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

# put_default_encryption_configuration method definition

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

1. See EncryptionTypeType
2. See PutDefaultEncryptionConfigurationResponseTypeDef

# put_default_encryption_configuration method usage example with argument unpacking

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

parent.put_default_encryption_configuration(**kwargs)

1. See PutDefaultEncryptionConfigurationRequestRequestTypeDef

put_logging_options

Sets logging options for IoT SiteWise.

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

# put_logging_options method definition

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

1. See LoggingOptionsTypeDef

# put_logging_options method usage example with argument unpacking

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

parent.put_logging_options(**kwargs)

1. See PutLoggingOptionsRequestRequestTypeDef

put_storage_configuration

Configures storage settings for IoT SiteWise.

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

# put_storage_configuration method definition

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

1. See StorageTypeType
2. See MultiLayerStorageTypeDef
3. See DisassociatedDataStorageStateType
4. See RetentionPeriodTypeDef
5. See WarmTierStateType
6. See WarmTierRetentionPeriodTypeDef
7. See PutStorageConfigurationResponseTypeDef

# put_storage_configuration method usage example with argument unpacking

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

parent.put_storage_configuration(**kwargs)

1. See PutStorageConfigurationRequestRequestTypeDef

tag_resource

Adds tags to an IoT SiteWise resource.

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

# tag_resource method definition

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)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes a tag from an IoT SiteWise resource.

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

# untag_resource method definition

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)

1. See UntagResourceRequestRequestTypeDef

update_access_policy

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

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

# update_access_policy method definition

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

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

# update_access_policy method usage example with argument unpacking

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

parent.update_access_policy(**kwargs)

1. See UpdateAccessPolicyRequestRequestTypeDef

update_asset

Updates an asset's name.

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

# update_asset method definition

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

1. See UpdateAssetResponseTypeDef

# update_asset method usage example with argument unpacking

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

parent.update_asset(**kwargs)

1. See UpdateAssetRequestRequestTypeDef

update_asset_model

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

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

# update_asset_model method definition

def update_asset_model(
    self,
    *,
    assetModelId: str,
    assetModelName: str,
    assetModelExternalId: str = ...,
    assetModelDescription: str = ...,
    assetModelProperties: Sequence[AssetModelPropertyUnionTypeDef] = ...,  # (1)
    assetModelHierarchies: Sequence[AssetModelHierarchyTypeDef] = ...,  # (2)
    assetModelCompositeModels: Sequence[AssetModelCompositeModelUnionTypeDef] = ...,  # (3)
    clientToken: str = ...,
    ifMatch: str = ...,
    ifNoneMatch: str = ...,
    matchForVersionType: AssetModelVersionTypeType = ...,  # (4)
) -> UpdateAssetModelResponseTypeDef:  # (5)
    ...

1. See AssetModelPropertyTypeDef AssetModelPropertyOutputTypeDef
2. See AssetModelHierarchyTypeDef
3. See AssetModelCompositeModelTypeDef AssetModelCompositeModelOutputTypeDef
4. See AssetModelVersionTypeType
5. See UpdateAssetModelResponseTypeDef

# update_asset_model method usage example with argument unpacking

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

parent.update_asset_model(**kwargs)

1. See UpdateAssetModelRequestRequestTypeDef

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

# update_asset_model_composite_model method definition

def update_asset_model_composite_model(
    self,
    *,
    assetModelId: str,
    assetModelCompositeModelId: str,
    assetModelCompositeModelName: str,
    assetModelCompositeModelExternalId: str = ...,
    assetModelCompositeModelDescription: str = ...,
    clientToken: str = ...,
    assetModelCompositeModelProperties: Sequence[AssetModelPropertyTypeDef] = ...,  # (1)
    ifMatch: str = ...,
    ifNoneMatch: str = ...,
    matchForVersionType: AssetModelVersionTypeType = ...,  # (2)
) -> UpdateAssetModelCompositeModelResponseTypeDef:  # (3)
    ...

1. See AssetModelPropertyTypeDef
2. See AssetModelVersionTypeType
3. See UpdateAssetModelCompositeModelResponseTypeDef

# update_asset_model_composite_model method usage example with argument unpacking

kwargs: UpdateAssetModelCompositeModelRequestRequestTypeDef = {  # (1)
    "assetModelId": ...,
    "assetModelCompositeModelId": ...,
    "assetModelCompositeModelName": ...,
}

parent.update_asset_model_composite_model(**kwargs)

1. See UpdateAssetModelCompositeModelRequestRequestTypeDef

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

# update_asset_property method definition

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

1. See PropertyNotificationStateType
2. See EmptyResponseMetadataTypeDef

# update_asset_property method usage example with argument unpacking

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

parent.update_asset_property(**kwargs)

1. See UpdateAssetPropertyRequestRequestTypeDef

update_dashboard

Updates an IoT SiteWise Monitor dashboard.

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

# update_dashboard method definition

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)

1. See UpdateDashboardRequestRequestTypeDef

update_dataset

Updates a dataset.

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

# update_dataset method definition

def update_dataset(
    self,
    *,
    datasetId: str,
    datasetName: str,
    datasetSource: DatasetSourceTypeDef,  # (1)
    datasetDescription: str = ...,
    clientToken: str = ...,
) -> UpdateDatasetResponseTypeDef:  # (2)
    ...

1. See DatasetSourceTypeDef
2. See UpdateDatasetResponseTypeDef

# update_dataset method usage example with argument unpacking

kwargs: UpdateDatasetRequestRequestTypeDef = {  # (1)
    "datasetId": ...,
    "datasetName": ...,
    "datasetSource": ...,
}

parent.update_dataset(**kwargs)

1. See UpdateDatasetRequestRequestTypeDef

update_gateway

Updates a gateway's name.

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

# update_gateway method definition

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

1. See EmptyResponseMetadataTypeDef

# update_gateway method usage example with argument unpacking

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

parent.update_gateway(**kwargs)

1. See UpdateGatewayRequestRequestTypeDef

update_gateway_capability_configuration

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

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

# update_gateway_capability_configuration method definition

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

1. See UpdateGatewayCapabilityConfigurationResponseTypeDef

# update_gateway_capability_configuration method usage example with argument unpacking

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

parent.update_gateway_capability_configuration(**kwargs)

1. See UpdateGatewayCapabilityConfigurationRequestRequestTypeDef

update_portal

Updates an IoT SiteWise Monitor portal.

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

# update_portal method definition

def update_portal(
    self,
    *,
    portalId: str,
    portalName: str,
    portalContactEmail: str,
    roleArn: str,
    portalDescription: str = ...,
    portalLogoImage: ImageTypeDef = ...,  # (1)
    clientToken: str = ...,
    notificationSenderEmail: str = ...,
    alarms: AlarmsTypeDef = ...,  # (2)
    portalType: PortalTypeType = ...,  # (3)
    portalTypeConfiguration: Mapping[str, PortalTypeEntryTypeDef] = ...,  # (4)
) -> UpdatePortalResponseTypeDef:  # (5)
    ...

1. See ImageTypeDef
2. See AlarmsTypeDef
3. See PortalTypeType
4. See PortalTypeEntryTypeDef
5. See UpdatePortalResponseTypeDef

# update_portal method usage example with argument unpacking

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

parent.update_portal(**kwargs)

1. See UpdatePortalRequestRequestTypeDef

update_project

Updates an IoT SiteWise Monitor project.

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

# update_project method definition

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)

1. See UpdateProjectRequestRequestTypeDef

get_paginator

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

• client.get_paginator("execute_query") -> ExecuteQueryPaginator
• client.get_paginator("get_asset_property_aggregates") -> GetAssetPropertyAggregatesPaginator
• client.get_paginator("get_asset_property_value_history") -> GetAssetPropertyValueHistoryPaginator
• client.get_paginator("get_interpolated_asset_property_values") -> GetInterpolatedAssetPropertyValuesPaginator
• client.get_paginator("list_access_policies") -> ListAccessPoliciesPaginator
• client.get_paginator("list_actions") -> ListActionsPaginator
• client.get_paginator("list_asset_model_composite_models") -> ListAssetModelCompositeModelsPaginator
• client.get_paginator("list_asset_model_properties") -> ListAssetModelPropertiesPaginator
• client.get_paginator("list_asset_models") -> ListAssetModelsPaginator
• client.get_paginator("list_asset_properties") -> ListAssetPropertiesPaginator
• client.get_paginator("list_asset_relationships") -> ListAssetRelationshipsPaginator
• client.get_paginator("list_assets") -> ListAssetsPaginator
• client.get_paginator("list_associated_assets") -> ListAssociatedAssetsPaginator
• client.get_paginator("list_bulk_import_jobs") -> ListBulkImportJobsPaginator
• client.get_paginator("list_composition_relationships") -> ListCompositionRelationshipsPaginator
• client.get_paginator("list_dashboards") -> ListDashboardsPaginator
• client.get_paginator("list_datasets") -> ListDatasetsPaginator
• client.get_paginator("list_gateways") -> ListGatewaysPaginator
• client.get_paginator("list_portals") -> ListPortalsPaginator
• client.get_paginator("list_project_assets") -> ListProjectAssetsPaginator
• client.get_paginator("list_projects") -> ListProjectsPaginator
• client.get_paginator("list_time_series") -> ListTimeSeriesPaginator

get_waiter

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

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