# frozen_string_literal: true # WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE require 'seahorse/client/plugins/content_length.rb' require 'aws-sdk-core/plugins/credentials_configuration.rb' require 'aws-sdk-core/plugins/logging.rb' require 'aws-sdk-core/plugins/param_converter.rb' require 'aws-sdk-core/plugins/param_validator.rb' require 'aws-sdk-core/plugins/user_agent.rb' require 'aws-sdk-core/plugins/helpful_socket_errors.rb' require 'aws-sdk-core/plugins/retry_errors.rb' require 'aws-sdk-core/plugins/global_configuration.rb' require 'aws-sdk-core/plugins/regional_endpoint.rb' require 'aws-sdk-core/plugins/endpoint_discovery.rb' require 'aws-sdk-core/plugins/endpoint_pattern.rb' require 'aws-sdk-core/plugins/response_paging.rb' require 'aws-sdk-core/plugins/stub_responses.rb' require 'aws-sdk-core/plugins/idempotency_token.rb' require 'aws-sdk-core/plugins/invocation_id.rb' require 'aws-sdk-core/plugins/jsonvalue_converter.rb' require 'aws-sdk-core/plugins/client_metrics_plugin.rb' require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb' require 'aws-sdk-core/plugins/transfer_encoding.rb' require 'aws-sdk-core/plugins/http_checksum.rb' require 'aws-sdk-core/plugins/checksum_algorithm.rb' require 'aws-sdk-core/plugins/request_compression.rb' require 'aws-sdk-core/plugins/defaults_mode.rb' require 'aws-sdk-core/plugins/recursion_detection.rb' require 'aws-sdk-core/plugins/telemetry.rb' require 'aws-sdk-core/plugins/sign.rb' require 'aws-sdk-core/plugins/protocols/rest_json.rb' Aws::Plugins::GlobalConfiguration.add_identifier(:iottwinmaker) module Aws::IoTTwinMaker # An API client for IoTTwinMaker. To construct a client, you need to configure a `:region` and `:credentials`. # # client = Aws::IoTTwinMaker::Client.new( # region: region_name, # credentials: credentials, # # ... # ) # # For details on configuring region and credentials see # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html). # # See {#initialize} for a full list of supported configuration options. class Client < Seahorse::Client::Base include Aws::ClientStubs @identifier = :iottwinmaker set_api(ClientApi::API) add_plugin(Seahorse::Client::Plugins::ContentLength) add_plugin(Aws::Plugins::CredentialsConfiguration) add_plugin(Aws::Plugins::Logging) add_plugin(Aws::Plugins::ParamConverter) add_plugin(Aws::Plugins::ParamValidator) add_plugin(Aws::Plugins::UserAgent) add_plugin(Aws::Plugins::HelpfulSocketErrors) add_plugin(Aws::Plugins::RetryErrors) add_plugin(Aws::Plugins::GlobalConfiguration) add_plugin(Aws::Plugins::RegionalEndpoint) add_plugin(Aws::Plugins::EndpointDiscovery) add_plugin(Aws::Plugins::EndpointPattern) add_plugin(Aws::Plugins::ResponsePaging) add_plugin(Aws::Plugins::StubResponses) add_plugin(Aws::Plugins::IdempotencyToken) add_plugin(Aws::Plugins::InvocationId) add_plugin(Aws::Plugins::JsonvalueConverter) add_plugin(Aws::Plugins::ClientMetricsPlugin) add_plugin(Aws::Plugins::ClientMetricsSendPlugin) add_plugin(Aws::Plugins::TransferEncoding) add_plugin(Aws::Plugins::HttpChecksum) add_plugin(Aws::Plugins::ChecksumAlgorithm) add_plugin(Aws::Plugins::RequestCompression) add_plugin(Aws::Plugins::DefaultsMode) add_plugin(Aws::Plugins::RecursionDetection) add_plugin(Aws::Plugins::Telemetry) add_plugin(Aws::Plugins::Sign) add_plugin(Aws::Plugins::Protocols::RestJson) add_plugin(Aws::IoTTwinMaker::Plugins::Endpoints) # @overload initialize(options) # @param [Hash] options # # @option options [Array] :plugins ([]]) # A list of plugins to apply to the client. Each plugin is either a # class name or an instance of a plugin class. # # @option options [required, Aws::CredentialProvider] :credentials # Your AWS credentials. This can be an 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. # # @option options [required, String] :region # 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` # # @option options [String] :access_key_id # # @option options [String] :account_id # # @option options [Boolean] :active_endpoint_cache (false) # When set to `true`, a thread polling for endpoints will be running in # the background every 60 secs (default). Defaults to `false`. # # @option options [Boolean] :adaptive_retry_wait_to_fill (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. # # @option options [Boolean] :client_side_monitoring (false) # When `true`, client-side metrics will be collected for all API requests from # this client. # # @option options [String] :client_side_monitoring_client_id ("") # Allows you to provide an identifier for this client which will be attached to # all generated client side metrics. Defaults to an empty string. # # @option options [String] :client_side_monitoring_host ("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. # # @option options [Integer] :client_side_monitoring_port (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. # # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) # Allows you to provide a custom client-side monitoring publisher class. By default, # will use the Client Side Monitoring Agent Publisher. # # @option options [Boolean] :convert_params (true) # When `true`, an attempt is made to coerce request parameters into # the required types. # # @option options [Boolean] :correct_clock_skew (true) # Used only in `standard` and adaptive retry modes. Specifies whether to apply # a clock skew correction and retry requests with skewed client clocks. # # @option options [String] :defaults_mode ("legacy") # See {Aws::DefaultsModeConfiguration} for a list of the # accepted modes and the configuration defaults that are included. # # @option options [Boolean] :disable_host_prefix_injection (false) # Set to true to disable SDK automatically adding host prefix # to default service endpoint when available. # # @option options [Boolean] :disable_request_compression (false) # When set to 'true' the request body will not be compressed # for supported operations. # # @option options [String, URI::HTTPS, URI::HTTP] :endpoint # 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' # # @option options [Integer] :endpoint_cache_max_entries (1000) # Used for the maximum size limit of the LRU cache storing endpoints data # for endpoint discovery enabled operations. Defaults to 1000. # # @option options [Integer] :endpoint_cache_max_threads (10) # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. # # @option options [Integer] :endpoint_cache_poll_interval (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. # # @option options [Boolean] :endpoint_discovery (false) # When set to `true`, endpoint discovery will be enabled for operations when available. # # @option options [Boolean] :ignore_configured_endpoint_urls # Setting to true disables use of endpoint URLs provided via environment # variables and the shared configuration file. # # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) # The log formatter. # # @option options [Symbol] :log_level (:info) # The log level to send messages to the `:logger` at. # # @option options [Logger] :logger # The Logger instance to send log messages to. If this option # is not set, logging will be disabled. # # @option options [Integer] :max_attempts (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. # # @option options [String] :profile ("default") # Used when loading credentials from the shared credentials file # at HOME/.aws/credentials. When not specified, 'default' is used. # # @option options [Integer] :request_min_compression_size_bytes (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. # # @option options [Proc] :retry_backoff # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. # This option is only used in the `legacy` retry mode. # # @option options [Float] :retry_base_delay (0.3) # The base delay in seconds used by the default backoff function. This option # is only used in the `legacy` retry mode. # # @option options [Symbol] :retry_jitter (: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 # # @option options [Integer] :retry_limit (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. # # @option options [Integer] :retry_max_delay (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. # # @option options [String] :retry_mode ("legacy") # Specifies which retry algorithm to use. Values are: # # * `legacy` - The pre-existing retry behavior. This is 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` - An experimental retry mode that includes all the # functionality of `standard` mode along with automatic client side # throttling. This is a provisional mode that may change behavior # in the future. # # @option options [String] :sdk_ua_app_id # 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. # # @option options [String] :secret_access_key # # @option options [String] :session_token # # @option options [Array] :sigv4a_signing_region_set # 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` # # @option options [Boolean] :stub_responses (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. # # @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (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. # # @option options [Aws::TokenProvider] :token_provider # A Bearer Token Provider. This can be an 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. # # @option options [Boolean] :use_dualstack_endpoint # When set to `true`, dualstack enabled endpoints (with `.aws` TLD) # will be used if available. # # @option options [Boolean] :use_fips_endpoint # 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`. # # @option options [Boolean] :validate_params (true) # When `true`, request parameters are validated before # sending the request. # # @option options [Aws::IoTTwinMaker::EndpointProvider] :endpoint_provider # The endpoint provider used to resolve endpoints. Any object that responds to # `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to # `Aws::IoTTwinMaker::EndpointParameters`. # # @option options [Float] :http_continue_timeout (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. # # @option options [Float] :http_idle_timeout (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. # # @option options [Float] :http_open_timeout (15) # The default number of seconds to wait for response data. # This value can safely be set per-request on the session. # # @option options [URI::HTTP,String] :http_proxy # A proxy to send requests through. Formatted like 'http://proxy.com:123'. # # @option options [Float] :http_read_timeout (60) # The default number of seconds to wait for response data. # This value can safely be set per-request on the session. # # @option options [Boolean] :http_wire_trace (false) # When `true`, HTTP debug output will be sent to the `:logger`. # # @option options [Proc] :on_chunk_received # 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`). # # @option options [Proc] :on_chunk_sent # 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. # # @option options [Boolean] :raise_response_errors (true) # When `true`, response errors are raised. # # @option options [String] :ssl_ca_bundle # 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. # # @option options [String] :ssl_ca_directory # 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. # # @option options [String] :ssl_ca_store # Sets the X509::Store to verify peer certificate. # # @option options [OpenSSL::X509::Certificate] :ssl_cert # Sets a client certificate when creating http connections. # # @option options [OpenSSL::PKey] :ssl_key # Sets a client key when creating http connections. # # @option options [Float] :ssl_timeout # Sets the SSL timeout in seconds # # @option options [Boolean] :ssl_verify_peer (true) # When `true`, SSL peer certificates are verified when establishing a connection. # def initialize(*args) super end # @!group API Operations # Sets values for multiple time series properties. # # @option params [required, String] :workspace_id # The ID of the workspace that contains the properties to set. # # @option params [required, Array] :entries # An object that maps strings to the property value entries to set. Each # string in the mapping must be unique to this object. # # @return [Types::BatchPutPropertyValuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::BatchPutPropertyValuesResponse#error_entries #error_entries} => Array<Types::BatchPutPropertyErrorEntry> # # @example Request syntax with placeholder values # # resp = client.batch_put_property_values({ # workspace_id: "Id", # required # entries: [ # required # { # entity_property_reference: { # required # component_name: "Name", # component_path: "ComponentPath", # external_id_property: { # "String" => "String", # }, # entity_id: "EntityId", # property_name: "Name", # required # }, # property_values: [ # { # timestamp: Time.now, # value: { # required # boolean_value: false, # double_value: 1.0, # integer_value: 1, # long_value: 1, # string_value: "String", # list_value: [ # { # # recursive DataValue # }, # ], # map_value: { # "String" => { # # recursive DataValue # }, # }, # relationship_value: { # target_entity_id: "EntityId", # target_component_name: "Name", # }, # expression: "Expression", # }, # time: "Time", # }, # ], # }, # ], # }) # # @example Response structure # # resp.error_entries #=> Array # resp.error_entries[0].errors #=> Array # resp.error_entries[0].errors[0].error_code #=> String # resp.error_entries[0].errors[0].error_message #=> String # resp.error_entries[0].errors[0].entry.entity_property_reference.component_name #=> String # resp.error_entries[0].errors[0].entry.entity_property_reference.component_path #=> String # resp.error_entries[0].errors[0].entry.entity_property_reference.external_id_property #=> Hash # resp.error_entries[0].errors[0].entry.entity_property_reference.external_id_property["String"] #=> String # resp.error_entries[0].errors[0].entry.entity_property_reference.entity_id #=> String # resp.error_entries[0].errors[0].entry.entity_property_reference.property_name #=> String # resp.error_entries[0].errors[0].entry.property_values #=> Array # resp.error_entries[0].errors[0].entry.property_values[0].timestamp #=> Time # resp.error_entries[0].errors[0].entry.property_values[0].value.boolean_value #=> Boolean # resp.error_entries[0].errors[0].entry.property_values[0].value.double_value #=> Float # resp.error_entries[0].errors[0].entry.property_values[0].value.integer_value #=> Integer # resp.error_entries[0].errors[0].entry.property_values[0].value.long_value #=> Integer # resp.error_entries[0].errors[0].entry.property_values[0].value.string_value #=> String # resp.error_entries[0].errors[0].entry.property_values[0].value.list_value #=> Array # resp.error_entries[0].errors[0].entry.property_values[0].value.list_value[0] #=> Types::DataValue # resp.error_entries[0].errors[0].entry.property_values[0].value.map_value #=> Hash # resp.error_entries[0].errors[0].entry.property_values[0].value.map_value["String"] #=> Types::DataValue # resp.error_entries[0].errors[0].entry.property_values[0].value.relationship_value.target_entity_id #=> String # resp.error_entries[0].errors[0].entry.property_values[0].value.relationship_value.target_component_name #=> String # resp.error_entries[0].errors[0].entry.property_values[0].value.expression #=> String # resp.error_entries[0].errors[0].entry.property_values[0].time #=> String # # @overload batch_put_property_values(params = {}) # @param [Hash] params ({}) def batch_put_property_values(params = {}, options = {}) req = build_request(:batch_put_property_values, params) req.send_request(options) end # Cancels the metadata transfer job. # # @option params [required, String] :metadata_transfer_job_id # The metadata transfer job Id. # # @return [Types::CancelMetadataTransferJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CancelMetadataTransferJobResponse#metadata_transfer_job_id #metadata_transfer_job_id} => String # * {Types::CancelMetadataTransferJobResponse#arn #arn} => String # * {Types::CancelMetadataTransferJobResponse#update_date_time #update_date_time} => Time # * {Types::CancelMetadataTransferJobResponse#status #status} => Types::MetadataTransferJobStatus # * {Types::CancelMetadataTransferJobResponse#progress #progress} => Types::MetadataTransferJobProgress # # @example Request syntax with placeholder values # # resp = client.cancel_metadata_transfer_job({ # metadata_transfer_job_id: "Id", # required # }) # # @example Response structure # # resp.metadata_transfer_job_id #=> String # resp.arn #=> String # resp.update_date_time #=> Time # resp.status.state #=> String, one of "VALIDATING", "PENDING", "RUNNING", "CANCELLING", "ERROR", "COMPLETED", "CANCELLED" # resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE" # resp.status.error.message #=> String # resp.status.queued_position #=> Integer # resp.progress.total_count #=> Integer # resp.progress.succeeded_count #=> Integer # resp.progress.skipped_count #=> Integer # resp.progress.failed_count #=> Integer # # @overload cancel_metadata_transfer_job(params = {}) # @param [Hash] params ({}) def cancel_metadata_transfer_job(params = {}, options = {}) req = build_request(:cancel_metadata_transfer_job, params) req.send_request(options) end # Creates a component type. # # @option params [required, String] :workspace_id # The ID of the workspace that contains the component type. # # @option params [Boolean] :is_singleton # A Boolean value that specifies whether an entity can have more than # one component of this type. # # @option params [required, String] :component_type_id # The ID of the component type. # # @option params [String] :description # The description of the component type. # # @option params [Hash] :property_definitions # An object that maps strings to the property definitions in the # component type. Each string in the mapping must be unique to this # object. # # @option params [Array] :extends_from # Specifies the parent component type to extend. # # @option params [Hash] :functions # An object that maps strings to the functions in the component type. # Each string in the mapping must be unique to this object. # # @option params [Hash] :tags # Metadata that you can use to manage the component type. # # @option params [Hash] :property_groups # # @option params [String] :component_type_name # A friendly name for the component type. # # @option params [Hash] :composite_component_types # This is an object that maps strings to `compositeComponentTypes` of # the `componentType`. `CompositeComponentType` is referenced by # `componentTypeId`. # # @return [Types::CreateComponentTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateComponentTypeResponse#arn #arn} => String # * {Types::CreateComponentTypeResponse#creation_date_time #creation_date_time} => Time # * {Types::CreateComponentTypeResponse#state #state} => String # # @example Request syntax with placeholder values # # resp = client.create_component_type({ # workspace_id: "Id", # required # is_singleton: false, # component_type_id: "ComponentTypeId", # required # description: "Description", # property_definitions: { # "Name" => { # data_type: { # type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP # nested_type: { # # recursive DataType # }, # allowed_values: [ # { # boolean_value: false, # double_value: 1.0, # integer_value: 1, # long_value: 1, # string_value: "String", # list_value: { # # recursive DataValueList # }, # map_value: { # "String" => { # # recursive DataValue # }, # }, # relationship_value: { # target_entity_id: "EntityId", # target_component_name: "Name", # }, # expression: "Expression", # }, # ], # unit_of_measure: "String", # relationship: { # target_component_type_id: "ComponentTypeId", # relationship_type: "String", # }, # }, # is_required_in_entity: false, # is_external_id: false, # is_stored_externally: false, # is_time_series: false, # default_value: { # boolean_value: false, # double_value: 1.0, # integer_value: 1, # long_value: 1, # string_value: "String", # list_value: [ # { # # recursive DataValue # }, # ], # map_value: { # "String" => { # # recursive DataValue # }, # }, # relationship_value: { # target_entity_id: "EntityId", # target_component_name: "Name", # }, # expression: "Expression", # }, # configuration: { # "Name" => "Value", # }, # display_name: "PropertyDisplayName", # }, # }, # extends_from: ["ComponentTypeId"], # functions: { # "Name" => { # required_properties: ["Name"], # scope: "ENTITY", # accepts ENTITY, WORKSPACE # implemented_by: { # lambda: { # arn: "LambdaArn", # required # }, # is_native: false, # }, # }, # }, # tags: { # "TagKey" => "TagValue", # }, # property_groups: { # "Name" => { # group_type: "TABULAR", # accepts TABULAR # property_names: ["Name"], # }, # }, # component_type_name: "ComponentTypeName", # composite_component_types: { # "Name" => { # component_type_id: "ComponentTypeId", # }, # }, # }) # # @example Response structure # # resp.arn #=> String # resp.creation_date_time #=> Time # resp.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR" # # @overload create_component_type(params = {}) # @param [Hash] params ({}) def create_component_type(params = {}, options = {}) req = build_request(:create_component_type, params) req.send_request(options) end # Creates an entity. # # @option params [required, String] :workspace_id # The ID of the workspace that contains the entity. # # @option params [String] :entity_id # The ID of the entity. # # @option params [required, String] :entity_name # The name of the entity. # # @option params [String] :description # The description of the entity. # # @option params [Hash] :components # An object that maps strings to the components in the entity. Each # string in the mapping must be unique to this object. # # @option params [Hash] :composite_components # This is an object that maps strings to `compositeComponent` updates in # the request. Each key of the map represents the `componentPath` of the # `compositeComponent`. # # @option params [String] :parent_entity_id # The ID of the entity's parent entity. # # @option params [Hash] :tags # Metadata that you can use to manage the entity. # # @return [Types::CreateEntityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateEntityResponse#entity_id #entity_id} => String # * {Types::CreateEntityResponse#arn #arn} => String # * {Types::CreateEntityResponse#creation_date_time #creation_date_time} => Time # * {Types::CreateEntityResponse#state #state} => String # # @example Request syntax with placeholder values # # resp = client.create_entity({ # workspace_id: "Id", # required # entity_id: "EntityId", # entity_name: "EntityName", # required # description: "Description", # components: { # "Name" => { # description: "Description", # component_type_id: "ComponentTypeId", # properties: { # "Name" => { # definition: { # data_type: { # type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP # nested_type: { # # recursive DataType # }, # allowed_values: [ # { # boolean_value: false, # double_value: 1.0, # integer_value: 1, # long_value: 1, # string_value: "String", # list_value: { # # recursive DataValueList # }, # map_value: { # "String" => { # # recursive DataValue # }, # }, # relationship_value: { # target_entity_id: "EntityId", # target_component_name: "Name", # }, # expression: "Expression", # }, # ], # unit_of_measure: "String", # relationship: { # target_component_type_id: "ComponentTypeId", # relationship_type: "String", # }, # }, # is_required_in_entity: false, # is_external_id: false, # is_stored_externally: false, # is_time_series: false, # default_value: { # boolean_value: false, # double_value: 1.0, # integer_value: 1, # long_value: 1, # string_value: "String", # list_value: [ # { # # recursive DataValue # }, # ], # map_value: { # "String" => { # # recursive DataValue # }, # }, # relationship_value: { # target_entity_id: "EntityId", # target_component_name: "Name", # }, # expression: "Expression", # }, # configuration: { # "Name" => "Value", # }, # display_name: "PropertyDisplayName", # }, # value: { # boolean_value: false, # double_value: 1.0, # integer_value: 1, # long_value: 1, # string_value: "String", # list_value: [ # { # # recursive DataValue # }, # ], # map_value: { # "String" => { # # recursive DataValue # }, # }, # relationship_value: { # target_entity_id: "EntityId", # target_component_name: "Name", # }, # expression: "Expression", # }, # update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE, RESET_VALUE # }, # }, # property_groups: { # "Name" => { # group_type: "TABULAR", # accepts TABULAR # property_names: ["Name"], # update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE # }, # }, # }, # }, # composite_components: { # "ComponentPath" => { # description: "Description", # properties: { # "Name" => { # definition: { # data_type: { # type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP # nested_type: { # # recursive DataType # }, # allowed_values: [ # { # boolean_value: false, # double_value: 1.0, # integer_value: 1, # long_value: 1, # string_value: "String", # list_value: { # # recursive DataValueList # }, # map_value: { # "String" => { # # recursive DataValue # }, # }, # relationship_value: { # target_entity_id: "EntityId", # target_component_name: "Name", # }, # expression: "Expression", # }, # ], # unit_of_measure: "String", # relationship: { # target_component_type_id: "ComponentTypeId", # relationship_type: "String", # }, # }, # is_required_in_entity: false, # is_external_id: false, # is_stored_externally: false, # is_time_series: false, # default_value: { # boolean_value: false, # double_value: 1.0, # integer_value: 1, # long_value: 1, # string_value: "String", # list_value: [ # { # # recursive DataValue # }, # ], # map_value: { # "String" => { # # recursive DataValue # }, # }, # relationship_value: { # target_entity_id: "EntityId", # target_component_name: "Name", # }, # expression: "Expression", # }, # configuration: { # "Name" => "Value", # }, # display_name: "PropertyDisplayName", # }, # value: { # boolean_value: false, # double_value: 1.0, # integer_value: 1, # long_value: 1, # string_value: "String", # list_value: [ # { # # recursive DataValue # }, # ], # map_value: { # "String" => { # # recursive DataValue # }, # }, # relationship_value: { # target_entity_id: "EntityId", # target_component_name: "Name", # }, # expression: "Expression", # }, # update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE, RESET_VALUE # }, # }, # property_groups: { # "Name" => { # group_type: "TABULAR", # accepts TABULAR # property_names: ["Name"], # update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE # }, # }, # }, # }, # parent_entity_id: "ParentEntityId", # tags: { # "TagKey" => "TagValue", # }, # }) # # @example Response structure # # resp.entity_id #=> String # resp.arn #=> String # resp.creation_date_time #=> Time # resp.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR" # # @overload create_entity(params = {}) # @param [Hash] params ({}) def create_entity(params = {}, options = {}) req = build_request(:create_entity, params) req.send_request(options) end # Creates a new metadata transfer job. # # @option params [String] :metadata_transfer_job_id # The metadata transfer job Id. # # @option params [String] :description # The metadata transfer job description. # # @option params [required, Array] :sources # The metadata transfer job sources. # # @option params [required, Types::DestinationConfiguration] :destination # The metadata transfer job destination. # # @return [Types::CreateMetadataTransferJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateMetadataTransferJobResponse#metadata_transfer_job_id #metadata_transfer_job_id} => String # * {Types::CreateMetadataTransferJobResponse#arn #arn} => String # * {Types::CreateMetadataTransferJobResponse#creation_date_time #creation_date_time} => Time # * {Types::CreateMetadataTransferJobResponse#status #status} => Types::MetadataTransferJobStatus # # @example Request syntax with placeholder values # # resp = client.create_metadata_transfer_job({ # metadata_transfer_job_id: "Id", # description: "Description", # sources: [ # required # { # type: "s3", # required, accepts s3, iotsitewise, iottwinmaker # s3_configuration: { # location: "S3SourceLocation", # required # }, # iot_site_wise_configuration: { # filters: [ # { # filter_by_asset_model: { # asset_model_id: "Uuid", # asset_model_external_id: "SiteWiseExternalId", # include_offspring: false, # include_assets: false, # }, # filter_by_asset: { # asset_id: "Uuid", # asset_external_id: "SiteWiseExternalId", # include_offspring: false, # include_asset_model: false, # }, # }, # ], # }, # iot_twin_maker_configuration: { # workspace: "TwinMakerArn", # required # filters: [ # { # filter_by_component_type: { # component_type_id: "ComponentTypeId", # required # }, # filter_by_entity: { # entity_id: "EntityId", # required # }, # }, # ], # }, # }, # ], # destination: { # required # type: "s3", # required, accepts s3, iotsitewise, iottwinmaker # s3_configuration: { # location: "S3DestinationLocation", # required # }, # iot_twin_maker_configuration: { # workspace: "TwinMakerArn", # required # }, # }, # }) # # @example Response structure # # resp.metadata_transfer_job_id #=> String # resp.arn #=> String # resp.creation_date_time #=> Time # resp.status.state #=> String, one of "VALIDATING", "PENDING", "RUNNING", "CANCELLING", "ERROR", "COMPLETED", "CANCELLED" # resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE" # resp.status.error.message #=> String # resp.status.queued_position #=> Integer # # @overload create_metadata_transfer_job(params = {}) # @param [Hash] params ({}) def create_metadata_transfer_job(params = {}, options = {}) req = build_request(:create_metadata_transfer_job, params) req.send_request(options) end # Creates a scene. # # @option params [required, String] :workspace_id # The ID of the workspace that contains the scene. # # @option params [required, String] :scene_id # The ID of the scene. # # @option params [required, String] :content_location # The relative path that specifies the location of the content # definition file. # # @option params [String] :description # The description for this scene. # # @option params [Array] :capabilities # A list of capabilities that the scene uses to render itself. # # @option params [Hash] :tags # Metadata that you can use to manage the scene. # # @option params [Hash] :scene_metadata # The request metadata. # # @return [Types::CreateSceneResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateSceneResponse#arn #arn} => String # * {Types::CreateSceneResponse#creation_date_time #creation_date_time} => Time # # @example Request syntax with placeholder values # # resp = client.create_scene({ # workspace_id: "Id", # required # scene_id: "Id", # required # content_location: "S3Url", # required # description: "Description", # capabilities: ["SceneCapability"], # tags: { # "TagKey" => "TagValue", # }, # scene_metadata: { # "Name" => "SceneMetadataValue", # }, # }) # # @example Response structure # # resp.arn #=> String # resp.creation_date_time #=> Time # # @overload create_scene(params = {}) # @param [Hash] params ({}) def create_scene(params = {}, options = {}) req = build_request(:create_scene, params) req.send_request(options) end # This action creates a SyncJob. # # @option params [required, String] :workspace_id # The workspace ID. # # @option params [required, String] :sync_source # The sync source. # # Currently the only supported syncSoource is `SITEWISE `. # # # # @option params [required, String] :sync_role # The SyncJob IAM role. This IAM role is used by the SyncJob to read # from the syncSource, and create, update, or delete the corresponding # resources. # # @option params [Hash] :tags # The SyncJob tags. # # @return [Types::CreateSyncJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateSyncJobResponse#arn #arn} => String # * {Types::CreateSyncJobResponse#creation_date_time #creation_date_time} => Time # * {Types::CreateSyncJobResponse#state #state} => String # # @example Request syntax with placeholder values # # resp = client.create_sync_job({ # workspace_id: "Id", # required # sync_source: "SyncSource", # required # sync_role: "RoleArn", # required # tags: { # "TagKey" => "TagValue", # }, # }) # # @example Response structure # # resp.arn #=> String # resp.creation_date_time #=> Time # resp.state #=> String, one of "CREATING", "INITIALIZING", "ACTIVE", "DELETING", "ERROR" # # @overload create_sync_job(params = {}) # @param [Hash] params ({}) def create_sync_job(params = {}, options = {}) req = build_request(:create_sync_job, params) req.send_request(options) end # Creates a workplace. # # @option params [required, String] :workspace_id # The ID of the workspace. # # @option params [String] :description # The description of the workspace. # # @option params [String] :s3_location # The ARN of the S3 bucket where resources associated with the workspace # are stored. # # @option params [String] :role # The ARN of the execution role associated with the workspace. # # @option params [Hash] :tags # Metadata that you can use to manage the workspace # # @return [Types::CreateWorkspaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateWorkspaceResponse#arn #arn} => String # * {Types::CreateWorkspaceResponse#creation_date_time #creation_date_time} => Time # # @example Request syntax with placeholder values # # resp = client.create_workspace({ # workspace_id: "Id", # required # description: "Description", # s3_location: "S3Location", # role: "RoleArn", # tags: { # "TagKey" => "TagValue", # }, # }) # # @example Response structure # # resp.arn #=> String # resp.creation_date_time #=> Time # # @overload create_workspace(params = {}) # @param [Hash] params ({}) def create_workspace(params = {}, options = {}) req = build_request(:create_workspace, params) req.send_request(options) end # Deletes a component type. # # @option params [required, String] :workspace_id # The ID of the workspace that contains the component type. # # @option params [required, String] :component_type_id # The ID of the component type to delete. # # @return [Types::DeleteComponentTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteComponentTypeResponse#state #state} => String # # @example Request syntax with placeholder values # # resp = client.delete_component_type({ # workspace_id: "Id", # required # component_type_id: "ComponentTypeId", # required # }) # # @example Response structure # # resp.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR" # # @overload delete_component_type(params = {}) # @param [Hash] params ({}) def delete_component_type(params = {}, options = {}) req = build_request(:delete_component_type, params) req.send_request(options) end # Deletes an entity. # # @option params [required, String] :workspace_id # The ID of the workspace that contains the entity to delete. # # @option params [required, String] :entity_id # The ID of the entity to delete. # # @option params [Boolean] :is_recursive # A Boolean value that specifies whether the operation deletes child # entities. # # @return [Types::DeleteEntityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteEntityResponse#state #state} => String # # @example Request syntax with placeholder values # # resp = client.delete_entity({ # workspace_id: "Id", # required # entity_id: "EntityId", # required # is_recursive: false, # }) # # @example Response structure # # resp.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR" # # @overload delete_entity(params = {}) # @param [Hash] params ({}) def delete_entity(params = {}, options = {}) req = build_request(:delete_entity, params) req.send_request(options) end # Deletes a scene. # # @option params [required, String] :workspace_id # The ID of the workspace. # # @option params [required, String] :scene_id # The ID of the scene to delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_scene({ # workspace_id: "Id", # required # scene_id: "Id", # required # }) # # @overload delete_scene(params = {}) # @param [Hash] params ({}) def delete_scene(params = {}, options = {}) req = build_request(:delete_scene, params) req.send_request(options) end # Delete the SyncJob. # # @option params [required, String] :workspace_id # The workspace ID. # # @option params [required, String] :sync_source # The sync source. # # Currently the only supported syncSource is `SITEWISE `. # # # # @return [Types::DeleteSyncJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteSyncJobResponse#state #state} => String # # @example Request syntax with placeholder values # # resp = client.delete_sync_job({ # workspace_id: "Id", # required # sync_source: "SyncSource", # required # }) # # @example Response structure # # resp.state #=> String, one of "CREATING", "INITIALIZING", "ACTIVE", "DELETING", "ERROR" # # @overload delete_sync_job(params = {}) # @param [Hash] params ({}) def delete_sync_job(params = {}, options = {}) req = build_request(:delete_sync_job, params) req.send_request(options) end # Deletes a workspace. # # @option params [required, String] :workspace_id # The ID of the workspace to delete. # # @return [Types::DeleteWorkspaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteWorkspaceResponse#message #message} => String # # @example Request syntax with placeholder values # # resp = client.delete_workspace({ # workspace_id: "Id", # required # }) # # @example Response structure # # resp.message #=> String # # @overload delete_workspace(params = {}) # @param [Hash] params ({}) def delete_workspace(params = {}, options = {}) req = build_request(:delete_workspace, params) req.send_request(options) end # Run queries to access information from your knowledge graph of # entities within individual workspaces. # # The ExecuteQuery action only works with [Amazon Web Services Java # SDK2][1]. ExecuteQuery will not work with any Amazon Web Services Java # SDK version < 2.x. # # # # # # [1]: https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/home.html # # @option params [required, String] :workspace_id # The ID of the workspace. # # @option params [required, String] :query_statement # The query statement. # # @option params [Integer] :max_results # The maximum number of results to return at one time. The default is # 50. # # @option params [String] :next_token # The string that specifies the next page of results. # # @return [Types::ExecuteQueryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ExecuteQueryResponse#column_descriptions #column_descriptions} => Array<Types::ColumnDescription> # * {Types::ExecuteQueryResponse#rows #rows} => Array<Types::Row> # * {Types::ExecuteQueryResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.execute_query({ # workspace_id: "Id", # required # query_statement: "QueryStatement", # required # max_results: 1, # next_token: "NextToken", # }) # # @example Response structure # # resp.column_descriptions #=> Array # resp.column_descriptions[0].name #=> String # resp.column_descriptions[0].type #=> String, one of "NODE", "EDGE", "VALUE" # resp.rows #=> Array # resp.rows[0].row_data #=> Array # resp.next_token #=> String # # @overload execute_query(params = {}) # @param [Hash] params ({}) def execute_query(params = {}, options = {}) req = build_request(:execute_query, params) req.send_request(options) end # Retrieves information about a component type. # # @option params [required, String] :workspace_id # The ID of the workspace that contains the component type. # # @option params [required, String] :component_type_id # The ID of the component type. # # @return [Types::GetComponentTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetComponentTypeResponse#workspace_id #workspace_id} => String # * {Types::GetComponentTypeResponse#is_singleton #is_singleton} => Boolean # * {Types::GetComponentTypeResponse#component_type_id #component_type_id} => String # * {Types::GetComponentTypeResponse#description #description} => String # * {Types::GetComponentTypeResponse#property_definitions #property_definitions} => Hash<String,Types::PropertyDefinitionResponse> # * {Types::GetComponentTypeResponse#extends_from #extends_from} => Array<String> # * {Types::GetComponentTypeResponse#functions #functions} => Hash<String,Types::FunctionResponse> # * {Types::GetComponentTypeResponse#creation_date_time #creation_date_time} => Time # * {Types::GetComponentTypeResponse#update_date_time #update_date_time} => Time # * {Types::GetComponentTypeResponse#arn #arn} => String # * {Types::GetComponentTypeResponse#is_abstract #is_abstract} => Boolean # * {Types::GetComponentTypeResponse#is_schema_initialized #is_schema_initialized} => Boolean # * {Types::GetComponentTypeResponse#status #status} => Types::Status # * {Types::GetComponentTypeResponse#property_groups #property_groups} => Hash<String,Types::PropertyGroupResponse> # * {Types::GetComponentTypeResponse#sync_source #sync_source} => String # * {Types::GetComponentTypeResponse#component_type_name #component_type_name} => String # * {Types::GetComponentTypeResponse#composite_component_types #composite_component_types} => Hash<String,Types::CompositeComponentTypeResponse> # # @example Request syntax with placeholder values # # resp = client.get_component_type({ # workspace_id: "Id", # required # component_type_id: "ComponentTypeId", # required # }) # # @example Response structure # # resp.workspace_id #=> String # resp.is_singleton #=> Boolean # resp.component_type_id #=> String # resp.description #=> String # resp.property_definitions #=> Hash # resp.property_definitions["Name"].data_type.type #=> String, one of "RELATIONSHIP", "STRING", "LONG", "BOOLEAN", "INTEGER", "DOUBLE", "LIST", "MAP" # resp.property_definitions["Name"].data_type.nested_type #=> Types::DataType # resp.property_definitions["Name"].data_type.allowed_values #=> Array # resp.property_definitions["Name"].data_type.allowed_values[0].boolean_value #=> Boolean # resp.property_definitions["Name"].data_type.allowed_values[0].double_value #=> Float # resp.property_definitions["Name"].data_type.allowed_values[0].integer_value #=> Integer # resp.property_definitions["Name"].data_type.allowed_values[0].long_value #=> Integer # resp.property_definitions["Name"].data_type.allowed_values[0].string_value #=> String # resp.property_definitions["Name"].data_type.allowed_values[0].list_value #=> Types::DataValueList # resp.property_definitions["Name"].data_type.allowed_values[0].map_value #=> Hash # resp.property_definitions["Name"].data_type.allowed_values[0].map_value["String"] #=> Types::DataValue # resp.property_definitions["Name"].data_type.allowed_values[0].relationship_value.target_entity_id #=> String # resp.property_definitions["Name"].data_type.allowed_values[0].relationship_value.target_component_name #=> String # resp.property_definitions["Name"].data_type.allowed_values[0].expression #=> String # resp.property_definitions["Name"].data_type.unit_of_measure #=> String # resp.property_definitions["Name"].data_type.relationship.target_component_type_id #=> String # resp.property_definitions["Name"].data_type.relationship.relationship_type #=> String # resp.property_definitions["Name"].is_time_series #=> Boolean # resp.property_definitions["Name"].is_required_in_entity #=> Boolean # resp.property_definitions["Name"].is_external_id #=> Boolean # resp.property_definitions["Name"].is_stored_externally #=> Boolean # resp.property_definitions["Name"].is_imported #=> Boolean # resp.property_definitions["Name"].is_final #=> Boolean # resp.property_definitions["Name"].is_inherited #=> Boolean # resp.property_definitions["Name"].default_value.boolean_value #=> Boolean # resp.property_definitions["Name"].default_value.double_value #=> Float # resp.property_definitions["Name"].default_value.integer_value #=> Integer # resp.property_definitions["Name"].default_value.long_value #=> Integer # resp.property_definitions["Name"].default_value.string_value #=> String # resp.property_definitions["Name"].default_value.list_value #=> Array # resp.property_definitions["Name"].default_value.list_value[0] #=> Types::DataValue # resp.property_definitions["Name"].default_value.map_value #=> Hash # resp.property_definitions["Name"].default_value.map_value["String"] #=> Types::DataValue # resp.property_definitions["Name"].default_value.relationship_value.target_entity_id #=> String # resp.property_definitions["Name"].default_value.relationship_value.target_component_name #=> String # resp.property_definitions["Name"].default_value.expression #=> String # resp.property_definitions["Name"].configuration #=> Hash # resp.property_definitions["Name"].configuration["Name"] #=> String # resp.property_definitions["Name"].display_name #=> String # resp.extends_from #=> Array # resp.extends_from[0] #=> String # resp.functions #=> Hash # resp.functions["Name"].required_properties #=> Array # resp.functions["Name"].required_properties[0] #=> String # resp.functions["Name"].scope #=> String, one of "ENTITY", "WORKSPACE" # resp.functions["Name"].implemented_by.lambda.arn #=> String # resp.functions["Name"].implemented_by.is_native #=> Boolean # resp.functions["Name"].is_inherited #=> Boolean # resp.creation_date_time #=> Time # resp.update_date_time #=> Time # resp.arn #=> String # resp.is_abstract #=> Boolean # resp.is_schema_initialized #=> Boolean # resp.status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR" # resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE" # resp.status.error.message #=> String # resp.property_groups #=> Hash # resp.property_groups["Name"].group_type #=> String, one of "TABULAR" # resp.property_groups["Name"].property_names #=> Array # resp.property_groups["Name"].property_names[0] #=> String # resp.property_groups["Name"].is_inherited #=> Boolean # resp.sync_source #=> String # resp.component_type_name #=> String # resp.composite_component_types #=> Hash # resp.composite_component_types["Name"].component_type_id #=> String # resp.composite_component_types["Name"].is_inherited #=> Boolean # # @overload get_component_type(params = {}) # @param [Hash] params ({}) def get_component_type(params = {}, options = {}) req = build_request(:get_component_type, params) req.send_request(options) end # Retrieves information about an entity. # # @option params [required, String] :workspace_id # The ID of the workspace. # # @option params [required, String] :entity_id # The ID of the entity. # # @return [Types::GetEntityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetEntityResponse#entity_id #entity_id} => String # * {Types::GetEntityResponse#entity_name #entity_name} => String # * {Types::GetEntityResponse#arn #arn} => String # * {Types::GetEntityResponse#status #status} => Types::Status # * {Types::GetEntityResponse#workspace_id #workspace_id} => String # * {Types::GetEntityResponse#description #description} => String # * {Types::GetEntityResponse#components #components} => Hash<String,Types::ComponentResponse> # * {Types::GetEntityResponse#parent_entity_id #parent_entity_id} => String # * {Types::GetEntityResponse#has_child_entities #has_child_entities} => Boolean # * {Types::GetEntityResponse#creation_date_time #creation_date_time} => Time # * {Types::GetEntityResponse#update_date_time #update_date_time} => Time # * {Types::GetEntityResponse#sync_source #sync_source} => String # * {Types::GetEntityResponse#are_all_components_returned #are_all_components_returned} => Boolean # # @example Request syntax with placeholder values # # resp = client.get_entity({ # workspace_id: "Id", # required # entity_id: "EntityId", # required # }) # # @example Response structure # # resp.entity_id #=> String # resp.entity_name #=> String # resp.arn #=> String # resp.status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR" # resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE" # resp.status.error.message #=> String # resp.workspace_id #=> String # resp.description #=> String # resp.components #=> Hash # resp.components["Name"].component_name #=> String # resp.components["Name"].description #=> String # resp.components["Name"].component_type_id #=> String # resp.components["Name"].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR" # resp.components["Name"].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE" # resp.components["Name"].status.error.message #=> String # resp.components["Name"].defined_in #=> String # resp.components["Name"].properties #=> Hash # resp.components["Name"].properties["Name"].definition.data_type.type #=> String, one of "RELATIONSHIP", "STRING", "LONG", "BOOLEAN", "INTEGER", "DOUBLE", "LIST", "MAP" # resp.components["Name"].properties["Name"].definition.data_type.nested_type #=> Types::DataType # resp.components["Name"].properties["Name"].definition.data_type.allowed_values #=> Array # resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].boolean_value #=> Boolean # resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].double_value #=> Float # resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].integer_value #=> Integer # resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].long_value #=> Integer # resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].string_value #=> String # resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].list_value #=> Types::DataValueList # resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].map_value #=> Hash # resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].map_value["String"] #=> Types::DataValue # resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].relationship_value.target_entity_id #=> String # resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].relationship_value.target_component_name #=> String # resp.components["Name"].properties["Name"].definition.data_type.allowed_values[0].expression #=> String # resp.components["Name"].properties["Name"].definition.data_type.unit_of_measure #=> String # resp.components["Name"].properties["Name"].definition.data_type.relationship.target_component_type_id #=> String # resp.components["Name"].properties["Name"].definition.data_type.relationship.relationship_type #=> String # resp.components["Name"].properties["Name"].definition.is_time_series #=> Boolean # resp.components["Name"].properties["Name"].definition.is_required_in_entity #=> Boolean # resp.components["Name"].properties["Name"].definition.is_external_id #=> Boolean # resp.components["Name"].properties["Name"].definition.is_stored_externally #=> Boolean # resp.components["Name"].properties["Name"].definition.is_imported #=> Boolean # resp.components["Name"].properties["Name"].definition.is_final #=> Boolean # resp.components["Name"].properties["Name"].definition.is_inherited #=> Boolean # resp.components["Name"].properties["Name"].definition.default_value.boolean_value #=> Boolean # resp.components["Name"].properties["Name"].definition.default_value.double_value #=> Float # resp.components["Name"].properties["Name"].definition.default_value.integer_value #=> Integer # resp.components["Name"].properties["Name"].definition.default_value.long_value #=> Integer # resp.components["Name"].properties["Name"].definition.default_value.string_value #=> String # resp.components["Name"].properties["Name"].definition.default_value.list_value #=> Array # resp.components["Name"].properties["Name"].definition.default_value.list_value[0] #=> Types::DataValue # resp.components["Name"].properties["Name"].definition.default_value.map_value #=> Hash # resp.components["Name"].properties["Name"].definition.default_value.map_value["String"] #=> Types::DataValue # resp.components["Name"].properties["Name"].definition.default_value.relationship_value.target_entity_id #=> String # resp.components["Name"].properties["Name"].definition.default_value.relationship_value.target_component_name #=> String # resp.components["Name"].properties["Name"].definition.default_value.expression #=> String # resp.components["Name"].properties["Name"].definition.configuration #=> Hash # resp.components["Name"].properties["Name"].definition.configuration["Name"] #=> String # resp.components["Name"].properties["Name"].definition.display_name #=> String # resp.components["Name"].properties["Name"].value.boolean_value #=> Boolean # resp.components["Name"].properties["Name"].value.double_value #=> Float # resp.components["Name"].properties["Name"].value.integer_value #=> Integer # resp.components["Name"].properties["Name"].value.long_value #=> Integer # resp.components["Name"].properties["Name"].value.string_value #=> String # resp.components["Name"].properties["Name"].value.list_value #=> Array # resp.components["Name"].properties["Name"].value.list_value[0] #=> Types::DataValue # resp.components["Name"].properties["Name"].value.map_value #=> Hash # resp.components["Name"].properties["Name"].value.map_value["String"] #=> Types::DataValue # resp.components["Name"].properties["Name"].value.relationship_value.target_entity_id #=> String # resp.components["Name"].properties["Name"].value.relationship_value.target_component_name #=> String # resp.components["Name"].properties["Name"].value.expression #=> String # resp.components["Name"].properties["Name"].are_all_property_values_returned #=> Boolean # resp.components["Name"].property_groups #=> Hash # resp.components["Name"].property_groups["Name"].group_type #=> String, one of "TABULAR" # resp.components["Name"].property_groups["Name"].property_names #=> Array # resp.components["Name"].property_groups["Name"].property_names[0] #=> String # resp.components["Name"].property_groups["Name"].is_inherited #=> Boolean # resp.components["Name"].sync_source #=> String # resp.components["Name"].are_all_properties_returned #=> Boolean # resp.components["Name"].composite_components #=> Hash # resp.components["Name"].composite_components["Name"].component_name #=> String # resp.components["Name"].composite_components["Name"].component_type_id #=> String # resp.components["Name"].composite_components["Name"].defined_in #=> String # resp.components["Name"].composite_components["Name"].description #=> String # resp.components["Name"].composite_components["Name"].property_groups #=> Hash # resp.components["Name"].composite_components["Name"].property_groups["Name"].group_type #=> String, one of "TABULAR" # resp.components["Name"].composite_components["Name"].property_groups["Name"].property_names #=> Array # resp.components["Name"].composite_components["Name"].property_groups["Name"].property_names[0] #=> String # resp.components["Name"].composite_components["Name"].property_groups["Name"].is_inherited #=> Boolean # resp.components["Name"].composite_components["Name"].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR" # resp.components["Name"].composite_components["Name"].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE" # resp.components["Name"].composite_components["Name"].status.error.message #=> String # resp.components["Name"].composite_components["Name"].sync_source #=> String # resp.components["Name"].composite_components["Name"].component_path #=> String # resp.components["Name"].are_all_composite_components_returned #=> Boolean # resp.parent_entity_id #=> String # resp.has_child_entities #=> Boolean # resp.creation_date_time #=> Time # resp.update_date_time #=> Time # resp.sync_source #=> String # resp.are_all_components_returned #=> Boolean # # @overload get_entity(params = {}) # @param [Hash] params ({}) def get_entity(params = {}, options = {}) req = build_request(:get_entity, params) req.send_request(options) end # Gets a nmetadata transfer job. # # @option params [required, String] :metadata_transfer_job_id # The metadata transfer job Id. # # @return [Types::GetMetadataTransferJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetMetadataTransferJobResponse#metadata_transfer_job_id #metadata_transfer_job_id} => String # * {Types::GetMetadataTransferJobResponse#arn #arn} => String # * {Types::GetMetadataTransferJobResponse#description #description} => String # * {Types::GetMetadataTransferJobResponse#sources #sources} => Array<Types::SourceConfiguration> # * {Types::GetMetadataTransferJobResponse#destination #destination} => Types::DestinationConfiguration # * {Types::GetMetadataTransferJobResponse#metadata_transfer_job_role #metadata_transfer_job_role} => String # * {Types::GetMetadataTransferJobResponse#report_url #report_url} => String # * {Types::GetMetadataTransferJobResponse#creation_date_time #creation_date_time} => Time # * {Types::GetMetadataTransferJobResponse#update_date_time #update_date_time} => Time # * {Types::GetMetadataTransferJobResponse#status #status} => Types::MetadataTransferJobStatus # * {Types::GetMetadataTransferJobResponse#progress #progress} => Types::MetadataTransferJobProgress # # @example Request syntax with placeholder values # # resp = client.get_metadata_transfer_job({ # metadata_transfer_job_id: "Id", # required # }) # # @example Response structure # # resp.metadata_transfer_job_id #=> String # resp.arn #=> String # resp.description #=> String # resp.sources #=> Array # resp.sources[0].type #=> String, one of "s3", "iotsitewise", "iottwinmaker" # resp.sources[0].s3_configuration.location #=> String # resp.sources[0].iot_site_wise_configuration.filters #=> Array # resp.sources[0].iot_site_wise_configuration.filters[0].filter_by_asset_model.asset_model_id #=> String # resp.sources[0].iot_site_wise_configuration.filters[0].filter_by_asset_model.asset_model_external_id #=> String # resp.sources[0].iot_site_wise_configuration.filters[0].filter_by_asset_model.include_offspring #=> Boolean # resp.sources[0].iot_site_wise_configuration.filters[0].filter_by_asset_model.include_assets #=> Boolean # resp.sources[0].iot_site_wise_configuration.filters[0].filter_by_asset.asset_id #=> String # resp.sources[0].iot_site_wise_configuration.filters[0].filter_by_asset.asset_external_id #=> String # resp.sources[0].iot_site_wise_configuration.filters[0].filter_by_asset.include_offspring #=> Boolean # resp.sources[0].iot_site_wise_configuration.filters[0].filter_by_asset.include_asset_model #=> Boolean # resp.sources[0].iot_twin_maker_configuration.workspace #=> String # resp.sources[0].iot_twin_maker_configuration.filters #=> Array # resp.sources[0].iot_twin_maker_configuration.filters[0].filter_by_component_type.component_type_id #=> String # resp.sources[0].iot_twin_maker_configuration.filters[0].filter_by_entity.entity_id #=> String # resp.destination.type #=> String, one of "s3", "iotsitewise", "iottwinmaker" # resp.destination.s3_configuration.location #=> String # resp.destination.iot_twin_maker_configuration.workspace #=> String # resp.metadata_transfer_job_role #=> String # resp.report_url #=> String # resp.creation_date_time #=> Time # resp.update_date_time #=> Time # resp.status.state #=> String, one of "VALIDATING", "PENDING", "RUNNING", "CANCELLING", "ERROR", "COMPLETED", "CANCELLED" # resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE" # resp.status.error.message #=> String # resp.status.queued_position #=> Integer # resp.progress.total_count #=> Integer # resp.progress.succeeded_count #=> Integer # resp.progress.skipped_count #=> Integer # resp.progress.failed_count #=> Integer # # @overload get_metadata_transfer_job(params = {}) # @param [Hash] params ({}) def get_metadata_transfer_job(params = {}, options = {}) req = build_request(:get_metadata_transfer_job, params) req.send_request(options) end # Gets the pricing plan. # # @return [Types::GetPricingPlanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetPricingPlanResponse#current_pricing_plan #current_pricing_plan} => Types::PricingPlan # * {Types::GetPricingPlanResponse#pending_pricing_plan #pending_pricing_plan} => Types::PricingPlan # # @example Response structure # # resp.current_pricing_plan.billable_entity_count #=> Integer # resp.current_pricing_plan.bundle_information.bundle_names #=> Array # resp.current_pricing_plan.bundle_information.bundle_names[0] #=> String # resp.current_pricing_plan.bundle_information.pricing_tier #=> String, one of "TIER_1", "TIER_2", "TIER_3", "TIER_4" # resp.current_pricing_plan.effective_date_time #=> Time # resp.current_pricing_plan.pricing_mode #=> String, one of "BASIC", "STANDARD", "TIERED_BUNDLE" # resp.current_pricing_plan.update_date_time #=> Time # resp.current_pricing_plan.update_reason #=> String, one of "DEFAULT", "PRICING_TIER_UPDATE", "ENTITY_COUNT_UPDATE", "PRICING_MODE_UPDATE", "OVERWRITTEN" # resp.pending_pricing_plan.billable_entity_count #=> Integer # resp.pending_pricing_plan.bundle_information.bundle_names #=> Array # resp.pending_pricing_plan.bundle_information.bundle_names[0] #=> String # resp.pending_pricing_plan.bundle_information.pricing_tier #=> String, one of "TIER_1", "TIER_2", "TIER_3", "TIER_4" # resp.pending_pricing_plan.effective_date_time #=> Time # resp.pending_pricing_plan.pricing_mode #=> String, one of "BASIC", "STANDARD", "TIERED_BUNDLE" # resp.pending_pricing_plan.update_date_time #=> Time # resp.pending_pricing_plan.update_reason #=> String, one of "DEFAULT", "PRICING_TIER_UPDATE", "ENTITY_COUNT_UPDATE", "PRICING_MODE_UPDATE", "OVERWRITTEN" # # @overload get_pricing_plan(params = {}) # @param [Hash] params ({}) def get_pricing_plan(params = {}, options = {}) req = build_request(:get_pricing_plan, params) req.send_request(options) end # Gets the property values for a component, component type, entity, or # workspace. # # You must specify a value for either `componentName`, # `componentTypeId`, `entityId`, or `workspaceId`. # # @option params [String] :component_name # The name of the component whose property values the operation returns. # # @option params [String] :component_path # This string specifies the path to the composite component, starting # from the top-level component. # # @option params [String] :component_type_id # The ID of the component type whose property values the operation # returns. # # @option params [String] :entity_id # The ID of the entity whose property values the operation returns. # # @option params [required, Array] :selected_properties # The properties whose values the operation returns. # # @option params [required, String] :workspace_id # The ID of the workspace whose values the operation returns. # # @option params [Integer] :max_results # The maximum number of results to return at one time. The default is # 25. # # Valid Range: Minimum value of 1. Maximum value of 250. # # @option params [String] :next_token # The string that specifies the next page of results. # # @option params [String] :property_group_name # The property group name. # # @option params [Types::TabularConditions] :tabular_conditions # The tabular conditions. # # @return [Types::GetPropertyValueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetPropertyValueResponse#property_values #property_values} => Hash<String,Types::PropertyLatestValue> # * {Types::GetPropertyValueResponse#next_token #next_token} => String # * {Types::GetPropertyValueResponse#tabular_property_values #tabular_property_values} => Array<Array<Hash<String,Types::DataValue>>> # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.get_property_value({ # component_name: "Name", # component_path: "ComponentPath", # component_type_id: "ComponentTypeId", # entity_id: "EntityId", # selected_properties: ["String"], # required # workspace_id: "Id", # required # max_results: 1, # next_token: "NextToken", # property_group_name: "Name", # tabular_conditions: { # order_by: [ # { # order: "ASCENDING", # accepts ASCENDING, DESCENDING # property_name: "String", # required # }, # ], # property_filters: [ # { # property_name: "String", # operator: "String", # value: { # boolean_value: false, # double_value: 1.0, # integer_value: 1, # long_value: 1, # string_value: "String", # list_value: [ # { # # recursive DataValue # }, # ], # map_value: { # "String" => { # # recursive DataValue # }, # }, # relationship_value: { # target_entity_id: "EntityId", # target_component_name: "Name", # }, # expression: "Expression", # }, # }, # ], # }, # }) # # @example Response structure # # resp.property_values #=> Hash # resp.property_values["Name"].property_reference.component_name #=> String # resp.property_values["Name"].property_reference.component_path #=> String # resp.property_values["Name"].property_reference.external_id_property #=> Hash # resp.property_values["Name"].property_reference.external_id_property["String"] #=> String # resp.property_values["Name"].property_reference.entity_id #=> String # resp.property_values["Name"].property_reference.property_name #=> String # resp.property_values["Name"].property_value.boolean_value #=> Boolean # resp.property_values["Name"].property_value.double_value #=> Float # resp.property_values["Name"].property_value.integer_value #=> Integer # resp.property_values["Name"].property_value.long_value #=> Integer # resp.property_values["Name"].property_value.string_value #=> String # resp.property_values["Name"].property_value.list_value #=> Array # resp.property_values["Name"].property_value.list_value[0] #=> Types::DataValue # resp.property_values["Name"].property_value.map_value #=> Hash # resp.property_values["Name"].property_value.map_value["String"] #=> Types::DataValue # resp.property_values["Name"].property_value.relationship_value.target_entity_id #=> String # resp.property_values["Name"].property_value.relationship_value.target_component_name #=> String # resp.property_values["Name"].property_value.expression #=> String # resp.next_token #=> String # resp.tabular_property_values #=> Array # resp.tabular_property_values[0] #=> Array # resp.tabular_property_values[0][0] #=> Hash # resp.tabular_property_values[0][0]["Name"].boolean_value #=> Boolean # resp.tabular_property_values[0][0]["Name"].double_value #=> Float # resp.tabular_property_values[0][0]["Name"].integer_value #=> Integer # resp.tabular_property_values[0][0]["Name"].long_value #=> Integer # resp.tabular_property_values[0][0]["Name"].string_value #=> String # resp.tabular_property_values[0][0]["Name"].list_value #=> Array # resp.tabular_property_values[0][0]["Name"].list_value[0] #=> Types::DataValue # resp.tabular_property_values[0][0]["Name"].map_value #=> Hash # resp.tabular_property_values[0][0]["Name"].map_value["String"] #=> Types::DataValue # resp.tabular_property_values[0][0]["Name"].relationship_value.target_entity_id #=> String # resp.tabular_property_values[0][0]["Name"].relationship_value.target_component_name #=> String # resp.tabular_property_values[0][0]["Name"].expression #=> String # # @overload get_property_value(params = {}) # @param [Hash] params ({}) def get_property_value(params = {}, options = {}) req = build_request(:get_property_value, params) req.send_request(options) end # Retrieves information about the history of a time series property # value for a component, component type, entity, or workspace. # # You must specify a value for `workspaceId`. For entity-specific # queries, specify values for `componentName` and `entityId`. For # cross-entity quries, specify a value for `componentTypeId`. # # @option params [required, String] :workspace_id # The ID of the workspace. # # @option params [String] :entity_id # The ID of the entity. # # @option params [String] :component_name # The name of the component. # # @option params [String] :component_path # This string specifies the path to the composite component, starting # from the top-level component. # # @option params [String] :component_type_id # The ID of the component type. # # @option params [required, Array] :selected_properties # A list of properties whose value histories the request retrieves. # # @option params [Array] :property_filters # A list of objects that filter the property value history request. # # @option params [Time,DateTime,Date,Integer,String] :start_date_time # The date and time of the earliest property value to return. # # @option params [Time,DateTime,Date,Integer,String] :end_date_time # The date and time of the latest property value to return. # # @option params [Types::InterpolationParameters] :interpolation # An object that specifies the interpolation type and the interval over # which to interpolate data. # # @option params [String] :next_token # The string that specifies the next page of results. # # @option params [Integer] :max_results # The maximum number of results to return at one time. The default is # 25. # # Valid Range: Minimum value of 1. Maximum value of 250. # # @option params [String] :order_by_time # The time direction to use in the result order. # # @option params [String] :start_time # The ISO8601 DateTime of the earliest property value to return. # # For more information about the ISO8601 DateTime format, see the data # type [PropertyValue][1]. # # # # [1]: https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html # # @option params [String] :end_time # The ISO8601 DateTime of the latest property value to return. # # For more information about the ISO8601 DateTime format, see the data # type [PropertyValue][1]. # # # # [1]: https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_PropertyValue.html # # @return [Types::GetPropertyValueHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetPropertyValueHistoryResponse#property_values #property_values} => Array<Types::PropertyValueHistory> # * {Types::GetPropertyValueHistoryResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.get_property_value_history({ # workspace_id: "Id", # required # entity_id: "EntityId", # component_name: "Name", # component_path: "ComponentPath", # component_type_id: "ComponentTypeId", # selected_properties: ["String"], # required # property_filters: [ # { # property_name: "String", # operator: "String", # value: { # boolean_value: false, # double_value: 1.0, # integer_value: 1, # long_value: 1, # string_value: "String", # list_value: [ # { # # recursive DataValue # }, # ], # map_value: { # "String" => { # # recursive DataValue # }, # }, # relationship_value: { # target_entity_id: "EntityId", # target_component_name: "Name", # }, # expression: "Expression", # }, # }, # ], # start_date_time: Time.now, # end_date_time: Time.now, # interpolation: { # interpolation_type: "LINEAR", # accepts LINEAR # interval_in_seconds: 1, # }, # next_token: "NextToken", # max_results: 1, # order_by_time: "ASCENDING", # accepts ASCENDING, DESCENDING # start_time: "Time", # end_time: "Time", # }) # # @example Response structure # # resp.property_values #=> Array # resp.property_values[0].entity_property_reference.component_name #=> String # resp.property_values[0].entity_property_reference.component_path #=> String # resp.property_values[0].entity_property_reference.external_id_property #=> Hash # resp.property_values[0].entity_property_reference.external_id_property["String"] #=> String # resp.property_values[0].entity_property_reference.entity_id #=> String # resp.property_values[0].entity_property_reference.property_name #=> String # resp.property_values[0].values #=> Array # resp.property_values[0].values[0].timestamp #=> Time # resp.property_values[0].values[0].value.boolean_value #=> Boolean # resp.property_values[0].values[0].value.double_value #=> Float # resp.property_values[0].values[0].value.integer_value #=> Integer # resp.property_values[0].values[0].value.long_value #=> Integer # resp.property_values[0].values[0].value.string_value #=> String # resp.property_values[0].values[0].value.list_value #=> Array # resp.property_values[0].values[0].value.list_value[0] #=> Types::DataValue # resp.property_values[0].values[0].value.map_value #=> Hash # resp.property_values[0].values[0].value.map_value["String"] #=> Types::DataValue # resp.property_values[0].values[0].value.relationship_value.target_entity_id #=> String # resp.property_values[0].values[0].value.relationship_value.target_component_name #=> String # resp.property_values[0].values[0].value.expression #=> String # resp.property_values[0].values[0].time #=> String # resp.next_token #=> String # # @overload get_property_value_history(params = {}) # @param [Hash] params ({}) def get_property_value_history(params = {}, options = {}) req = build_request(:get_property_value_history, params) req.send_request(options) end # Retrieves information about a scene. # # @option params [required, String] :workspace_id # The ID of the workspace that contains the scene. # # @option params [required, String] :scene_id # The ID of the scene. # # @return [Types::GetSceneResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetSceneResponse#workspace_id #workspace_id} => String # * {Types::GetSceneResponse#scene_id #scene_id} => String # * {Types::GetSceneResponse#content_location #content_location} => String # * {Types::GetSceneResponse#arn #arn} => String # * {Types::GetSceneResponse#creation_date_time #creation_date_time} => Time # * {Types::GetSceneResponse#update_date_time #update_date_time} => Time # * {Types::GetSceneResponse#description #description} => String # * {Types::GetSceneResponse#capabilities #capabilities} => Array<String> # * {Types::GetSceneResponse#scene_metadata #scene_metadata} => Hash<String,String> # * {Types::GetSceneResponse#generated_scene_metadata #generated_scene_metadata} => Hash<String,String> # * {Types::GetSceneResponse#error #error} => Types::SceneError # # @example Request syntax with placeholder values # # resp = client.get_scene({ # workspace_id: "Id", # required # scene_id: "Id", # required # }) # # @example Response structure # # resp.workspace_id #=> String # resp.scene_id #=> String # resp.content_location #=> String # resp.arn #=> String # resp.creation_date_time #=> Time # resp.update_date_time #=> Time # resp.description #=> String # resp.capabilities #=> Array # resp.capabilities[0] #=> String # resp.scene_metadata #=> Hash # resp.scene_metadata["Name"] #=> String # resp.generated_scene_metadata #=> Hash # resp.generated_scene_metadata["Name"] #=> String # resp.error.code #=> String, one of "MATTERPORT_ERROR" # resp.error.message #=> String # # @overload get_scene(params = {}) # @param [Hash] params ({}) def get_scene(params = {}, options = {}) req = build_request(:get_scene, params) req.send_request(options) end # Gets the SyncJob. # # @option params [required, String] :sync_source # The sync source. # # Currently the only supported syncSource is `SITEWISE `. # # # # @option params [String] :workspace_id # The workspace ID. # # @return [Types::GetSyncJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetSyncJobResponse#arn #arn} => String # * {Types::GetSyncJobResponse#workspace_id #workspace_id} => String # * {Types::GetSyncJobResponse#sync_source #sync_source} => String # * {Types::GetSyncJobResponse#sync_role #sync_role} => String # * {Types::GetSyncJobResponse#status #status} => Types::SyncJobStatus # * {Types::GetSyncJobResponse#creation_date_time #creation_date_time} => Time # * {Types::GetSyncJobResponse#update_date_time #update_date_time} => Time # # @example Request syntax with placeholder values # # resp = client.get_sync_job({ # sync_source: "SyncSource", # required # workspace_id: "Id", # }) # # @example Response structure # # resp.arn #=> String # resp.workspace_id #=> String # resp.sync_source #=> String # resp.sync_role #=> String # resp.status.state #=> String, one of "CREATING", "INITIALIZING", "ACTIVE", "DELETING", "ERROR" # resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE" # resp.status.error.message #=> String # resp.creation_date_time #=> Time # resp.update_date_time #=> Time # # @overload get_sync_job(params = {}) # @param [Hash] params ({}) def get_sync_job(params = {}, options = {}) req = build_request(:get_sync_job, params) req.send_request(options) end # Retrieves information about a workspace. # # @option params [required, String] :workspace_id # The ID of the workspace. # # @return [Types::GetWorkspaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetWorkspaceResponse#workspace_id #workspace_id} => String # * {Types::GetWorkspaceResponse#arn #arn} => String # * {Types::GetWorkspaceResponse#description #description} => String # * {Types::GetWorkspaceResponse#linked_services #linked_services} => Array<String> # * {Types::GetWorkspaceResponse#s3_location #s3_location} => String # * {Types::GetWorkspaceResponse#role #role} => String # * {Types::GetWorkspaceResponse#creation_date_time #creation_date_time} => Time # * {Types::GetWorkspaceResponse#update_date_time #update_date_time} => Time # # @example Request syntax with placeholder values # # resp = client.get_workspace({ # workspace_id: "IdOrArn", # required # }) # # @example Response structure # # resp.workspace_id #=> String # resp.arn #=> String # resp.description #=> String # resp.linked_services #=> Array # resp.linked_services[0] #=> String # resp.s3_location #=> String # resp.role #=> String # resp.creation_date_time #=> Time # resp.update_date_time #=> Time # # @overload get_workspace(params = {}) # @param [Hash] params ({}) def get_workspace(params = {}, options = {}) req = build_request(:get_workspace, params) req.send_request(options) end # Lists all component types in a workspace. # # @option params [required, String] :workspace_id # The ID of the workspace. # # @option params [Array] :filters # A list of objects that filter the request. # # @option params [String] :next_token # The string that specifies the next page of results. # # @option params [Integer] :max_results # The maximum number of results to return at one time. The default is # 25. # # Valid Range: Minimum value of 1. Maximum value of 250. # # @return [Types::ListComponentTypesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListComponentTypesResponse#workspace_id #workspace_id} => String # * {Types::ListComponentTypesResponse#component_type_summaries #component_type_summaries} => Array<Types::ComponentTypeSummary> # * {Types::ListComponentTypesResponse#next_token #next_token} => String # * {Types::ListComponentTypesResponse#max_results #max_results} => Integer # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_component_types({ # workspace_id: "Id", # required # filters: [ # { # extends_from: "ComponentTypeId", # namespace: "String", # is_abstract: false, # }, # ], # next_token: "NextToken", # max_results: 1, # }) # # @example Response structure # # resp.workspace_id #=> String # resp.component_type_summaries #=> Array # resp.component_type_summaries[0].arn #=> String # resp.component_type_summaries[0].component_type_id #=> String # resp.component_type_summaries[0].creation_date_time #=> Time # resp.component_type_summaries[0].update_date_time #=> Time # resp.component_type_summaries[0].description #=> String # resp.component_type_summaries[0].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR" # resp.component_type_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE" # resp.component_type_summaries[0].status.error.message #=> String # resp.component_type_summaries[0].component_type_name #=> String # resp.next_token #=> String # resp.max_results #=> Integer # # @overload list_component_types(params = {}) # @param [Hash] params ({}) def list_component_types(params = {}, options = {}) req = build_request(:list_component_types, params) req.send_request(options) end # This API lists the components of an entity. # # @option params [required, String] :workspace_id # The workspace ID. # # @option params [required, String] :entity_id # The ID for the entity whose metadata (component/properties) is # returned by the operation. # # @option params [String] :component_path # This string specifies the path to the composite component, starting # from the top-level component. # # @option params [Integer] :max_results # The maximum number of results returned at one time. The default is 25. # # @option params [String] :next_token # The string that specifies the next page of results. # # @return [Types::ListComponentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListComponentsResponse#component_summaries #component_summaries} => Array<Types::ComponentSummary> # * {Types::ListComponentsResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_components({ # workspace_id: "Id", # required # entity_id: "EntityId", # required # component_path: "ComponentPath", # max_results: 1, # next_token: "NextToken", # }) # # @example Response structure # # resp.component_summaries #=> Array # resp.component_summaries[0].component_name #=> String # resp.component_summaries[0].component_type_id #=> String # resp.component_summaries[0].defined_in #=> String # resp.component_summaries[0].description #=> String # resp.component_summaries[0].property_groups #=> Hash # resp.component_summaries[0].property_groups["Name"].group_type #=> String, one of "TABULAR" # resp.component_summaries[0].property_groups["Name"].property_names #=> Array # resp.component_summaries[0].property_groups["Name"].property_names[0] #=> String # resp.component_summaries[0].property_groups["Name"].is_inherited #=> Boolean # resp.component_summaries[0].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR" # resp.component_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE" # resp.component_summaries[0].status.error.message #=> String # resp.component_summaries[0].sync_source #=> String # resp.component_summaries[0].component_path #=> String # resp.next_token #=> String # # @overload list_components(params = {}) # @param [Hash] params ({}) def list_components(params = {}, options = {}) req = build_request(:list_components, params) req.send_request(options) end # Lists all entities in a workspace. # # @option params [required, String] :workspace_id # The ID of the workspace. # # @option params [Array] :filters # A list of objects that filter the request. # # Only one object is accepted as a valid input. # # # # @option params [Integer] :max_results # The maximum number of results to return at one time. The default is # 25. # # Valid Range: Minimum value of 1. Maximum value of 250. # # @option params [String] :next_token # The string that specifies the next page of results. # # @return [Types::ListEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListEntitiesResponse#entity_summaries #entity_summaries} => Array<Types::EntitySummary> # * {Types::ListEntitiesResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_entities({ # workspace_id: "Id", # required # filters: [ # { # parent_entity_id: "ParentEntityId", # component_type_id: "ComponentTypeId", # external_id: "String", # }, # ], # max_results: 1, # next_token: "NextToken", # }) # # @example Response structure # # resp.entity_summaries #=> Array # resp.entity_summaries[0].entity_id #=> String # resp.entity_summaries[0].entity_name #=> String # resp.entity_summaries[0].arn #=> String # resp.entity_summaries[0].parent_entity_id #=> String # resp.entity_summaries[0].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR" # resp.entity_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE" # resp.entity_summaries[0].status.error.message #=> String # resp.entity_summaries[0].description #=> String # resp.entity_summaries[0].has_child_entities #=> Boolean # resp.entity_summaries[0].creation_date_time #=> Time # resp.entity_summaries[0].update_date_time #=> Time # resp.next_token #=> String # # @overload list_entities(params = {}) # @param [Hash] params ({}) def list_entities(params = {}, options = {}) req = build_request(:list_entities, params) req.send_request(options) end # Lists the metadata transfer jobs. # # @option params [required, String] :source_type # The metadata transfer job's source type. # # @option params [required, String] :destination_type # The metadata transfer job's destination type. # # @option params [Array] :filters # An object that filters metadata transfer jobs. # # @option params [String] :next_token # The string that specifies the next page of results. # # @option params [Integer] :max_results # The maximum number of results to return at one time. # # @return [Types::ListMetadataTransferJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListMetadataTransferJobsResponse#metadata_transfer_job_summaries #metadata_transfer_job_summaries} => Array<Types::MetadataTransferJobSummary> # * {Types::ListMetadataTransferJobsResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_metadata_transfer_jobs({ # source_type: "s3", # required, accepts s3, iotsitewise, iottwinmaker # destination_type: "s3", # required, accepts s3, iotsitewise, iottwinmaker # filters: [ # { # workspace_id: "Id", # state: "VALIDATING", # accepts VALIDATING, PENDING, RUNNING, CANCELLING, ERROR, COMPLETED, CANCELLED # }, # ], # next_token: "NextToken", # max_results: 1, # }) # # @example Response structure # # resp.metadata_transfer_job_summaries #=> Array # resp.metadata_transfer_job_summaries[0].metadata_transfer_job_id #=> String # resp.metadata_transfer_job_summaries[0].arn #=> String # resp.metadata_transfer_job_summaries[0].creation_date_time #=> Time # resp.metadata_transfer_job_summaries[0].update_date_time #=> Time # resp.metadata_transfer_job_summaries[0].status.state #=> String, one of "VALIDATING", "PENDING", "RUNNING", "CANCELLING", "ERROR", "COMPLETED", "CANCELLED" # resp.metadata_transfer_job_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE" # resp.metadata_transfer_job_summaries[0].status.error.message #=> String # resp.metadata_transfer_job_summaries[0].status.queued_position #=> Integer # resp.metadata_transfer_job_summaries[0].progress.total_count #=> Integer # resp.metadata_transfer_job_summaries[0].progress.succeeded_count #=> Integer # resp.metadata_transfer_job_summaries[0].progress.skipped_count #=> Integer # resp.metadata_transfer_job_summaries[0].progress.failed_count #=> Integer # resp.next_token #=> String # # @overload list_metadata_transfer_jobs(params = {}) # @param [Hash] params ({}) def list_metadata_transfer_jobs(params = {}, options = {}) req = build_request(:list_metadata_transfer_jobs, params) req.send_request(options) end # This API lists the properties of a component. # # @option params [required, String] :workspace_id # The workspace ID. # # @option params [String] :component_name # The name of the component whose properties are returned by the # operation. # # @option params [String] :component_path # This string specifies the path to the composite component, starting # from the top-level component. # # @option params [required, String] :entity_id # The ID for the entity whose metadata (component/properties) is # returned by the operation. # # @option params [Integer] :max_results # The maximum number of results returned at one time. The default is 25. # # @option params [String] :next_token # The string that specifies the next page of results. # # @return [Types::ListPropertiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListPropertiesResponse#property_summaries #property_summaries} => Array<Types::PropertySummary> # * {Types::ListPropertiesResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_properties({ # workspace_id: "Id", # required # component_name: "Name", # component_path: "ComponentPath", # entity_id: "EntityId", # required # max_results: 1, # next_token: "NextToken", # }) # # @example Response structure # # resp.property_summaries #=> Array # resp.property_summaries[0].definition.data_type.type #=> String, one of "RELATIONSHIP", "STRING", "LONG", "BOOLEAN", "INTEGER", "DOUBLE", "LIST", "MAP" # resp.property_summaries[0].definition.data_type.nested_type #=> Types::DataType # resp.property_summaries[0].definition.data_type.allowed_values #=> Array # resp.property_summaries[0].definition.data_type.allowed_values[0].boolean_value #=> Boolean # resp.property_summaries[0].definition.data_type.allowed_values[0].double_value #=> Float # resp.property_summaries[0].definition.data_type.allowed_values[0].integer_value #=> Integer # resp.property_summaries[0].definition.data_type.allowed_values[0].long_value #=> Integer # resp.property_summaries[0].definition.data_type.allowed_values[0].string_value #=> String # resp.property_summaries[0].definition.data_type.allowed_values[0].list_value #=> Types::DataValueList # resp.property_summaries[0].definition.data_type.allowed_values[0].map_value #=> Hash # resp.property_summaries[0].definition.data_type.allowed_values[0].map_value["String"] #=> Types::DataValue # resp.property_summaries[0].definition.data_type.allowed_values[0].relationship_value.target_entity_id #=> String # resp.property_summaries[0].definition.data_type.allowed_values[0].relationship_value.target_component_name #=> String # resp.property_summaries[0].definition.data_type.allowed_values[0].expression #=> String # resp.property_summaries[0].definition.data_type.unit_of_measure #=> String # resp.property_summaries[0].definition.data_type.relationship.target_component_type_id #=> String # resp.property_summaries[0].definition.data_type.relationship.relationship_type #=> String # resp.property_summaries[0].definition.is_time_series #=> Boolean # resp.property_summaries[0].definition.is_required_in_entity #=> Boolean # resp.property_summaries[0].definition.is_external_id #=> Boolean # resp.property_summaries[0].definition.is_stored_externally #=> Boolean # resp.property_summaries[0].definition.is_imported #=> Boolean # resp.property_summaries[0].definition.is_final #=> Boolean # resp.property_summaries[0].definition.is_inherited #=> Boolean # resp.property_summaries[0].definition.default_value.boolean_value #=> Boolean # resp.property_summaries[0].definition.default_value.double_value #=> Float # resp.property_summaries[0].definition.default_value.integer_value #=> Integer # resp.property_summaries[0].definition.default_value.long_value #=> Integer # resp.property_summaries[0].definition.default_value.string_value #=> String # resp.property_summaries[0].definition.default_value.list_value #=> Array # resp.property_summaries[0].definition.default_value.list_value[0] #=> Types::DataValue # resp.property_summaries[0].definition.default_value.map_value #=> Hash # resp.property_summaries[0].definition.default_value.map_value["String"] #=> Types::DataValue # resp.property_summaries[0].definition.default_value.relationship_value.target_entity_id #=> String # resp.property_summaries[0].definition.default_value.relationship_value.target_component_name #=> String # resp.property_summaries[0].definition.default_value.expression #=> String # resp.property_summaries[0].definition.configuration #=> Hash # resp.property_summaries[0].definition.configuration["Name"] #=> String # resp.property_summaries[0].definition.display_name #=> String # resp.property_summaries[0].property_name #=> String # resp.property_summaries[0].value.boolean_value #=> Boolean # resp.property_summaries[0].value.double_value #=> Float # resp.property_summaries[0].value.integer_value #=> Integer # resp.property_summaries[0].value.long_value #=> Integer # resp.property_summaries[0].value.string_value #=> String # resp.property_summaries[0].value.list_value #=> Array # resp.property_summaries[0].value.list_value[0] #=> Types::DataValue # resp.property_summaries[0].value.map_value #=> Hash # resp.property_summaries[0].value.map_value["String"] #=> Types::DataValue # resp.property_summaries[0].value.relationship_value.target_entity_id #=> String # resp.property_summaries[0].value.relationship_value.target_component_name #=> String # resp.property_summaries[0].value.expression #=> String # resp.property_summaries[0].are_all_property_values_returned #=> Boolean # resp.next_token #=> String # # @overload list_properties(params = {}) # @param [Hash] params ({}) def list_properties(params = {}, options = {}) req = build_request(:list_properties, params) req.send_request(options) end # Lists all scenes in a workspace. # # @option params [required, String] :workspace_id # The ID of the workspace that contains the scenes. # # @option params [Integer] :max_results # Specifies the maximum number of results to display. # # @option params [String] :next_token # The string that specifies the next page of results. # # @return [Types::ListScenesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListScenesResponse#scene_summaries #scene_summaries} => Array<Types::SceneSummary> # * {Types::ListScenesResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_scenes({ # workspace_id: "Id", # required # max_results: 1, # next_token: "NextToken", # }) # # @example Response structure # # resp.scene_summaries #=> Array # resp.scene_summaries[0].scene_id #=> String # resp.scene_summaries[0].content_location #=> String # resp.scene_summaries[0].arn #=> String # resp.scene_summaries[0].creation_date_time #=> Time # resp.scene_summaries[0].update_date_time #=> Time # resp.scene_summaries[0].description #=> String # resp.next_token #=> String # # @overload list_scenes(params = {}) # @param [Hash] params ({}) def list_scenes(params = {}, options = {}) req = build_request(:list_scenes, params) req.send_request(options) end # List all SyncJobs. # # @option params [required, String] :workspace_id # The ID of the workspace that contains the sync job. # # @option params [Integer] :max_results # The maximum number of results to return at one time. The default is # 50. # # Valid Range: Minimum value of 0. Maximum value of 200. # # @option params [String] :next_token # The string that specifies the next page of results. # # @return [Types::ListSyncJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListSyncJobsResponse#sync_job_summaries #sync_job_summaries} => Array<Types::SyncJobSummary> # * {Types::ListSyncJobsResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_sync_jobs({ # workspace_id: "Id", # required # max_results: 1, # next_token: "NextToken", # }) # # @example Response structure # # resp.sync_job_summaries #=> Array # resp.sync_job_summaries[0].arn #=> String # resp.sync_job_summaries[0].workspace_id #=> String # resp.sync_job_summaries[0].sync_source #=> String # resp.sync_job_summaries[0].status.state #=> String, one of "CREATING", "INITIALIZING", "ACTIVE", "DELETING", "ERROR" # resp.sync_job_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE" # resp.sync_job_summaries[0].status.error.message #=> String # resp.sync_job_summaries[0].creation_date_time #=> Time # resp.sync_job_summaries[0].update_date_time #=> Time # resp.next_token #=> String # # @overload list_sync_jobs(params = {}) # @param [Hash] params ({}) def list_sync_jobs(params = {}, options = {}) req = build_request(:list_sync_jobs, params) req.send_request(options) end # Lists the sync resources. # # @option params [required, String] :workspace_id # The ID of the workspace that contains the sync job. # # @option params [required, String] :sync_source # The sync source. # # Currently the only supported syncSource is `SITEWISE `. # # # # @option params [Array] :filters # A list of objects that filter the request. # # The following filter combinations are supported: # # * Filter with state # # * Filter with ResourceType and ResourceId # # * Filter with ResourceType and ExternalId # # @option params [Integer] :max_results # The maximum number of results to return at one time. The default is # 50. # # Valid Range: Minimum value of 0. Maximum value of 200. # # @option params [String] :next_token # The string that specifies the next page of results. # # @return [Types::ListSyncResourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListSyncResourcesResponse#sync_resources #sync_resources} => Array<Types::SyncResourceSummary> # * {Types::ListSyncResourcesResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_sync_resources({ # workspace_id: "Id", # required # sync_source: "SyncSource", # required # filters: [ # { # state: "INITIALIZING", # accepts INITIALIZING, PROCESSING, DELETED, IN_SYNC, ERROR # resource_type: "ENTITY", # accepts ENTITY, COMPONENT_TYPE # resource_id: "Id", # external_id: "Id", # }, # ], # max_results: 1, # next_token: "NextToken", # }) # # @example Response structure # # resp.sync_resources #=> Array # resp.sync_resources[0].resource_type #=> String, one of "ENTITY", "COMPONENT_TYPE" # resp.sync_resources[0].external_id #=> String # resp.sync_resources[0].resource_id #=> String # resp.sync_resources[0].status.state #=> String, one of "INITIALIZING", "PROCESSING", "DELETED", "IN_SYNC", "ERROR" # resp.sync_resources[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE", "SYNC_INITIALIZING_ERROR", "SYNC_CREATING_ERROR", "SYNC_PROCESSING_ERROR", "SYNC_DELETING_ERROR", "PROCESSING_ERROR", "COMPOSITE_COMPONENT_FAILURE" # resp.sync_resources[0].status.error.message #=> String # resp.sync_resources[0].update_date_time #=> Time # resp.next_token #=> String # # @overload list_sync_resources(params = {}) # @param [Hash] params ({}) def list_sync_resources(params = {}, options = {}) req = build_request(:list_sync_resources, params) req.send_request(options) end # Lists all tags associated with a resource. # # @option params [required, String] :resource_arn # The ARN of the resource. # # @option params [Integer] :max_results # The maximum number of results to return at one time. The default is # 25. # # Valid Range: Minimum value of 1. Maximum value of 250. # # @option params [String] :next_token # The string that specifies the next page of results. # # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListTagsForResourceResponse#tags #tags} => Hash<String,String> # * {Types::ListTagsForResourceResponse#next_token #next_token} => String # # @example Request syntax with placeholder values # # resp = client.list_tags_for_resource({ # resource_arn: "TwinMakerArn", # required # max_results: 1, # next_token: "NextToken", # }) # # @example Response structure # # resp.tags #=> Hash # resp.tags["TagKey"] #=> String # resp.next_token #=> String # # @overload list_tags_for_resource(params = {}) # @param [Hash] params ({}) def list_tags_for_resource(params = {}, options = {}) req = build_request(:list_tags_for_resource, params) req.send_request(options) end # Retrieves information about workspaces in the current account. # # @option params [Integer] :max_results # The maximum number of results to return at one time. The default is # 25. # # Valid Range: Minimum value of 1. Maximum value of 250. # # @option params [String] :next_token # The string that specifies the next page of results. # # @return [Types::ListWorkspacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListWorkspacesResponse#workspace_summaries #workspace_summaries} => Array<Types::WorkspaceSummary> # * {Types::ListWorkspacesResponse#next_token #next_token} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_workspaces({ # max_results: 1, # next_token: "NextToken", # }) # # @example Response structure # # resp.workspace_summaries #=> Array # resp.workspace_summaries[0].workspace_id #=> String # resp.workspace_summaries[0].arn #=> String # resp.workspace_summaries[0].description #=> String # resp.workspace_summaries[0].linked_services #=> Array # resp.workspace_summaries[0].linked_services[0] #=> String # resp.workspace_summaries[0].creation_date_time #=> Time # resp.workspace_summaries[0].update_date_time #=> Time # resp.next_token #=> String # # @overload list_workspaces(params = {}) # @param [Hash] params ({}) def list_workspaces(params = {}, options = {}) req = build_request(:list_workspaces, params) req.send_request(options) end # Adds tags to a resource. # # @option params [required, String] :resource_arn # The ARN of the resource. # # @option params [required, Hash] :tags # Metadata to add to this resource. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.tag_resource({ # resource_arn: "TwinMakerArn", # required # tags: { # required # "TagKey" => "TagValue", # }, # }) # # @overload tag_resource(params = {}) # @param [Hash] params ({}) def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end # Removes tags from a resource. # # @option params [required, String] :resource_arn # The ARN of the resource. # # @option params [required, Array] :tag_keys # A list of tag key names to remove from the resource. You don't # specify the value. Both the key and its associated value are removed. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.untag_resource({ # resource_arn: "TwinMakerArn", # required # tag_keys: ["TagKey"], # required # }) # # @overload untag_resource(params = {}) # @param [Hash] params ({}) def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end # Updates information in a component type. # # @option params [required, String] :workspace_id # The ID of the workspace. # # @option params [Boolean] :is_singleton # A Boolean value that specifies whether an entity can have more than # one component of this type. # # @option params [required, String] :component_type_id # The ID of the component type. # # @option params [String] :description # The description of the component type. # # @option params [Hash] :property_definitions # An object that maps strings to the property definitions in the # component type. Each string in the mapping must be unique to this # object. # # @option params [Array] :extends_from # Specifies the component type that this component type extends. # # @option params [Hash] :functions # An object that maps strings to the functions in the component type. # Each string in the mapping must be unique to this object. # # @option params [Hash] :property_groups # The property groups. # # @option params [String] :component_type_name # The component type name. # # @option params [Hash] :composite_component_types # This is an object that maps strings to `compositeComponentTypes` of # the `componentType`. `CompositeComponentType` is referenced by # `componentTypeId`. # # @return [Types::UpdateComponentTypeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateComponentTypeResponse#workspace_id #workspace_id} => String # * {Types::UpdateComponentTypeResponse#arn #arn} => String # * {Types::UpdateComponentTypeResponse#component_type_id #component_type_id} => String # * {Types::UpdateComponentTypeResponse#state #state} => String # # @example Request syntax with placeholder values # # resp = client.update_component_type({ # workspace_id: "Id", # required # is_singleton: false, # component_type_id: "ComponentTypeId", # required # description: "Description", # property_definitions: { # "Name" => { # data_type: { # type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP # nested_type: { # # recursive DataType # }, # allowed_values: [ # { # boolean_value: false, # double_value: 1.0, # integer_value: 1, # long_value: 1, # string_value: "String", # list_value: { # # recursive DataValueList # }, # map_value: { # "String" => { # # recursive DataValue # }, # }, # relationship_value: { # target_entity_id: "EntityId", # target_component_name: "Name", # }, # expression: "Expression", # }, # ], # unit_of_measure: "String", # relationship: { # target_component_type_id: "ComponentTypeId", # relationship_type: "String", # }, # }, # is_required_in_entity: false, # is_external_id: false, # is_stored_externally: false, # is_time_series: false, # default_value: { # boolean_value: false, # double_value: 1.0, # integer_value: 1, # long_value: 1, # string_value: "String", # list_value: [ # { # # recursive DataValue # }, # ], # map_value: { # "String" => { # # recursive DataValue # }, # }, # relationship_value: { # target_entity_id: "EntityId", # target_component_name: "Name", # }, # expression: "Expression", # }, # configuration: { # "Name" => "Value", # }, # display_name: "PropertyDisplayName", # }, # }, # extends_from: ["ComponentTypeId"], # functions: { # "Name" => { # required_properties: ["Name"], # scope: "ENTITY", # accepts ENTITY, WORKSPACE # implemented_by: { # lambda: { # arn: "LambdaArn", # required # }, # is_native: false, # }, # }, # }, # property_groups: { # "Name" => { # group_type: "TABULAR", # accepts TABULAR # property_names: ["Name"], # }, # }, # component_type_name: "ComponentTypeName", # composite_component_types: { # "Name" => { # component_type_id: "ComponentTypeId", # }, # }, # }) # # @example Response structure # # resp.workspace_id #=> String # resp.arn #=> String # resp.component_type_id #=> String # resp.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR" # # @overload update_component_type(params = {}) # @param [Hash] params ({}) def update_component_type(params = {}, options = {}) req = build_request(:update_component_type, params) req.send_request(options) end # Updates an entity. # # @option params [required, String] :workspace_id # The ID of the workspace that contains the entity. # # @option params [required, String] :entity_id # The ID of the entity. # # @option params [String] :entity_name # The name of the entity. # # @option params [String] :description # The description of the entity. # # @option params [Hash] :component_updates # An object that maps strings to the component updates in the request. # Each string in the mapping must be unique to this object. # # @option params [Hash] :composite_component_updates # This is an object that maps strings to `compositeComponent` updates in # the request. Each key of the map represents the `componentPath` of the # `compositeComponent`. # # @option params [Types::ParentEntityUpdateRequest] :parent_entity_update # An object that describes the update request for a parent entity. # # @return [Types::UpdateEntityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateEntityResponse#update_date_time #update_date_time} => Time # * {Types::UpdateEntityResponse#state #state} => String # # @example Request syntax with placeholder values # # resp = client.update_entity({ # workspace_id: "Id", # required # entity_id: "EntityId", # required # entity_name: "EntityName", # description: "Description", # component_updates: { # "Name" => { # update_type: "CREATE", # accepts CREATE, UPDATE, DELETE # description: "Description", # component_type_id: "ComponentTypeId", # property_updates: { # "Name" => { # definition: { # data_type: { # type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP # nested_type: { # # recursive DataType # }, # allowed_values: [ # { # boolean_value: false, # double_value: 1.0, # integer_value: 1, # long_value: 1, # string_value: "String", # list_value: { # # recursive DataValueList # }, # map_value: { # "String" => { # # recursive DataValue # }, # }, # relationship_value: { # target_entity_id: "EntityId", # target_component_name: "Name", # }, # expression: "Expression", # }, # ], # unit_of_measure: "String", # relationship: { # target_component_type_id: "ComponentTypeId", # relationship_type: "String", # }, # }, # is_required_in_entity: false, # is_external_id: false, # is_stored_externally: false, # is_time_series: false, # default_value: { # boolean_value: false, # double_value: 1.0, # integer_value: 1, # long_value: 1, # string_value: "String", # list_value: [ # { # # recursive DataValue # }, # ], # map_value: { # "String" => { # # recursive DataValue # }, # }, # relationship_value: { # target_entity_id: "EntityId", # target_component_name: "Name", # }, # expression: "Expression", # }, # configuration: { # "Name" => "Value", # }, # display_name: "PropertyDisplayName", # }, # value: { # boolean_value: false, # double_value: 1.0, # integer_value: 1, # long_value: 1, # string_value: "String", # list_value: [ # { # # recursive DataValue # }, # ], # map_value: { # "String" => { # # recursive DataValue # }, # }, # relationship_value: { # target_entity_id: "EntityId", # target_component_name: "Name", # }, # expression: "Expression", # }, # update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE, RESET_VALUE # }, # }, # property_group_updates: { # "Name" => { # group_type: "TABULAR", # accepts TABULAR # property_names: ["Name"], # update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE # }, # }, # }, # }, # composite_component_updates: { # "ComponentPath" => { # update_type: "CREATE", # accepts CREATE, UPDATE, DELETE # description: "Description", # property_updates: { # "Name" => { # definition: { # data_type: { # type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP # nested_type: { # # recursive DataType # }, # allowed_values: [ # { # boolean_value: false, # double_value: 1.0, # integer_value: 1, # long_value: 1, # string_value: "String", # list_value: { # # recursive DataValueList # }, # map_value: { # "String" => { # # recursive DataValue # }, # }, # relationship_value: { # target_entity_id: "EntityId", # target_component_name: "Name", # }, # expression: "Expression", # }, # ], # unit_of_measure: "String", # relationship: { # target_component_type_id: "ComponentTypeId", # relationship_type: "String", # }, # }, # is_required_in_entity: false, # is_external_id: false, # is_stored_externally: false, # is_time_series: false, # default_value: { # boolean_value: false, # double_value: 1.0, # integer_value: 1, # long_value: 1, # string_value: "String", # list_value: [ # { # # recursive DataValue # }, # ], # map_value: { # "String" => { # # recursive DataValue # }, # }, # relationship_value: { # target_entity_id: "EntityId", # target_component_name: "Name", # }, # expression: "Expression", # }, # configuration: { # "Name" => "Value", # }, # display_name: "PropertyDisplayName", # }, # value: { # boolean_value: false, # double_value: 1.0, # integer_value: 1, # long_value: 1, # string_value: "String", # list_value: [ # { # # recursive DataValue # }, # ], # map_value: { # "String" => { # # recursive DataValue # }, # }, # relationship_value: { # target_entity_id: "EntityId", # target_component_name: "Name", # }, # expression: "Expression", # }, # update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE, RESET_VALUE # }, # }, # property_group_updates: { # "Name" => { # group_type: "TABULAR", # accepts TABULAR # property_names: ["Name"], # update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE # }, # }, # }, # }, # parent_entity_update: { # update_type: "UPDATE", # required, accepts UPDATE, DELETE # parent_entity_id: "ParentEntityId", # }, # }) # # @example Response structure # # resp.update_date_time #=> Time # resp.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR" # # @overload update_entity(params = {}) # @param [Hash] params ({}) def update_entity(params = {}, options = {}) req = build_request(:update_entity, params) req.send_request(options) end # Update the pricing plan. # # @option params [required, String] :pricing_mode # The pricing mode. # # @option params [Array] :bundle_names # The bundle names. # # @return [Types::UpdatePricingPlanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdatePricingPlanResponse#current_pricing_plan #current_pricing_plan} => Types::PricingPlan # * {Types::UpdatePricingPlanResponse#pending_pricing_plan #pending_pricing_plan} => Types::PricingPlan # # @example Request syntax with placeholder values # # resp = client.update_pricing_plan({ # pricing_mode: "BASIC", # required, accepts BASIC, STANDARD, TIERED_BUNDLE # bundle_names: ["BundleName"], # }) # # @example Response structure # # resp.current_pricing_plan.billable_entity_count #=> Integer # resp.current_pricing_plan.bundle_information.bundle_names #=> Array # resp.current_pricing_plan.bundle_information.bundle_names[0] #=> String # resp.current_pricing_plan.bundle_information.pricing_tier #=> String, one of "TIER_1", "TIER_2", "TIER_3", "TIER_4" # resp.current_pricing_plan.effective_date_time #=> Time # resp.current_pricing_plan.pricing_mode #=> String, one of "BASIC", "STANDARD", "TIERED_BUNDLE" # resp.current_pricing_plan.update_date_time #=> Time # resp.current_pricing_plan.update_reason #=> String, one of "DEFAULT", "PRICING_TIER_UPDATE", "ENTITY_COUNT_UPDATE", "PRICING_MODE_UPDATE", "OVERWRITTEN" # resp.pending_pricing_plan.billable_entity_count #=> Integer # resp.pending_pricing_plan.bundle_information.bundle_names #=> Array # resp.pending_pricing_plan.bundle_information.bundle_names[0] #=> String # resp.pending_pricing_plan.bundle_information.pricing_tier #=> String, one of "TIER_1", "TIER_2", "TIER_3", "TIER_4" # resp.pending_pricing_plan.effective_date_time #=> Time # resp.pending_pricing_plan.pricing_mode #=> String, one of "BASIC", "STANDARD", "TIERED_BUNDLE" # resp.pending_pricing_plan.update_date_time #=> Time # resp.pending_pricing_plan.update_reason #=> String, one of "DEFAULT", "PRICING_TIER_UPDATE", "ENTITY_COUNT_UPDATE", "PRICING_MODE_UPDATE", "OVERWRITTEN" # # @overload update_pricing_plan(params = {}) # @param [Hash] params ({}) def update_pricing_plan(params = {}, options = {}) req = build_request(:update_pricing_plan, params) req.send_request(options) end # Updates a scene. # # @option params [required, String] :workspace_id # The ID of the workspace that contains the scene. # # @option params [required, String] :scene_id # The ID of the scene. # # @option params [String] :content_location # The relative path that specifies the location of the content # definition file. # # @option params [String] :description # The description of this scene. # # @option params [Array] :capabilities # A list of capabilities that the scene uses to render. # # @option params [Hash] :scene_metadata # The scene metadata. # # @return [Types::UpdateSceneResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateSceneResponse#update_date_time #update_date_time} => Time # # @example Request syntax with placeholder values # # resp = client.update_scene({ # workspace_id: "Id", # required # scene_id: "Id", # required # content_location: "S3Url", # description: "Description", # capabilities: ["SceneCapability"], # scene_metadata: { # "Name" => "SceneMetadataValue", # }, # }) # # @example Response structure # # resp.update_date_time #=> Time # # @overload update_scene(params = {}) # @param [Hash] params ({}) def update_scene(params = {}, options = {}) req = build_request(:update_scene, params) req.send_request(options) end # Updates a workspace. # # @option params [required, String] :workspace_id # The ID of the workspace. # # @option params [String] :description # The description of the workspace. # # @option params [String] :role # The ARN of the execution role associated with the workspace. # # @option params [String] :s3_location # The ARN of the S3 bucket where resources associated with the workspace # are stored. # # @return [Types::UpdateWorkspaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateWorkspaceResponse#update_date_time #update_date_time} => Time # # @example Request syntax with placeholder values # # resp = client.update_workspace({ # workspace_id: "Id", # required # description: "Description", # role: "RoleArn", # s3_location: "S3Location", # }) # # @example Response structure # # resp.update_date_time #=> Time # # @overload update_workspace(params = {}) # @param [Hash] params ({}) def update_workspace(params = {}, options = {}) req = build_request(:update_workspace, params) req.send_request(options) end # @!endgroup # @param params ({}) # @api private def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) tracer = config.telemetry_provider.tracer_provider.tracer( Aws::Telemetry.module_to_tracer_name('Aws::IoTTwinMaker') ) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config, tracer: tracer ) context[:gem_name] = 'aws-sdk-iottwinmaker' context[:gem_version] = '1.32.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated def waiter_names [] end class << self # @api private attr_reader :identifier # @api private def errors_module Errors end end end end