Class: Aws::IoTSiteWise::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb

Overview

An API client for IoTSiteWise. To construct a client, you need to configure a :region and :credentials.

client = Aws::IoTSiteWise::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. Takes effect only when disable_clock_skew_correction is not set.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_clock_skew_correction (Boolean) —

    Used only in standard and adaptive retry modes. When true, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :event_stream_handler (Proc) —

    When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :input_event_stream_handler (Proc) —

    When an EventStream or Proc object is provided, it can be used for sending events for the event stream.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :output_event_stream_handler (Proc) —

    When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::IoTSiteWise::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::IoTSiteWise::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



489
490
491
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 489

def initialize(*args)
  super
end

Instance Method Details

#associate_assets(params = {}) ⇒ Struct

Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the IoT SiteWise User Guide.

Examples:

Request syntax with placeholder values


resp = client.associate_assets({
  asset_id: "CustomID", # required
  hierarchy_id: "CustomID", # required
  child_asset_id: "CustomID", # required
  client_token: "ClientToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_id (required, String) —

    The ID of the parent asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :hierarchy_id (required, String) —

    The ID of a hierarchy in the parent asset's model. (This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.) Hierarchies allow different groupings of assets to be formed that all come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

  • :child_asset_id (required, String) —

    The ID of the child asset to be associated. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.



558
559
560
561
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 558

def associate_assets(params = {}, options = {})
  req = build_request(:associate_assets, params)
  req.send_request(options)
end

#associate_time_series_to_asset_property(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.associate_time_series_to_asset_property({
  alias: "PropertyAlias", # required
  asset_id: "CustomID", # required
  property_id: "CustomID", # required
  client_token: "ClientToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :alias (required, String) —

    The alias that identifies the time series.

  • :asset_id (required, String) —

    The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :property_id (required, String) —

    The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.



610
611
612
613
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 610

def associate_time_series_to_asset_property(params = {}, options = {})
  req = build_request(:associate_time_series_to_asset_property, params)
  req.send_request(options)
end

#batch_associate_data_segments_to_dataset(params = {}) ⇒ Types::BatchAssociateDataSegmentsToDatasetResponse

Associates a batch of data segments with a curated dataset. Data segments are time-bounded slices of time series data selected from source session datasets. Data segments that belong to the same time series can't overlap in time, regardless of which dataset they belong to.

Examples:

Request syntax with placeholder values


resp = client.batch_associate_data_segments_to_dataset({
  dataset_id: "ID", # required
  workspace_name: "WorkspaceName", # required
  associate_data_segment_entries: [ # required
    {
      source_dataset_id: "ID", # required
      time_series_id: "TimeSeriesId", # required
      start_timestamp: { # required
        time_in_seconds: 1, # required
        offset_in_nanos: 1,
      },
      end_timestamp: { # required
        time_in_seconds: 1, # required
        offset_in_nanos: 1,
      },
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.dataset_id #=> String
resp.dataset_version #=> String
resp.failed_associations #=> Array
resp.failed_associations[0].source_dataset_id #=> String
resp.failed_associations[0].time_series_id #=> String
resp.failed_associations[0].start_timestamp.time_in_seconds #=> Integer
resp.failed_associations[0].start_timestamp.offset_in_nanos #=> Integer
resp.failed_associations[0].end_timestamp.time_in_seconds #=> Integer
resp.failed_associations[0].end_timestamp.offset_in_nanos #=> Integer
resp.failed_associations[0].error_code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "RESOURCE_NOT_FOUND", "LIMIT_EXCEEDED", "CONFLICTING_OPERATION"
resp.failed_associations[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dataset_id (required, String) —

    The ID of the curated dataset to associate data segments with.

  • :workspace_name (required, String) —

    The name of the workspace that contains the dataset.

  • :associate_data_segment_entries (required, Array<Types::AssociateDataSegmentEntry>) —

    The list of data segment entries to associate with the dataset.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure that the request is idempotent. If you retry a request that completed successfully using the same client token, the retry succeeds without performing any further actions.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



683
684
685
686
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 683

def batch_associate_data_segments_to_dataset(params = {}, options = {})
  req = build_request(:batch_associate_data_segments_to_dataset, params)
  req.send_request(options)
end

#batch_associate_project_assets(params = {}) ⇒ Types::BatchAssociateProjectAssetsResponse

The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

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

Examples:

Request syntax with placeholder values


resp = client.batch_associate_project_assets({
  project_id: "ID", # required
  asset_ids: ["ID"], # required
  client_token: "ClientToken",
})

Response structure


resp.errors #=> Array
resp.errors[0].asset_id #=> String
resp.errors[0].code #=> String, one of "INTERNAL_FAILURE"
resp.errors[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :project_id (required, String) —

    The ID of the project to which to associate the assets.

  • :asset_ids (required, Array<String>) —

    The IDs of the assets to be associated to the project.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



736
737
738
739
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 736

def batch_associate_project_assets(params = {}, options = {})
  req = build_request(:batch_associate_project_assets, params)
  req.send_request(options)
end

#batch_delete_dataset_data_segments(params = {}) ⇒ Types::BatchDeleteDatasetDataSegmentsResponse

Deletes a batch of data segments from a session dataset. Deleting a data segment deletes the underlying time series data for the segment's time range.

Examples:

Request syntax with placeholder values


resp = client.batch_delete_dataset_data_segments({
  dataset_id: "ID", # required
  workspace_name: "WorkspaceName", # required
  delete_data_segment_entries: [ # required
    {
      time_series_id: "ID", # required
      start_timestamp: { # required
        time_in_seconds: 1, # required
        offset_in_nanos: 1,
      },
      end_timestamp: { # required
        time_in_seconds: 1, # required
        offset_in_nanos: 1,
      },
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.dataset_id #=> String
resp.dataset_version #=> String
resp.errors #=> Array
resp.errors[0].time_series_id #=> String
resp.errors[0].start_timestamp.time_in_seconds #=> Integer
resp.errors[0].start_timestamp.offset_in_nanos #=> Integer
resp.errors[0].end_timestamp.time_in_seconds #=> Integer
resp.errors[0].end_timestamp.offset_in_nanos #=> Integer
resp.errors[0].error_code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "RESOURCE_NOT_FOUND", "LIMIT_EXCEEDED", "CONFLICTING_OPERATION"
resp.errors[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dataset_id (required, String) —

    The ID of the session dataset from which to delete data segments.

  • :workspace_name (required, String) —

    The name of the workspace that contains the dataset.

  • :delete_data_segment_entries (required, Array<Types::DeleteDataSegmentEntry>) —

    The list of data segment entries to delete.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure that the request is idempotent. If you retry a request that completed successfully using the same client token, the retry succeeds without performing any further actions.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



805
806
807
808
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 805

def batch_delete_dataset_data_segments(params = {}, options = {})
  req = build_request(:batch_delete_dataset_data_segments, params)
  req.send_request(options)
end

#batch_disassociate_data_segments_from_dataset(params = {}) ⇒ Types::BatchDisassociateDataSegmentsFromDatasetResponse

Disassociates a batch of data segments from a curated dataset. Disassociating a data segment doesn't delete the underlying data in the source session dataset.

Examples:

Request syntax with placeholder values


resp = client.batch_disassociate_data_segments_from_dataset({
  dataset_id: "ID", # required
  workspace_name: "WorkspaceName", # required
  disassociate_data_segment_entries: [ # required
    {
      source_dataset_id: "ID", # required
      time_series_id: "TimeSeriesId", # required
      start_timestamp: { # required
        time_in_seconds: 1, # required
        offset_in_nanos: 1,
      },
      end_timestamp: { # required
        time_in_seconds: 1, # required
        offset_in_nanos: 1,
      },
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.dataset_id #=> String
resp.dataset_version #=> String
resp.failed_disassociations #=> Array
resp.failed_disassociations[0].source_dataset_id #=> String
resp.failed_disassociations[0].time_series_id #=> String
resp.failed_disassociations[0].start_timestamp.time_in_seconds #=> Integer
resp.failed_disassociations[0].start_timestamp.offset_in_nanos #=> Integer
resp.failed_disassociations[0].end_timestamp.time_in_seconds #=> Integer
resp.failed_disassociations[0].end_timestamp.offset_in_nanos #=> Integer
resp.failed_disassociations[0].error_code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "RESOURCE_NOT_FOUND", "LIMIT_EXCEEDED", "CONFLICTING_OPERATION"
resp.failed_disassociations[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dataset_id (required, String) —

    The ID of the curated dataset to disassociate data segments from.

  • :workspace_name (required, String) —

    The name of the workspace that contains the dataset.

  • :disassociate_data_segment_entries (required, Array<Types::DisassociateDataSegmentEntry>) —

    The list of data segment entries to disassociate from the dataset.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure that the request is idempotent. If you retry a request that completed successfully using the same client token, the retry succeeds without performing any further actions.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



876
877
878
879
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 876

def batch_disassociate_data_segments_from_dataset(params = {}, options = {})
  req = build_request(:batch_disassociate_data_segments_from_dataset, params)
  req.send_request(options)
end

#batch_disassociate_project_assets(params = {}) ⇒ Types::BatchDisassociateProjectAssetsResponse

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

Examples:

Request syntax with placeholder values


resp = client.batch_disassociate_project_assets({
  project_id: "ID", # required
  asset_ids: ["ID"], # required
  client_token: "ClientToken",
})

Response structure


resp.errors #=> Array
resp.errors[0].asset_id #=> String
resp.errors[0].code #=> String, one of "INTERNAL_FAILURE"
resp.errors[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :project_id (required, String) —

    The ID of the project from which to disassociate the assets.

  • :asset_ids (required, Array<String>) —

    The IDs of the assets to be disassociated from the project.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



919
920
921
922
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 919

def batch_disassociate_project_assets(params = {}, options = {})
  req = build_request(:batch_disassociate_project_assets, params)
  req.send_request(options)
end

#batch_get_asset_property_aggregates(params = {}) ⇒ Types::BatchGetAssetPropertyAggregatesResponse

Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. For more information, see Querying aggregates in the IoT SiteWise User Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.batch_get_asset_property_aggregates({
  entries: [ # required
    {
      entry_id: "EntryId", # required
      asset_id: "ID",
      property_id: "ID",
      property_alias: "AssetPropertyAlias",
      aggregate_types: ["AVERAGE"], # required, accepts AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION
      resolution: "Resolution", # required
      start_date: Time.now, # required
      end_date: Time.now, # required
      qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
      time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.error_entries #=> Array
resp.error_entries[0].error_code #=> String, one of "ResourceNotFoundException", "InvalidRequestException", "AccessDeniedException"
resp.error_entries[0].error_message #=> String
resp.error_entries[0].entry_id #=> String
resp.success_entries #=> Array
resp.success_entries[0].entry_id #=> String
resp.success_entries[0].aggregated_values #=> Array
resp.success_entries[0].aggregated_values[0].timestamp #=> Time
resp.success_entries[0].aggregated_values[0].quality #=> String, one of "GOOD", "BAD", "UNCERTAIN"
resp.success_entries[0].aggregated_values[0].value.average #=> Float
resp.success_entries[0].aggregated_values[0].value.count #=> Float
resp.success_entries[0].aggregated_values[0].value.maximum #=> Float
resp.success_entries[0].aggregated_values[0].value.minimum #=> Float
resp.success_entries[0].aggregated_values[0].value.sum #=> Float
resp.success_entries[0].aggregated_values[0].value.standard_deviation #=> Float
resp.skipped_entries #=> Array
resp.skipped_entries[0].entry_id #=> String
resp.skipped_entries[0].completion_status #=> String, one of "SUCCESS", "ERROR"
resp.skipped_entries[0].error_info.error_code #=> String, one of "ResourceNotFoundException", "InvalidRequestException", "AccessDeniedException"
resp.skipped_entries[0].error_info.error_timestamp #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :entries (required, Array<Types::BatchGetAssetPropertyAggregatesEntry>) —

    The list of asset property aggregate entries for the batch get request. You can specify up to 16 entries per request.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.

    • The size of the result set is equal to 1 MB.

    • The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 4000.

Returns:



1004
1005
1006
1007
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1004

def batch_get_asset_property_aggregates(params = {}, options = {})
  req = build_request(:batch_get_asset_property_aggregates, params)
  req.send_request(options)
end

#batch_get_asset_property_value(params = {}) ⇒ Types::BatchGetAssetPropertyValueResponse

Gets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.batch_get_asset_property_value({
  entries: [ # required
    {
      entry_id: "EntryId", # required
      asset_id: "ID",
      property_id: "ID",
      property_alias: "AssetPropertyAlias",
    },
  ],
  next_token: "NextToken",
})

Response structure


resp.error_entries #=> Array
resp.error_entries[0].error_code #=> String, one of "ResourceNotFoundException", "InvalidRequestException", "AccessDeniedException"
resp.error_entries[0].error_message #=> String
resp.error_entries[0].entry_id #=> String
resp.success_entries #=> Array
resp.success_entries[0].entry_id #=> String
resp.success_entries[0].asset_property_value.value.string_value #=> String
resp.success_entries[0].asset_property_value.value.integer_value #=> Integer
resp.success_entries[0].asset_property_value.value.double_value #=> Float
resp.success_entries[0].asset_property_value.value.boolean_value #=> Boolean
resp.success_entries[0].asset_property_value.value.null_value.value_type #=> String, one of "D", "B", "S", "I", "U"
resp.success_entries[0].asset_property_value.timestamp.time_in_seconds #=> Integer
resp.success_entries[0].asset_property_value.timestamp.offset_in_nanos #=> Integer
resp.success_entries[0].asset_property_value.quality #=> String, one of "GOOD", "BAD", "UNCERTAIN"
resp.skipped_entries #=> Array
resp.skipped_entries[0].entry_id #=> String
resp.skipped_entries[0].completion_status #=> String, one of "SUCCESS", "ERROR"
resp.skipped_entries[0].error_info.error_code #=> String, one of "ResourceNotFoundException", "InvalidRequestException", "AccessDeniedException"
resp.skipped_entries[0].error_info.error_timestamp #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :entries (required, Array<Types::BatchGetAssetPropertyValueEntry>) —

    The list of asset property value entries for the batch get request. You can specify up to 128 entries per request.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

Returns:



1072
1073
1074
1075
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1072

def batch_get_asset_property_value(params = {}, options = {})
  req = build_request(:batch_get_asset_property_value, params)
  req.send_request(options)
end

#batch_get_asset_property_value_history(params = {}) ⇒ Types::BatchGetAssetPropertyValueHistoryResponse

Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.batch_get_asset_property_value_history({
  entries: [ # required
    {
      entry_id: "EntryId", # required
      asset_id: "ID",
      property_id: "ID",
      property_alias: "AssetPropertyAlias",
      start_date: Time.now,
      end_date: Time.now,
      qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
      time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.error_entries #=> Array
resp.error_entries[0].error_code #=> String, one of "ResourceNotFoundException", "InvalidRequestException", "AccessDeniedException"
resp.error_entries[0].error_message #=> String
resp.error_entries[0].entry_id #=> String
resp.success_entries #=> Array
resp.success_entries[0].entry_id #=> String
resp.success_entries[0].asset_property_value_history #=> Array
resp.success_entries[0].asset_property_value_history[0].value.string_value #=> String
resp.success_entries[0].asset_property_value_history[0].value.integer_value #=> Integer
resp.success_entries[0].asset_property_value_history[0].value.double_value #=> Float
resp.success_entries[0].asset_property_value_history[0].value.boolean_value #=> Boolean
resp.success_entries[0].asset_property_value_history[0].value.null_value.value_type #=> String, one of "D", "B", "S", "I", "U"
resp.success_entries[0].asset_property_value_history[0].timestamp.time_in_seconds #=> Integer
resp.success_entries[0].asset_property_value_history[0].timestamp.offset_in_nanos #=> Integer
resp.success_entries[0].asset_property_value_history[0].quality #=> String, one of "GOOD", "BAD", "UNCERTAIN"
resp.skipped_entries #=> Array
resp.skipped_entries[0].entry_id #=> String
resp.skipped_entries[0].completion_status #=> String, one of "SUCCESS", "ERROR"
resp.skipped_entries[0].error_info.error_code #=> String, one of "ResourceNotFoundException", "InvalidRequestException", "AccessDeniedException"
resp.skipped_entries[0].error_info.error_timestamp #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :entries (required, Array<Types::BatchGetAssetPropertyValueHistoryEntry>) —

    The list of asset property historical value entries for the batch get request. You can specify up to 16 entries per request.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.

    • The size of the result set is equal to 4 MB.

    • The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 20000.

Returns:



1155
1156
1157
1158
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1155

def batch_get_asset_property_value_history(params = {}, options = {})
  req = build_request(:batch_get_asset_property_value_history, params)
  req.send_request(options)
end

#batch_put_asset_property_value(params = {}) ⇒ Types::BatchPutAssetPropertyValueResponse

Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

  • The assetId and propertyId of an asset property.

  • A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in the past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, +10 minutes] and returns a TimestampOutOfRangeException error.

For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}, then storing {T1, GOOD, V2} replaces the existing TQV.

IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorization in the IoT SiteWise User Guide.

Examples:

Request syntax with placeholder values


resp = client.batch_put_asset_property_value({
  enable_partial_entry_processing: false,
  entries: [ # required
    {
      entry_id: "EntryId", # required
      asset_id: "ID",
      property_id: "ID",
      property_alias: "AssetPropertyAlias",
      property_values: [ # required
        {
          value: { # required
            string_value: "PropertyValueStringValue",
            integer_value: 1,
            double_value: 1.0,
            boolean_value: false,
            null_value: {
              value_type: "D", # required, accepts D, B, S, I, U
            },
          },
          timestamp: { # required
            time_in_seconds: 1, # required
            offset_in_nanos: 1,
          },
          quality: "GOOD", # accepts GOOD, BAD, UNCERTAIN
        },
      ],
    },
  ],
})

Response structure


resp.error_entries #=> Array
resp.error_entries[0].entry_id #=> String
resp.error_entries[0].errors #=> Array
resp.error_entries[0].errors[0].error_code #=> String, one of "ResourceNotFoundException", "InvalidRequestException", "InternalFailureException", "ServiceUnavailableException", "ThrottlingException", "LimitExceededException", "ConflictingOperationException", "TimestampOutOfRangeException", "AccessDeniedException"
resp.error_entries[0].errors[0].error_message #=> String
resp.error_entries[0].errors[0].timestamps #=> Array
resp.error_entries[0].errors[0].timestamps[0].time_in_seconds #=> Integer
resp.error_entries[0].errors[0].timestamps[0].offset_in_nanos #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :enable_partial_entry_processing (Boolean) —

    This setting enables partial ingestion at entry-level. If set to true, we ingest all TQVs not resulting in an error. If set to false, an invalid TQV fails ingestion of the entire entry that contains it.

  • :entries (required, Array<Types::PutAssetPropertyValueEntry>) —

    The list of asset property value entries for the batch put request. You can specify up to 10 entries per request.

Returns:



1253
1254
1255
1256
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1253

def batch_put_asset_property_value(params = {}, options = {})
  req = build_request(:batch_put_asset_property_value, params)
  req.send_request(options)
end

#cancel_enrichment_job(params = {}) ⇒ Types::CancelEnrichmentJobResponse

Cancels a running or pending enrichment job. This is an idempotent operation—calling it multiple times with the same jobId is safe and returns the current status.

Behavior

  • Jobs in PENDING or RUNNING status transition to CANCELLED
  • Jobs in RUNNING state may not be cancellable once they have progressed to certain processing stages
  • Jobs already in terminal states (COMPLETED, FAILED, TIMED_OUT) cannot be cancelled; the operation returns a ConflictingOperationException
  • Cancelling an already-CANCELLED job is a no-op and returns the current status (idempotent behavior)
  • The API responds immediately after recording the cancellation
  • Cleanup of job resources happens asynchronously in the background

When to Cancel

Cancel a job when:

  • The job is taking longer than expected
  • The job was created with incorrect parameters
  • You no longer need the results

Idempotency

You can safely retry cancellation requests. Calling CancelEnrichmentJob multiple times for the same job returns the current status without error as long as the job is not in a terminal state other than CANCELLED.

Examples:

Request syntax with placeholder values


resp = client.cancel_enrichment_job({
  workspace_name: "WorkspaceName", # required
  job_id: "ID", # required
})

Response structure


resp.job_id #=> String
resp.status #=> String, one of "PENDING", "RUNNING", "COMPLETED", "FAILED", "TIMED_OUT", "CANCELLED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the IoT SiteWise workspace containing the enrichment job to cancel.

  • :job_id (required, String) —

    The unique identifier of the enrichment job to cancel. This is the jobId returned by CreateEnrichmentJob.

Returns:



1317
1318
1319
1320
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1317

def cancel_enrichment_job(params = {}, options = {})
  req = build_request(:cancel_enrichment_job, params)
  req.send_request(options)
end

#cancel_pipeline_execution(params = {}) ⇒ Types::CancelPipelineExecutionResponse

Cancels a pipeline execution in the specified workspace. If the execution is not in a terminal state (such as NOT_STARTED or RUNNING), it transitions to CANCELLING and asynchronously to CANCELLED. This operation is idempotent: calling it on an execution that is already CANCELLING or CANCELLED returns success with the current state. Calling it on a terminal execution (SUCCEEDED or FAILED) returns a conflict error. You can optionally provide a reason; it is returned in the stateDetails field when you describe the execution.

Examples:

Request syntax with placeholder values


resp = client.cancel_pipeline_execution({
  workspace_name: "WorkspaceName", # required
  pipeline_name: "ResourceName", # required
  pipeline_execution_id: "ID", # required
  reason: "CancelPipelineExecutionRequestReasonString",
})

Response structure


resp.state #=> String, one of "NOT_STARTED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace.

  • :pipeline_name (required, String) —

    The name of the pipeline.

  • :pipeline_execution_id (required, String) —

    The unique identifier of the pipeline execution.

  • :reason (String) —

    A message describing why the pipeline execution is being cancelled.

Returns:



1363
1364
1365
1366
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1363

def cancel_pipeline_execution(params = {}, options = {})
  req = build_request(:cancel_pipeline_execution, params)
  req.send_request(options)
end

#cancel_query(params = {}) ⇒ Types::CancelQueryResponse

Cancels a running query.

Examples:

Request syntax with placeholder values


resp = client.cancel_query({
  workspace_name: "WorkspaceName", # required
  query_id: "QueryId", # required
})

Response structure


resp.query_id #=> String
resp.status #=> String, one of "SUBMITTED", "RUNNING", "COMPLETED", "FAILED", "CANCELED", "CANCELING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace associated with the query.

  • :query_id (required, String) —

    The unique identifier for the query execution to cancel.

Returns:



1395
1396
1397
1398
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1395

def cancel_query(params = {}, options = {})
  req = build_request(:cancel_query, params)
  req.send_request(options)
end

#create_access_policy(params = {}) ⇒ Types::CreateAccessPolicyResponse

The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

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.

Support for access policies that use an SSO Group as the identity is not supported at this time.

Examples:

Request syntax with placeholder values


resp = client.create_access_policy({
  access_policy_identity: { # required
    user: {
      id: "IdentityId", # required
    },
    group: {
      id: "IdentityId", # required
    },
    iam_user: {
      arn: "IamArn", # required
    },
    iam_role: {
      arn: "IamArn", # required
    },
  },
  access_policy_resource: { # required
    portal: {
      id: "ID", # required
    },
    project: {
      id: "ID", # required
    },
  },
  access_policy_permission: "ADMINISTRATOR", # required, accepts ADMINISTRATOR, VIEWER
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.access_policy_id #=> String
resp.access_policy_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :access_policy_identity (required, Types::Identity) —

    The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.

  • :access_policy_resource (required, Types::Resource) —

    The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.

  • :access_policy_permission (required, String) —

    The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) —

    A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

Returns:



1492
1493
1494
1495
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1492

def create_access_policy(params = {}, options = {})
  req = build_request(:create_access_policy, params)
  req.send_request(options)
end

#create_application(params = {}) ⇒ Types::CreateApplicationResponse

Creates a new application for the workspace and IdC application provided

Examples:

Request syntax with placeholder values


resp = client.create_application({
  client_token: "ClientToken",
  idc_instance_arn: "ARN", # required
  workspace_name: "WorkspaceName", # required
  name: "ApplicationName", # required
  description: "Description",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.id #=> String
resp.dns_subdomain #=> String
resp.name #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    Unique client token for idempotent request handling

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :idc_instance_arn (required, String) —

    Identity Center Instance ARN to create the application in

  • :workspace_name (required, String) —

    Name of the workspace to associate with the underlying Application

  • :name (required, String) —

    Name of the application

  • :description (String) —

    Description of the application

  • :tags (Hash<String,String>) —

    A list of key-value pairs that contain metadata for the application.

Returns:



1552
1553
1554
1555
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1552

def create_application(params = {}, options = {})
  req = build_request(:create_application, params)
  req.send_request(options)
end

#create_asset(params = {}) ⇒ Types::CreateAssetResponse

Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide.

Examples:

Request syntax with placeholder values


resp = client.create_asset({
  asset_name: "Name", # required
  asset_model_id: "CustomID", # required
  asset_id: "ID",
  asset_external_id: "ExternalId",
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
  asset_description: "Description",
})

Response structure


resp.asset_id #=> String
resp.asset_arn #=> String
resp.asset_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.asset_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.asset_status.error.message #=> String
resp.asset_status.error.details #=> Array
resp.asset_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.asset_status.error.details[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_name (required, String) —

    A friendly name for the asset.

  • :asset_model_id (required, String) —

    The ID of the asset model from which to create the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :asset_id (String) —

    The ID to assign to the asset, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

  • :asset_external_id (String) —

    An external ID to assign to the asset. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) —

    A list of key-value pairs that contain metadata for the asset. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

  • :asset_description (String) —

    A description for the asset.

Returns:



1646
1647
1648
1649
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1646

def create_asset(params = {}, options = {})
  req = build_request(:create_asset, params)
  req.send_request(options)
end

#create_asset_model(params = {}) ⇒ Types::CreateAssetModelResponse

Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide.

You can create three types of asset models, ASSET_MODEL, COMPONENT_MODEL, or an INTERFACE.

  • ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

  • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

  • INTERFACE – An interface is a type of model that defines a standard structure that can be applied to different asset models.

Examples:

Request syntax with placeholder values


resp = client.create_asset_model({
  asset_model_name: "Name", # required
  asset_model_type: "ASSET_MODEL", # accepts ASSET_MODEL, COMPONENT_MODEL, INTERFACE
  asset_model_id: "ID",
  asset_model_external_id: "ExternalId",
  asset_model_description: "Description",
  asset_model_properties: [
    {
      id: "ID",
      external_id: "ExternalId",
      name: "Name", # required
      data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT, VIDEO, ANNOTATION, JSON
      data_type_spec: "Name",
      unit: "PropertyUnit",
      type: { # required
        attribute: {
          default_value: "DefaultValue",
        },
        measurement: {
          processing_config: {
            forwarding_config: { # required
              state: "DISABLED", # required, accepts DISABLED, ENABLED
            },
          },
        },
        transform: {
          expression: "Expression", # required
          variables: [ # required
            {
              name: "VariableName", # required
              value: { # required
                property_id: "Macro",
                hierarchy_id: "Macro",
                property_path: [
                  {
                    id: "ID",
                    name: "Name",
                  },
                ],
              },
            },
          ],
          processing_config: {
            compute_location: "EDGE", # required, accepts EDGE, CLOUD
            forwarding_config: {
              state: "DISABLED", # required, accepts DISABLED, ENABLED
            },
          },
        },
        metric: {
          expression: "Expression",
          variables: [
            {
              name: "VariableName", # required
              value: { # required
                property_id: "Macro",
                hierarchy_id: "Macro",
                property_path: [
                  {
                    id: "ID",
                    name: "Name",
                  },
                ],
              },
            },
          ],
          window: { # required
            tumbling: {
              interval: "Interval", # required
              offset: "Offset",
            },
          },
          processing_config: {
            compute_location: "EDGE", # required, accepts EDGE, CLOUD
          },
        },
      },
    },
  ],
  asset_model_hierarchies: [
    {
      id: "ID",
      external_id: "ExternalId",
      name: "Name", # required
      child_asset_model_id: "CustomID", # required
    },
  ],
  asset_model_composite_models: [
    {
      id: "ID",
      external_id: "ExternalId",
      name: "Name", # required
      description: "Description",
      type: "Name", # required
      properties: [
        {
          id: "ID",
          external_id: "ExternalId",
          name: "Name", # required
          data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT, VIDEO, ANNOTATION, JSON
          data_type_spec: "Name",
          unit: "PropertyUnit",
          type: { # required
            attribute: {
              default_value: "DefaultValue",
            },
            measurement: {
              processing_config: {
                forwarding_config: { # required
                  state: "DISABLED", # required, accepts DISABLED, ENABLED
                },
              },
            },
            transform: {
              expression: "Expression", # required
              variables: [ # required
                {
                  name: "VariableName", # required
                  value: { # required
                    property_id: "Macro",
                    hierarchy_id: "Macro",
                    property_path: [
                      {
                        id: "ID",
                        name: "Name",
                      },
                    ],
                  },
                },
              ],
              processing_config: {
                compute_location: "EDGE", # required, accepts EDGE, CLOUD
                forwarding_config: {
                  state: "DISABLED", # required, accepts DISABLED, ENABLED
                },
              },
            },
            metric: {
              expression: "Expression",
              variables: [
                {
                  name: "VariableName", # required
                  value: { # required
                    property_id: "Macro",
                    hierarchy_id: "Macro",
                    property_path: [
                      {
                        id: "ID",
                        name: "Name",
                      },
                    ],
                  },
                },
              ],
              window: { # required
                tumbling: {
                  interval: "Interval", # required
                  offset: "Offset",
                },
              },
              processing_config: {
                compute_location: "EDGE", # required, accepts EDGE, CLOUD
              },
            },
          },
        },
      ],
    },
  ],
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.asset_model_id #=> String
resp.asset_model_arn #=> String
resp.asset_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED"
resp.asset_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.asset_model_status.error.message #=> String
resp.asset_model_status.error.details #=> Array
resp.asset_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.asset_model_status.error.details[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_model_name (required, String) —

    A unique name for the asset model.

  • :asset_model_type (String) —

    The type of asset model.

    • ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

    • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

  • :asset_model_id (String) —

    The ID to assign to the asset model, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

  • :asset_model_external_id (String) —

    An external ID to assign to the asset model. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.

  • :asset_model_description (String) —

    A description for the asset model.

  • :asset_model_properties (Array<Types::AssetModelPropertyDefinition>) —

    The property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.

    You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

  • :asset_model_hierarchies (Array<Types::AssetModelHierarchyDefinition>) —

    The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

    You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

  • :asset_model_composite_models (Array<Types::AssetModelCompositeModelDefinition>) —

    The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

    When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see Creating custom composite models (Components) in the IoT SiteWise User Guide.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) —

    A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

Returns:



1968
1969
1970
1971
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 1968

def create_asset_model(params = {}, options = {})
  req = build_request(:create_asset_model, params)
  req.send_request(options)
end

#create_asset_model_composite_model(params = {}) ⇒ Types::CreateAssetModelCompositeModelResponse

Creates a custom composite model from specified property and hierarchy definitions. There are two types of custom composite models, inline and component-model-based.

Use component-model-based custom composite models to define standard, reusable components. A component-model-based custom composite model consists of a name, a description, and the ID of the component model it references. A component-model-based custom composite model has no properties of its own; its referenced component model provides its associated properties to any created assets. For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.

Use inline custom composite models to organize the properties of an asset model. The properties of inline custom composite models are local to the asset model where they are included and can't be used to create multiple assets.

To create a component-model-based model, specify the composedAssetModelId of an existing asset model with assetModelType of COMPONENT_MODEL.

To create an inline model, specify the assetModelCompositeModelProperties and don't include an composedAssetModelId.

Examples:

Request syntax with placeholder values


resp = client.create_asset_model_composite_model({
  asset_model_id: "CustomID", # required
  asset_model_composite_model_external_id: "ExternalId",
  parent_asset_model_composite_model_id: "CustomID",
  asset_model_composite_model_id: "ID",
  asset_model_composite_model_description: "Description",
  asset_model_composite_model_name: "Name", # required
  asset_model_composite_model_type: "Name", # required
  client_token: "ClientToken",
  composed_asset_model_id: "CustomID",
  asset_model_composite_model_properties: [
    {
      id: "ID",
      external_id: "ExternalId",
      name: "Name", # required
      data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT, VIDEO, ANNOTATION, JSON
      data_type_spec: "Name",
      unit: "PropertyUnit",
      type: { # required
        attribute: {
          default_value: "DefaultValue",
        },
        measurement: {
          processing_config: {
            forwarding_config: { # required
              state: "DISABLED", # required, accepts DISABLED, ENABLED
            },
          },
        },
        transform: {
          expression: "Expression", # required
          variables: [ # required
            {
              name: "VariableName", # required
              value: { # required
                property_id: "Macro",
                hierarchy_id: "Macro",
                property_path: [
                  {
                    id: "ID",
                    name: "Name",
                  },
                ],
              },
            },
          ],
          processing_config: {
            compute_location: "EDGE", # required, accepts EDGE, CLOUD
            forwarding_config: {
              state: "DISABLED", # required, accepts DISABLED, ENABLED
            },
          },
        },
        metric: {
          expression: "Expression",
          variables: [
            {
              name: "VariableName", # required
              value: { # required
                property_id: "Macro",
                hierarchy_id: "Macro",
                property_path: [
                  {
                    id: "ID",
                    name: "Name",
                  },
                ],
              },
            },
          ],
          window: { # required
            tumbling: {
              interval: "Interval", # required
              offset: "Offset",
            },
          },
          processing_config: {
            compute_location: "EDGE", # required, accepts EDGE, CLOUD
          },
        },
      },
    },
  ],
  if_match: "ETag",
  if_none_match: "SelectAll",
  match_for_version_type: "LATEST", # accepts LATEST, ACTIVE
})

Response structure


resp.asset_model_composite_model_id #=> String
resp.asset_model_composite_model_path #=> Array
resp.asset_model_composite_model_path[0].id #=> String
resp.asset_model_composite_model_path[0].name #=> String
resp.asset_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED"
resp.asset_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.asset_model_status.error.message #=> String
resp.asset_model_status.error.details #=> Array
resp.asset_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.asset_model_status.error.details[0].message #=> String
resp.asset_model_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_model_id (required, String) —

    The ID of the asset model this composite model is a part of.

  • :asset_model_composite_model_external_id (String) —

    An external ID to assign to the composite model.

    If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it's a part of.

  • :parent_asset_model_composite_model_id (String) —

    The ID of the parent composite model in this asset model relationship.

  • :asset_model_composite_model_id (String) —

    The ID of the composite model. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

  • :asset_model_composite_model_description (String) —

    A description for the composite model.

  • :asset_model_composite_model_name (required, String) —

    A unique name for the composite model.

  • :asset_model_composite_model_type (required, String) —

    The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :composed_asset_model_id (String) —

    The ID of a component model which is reused to create this composite model.

  • :asset_model_composite_model_properties (Array<Types::AssetModelPropertyDefinition>) —

    The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide.

    You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.

  • :if_match (String) —

    The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The create request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.

  • :if_none_match (String) —

    Accepts ***** to reject the create request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.

  • :match_for_version_type (String) —

    Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the create operation.

Returns:



2192
2193
2194
2195
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2192

def create_asset_model_composite_model(params = {}, options = {})
  req = build_request(:create_asset_model_composite_model, params)
  req.send_request(options)
end

#create_bulk_import_job(params = {}) ⇒ Types::CreateBulkImportJobResponse

Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.

Before you create a bulk import job that ingests data into time series outside of a workspace, you must enable IoT SiteWise warm tier or IoT SiteWise cold tier. For more information about how to configure storage settings, see PutStorageConfiguration. This requirement doesn't apply to bulk import jobs that ingest data into a session dataset in a workspace (jobs that specify a workspaceName and datasetId). Those jobs don't use IoT SiteWise warm or cold tier storage.

Bulk import is designed to store historical data to IoT SiteWise.

  • Newly ingested data in the hot tier triggers notifications and computations.

  • After data moves from the hot tier to the warm or cold tier based on retention settings, it does not trigger computations or notifications.

  • Data older than 7 days does not trigger computations or notifications.

Examples:

Request syntax with placeholder values


resp = client.create_bulk_import_job({
  job_name: "BulkImportJobName", # required
  job_role_arn: "ARN", # required
  files: [ # required
    {
      bucket: "Bucket", # required
      key: "String", # required
      version_id: "String",
      alias: "AssetPropertyAlias",
      start_time: {
        time_in_seconds: 1, # required
        offset_in_nanos: 1,
      },
      file_format: {
        csv: {
          column_names: ["ALIAS"], # required, accepts ALIAS, ASSET_ID, PROPERTY_ID, DATA_TYPE, TIMESTAMP_SECONDS, TIMESTAMP_NANO_OFFSET, QUALITY, VALUE
        },
        parquet: {
        },
        mp4: {
        },
        annotation: {
        },
      },
    },
  ],
  error_report_location: { # required
    bucket: "Bucket", # required
    prefix: "String", # required
  },
  job_configuration: {
    file_format: {
      csv: {
        column_names: ["ALIAS"], # required, accepts ALIAS, ASSET_ID, PROPERTY_ID, DATA_TYPE, TIMESTAMP_SECONDS, TIMESTAMP_NANO_OFFSET, QUALITY, VALUE
      },
      parquet: {
      },
      mp4: {
      },
      annotation: {
      },
    },
  },
  adaptive_ingestion: false,
  delete_files_after_import: false,
  dataset_id: "ID",
  workspace_name: "WorkspaceName",
})

Response structure


resp.job_id #=> String
resp.job_name #=> String
resp.job_status #=> String, one of "PENDING", "CANCELLED", "RUNNING", "COMPLETED", "FAILED", "COMPLETED_WITH_FAILURES"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_name (required, String) —

    The unique name that helps identify the job request.

  • :job_role_arn (required, String) —

    The ARN of the IAM role that allows IoT SiteWise to read Amazon S3 data.

  • :files (required, Array<Types::File>) —

    The files in the specified Amazon S3 bucket that contain your data. You can specify up to 100 files for each bulk import job. Each file supports the following size limits:

    • Parquet files – Up to 256 MiB.

    • Other file formats – Up to 5 GiB.

  • :error_report_location (required, Types::ErrorReportLocation) —

    The Amazon S3 destination where errors associated with the job creation request are saved.

  • :job_configuration (Types::JobConfiguration) —

    Contains the configuration information of a job, such as the file format used to save data in Amazon S3.

  • :adaptive_ingestion (Boolean) —

    If set to true, ingest new data into IoT SiteWise storage. Measurements with notifications, metrics and transforms are computed. If set to false, historical data is ingested into IoT SiteWise as is.

  • :delete_files_after_import (Boolean) —

    If set to true, your data files is deleted from S3, after ingestion into IoT SiteWise storage.

  • :dataset_id (String) —

    The ID of the session dataset to ingest data into. Specify this field, together with workspaceName, to ingest data into a session dataset in a workspace.

  • :workspace_name (String) —

    The name of the workspace that contains the session dataset. Specify this field together with datasetId.

Returns:



2338
2339
2340
2341
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2338

def create_bulk_import_job(params = {}, options = {})
  req = build_request(:create_bulk_import_job, params)
  req.send_request(options)
end

#create_computation_model(params = {}) ⇒ Types::CreateComputationModelResponse

Create a computation model with a configuration and data binding.

Examples:

Request syntax with placeholder values


resp = client.create_computation_model({
  computation_model_name: "RestrictedName", # required
  computation_model_description: "RestrictedDescription",
  computation_model_configuration: { # required
    anomaly_detection: {
      input_properties: "InputProperties", # required
      result_property: "ResultProperty", # required
    },
  },
  computation_model_data_binding: { # required
    "ComputationModelDataBindingVariable" => {
      asset_model_property: {
        asset_model_id: "ID", # required
        property_id: "ID", # required
      },
      asset_property: {
        asset_id: "ID", # required
        property_id: "ID", # required
      },
      list: [
        {
          # recursive ComputationModelDataBindingValue
        },
      ],
    },
  },
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.computation_model_id #=> String
resp.computation_model_arn #=> String
resp.computation_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.computation_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.computation_model_status.error.message #=> String
resp.computation_model_status.error.details #=> Array
resp.computation_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.computation_model_status.error.details[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :computation_model_name (required, String) —

    The name of the computation model.

  • :computation_model_description (String) —

    The description of the computation model.

  • :computation_model_configuration (required, Types::ComputationModelConfiguration) —

    The configuration for the computation model.

  • :computation_model_data_binding (required, Hash<String,Types::ComputationModelDataBindingValue>) —

    The data binding for the computation model. Key is a variable name defined in configuration. Value is a ComputationModelDataBindingValue referenced by the variable.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) —

    A list of key-value pairs that contain metadata for the asset. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

Returns:



2429
2430
2431
2432
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2429

def create_computation_model(params = {}, options = {})
  req = build_request(:create_computation_model, params)
  req.send_request(options)
end

#create_dashboard(params = {}) ⇒ Types::CreateDashboardResponse

The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

Creates a dashboard in an IoT SiteWise Monitor project.

Examples:

Request syntax with placeholder values


resp = client.create_dashboard({
  project_id: "ID", # required
  dashboard_name: "Name", # required
  dashboard_description: "Description",
  dashboard_definition: "DashboardDefinition", # required
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.dashboard_id #=> String
resp.dashboard_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :project_id (required, String) —

    The ID of the project in which to create the dashboard.

  • :dashboard_name (required, String) —

    A friendly name for the dashboard.

  • :dashboard_description (String) —

    A description for the dashboard.

  • :dashboard_definition (required, String) —

    The dashboard definition specified in a JSON literal.

    in the IoT SiteWise User Guide

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) —

    A list of key-value pairs that contain metadata for the dashboard. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

Returns:



2511
2512
2513
2514
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2511

def create_dashboard(params = {}, options = {})
  req = build_request(:create_dashboard, params)
  req.send_request(options)
end

#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse

Creates a dataset. Session and curated datasets are created in a workspace. A session dataset contains data segments of time series data, and a curated dataset curates data segments selected from source session datasets. A dataset that connects to an external datasource is created outside of a workspace.

Examples:

Request syntax with placeholder values


resp = client.create_dataset({
  dataset_id: "ID",
  dataset_name: "RestrictedName", # required
  dataset_description: "Description",
  dataset_type: "SESSION", # accepts SESSION, CURATED, EXTERNAL
  dataset_config: {
    session: {
      session_start_timestamp: { # required
        time_in_seconds: 1, # required
        offset_in_nanos: 1,
      },
      session_end_timestamp: { # required
        time_in_seconds: 1, # required
        offset_in_nanos: 1,
      },
    },
  },
  workspace_name: "WorkspaceName",
  metadata: {
    "MetadataKey" => "MetadataValue",
  },
  dataset_source: { # required
    source_type: "KENDRA", # required, accepts KENDRA, SITEWISE
    source_format: "KNOWLEDGE_BASE", # required, accepts KNOWLEDGE_BASE, TIMESERIES
    source_detail: {
      kendra: {
        knowledge_base_arn: "ARN", # required
        role_arn: "ARN", # required
      },
    },
  },
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.dataset_id #=> String
resp.dataset_arn #=> String
resp.dataset_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.dataset_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.dataset_status.error.message #=> String
resp.dataset_status.error.details #=> Array
resp.dataset_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.dataset_status.error.details[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dataset_id (String) —

    The ID of the dataset.

  • :dataset_name (required, String) —

    The name of the dataset.

  • :dataset_description (String) —

    A description about the dataset, and its functionality.

  • :dataset_type (String) —

    The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.

  • :dataset_config (Types::DatasetConfig) —

    The configuration for the dataset.

  • :workspace_name (String) —

    The name of the workspace that contains the dataset. Required for session and curated datasets. Omit this field for datasets that connect to an external datasource.

  • :metadata (Hash<String,String>) —

    The metadata for the dataset, provided as key-value pairs.

  • :dataset_source (required, Types::DatasetSource) —

    The data source for the dataset.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) —

    A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

Returns:



2624
2625
2626
2627
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2624

def create_dataset(params = {}, options = {})
  req = build_request(:create_dataset, params)
  req.send_request(options)
end

#create_dataset_export_job(params = {}) ⇒ Types::CreateDatasetExportJobResponse

Starts an asynchronous job that exports dataset and time-series data from a workspace to Amazon S3. The operation returns a jobId immediately; poll DescribeDatasetExportJob to track progress and ListDatasetExportJobs to enumerate a workspace's jobs.

Examples:

Request syntax with placeholder values


resp = client.create_dataset_export_job({
  workspace_name: "WorkspaceName", # required
  client_token: "ClientToken",
  destination_s3_uri: "S3Uri", # required
  input: { # required
    timeseries: [
      {
        time_series_id: "TimeSeriesId",
        property_alias: "AssetPropertyAlias",
        trim_settings: {
          start_time: { # required
            time_in_seconds: 1, # required
            offset_in_nanos: 1,
          },
          end_time: { # required
            time_in_seconds: 1, # required
            offset_in_nanos: 1,
          },
        },
        format_settings: {
          frames_per_second: 1,
          width_in_pixels: 1,
          height_in_pixels: 1,
        },
      },
    ],
    dataset: {
      dataset_id: "DatasetId", # required
      trim_settings: {
        start_time: { # required
          time_in_seconds: 1, # required
          offset_in_nanos: 1,
        },
        end_time: { # required
          time_in_seconds: 1, # required
          offset_in_nanos: 1,
        },
      },
      export_data_types: ["VIDEO"], # accepts VIDEO, TELEMETRY, ANNOTATION
    },
  },
  error_report_location: { # required
    s3_uri: "S3Uri", # required
  },
})

Response structure


resp.job_id #=> String
resp.workspace_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace in which to create the dataset export job.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The AWS SDKs and CLI populate this automatically.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :destination_s3_uri (required, String) —

    The S3 URI where output clips will be written.

  • :input (required, Types::ProcessingInput) —

    The processing input source.

  • :error_report_location (required, Types::ExportErrorReportLocation) —

    The location where the error report will be written on failure.

Returns:



2714
2715
2716
2717
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2714

def create_dataset_export_job(params = {}, options = {})
  req = build_request(:create_dataset_export_job, params)
  req.send_request(options)
end

#create_enrichment_job(params = {}) ⇒ Types::CreateEnrichmentJobResponse

Creates an asynchronous enrichment job to analyze time-series sensor data. The operation returns immediately with job details while processing continues in the background.

Idempotency

Include a clientToken to make the operation idempotent. If you submit the same request with the same token within the idempotency window, you receive the original job details without creating a duplicate.

Prerequisites

Before creating a job, ensure:

  • The workspace is in ACTIVE state (not being deleted)
  • You have IAM permissions for the workspace, dataset, and time-series resources
  • You have KMS Decrypt permission on the workspace's customer-managed encryption key
  • No duplicate job (same workspace, dataset, property, and job type) is currently running

Workflow

  1. Submit the job with configuration specifying which video data to analyze and the time range
  2. Capture the jobId from the response
  3. Use DescribeEnrichmentJob to monitor progress and check job status
  4. When status reaches a terminal state (COMPLETED, FAILED, TIMED_OUT, CANCELLED), check results
  5. For COMPLETED jobs, query IoT SiteWise for semantic search on video events

Error Handling

  • ConflictingOperationException: A duplicate job is already running for the same configuration
  • InvalidRequestException: Invalid parameters (e.g., both timeSeriesId and propertyAlias specified)
  • AccessDeniedException: Insufficient IAM or KMS permissions
  • LimitExceededException: Too many concurrent jobs or requests

Examples:

Request syntax with placeholder values


resp = client.create_enrichment_job({
  workspace_name: "WorkspaceName", # required
  job_configuration: { # required
    event_detection: {
      dataset_id: "ID", # required
      time_series_id: "TimeSeriesId",
      property_alias: "AssetPropertyAlias",
      trim_settings: { # required
        start_time: { # required
          time_in_seconds: 1, # required
          offset_in_nanos: 1,
        },
        end_time: { # required
          time_in_seconds: 1, # required
          offset_in_nanos: 1,
        },
      },
    },
  },
  client_token: "ClientToken",
})

Response structure


resp.job_id #=> String
resp.status #=> String, one of "PENDING", "RUNNING", "COMPLETED", "FAILED", "TIMED_OUT", "CANCELLED"
resp.created_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the IoT SiteWise workspace containing the video data to analyze.

  • :job_configuration (required, Types::EnrichmentJobConfiguration) —

    Configuration defining the type of enrichment analysis to perform and which video data to analyze. Currently supports eventDetection for generating embeddings from video data for semantic search.

  • :client_token (String) —

    Optional unique token that makes the operation idempotent. If you submit the same request with the same token within the idempotency window, the service returns the original job without creating a duplicate. Use a UUID or timestamp-based token for each unique request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



2818
2819
2820
2821
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2818

def create_enrichment_job(params = {}, options = {})
  req = build_request(:create_enrichment_job, params)
  req.send_request(options)
end

#create_gateway(params = {}) ⇒ Types::CreateGatewayResponse

Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise. For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide.

Examples:

Request syntax with placeholder values


resp = client.create_gateway({
  gateway_name: "GatewayName", # required
  gateway_platform: { # required
    greengrass: {
      group_arn: "ARN", # required
    },
    greengrass_v2: {
      core_device_thing_name: "CoreDeviceThingName", # required
      core_device_operating_system: "LINUX_AARCH64", # accepts LINUX_AARCH64, LINUX_AMD64, WINDOWS_AMD64
    },
    siemens_ie: {
      iot_core_thing_name: "IotCoreThingName", # required
    },
  },
  gateway_version: "GatewayVersion",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.gateway_id #=> String
resp.gateway_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :gateway_name (required, String) —

    A unique name for the gateway.

  • :gateway_platform (required, Types::GatewayPlatform) —

    The gateway's platform. You can only specify one platform in a gateway.

  • :gateway_version (String) —

    The version of the gateway to create. Specify 3 to create an MQTT-enabled, V3 gateway and 2 to create a Classic streams, V2 gateway. If not specified, the default is 2 (Classic streams, V2 gateway).

    When creating a V3 gateway (gatewayVersion=3) with the GreengrassV2 platform, you must also specify the coreDeviceOperatingSystem parameter.

    We recommend creating an MQTT-enabled gateway for self-hosted gateways and Siemens Industrial Edge gateways. For more information on gateway versions, see Use Amazon Web Services IoT SiteWise Edge Edge gateways.

  • :tags (Hash<String,String>) —

    A list of key-value pairs that contain metadata for the gateway. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

Returns:



2903
2904
2905
2906
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 2903

def create_gateway(params = {}, options = {})
  req = build_request(:create_gateway, params)
  req.send_request(options)
end

#create_pipeline(params = {}) ⇒ Types::CreatePipelineResponse

Creates a new pipeline in the specified workspace. A pipeline defines a directed acyclic graph (DAG) of compute nodes, where each node references a task and can declare dependencies on other nodes. Cyclic dependencies are not allowed. Nodes without dependencies run in parallel, while nodes with dependencies wait for all upstream nodes to complete successfully before starting.

You can set environment variables at the pipeline level that are shared across all compute nodes, and override them at the individual compute node level.

Examples:

Request syntax with placeholder values


resp = client.create_pipeline({
  workspace_name: "WorkspaceName", # required
  pipeline_name: "ResourceName", # required
  description: "Description",
  environment_variables: {
    "EnvironmentVariableName" => "EnvironmentVariableValue",
  },
  computations: [ # required
    {
      compute_node_name: "ResourceName", # required
      task_name: "ResourceName", # required
      environment_variables: {
        "EnvironmentVariableName" => "EnvironmentVariableValue",
      },
      depends_on: ["ResourceName"],
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
  client_token: "ClientToken",
})

Response structure


resp.pipeline_name #=> String
resp.pipeline_arn #=> String
resp.version #=> String
resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.status.error.message #=> String
resp.status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace.

  • :pipeline_name (required, String) —

    The name of the pipeline to create. Must be unique within the workspace.

  • :description (String) —

    A description of the pipeline.

  • :environment_variables (Hash<String,String>) —

    Environment variables shared across all compute nodes in the pipeline. Individual compute nodes can override these values with their own environment variables.

  • :computations (required, Array<Types::ComputeNode>) —

    The list of compute nodes that form the pipeline DAG. Each compute node references a task and can declare dependencies on other nodes.

  • :tags (Hash<String,String>) —

    A list of key-value pairs that contain metadata for the pipeline. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the server returns the cached result from the original successful request without performing the operation again.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



3000
3001
3002
3003
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3000

def create_pipeline(params = {}, options = {})
  req = build_request(:create_pipeline, params)
  req.send_request(options)
end

#create_portal(params = {}) ⇒ Types::CreatePortalResponse

The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center or IAM to authenticate portal users and manage user permissions.

Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the IoT SiteWise User Guide.

Examples:

Request syntax with placeholder values


resp = client.create_portal({
  portal_name: "Name", # required
  portal_description: "Description",
  portal_contact_email: "Email", # required
  client_token: "ClientToken",
  portal_logo_image_file: {
    data: "data", # required
    type: "PNG", # required, accepts PNG
  },
  role_arn: "IamArn", # required
  tags: {
    "TagKey" => "TagValue",
  },
  portal_auth_mode: "IAM", # accepts IAM, SSO
  notification_sender_email: "Email",
  alarms: {
    alarm_role_arn: "IamArn", # required
    notification_lambda_arn: "ARN",
  },
  portal_type: "SITEWISE_PORTAL_V1", # accepts SITEWISE_PORTAL_V1, SITEWISE_PORTAL_V2
  portal_type_configuration: {
    "PortalTypeKey" => {
      portal_tools: ["Name"],
    },
  },
})

Response structure


resp.portal_id #=> String
resp.portal_arn #=> String
resp.portal_start_url #=> String
resp.portal_status.state #=> String, one of "CREATING", "PENDING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "LIMIT_EXCEEDED"
resp.portal_status.error.message #=> String
resp.sso_application_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :portal_name (required, String) —

    A friendly name for the portal.

  • :portal_description (String) —

    A description for the portal.

  • :portal_contact_email (required, String) —

    The Amazon Web Services administrator's contact email address.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :portal_logo_image_file (Types::ImageFile) —

    A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.

  • :role_arn (required, String) —

    The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.

  • :tags (Hash<String,String>) —

    A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

  • :portal_auth_mode (String) —

    The service to use to authenticate users to the portal. Choose from the following options:

    • SSO – The portal uses IAM Identity Center to authenticate users and manage user permissions. Before you can create a portal that uses IAM Identity Center, you must enable IAM Identity Center. For more information, see Enabling IAM Identity Center in the IoT SiteWise User Guide. This option is only available in Amazon Web Services Regions other than the China Regions.

    • IAM – The portal uses Identity and Access Management to authenticate users and manage user permissions.

    You can't change this value after you create a portal.

    Default: SSO

  • :notification_sender_email (String) —

    The email address that sends alarm notifications.

    If you use the IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES.

  • :alarms (Types::Alarms) —

    Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.

  • :portal_type (String) —

    Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

  • :portal_type_configuration (Hash<String,Types::PortalTypeEntry>) —

    The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

Returns:



3170
3171
3172
3173
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3170

def create_portal(params = {}, options = {})
  req = build_request(:create_portal, params)
  req.send_request(options)
end

#create_project(params = {}) ⇒ Types::CreateProjectResponse

The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

Creates a project in the specified portal.

Make sure that the project name and description don't contain confidential information.

Examples:

Request syntax with placeholder values


resp = client.create_project({
  portal_id: "ID", # required
  project_name: "Name", # required
  project_description: "Description",
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.project_id #=> String
resp.project_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :portal_id (required, String) —

    The ID of the portal in which to create the project.

  • :project_name (required, String) —

    A friendly name for the project.

  • :project_description (String) —

    A description for the project.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) —

    A list of key-value pairs that contain metadata for the project. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

Returns:



3242
3243
3244
3245
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3242

def create_project(params = {}, options = {})
  req = build_request(:create_project, params)
  req.send_request(options)
end

#create_task(params = {}) ⇒ Types::CreateTaskResponse

Creates a new task in the specified workspace. A task defines a reusable containerized compute workload that can be referenced by one or more pipeline compute nodes.

Specify a containerTaskConfiguration for custom container workloads with configurable ECR image, processing type, processing unit, and environment variables.

Examples:

Request syntax with placeholder values


resp = client.create_task({
  workspace_name: "WorkspaceName", # required
  task_name: "ResourceName", # required
  description: "Description",
  task_configuration: { # required
    container_task_configuration: {
      ecr_uri: "EcrUri", # required
      task_execution_role: "IamRoleArn", # required
      processing_type: "GENERIC_COMPUTE_PROCESSING", # required, accepts GENERIC_COMPUTE_PROCESSING, HARDWARE_ACCELERATED_PROCESSING
      processing_unit: "UNITS_2", # required, accepts UNITS_2, UNITS_4, UNITS_8, UNITS_12, UNITS_16, UNITS_24, UNITS_32, UNITS_36, UNITS_48, UNITS_60, UNITS_64, UNITS_72, UNITS_84, UNITS_96
      ephemeral_storage_configuration: {
        storage_class: "STANDARD_1", # required, accepts STANDARD_1, STANDARD_2, THROUGHPUT_1, THROUGHPUT_2
        storage_size_in_gi_b: 1, # required
      },
      command: ["String"],
      timeout_seconds: 1,
      environment_variables: {
        "EnvironmentVariableName" => "EnvironmentVariableValue",
      },
      mounts: [
        {
          name: "ResourceName", # required
          relative_path: "MountRelativePath", # required
          source: { # required
            s3_access_point: {
              access_point_arn: "MountS3AccessPointArn", # required
              prefix: "MountS3KeyPrefix",
            },
          },
          storage_type: "SHARED_STORAGE", # required, accepts SHARED_STORAGE
        },
      ],
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
  client_token: "ClientToken",
})

Response structure


resp.task_name #=> String
resp.task_arn #=> String
resp.version #=> String
resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.status.error.message #=> String
resp.status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace.

  • :task_name (required, String) —

    The name of the task to create. Must be unique within the workspace.

  • :description (String) —

    A description of the task.

  • :task_configuration (required, Types::TaskConfiguration) —

    The task execution configuration. Specify a containerTaskConfiguration for custom container workloads.

  • :tags (Hash<String,String>) —

    A list of key-value pairs that contain metadata for the task. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the server returns the cached result from the original successful request without performing the operation again.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



3355
3356
3357
3358
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3355

def create_task(params = {}, options = {})
  req = build_request(:create_task, params)
  req.send_request(options)
end

#create_workspace(params = {}) ⇒ Types::CreateWorkspaceResponse

Creates a workspace in IoT SiteWise. A workspace isolates its resources, such as datasets, time series, pipelines, and tasks, and their data from other workspaces, and has its own quotas and throttling limits. You must specify an encryption configuration when you create a workspace. The operation returns immediately with the workspace in the CREATING state. Provisioning completes asynchronously, after which the workspace state is ACTIVE, or FAILED if provisioning doesn't complete.

Examples:

Request syntax with placeholder values


resp = client.create_workspace({
  workspace_name: "WorkspaceName", # required
  workspace_description: "Description",
  encryption_configuration: { # required
    encryption_type: "SITEWISE_DEFAULT_ENCRYPTION", # required, accepts SITEWISE_DEFAULT_ENCRYPTION, KMS_BASED_ENCRYPTION
    kms_key_id: "KmsKeyId",
  },
  tags: {
    "TagKey" => "TagValue",
  },
  client_token: "ClientToken",
})

Response structure


resp.workspace_name #=> String
resp.workspace_arn #=> String
resp.workspace_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.workspace_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.workspace_status.error.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace to create.

  • :workspace_description (String) —

    A description for the workspace.

  • :encryption_configuration (required, Types::WorkspaceEncryptionConfiguration) —

    The encryption configuration for the workspace.

  • :tags (Hash<String,String>) —

    A list of key-value pairs that contain metadata for the workspace. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure that the request is idempotent. If you retry a request that completed successfully using the same client token, the retry succeeds without performing any further actions.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



3427
3428
3429
3430
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3427

def create_workspace(params = {}, options = {})
  req = build_request(:create_workspace, params)
  req.send_request(options)
end

#delete_access_policy(params = {}) ⇒ Struct

Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource. You can use this operation to revoke access to an IoT SiteWise Monitor resource.

Examples:

Request syntax with placeholder values


resp = client.delete_access_policy({
  access_policy_id: "ID", # required
  client_token: "ClientToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :access_policy_id (required, String) —

    The ID of the access policy to be deleted.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.



3458
3459
3460
3461
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3458

def delete_access_policy(params = {}, options = {})
  req = build_request(:delete_access_policy, params)
  req.send_request(options)
end

#delete_application(params = {}) ⇒ Struct

Deletes an application by ID

Examples:

Request syntax with placeholder values


resp = client.delete_application({
  workspace_name: "WorkspaceName", # required
  id: "ApplicationId", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    Name of the workspace to associate with the underlying Application

  • :id (required, String) —

    ID of the Application to delete

Returns:

  • (Struct) —

    Returns an empty response.



3482
3483
3484
3485
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3482

def delete_application(params = {}, options = {})
  req = build_request(:delete_application, params)
  req.send_request(options)
end

#delete_asset(params = {}) ⇒ Types::DeleteAssetResponse

Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide.

You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.

Examples:

Request syntax with placeholder values


resp = client.delete_asset({
  asset_id: "CustomID", # required
  client_token: "ClientToken",
})

Response structure


resp.asset_id #=> String
resp.asset_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.asset_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.asset_status.error.message #=> String
resp.asset_status.error.details #=> Array
resp.asset_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.asset_status.error.details[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_id (required, String) —

    The ID of the asset to delete. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



3542
3543
3544
3545
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3542

def delete_asset(params = {}, options = {})
  req = build_request(:delete_asset, params)
  req.send_request(options)
end

#delete_asset_model(params = {}) ⇒ Types::DeleteAssetModelResponse

Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_asset_model({
  asset_model_id: "CustomID", # required
  client_token: "ClientToken",
  if_match: "ETag",
  if_none_match: "SelectAll",
  match_for_version_type: "LATEST", # accepts LATEST, ACTIVE
})

Response structure


resp.asset_model_id #=> String
resp.asset_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED"
resp.asset_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.asset_model_status.error.message #=> String
resp.asset_model_status.error.details #=> Array
resp.asset_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.asset_model_status.error.details[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_model_id (required, String) —

    The ID of the asset model to delete. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :if_match (String) —

    The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The delete request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.

  • :if_none_match (String) —

    Accepts ***** to reject the delete request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.

  • :match_for_version_type (String) —

    Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the delete operation.

Returns:



3624
3625
3626
3627
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3624

def delete_asset_model(params = {}, options = {})
  req = build_request(:delete_asset_model, params)
  req.send_request(options)
end

#delete_asset_model_composite_model(params = {}) ⇒ Types::DeleteAssetModelCompositeModelResponse

Deletes a composite model. This action can't be undone. You must delete all assets created from a composite model before you can delete the model. Also, you can't delete a composite model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_asset_model_composite_model({
  asset_model_id: "CustomID", # required
  asset_model_composite_model_id: "CustomID", # required
  client_token: "ClientToken",
  if_match: "ETag",
  if_none_match: "SelectAll",
  match_for_version_type: "LATEST", # accepts LATEST, ACTIVE
})

Response structure


resp.asset_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED"
resp.asset_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.asset_model_status.error.message #=> String
resp.asset_model_status.error.details #=> Array
resp.asset_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.asset_model_status.error.details[0].message #=> String
resp.asset_model_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_model_id (required, String) —

    The ID of the asset model, in UUID format.

  • :asset_model_composite_model_id (required, String) —

    The ID of a composite model on this asset model.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :if_match (String) —

    The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The delete request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.

  • :if_none_match (String) —

    Accepts ***** to reject the delete request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.

  • :match_for_version_type (String) —

    Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the delete operation.

Returns:



3703
3704
3705
3706
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3703

def delete_asset_model_composite_model(params = {}, options = {})
  req = build_request(:delete_asset_model_composite_model, params)
  req.send_request(options)
end

#delete_asset_model_interface_relationship(params = {}) ⇒ Types::DeleteAssetModelInterfaceRelationshipResponse

Deletes an interface relationship between an asset model and an interface asset model.

Examples:

Request syntax with placeholder values


resp = client.delete_asset_model_interface_relationship({
  asset_model_id: "CustomID", # required
  interface_asset_model_id: "CustomID", # required
  client_token: "ClientToken",
})

Response structure


resp.asset_model_id #=> String
resp.interface_asset_model_id #=> String
resp.asset_model_arn #=> String
resp.asset_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED"
resp.asset_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.asset_model_status.error.message #=> String
resp.asset_model_status.error.details #=> Array
resp.asset_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.asset_model_status.error.details[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_model_id (required, String) —

    The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.

  • :interface_asset_model_id (required, String) —

    The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



3756
3757
3758
3759
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3756

def delete_asset_model_interface_relationship(params = {}, options = {})
  req = build_request(:delete_asset_model_interface_relationship, params)
  req.send_request(options)
end

#delete_computation_model(params = {}) ⇒ Types::DeleteComputationModelResponse

Deletes a computation model. This action can't be undone.

Examples:

Request syntax with placeholder values


resp = client.delete_computation_model({
  computation_model_id: "ID", # required
  client_token: "ClientToken",
})

Response structure


resp.computation_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.computation_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.computation_model_status.error.message #=> String
resp.computation_model_status.error.details #=> Array
resp.computation_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.computation_model_status.error.details[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :computation_model_id (required, String) —

    The ID of the computation model.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



3796
3797
3798
3799
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3796

def delete_computation_model(params = {}, options = {})
  req = build_request(:delete_computation_model, params)
  req.send_request(options)
end

#delete_dashboard(params = {}) ⇒ Struct

Deletes a dashboard from IoT SiteWise Monitor.

Examples:

Request syntax with placeholder values


resp = client.delete_dashboard({
  dashboard_id: "ID", # required
  client_token: "ClientToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dashboard_id (required, String) —

    The ID of the dashboard to delete.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.



3825
3826
3827
3828
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3825

def delete_dashboard(params = {}, options = {})
  req = build_request(:delete_dashboard, params)
  req.send_request(options)
end

#delete_dataset(params = {}) ⇒ Types::DeleteDatasetResponse

Deletes a dataset. This can't be undone. Deleting a session dataset also deletes the underlying time series data in the session. You can't delete a session dataset while a curated dataset references its data segments. First delete the curated dataset or disassociate the data segments. Deleting a curated dataset doesn't delete the underlying data in the source session datasets.

Examples:

Request syntax with placeholder values


resp = client.delete_dataset({
  dataset_id: "ID", # required
  workspace_name: "WorkspaceName",
  client_token: "ClientToken",
})

Response structure


resp.dataset_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.dataset_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.dataset_status.error.message #=> String
resp.dataset_status.error.details #=> Array
resp.dataset_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.dataset_status.error.details[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dataset_id (required, String) —

    The ID of the dataset.

  • :workspace_name (String) —

    The name of the workspace that contains the dataset.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



3874
3875
3876
3877
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3874

def delete_dataset(params = {}, options = {})
  req = build_request(:delete_dataset, params)
  req.send_request(options)
end

#delete_gateway(params = {}) ⇒ Struct

Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.

Examples:

Request syntax with placeholder values


resp = client.delete_gateway({
  gateway_id: "ID", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The ID of the gateway to delete.

Returns:

  • (Struct) —

    Returns an empty response.



3895
3896
3897
3898
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3895

def delete_gateway(params = {}, options = {})
  req = build_request(:delete_gateway, params)
  req.send_request(options)
end

#delete_pipeline(params = {}) ⇒ Types::DeletePipelineResponse

Deletes a pipeline from the specified workspace. A pipeline cannot be deleted if it has any active executions. Wait for all executions to complete before attempting to delete the pipeline, or use CancelPipelineExecution to stop a running execution.

Examples:

Request syntax with placeholder values


resp = client.delete_pipeline({
  workspace_name: "WorkspaceName", # required
  pipeline_name: "ResourceName", # required
})

Response structure


resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.status.error.message #=> String
resp.status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace.

  • :pipeline_name (required, String) —

    The name of the pipeline to delete.

Returns:



3934
3935
3936
3937
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3934

def delete_pipeline(params = {}, options = {})
  req = build_request(:delete_pipeline, params)
  req.send_request(options)
end

#delete_portal(params = {}) ⇒ Types::DeletePortalResponse

Deletes a portal from IoT SiteWise Monitor.

Examples:

Request syntax with placeholder values


resp = client.delete_portal({
  portal_id: "ID", # required
  client_token: "ClientToken",
})

Response structure


resp.portal_status.state #=> String, one of "CREATING", "PENDING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "LIMIT_EXCEEDED"
resp.portal_status.error.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :portal_id (required, String) —

    The ID of the portal to delete.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



3971
3972
3973
3974
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 3971

def delete_portal(params = {}, options = {})
  req = build_request(:delete_portal, params)
  req.send_request(options)
end

#delete_project(params = {}) ⇒ Struct

Deletes a project from IoT SiteWise Monitor.

Examples:

Request syntax with placeholder values


resp = client.delete_project({
  project_id: "ID", # required
  client_token: "ClientToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :project_id (required, String) —

    The ID of the project.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.



4000
4001
4002
4003
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4000

def delete_project(params = {}, options = {})
  req = build_request(:delete_project, params)
  req.send_request(options)
end

#delete_task(params = {}) ⇒ Types::DeleteTaskResponse

Deletes a task from the specified workspace. A task cannot be deleted if it is currently referenced by any existing pipeline. Remove the task from all pipelines before attempting to delete it.

Examples:

Request syntax with placeholder values


resp = client.delete_task({
  workspace_name: "WorkspaceName", # required
  task_name: "ResourceName", # required
})

Response structure


resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.status.error.message #=> String
resp.status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace.

  • :task_name (required, String) —

    The name of the task to delete.

Returns:



4034
4035
4036
4037
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4034

def delete_task(params = {}, options = {})
  req = build_request(:delete_task, params)
  req.send_request(options)
end

#delete_time_series(params = {}) ⇒ Struct

Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the asset property still exists, but the time series will no longer be associated with this asset property. You can't delete a time series until all of its data segments have been deleted from session datasets.

To identify a time series, do one of the following:

  • If the time series isn't associated with an asset property, specify the alias of the time series.

  • If the time series is associated with an asset property, specify one of the following:

    • The alias of the time series.

    • The assetId and propertyId that identifies the asset property.

Examples:

Request syntax with placeholder values


resp = client.delete_time_series({
  alias: "PropertyAlias",
  asset_id: "CustomID",
  property_id: "CustomID",
  client_token: "ClientToken",
  workspace_name: "WorkspaceName",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :alias (String) —

    The alias that identifies the time series.

  • :asset_id (String) —

    The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :property_id (String) —

    The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :workspace_name (String) —

    The name of the workspace.

Returns:

  • (Struct) —

    Returns an empty response.



4106
4107
4108
4109
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4106

def delete_time_series(params = {}, options = {})
  req = build_request(:delete_time_series, params)
  req.send_request(options)
end

#delete_workspace(params = {}) ⇒ Types::DeleteWorkspaceResponse

Deletes a workspace. Before you delete a workspace, you must delete all resources contained in or associated with the workspace, such as datasets, time series, pipelines, and tasks.

Examples:

Request syntax with placeholder values


resp = client.delete_workspace({
  workspace_name: "WorkspaceName", # required
  client_token: "ClientToken",
})

Response structure


resp.workspace_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.workspace_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.workspace_status.error.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace to delete.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure that the request is idempotent. If you retry a request that completed successfully using the same client token, the retry succeeds without performing any further actions.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



4146
4147
4148
4149
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4146

def delete_workspace(params = {}, options = {})
  req = build_request(:delete_workspace, params)
  req.send_request(options)
end

#describe_access_policy(params = {}) ⇒ Types::DescribeAccessPolicyResponse

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

Examples:

Request syntax with placeholder values


resp = client.describe_access_policy({
  access_policy_id: "ID", # required
})

Response structure


resp.access_policy_id #=> String
resp.access_policy_arn #=> String
resp.access_policy_identity.user.id #=> String
resp.access_policy_identity.group.id #=> String
resp.access_policy_identity.iam_user.arn #=> String
resp.access_policy_identity.iam_role.arn #=> String
resp.access_policy_resource.portal.id #=> String
resp.access_policy_resource.project.id #=> String
resp.access_policy_permission #=> String, one of "ADMINISTRATOR", "VIEWER"
resp.access_policy_creation_date #=> Time
resp.access_policy_last_update_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :access_policy_id (required, String) —

    The ID of the access policy.

Returns:



4189
4190
4191
4192
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4189

def describe_access_policy(params = {}, options = {})
  req = build_request(:describe_access_policy, params)
  req.send_request(options)
end

#describe_action(params = {}) ⇒ Types::DescribeActionResponse

Retrieves information about an action.

Examples:

Request syntax with placeholder values


resp = client.describe_action({
  action_id: "ID", # required
})

Response structure


resp.action_id #=> String
resp.target_resource.asset_id #=> String
resp.target_resource.computation_model_id #=> String
resp.action_definition_id #=> String
resp.action_payload.string_value #=> String
resp.execution_time #=> Time
resp.resolve_to.asset_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :action_id (required, String) —

    The ID of the action.

Returns:



4226
4227
4228
4229
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4226

def describe_action(params = {}, options = {})
  req = build_request(:describe_action, params)
  req.send_request(options)
end

#describe_application(params = {}) ⇒ Types::DescribeApplicationResponse

Retrieves Application details based on the ID

Examples:

Request syntax with placeholder values


resp = client.describe_application({
  workspace_name: "WorkspaceName", # required
  id: "ApplicationId", # required
})

Response structure


resp.arn #=> String
resp.created_at #=> Time
resp.dns_subdomain #=> String
resp.description #=> String
resp.id #=> String
resp.idc_application_arn #=> String
resp.name #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING"
resp.updated_at #=> Time
resp.workspace_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    Name of the workspace to associate with the underlying Application

  • :id (required, String) —

    ID of the Application

Returns:



4274
4275
4276
4277
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4274

def describe_application(params = {}, options = {})
  req = build_request(:describe_application, params)
  req.send_request(options)
end

#describe_asset(params = {}) ⇒ Types::DescribeAssetResponse

Retrieves information about an asset.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • asset_active
  • asset_not_exists

Examples:

Request syntax with placeholder values


resp = client.describe_asset({
  asset_id: "CustomID", # required
  exclude_properties: false,
})

Response structure


resp.asset_id #=> String
resp.asset_external_id #=> String
resp.asset_arn #=> String
resp.asset_name #=> String
resp.asset_model_id #=> String
resp.asset_properties #=> Array
resp.asset_properties[0].id #=> String
resp.asset_properties[0].external_id #=> String
resp.asset_properties[0].name #=> String
resp.asset_properties[0].alias #=> String
resp.asset_properties[0].notification.topic #=> String
resp.asset_properties[0].notification.state #=> String, one of "ENABLED", "DISABLED"
resp.asset_properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT", "VIDEO", "ANNOTATION", "JSON"
resp.asset_properties[0].data_type_spec #=> String
resp.asset_properties[0].unit #=> String
resp.asset_properties[0].path #=> Array
resp.asset_properties[0].path[0].id #=> String
resp.asset_properties[0].path[0].name #=> String
resp.asset_hierarchies #=> Array
resp.asset_hierarchies[0].id #=> String
resp.asset_hierarchies[0].external_id #=> String
resp.asset_hierarchies[0].name #=> String
resp.asset_composite_models #=> Array
resp.asset_composite_models[0].name #=> String
resp.asset_composite_models[0].description #=> String
resp.asset_composite_models[0].type #=> String
resp.asset_composite_models[0].properties #=> Array
resp.asset_composite_models[0].properties[0].id #=> String
resp.asset_composite_models[0].properties[0].external_id #=> String
resp.asset_composite_models[0].properties[0].name #=> String
resp.asset_composite_models[0].properties[0].alias #=> String
resp.asset_composite_models[0].properties[0].notification.topic #=> String
resp.asset_composite_models[0].properties[0].notification.state #=> String, one of "ENABLED", "DISABLED"
resp.asset_composite_models[0].properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT", "VIDEO", "ANNOTATION", "JSON"
resp.asset_composite_models[0].properties[0].data_type_spec #=> String
resp.asset_composite_models[0].properties[0].unit #=> String
resp.asset_composite_models[0].properties[0].path #=> Array
resp.asset_composite_models[0].properties[0].path[0].id #=> String
resp.asset_composite_models[0].properties[0].path[0].name #=> String
resp.asset_composite_models[0].id #=> String
resp.asset_composite_models[0].external_id #=> String
resp.asset_creation_date #=> Time
resp.asset_last_update_date #=> Time
resp.asset_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.asset_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.asset_status.error.message #=> String
resp.asset_status.error.details #=> Array
resp.asset_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.asset_status.error.details[0].message #=> String
resp.asset_description #=> String
resp.asset_composite_model_summaries #=> Array
resp.asset_composite_model_summaries[0].id #=> String
resp.asset_composite_model_summaries[0].external_id #=> String
resp.asset_composite_model_summaries[0].name #=> String
resp.asset_composite_model_summaries[0].type #=> String
resp.asset_composite_model_summaries[0].description #=> String
resp.asset_composite_model_summaries[0].path #=> Array
resp.asset_composite_model_summaries[0].path[0].id #=> String
resp.asset_composite_model_summaries[0].path[0].name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_id (required, String) —

    The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :exclude_properties (Boolean) —

    Whether or not to exclude asset properties from the response.

Returns:



4387
4388
4389
4390
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4387

def describe_asset(params = {}, options = {})
  req = build_request(:describe_asset, params)
  req.send_request(options)
end

#describe_asset_composite_model(params = {}) ⇒ Types::DescribeAssetCompositeModelResponse

Retrieves information about an asset composite model (also known as an asset component). An AssetCompositeModel is an instance of an AssetModelCompositeModel. If you want to see information about the model this is based on, call DescribeAssetModelCompositeModel.

Examples:

Request syntax with placeholder values


resp = client.describe_asset_composite_model({
  asset_id: "CustomID", # required
  asset_composite_model_id: "CustomID", # required
})

Response structure


resp.asset_id #=> String
resp.asset_composite_model_id #=> String
resp.asset_composite_model_external_id #=> String
resp.asset_composite_model_path #=> Array
resp.asset_composite_model_path[0].id #=> String
resp.asset_composite_model_path[0].name #=> String
resp.asset_composite_model_name #=> String
resp.asset_composite_model_description #=> String
resp.asset_composite_model_type #=> String
resp.asset_composite_model_properties #=> Array
resp.asset_composite_model_properties[0].id #=> String
resp.asset_composite_model_properties[0].external_id #=> String
resp.asset_composite_model_properties[0].name #=> String
resp.asset_composite_model_properties[0].alias #=> String
resp.asset_composite_model_properties[0].notification.topic #=> String
resp.asset_composite_model_properties[0].notification.state #=> String, one of "ENABLED", "DISABLED"
resp.asset_composite_model_properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT", "VIDEO", "ANNOTATION", "JSON"
resp.asset_composite_model_properties[0].data_type_spec #=> String
resp.asset_composite_model_properties[0].unit #=> String
resp.asset_composite_model_properties[0].path #=> Array
resp.asset_composite_model_properties[0].path[0].id #=> String
resp.asset_composite_model_properties[0].path[0].name #=> String
resp.asset_composite_model_summaries #=> Array
resp.asset_composite_model_summaries[0].id #=> String
resp.asset_composite_model_summaries[0].external_id #=> String
resp.asset_composite_model_summaries[0].name #=> String
resp.asset_composite_model_summaries[0].type #=> String
resp.asset_composite_model_summaries[0].description #=> String
resp.asset_composite_model_summaries[0].path #=> Array
resp.asset_composite_model_summaries[0].path[0].id #=> String
resp.asset_composite_model_summaries[0].path[0].name #=> String
resp.action_definitions #=> Array
resp.action_definitions[0].action_definition_id #=> String
resp.action_definitions[0].action_name #=> String
resp.action_definitions[0].action_type #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_id (required, String) —

    The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :asset_composite_model_id (required, String) —

    The ID of a composite model on this asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

Returns:



4481
4482
4483
4484
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4481

def describe_asset_composite_model(params = {}, options = {})
  req = build_request(:describe_asset_composite_model, params)
  req.send_request(options)
end

#describe_asset_model(params = {}) ⇒ Types::DescribeAssetModelResponse

Retrieves information about an asset model. This includes details about the asset model's properties, hierarchies, composite models, and any interface relationships if the asset model implements interfaces.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • asset_model_active
  • asset_model_not_exists

Examples:

Request syntax with placeholder values


resp = client.describe_asset_model({
  asset_model_id: "CustomID", # required
  exclude_properties: false,
  asset_model_version: "AssetModelVersionFilter",
})

Response structure


resp.asset_model_id #=> String
resp.asset_model_external_id #=> String
resp.asset_model_arn #=> String
resp.asset_model_name #=> String
resp.asset_model_type #=> String, one of "ASSET_MODEL", "COMPONENT_MODEL", "INTERFACE"
resp.asset_model_description #=> String
resp.asset_model_properties #=> Array
resp.asset_model_properties[0].id #=> String
resp.asset_model_properties[0].external_id #=> String
resp.asset_model_properties[0].name #=> String
resp.asset_model_properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT", "VIDEO", "ANNOTATION", "JSON"
resp.asset_model_properties[0].data_type_spec #=> String
resp.asset_model_properties[0].unit #=> String
resp.asset_model_properties[0].type.attribute.default_value #=> String
resp.asset_model_properties[0].type.measurement.processing_config.forwarding_config.state #=> String, one of "DISABLED", "ENABLED"
resp.asset_model_properties[0].type.transform.expression #=> String
resp.asset_model_properties[0].type.transform.variables #=> Array
resp.asset_model_properties[0].type.transform.variables[0].name #=> String
resp.asset_model_properties[0].type.transform.variables[0].value.property_id #=> String
resp.asset_model_properties[0].type.transform.variables[0].value.hierarchy_id #=> String
resp.asset_model_properties[0].type.transform.variables[0].value.property_path #=> Array
resp.asset_model_properties[0].type.transform.variables[0].value.property_path[0].id #=> String
resp.asset_model_properties[0].type.transform.variables[0].value.property_path[0].name #=> String
resp.asset_model_properties[0].type.transform.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
resp.asset_model_properties[0].type.transform.processing_config.forwarding_config.state #=> String, one of "DISABLED", "ENABLED"
resp.asset_model_properties[0].type.metric.expression #=> String
resp.asset_model_properties[0].type.metric.variables #=> Array
resp.asset_model_properties[0].type.metric.variables[0].name #=> String
resp.asset_model_properties[0].type.metric.variables[0].value.property_id #=> String
resp.asset_model_properties[0].type.metric.variables[0].value.hierarchy_id #=> String
resp.asset_model_properties[0].type.metric.variables[0].value.property_path #=> Array
resp.asset_model_properties[0].type.metric.variables[0].value.property_path[0].id #=> String
resp.asset_model_properties[0].type.metric.variables[0].value.property_path[0].name #=> String
resp.asset_model_properties[0].type.metric.window.tumbling.interval #=> String
resp.asset_model_properties[0].type.metric.window.tumbling.offset #=> String
resp.asset_model_properties[0].type.metric.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
resp.asset_model_properties[0].path #=> Array
resp.asset_model_properties[0].path[0].id #=> String
resp.asset_model_properties[0].path[0].name #=> String
resp.asset_model_hierarchies #=> Array
resp.asset_model_hierarchies[0].id #=> String
resp.asset_model_hierarchies[0].external_id #=> String
resp.asset_model_hierarchies[0].name #=> String
resp.asset_model_hierarchies[0].child_asset_model_id #=> String
resp.asset_model_composite_models #=> Array
resp.asset_model_composite_models[0].name #=> String
resp.asset_model_composite_models[0].description #=> String
resp.asset_model_composite_models[0].type #=> String
resp.asset_model_composite_models[0].properties #=> Array
resp.asset_model_composite_models[0].properties[0].id #=> String
resp.asset_model_composite_models[0].properties[0].external_id #=> String
resp.asset_model_composite_models[0].properties[0].name #=> String
resp.asset_model_composite_models[0].properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT", "VIDEO", "ANNOTATION", "JSON"
resp.asset_model_composite_models[0].properties[0].data_type_spec #=> String
resp.asset_model_composite_models[0].properties[0].unit #=> String
resp.asset_model_composite_models[0].properties[0].type.attribute.default_value #=> String
resp.asset_model_composite_models[0].properties[0].type.measurement.processing_config.forwarding_config.state #=> String, one of "DISABLED", "ENABLED"
resp.asset_model_composite_models[0].properties[0].type.transform.expression #=> String
resp.asset_model_composite_models[0].properties[0].type.transform.variables #=> Array
resp.asset_model_composite_models[0].properties[0].type.transform.variables[0].name #=> String
resp.asset_model_composite_models[0].properties[0].type.transform.variables[0].value.property_id #=> String
resp.asset_model_composite_models[0].properties[0].type.transform.variables[0].value.hierarchy_id #=> String
resp.asset_model_composite_models[0].properties[0].type.transform.variables[0].value.property_path #=> Array
resp.asset_model_composite_models[0].properties[0].type.transform.variables[0].value.property_path[0].id #=> String
resp.asset_model_composite_models[0].properties[0].type.transform.variables[0].value.property_path[0].name #=> String
resp.asset_model_composite_models[0].properties[0].type.transform.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
resp.asset_model_composite_models[0].properties[0].type.transform.processing_config.forwarding_config.state #=> String, one of "DISABLED", "ENABLED"
resp.asset_model_composite_models[0].properties[0].type.metric.expression #=> String
resp.asset_model_composite_models[0].properties[0].type.metric.variables #=> Array
resp.asset_model_composite_models[0].properties[0].type.metric.variables[0].name #=> String
resp.asset_model_composite_models[0].properties[0].type.metric.variables[0].value.property_id #=> String
resp.asset_model_composite_models[0].properties[0].type.metric.variables[0].value.hierarchy_id #=> String
resp.asset_model_composite_models[0].properties[0].type.metric.variables[0].value.property_path #=> Array
resp.asset_model_composite_models[0].properties[0].type.metric.variables[0].value.property_path[0].id #=> String
resp.asset_model_composite_models[0].properties[0].type.metric.variables[0].value.property_path[0].name #=> String
resp.asset_model_composite_models[0].properties[0].type.metric.window.tumbling.interval #=> String
resp.asset_model_composite_models[0].properties[0].type.metric.window.tumbling.offset #=> String
resp.asset_model_composite_models[0].properties[0].type.metric.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
resp.asset_model_composite_models[0].properties[0].path #=> Array
resp.asset_model_composite_models[0].properties[0].path[0].id #=> String
resp.asset_model_composite_models[0].properties[0].path[0].name #=> String
resp.asset_model_composite_models[0].id #=> String
resp.asset_model_composite_models[0].external_id #=> String
resp.asset_model_composite_model_summaries #=> Array
resp.asset_model_composite_model_summaries[0].id #=> String
resp.asset_model_composite_model_summaries[0].external_id #=> String
resp.asset_model_composite_model_summaries[0].name #=> String
resp.asset_model_composite_model_summaries[0].type #=> String
resp.asset_model_composite_model_summaries[0].description #=> String
resp.asset_model_composite_model_summaries[0].path #=> Array
resp.asset_model_composite_model_summaries[0].path[0].id #=> String
resp.asset_model_composite_model_summaries[0].path[0].name #=> String
resp.asset_model_creation_date #=> Time
resp.asset_model_last_update_date #=> Time
resp.asset_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED"
resp.asset_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.asset_model_status.error.message #=> String
resp.asset_model_status.error.details #=> Array
resp.asset_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.asset_model_status.error.details[0].message #=> String
resp.asset_model_version #=> String
resp.interface_details #=> Array
resp.interface_details[0].id #=> String
resp.e_tag #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_model_id (required, String) —

    The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :exclude_properties (Boolean) —

    Whether or not to exclude asset model properties from the response.

  • :asset_model_version (String) —

    The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.

Returns:



4656
4657
4658
4659
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4656

def describe_asset_model(params = {}, options = {})
  req = build_request(:describe_asset_model, params)
  req.send_request(options)
end

#describe_asset_model_composite_model(params = {}) ⇒ Types::DescribeAssetModelCompositeModelResponse

Retrieves information about an asset model composite model (also known as an asset model component). For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_asset_model_composite_model({
  asset_model_id: "CustomID", # required
  asset_model_composite_model_id: "CustomID", # required
  asset_model_version: "AssetModelVersionFilter",
})

Response structure


resp.asset_model_id #=> String
resp.asset_model_composite_model_id #=> String
resp.asset_model_composite_model_external_id #=> String
resp.asset_model_composite_model_path #=> Array
resp.asset_model_composite_model_path[0].id #=> String
resp.asset_model_composite_model_path[0].name #=> String
resp.asset_model_composite_model_name #=> String
resp.asset_model_composite_model_description #=> String
resp.asset_model_composite_model_type #=> String
resp.asset_model_composite_model_properties #=> Array
resp.asset_model_composite_model_properties[0].id #=> String
resp.asset_model_composite_model_properties[0].external_id #=> String
resp.asset_model_composite_model_properties[0].name #=> String
resp.asset_model_composite_model_properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT", "VIDEO", "ANNOTATION", "JSON"
resp.asset_model_composite_model_properties[0].data_type_spec #=> String
resp.asset_model_composite_model_properties[0].unit #=> String
resp.asset_model_composite_model_properties[0].type.attribute.default_value #=> String
resp.asset_model_composite_model_properties[0].type.measurement.processing_config.forwarding_config.state #=> String, one of "DISABLED", "ENABLED"
resp.asset_model_composite_model_properties[0].type.transform.expression #=> String
resp.asset_model_composite_model_properties[0].type.transform.variables #=> Array
resp.asset_model_composite_model_properties[0].type.transform.variables[0].name #=> String
resp.asset_model_composite_model_properties[0].type.transform.variables[0].value.property_id #=> String
resp.asset_model_composite_model_properties[0].type.transform.variables[0].value.hierarchy_id #=> String
resp.asset_model_composite_model_properties[0].type.transform.variables[0].value.property_path #=> Array
resp.asset_model_composite_model_properties[0].type.transform.variables[0].value.property_path[0].id #=> String
resp.asset_model_composite_model_properties[0].type.transform.variables[0].value.property_path[0].name #=> String
resp.asset_model_composite_model_properties[0].type.transform.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
resp.asset_model_composite_model_properties[0].type.transform.processing_config.forwarding_config.state #=> String, one of "DISABLED", "ENABLED"
resp.asset_model_composite_model_properties[0].type.metric.expression #=> String
resp.asset_model_composite_model_properties[0].type.metric.variables #=> Array
resp.asset_model_composite_model_properties[0].type.metric.variables[0].name #=> String
resp.asset_model_composite_model_properties[0].type.metric.variables[0].value.property_id #=> String
resp.asset_model_composite_model_properties[0].type.metric.variables[0].value.hierarchy_id #=> String
resp.asset_model_composite_model_properties[0].type.metric.variables[0].value.property_path #=> Array
resp.asset_model_composite_model_properties[0].type.metric.variables[0].value.property_path[0].id #=> String
resp.asset_model_composite_model_properties[0].type.metric.variables[0].value.property_path[0].name #=> String
resp.asset_model_composite_model_properties[0].type.metric.window.tumbling.interval #=> String
resp.asset_model_composite_model_properties[0].type.metric.window.tumbling.offset #=> String
resp.asset_model_composite_model_properties[0].type.metric.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
resp.asset_model_composite_model_properties[0].path #=> Array
resp.asset_model_composite_model_properties[0].path[0].id #=> String
resp.asset_model_composite_model_properties[0].path[0].name #=> String
resp.composition_details.composition_relationship #=> Array
resp.composition_details.composition_relationship[0].id #=> String
resp.asset_model_composite_model_summaries #=> Array
resp.asset_model_composite_model_summaries[0].id #=> String
resp.asset_model_composite_model_summaries[0].external_id #=> String
resp.asset_model_composite_model_summaries[0].name #=> String
resp.asset_model_composite_model_summaries[0].type #=> String
resp.asset_model_composite_model_summaries[0].description #=> String
resp.asset_model_composite_model_summaries[0].path #=> Array
resp.asset_model_composite_model_summaries[0].path[0].id #=> String
resp.asset_model_composite_model_summaries[0].path[0].name #=> String
resp.action_definitions #=> Array
resp.action_definitions[0].action_definition_id #=> String
resp.action_definitions[0].action_name #=> String
resp.action_definitions[0].action_type #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_model_id (required, String) —

    The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :asset_model_composite_model_id (required, String) —

    The ID of a composite model on this asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :asset_model_version (String) —

    The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.

Returns:



4783
4784
4785
4786
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4783

def describe_asset_model_composite_model(params = {}, options = {})
  req = build_request(:describe_asset_model_composite_model, params)
  req.send_request(options)
end

#describe_asset_model_interface_relationship(params = {}) ⇒ Types::DescribeAssetModelInterfaceRelationshipResponse

Retrieves information about an interface relationship between an asset model and an interface asset model.

Examples:

Request syntax with placeholder values


resp = client.describe_asset_model_interface_relationship({
  asset_model_id: "CustomID", # required
  interface_asset_model_id: "CustomID", # required
})

Response structure


resp.asset_model_id #=> String
resp.interface_asset_model_id #=> String
resp.property_mappings #=> Array
resp.property_mappings[0].asset_model_property_id #=> String
resp.property_mappings[0].interface_asset_model_property_id #=> String
resp.hierarchy_mappings #=> Array
resp.hierarchy_mappings[0].asset_model_hierarchy_id #=> String
resp.hierarchy_mappings[0].interface_asset_model_hierarchy_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_model_id (required, String) —

    The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.

  • :interface_asset_model_id (required, String) —

    The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.

Returns:



4826
4827
4828
4829
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4826

def describe_asset_model_interface_relationship(params = {}, options = {})
  req = build_request(:describe_asset_model_interface_relationship, params)
  req.send_request(options)
end

#describe_asset_property(params = {}) ⇒ Types::DescribeAssetPropertyResponse

Retrieves information about an asset property.

When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value.

This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue.

Examples:

Request syntax with placeholder values


resp = client.describe_asset_property({
  asset_id: "CustomID", # required
  property_id: "CustomID", # required
})

Response structure


resp.asset_id #=> String
resp.asset_external_id #=> String
resp.asset_name #=> String
resp.asset_model_id #=> String
resp.asset_property.id #=> String
resp.asset_property.external_id #=> String
resp.asset_property.name #=> String
resp.asset_property.alias #=> String
resp.asset_property.notification.topic #=> String
resp.asset_property.notification.state #=> String, one of "ENABLED", "DISABLED"
resp.asset_property.data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT", "VIDEO", "ANNOTATION", "JSON"
resp.asset_property.unit #=> String
resp.asset_property.type.attribute.default_value #=> String
resp.asset_property.type.measurement.processing_config.forwarding_config.state #=> String, one of "DISABLED", "ENABLED"
resp.asset_property.type.transform.expression #=> String
resp.asset_property.type.transform.variables #=> Array
resp.asset_property.type.transform.variables[0].name #=> String
resp.asset_property.type.transform.variables[0].value.property_id #=> String
resp.asset_property.type.transform.variables[0].value.hierarchy_id #=> String
resp.asset_property.type.transform.variables[0].value.property_path #=> Array
resp.asset_property.type.transform.variables[0].value.property_path[0].id #=> String
resp.asset_property.type.transform.variables[0].value.property_path[0].name #=> String
resp.asset_property.type.transform.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
resp.asset_property.type.transform.processing_config.forwarding_config.state #=> String, one of "DISABLED", "ENABLED"
resp.asset_property.type.metric.expression #=> String
resp.asset_property.type.metric.variables #=> Array
resp.asset_property.type.metric.variables[0].name #=> String
resp.asset_property.type.metric.variables[0].value.property_id #=> String
resp.asset_property.type.metric.variables[0].value.hierarchy_id #=> String
resp.asset_property.type.metric.variables[0].value.property_path #=> Array
resp.asset_property.type.metric.variables[0].value.property_path[0].id #=> String
resp.asset_property.type.metric.variables[0].value.property_path[0].name #=> String
resp.asset_property.type.metric.window.tumbling.interval #=> String
resp.asset_property.type.metric.window.tumbling.offset #=> String
resp.asset_property.type.metric.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
resp.asset_property.path #=> Array
resp.asset_property.path[0].id #=> String
resp.asset_property.path[0].name #=> String
resp.composite_model.name #=> String
resp.composite_model.type #=> String
resp.composite_model.asset_property.id #=> String
resp.composite_model.asset_property.external_id #=> String
resp.composite_model.asset_property.name #=> String
resp.composite_model.asset_property.alias #=> String
resp.composite_model.asset_property.notification.topic #=> String
resp.composite_model.asset_property.notification.state #=> String, one of "ENABLED", "DISABLED"
resp.composite_model.asset_property.data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT", "VIDEO", "ANNOTATION", "JSON"
resp.composite_model.asset_property.unit #=> String
resp.composite_model.asset_property.type.attribute.default_value #=> String
resp.composite_model.asset_property.type.measurement.processing_config.forwarding_config.state #=> String, one of "DISABLED", "ENABLED"
resp.composite_model.asset_property.type.transform.expression #=> String
resp.composite_model.asset_property.type.transform.variables #=> Array
resp.composite_model.asset_property.type.transform.variables[0].name #=> String
resp.composite_model.asset_property.type.transform.variables[0].value.property_id #=> String
resp.composite_model.asset_property.type.transform.variables[0].value.hierarchy_id #=> String
resp.composite_model.asset_property.type.transform.variables[0].value.property_path #=> Array
resp.composite_model.asset_property.type.transform.variables[0].value.property_path[0].id #=> String
resp.composite_model.asset_property.type.transform.variables[0].value.property_path[0].name #=> String
resp.composite_model.asset_property.type.transform.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
resp.composite_model.asset_property.type.transform.processing_config.forwarding_config.state #=> String, one of "DISABLED", "ENABLED"
resp.composite_model.asset_property.type.metric.expression #=> String
resp.composite_model.asset_property.type.metric.variables #=> Array
resp.composite_model.asset_property.type.metric.variables[0].name #=> String
resp.composite_model.asset_property.type.metric.variables[0].value.property_id #=> String
resp.composite_model.asset_property.type.metric.variables[0].value.hierarchy_id #=> String
resp.composite_model.asset_property.type.metric.variables[0].value.property_path #=> Array
resp.composite_model.asset_property.type.metric.variables[0].value.property_path[0].id #=> String
resp.composite_model.asset_property.type.metric.variables[0].value.property_path[0].name #=> String
resp.composite_model.asset_property.type.metric.window.tumbling.interval #=> String
resp.composite_model.asset_property.type.metric.window.tumbling.offset #=> String
resp.composite_model.asset_property.type.metric.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
resp.composite_model.asset_property.path #=> Array
resp.composite_model.asset_property.path[0].id #=> String
resp.composite_model.asset_property.path[0].name #=> String
resp.composite_model.id #=> String
resp.composite_model.external_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_id (required, String) —

    The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :property_id (required, String) —

    The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

Returns:



4964
4965
4966
4967
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 4964

def describe_asset_property(params = {}, options = {})
  req = build_request(:describe_asset_property, params)
  req.send_request(options)
end

#describe_bulk_import_job(params = {}) ⇒ Types::DescribeBulkImportJobResponse

Retrieves information about a bulk import job request. For more information, see Describe a bulk import job (CLI) in the Amazon Simple Storage Service User Guide.

Examples:

Request syntax with placeholder values


resp = client.describe_bulk_import_job({
  job_id: "ID", # required
  workspace_name: "WorkspaceName",
})

Response structure


resp.job_id #=> String
resp.job_name #=> String
resp.job_status #=> String, one of "PENDING", "CANCELLED", "RUNNING", "COMPLETED", "FAILED", "COMPLETED_WITH_FAILURES"
resp.job_role_arn #=> String
resp.files #=> Array
resp.files[0].bucket #=> String
resp.files[0].key #=> String
resp.files[0].version_id #=> String
resp.files[0].alias #=> String
resp.files[0].start_time.time_in_seconds #=> Integer
resp.files[0].start_time.offset_in_nanos #=> Integer
resp.files[0].file_format.csv.column_names #=> Array
resp.files[0].file_format.csv.column_names[0] #=> String, one of "ALIAS", "ASSET_ID", "PROPERTY_ID", "DATA_TYPE", "TIMESTAMP_SECONDS", "TIMESTAMP_NANO_OFFSET", "QUALITY", "VALUE"
resp.error_report_location.bucket #=> String
resp.error_report_location.prefix #=> String
resp.job_configuration.file_format.csv.column_names #=> Array
resp.job_configuration.file_format.csv.column_names[0] #=> String, one of "ALIAS", "ASSET_ID", "PROPERTY_ID", "DATA_TYPE", "TIMESTAMP_SECONDS", "TIMESTAMP_NANO_OFFSET", "QUALITY", "VALUE"
resp.job_creation_date #=> Time
resp.job_last_update_date #=> Time
resp.adaptive_ingestion #=> Boolean
resp.delete_files_after_import #=> Boolean
resp.dataset_id #=> String
resp.workspace_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The ID of the job.

  • :workspace_name (String) —

    The name of the workspace.

Returns:



5034
5035
5036
5037
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5034

def describe_bulk_import_job(params = {}, options = {})
  req = build_request(:describe_bulk_import_job, params)
  req.send_request(options)
end

#describe_computation_model(params = {}) ⇒ Types::DescribeComputationModelResponse

Retrieves information about a computation model.

Examples:

Request syntax with placeholder values


resp = client.describe_computation_model({
  computation_model_id: "ID", # required
  computation_model_version: "ComputationModelVersionFilter",
})

Response structure


resp.computation_model_id #=> String
resp.computation_model_arn #=> String
resp.computation_model_name #=> String
resp.computation_model_description #=> String
resp.computation_model_configuration.anomaly_detection.input_properties #=> String
resp.computation_model_configuration.anomaly_detection.result_property #=> String
resp.computation_model_data_binding #=> Hash
resp.computation_model_data_binding["ComputationModelDataBindingVariable"].asset_model_property.asset_model_id #=> String
resp.computation_model_data_binding["ComputationModelDataBindingVariable"].asset_model_property.property_id #=> String
resp.computation_model_data_binding["ComputationModelDataBindingVariable"].asset_property.asset_id #=> String
resp.computation_model_data_binding["ComputationModelDataBindingVariable"].asset_property.property_id #=> String
resp.computation_model_data_binding["ComputationModelDataBindingVariable"].list #=> Array
resp.computation_model_data_binding["ComputationModelDataBindingVariable"].list[0] #=> Types::ComputationModelDataBindingValue
resp.computation_model_creation_date #=> Time
resp.computation_model_last_update_date #=> Time
resp.computation_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.computation_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.computation_model_status.error.message #=> String
resp.computation_model_status.error.details #=> Array
resp.computation_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.computation_model_status.error.details[0].message #=> String
resp.computation_model_version #=> String
resp.action_definitions #=> Array
resp.action_definitions[0].action_definition_id #=> String
resp.action_definitions[0].action_name #=> String
resp.action_definitions[0].action_type #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :computation_model_id (required, String) —

    The ID of the computation model.

  • :computation_model_version (String) —

    The version of the computation model.

Returns:



5099
5100
5101
5102
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5099

def describe_computation_model(params = {}, options = {})
  req = build_request(:describe_computation_model, params)
  req.send_request(options)
end

#describe_computation_model_execution_summary(params = {}) ⇒ Types::DescribeComputationModelExecutionSummaryResponse

Retrieves information about the execution summary of a computation model.

Examples:

Request syntax with placeholder values


resp = client.describe_computation_model_execution_summary({
  computation_model_id: "ID", # required
  resolve_to_resource_type: "ASSET", # accepts ASSET
  resolve_to_resource_id: "ID",
})

Response structure


resp.computation_model_id #=> String
resp.resolve_to.asset_id #=> String
resp.computation_model_execution_summary #=> Hash
resp.computation_model_execution_summary["ComputationModelExecutionSummaryKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :computation_model_id (required, String) —

    The ID of the computation model.

  • :resolve_to_resource_type (String) —

    The type of the resolved resource.

  • :resolve_to_resource_id (String) —

    The ID of the resolved resource.

Returns:



5139
5140
5141
5142
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5139

def describe_computation_model_execution_summary(params = {}, options = {})
  req = build_request(:describe_computation_model_execution_summary, params)
  req.send_request(options)
end

#describe_dashboard(params = {}) ⇒ Types::DescribeDashboardResponse

Retrieves information about a dashboard.

Examples:

Request syntax with placeholder values


resp = client.describe_dashboard({
  dashboard_id: "ID", # required
})

Response structure


resp.dashboard_id #=> String
resp.dashboard_arn #=> String
resp.dashboard_name #=> String
resp.project_id #=> String
resp.dashboard_description #=> String
resp.dashboard_definition #=> String
resp.dashboard_creation_date #=> Time
resp.dashboard_last_update_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dashboard_id (required, String) —

    The ID of the dashboard.

Returns:



5179
5180
5181
5182
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5179

def describe_dashboard(params = {}, options = {})
  req = build_request(:describe_dashboard, params)
  req.send_request(options)
end

#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse

Retrieves information about a dataset.

Examples:

Request syntax with placeholder values


resp = client.describe_dataset({
  dataset_id: "ID", # required
  workspace_name: "WorkspaceName",
  dataset_version: "Version",
})

Response structure


resp.dataset_id #=> String
resp.dataset_arn #=> String
resp.dataset_name #=> String
resp.dataset_description #=> String
resp.dataset_type #=> String, one of "SESSION", "CURATED", "EXTERNAL"
resp.dataset_config.session.session_start_timestamp.time_in_seconds #=> Integer
resp.dataset_config.session.session_start_timestamp.offset_in_nanos #=> Integer
resp.dataset_config.session.session_end_timestamp.time_in_seconds #=> Integer
resp.dataset_config.session.session_end_timestamp.offset_in_nanos #=> Integer
resp.workspace_name #=> String
resp.metadata #=> Hash
resp.metadata["MetadataKey"] #=> String
resp.dataset_source.source_type #=> String, one of "KENDRA", "SITEWISE"
resp.dataset_source.source_format #=> String, one of "KNOWLEDGE_BASE", "TIMESERIES"
resp.dataset_source.source_detail.kendra.knowledge_base_arn #=> String
resp.dataset_source.source_detail.kendra.role_arn #=> String
resp.dataset_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.dataset_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.dataset_status.error.message #=> String
resp.dataset_status.error.details #=> Array
resp.dataset_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.dataset_status.error.details[0].message #=> String
resp.dataset_creation_date #=> Time
resp.dataset_last_update_date #=> Time
resp.dataset_version #=> String
resp.enrichment_status.video.status #=> String, one of "FULLY_ENRICHED", "PARTIALLY_ENRICHED", "NOT_ENRICHED"
resp.enrichment_status.video.last_enriched_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dataset_id (required, String) —

    The ID of the dataset.

  • :workspace_name (String) —

    The name of the workspace that contains the dataset.

  • :dataset_version (String) —

    The version of the dataset.

Returns:



5252
5253
5254
5255
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5252

def describe_dataset(params = {}, options = {})
  req = build_request(:describe_dataset, params)
  req.send_request(options)
end

#describe_dataset_export_job(params = {}) ⇒ Types::DescribeDatasetExportJobResponse

Retrieves information about a dataset export job.

Examples:

Request syntax with placeholder values


resp = client.describe_dataset_export_job({
  workspace_name: "WorkspaceName", # required
  job_id: "DatasetExportJobId", # required
})

Response structure


resp.job_id #=> String
resp.workspace_name #=> String
resp.status #=> String, one of "SUBMITTED", "RUNNING", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED"
resp.started_at #=> Time
resp.completed_at #=> Time
resp.destination_s3_uri #=> String
resp.error_report_location.s3_uri #=> String
resp.input.timeseries #=> Array
resp.input.timeseries[0].time_series_id #=> String
resp.input.timeseries[0].property_alias #=> String
resp.input.timeseries[0].trim_settings.start_time.time_in_seconds #=> Integer
resp.input.timeseries[0].trim_settings.start_time.offset_in_nanos #=> Integer
resp.input.timeseries[0].trim_settings.end_time.time_in_seconds #=> Integer
resp.input.timeseries[0].trim_settings.end_time.offset_in_nanos #=> Integer
resp.input.timeseries[0].format_settings.frames_per_second #=> Integer
resp.input.timeseries[0].format_settings.width_in_pixels #=> Integer
resp.input.timeseries[0].format_settings.height_in_pixels #=> Integer
resp.input.dataset.dataset_id #=> String
resp.input.dataset.trim_settings.start_time.time_in_seconds #=> Integer
resp.input.dataset.trim_settings.start_time.offset_in_nanos #=> Integer
resp.input.dataset.trim_settings.end_time.time_in_seconds #=> Integer
resp.input.dataset.trim_settings.end_time.offset_in_nanos #=> Integer
resp.input.dataset.export_data_types #=> Array
resp.input.dataset.export_data_types[0] #=> String, one of "VIDEO", "TELEMETRY", "ANNOTATION"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace that contains the dataset export job.

  • :job_id (required, String) —

    The unique identifier for the dataset export job.

Returns:



5312
5313
5314
5315
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5312

def describe_dataset_export_job(params = {}, options = {})
  req = build_request(:describe_dataset_export_job, params)
  req.send_request(options)
end

#describe_default_encryption_configuration(params = {}) ⇒ Types::DescribeDefaultEncryptionConfigurationResponse

Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region. For more information, see Key management in the IoT SiteWise User Guide.

Examples:

Response structure


resp.encryption_type #=> String, one of "SITEWISE_DEFAULT_ENCRYPTION", "KMS_BASED_ENCRYPTION"
resp.kms_key_arn #=> String
resp.configuration_status.state #=> String, one of "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
resp.configuration_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.configuration_status.error.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:



5342
5343
5344
5345
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5342

def describe_default_encryption_configuration(params = {}, options = {})
  req = build_request(:describe_default_encryption_configuration, params)
  req.send_request(options)
end

#describe_enrichment_job(params = {}) ⇒ Types::DescribeEnrichmentJobResponse

Retrieves detailed information about a specific enrichment job, including its current status, configuration, and timestamps.

Use Cases

  • Monitor job progress by checking status updates with DescribeEnrichmentJob
  • Retrieve the complete job configuration submitted during creation
  • Debug failed jobs by examining the failureMessage field
  • Track job lifecycle with creation, update, completion, and cancellation timestamps

Status Monitoring

Jobs progress through statuses: PENDING → RUNNING → terminal state

Terminal states:

  • COMPLETED: Job finished successfully; query IoT SiteWise for semantic search results
  • FAILED: Job encountered an error; check failureMessage for details
  • TIMED_OUT: Job exceeded maximum processing time
  • CANCELLED: Job was cancelled via CancelEnrichmentJob

Response Fields

The response includes:

  • Current job status and type
  • Full job configuration as originally submitted
  • Lifecycle timestamps (created, updated, completed, cancelled)
  • Failure details if status is FAILED

Examples:

Request syntax with placeholder values


resp = client.describe_enrichment_job({
  workspace_name: "WorkspaceName", # required
  job_id: "ID", # required
})

Response structure


resp.job_id #=> String
resp.status #=> String, one of "PENDING", "RUNNING", "COMPLETED", "FAILED", "TIMED_OUT", "CANCELLED"
resp.workspace_name #=> String
resp.job_type #=> String, one of "EVENT_DETECTION"
resp.job_configuration.event_detection.dataset_id #=> String
resp.job_configuration.event_detection.time_series_id #=> String
resp.job_configuration.event_detection.property_alias #=> String
resp.job_configuration.event_detection.trim_settings.start_time.time_in_seconds #=> Integer
resp.job_configuration.event_detection.trim_settings.start_time.offset_in_nanos #=> Integer
resp.job_configuration.event_detection.trim_settings.end_time.time_in_seconds #=> Integer
resp.job_configuration.event_detection.trim_settings.end_time.offset_in_nanos #=> Integer
resp.created_at #=> Time
resp.updated_at #=> Time
resp.completed_at #=> Time
resp.cancelled_at #=> Time
resp.failure_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the IoT SiteWise workspace containing the enrichment job.

  • :job_id (required, String) —

    The unique identifier of the enrichment job to retrieve. This is the jobId returned by CreateEnrichmentJob.

Returns:



5428
5429
5430
5431
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5428

def describe_enrichment_job(params = {}, options = {})
  req = build_request(:describe_enrichment_job, params)
  req.send_request(options)
end

#describe_execution(params = {}) ⇒ Types::DescribeExecutionResponse

Retrieves information about the execution.

Examples:

Request syntax with placeholder values


resp = client.describe_execution({
  execution_id: "ID", # required
})

Response structure


resp.execution_id #=> String
resp.action_type #=> String
resp.target_resource.asset_id #=> String
resp.target_resource.computation_model_id #=> String
resp.target_resource_version #=> String
resp.resolve_to.asset_id #=> String
resp.execution_start_time #=> Time
resp.execution_end_time #=> Time
resp.execution_status.state #=> String, one of "RUNNING", "COMPLETED", "FAILED"
resp.execution_result #=> Hash
resp.execution_result["ExecutionResultKey"] #=> String
resp.execution_details #=> Hash
resp.execution_details["ExecutionDetailsKey"] #=> String
resp.execution_entity_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :execution_id (required, String) —

    The ID of the execution.

Returns:



5477
5478
5479
5480
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5477

def describe_execution(params = {}, options = {})
  req = build_request(:describe_execution, params)
  req.send_request(options)
end

#describe_gateway(params = {}) ⇒ Types::DescribeGatewayResponse

Retrieves information about a gateway.

Examples:

Request syntax with placeholder values


resp = client.describe_gateway({
  gateway_id: "ID", # required
})

Response structure


resp.gateway_id #=> String
resp.gateway_name #=> String
resp.gateway_arn #=> String
resp.gateway_platform.greengrass.group_arn #=> String
resp.gateway_platform.greengrass_v2.core_device_thing_name #=> String
resp.gateway_platform.greengrass_v2.core_device_operating_system #=> String, one of "LINUX_AARCH64", "LINUX_AMD64", "WINDOWS_AMD64"
resp.gateway_platform.siemens_ie.iot_core_thing_name #=> String
resp.gateway_version #=> String
resp.gateway_capability_summaries #=> Array
resp.gateway_capability_summaries[0].capability_namespace #=> String
resp.gateway_capability_summaries[0].capability_sync_status #=> String, one of "IN_SYNC", "OUT_OF_SYNC", "SYNC_FAILED", "UNKNOWN", "NOT_APPLICABLE"
resp.creation_date #=> Time
resp.last_update_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The ID of the gateway device.

Returns:



5522
5523
5524
5525
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5522

def describe_gateway(params = {}, options = {})
  req = build_request(:describe_gateway, params)
  req.send_request(options)
end

#describe_gateway_capability_configuration(params = {}) ⇒ Types::DescribeGatewayCapabilityConfigurationResponse

Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability.

. The namespace follows the format service:capability:version, where:

  • service - The service providing the capability, or iotsitewise.

  • capability - The specific capability type. Options include: opcuacollector for the OPC UA data source collector, or publisher for data publisher capability.

  • version - The version number of the capability. Option include 2 for Classic streams, V2 gateways, and 3 for MQTT-enabled, V3 gateways.

After updating a capability configuration, the sync status becomes OUT_OF_SYNC until the gateway processes the configuration.Use DescribeGatewayCapabilityConfiguration to check the sync status and verify the configuration was applied.

A gateway can have multiple capability configurations with different namespaces.

Examples:

Request syntax with placeholder values


resp = client.describe_gateway_capability_configuration({
  gateway_id: "ID", # required
  capability_namespace: "CapabilityNamespace", # required
})

Response structure


resp.gateway_id #=> String
resp.capability_namespace #=> String
resp.capability_configuration #=> String
resp.capability_sync_status #=> String, one of "IN_SYNC", "OUT_OF_SYNC", "SYNC_FAILED", "UNKNOWN", "NOT_APPLICABLE"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The ID of the gateway that defines the capability configuration.

  • :capability_namespace (required, String) —

    The namespace of the capability configuration. For example, if you configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:3.

Returns:



5583
5584
5585
5586
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5583

def describe_gateway_capability_configuration(params = {}, options = {})
  req = build_request(:describe_gateway_capability_configuration, params)
  req.send_request(options)
end

#describe_logging_options(params = {}) ⇒ Types::DescribeLoggingOptionsResponse

Retrieves the current IoT SiteWise logging options.

Examples:

Request syntax with placeholder values


resp = client.describe_logging_options({
  workspace_name: "WorkspaceName",
})

Response structure


resp.logging_options.level #=> String, one of "ERROR", "INFO", "OFF"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (String) —

    The name of the workspace.

Returns:



5609
5610
5611
5612
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5609

def describe_logging_options(params = {}, options = {})
  req = build_request(:describe_logging_options, params)
  req.send_request(options)
end

#describe_pipeline(params = {}) ⇒ Types::DescribePipelineResponse

Retrieves detailed information about a specific pipeline in a workspace.

Examples:

Request syntax with placeholder values


resp = client.describe_pipeline({
  workspace_name: "WorkspaceName", # required
  pipeline_name: "ResourceName", # required
  pipeline_version: "Version",
})

Response structure


resp.pipeline_name #=> String
resp.workspace_name #=> String
resp.description #=> String
resp.pipeline_arn #=> String
resp.version #=> String
resp.environment_variables #=> Hash
resp.environment_variables["EnvironmentVariableName"] #=> String
resp.computations #=> Array
resp.computations[0].compute_node_name #=> String
resp.computations[0].task_name #=> String
resp.computations[0].environment_variables #=> Hash
resp.computations[0].environment_variables["EnvironmentVariableName"] #=> String
resp.computations[0].depends_on #=> Array
resp.computations[0].depends_on[0] #=> String
resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.status.error.message #=> String
resp.status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace.

  • :pipeline_name (required, String) —

    The name of the pipeline.

  • :pipeline_version (String) —

    The version number of the pipeline to retrieve. If not specified, returns the latest version.

Returns:



5672
5673
5674
5675
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5672

def describe_pipeline(params = {}, options = {})
  req = build_request(:describe_pipeline, params)
  req.send_request(options)
end

#describe_pipeline_execution(params = {}) ⇒ Types::DescribePipelineExecutionResponse

Retrieves detailed information about a specific pipeline execution, including the overall execution status and the status of each individual compute node. Use this operation to monitor execution progress and inspect per-node results, environment variables, and error details.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_pipeline_execution({
  workspace_name: "WorkspaceName", # required
  pipeline_name: "ResourceName", # required
  pipeline_execution_id: "ID", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.pipeline_execution_id #=> String
resp.pipeline_name #=> String
resp.workspace_name #=> String
resp.pipeline_version #=> String
resp.status.state #=> String, one of "NOT_STARTED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED"
resp.status.state_details.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "EXECUTION_ERROR", "TIMED_OUT"
resp.status.state_details.message #=> String
resp.status.state_details.details #=> Array
resp.status.state_details.details[0].code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "EXECUTION_ERROR", "TIMED_OUT"
resp.status.state_details.details[0].message #=> String
resp.start_time #=> Time
resp.end_time #=> Time
resp.request_environment_variables.global #=> Hash
resp.request_environment_variables.global["EnvironmentVariableName"] #=> String
resp.request_environment_variables.compute_nodes #=> Hash
resp.request_environment_variables.compute_nodes["ResourceName"] #=> Hash
resp.request_environment_variables.compute_nodes["ResourceName"]["EnvironmentVariableName"] #=> String
resp.request_mount_overrides.compute_nodes #=> Hash
resp.request_mount_overrides.compute_nodes["ResourceName"] #=> Array
resp.request_mount_overrides.compute_nodes["ResourceName"][0].name #=> String
resp.request_mount_overrides.compute_nodes["ResourceName"][0].relative_path #=> String
resp.request_mount_overrides.compute_nodes["ResourceName"][0].source.s3_access_point.access_point_arn #=> String
resp.request_mount_overrides.compute_nodes["ResourceName"][0].source.s3_access_point.prefix #=> String
resp.request_mount_overrides.compute_nodes["ResourceName"][0].storage_type #=> String, one of "SHARED_STORAGE"
resp.execution_priority #=> Integer
resp.compute_node_execution_details #=> Array
resp.compute_node_execution_details[0].compute_node_name #=> String
resp.compute_node_execution_details[0].task_name #=> String
resp.compute_node_execution_details[0].task_arn #=> String
resp.compute_node_execution_details[0].task_version #=> String
resp.compute_node_execution_details[0].depends_on #=> Array
resp.compute_node_execution_details[0].depends_on[0] #=> String
resp.compute_node_execution_details[0].status.state #=> String, one of "NOT_STARTED", "QUEUED", "RUNNING", "SUCCEEDED", "FAILED"
resp.compute_node_execution_details[0].status.state_details.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "EXECUTION_ERROR", "TIMED_OUT"
resp.compute_node_execution_details[0].status.state_details.message #=> String
resp.compute_node_execution_details[0].status.state_details.details #=> Array
resp.compute_node_execution_details[0].status.state_details.details[0].code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "EXECUTION_ERROR", "TIMED_OUT"
resp.compute_node_execution_details[0].status.state_details.details[0].message #=> String
resp.compute_node_execution_details[0].start_time #=> Time
resp.compute_node_execution_details[0].end_time #=> Time
resp.compute_node_execution_details[0].execution_environment_variables #=> Hash
resp.compute_node_execution_details[0].execution_environment_variables["ExecutionEnvironmentVariablesMapKeyString"] #=> String
resp.compute_node_execution_details[0].execution_mounts #=> Array
resp.compute_node_execution_details[0].execution_mounts[0].name #=> String
resp.compute_node_execution_details[0].execution_mounts[0].relative_path #=> String
resp.compute_node_execution_details[0].execution_mounts[0].source.s3_access_point.access_point_arn #=> String
resp.compute_node_execution_details[0].execution_mounts[0].source.s3_access_point.prefix #=> String
resp.compute_node_execution_details[0].execution_mounts[0].storage_type #=> String, one of "SHARED_STORAGE"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace.

  • :pipeline_name (required, String) —

    The name of the pipeline.

  • :pipeline_execution_id (required, String) —

    The unique identifier of the pipeline execution.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of compute nodes to return per request. This is an upper bound; the actual number of results may be less. Default: 50.

Returns:



5780
5781
5782
5783
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5780

def describe_pipeline_execution(params = {}, options = {})
  req = build_request(:describe_pipeline_execution, params)
  req.send_request(options)
end

#describe_portal(params = {}) ⇒ Types::DescribePortalResponse

Retrieves information about a portal.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • portal_active
  • portal_not_exists

Examples:

Request syntax with placeholder values


resp = client.describe_portal({
  portal_id: "ID", # required
})

Response structure


resp.portal_id #=> String
resp.portal_arn #=> String
resp.portal_name #=> String
resp.portal_description #=> String
resp.portal_client_id #=> String
resp.portal_start_url #=> String
resp.portal_contact_email #=> String
resp.portal_status.state #=> String, one of "CREATING", "PENDING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "LIMIT_EXCEEDED"
resp.portal_status.error.message #=> String
resp.portal_creation_date #=> Time
resp.portal_last_update_date #=> Time
resp.portal_logo_image_location.id #=> String
resp.portal_logo_image_location.url #=> String
resp.role_arn #=> String
resp.portal_auth_mode #=> String, one of "IAM", "SSO"
resp.notification_sender_email #=> String
resp.alarms.alarm_role_arn #=> String
resp.alarms.notification_lambda_arn #=> String
resp.portal_type #=> String, one of "SITEWISE_PORTAL_V1", "SITEWISE_PORTAL_V2"
resp.portal_type_configuration #=> Hash
resp.portal_type_configuration["PortalTypeKey"].portal_tools #=> Array
resp.portal_type_configuration["PortalTypeKey"].portal_tools[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :portal_id (required, String) —

    The ID of the portal.

Returns:



5850
5851
5852
5853
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5850

def describe_portal(params = {}, options = {})
  req = build_request(:describe_portal, params)
  req.send_request(options)
end

#describe_project(params = {}) ⇒ Types::DescribeProjectResponse

Retrieves information about a project.

Examples:

Request syntax with placeholder values


resp = client.describe_project({
  project_id: "ID", # required
})

Response structure


resp.project_id #=> String
resp.project_arn #=> String
resp.project_name #=> String
resp.portal_id #=> String
resp.project_description #=> String
resp.project_creation_date #=> Time
resp.project_last_update_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :project_id (required, String) —

    The ID of the project.

Returns:



5888
5889
5890
5891
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5888

def describe_project(params = {}, options = {})
  req = build_request(:describe_project, params)
  req.send_request(options)
end

#describe_query(params = {}) ⇒ Types::DescribeQueryResponse

Retrieves information about a query, including its status.

Examples:

Request syntax with placeholder values


resp = client.describe_query({
  workspace_name: "WorkspaceName", # required
  query_id: "QueryId", # required
})

Response structure


resp.query_id #=> String
resp.status #=> String, one of "SUBMITTED", "RUNNING", "COMPLETED", "FAILED", "CANCELED", "CANCELING"
resp.submitted_at #=> Time
resp.completed_at #=> Time
resp.statistics.row_count #=> Integer
resp.statistics.bytes_scanned #=> Integer
resp.statistics.execution_time_in_millis #=> Integer
resp.error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace associated with the query.

  • :query_id (required, String) —

    The unique identifier for the query execution.

Returns:



5930
5931
5932
5933
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5930

def describe_query(params = {}, options = {})
  req = build_request(:describe_query, params)
  req.send_request(options)
end

#describe_search(params = {}) ⇒ Types::DescribeSearchResponse

Returns the current status and metadata of a single search, including the query that was submitted, the search type, and — when the search has failed — the reason. Use this to poll a search started with StartSearch until it reaches a terminal status (SUCCEEDED or FAILED).

Examples:

Request syntax with placeholder values


resp = client.describe_search({
  workspace_name: "WorkspaceName", # required
  search_id: "SearchId", # required
})

Response structure


resp.search_id #=> String
resp.workspace_name #=> String
resp.status #=> String, one of "QUEUED", "RUNNING", "SUCCEEDED", "FAILED"
resp.query_statement #=> String
resp.search_type #=> String, one of "DEEP", "QUICK"
resp.status_reason #=> String
resp.started_at #=> Time
resp.group_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace the search belongs to.

  • :search_id (required, String) —

    The identifier of the search to describe.

Returns:



5978
5979
5980
5981
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 5978

def describe_search(params = {}, options = {})
  req = build_request(:describe_search, params)
  req.send_request(options)
end

#describe_storage_configuration(params = {}) ⇒ Types::DescribeStorageConfigurationResponse

Retrieves information about the storage configuration for IoT SiteWise.

Examples:

Response structure


resp.storage_type #=> String, one of "SITEWISE_DEFAULT_STORAGE", "MULTI_LAYER_STORAGE"
resp.multi_layer_storage.customer_managed_s3_storage.s3_resource_arn #=> String
resp.multi_layer_storage.customer_managed_s3_storage.role_arn #=> String
resp.disassociated_data_storage #=> String, one of "ENABLED", "DISABLED"
resp.retention_period.number_of_days #=> Integer
resp.retention_period.unlimited #=> Boolean
resp.configuration_status.state #=> String, one of "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
resp.configuration_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.configuration_status.error.message #=> String
resp.last_update_date #=> Time
resp.warm_tier #=> String, one of "ENABLED", "DISABLED"
resp.warm_tier_retention_period.number_of_days #=> Integer
resp.warm_tier_retention_period.unlimited #=> Boolean
resp.disallow_ingest_null_na_n #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:



6017
6018
6019
6020
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6017

def describe_storage_configuration(params = {}, options = {})
  req = build_request(:describe_storage_configuration, params)
  req.send_request(options)
end

#describe_task(params = {}) ⇒ Types::DescribeTaskResponse

Retrieves detailed information about a specific task in a workspace.

Examples:

Request syntax with placeholder values


resp = client.describe_task({
  workspace_name: "WorkspaceName", # required
  task_name: "ResourceName", # required
  task_version: "Version",
})

Response structure


resp.workspace_name #=> String
resp.task_name #=> String
resp.description #=> String
resp.task_arn #=> String
resp.version #=> String
resp.task_configuration.container_task_configuration.ecr_uri #=> String
resp.task_configuration.container_task_configuration.task_execution_role #=> String
resp.task_configuration.container_task_configuration.processing_type #=> String, one of "GENERIC_COMPUTE_PROCESSING", "HARDWARE_ACCELERATED_PROCESSING"
resp.task_configuration.container_task_configuration.processing_unit #=> String, one of "UNITS_2", "UNITS_4", "UNITS_8", "UNITS_12", "UNITS_16", "UNITS_24", "UNITS_32", "UNITS_36", "UNITS_48", "UNITS_60", "UNITS_64", "UNITS_72", "UNITS_84", "UNITS_96"
resp.task_configuration.container_task_configuration.ephemeral_storage_configuration.storage_class #=> String, one of "STANDARD_1", "STANDARD_2", "THROUGHPUT_1", "THROUGHPUT_2"
resp.task_configuration.container_task_configuration.ephemeral_storage_configuration.storage_size_in_gi_b #=> Integer
resp.task_configuration.container_task_configuration.command #=> Array
resp.task_configuration.container_task_configuration.command[0] #=> String
resp.task_configuration.container_task_configuration.timeout_seconds #=> Integer
resp.task_configuration.container_task_configuration.environment_variables #=> Hash
resp.task_configuration.container_task_configuration.environment_variables["EnvironmentVariableName"] #=> String
resp.task_configuration.container_task_configuration.mounts #=> Array
resp.task_configuration.container_task_configuration.mounts[0].name #=> String
resp.task_configuration.container_task_configuration.mounts[0].relative_path #=> String
resp.task_configuration.container_task_configuration.mounts[0].source.s3_access_point.access_point_arn #=> String
resp.task_configuration.container_task_configuration.mounts[0].source.s3_access_point.prefix #=> String
resp.task_configuration.container_task_configuration.mounts[0].storage_type #=> String, one of "SHARED_STORAGE"
resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.status.error.message #=> String
resp.status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace.

  • :task_name (required, String) —

    The name of the task.

  • :task_version (String) —

    The version number of the task to retrieve. If not specified, returns the latest version.

Returns:



6086
6087
6088
6089
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6086

def describe_task(params = {}, options = {})
  req = build_request(:describe_task, params)
  req.send_request(options)
end

#describe_time_series(params = {}) ⇒ Types::DescribeTimeSeriesResponse

Retrieves information about a time series (data stream).

To identify a time series, do one of the following:

  • If the time series isn't associated with an asset property, specify the alias of the time series.

  • If the time series is associated with an asset property, specify one of the following:

    • The alias of the time series.

    • The assetId and propertyId that identifies the asset property.

Examples:

Request syntax with placeholder values


resp = client.describe_time_series({
  alias: "PropertyAlias",
  asset_id: "CustomID",
  property_id: "CustomID",
  workspace_name: "WorkspaceName",
})

Response structure


resp.asset_id #=> String
resp.property_id #=> String
resp.alias #=> String
resp.time_series_id #=> String
resp.data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT", "VIDEO", "ANNOTATION", "JSON"
resp.data_type_spec #=> String
resp.time_series_creation_date #=> Time
resp.time_series_last_update_date #=> Time
resp.time_series_arn #=> String
resp.workspace_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :alias (String) —

    The alias that identifies the time series.

  • :asset_id (String) —

    The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :property_id (String) —

    The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :workspace_name (String) —

    The name of the workspace.

Returns:



6169
6170
6171
6172
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6169

def describe_time_series(params = {}, options = {})
  req = build_request(:describe_time_series, params)
  req.send_request(options)
end

#describe_workspace(params = {}) ⇒ Types::DescribeWorkspaceResponse

Retrieves information about a workspace.

Examples:

Request syntax with placeholder values


resp = client.describe_workspace({
  workspace_name: "WorkspaceName", # required
})

Response structure


resp.workspace_arn #=> String
resp.workspace_name #=> String
resp.workspace_description #=> String
resp.workspace_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.workspace_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.workspace_status.error.message #=> String
resp.encryption_configuration.encryption_type #=> String, one of "SITEWISE_DEFAULT_ENCRYPTION", "KMS_BASED_ENCRYPTION"
resp.encryption_configuration.kms_key_arn #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace.

Returns:



6210
6211
6212
6213
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6210

def describe_workspace(params = {}, options = {})
  req = build_request(:describe_workspace, params)
  req.send_request(options)
end

#disassociate_assets(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.disassociate_assets({
  asset_id: "CustomID", # required
  hierarchy_id: "CustomID", # required
  child_asset_id: "CustomID", # required
  client_token: "ClientToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_id (required, String) —

    The ID of the parent asset from which to disassociate the child asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :hierarchy_id (required, String) —

    The ID of a hierarchy in the parent asset's model. (This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.) Hierarchies allow different groupings of assets to be formed that all come from the same asset model. You can use the hierarchy ID to identify the correct asset to disassociate. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

  • :child_asset_id (required, String) —

    The ID of the child asset to disassociate. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.



6275
6276
6277
6278
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6275

def disassociate_assets(params = {}, options = {})
  req = build_request(:disassociate_assets, params)
  req.send_request(options)
end

#disassociate_time_series_from_asset_property(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.disassociate_time_series_from_asset_property({
  alias: "PropertyAlias", # required
  asset_id: "CustomID", # required
  property_id: "CustomID", # required
  client_token: "ClientToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :alias (required, String) —

    The alias that identifies the time series.

  • :asset_id (required, String) —

    The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :property_id (required, String) —

    The ID of the asset property. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.



6327
6328
6329
6330
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6327

def disassociate_time_series_from_asset_property(params = {}, options = {})
  req = build_request(:disassociate_time_series_from_asset_property, params)
  req.send_request(options)
end

#execute_action(params = {}) ⇒ Types::ExecuteActionResponse

Executes an action on a target resource.

Examples:

Request syntax with placeholder values


resp = client.execute_action({
  target_resource: { # required
    asset_id: "ID",
    computation_model_id: "ID",
  },
  action_definition_id: "ID", # required
  action_payload: { # required
    string_value: "ActionPayloadString", # required
  },
  client_token: "ClientToken",
  resolve_to: {
    asset_id: "ID", # required
  },
})

Response structure


resp.action_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :target_resource (required, Types::TargetResource) —

    The resource the action will be taken on.

  • :action_definition_id (required, String) —

    The ID of the action definition.

  • :action_payload (required, Types::ActionPayload) —

    The JSON payload of the action.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

  • :resolve_to (Types::ResolveTo) —

    The detailed resource this action resolves to.

Returns:



6378
6379
6380
6381
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6378

def execute_action(params = {}, options = {})
  req = build_request(:execute_action, params)
  req.send_request(options)
end

#execute_query(params = {}) ⇒ Types::ExecuteQueryResponse

Run SQL queries to retrieve metadata and time-series data from asset models, assets, measurements, metrics, transforms, and aggregates.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.execute_query({
  query_statement: "QueryStatement", # required
  next_token: "ExecuteQueryNextToken",
  max_results: 1,
  client_token: "ClientToken",
})

Response structure


resp.columns #=> Array
resp.columns[0].name #=> String
resp.columns[0].type.scalar_type #=> String, one of "BOOLEAN", "INT", "DOUBLE", "TIMESTAMP", "STRING"
resp.rows #=> Array
resp.rows[0].data #=> Array
resp.rows[0].data[0].scalar_value #=> String
resp.rows[0].data[0].array_value #=> Types::DatumList
resp.rows[0].data[0].row_value #=> Types::Row
resp.rows[0].data[0].null_value #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :query_statement (required, String) —

    The IoT SiteWise query statement.

  • :next_token (String) —

    The string that specifies the next page of results.

  • :max_results (Integer) —

    The maximum number of results to return at one time.

    • Minimum is 1

    • Maximum is 20000

    • Default is 20000

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



6441
6442
6443
6444
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6441

def execute_query(params = {}, options = {})
  req = build_request(:execute_query, params)
  req.send_request(options)
end

#get_asset_property_aggregates(params = {}) ⇒ Types::GetAssetPropertyAggregatesResponse

Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

  • The assetId and propertyId of an asset property.

  • A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_asset_property_aggregates({
  asset_id: "ID",
  property_id: "ID",
  property_alias: "AssetPropertyAlias",
  aggregate_types: ["AVERAGE"], # required, accepts AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION
  resolution: "Resolution", # required
  qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
  start_date: Time.now, # required
  end_date: Time.now, # required
  time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.aggregated_values #=> Array
resp.aggregated_values[0].timestamp #=> Time
resp.aggregated_values[0].quality #=> String, one of "GOOD", "BAD", "UNCERTAIN"
resp.aggregated_values[0].value.average #=> Float
resp.aggregated_values[0].value.count #=> Float
resp.aggregated_values[0].value.maximum #=> Float
resp.aggregated_values[0].value.minimum #=> Float
resp.aggregated_values[0].value.sum #=> Float
resp.aggregated_values[0].value.standard_deviation #=> Float
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_id (String) —

    The ID of the asset, in UUID format.

  • :property_id (String) —

    The ID of the asset property, in UUID format.

  • :property_alias (String) —

    The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

  • :aggregate_types (required, Array<String>) —

    The data aggregating function.

  • :resolution (required, String) —

    The time interval over which to aggregate data.

  • :qualities (Array<String>) —

    The quality by which to filter asset data.

  • :start_date (required, Time, DateTime, Date, Integer, String) —

    The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

  • :end_date (required, Time, DateTime, Date, Integer, String) —

    The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

  • :time_ordering (String) —

    The chronological sorting order of the requested information.

    Default: ASCENDING

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.

    • The size of the result set is equal to 1 MB.

    • The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 2500.

Returns:



6551
6552
6553
6554
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6551

def get_asset_property_aggregates(params = {}, options = {})
  req = build_request(:get_asset_property_aggregates, params)
  req.send_request(options)
end

#get_asset_property_value(params = {}) ⇒ Types::GetAssetPropertyValueResponse

Gets an asset property's current value. For more information, see Querying current values in the IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

  • The assetId and propertyId of an asset property.

  • A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

Examples:

Request syntax with placeholder values


resp = client.get_asset_property_value({
  asset_id: "ID",
  property_id: "ID",
  property_alias: "AssetPropertyAlias",
})

Response structure


resp.property_value.value.string_value #=> String
resp.property_value.value.integer_value #=> Integer
resp.property_value.value.double_value #=> Float
resp.property_value.value.boolean_value #=> Boolean
resp.property_value.value.null_value.value_type #=> String, one of "D", "B", "S", "I", "U"
resp.property_value.timestamp.time_in_seconds #=> Integer
resp.property_value.timestamp.offset_in_nanos #=> Integer
resp.property_value.quality #=> String, one of "GOOD", "BAD", "UNCERTAIN"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_id (String) —

    The ID of the asset, in UUID format.

  • :property_id (String) —

    The ID of the asset property, in UUID format.

  • :property_alias (String) —

    The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

Returns:



6614
6615
6616
6617
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6614

def get_asset_property_value(params = {}, options = {})
  req = build_request(:get_asset_property_value, params)
  req.send_request(options)
end

#get_asset_property_value_history(params = {}) ⇒ Types::GetAssetPropertyValueHistoryResponse

Gets the history of an asset property's values. For more information, see Querying historical values in the IoT SiteWise User Guide.

To identify an asset property, you must specify one of the following:

  • The assetId and propertyId of an asset property.

  • A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_asset_property_value_history({
  asset_id: "ID",
  property_id: "ID",
  property_alias: "AssetPropertyAlias",
  start_date: Time.now,
  end_date: Time.now,
  qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
  time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.asset_property_value_history #=> Array
resp.asset_property_value_history[0].value.string_value #=> String
resp.asset_property_value_history[0].value.integer_value #=> Integer
resp.asset_property_value_history[0].value.double_value #=> Float
resp.asset_property_value_history[0].value.boolean_value #=> Boolean
resp.asset_property_value_history[0].value.null_value.value_type #=> String, one of "D", "B", "S", "I", "U"
resp.asset_property_value_history[0].timestamp.time_in_seconds #=> Integer
resp.asset_property_value_history[0].timestamp.offset_in_nanos #=> Integer
resp.asset_property_value_history[0].quality #=> String, one of "GOOD", "BAD", "UNCERTAIN"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_id (String) —

    The ID of the asset, in UUID format.

  • :property_id (String) —

    The ID of the asset property, in UUID format.

  • :property_alias (String) —

    The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

  • :start_date (Time, DateTime, Date, Integer, String) —

    The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.

  • :end_date (Time, DateTime, Date, Integer, String) —

    The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.

  • :qualities (Array<String>) —

    The quality by which to filter asset data.

  • :time_ordering (String) —

    The chronological sorting order of the requested information.

    Default: ASCENDING

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.

    • The size of the result set is equal to 4 MB.

    • The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 20000.

Returns:



6716
6717
6718
6719
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6716

def get_asset_property_value_history(params = {}, options = {})
  req = build_request(:get_asset_property_value_history, params)
  req.send_request(options)
end

#get_capture_data(params = {}) ⇒ Types::GetCaptureDataResponse

Retrieves video data for a specific time range.

Examples:

Request syntax with placeholder values


resp = client.get_capture_data({
  workspace_name: "WorkspaceName", # required
  start_time: { # required
    time_in_seconds: 1, # required
    offset_in_nanos: 1,
  },
  end_time: { # required
    time_in_seconds: 1, # required
    offset_in_nanos: 1,
  },
  time_series_id: "TimeSeriesId",
  property_alias: "AssetPropertyAlias",
  format_settings: {
    frames_per_second: 1,
    width_in_pixels: 1,
    height_in_pixels: 1,
  },
  next_token: "GetCaptureDataNextToken",
})

Response structure


resp.data #=> String
resp.start_time.time_in_seconds #=> Integer
resp.start_time.offset_in_nanos #=> Integer
resp.end_time.time_in_seconds #=> Integer
resp.end_time.offset_in_nanos #=> Integer
resp.data_type #=> String, one of "VIDEO-MP4"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace that contains the capture source.

  • :start_time (required, Types::TimeInNanos) —

    The start time for the video data range.

  • :end_time (required, Types::TimeInNanos) —

    The end time for the video data range. Must be greater than startTime.

  • :time_series_id (String) —

    The time series ID that identifies the capture source. Mutually exclusive with propertyAlias.

  • :property_alias (String) —

    The property alias that identifies the capture source. Mutually exclusive with timeSeriesId.

  • :format_settings (Types::FormatSettings) —

    The optional format settings for the output.

  • :next_token (String) —

    The token from a previous response used to continue retrieving data.

Returns:



6788
6789
6790
6791
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6788

def get_capture_data(params = {}, options = {})
  req = build_request(:get_capture_data, params)
  req.send_request(options)
end

#get_interpolated_asset_property_values(params = {}) ⇒ Types::GetInterpolatedAssetPropertyValuesResponse

Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the specified time interval, you can use interpolation to estimate the missing data.

For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days.

To identify an asset property, you must specify one of the following:

  • The assetId and propertyId of an asset property.

  • A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_interpolated_asset_property_values({
  asset_id: "ID",
  property_id: "ID",
  property_alias: "AssetPropertyAlias",
  start_time_in_seconds: 1, # required
  start_time_offset_in_nanos: 1,
  end_time_in_seconds: 1, # required
  end_time_offset_in_nanos: 1,
  quality: "GOOD", # required, accepts GOOD, BAD, UNCERTAIN
  interval_in_seconds: 1, # required
  next_token: "NextToken",
  max_results: 1,
  type: "InterpolationType", # required
  interval_window_in_seconds: 1,
})

Response structure


resp.interpolated_asset_property_values #=> Array
resp.interpolated_asset_property_values[0].timestamp.time_in_seconds #=> Integer
resp.interpolated_asset_property_values[0].timestamp.offset_in_nanos #=> Integer
resp.interpolated_asset_property_values[0].value.string_value #=> String
resp.interpolated_asset_property_values[0].value.integer_value #=> Integer
resp.interpolated_asset_property_values[0].value.double_value #=> Float
resp.interpolated_asset_property_values[0].value.boolean_value #=> Boolean
resp.interpolated_asset_property_values[0].value.null_value.value_type #=> String, one of "D", "B", "S", "I", "U"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_id (String) —

    The ID of the asset, in UUID format.

  • :property_id (String) —

    The ID of the asset property, in UUID format.

  • :property_alias (String) —

    The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

  • :start_time_in_seconds (required, Integer) —

    The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time.

  • :start_time_offset_in_nanos (Integer) —

    The nanosecond offset converted from startTimeInSeconds.

  • :end_time_in_seconds (required, Integer) —

    The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time.

  • :end_time_offset_in_nanos (Integer) —

    The nanosecond offset converted from endTimeInSeconds.

  • :quality (required, String) —

    The quality of the asset property value. You can use this parameter as a filter to choose only the asset property values that have a specific quality.

  • :interval_in_seconds (required, Integer) —

    The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request. If not specified, the default value is 10.

  • :type (required, String) —

    The interpolation type.

    Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION

    • LINEAR_INTERPOLATION – Estimates missing data using linear interpolation.

      For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the first interpolated value on July 2, 2021, at 9 AM, the second interpolated value on July 3, 2021, at 9 AM, and so on.

    • LOCF_INTERPOLATION – Estimates missing data using last observation carried forward interpolation

      If no data point is found for an interval, IoT SiteWise returns the last observed data point for the previous interval and carries forward this interpolated value until a new data point is found.

      For example, you can get the state of an on-off valve every 24 hours over a duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the last observed data point between July 1, 2021, at 9 AM and July 2, 2021, at 9 AM as the first interpolated value. If a data point isn't found after 9 AM on July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the days.

  • :interval_window_in_seconds (Integer) —

    The query interval for the window, in seconds. IoT SiteWise computes each interpolated value by using data points from the timestamp of each interval, minus the window to the timestamp of each interval plus the window. If not specified, the window ranges between the start time minus the interval and the end time plus the interval.

    * If you specify a value for the intervalWindowInSeconds parameter, the value for the type parameter must be LINEAR_INTERPOLATION.

    • If a data point isn't found during the specified query window, IoT SiteWise won't return an interpolated value for the interval. This indicates that there's a gap in the ingested data points.

    For example, you can get the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts on July 1, 2021, at 9 AM with a window of 2 hours, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 2, 2021 to compute the first interpolated value. Next, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021 to compute the second interpolated value, and so on.

Returns:



6959
6960
6961
6962
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 6959

def get_interpolated_asset_property_values(params = {}, options = {})
  req = build_request(:get_interpolated_asset_property_values, params)
  req.send_request(options)
end

#get_query_results(params = {}) ⇒ Types::GetQueryResultsResponse

Retrieves the paginated results of a query. Returns empty rows if the query is not yet complete.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_query_results({
  workspace_name: "WorkspaceName", # required
  query_id: "QueryId", # required
  max_results: 1,
  next_token: "QueryNextToken",
})

Response structure


resp.column_info #=> Array
resp.column_info[0].name #=> String
resp.column_info[0].type #=> String
resp.rows #=> Array
resp.rows[0] #=> Array
resp.rows[0][0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace associated with the query.

  • :query_id (required, String) —

    The unique identifier for the query execution.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

Returns:



7008
7009
7010
7011
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7008

def get_query_results(params = {}, options = {})
  req = build_request(:get_query_results, params)
  req.send_request(options)
end

#get_search_results(params = {}) ⇒ Types::GetSearchResultsResponse

Retrieves the ranked results of a search, ordered by descending relevance score. Results are available only after the search has reached the SUCCEEDED status. Calling this on a search that exists but has not yet completed returns InvalidRequestException, while calling it on a search that does not exist returns ResourceNotFoundException. The response is paginated: when nextToken is present, pass it on a subsequent call to retrieve the next page.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_search_results({
  search_id: "SearchId", # required
  workspace_name: "WorkspaceName", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.search_results #=> Array
resp.search_results[0].search_id #=> String
resp.search_results[0].workspace_name #=> String
resp.search_results[0].dataset_id #=> String
resp.search_results[0].time_series_id #=> String
resp.search_results[0].start_timestamp.time_in_seconds #=> Integer
resp.search_results[0].start_timestamp.offset_in_nanos #=> Integer
resp.search_results[0].end_timestamp.time_in_seconds #=> Integer
resp.search_results[0].end_timestamp.offset_in_nanos #=> Integer
resp.search_results[0].top_timestamp.time_in_seconds #=> Integer
resp.search_results[0].top_timestamp.offset_in_nanos #=> Integer
resp.search_results[0].score #=> Float
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :search_id (required, String) —

    The identifier of the search whose results are retrieved.

  • :workspace_name (required, String) —

    The name of the workspace the search belongs to.

  • :max_results (Integer) —

    The maximum number of results to return in a single page. Valid range is 1 to 10,000; if omitted, a service-defined default is used.

  • :next_token (String) —

    The pagination token returned by a previous GetSearchResults call. Provide it to retrieve the next page of results; omit it to retrieve the first page.

Returns:



7071
7072
7073
7074
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7071

def get_search_results(params = {}, options = {})
  req = build_request(:get_search_results, params)
  req.send_request(options)
end

#invoke_assistant(params = {}) ⇒ Types::InvokeAssistantResponse

Invokes SiteWise Assistant to start or continue a conversation.

Examples:

EventStream Operation Example


# You can process the event once it arrives immediately, or wait until the
# full response is complete and iterate through the eventstream enumerator.

# To interact with event immediately, you need to register invoke_assistant
# with callbacks. Callbacks can be registered for specific events or for all
# events, including error events.

# Callbacks can be passed into the `:event_stream_handler` option or within a
# block statement attached to the #invoke_assistant call directly. Hybrid
# pattern of both is also supported.

# `:event_stream_handler` option takes in either a Proc object or
# Aws::IoTSiteWise::EventStreams::ResponseStream object.

# Usage pattern a): Callbacks with a block attached to #invoke_assistant
# Example for registering callbacks for all event types and an error event
client.invoke_assistant(
  # params input
) do |stream|
  stream.on_error_event do |event|
    # catch unmodeled error event in the stream
    raise event
    # => Aws::Errors::EventError
    # event.event_type => :error
    # event.error_code => String
    # event.error_message => String
  end

  stream.on_event do |event|
    # process all events arrive
    puts event.event_type
    # ...
  end
end

# Usage pattern b): Pass in `:event_stream_handler` for #invoke_assistant
#  1) Create a Aws::IoTSiteWise::EventStreams::ResponseStream object
#  Example for registering callbacks with specific events

handler = Aws::IoTSiteWise::EventStreams::ResponseStream.new
handler.on_trace_event do |event|
  event # => Aws::IoTSiteWise::Types::trace
end
handler.on_output_event do |event|
  event # => Aws::IoTSiteWise::Types::output
end
handler.on_access_denied_exception_event do |event|
  event # => Aws::IoTSiteWise::Types::accessDeniedException
end
handler.on_conflicting_operation_exception_event do |event|
  event # => Aws::IoTSiteWise::Types::conflictingOperationException
end
handler.on_internal_failure_exception_event do |event|
  event # => Aws::IoTSiteWise::Types::internalFailureException
end
handler.on_invalid_request_exception_event do |event|
  event # => Aws::IoTSiteWise::Types::invalidRequestException
end
handler.on_limit_exceeded_exception_event do |event|
  event # => Aws::IoTSiteWise::Types::limitExceededException
end
handler.on_resource_not_found_exception_event do |event|
  event # => Aws::IoTSiteWise::Types::resourceNotFoundException
end
handler.on_throttling_exception_event do |event|
  event # => Aws::IoTSiteWise::Types::throttlingException
end

client.invoke_assistant(
  # params inputs
  event_stream_handler: handler
)

#  2) Use a Ruby Proc object
#  Example for registering callbacks with specific events
handler = Proc.new do |stream|
  stream.on_trace_event do |event|
    event # => Aws::IoTSiteWise::Types::trace
  end
  stream.on_output_event do |event|
    event # => Aws::IoTSiteWise::Types::output
  end
  stream.on_access_denied_exception_event do |event|
    event # => Aws::IoTSiteWise::Types::accessDeniedException
  end
  stream.on_conflicting_operation_exception_event do |event|
    event # => Aws::IoTSiteWise::Types::conflictingOperationException
  end
  stream.on_internal_failure_exception_event do |event|
    event # => Aws::IoTSiteWise::Types::internalFailureException
  end
  stream.on_invalid_request_exception_event do |event|
    event # => Aws::IoTSiteWise::Types::invalidRequestException
  end
  stream.on_limit_exceeded_exception_event do |event|
    event # => Aws::IoTSiteWise::Types::limitExceededException
  end
  stream.on_resource_not_found_exception_event do |event|
    event # => Aws::IoTSiteWise::Types::resourceNotFoundException
  end
  stream.on_throttling_exception_event do |event|
    event # => Aws::IoTSiteWise::Types::throttlingException
  end
end

client.invoke_assistant(
  # params inputs
  event_stream_handler: handler
)

#  Usage pattern c): Hybrid pattern of a) and b)
handler = Aws::IoTSiteWise::EventStreams::ResponseStream.new
handler.on_trace_event do |event|
  event # => Aws::IoTSiteWise::Types::trace
end
handler.on_output_event do |event|
  event # => Aws::IoTSiteWise::Types::output
end
handler.on_access_denied_exception_event do |event|
  event # => Aws::IoTSiteWise::Types::accessDeniedException
end
handler.on_conflicting_operation_exception_event do |event|
  event # => Aws::IoTSiteWise::Types::conflictingOperationException
end
handler.on_internal_failure_exception_event do |event|
  event # => Aws::IoTSiteWise::Types::internalFailureException
end
handler.on_invalid_request_exception_event do |event|
  event # => Aws::IoTSiteWise::Types::invalidRequestException
end
handler.on_limit_exceeded_exception_event do |event|
  event # => Aws::IoTSiteWise::Types::limitExceededException
end
handler.on_resource_not_found_exception_event do |event|
  event # => Aws::IoTSiteWise::Types::resourceNotFoundException
end
handler.on_throttling_exception_event do |event|
  event # => Aws::IoTSiteWise::Types::throttlingException
end

client.invoke_assistant(
  # params input
  event_stream_handler: handler
) do |stream|
  stream.on_error_event do |event|
    # catch unmodeled error event in the stream
    raise event
    # => Aws::Errors::EventError
    # event.event_type => :error
    # event.error_code => String
    # event.error_message => String
  end
end

# You can also iterate through events after the response complete.
# Events are available at
resp.body # => Enumerator
# For parameter input example, please refer to following request syntax.

Request syntax with placeholder values


resp = client.invoke_assistant({
  conversation_id: "ConversationId",
  message: "MessageInput", # required
  enable_trace: false,
})

Response structure


# All events are available at resp.body:
resp.body #=> Enumerator
resp.body.event_types #=> [:trace, :output, :access_denied_exception, :conflicting_operation_exception, :internal_failure_exception, :invalid_request_exception, :limit_exceeded_exception, :resource_not_found_exception, :throttling_exception]

# For :trace event available at #on_trace_event callback and response eventstream enumerator:
event.text #=> String

# For :output event available at #on_output_event callback and response eventstream enumerator:
event.message #=> String
event.citations #=> Array
event.citations[0].reference.dataset.dataset_arn #=> String
event.citations[0].reference.dataset.source.arn #=> String
event.citations[0].reference.dataset.source.location.uri #=> String
event.citations[0].content.text #=> String

# For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
event.message #=> String

# For :conflicting_operation_exception event available at #on_conflicting_operation_exception_event callback and response eventstream enumerator:
event.message #=> String
event.resource_id #=> String
event.resource_arn #=> String

# For :internal_failure_exception event available at #on_internal_failure_exception_event callback and response eventstream enumerator:
event.message #=> String

# For :invalid_request_exception event available at #on_invalid_request_exception_event callback and response eventstream enumerator:
event.message #=> String

# For :limit_exceeded_exception event available at #on_limit_exceeded_exception_event callback and response eventstream enumerator:
event.message #=> String

# For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
event.message #=> String

# For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
event.message #=> String

resp.conversation_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :conversation_id (String) —

    The ID assigned to a conversation. IoT SiteWise automatically generates a unique ID for you, and this parameter is never required. However, if you prefer to have your own ID, you must specify it here in UUID format. If you specify your own ID, it must be globally unique.

  • :message (required, String) —

    A text message sent to the SiteWise Assistant by the user.

  • :enable_trace (Boolean) —

    Specifies if to turn trace on or not. It is used to track the SiteWise Assistant's reasoning, and data access process.

Yields:

  • (event_stream_handler)

Returns:



7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7310

def invoke_assistant(params = {}, options = {}, &block)
  params = params.dup
  event_stream_handler = case handler = params.delete(:event_stream_handler)
    when EventStreams::ResponseStream then handler
    when Proc then EventStreams::ResponseStream.new.tap(&handler)
    when nil then EventStreams::ResponseStream.new
    else
      msg = "expected :event_stream_handler to be a block or "\
            "instance of Aws::IoTSiteWise::EventStreams::ResponseStream"\
            ", got `#{handler.inspect}` instead"
      raise ArgumentError, msg
    end

  yield(event_stream_handler) if block_given?

  req = build_request(:invoke_assistant, params)

  req.context[:event_stream_handler] = event_stream_handler
  req.handlers.add(Aws::Binary::DecodeHandler, priority: 95)

  req.send_request(options, &block)
end

#list_access_policies(params = {}) ⇒ Types::ListAccessPoliciesResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_access_policies({
  identity_type: "USER", # accepts USER, GROUP, IAM
  identity_id: "IdentityId",
  resource_type: "PORTAL", # accepts PORTAL, PROJECT
  resource_id: "ID",
  iam_arn: "IamArn",
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.access_policy_summaries #=> Array
resp.access_policy_summaries[0].id #=> String
resp.access_policy_summaries[0].identity.user.id #=> String
resp.access_policy_summaries[0].identity.group.id #=> String
resp.access_policy_summaries[0].identity.iam_user.arn #=> String
resp.access_policy_summaries[0].identity.iam_role.arn #=> String
resp.access_policy_summaries[0].resource.portal.id #=> String
resp.access_policy_summaries[0].resource.project.id #=> String
resp.access_policy_summaries[0].permission #=> String, one of "ADMINISTRATOR", "VIEWER"
resp.access_policy_summaries[0].creation_date #=> Time
resp.access_policy_summaries[0].last_update_date #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identity_type (String) —

    The type of identity (IAM Identity Center user, IAM Identity Center group, or IAM user). This parameter is required if you specify identityId.

  • :identity_id (String) —

    The ID of the identity. This parameter is required if you specify USER or GROUP for identityType.

  • :resource_type (String) —

    The type of resource (portal or project). This parameter is required if you specify resourceId.

  • :resource_id (String) —

    The ID of the resource. This parameter is required if you specify resourceType.

  • :iam_arn (String) —

    The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide. This parameter is required if you specify IAM for identityType.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request.

    Default: 50

Returns:



7407
7408
7409
7410
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7407

def list_access_policies(params = {}, options = {})
  req = build_request(:list_access_policies, params)
  req.send_request(options)
end

#list_actions(params = {}) ⇒ Types::ListActionsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_actions({
  target_resource_type: "ASSET", # required, accepts ASSET, COMPUTATION_MODEL
  target_resource_id: "ID", # required
  next_token: "NextToken",
  max_results: 1,
  resolve_to_resource_type: "ASSET", # accepts ASSET
  resolve_to_resource_id: "ID",
})

Response structure


resp.action_summaries #=> Array
resp.action_summaries[0].action_id #=> String
resp.action_summaries[0].action_definition_id #=> String
resp.action_summaries[0].target_resource.asset_id #=> String
resp.action_summaries[0].target_resource.computation_model_id #=> String
resp.action_summaries[0].resolve_to.asset_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :target_resource_type (required, String) —

    The type of resource.

  • :target_resource_id (required, String) —

    The ID of the target resource.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request.

  • :resolve_to_resource_type (String) —

    The type of the resolved resource.

  • :resolve_to_resource_id (String) —

    The ID of the resolved resource.

Returns:



7462
7463
7464
7465
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7462

def list_actions(params = {}, options = {})
  req = build_request(:list_actions, params)
  req.send_request(options)
end

#list_applications(params = {}) ⇒ Types::ListApplicationsResponse

Retrieves a paginated list of existing applications

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_applications({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.applications #=> Array
resp.applications[0].arn #=> String
resp.applications[0].id #=> String
resp.applications[0].name #=> String
resp.applications[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING"
resp.applications[0].created_at #=> Time
resp.applications[0].workspace_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Maximum number of results to return

  • :next_token (String) —

    Next Page Token

Returns:



7502
7503
7504
7505
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7502

def list_applications(params = {}, options = {})
  req = build_request(:list_applications, params)
  req.send_request(options)
end

#list_asset_model_composite_models(params = {}) ⇒ Types::ListAssetModelCompositeModelsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_asset_model_composite_models({
  asset_model_id: "CustomID", # required
  next_token: "NextToken",
  max_results: 1,
  asset_model_version: "AssetModelVersionFilter",
})

Response structure


resp.asset_model_composite_model_summaries #=> Array
resp.asset_model_composite_model_summaries[0].id #=> String
resp.asset_model_composite_model_summaries[0].external_id #=> String
resp.asset_model_composite_model_summaries[0].name #=> String
resp.asset_model_composite_model_summaries[0].type #=> String
resp.asset_model_composite_model_summaries[0].description #=> String
resp.asset_model_composite_model_summaries[0].path #=> Array
resp.asset_model_composite_model_summaries[0].path[0].id #=> String
resp.asset_model_composite_model_summaries[0].path[0].name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_model_id (required, String) —

    The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request.

    Default: 50

  • :asset_model_version (String) —

    The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.

Returns:



7569
7570
7571
7572
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7569

def list_asset_model_composite_models(params = {}, options = {})
  req = build_request(:list_asset_model_composite_models, params)
  req.send_request(options)
end

#list_asset_model_properties(params = {}) ⇒ Types::ListAssetModelPropertiesResponse

Retrieves a paginated list of properties associated with an asset model. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_asset_model_properties({
  asset_model_id: "CustomID", # required
  next_token: "NextToken",
  max_results: 1,
  filter: "ALL", # accepts ALL, BASE
  asset_model_version: "AssetModelVersionFilter",
})

Response structure


resp.asset_model_property_summaries #=> Array
resp.asset_model_property_summaries[0].id #=> String
resp.asset_model_property_summaries[0].external_id #=> String
resp.asset_model_property_summaries[0].name #=> String
resp.asset_model_property_summaries[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT", "VIDEO", "ANNOTATION", "JSON"
resp.asset_model_property_summaries[0].data_type_spec #=> String
resp.asset_model_property_summaries[0].unit #=> String
resp.asset_model_property_summaries[0].type.attribute.default_value #=> String
resp.asset_model_property_summaries[0].type.measurement.processing_config.forwarding_config.state #=> String, one of "DISABLED", "ENABLED"
resp.asset_model_property_summaries[0].type.transform.expression #=> String
resp.asset_model_property_summaries[0].type.transform.variables #=> Array
resp.asset_model_property_summaries[0].type.transform.variables[0].name #=> String
resp.asset_model_property_summaries[0].type.transform.variables[0].value.property_id #=> String
resp.asset_model_property_summaries[0].type.transform.variables[0].value.hierarchy_id #=> String
resp.asset_model_property_summaries[0].type.transform.variables[0].value.property_path #=> Array
resp.asset_model_property_summaries[0].type.transform.variables[0].value.property_path[0].id #=> String
resp.asset_model_property_summaries[0].type.transform.variables[0].value.property_path[0].name #=> String
resp.asset_model_property_summaries[0].type.transform.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
resp.asset_model_property_summaries[0].type.transform.processing_config.forwarding_config.state #=> String, one of "DISABLED", "ENABLED"
resp.asset_model_property_summaries[0].type.metric.expression #=> String
resp.asset_model_property_summaries[0].type.metric.variables #=> Array
resp.asset_model_property_summaries[0].type.metric.variables[0].name #=> String
resp.asset_model_property_summaries[0].type.metric.variables[0].value.property_id #=> String
resp.asset_model_property_summaries[0].type.metric.variables[0].value.hierarchy_id #=> String
resp.asset_model_property_summaries[0].type.metric.variables[0].value.property_path #=> Array
resp.asset_model_property_summaries[0].type.metric.variables[0].value.property_path[0].id #=> String
resp.asset_model_property_summaries[0].type.metric.variables[0].value.property_path[0].name #=> String
resp.asset_model_property_summaries[0].type.metric.window.tumbling.interval #=> String
resp.asset_model_property_summaries[0].type.metric.window.tumbling.offset #=> String
resp.asset_model_property_summaries[0].type.metric.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
resp.asset_model_property_summaries[0].asset_model_composite_model_id #=> String
resp.asset_model_property_summaries[0].path #=> Array
resp.asset_model_property_summaries[0].path[0].id #=> String
resp.asset_model_property_summaries[0].path[0].name #=> String
resp.asset_model_property_summaries[0].interface_summaries #=> Array
resp.asset_model_property_summaries[0].interface_summaries[0].interface_asset_model_id #=> String
resp.asset_model_property_summaries[0].interface_summaries[0].interface_asset_model_property_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_model_id (required, String) —

    The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request. If not specified, the default value is 50.

  • :filter (String) —

    Filters the requested list of asset model properties. You can choose one of the following options:

    • ALL – The list includes all asset model properties for a given asset model ID.

    • BASE – The list includes only base asset model properties for a given asset model ID.

    Default: BASE

  • :asset_model_version (String) —

    The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.

Returns:



7677
7678
7679
7680
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7677

def list_asset_model_properties(params = {}, options = {})
  req = build_request(:list_asset_model_properties, params)
  req.send_request(options)
end

#list_asset_models(params = {}) ⇒ Types::ListAssetModelsResponse

Retrieves a paginated list of summaries of all asset models.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_asset_models({
  asset_model_types: ["ASSET_MODEL"], # accepts ASSET_MODEL, COMPONENT_MODEL, INTERFACE
  next_token: "NextToken",
  max_results: 1,
  asset_model_version: "AssetModelVersionFilter",
})

Response structure


resp.asset_model_summaries #=> Array
resp.asset_model_summaries[0].id #=> String
resp.asset_model_summaries[0].external_id #=> String
resp.asset_model_summaries[0].arn #=> String
resp.asset_model_summaries[0].name #=> String
resp.asset_model_summaries[0].asset_model_type #=> String, one of "ASSET_MODEL", "COMPONENT_MODEL", "INTERFACE"
resp.asset_model_summaries[0].description #=> String
resp.asset_model_summaries[0].creation_date #=> Time
resp.asset_model_summaries[0].last_update_date #=> Time
resp.asset_model_summaries[0].status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED"
resp.asset_model_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.asset_model_summaries[0].status.error.message #=> String
resp.asset_model_summaries[0].status.error.details #=> Array
resp.asset_model_summaries[0].status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.asset_model_summaries[0].status.error.details[0].message #=> String
resp.asset_model_summaries[0].version #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_model_types (Array<String>) —

    The type of asset model. If you don't provide an assetModelTypes, all types of asset models are returned.

    • ASSET_MODEL – An asset model that you can use to create assets. Can't be included as a component in another asset model.

    • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

    • INTERFACE – An interface is a type of model that defines a standard structure that can be applied to different asset models.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request.

    Default: 50

  • :asset_model_version (String) —

    The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.

Returns:



7754
7755
7756
7757
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7754

def list_asset_models(params = {}, options = {})
  req = build_request(:list_asset_models, params)
  req.send_request(options)
end

#list_asset_properties(params = {}) ⇒ Types::ListAssetPropertiesResponse

Retrieves a paginated list of properties associated with an asset. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_asset_properties({
  asset_id: "CustomID", # required
  next_token: "NextToken",
  max_results: 1,
  filter: "ALL", # accepts ALL, BASE
})

Response structure


resp.asset_property_summaries #=> Array
resp.asset_property_summaries[0].id #=> String
resp.asset_property_summaries[0].external_id #=> String
resp.asset_property_summaries[0].alias #=> String
resp.asset_property_summaries[0].unit #=> String
resp.asset_property_summaries[0].notification.topic #=> String
resp.asset_property_summaries[0].notification.state #=> String, one of "ENABLED", "DISABLED"
resp.asset_property_summaries[0].asset_composite_model_id #=> String
resp.asset_property_summaries[0].path #=> Array
resp.asset_property_summaries[0].path[0].id #=> String
resp.asset_property_summaries[0].path[0].name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_id (required, String) —

    The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request. If not specified, the default value is 50.

  • :filter (String) —

    Filters the requested list of asset properties. You can choose one of the following options:

    • ALL – The list includes all asset properties for a given asset model ID.

    • BASE – The list includes only base asset properties for a given asset model ID.

    Default: BASE

Returns:



7825
7826
7827
7828
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7825

def list_asset_properties(params = {}, options = {})
  req = build_request(:list_asset_properties, params)
  req.send_request(options)
end

#list_asset_relationships(params = {}) ⇒ Types::ListAssetRelationshipsResponse

Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_asset_relationships({
  asset_id: "CustomID", # required
  traversal_type: "PATH_TO_ROOT", # required, accepts PATH_TO_ROOT
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.asset_relationship_summaries #=> Array
resp.asset_relationship_summaries[0].hierarchy_info.parent_asset_id #=> String
resp.asset_relationship_summaries[0].hierarchy_info.child_asset_id #=> String
resp.asset_relationship_summaries[0].relationship_type #=> String, one of "HIERARCHY"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_id (required, String) —

    The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :traversal_type (required, String) —

    The type of traversal to use to identify asset relationships. Choose the following option:

    • PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result.

    ^

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request.

Returns:



7887
7888
7889
7890
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7887

def list_asset_relationships(params = {}, options = {})
  req = build_request(:list_asset_relationships, params)
  req.send_request(options)
end

#list_assets(params = {}) ⇒ Types::ListAssetsResponse

Retrieves a paginated list of asset summaries.

You can use this operation to do the following:

  • List assets based on a specific asset model.

  • List top-level assets.

You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_assets({
  next_token: "NextToken",
  max_results: 1,
  asset_model_id: "CustomID",
  filter: "ALL", # accepts ALL, TOP_LEVEL
})

Response structure


resp.asset_summaries #=> Array
resp.asset_summaries[0].id #=> String
resp.asset_summaries[0].external_id #=> String
resp.asset_summaries[0].arn #=> String
resp.asset_summaries[0].name #=> String
resp.asset_summaries[0].asset_model_id #=> String
resp.asset_summaries[0].creation_date #=> Time
resp.asset_summaries[0].last_update_date #=> Time
resp.asset_summaries[0].status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.asset_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.asset_summaries[0].status.error.message #=> String
resp.asset_summaries[0].status.error.details #=> Array
resp.asset_summaries[0].status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.asset_summaries[0].status.error.details[0].message #=> String
resp.asset_summaries[0].hierarchies #=> Array
resp.asset_summaries[0].hierarchies[0].id #=> String
resp.asset_summaries[0].hierarchies[0].external_id #=> String
resp.asset_summaries[0].hierarchies[0].name #=> String
resp.asset_summaries[0].description #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request.

    Default: 50

  • :asset_model_id (String) —

    The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :filter (String) —

    The filter for the requested list of assets. Choose one of the following options:

    • ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL.

    • TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

    Default: ALL

Returns:



7981
7982
7983
7984
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 7981

def list_assets(params = {}, options = {})
  req = build_request(:list_assets, params)
  req.send_request(options)
end

#list_associated_assets(params = {}) ⇒ Types::ListAssociatedAssetsResponse

Retrieves a paginated list of associated assets.

You can use this operation to do the following:

  • CHILD - List all child assets associated to the asset.

  • PARENT - List the asset's parent asset.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_associated_assets({
  asset_id: "CustomID", # required
  hierarchy_id: "CustomID",
  traversal_direction: "PARENT", # accepts PARENT, CHILD
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.asset_summaries #=> Array
resp.asset_summaries[0].id #=> String
resp.asset_summaries[0].external_id #=> String
resp.asset_summaries[0].arn #=> String
resp.asset_summaries[0].name #=> String
resp.asset_summaries[0].asset_model_id #=> String
resp.asset_summaries[0].creation_date #=> Time
resp.asset_summaries[0].last_update_date #=> Time
resp.asset_summaries[0].status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.asset_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.asset_summaries[0].status.error.message #=> String
resp.asset_summaries[0].status.error.details #=> Array
resp.asset_summaries[0].status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.asset_summaries[0].status.error.details[0].message #=> String
resp.asset_summaries[0].hierarchies #=> Array
resp.asset_summaries[0].hierarchies[0].id #=> String
resp.asset_summaries[0].hierarchies[0].external_id #=> String
resp.asset_summaries[0].hierarchies[0].name #=> String
resp.asset_summaries[0].description #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_id (required, String) —

    The ID of the asset to query. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :hierarchy_id (String) — default: Optional —

    If you don't provide a hierarchyId, all the immediate assets in the traversalDirection will be returned.

    The ID of the hierarchy by which child assets are associated to the asset. (This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.)

    For more information, see Asset hierarchies in the IoT SiteWise User Guide.

  • :traversal_direction (String) —

    The direction to list associated assets. Choose one of the following options:

    • CHILD – The list includes all child assets associated to the asset.

    • PARENT – The list includes the asset's parent asset.

    Default: CHILD

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request.

    Default: 50

Returns:



8083
8084
8085
8086
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8083

def list_associated_assets(params = {}, options = {})
  req = build_request(:list_associated_assets, params)
  req.send_request(options)
end

#list_bulk_import_jobs(params = {}) ⇒ Types::ListBulkImportJobsResponse

Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_bulk_import_jobs({
  next_token: "NextToken",
  max_results: 1,
  filter: "ALL", # accepts ALL, PENDING, RUNNING, CANCELLED, FAILED, COMPLETED_WITH_FAILURES, COMPLETED
  workspace_name: "WorkspaceName",
})

Response structure


resp.job_summaries #=> Array
resp.job_summaries[0].id #=> String
resp.job_summaries[0].name #=> String
resp.job_summaries[0].status #=> String, one of "PENDING", "CANCELLED", "RUNNING", "COMPLETED", "FAILED", "COMPLETED_WITH_FAILURES"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request.

  • :filter (String) —

    You can use a filter to select the bulk import jobs that you want to retrieve.

  • :workspace_name (String) —

    The name of the workspace.

Returns:



8135
8136
8137
8138
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8135

def list_bulk_import_jobs(params = {}, options = {})
  req = build_request(:list_bulk_import_jobs, params)
  req.send_request(options)
end

#list_composition_relationships(params = {}) ⇒ Types::ListCompositionRelationshipsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_composition_relationships({
  asset_model_id: "ID", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.composition_relationship_summaries #=> Array
resp.composition_relationship_summaries[0].asset_model_id #=> String
resp.composition_relationship_summaries[0].asset_model_composite_model_id #=> String
resp.composition_relationship_summaries[0].asset_model_composite_model_type #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_model_id (required, String) —

    The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request.

    Default: 50

Returns:



8186
8187
8188
8189
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8186

def list_composition_relationships(params = {}, options = {})
  req = build_request(:list_composition_relationships, params)
  req.send_request(options)
end

#list_computation_model_data_binding_usages(params = {}) ⇒ Types::ListComputationModelDataBindingUsagesResponse

Lists all data binding usages for computation models. This allows to identify where specific data bindings are being utilized across the computation models. This track dependencies between data sources and computation models.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_computation_model_data_binding_usages({
  data_binding_value_filter: { # required
    asset: {
      asset_id: "ID", # required
    },
    asset_model: {
      asset_model_id: "ID", # required
    },
    asset_property: {
      asset_id: "ID", # required
      property_id: "ID", # required
    },
    asset_model_property: {
      asset_model_id: "ID", # required
      property_id: "ID", # required
    },
  },
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.data_binding_usage_summaries #=> Array
resp.data_binding_usage_summaries[0].computation_model_ids #=> Array
resp.data_binding_usage_summaries[0].computation_model_ids[0] #=> String
resp.data_binding_usage_summaries[0].matched_data_binding.value.asset_model_property.asset_model_id #=> String
resp.data_binding_usage_summaries[0].matched_data_binding.value.asset_model_property.property_id #=> String
resp.data_binding_usage_summaries[0].matched_data_binding.value.asset_property.asset_id #=> String
resp.data_binding_usage_summaries[0].matched_data_binding.value.asset_property.property_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :data_binding_value_filter (required, Types::DataBindingValueFilter) —

    A filter used to limit the returned data binding usages based on specific data binding values. You can filter by asset, asset model, asset property, or asset model property to find all computation models using these specific data sources.

  • :next_token (String) —

    The token used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results returned for each paginated request.

Returns:



8251
8252
8253
8254
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8251

def list_computation_model_data_binding_usages(params = {}, options = {})
  req = build_request(:list_computation_model_data_binding_usages, params)
  req.send_request(options)
end

#list_computation_model_resolve_to_resources(params = {}) ⇒ Types::ListComputationModelResolveToResourcesResponse

Lists all distinct resources that are resolved from the executed actions of the computation model.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_computation_model_resolve_to_resources({
  computation_model_id: "ID", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.computation_model_resolve_to_resource_summaries #=> Array
resp.computation_model_resolve_to_resource_summaries[0].resolve_to.asset_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :computation_model_id (required, String) —

    The ID of the computation model for which to list resolved resources.

  • :next_token (String) —

    The token used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results returned for each paginated request.

Returns:



8291
8292
8293
8294
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8291

def list_computation_model_resolve_to_resources(params = {}, options = {})
  req = build_request(:list_computation_model_resolve_to_resources, params)
  req.send_request(options)
end

#list_computation_models(params = {}) ⇒ Types::ListComputationModelsResponse

Retrieves a paginated list of summaries of all computation models.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_computation_models({
  computation_model_type: "ANOMALY_DETECTION", # accepts ANOMALY_DETECTION
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.computation_model_summaries #=> Array
resp.computation_model_summaries[0].id #=> String
resp.computation_model_summaries[0].arn #=> String
resp.computation_model_summaries[0].name #=> String
resp.computation_model_summaries[0].description #=> String
resp.computation_model_summaries[0].type #=> String, one of "ANOMALY_DETECTION"
resp.computation_model_summaries[0].creation_date #=> Time
resp.computation_model_summaries[0].last_update_date #=> Time
resp.computation_model_summaries[0].status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.computation_model_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.computation_model_summaries[0].status.error.message #=> String
resp.computation_model_summaries[0].status.error.details #=> Array
resp.computation_model_summaries[0].status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.computation_model_summaries[0].status.error.details[0].message #=> String
resp.computation_model_summaries[0].version #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :computation_model_type (String) —

    The type of computation model. If a computationModelType is not provided, all types of computation models are returned.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request.

Returns:



8344
8345
8346
8347
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8344

def list_computation_models(params = {}, options = {})
  req = build_request(:list_computation_models, params)
  req.send_request(options)
end

#list_dashboards(params = {}) ⇒ Types::ListDashboardsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_dashboards({
  project_id: "ID", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.dashboard_summaries #=> Array
resp.dashboard_summaries[0].id #=> String
resp.dashboard_summaries[0].name #=> String
resp.dashboard_summaries[0].description #=> String
resp.dashboard_summaries[0].creation_date #=> Time
resp.dashboard_summaries[0].last_update_date #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :project_id (required, String) —

    The ID of the project.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request.

    Default: 50

Returns:



8390
8391
8392
8393
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8390

def list_dashboards(params = {}, options = {})
  req = build_request(:list_dashboards, params)
  req.send_request(options)
end

#list_dataset_data_segment_relationships(params = {}) ⇒ Types::ListDatasetDataSegmentRelationshipsResponse

Retrieves a paginated list of data segment relationships for a session dataset. Use this operation to find the curated datasets that reference data segments of the specified session dataset. Use the nextToken parameter to retrieve additional results.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_dataset_data_segment_relationships({
  dataset_id: "ID", # required
  workspace_name: "WorkspaceName", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.data_segment_relationship_summaries #=> Array
resp.data_segment_relationship_summaries[0].target_dataset_id #=> String
resp.data_segment_relationship_summaries[0].source_dataset_id #=> String
resp.data_segment_relationship_summaries[0].time_series_id #=> String
resp.data_segment_relationship_summaries[0].start_timestamp.time_in_seconds #=> Integer
resp.data_segment_relationship_summaries[0].start_timestamp.offset_in_nanos #=> Integer
resp.data_segment_relationship_summaries[0].end_timestamp.time_in_seconds #=> Integer
resp.data_segment_relationship_summaries[0].end_timestamp.offset_in_nanos #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dataset_id (required, String) —

    The ID of the session dataset to list data segment relationships for.

  • :workspace_name (required, String) —

    The name of the workspace that contains the dataset.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request. Default: 50.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

Returns:



8443
8444
8445
8446
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8443

def list_dataset_data_segment_relationships(params = {}, options = {})
  req = build_request(:list_dataset_data_segment_relationships, params)
  req.send_request(options)
end

#list_dataset_data_segments(params = {}) ⇒ Types::ListDatasetDataSegmentsResponse

Retrieves a paginated list of data segments associated with a dataset. Use the nextToken parameter to retrieve additional results.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_dataset_data_segments({
  dataset_id: "ID", # required
  workspace_name: "WorkspaceName", # required
  dataset_version: "Version",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.data_segments #=> Array
resp.data_segments[0].source_dataset_id #=> String
resp.data_segments[0].time_series_id #=> String
resp.data_segments[0].start_timestamp.time_in_seconds #=> Integer
resp.data_segments[0].start_timestamp.offset_in_nanos #=> Integer
resp.data_segments[0].end_timestamp.time_in_seconds #=> Integer
resp.data_segments[0].end_timestamp.offset_in_nanos #=> Integer
resp.data_segments[0].alias #=> String
resp.data_segments[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT", "VIDEO", "ANNOTATION", "JSON"
resp.data_segments[0].enrichment.status #=> String, one of "ENRICHED", "NOT_ENRICHED"
resp.data_segments[0].enrichment.last_enriched_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dataset_id (required, String) —

    The ID of the dataset.

  • :workspace_name (required, String) —

    The name of the workspace that contains the dataset.

  • :dataset_version (String) —

    The version of the dataset to list data segments for.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request. Default: 50.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

Returns:



8501
8502
8503
8504
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8501

def list_dataset_data_segments(params = {}, options = {})
  req = build_request(:list_dataset_data_segments, params)
  req.send_request(options)
end

#list_dataset_export_jobs(params = {}) ⇒ Types::ListDatasetExportJobsResponse

Retrieves a paginated list of dataset export jobs for a workspace.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_dataset_export_jobs({
  workspace_name: "WorkspaceName", # required
  filter: "ALL", # accepts ALL, SUBMITTED, RUNNING, COMPLETED, COMPLETED_WITH_ERRORS, FAILED
  max_results: 1,
  next_token: "ListExportJobsNextToken",
})

Response structure


resp.jobs #=> Array
resp.jobs[0].job_id #=> String
resp.jobs[0].status #=> String, one of "SUBMITTED", "RUNNING", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED"
resp.jobs[0].started_at #=> Time
resp.jobs[0].completed_at #=> Time
resp.jobs[0].destination_s3_uri #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace whose dataset export jobs should be listed.

  • :filter (String) —

    The optional filter that returns only jobs matching the given filter value. Defaults to ALL.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

Returns:



8549
8550
8551
8552
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8549

def list_dataset_export_jobs(params = {}, options = {})
  req = build_request(:list_dataset_export_jobs, params)
  req.send_request(options)
end

#list_datasets(params = {}) ⇒ Types::ListDatasetsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_datasets({
  source_type: "KENDRA", # required, accepts KENDRA, SITEWISE
  workspace_name: "WorkspaceName",
  dataset_type: "SESSION", # accepts SESSION, CURATED, EXTERNAL
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.dataset_summaries #=> Array
resp.dataset_summaries[0].id #=> String
resp.dataset_summaries[0].arn #=> String
resp.dataset_summaries[0].name #=> String
resp.dataset_summaries[0].description #=> String
resp.dataset_summaries[0].source_type #=> String, one of "KENDRA", "SITEWISE"
resp.dataset_summaries[0].dataset_type #=> String, one of "SESSION", "CURATED", "EXTERNAL"
resp.dataset_summaries[0].creation_date #=> Time
resp.dataset_summaries[0].last_update_date #=> Time
resp.dataset_summaries[0].status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.dataset_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.dataset_summaries[0].status.error.message #=> String
resp.dataset_summaries[0].status.error.details #=> Array
resp.dataset_summaries[0].status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.dataset_summaries[0].status.error.details[0].message #=> String
resp.dataset_summaries[0].enrichment_status.video.status #=> String, one of "FULLY_ENRICHED", "PARTIALLY_ENRICHED", "NOT_ENRICHED"
resp.dataset_summaries[0].enrichment_status.video.last_enriched_at #=> Time
resp.next_token #=> String
resp.workspace_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_type (required, String) —

    The type of data source for the dataset.

  • :workspace_name (String) —

    The name of the workspace to filter datasets by.

  • :dataset_type (String) —

    The type of dataset to filter by: a session dataset, a curated dataset, or a connection to an external datasource.

  • :next_token (String) —

    The token for the next set of results, or null if there are no additional results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request.

Returns:



8615
8616
8617
8618
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8615

def list_datasets(params = {}, options = {})
  req = build_request(:list_datasets, params)
  req.send_request(options)
end

#list_enrichment_jobs(params = {}) ⇒ Types::ListEnrichmentJobsResponse

Lists enrichment jobs within a workspace with optional filtering and pagination. Results are ordered by createdAt timestamp descending (newest first).

Filtering

Combine filters to narrow results:

  • datasetId: Filter by dataset
  • propertyAlias OR timeSeriesId: Filter by time series (specify one, not both)
  • status: Filter by job status (e.g., RUNNING to find active jobs)
  • jobType: Filter by enrichment type (currently only EVENT_DETECTION)
  • startDate and endDate: Filter by job creation time range

Important Constraints

  • You must specify either propertyAlias OR timeSeriesId, but not both
  • Attempting to specify both results in an InvalidRequestException
  • Date filters use ISO 8601 format
  • startDate is exclusive, endDate is inclusive

Pagination

The operation returns up to maxResults jobs per page (default 50). If more results exist, the response includes a nextToken. Submit this token in a subsequent request to retrieve the next page.

Common Use Cases

  • Find all running jobs: Filter by status=RUNNING
  • List recent jobs for a dataset: Filter by datasetId with optional date range
  • Monitor jobs for a specific sensor: Filter by propertyAlias or timeSeriesId
  • Track all event detection jobs: Filter by jobType=EVENT_DETECTION

Performance

Performance is optimal when filtering by supported fields (datasetId, propertyAlias, timeSeriesId, status, jobType).

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_enrichment_jobs({
  workspace_name: "WorkspaceName", # required
  dataset_id: "ID",
  property_alias: "AssetPropertyAlias",
  time_series_id: "TimeSeriesId",
  status: "PENDING", # accepts PENDING, RUNNING, COMPLETED, FAILED, TIMED_OUT, CANCELLED
  job_type: "EVENT_DETECTION", # accepts EVENT_DETECTION
  start_date: Time.now,
  end_date: Time.now,
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.jobs #=> Array
resp.jobs[0].job_id #=> String
resp.jobs[0].status #=> String, one of "PENDING", "RUNNING", "COMPLETED", "FAILED", "TIMED_OUT", "CANCELLED"
resp.jobs[0].workspace_name #=> String
resp.jobs[0].job_type #=> String, one of "EVENT_DETECTION"
resp.jobs[0].dataset_id #=> String
resp.jobs[0].property_alias #=> String
resp.jobs[0].time_series_id #=> String
resp.jobs[0].created_at #=> Time
resp.jobs[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the IoT SiteWise workspace to list enrichment jobs from.

  • :dataset_id (String) —

    Filter jobs by dataset ID. Returns only jobs analyzing data from the specified dataset.

  • :property_alias (String) —

    Filter by property alias (human-readable sensor name). Specify either propertyAlias or timeSeriesId, but not both. Returns only jobs analyzing the specified property alias.

  • :time_series_id (String) —

    Filter by time series ID (system identifier). Specify either timeSeriesId or propertyAlias, but not both. Returns only jobs analyzing the specified time series.

  • :status (String) —

    Filter by job status. Returns only jobs in the specified status. Use RUNNING to find active jobs, or FAILED to identify jobs requiring attention.

  • :job_type (String) —

    Filter by enrichment job type. Currently only EVENT_DETECTION is supported. Use this filter to future-proof queries when additional job types are added.

  • :start_date (Time, DateTime, Date, Integer, String) —

    The exclusive start of the date range for filtering jobs by creation time. Jobs created after this timestamp are included. Use ISO 8601 format (e.g., 2024-01-01T00:00:00Z).

  • :end_date (Time, DateTime, Date, Integer, String) —

    The inclusive end of the date range for filtering jobs by creation time. Jobs created on or before this timestamp are included. Use ISO 8601 format (e.g., 2024-01-31T23:59:59Z).

  • :max_results (Integer) —

    Maximum number of jobs to return per page. Defaults to 50 if not specified. Use smaller values for faster responses, larger values to reduce API calls.

  • :next_token (String) —

    Pagination token from a previous ListEnrichmentJobs response. Include this token to retrieve the next page of results. Omit for the first request.

Returns:



8748
8749
8750
8751
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8748

def list_enrichment_jobs(params = {}, options = {})
  req = build_request(:list_enrichment_jobs, params)
  req.send_request(options)
end

#list_executions(params = {}) ⇒ Types::ListExecutionsResponse

Retrieves a paginated list of summaries of all executions.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_executions({
  target_resource_type: "ASSET", # required, accepts ASSET, COMPUTATION_MODEL
  target_resource_id: "ID", # required
  resolve_to_resource_type: "ASSET", # accepts ASSET
  resolve_to_resource_id: "ID",
  next_token: "NextToken",
  max_results: 1,
  action_type: "Name",
})

Response structure


resp.execution_summaries #=> Array
resp.execution_summaries[0].execution_id #=> String
resp.execution_summaries[0].action_type #=> String
resp.execution_summaries[0].target_resource.asset_id #=> String
resp.execution_summaries[0].target_resource.computation_model_id #=> String
resp.execution_summaries[0].target_resource_version #=> String
resp.execution_summaries[0].resolve_to.asset_id #=> String
resp.execution_summaries[0].execution_start_time #=> Time
resp.execution_summaries[0].execution_end_time #=> Time
resp.execution_summaries[0].execution_status.state #=> String, one of "RUNNING", "COMPLETED", "FAILED"
resp.execution_summaries[0].execution_entity_version #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :target_resource_type (required, String) —

    The type of the target resource.

  • :target_resource_id (required, String) —

    The ID of the target resource.

  • :resolve_to_resource_type (String) —

    The type of the resolved resource.

  • :resolve_to_resource_id (String) —

    The ID of the resolved resource.

  • :next_token (String) —

    The token used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results returned for each paginated request.

  • :action_type (String) —

    The type of action exectued.

Returns:



8812
8813
8814
8815
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8812

def list_executions(params = {}, options = {})
  req = build_request(:list_executions, params)
  req.send_request(options)
end

#list_gateways(params = {}) ⇒ Types::ListGatewaysResponse

Retrieves a paginated list of gateways.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_gateways({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.gateway_summaries #=> Array
resp.gateway_summaries[0].gateway_id #=> String
resp.gateway_summaries[0].gateway_name #=> String
resp.gateway_summaries[0].gateway_platform.greengrass.group_arn #=> String
resp.gateway_summaries[0].gateway_platform.greengrass_v2.core_device_thing_name #=> String
resp.gateway_summaries[0].gateway_platform.greengrass_v2.core_device_operating_system #=> String, one of "LINUX_AARCH64", "LINUX_AMD64", "WINDOWS_AMD64"
resp.gateway_summaries[0].gateway_platform.siemens_ie.iot_core_thing_name #=> String
resp.gateway_summaries[0].gateway_version #=> String
resp.gateway_summaries[0].gateway_capability_summaries #=> Array
resp.gateway_summaries[0].gateway_capability_summaries[0].capability_namespace #=> String
resp.gateway_summaries[0].gateway_capability_summaries[0].capability_sync_status #=> String, one of "IN_SYNC", "OUT_OF_SYNC", "SYNC_FAILED", "UNKNOWN", "NOT_APPLICABLE"
resp.gateway_summaries[0].creation_date #=> Time
resp.gateway_summaries[0].last_update_date #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request.

    Default: 50

Returns:



8860
8861
8862
8863
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8860

def list_gateways(params = {}, options = {})
  req = build_request(:list_gateways, params)
  req.send_request(options)
end

#list_interface_relationships(params = {}) ⇒ Types::ListInterfaceRelationshipsResponse

Retrieves a paginated list of asset models that have a specific interface asset model applied to them.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_interface_relationships({
  interface_asset_model_id: "CustomID", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.interface_relationship_summaries #=> Array
resp.interface_relationship_summaries[0].id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :interface_asset_model_id (required, String) —

    The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request. Default: 50

Returns:



8902
8903
8904
8905
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8902

def list_interface_relationships(params = {}, options = {})
  req = build_request(:list_interface_relationships, params)
  req.send_request(options)
end

#list_pipeline_executions(params = {}) ⇒ Types::ListPipelineExecutionsResponse

Lists pipeline executions for a specific pipeline in a workspace. Supports filtering by state and time range. State can be combined with either startTime or endTime filters. Time range filters are grouped: use startTime filters (startTimeAfter, startTimeBefore) or endTime filters (endTimeAfter, endTimeBefore), but not both. Combining startTime and endTime filters returns an InvalidRequestException. Note: endTime filters only return executions in terminal states, as in-progress executions have no endTime.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_pipeline_executions({
  workspace_name: "WorkspaceName", # required
  pipeline_name: "ResourceName", # required
  next_token: "PaginationToken",
  max_results: 1,
  state: "NOT_STARTED", # accepts NOT_STARTED, RUNNING, SUCCEEDED, FAILED, CANCELLING, CANCELLED
  start_time_after: Time.now,
  start_time_before: Time.now,
  end_time_after: Time.now,
  end_time_before: Time.now,
})

Response structure


resp.pipeline_execution_summaries #=> Array
resp.pipeline_execution_summaries[0].pipeline_execution_id #=> String
resp.pipeline_execution_summaries[0].pipeline_version #=> String
resp.pipeline_execution_summaries[0].status.state #=> String, one of "NOT_STARTED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLING", "CANCELLED"
resp.pipeline_execution_summaries[0].status.state_details.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "EXECUTION_ERROR", "TIMED_OUT"
resp.pipeline_execution_summaries[0].status.state_details.message #=> String
resp.pipeline_execution_summaries[0].status.state_details.details #=> Array
resp.pipeline_execution_summaries[0].status.state_details.details[0].code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "EXECUTION_ERROR", "TIMED_OUT"
resp.pipeline_execution_summaries[0].status.state_details.details[0].message #=> String
resp.pipeline_execution_summaries[0].execution_priority #=> Integer
resp.pipeline_execution_summaries[0].start_time #=> Time
resp.pipeline_execution_summaries[0].end_time #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace.

  • :pipeline_name (required, String) —

    The name of the pipeline.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return per request. This is an upper bound; the actual number of results may be less. Default: 50.

  • :state (String) —

    Filter by execution state. If not specified, executions in all states are returned.

  • :start_time_after (Time, DateTime, Date, Integer, String) —

    Inclusive lower bound on execution start time (ISO-8601). Only executions with startTime >= startTimeAfter are returned. Cannot be combined with endTimeAfter or endTimeBefore.

  • :start_time_before (Time, DateTime, Date, Integer, String) —

    Exclusive upper bound on execution start time (ISO-8601). Only executions with startTime < startTimeBefore are returned. Cannot be combined with endTimeAfter or endTimeBefore.

  • :end_time_after (Time, DateTime, Date, Integer, String) —

    Inclusive lower bound on execution end time (ISO-8601). Only executions with endTime >= endTimeAfter are returned. Cannot be combined with startTimeAfter or startTimeBefore. Only matches executions in terminal states.

  • :end_time_before (Time, DateTime, Date, Integer, String) —

    Exclusive upper bound on execution end time (ISO-8601). Only executions with endTime < endTimeBefore are returned. Cannot be combined with startTimeAfter or startTimeBefore. Only matches executions in terminal states.

Returns:



8994
8995
8996
8997
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 8994

def list_pipeline_executions(params = {}, options = {})
  req = build_request(:list_pipeline_executions, params)
  req.send_request(options)
end

#list_pipelines(params = {}) ⇒ Types::ListPipelinesResponse

Lists pipelines in a workspace. To get complete details about a pipeline, use DescribePipeline.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_pipelines({
  workspace_name: "WorkspaceName", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.pipeline_summaries #=> Array
resp.pipeline_summaries[0].pipeline_name #=> String
resp.pipeline_summaries[0].description #=> String
resp.pipeline_summaries[0].pipeline_arn #=> String
resp.pipeline_summaries[0].version #=> String
resp.pipeline_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.pipeline_summaries[0].status.error.message #=> String
resp.pipeline_summaries[0].status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.pipeline_summaries[0].created_at #=> Time
resp.pipeline_summaries[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request. Default: 50.

Returns:



9047
9048
9049
9050
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9047

def list_pipelines(params = {}, options = {})
  req = build_request(:list_pipelines, params)
  req.send_request(options)
end

#list_portals(params = {}) ⇒ Types::ListPortalsResponse

Retrieves a paginated list of IoT SiteWise Monitor portals.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_portals({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.portal_summaries #=> Array
resp.portal_summaries[0].id #=> String
resp.portal_summaries[0].name #=> String
resp.portal_summaries[0].description #=> String
resp.portal_summaries[0].start_url #=> String
resp.portal_summaries[0].creation_date #=> Time
resp.portal_summaries[0].last_update_date #=> Time
resp.portal_summaries[0].role_arn #=> String
resp.portal_summaries[0].status.state #=> String, one of "CREATING", "PENDING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
resp.portal_summaries[0].status.error.code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "LIMIT_EXCEEDED"
resp.portal_summaries[0].status.error.message #=> String
resp.portal_summaries[0].portal_type #=> String, one of "SITEWISE_PORTAL_V1", "SITEWISE_PORTAL_V2"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request.

    Default: 50

Returns:



9094
9095
9096
9097
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9094

def list_portals(params = {}, options = {})
  req = build_request(:list_portals, params)
  req.send_request(options)
end

#list_project_assets(params = {}) ⇒ Types::ListProjectAssetsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_project_assets({
  project_id: "ID", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.asset_ids #=> Array
resp.asset_ids[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :project_id (required, String) —

    The ID of the project.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request.

    Default: 50

Returns:



9136
9137
9138
9139
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9136

def list_project_assets(params = {}, options = {})
  req = build_request(:list_project_assets, params)
  req.send_request(options)
end

#list_projects(params = {}) ⇒ Types::ListProjectsResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_projects({
  portal_id: "ID", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.project_summaries #=> Array
resp.project_summaries[0].id #=> String
resp.project_summaries[0].name #=> String
resp.project_summaries[0].description #=> String
resp.project_summaries[0].creation_date #=> Time
resp.project_summaries[0].last_update_date #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :portal_id (required, String) —

    The ID of the portal.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request.

    Default: 50

Returns:



9182
9183
9184
9185
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9182

def list_projects(params = {}, options = {})
  req = build_request(:list_projects, params)
  req.send_request(options)
end

#list_queries(params = {}) ⇒ Types::ListQueriesResponse

Retrieves a paginated list of queries for a workspace.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_queries({
  workspace_name: "WorkspaceName", # required
  filter: "QueryFilter",
  max_results: 1,
  next_token: "QueryListNextToken",
})

Response structure


resp.queries #=> Array
resp.queries[0].query_id #=> String
resp.queries[0].status #=> String, one of "SUBMITTED", "RUNNING", "COMPLETED", "FAILED", "CANCELED", "CANCELING"
resp.queries[0].submitted_at #=> Time
resp.queries[0].completed_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace to list queries for.

  • :filter (String) —

    An optional filter to return only queries with the specified status. The value must be one of the supported query statuses: SUBMITTED, RUNNING, COMPLETED, FAILED, CANCELED, or CANCELING.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

Returns:



9230
9231
9232
9233
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9230

def list_queries(params = {}, options = {})
  req = build_request(:list_queries, params)
  req.send_request(options)
end

#list_searches(params = {}) ⇒ Types::ListSearchesResponse

Lists the searches in a workspace, most recently started first. Results can be narrowed with optional filters (status, search type, group, and started-at time range) and are paginated: when nextToken is present, pass it on a subsequent call to retrieve the next page.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_searches({
  workspace_name: "WorkspaceName", # required
  max_results: 1,
  next_token: "NextToken",
  list_searches_filters: {
    status_filter: ["QUEUED"], # accepts QUEUED, RUNNING, SUCCEEDED, FAILED
    started_after: Time.now,
    started_before: Time.now,
    group_id_filter: ["GroupId"],
    search_type_filter: ["DEEP"], # accepts DEEP, QUICK
  },
})

Response structure


resp.search_summaries #=> Array
resp.search_summaries[0].search_id #=> String
resp.search_summaries[0].workspace_name #=> String
resp.search_summaries[0].status #=> String, one of "QUEUED", "RUNNING", "SUCCEEDED", "FAILED"
resp.search_summaries[0].query_statement #=> String
resp.search_summaries[0].search_type #=> String, one of "DEEP", "QUICK"
resp.search_summaries[0].status_reason #=> String
resp.search_summaries[0].started_at #=> Time
resp.search_summaries[0].group_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace whose searches are listed.

  • :max_results (Integer) —

    The maximum number of searches to return in a single page. Valid range is 1 to 1,000; if omitted, a service-defined default is used.

  • :next_token (String) —

    The pagination token returned by a previous ListSearches call. Provide it to retrieve the next page; omit it to retrieve the first page.

  • :list_searches_filters (Types::ListSearchesFilters) —

    Optional filters that restrict which searches are returned.

Returns:



9291
9292
9293
9294
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9291

def list_searches(params = {}, options = {})
  req = build_request(:list_searches, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Retrieves the list of tags for an IoT SiteWise resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AmazonResourceName", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource.

Returns:



9322
9323
9324
9325
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9322

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_tasks(params = {}) ⇒ Types::ListTasksResponse

Lists tasks in a workspace. To get complete details about a task, use DescribeTask.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_tasks({
  workspace_name: "WorkspaceName", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.task_summaries #=> Array
resp.task_summaries[0].task_name #=> String
resp.task_summaries[0].description #=> String
resp.task_summaries[0].task_arn #=> String
resp.task_summaries[0].version #=> String
resp.task_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.task_summaries[0].status.error.message #=> String
resp.task_summaries[0].status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.task_summaries[0].created_at #=> Time
resp.task_summaries[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace.

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request. Default: 50.

Returns:



9375
9376
9377
9378
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9375

def list_tasks(params = {}, options = {})
  req = build_request(:list_tasks, params)
  req.send_request(options)
end

#list_time_series(params = {}) ⇒ Types::ListTimeSeriesResponse

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_time_series({
  next_token: "NextToken",
  max_results: 1,
  asset_id: "CustomID",
  alias_prefix: "PropertyAlias",
  time_series_type: "ASSOCIATED", # accepts ASSOCIATED, DISASSOCIATED
  workspace_name: "WorkspaceName",
})

Response structure


resp.time_series_summaries #=> Array
resp.time_series_summaries[0].asset_id #=> String
resp.time_series_summaries[0].property_id #=> String
resp.time_series_summaries[0].alias #=> String
resp.time_series_summaries[0].time_series_id #=> String
resp.time_series_summaries[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT", "VIDEO", "ANNOTATION", "JSON"
resp.time_series_summaries[0].data_type_spec #=> String
resp.time_series_summaries[0].time_series_creation_date #=> Time
resp.time_series_summaries[0].time_series_last_update_date #=> Time
resp.time_series_summaries[0].time_series_arn #=> String
resp.next_token #=> String
resp.workspace_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request.

  • :asset_id (String) —

    The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :alias_prefix (String) —

    The alias prefix of the time series.

  • :time_series_type (String) —

    The type of the time series. The time series type can be one of the following values:

    • ASSOCIATED – The time series is associated with an asset property.

    • DISASSOCIATED – The time series isn't associated with any asset property.

  • :workspace_name (String) —

    The name of the workspace.

Returns:



9450
9451
9452
9453
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9450

def list_time_series(params = {}, options = {})
  req = build_request(:list_time_series, params)
  req.send_request(options)
end

#list_workspaces(params = {}) ⇒ Types::ListWorkspacesResponse

Retrieves a paginated list of workspaces. Use the nextToken parameter to retrieve additional results.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_workspaces({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.workspace_summaries #=> Array
resp.workspace_summaries[0].name #=> String
resp.workspace_summaries[0].arn #=> String
resp.workspace_summaries[0].status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.workspace_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.workspace_summaries[0].status.error.message #=> String
resp.workspace_summaries[0].created_at #=> Time
resp.workspace_summaries[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token to be used for the next set of paginated results.

  • :max_results (Integer) —

    The maximum number of results to return for each paginated request. Default: 50.

Returns:



9493
9494
9495
9496
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9493

def list_workspaces(params = {}, options = {})
  req = build_request(:list_workspaces, params)
  req.send_request(options)
end

#put_asset_model_interface_relationship(params = {}) ⇒ Types::PutAssetModelInterfaceRelationshipResponse

Creates or updates an interface relationship between an asset model and an interface asset model. This operation applies an interface to an asset model.

Examples:

Request syntax with placeholder values


resp = client.put_asset_model_interface_relationship({
  asset_model_id: "CustomID", # required
  interface_asset_model_id: "CustomID", # required
  property_mapping_configuration: { # required
    match_by_property_name: false,
    create_missing_property: false,
    overrides: [
      {
        asset_model_property_id: "CustomID", # required
        interface_asset_model_property_id: "CustomID", # required
      },
    ],
  },
  client_token: "ClientToken",
})

Response structure


resp.asset_model_id #=> String
resp.interface_asset_model_id #=> String
resp.asset_model_arn #=> String
resp.asset_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED"
resp.asset_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.asset_model_status.error.message #=> String
resp.asset_model_status.error.details #=> Array
resp.asset_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.asset_model_status.error.details[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_model_id (required, String) —

    The ID of the asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.

  • :interface_asset_model_id (required, String) —

    The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.

  • :property_mapping_configuration (required, Types::PropertyMappingConfiguration) —

    The configuration for mapping properties from the interface asset model to the asset model where the interface is applied. This configuration controls how properties are matched and created during the interface application process.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



9563
9564
9565
9566
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9563

def put_asset_model_interface_relationship(params = {}, options = {})
  req = build_request(:put_asset_model_interface_relationship, params)
  req.send_request(options)
end

#put_default_encryption_configuration(params = {}) ⇒ Types::PutDefaultEncryptionConfigurationResponse

Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide.

Examples:

Request syntax with placeholder values


resp = client.put_default_encryption_configuration({
  encryption_type: "SITEWISE_DEFAULT_ENCRYPTION", # required, accepts SITEWISE_DEFAULT_ENCRYPTION, KMS_BASED_ENCRYPTION
  kms_key_id: "KmsKeyId",
})

Response structure


resp.encryption_type #=> String, one of "SITEWISE_DEFAULT_ENCRYPTION", "KMS_BASED_ENCRYPTION"
resp.kms_key_arn #=> String
resp.configuration_status.state #=> String, one of "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
resp.configuration_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.configuration_status.error.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :encryption_type (required, String) —

    The type of encryption used for the encryption configuration.

  • :kms_key_id (String) —

    The Key ID of the customer managed key used for KMS encryption. This is required if you use KMS_BASED_ENCRYPTION.

Returns:



9606
9607
9608
9609
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9606

def put_default_encryption_configuration(params = {}, options = {})
  req = build_request(:put_default_encryption_configuration, params)
  req.send_request(options)
end

#put_logging_options(params = {}) ⇒ Struct

Sets logging options for IoT SiteWise.

Examples:

Request syntax with placeholder values


resp = client.put_logging_options({
  logging_options: { # required
    level: "ERROR", # required, accepts ERROR, INFO, OFF
  },
  workspace_name: "WorkspaceName",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :logging_options (required, Types::LoggingOptions) —

    The logging options to set.

  • :workspace_name (String) —

    The name of the workspace.

Returns:

  • (Struct) —

    Returns an empty response.



9632
9633
9634
9635
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9632

def put_logging_options(params = {}, options = {})
  req = build_request(:put_logging_options, params)
  req.send_request(options)
end

#put_storage_configuration(params = {}) ⇒ Types::PutStorageConfigurationResponse

Configures storage settings for IoT SiteWise.

Examples:

Request syntax with placeholder values


resp = client.put_storage_configuration({
  storage_type: "SITEWISE_DEFAULT_STORAGE", # required, accepts SITEWISE_DEFAULT_STORAGE, MULTI_LAYER_STORAGE
  multi_layer_storage: {
    customer_managed_s3_storage: { # required
      s3_resource_arn: "ARN", # required
      role_arn: "ARN", # required
    },
  },
  disassociated_data_storage: "ENABLED", # accepts ENABLED, DISABLED
  retention_period: {
    number_of_days: 1,
    unlimited: false,
  },
  warm_tier: "ENABLED", # accepts ENABLED, DISABLED
  warm_tier_retention_period: {
    number_of_days: 1,
    unlimited: false,
  },
  disallow_ingest_null_na_n: false,
})

Response structure


resp.storage_type #=> String, one of "SITEWISE_DEFAULT_STORAGE", "MULTI_LAYER_STORAGE"
resp.multi_layer_storage.customer_managed_s3_storage.s3_resource_arn #=> String
resp.multi_layer_storage.customer_managed_s3_storage.role_arn #=> String
resp.disassociated_data_storage #=> String, one of "ENABLED", "DISABLED"
resp.retention_period.number_of_days #=> Integer
resp.retention_period.unlimited #=> Boolean
resp.configuration_status.state #=> String, one of "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
resp.configuration_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.configuration_status.error.message #=> String
resp.warm_tier #=> String, one of "ENABLED", "DISABLED"
resp.warm_tier_retention_period.number_of_days #=> Integer
resp.warm_tier_retention_period.unlimited #=> Boolean
resp.disallow_ingest_null_na_n #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :storage_type (required, String) —

    The storage tier that you specified for your data. The storageType parameter can be one of the following values:

    • SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.

    • MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.

  • :multi_layer_storage (Types::MultiLayerStorage) —

    Identifies a storage destination. If you specified MULTI_LAYER_STORAGE for the storage type, you must specify a MultiLayerStorage object.

  • :disassociated_data_storage (String) —

    Contains the storage configuration for time series (data streams) that aren't associated with asset properties. The disassociatedDataStorage can be one of the following values:

    • ENABLED – IoT SiteWise accepts time series that aren't associated with asset properties.

      After the disassociatedDataStorage is enabled, you can't disable it.

    • DISABLED – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.

    For more information, see Data streams in the IoT SiteWise User Guide.

  • :retention_period (Types::RetentionPeriod) —

    The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.

  • :warm_tier (String) —

    A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.

  • :warm_tier_retention_period (Types::WarmTierRetentionPeriod) —

    Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.

  • :disallow_ingest_null_na_n (Boolean) —

    Describes the configuration for ingesting NULL and NaN data. By default the feature is allowed. The feature is disallowed if the value is true.

Returns:



9747
9748
9749
9750
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9747

def put_storage_configuration(params = {}, options = {})
  req = build_request(:put_storage_configuration, params)
  req.send_request(options)
end

#start_pipeline_execution(params = {}) ⇒ Types::StartPipelineExecutionResponse

Starts execution of a pipeline in the specified workspace. Each compute node runs according to the DAG dependency order defined in the pipeline. Nodes without dependencies start immediately, while dependent nodes wait for all upstream nodes to complete successfully.

You can provide runtime environment variable overrides that take the highest priority in the environment variable hierarchy, without modifying the pipeline definition.

Examples:

Request syntax with placeholder values


resp = client.start_pipeline_execution({
  workspace_name: "WorkspaceName", # required
  pipeline_name: "ResourceName", # required
  execution_environment_variable_overrides: {
    global: {
      "EnvironmentVariableName" => "EnvironmentVariableValue",
    },
    compute_nodes: {
      "ResourceName" => {
        "EnvironmentVariableName" => "EnvironmentVariableValue",
      },
    },
  },
  execution_mount_overrides: {
    compute_nodes: { # required
      "ResourceName" => [
        {
          name: "ResourceName", # required
          relative_path: "MountRelativePath", # required
          source: { # required
            s3_access_point: {
              access_point_arn: "MountS3AccessPointArn", # required
              prefix: "MountS3KeyPrefix",
            },
          },
          storage_type: "SHARED_STORAGE", # required, accepts SHARED_STORAGE
        },
      ],
    },
  },
  execution_priority: 1,
  client_token: "ClientToken",
})

Response structure


resp.pipeline_execution_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace containing the pipeline.

  • :pipeline_name (required, String) —

    The name of the pipeline to execute.

  • :execution_environment_variable_overrides (Types::ExecutionEnvironmentVariables) —

    Runtime environment variable overrides for the execution. Includes global variables that apply to all compute nodes and computeNodes for per-node overrides. These take the highest priority in the environment variable hierarchy.

  • :execution_mount_overrides (Types::MountOverrides) —

    Runtime mount overrides for the execution. Overrides are merged by mount name into each listed compute node's task-defined mounts: a matching name replaces the task-defined mount, a new name adds a mount, and task-defined mounts not referenced remain unchanged. Compute nodes not listed use their task-defined mounts as-is.

  • :execution_priority (Integer) —

    Scheduling priority for the execution. Lower values indicate higher priority. Defaults to 2 when not specified.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token, the server returns the cached result from the original successful request without performing the operation again.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



9840
9841
9842
9843
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9840

def start_pipeline_execution(params = {}, options = {})
  req = build_request(:start_pipeline_execution, params)
  req.send_request(options)
end

#start_query(params = {}) ⇒ Types::StartQueryResponse

Starts an asynchronous SQL query against workspace telemetry, annotations, data segment, and dataset data.

Examples:

Request syntax with placeholder values


resp = client.start_query({
  client_token: "ClientToken",
  workspace_name: "WorkspaceName", # required
  query_statement: "QueryString", # required
})

Response structure


resp.query_id #=> String
resp.status #=> String, one of "SUBMITTED", "RUNNING", "COMPLETED", "FAILED", "CANCELED", "CANCELING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :workspace_name (required, String) —

    The name of the workspace to query.

  • :query_statement (required, String) —

    The SQL query to execute against the workspace telemetry, annotations, data segment, and dataset data.

Returns:



9883
9884
9885
9886
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9883

def start_query(params = {}, options = {})
  req = build_request(:start_query, params)
  req.send_request(options)
end

#start_search(params = {}) ⇒ Types::StartSearchResponse

Starts an asynchronous search over the data in a workspace. The search runs in the background; the response returns immediately with a searchId and an initial status of QUEUED. Use DescribeSearch to poll for completion and GetSearchResults to retrieve the results once the search reaches SUCCEEDED. The request is idempotent on clientToken: repeating a call with the same token returns the original search instead of starting a new one.

Examples:

Request syntax with placeholder values


resp = client.start_search({
  workspace_name: "WorkspaceName", # required
  query_statement: "SearchQueryStatement", # required
  client_token: "ClientToken",
  search_type: "DEEP", # accepts DEEP, QUICK
  search_filters: {
    time_series_ids: ["TimeSeriesId"],
    dataset_ids: ["DatasetId"],
    time_intervals: [
      {
        start_time: { # required
          time_in_seconds: 1, # required
          offset_in_nanos: 1,
        },
        end_time: { # required
          time_in_seconds: 1, # required
          offset_in_nanos: 1,
        },
      },
    ],
  },
  group_id: "GroupId",
})

Response structure


resp.search_id #=> String
resp.workspace_name #=> String
resp.status #=> String, one of "QUEUED", "RUNNING", "SUCCEEDED", "FAILED"
resp.group_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace whose data is searched.

  • :query_statement (required, String) —

    The natural-language query describing the data to search for.

  • :client_token (String) —

    A unique, case-sensitive identifier you provide to ensure the request is idempotent. Repeating a StartSearch call with the same clientToken returns the original search rather than starting a new one. If omitted, the SDK autogenerates one.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :search_type (String) —

    The search strategy to use. Defaults to QUICK when omitted.

  • :search_filters (Types::SearchFilters) —

    Optional filters that restrict the search to a subset of the workspace's data.

  • :group_id (String) —

    An optional caller-supplied identifier used to group related searches together.

Returns:



9964
9965
9966
9967
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 9964

def start_search(params = {}, options = {})
  req = build_request(:start_search, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource to tag.

  • :tags (required, Hash<String,String>) —

    A list of key-value pairs that contain metadata for the resource. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

Returns:

  • (Struct) —

    Returns an empty response.



10001
10002
10003
10004
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 10001

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes a tag from an IoT SiteWise resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AmazonResourceName", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource to untag.

  • :tag_keys (required, Array<String>) —

    A list of keys for tags to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.



10029
10030
10031
10032
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 10029

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_access_policy(params = {}) ⇒ Struct

The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

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

Examples:

Request syntax with placeholder values


resp = client.update_access_policy({
  access_policy_id: "ID", # required
  access_policy_identity: { # required
    user: {
      id: "IdentityId", # required
    },
    group: {
      id: "IdentityId", # required
    },
    iam_user: {
      arn: "IamArn", # required
    },
    iam_role: {
      arn: "IamArn", # required
    },
  },
  access_policy_resource: { # required
    portal: {
      id: "ID", # required
    },
    project: {
      id: "ID", # required
    },
  },
  access_policy_permission: "ADMINISTRATOR", # required, accepts ADMINISTRATOR, VIEWER
  client_token: "ClientToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :access_policy_id (required, String) —

    The ID of the access policy.

  • :access_policy_identity (required, Types::Identity) —

    The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.

  • :access_policy_resource (required, Types::Resource) —

    The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.

  • :access_policy_permission (required, String) —

    The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.



10104
10105
10106
10107
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 10104

def update_access_policy(params = {}, options = {})
  req = build_request(:update_access_policy, params)
  req.send_request(options)
end

#update_asset(params = {}) ⇒ Types::UpdateAssetResponse

Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide.

Examples:

Request syntax with placeholder values


resp = client.update_asset({
  asset_id: "CustomID", # required
  asset_external_id: "ExternalId",
  asset_name: "Name", # required
  client_token: "ClientToken",
  asset_description: "Description",
})

Response structure


resp.asset_id #=> String
resp.asset_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.asset_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.asset_status.error.message #=> String
resp.asset_status.error.details #=> Array
resp.asset_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.asset_status.error.details[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_id (required, String) —

    The ID of the asset to update. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :asset_external_id (String) —

    An external ID to assign to the asset. The asset must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.

  • :asset_name (required, String) —

    A friendly name for the asset.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :asset_description (String) —

    A description for the asset.

Returns:



10177
10178
10179
10180
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 10177

def update_asset(params = {}, options = {})
  req = build_request(:update_asset, params)
  req.send_request(options)
end

#update_asset_model(params = {}) ⇒ Types::UpdateAssetModelResponse

Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.

If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.

To replace an existing asset model property with a new one with the same name, do the following:

  1. Submit an UpdateAssetModel request with the entire existing property removed.

  2. Submit a second UpdateAssetModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.

Examples:

Request syntax with placeholder values


resp = client.update_asset_model({
  asset_model_id: "CustomID", # required
  asset_model_external_id: "ExternalId",
  asset_model_name: "Name", # required
  asset_model_description: "Description",
  asset_model_properties: [
    {
      id: "CustomID",
      external_id: "ExternalId",
      name: "Name", # required
      data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT, VIDEO, ANNOTATION, JSON
      data_type_spec: "Name",
      unit: "PropertyUnit",
      type: { # required
        attribute: {
          default_value: "DefaultValue",
        },
        measurement: {
          processing_config: {
            forwarding_config: { # required
              state: "DISABLED", # required, accepts DISABLED, ENABLED
            },
          },
        },
        transform: {
          expression: "Expression", # required
          variables: [ # required
            {
              name: "VariableName", # required
              value: { # required
                property_id: "Macro",
                hierarchy_id: "Macro",
                property_path: [
                  {
                    id: "ID",
                    name: "Name",
                  },
                ],
              },
            },
          ],
          processing_config: {
            compute_location: "EDGE", # required, accepts EDGE, CLOUD
            forwarding_config: {
              state: "DISABLED", # required, accepts DISABLED, ENABLED
            },
          },
        },
        metric: {
          expression: "Expression",
          variables: [
            {
              name: "VariableName", # required
              value: { # required
                property_id: "Macro",
                hierarchy_id: "Macro",
                property_path: [
                  {
                    id: "ID",
                    name: "Name",
                  },
                ],
              },
            },
          ],
          window: { # required
            tumbling: {
              interval: "Interval", # required
              offset: "Offset",
            },
          },
          processing_config: {
            compute_location: "EDGE", # required, accepts EDGE, CLOUD
          },
        },
      },
      path: [
        {
          id: "ID",
          name: "Name",
        },
      ],
    },
  ],
  asset_model_hierarchies: [
    {
      id: "CustomID",
      external_id: "ExternalId",
      name: "Name", # required
      child_asset_model_id: "CustomID", # required
    },
  ],
  asset_model_composite_models: [
    {
      name: "Name", # required
      description: "Description",
      type: "Name", # required
      properties: [
        {
          id: "CustomID",
          external_id: "ExternalId",
          name: "Name", # required
          data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT, VIDEO, ANNOTATION, JSON
          data_type_spec: "Name",
          unit: "PropertyUnit",
          type: { # required
            attribute: {
              default_value: "DefaultValue",
            },
            measurement: {
              processing_config: {
                forwarding_config: { # required
                  state: "DISABLED", # required, accepts DISABLED, ENABLED
                },
              },
            },
            transform: {
              expression: "Expression", # required
              variables: [ # required
                {
                  name: "VariableName", # required
                  value: { # required
                    property_id: "Macro",
                    hierarchy_id: "Macro",
                    property_path: [
                      {
                        id: "ID",
                        name: "Name",
                      },
                    ],
                  },
                },
              ],
              processing_config: {
                compute_location: "EDGE", # required, accepts EDGE, CLOUD
                forwarding_config: {
                  state: "DISABLED", # required, accepts DISABLED, ENABLED
                },
              },
            },
            metric: {
              expression: "Expression",
              variables: [
                {
                  name: "VariableName", # required
                  value: { # required
                    property_id: "Macro",
                    hierarchy_id: "Macro",
                    property_path: [
                      {
                        id: "ID",
                        name: "Name",
                      },
                    ],
                  },
                },
              ],
              window: { # required
                tumbling: {
                  interval: "Interval", # required
                  offset: "Offset",
                },
              },
              processing_config: {
                compute_location: "EDGE", # required, accepts EDGE, CLOUD
              },
            },
          },
          path: [
            {
              id: "ID",
              name: "Name",
            },
          ],
        },
      ],
      id: "CustomID",
      external_id: "ExternalId",
    },
  ],
  client_token: "ClientToken",
  if_match: "ETag",
  if_none_match: "SelectAll",
  match_for_version_type: "LATEST", # accepts LATEST, ACTIVE
})

Response structure


resp.asset_model_id #=> String
resp.asset_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED"
resp.asset_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.asset_model_status.error.message #=> String
resp.asset_model_status.error.details #=> Array
resp.asset_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.asset_model_status.error.details[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_model_id (required, String) —

    The ID of the asset model to update. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :asset_model_external_id (String) —

    An external ID to assign to the asset model. The asset model must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.

  • :asset_model_name (required, String) —

    A unique name for the asset model.

  • :asset_model_description (String) —

    A description for the asset model.

  • :asset_model_properties (Array<Types::AssetModelProperty>) —

    The updated property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.

    You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

  • :asset_model_hierarchies (Array<Types::AssetModelHierarchy>) —

    The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

    You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

  • :asset_model_composite_models (Array<Types::AssetModelCompositeModel>) —

    The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

    When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see Creating custom composite models (Components) in the IoT SiteWise User Guide.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :if_match (String) —

    The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The update request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.

  • :if_none_match (String) —

    Accepts ***** to reject the update request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.

  • :match_for_version_type (String) —

    Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the update operation.

Returns:



10513
10514
10515
10516
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 10513

def update_asset_model(params = {}, options = {})
  req = build_request(:update_asset_model, params)
  req.send_request(options)
end

#update_asset_model_composite_model(params = {}) ⇒ Types::UpdateAssetModelCompositeModelResponse

Updates a composite model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide.

If you remove a property from a composite asset model, IoT SiteWise deletes all previous data for that property. You can’t change the type or data type of an existing property.

To replace an existing composite asset model property with a new one with the same name, do the following:

  1. Submit an UpdateAssetModelCompositeModel request with the entire existing property removed.

  2. Submit a second UpdateAssetModelCompositeModel request that includes the new property. The new asset property will have the same name as the previous one and IoT SiteWise will generate a new unique id.

Examples:

Request syntax with placeholder values


resp = client.update_asset_model_composite_model({
  asset_model_id: "CustomID", # required
  asset_model_composite_model_id: "CustomID", # required
  asset_model_composite_model_external_id: "ExternalId",
  asset_model_composite_model_description: "Description",
  asset_model_composite_model_name: "Name", # required
  client_token: "ClientToken",
  asset_model_composite_model_properties: [
    {
      id: "CustomID",
      external_id: "ExternalId",
      name: "Name", # required
      data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT, VIDEO, ANNOTATION, JSON
      data_type_spec: "Name",
      unit: "PropertyUnit",
      type: { # required
        attribute: {
          default_value: "DefaultValue",
        },
        measurement: {
          processing_config: {
            forwarding_config: { # required
              state: "DISABLED", # required, accepts DISABLED, ENABLED
            },
          },
        },
        transform: {
          expression: "Expression", # required
          variables: [ # required
            {
              name: "VariableName", # required
              value: { # required
                property_id: "Macro",
                hierarchy_id: "Macro",
                property_path: [
                  {
                    id: "ID",
                    name: "Name",
                  },
                ],
              },
            },
          ],
          processing_config: {
            compute_location: "EDGE", # required, accepts EDGE, CLOUD
            forwarding_config: {
              state: "DISABLED", # required, accepts DISABLED, ENABLED
            },
          },
        },
        metric: {
          expression: "Expression",
          variables: [
            {
              name: "VariableName", # required
              value: { # required
                property_id: "Macro",
                hierarchy_id: "Macro",
                property_path: [
                  {
                    id: "ID",
                    name: "Name",
                  },
                ],
              },
            },
          ],
          window: { # required
            tumbling: {
              interval: "Interval", # required
              offset: "Offset",
            },
          },
          processing_config: {
            compute_location: "EDGE", # required, accepts EDGE, CLOUD
          },
        },
      },
      path: [
        {
          id: "ID",
          name: "Name",
        },
      ],
    },
  ],
  if_match: "ETag",
  if_none_match: "SelectAll",
  match_for_version_type: "LATEST", # accepts LATEST, ACTIVE
})

Response structure


resp.asset_model_composite_model_path #=> Array
resp.asset_model_composite_model_path[0].id #=> String
resp.asset_model_composite_model_path[0].name #=> String
resp.asset_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED"
resp.asset_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.asset_model_status.error.message #=> String
resp.asset_model_status.error.details #=> Array
resp.asset_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.asset_model_status.error.details[0].message #=> String
resp.asset_model_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_model_id (required, String) —

    The ID of the asset model, in UUID format.

  • :asset_model_composite_model_id (required, String) —

    The ID of a composite model on this asset model.

  • :asset_model_composite_model_external_id (String) —

    An external ID to assign to the asset model. You can only set the external ID of the asset model if it wasn't set when it was created, or you're setting it to the exact same thing as when it was created.

  • :asset_model_composite_model_description (String) —

    A description for the composite model.

  • :asset_model_composite_model_name (required, String) —

    A unique name for the composite model.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :asset_model_composite_model_properties (Array<Types::AssetModelProperty>) —

    The property definitions of the composite model. For more information, see Inline custom composite models in the IoT SiteWise User Guide.

    You can specify up to 200 properties per composite model. For more information, see Quotas in the IoT SiteWise User Guide.

  • :if_match (String) —

    The expected current entity tag (ETag) for the asset model’s latest or active version (specified using matchForVersionType). The update request is rejected if the tag does not match the latest or active version's current entity tag. See Optimistic locking for asset model writes in the IoT SiteWise User Guide.

  • :if_none_match (String) —

    Accepts ***** to reject the update request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.

  • :match_for_version_type (String) —

    Specifies the asset model version type (LATEST or ACTIVE) used in conjunction with If-Match or If-None-Match headers to determine the target ETag for the update operation.

Returns:



10717
10718
10719
10720
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 10717

def update_asset_model_composite_model(params = {}, options = {})
  req = build_request(:update_asset_model_composite_model, params)
  req.send_request(options)
end

#update_asset_property(params = {}) ⇒ Struct

Updates an asset property's alias and notification state.

This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty.

Examples:

Request syntax with placeholder values


resp = client.update_asset_property({
  asset_id: "CustomID", # required
  property_id: "CustomID", # required
  property_alias: "PropertyAlias",
  property_notification_state: "ENABLED", # accepts ENABLED, DISABLED
  client_token: "ClientToken",
  property_unit: "PropertyUnit",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :asset_id (required, String) —

    The ID of the asset to be updated. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :property_id (required, String) —

    The ID of the asset property to be updated. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • :property_alias (String) —

    The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

    If you omit this parameter, the alias is removed from the property.

  • :property_notification_state (String) —

    The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide.

    If you omit this parameter, the notification state is set to DISABLED.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :property_unit (String) —

    The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.

Returns:

  • (Struct) —

    Returns an empty response.



10809
10810
10811
10812
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 10809

def update_asset_property(params = {}, options = {})
  req = build_request(:update_asset_property, params)
  req.send_request(options)
end

#update_computation_model(params = {}) ⇒ Types::UpdateComputationModelResponse

Updates the computation model.

Examples:

Request syntax with placeholder values


resp = client.update_computation_model({
  computation_model_id: "ID", # required
  computation_model_name: "RestrictedName", # required
  computation_model_description: "RestrictedDescription",
  computation_model_configuration: { # required
    anomaly_detection: {
      input_properties: "InputProperties", # required
      result_property: "ResultProperty", # required
    },
  },
  computation_model_data_binding: { # required
    "ComputationModelDataBindingVariable" => {
      asset_model_property: {
        asset_model_id: "ID", # required
        property_id: "ID", # required
      },
      asset_property: {
        asset_id: "ID", # required
        property_id: "ID", # required
      },
      list: [
        {
          # recursive ComputationModelDataBindingValue
        },
      ],
    },
  },
  client_token: "ClientToken",
})

Response structure


resp.computation_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.computation_model_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.computation_model_status.error.message #=> String
resp.computation_model_status.error.details #=> Array
resp.computation_model_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.computation_model_status.error.details[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :computation_model_id (required, String) —

    The ID of the computation model.

  • :computation_model_name (required, String) —

    The name of the computation model.

  • :computation_model_description (String) —

    The description of the computation model.

  • :computation_model_configuration (required, Types::ComputationModelConfiguration) —

    The configuration for the computation model.

  • :computation_model_data_binding (required, Hash<String,Types::ComputationModelDataBindingValue>) —

    The data binding for the computation model. Key is a variable name defined in configuration. Value is a ComputationModelDataBindingValue referenced by the variable.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



10888
10889
10890
10891
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 10888

def update_computation_model(params = {}, options = {})
  req = build_request(:update_computation_model, params)
  req.send_request(options)
end

#update_dashboard(params = {}) ⇒ Struct

The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

Updates an IoT SiteWise Monitor dashboard.

Examples:

Request syntax with placeholder values


resp = client.update_dashboard({
  dashboard_id: "ID", # required
  dashboard_name: "Name", # required
  dashboard_description: "Description",
  dashboard_definition: "DashboardDefinition", # required
  client_token: "ClientToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dashboard_id (required, String) —

    The ID of the dashboard to update.

  • :dashboard_name (required, String) —

    A new friendly name for the dashboard.

  • :dashboard_description (String) —

    A new description for the dashboard.

  • :dashboard_definition (required, String) —

    The new dashboard definition, as specified in a JSON literal.

    in the IoT SiteWise User Guide

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.



10950
10951
10952
10953
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 10950

def update_dashboard(params = {}, options = {})
  req = build_request(:update_dashboard, params)
  req.send_request(options)
end

#update_dataset(params = {}) ⇒ Types::UpdateDatasetResponse

Updates a dataset.

Examples:

Request syntax with placeholder values


resp = client.update_dataset({
  dataset_id: "ID", # required
  workspace_name: "WorkspaceName",
  dataset_name: "RestrictedName", # required
  dataset_description: "Description",
  dataset_config: {
    session: {
      session_start_timestamp: { # required
        time_in_seconds: 1, # required
        offset_in_nanos: 1,
      },
      session_end_timestamp: { # required
        time_in_seconds: 1, # required
        offset_in_nanos: 1,
      },
    },
  },
  metadata: {
    "MetadataKey" => "MetadataValue",
  },
  dataset_source: { # required
    source_type: "KENDRA", # required, accepts KENDRA, SITEWISE
    source_format: "KNOWLEDGE_BASE", # required, accepts KNOWLEDGE_BASE, TIMESERIES
    source_detail: {
      kendra: {
        knowledge_base_arn: "ARN", # required
        role_arn: "ARN", # required
      },
    },
  },
  client_token: "ClientToken",
})

Response structure


resp.dataset_id #=> String
resp.dataset_arn #=> String
resp.dataset_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.dataset_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.dataset_status.error.message #=> String
resp.dataset_status.error.details #=> Array
resp.dataset_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
resp.dataset_status.error.details[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :dataset_id (required, String) —

    The ID of the dataset.

  • :workspace_name (String) —

    The name of the workspace that contains the dataset.

  • :dataset_name (required, String) —

    The name of the dataset.

  • :dataset_description (String) —

    A description about the dataset, and its functionality.

  • :dataset_config (Types::DatasetConfig) —

    The updated configuration for the dataset.

  • :metadata (Hash<String,String>) —

    The updated metadata for the dataset.

  • :dataset_source (required, Types::DatasetSource) —

    The data source for the dataset.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



11040
11041
11042
11043
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 11040

def update_dataset(params = {}, options = {})
  req = build_request(:update_dataset, params)
  req.send_request(options)
end

#update_gateway(params = {}) ⇒ Struct

Updates a gateway's name.

Examples:

Request syntax with placeholder values


resp = client.update_gateway({
  gateway_id: "ID", # required
  gateway_name: "GatewayName", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The ID of the gateway to update.

  • :gateway_name (required, String) —

    A unique name for the gateway.

Returns:

  • (Struct) —

    Returns an empty response.



11064
11065
11066
11067
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 11064

def update_gateway(params = {}, options = {})
  req = build_request(:update_gateway, params)
  req.send_request(options)
end

#update_gateway_capability_configuration(params = {}) ⇒ Types::UpdateGatewayCapabilityConfigurationResponse

Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway.

Important workflow notes:

Each gateway capability defines data sources for a gateway. This is the namespace of the gateway capability.

. The namespace follows the format service:capability:version, where:

  • service - The service providing the capability, or iotsitewise.

  • capability - The specific capability type. Options include: opcuacollector for the OPC UA data source collector, or publisher for data publisher capability.

  • version - The version number of the capability. Option include 2 for Classic streams, V2 gateways, and 3 for MQTT-enabled, V3 gateways.

After updating a capability configuration, the sync status becomes OUT_OF_SYNC until the gateway processes the configuration.Use DescribeGatewayCapabilityConfiguration to check the sync status and verify the configuration was applied.

A gateway can have multiple capability configurations with different namespaces.

Examples:

Request syntax with placeholder values


resp = client.update_gateway_capability_configuration({
  gateway_id: "ID", # required
  capability_namespace: "CapabilityNamespace", # required
  capability_configuration: "CapabilityConfiguration", # required
})

Response structure


resp.capability_namespace #=> String
resp.capability_sync_status #=> String, one of "IN_SYNC", "OUT_OF_SYNC", "SYNC_FAILED", "UNKNOWN", "NOT_APPLICABLE"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :gateway_id (required, String) —

    The ID of the gateway to be updated.

  • :capability_namespace (required, String) —

    The namespace of the gateway capability configuration to be updated. For example, if you configure OPC UA sources for an MQTT-enabled gateway, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:3.

  • :capability_configuration (required, String) —

    The JSON document that defines the configuration for the gateway capability. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.

Returns:



11137
11138
11139
11140
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 11137

def update_gateway_capability_configuration(params = {}, options = {})
  req = build_request(:update_gateway_capability_configuration, params)
  req.send_request(options)
end

#update_pipeline(params = {}) ⇒ Types::UpdatePipelineResponse

Updates an existing pipeline in the specified workspace. Only the fields provided in the request are updated; fields not included in the request are preserved unchanged. You can update the pipeline description, environment variables, and the list of compute nodes independently.

Examples:

Request syntax with placeholder values


resp = client.update_pipeline({
  workspace_name: "WorkspaceName", # required
  pipeline_name: "ResourceName", # required
  description: "Description",
  environment_variables: {
    "EnvironmentVariableName" => "EnvironmentVariableValue",
  },
  computations: [
    {
      compute_node_name: "ResourceName", # required
      task_name: "ResourceName", # required
      environment_variables: {
        "EnvironmentVariableName" => "EnvironmentVariableValue",
      },
      depends_on: ["ResourceName"],
    },
  ],
})

Response structure


resp.version #=> String
resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.status.error.message #=> String
resp.status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace.

  • :pipeline_name (required, String) —

    The name of the pipeline to update.

  • :description (String) —

    A new description for the pipeline.

  • :environment_variables (Hash<String,String>) —

    Updated environment variables shared across all compute nodes.

  • :computations (Array<Types::ComputeNode>) —

    Updated list of compute nodes forming the pipeline DAG.

Returns:



11198
11199
11200
11201
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 11198

def update_pipeline(params = {}, options = {})
  req = build_request(:update_pipeline, params)
  req.send_request(options)
end

#update_portal(params = {}) ⇒ Types::UpdatePortalResponse

The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

Updates an IoT SiteWise Monitor portal.

Examples:

Request syntax with placeholder values


resp = client.update_portal({
  portal_id: "ID", # required
  portal_name: "Name", # required
  portal_description: "Description",
  portal_contact_email: "Email", # required
  portal_logo_image: {
    id: "ID",
    file: {
      data: "data", # required
      type: "PNG", # required, accepts PNG
    },
  },
  role_arn: "IamArn", # required
  client_token: "ClientToken",
  notification_sender_email: "Email",
  alarms: {
    alarm_role_arn: "IamArn", # required
    notification_lambda_arn: "ARN",
  },
  portal_type: "SITEWISE_PORTAL_V1", # accepts SITEWISE_PORTAL_V1, SITEWISE_PORTAL_V2
  portal_type_configuration: {
    "PortalTypeKey" => {
      portal_tools: ["Name"],
    },
  },
})

Response structure


resp.portal_status.state #=> String, one of "CREATING", "PENDING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "LIMIT_EXCEEDED"
resp.portal_status.error.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :portal_id (required, String) —

    The ID of the portal to update.

  • :portal_name (required, String) —

    A new friendly name for the portal.

  • :portal_description (String) —

    A new description for the portal.

  • :portal_contact_email (required, String) —

    The Amazon Web Services administrator's contact email address.

  • :portal_logo_image (Types::Image) —

    Contains an image that is one of the following:

    • An image file. Choose this option to upload a new image.

    • The ID of an existing image. Choose this option to keep an existing image.

  • :role_arn (required, String) —

    The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :notification_sender_email (String) —

    The email address that sends alarm notifications.

  • :alarms (Types::Alarms) —

    Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.

  • :portal_type (String) —

    Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

  • :portal_type_configuration (Hash<String,Types::PortalTypeEntry>) —

    The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

Returns:



11319
11320
11321
11322
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 11319

def update_portal(params = {}, options = {})
  req = build_request(:update_portal, params)
  req.send_request(options)
end

#update_project(params = {}) ⇒ Struct

The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.

Updates an IoT SiteWise Monitor project.

Examples:

Request syntax with placeholder values


resp = client.update_project({
  project_id: "ID", # required
  project_name: "Name", # required
  project_description: "Description",
  client_token: "ClientToken",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :project_id (required, String) —

    The ID of the project to update.

  • :project_name (required, String) —

    A new friendly name for the project.

  • :project_description (String) —

    A new description for the project.

  • :client_token (String) —

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.



11366
11367
11368
11369
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 11366

def update_project(params = {}, options = {})
  req = build_request(:update_project, params)
  req.send_request(options)
end

#update_task(params = {}) ⇒ Types::UpdateTaskResponse

Updates an existing task in the specified workspace. Only the fields provided in the request are updated; fields not included in the request are preserved unchanged.

Examples:

Request syntax with placeholder values


resp = client.update_task({
  workspace_name: "WorkspaceName", # required
  task_name: "ResourceName", # required
  description: "Description",
  task_configuration: {
    container_task_configuration: {
      ecr_uri: "EcrUri", # required
      task_execution_role: "IamRoleArn", # required
      processing_type: "GENERIC_COMPUTE_PROCESSING", # required, accepts GENERIC_COMPUTE_PROCESSING, HARDWARE_ACCELERATED_PROCESSING
      processing_unit: "UNITS_2", # required, accepts UNITS_2, UNITS_4, UNITS_8, UNITS_12, UNITS_16, UNITS_24, UNITS_32, UNITS_36, UNITS_48, UNITS_60, UNITS_64, UNITS_72, UNITS_84, UNITS_96
      ephemeral_storage_configuration: {
        storage_class: "STANDARD_1", # required, accepts STANDARD_1, STANDARD_2, THROUGHPUT_1, THROUGHPUT_2
        storage_size_in_gi_b: 1, # required
      },
      command: ["String"],
      timeout_seconds: 1,
      environment_variables: {
        "EnvironmentVariableName" => "EnvironmentVariableValue",
      },
      mounts: [
        {
          name: "ResourceName", # required
          relative_path: "MountRelativePath", # required
          source: { # required
            s3_access_point: {
              access_point_arn: "MountS3AccessPointArn", # required
              prefix: "MountS3KeyPrefix",
            },
          },
          storage_type: "SHARED_STORAGE", # required, accepts SHARED_STORAGE
        },
      ],
    },
  },
})

Response structure


resp.version #=> String
resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.status.error.message #=> String
resp.status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace.

  • :task_name (required, String) —

    The name of the task to update.

  • :description (String) —

    A new description for the task.

  • :task_configuration (Types::TaskConfiguration) —

    The updated task execution configuration.

Returns:



11439
11440
11441
11442
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 11439

def update_task(params = {}, options = {})
  req = build_request(:update_task, params)
  req.send_request(options)
end

#update_workspace(params = {}) ⇒ Types::UpdateWorkspaceResponse

Updates a workspace. You can update only workspaces in the ACTIVE or FAILED state. Fields that you omit from the request are left unchanged. To recover a workspace in the FAILED state, call this operation and supply its encryption configuration again.

Examples:

Request syntax with placeholder values


resp = client.update_workspace({
  workspace_name: "WorkspaceName", # required
  workspace_description: "Description",
  encryption_configuration: {
    encryption_type: "SITEWISE_DEFAULT_ENCRYPTION", # required, accepts SITEWISE_DEFAULT_ENCRYPTION, KMS_BASED_ENCRYPTION
    kms_key_id: "KmsKeyId",
  },
  client_token: "ClientToken",
})

Response structure


resp.workspace_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
resp.workspace_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.workspace_status.error.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :workspace_name (required, String) —

    The name of the workspace to update.

  • :workspace_description (String) —

    A new description for the workspace.

  • :encryption_configuration (Types::WorkspaceEncryptionConfiguration) —

    The encryption configuration for the workspace. Omit this field to leave encryption unchanged. After a customer managed key configuration becomes active, the key can't be changed; supplying the same key is accepted.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure that the request is idempotent. If you retry a request that completed successfully using the same client token, the retry succeeds without performing any further actions.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:



11494
11495
11496
11497
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 11494

def update_workspace(params = {}, options = {})
  req = build_request(:update_workspace, params)
  req.send_request(options)
end

#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean

Polls an API operation until a resource enters a desired state.

Basic Usage

A waiter will call an API operation until:

  • It is successful
  • It enters a terminal state
  • It makes the maximum number of attempts

In between attempts, the waiter will sleep.

# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.

# poll for ~25 seconds
client.wait_until(waiter_name, params, {
  max_attempts: 5,
  delay: 5,
})

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(waiter_name, params, {

  # disable max attempts
  max_attempts: nil,

  # poll for 1 hour, instead of a number of attempts
  before_wait: -> (attempts, response) do
    throw :failure if Time.now - started_at > 3600
  end
})

Handling Errors

When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Valid Waiters

The following table lists the valid waiter names, the operations they call, and the default :delay and :max_attempts values.

waiter_name params :delay :max_attempts
asset_active #describe_asset 3 20
asset_model_active #describe_asset_model 3 20
asset_model_not_exists #describe_asset_model 3 20
asset_not_exists #describe_asset 3 20
portal_active #describe_portal 3 20
portal_not_exists #describe_portal 3 20

Parameters:

  • waiter_name (Symbol)
  • params (Hash) (defaults to: {}) —

    ({})

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :max_attempts (Integer)
  • :delay (Integer)
  • :before_attempt (Proc)
  • :before_wait (Proc)

Yields:

  • (w.waiter)

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.



11614
11615
11616
11617
11618
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/client.rb', line 11614

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end