Class: Aws::IoTTwinMaker::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-iottwinmaker/client.rb

Overview

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 Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

    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`

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

    • ENV, ENV

    • `~/.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::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

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

  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

  • :client_side_monitoring (Boolean) — default: false —

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

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

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000 —

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

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

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

  • :convert_params (Boolean) — default: true —

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

  • :correct_clock_skew (Boolean) — default: true —

    Used only in `standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

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

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

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the `:region` option. You should only configure an `:endpoint` when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

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

  • :endpoint_cache_max_threads (Integer) — default: 10 —

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

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

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

  • :endpoint_discovery (Boolean) — default: false —

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

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

    The log formatter.

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

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

  • :logger (Logger) —

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

  • :max_attempts (Integer) — default: 3 —

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

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

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

  • :retry_backoff (Proc) —

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

  • :retry_base_delay (Float) — default: 0.3 —

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

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

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

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

  • :retry_limit (Integer) — default: 3 —

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

  • :retry_max_delay (Integer) — default: 0 —

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

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

    Specifies which retry algorithm to use. Values are:

    • `legacy` - The pre-existing retry behavior. This is 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.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false —

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

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

  • :token_provider (Aws::TokenProvider) —

    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.

  • :use_dualstack_endpoint (Boolean) —

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

  • :use_fips_endpoint (Boolean) —

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

  • :validate_params (Boolean) — default: true —

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

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

    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`

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

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

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a `Timeout::Error`.

  • :http_read_timeout (Float) — default: 60 —

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

  • :http_idle_timeout (Float) — default: 5 —

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

  • :http_continue_timeout (Float) — default: 1 —

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

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

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

  • :ssl_verify_peer (Boolean) — default: true —

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

  • :ssl_ca_bundle (String) —

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

  • :ssl_ca_directory (String) —

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



365
366
367
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 365

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2158
2159
2160
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2158

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



2161
2162
2163
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2161

def errors_module
  Errors
end

Instance Method Details

#batch_put_property_values(params = {}) ⇒ Types::BatchPutPropertyValuesResponse

Sets values for multiple time series properties.

Examples:

Request syntax with placeholder values


resp = client.batch_put_property_values({
  entries: [ # required
    {
      entity_property_reference: { # required
        component_name: "Name",
        entity_id: "EntityId",
        external_id_property: {
          "String" => "String",
        },
        property_name: "Name", # required
      },
      property_values: [
        {
          time: "Time",
          timestamp: Time.now,
          value: { # required
            boolean_value: false,
            double_value: 1.0,
            expression: "Expression",
            integer_value: 1,
            list_value: [
              {
                # recursive DataValue
              },
            ],
            long_value: 1,
            map_value: {
              "String" => {
                # recursive DataValue
              },
            },
            relationship_value: {
              target_component_name: "Name",
              target_entity_id: "EntityId",
            },
            string_value: "String",
          },
        },
      ],
    },
  ],
  workspace_id: "Id", # required
})

Response structure


resp.error_entries #=> Array
resp.error_entries[0].errors #=> Array
resp.error_entries[0].errors[0].entry.entity_property_reference.component_name #=> String
resp.error_entries[0].errors[0].entry.entity_property_reference.entity_id #=> 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.property_name #=> String
resp.error_entries[0].errors[0].entry.property_values #=> Array
resp.error_entries[0].errors[0].entry.property_values[0].time #=> String
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.expression #=> String
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.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.long_value #=> Integer
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_component_name #=> String
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.string_value #=> String
resp.error_entries[0].errors[0].error_code #=> String
resp.error_entries[0].errors[0].error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    An object that maps strings to the property value entries to set. Each string in the mapping must be unique to this object.

  • :workspace_id (required, String) —

    The ID of the workspace that contains the properties to set.

Returns:



459
460
461
462
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 459

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

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2136

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-iottwinmaker'
  context[:gem_version] = '1.6.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_component_type(params = {}) ⇒ Types::CreateComponentTypeResponse

Creates a component type.

Examples:

Request syntax with placeholder values


resp = client.create_component_type({
  component_type_id: "ComponentTypeId", # required
  description: "Description",
  extends_from: ["ComponentTypeId"],
  functions: {
    "Name" => {
      implemented_by: {
        is_native: false,
        lambda: {
          arn: "LambdaArn", # required
        },
      },
      required_properties: ["Name"],
      scope: "ENTITY", # accepts ENTITY, WORKSPACE
    },
  },
  is_singleton: false,
  property_definitions: {
    "Name" => {
      configuration: {
        "Name" => "Value",
      },
      data_type: {
        allowed_values: [
          {
            boolean_value: false,
            double_value: 1.0,
            expression: "Expression",
            integer_value: 1,
            list_value: {
              # recursive DataValueList
            },
            long_value: 1,
            map_value: {
              "String" => {
                # recursive DataValue
              },
            },
            relationship_value: {
              target_component_name: "Name",
              target_entity_id: "EntityId",
            },
            string_value: "String",
          },
        ],
        nested_type: {
          # recursive DataType
        },
        relationship: {
          relationship_type: "String",
          target_component_type_id: "ComponentTypeId",
        },
        type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
        unit_of_measure: "String",
      },
      default_value: {
        boolean_value: false,
        double_value: 1.0,
        expression: "Expression",
        integer_value: 1,
        list_value: [
          {
            # recursive DataValue
          },
        ],
        long_value: 1,
        map_value: {
          "String" => {
            # recursive DataValue
          },
        },
        relationship_value: {
          target_component_name: "Name",
          target_entity_id: "EntityId",
        },
        string_value: "String",
      },
      is_external_id: false,
      is_required_in_entity: false,
      is_stored_externally: false,
      is_time_series: false,
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
  workspace_id: "Id", # required
})

Response structure


resp.arn #=> String
resp.creation_date_time #=> Time
resp.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"

Parameters:

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

    ({})

Options Hash (params):

  • :component_type_id (required, String) —

    The ID of the component type.

  • :description (String) —

    The description of the component type.

  • :extends_from (Array<String>) —

    Specifies the parent component type to extend.

  • :functions (Hash<String,Types::FunctionRequest>) —

    An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.

  • :is_singleton (Boolean) —

    A Boolean value that specifies whether an entity can have more than one component of this type.

  • :property_definitions (Hash<String,Types::PropertyDefinitionRequest>) —

    An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.

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

    Metadata that you can use to manage the component type.

  • :workspace_id (required, String) —

    The ID of the workspace that contains the component type.

Returns:



599
600
601
602
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 599

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

#create_entity(params = {}) ⇒ Types::CreateEntityResponse

Creates an entity.

Examples:

Request syntax with placeholder values


resp = client.create_entity({
  components: {
    "Name" => {
      component_type_id: "ComponentTypeId",
      description: "Description",
      properties: {
        "Name" => {
          definition: {
            configuration: {
              "Name" => "Value",
            },
            data_type: {
              allowed_values: [
                {
                  boolean_value: false,
                  double_value: 1.0,
                  expression: "Expression",
                  integer_value: 1,
                  list_value: {
                    # recursive DataValueList
                  },
                  long_value: 1,
                  map_value: {
                    "String" => {
                      # recursive DataValue
                    },
                  },
                  relationship_value: {
                    target_component_name: "Name",
                    target_entity_id: "EntityId",
                  },
                  string_value: "String",
                },
              ],
              nested_type: {
                # recursive DataType
              },
              relationship: {
                relationship_type: "String",
                target_component_type_id: "ComponentTypeId",
              },
              type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
              unit_of_measure: "String",
            },
            default_value: {
              boolean_value: false,
              double_value: 1.0,
              expression: "Expression",
              integer_value: 1,
              list_value: [
                {
                  # recursive DataValue
                },
              ],
              long_value: 1,
              map_value: {
                "String" => {
                  # recursive DataValue
                },
              },
              relationship_value: {
                target_component_name: "Name",
                target_entity_id: "EntityId",
              },
              string_value: "String",
            },
            is_external_id: false,
            is_required_in_entity: false,
            is_stored_externally: false,
            is_time_series: false,
          },
          update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
          value: {
            boolean_value: false,
            double_value: 1.0,
            expression: "Expression",
            integer_value: 1,
            list_value: [
              {
                # recursive DataValue
              },
            ],
            long_value: 1,
            map_value: {
              "String" => {
                # recursive DataValue
              },
            },
            relationship_value: {
              target_component_name: "Name",
              target_entity_id: "EntityId",
            },
            string_value: "String",
          },
        },
      },
    },
  },
  description: "Description",
  entity_id: "EntityId",
  entity_name: "EntityName", # required
  parent_entity_id: "ParentEntityId",
  tags: {
    "TagKey" => "TagValue",
  },
  workspace_id: "Id", # required
})

Response structure


resp.arn #=> String
resp.creation_date_time #=> Time
resp.entity_id #=> String
resp.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"

Parameters:

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

    ({})

Options Hash (params):

  • :components (Hash<String,Types::ComponentRequest>) —

    An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.

  • :description (String) —

    The description of the entity.

  • :entity_id (String) —

    The ID of the entity.

  • :entity_name (required, String) —

    The name of the entity.

  • :parent_entity_id (String) —

    The ID of the entity's parent entity.

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

    Metadata that you can use to manage the entity.

  • :workspace_id (required, String) —

    The ID of the workspace that contains the entity.

Returns:



754
755
756
757
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 754

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

#create_scene(params = {}) ⇒ Types::CreateSceneResponse

Creates a scene.

Examples:

Request syntax with placeholder values


resp = client.create_scene({
  capabilities: ["SceneCapability"],
  content_location: "S3Url", # required
  description: "Description",
  scene_id: "Id", # required
  tags: {
    "TagKey" => "TagValue",
  },
  workspace_id: "Id", # required
})

Response structure


resp.arn #=> String
resp.creation_date_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :capabilities (Array<String>) —

    A list of capabilities that the scene uses to render itself.

  • :content_location (required, String) —

    The relative path that specifies the location of the content definition file.

  • :description (String) —

    The description for this scene.

  • :scene_id (required, String) —

    The ID of the scene.

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

    Metadata that you can use to manage the scene.

  • :workspace_id (required, String) —

    The ID of the workspace that contains the scene.

Returns:



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

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

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

Creates a workplace.

Examples:

Request syntax with placeholder values


resp = client.create_workspace({
  description: "Description",
  role: "RoleArn", # required
  s3_location: "S3Location", # required
  tags: {
    "TagKey" => "TagValue",
  },
  workspace_id: "Id", # required
})

Response structure


resp.arn #=> String
resp.creation_date_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :description (String) —

    The description of the workspace.

  • :role (required, String) —

    The ARN of the execution role associated with the workspace.

  • :s3_location (required, String) —

    The ARN of the S3 bucket where resources associated with the workspace are stored.

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

    Metadata that you can use to manage the workspace

  • :workspace_id (required, String) —

    The ID of the workspace.

Returns:



852
853
854
855
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 852

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

#delete_component_type(params = {}) ⇒ Types::DeleteComponentTypeResponse

Deletes a component type.

Examples:

Request syntax with placeholder values


resp = client.delete_component_type({
  component_type_id: "ComponentTypeId", # required
  workspace_id: "Id", # required
})

Response structure


resp.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"

Parameters:

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

    ({})

Options Hash (params):

  • :component_type_id (required, String) —

    The ID of the component type to delete.

  • :workspace_id (required, String) —

    The ID of the workspace that contains the component type.

Returns:



882
883
884
885
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 882

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

#delete_entity(params = {}) ⇒ Types::DeleteEntityResponse

Deletes an entity.

Examples:

Request syntax with placeholder values


resp = client.delete_entity({
  entity_id: "EntityId", # required
  is_recursive: false,
  workspace_id: "Id", # required
})

Response structure


resp.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"

Parameters:

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

    ({})

Options Hash (params):

  • :entity_id (required, String) —

    The ID of the entity to delete.

  • :is_recursive (Boolean) —

    A Boolean value that specifies whether the operation deletes child entities.

  • :workspace_id (required, String) —

    The ID of the workspace that contains the entity to delete.

Returns:



917
918
919
920
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 917

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

#delete_scene(params = {}) ⇒ Struct

Deletes a scene.

Examples:

Request syntax with placeholder values


resp = client.delete_scene({
  scene_id: "Id", # required
  workspace_id: "Id", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :scene_id (required, String) —

    The ID of the scene to delete.

  • :workspace_id (required, String) —

    The ID of the workspace.

Returns:

  • (Struct) —

    Returns an empty response.



941
942
943
944
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 941

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

#delete_workspace(params = {}) ⇒ Struct

Deletes a workspace.

Examples:

Request syntax with placeholder values


resp = client.delete_workspace({
  workspace_id: "Id", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace to delete.

Returns:

  • (Struct) —

    Returns an empty response.



961
962
963
964
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 961

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

#get_component_type(params = {}) ⇒ Types::GetComponentTypeResponse

Retrieves information about a component type.

Examples:

Request syntax with placeholder values


resp = client.get_component_type({
  component_type_id: "ComponentTypeId", # required
  workspace_id: "Id", # required
})

Response structure


resp.arn #=> String
resp.component_type_id #=> String
resp.creation_date_time #=> Time
resp.description #=> String
resp.extends_from #=> Array
resp.extends_from[0] #=> String
resp.functions #=> Hash
resp.functions["Name"].implemented_by.is_native #=> Boolean
resp.functions["Name"].implemented_by.lambda.arn #=> String
resp.functions["Name"].is_inherited #=> Boolean
resp.functions["Name"].required_properties #=> Array
resp.functions["Name"].required_properties[0] #=> String
resp.functions["Name"].scope #=> String, one of "ENTITY", "WORKSPACE"
resp.is_abstract #=> Boolean
resp.is_schema_initialized #=> Boolean
resp.is_singleton #=> Boolean
resp.property_definitions #=> Hash
resp.property_definitions["Name"].configuration #=> Hash
resp.property_definitions["Name"].configuration["Name"] #=> String
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].expression #=> String
resp.property_definitions["Name"].data_type.allowed_values[0].integer_value #=> Integer
resp.property_definitions["Name"].data_type.allowed_values[0].list_value #=> Types::DataValueList
resp.property_definitions["Name"].data_type.allowed_values[0].long_value #=> Integer
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_component_name #=> String
resp.property_definitions["Name"].data_type.allowed_values[0].relationship_value.target_entity_id #=> String
resp.property_definitions["Name"].data_type.allowed_values[0].string_value #=> String
resp.property_definitions["Name"].data_type.nested_type #=> Types::DataType
resp.property_definitions["Name"].data_type.relationship.relationship_type #=> String
resp.property_definitions["Name"].data_type.relationship.target_component_type_id #=> String
resp.property_definitions["Name"].data_type.type #=> String, one of "RELATIONSHIP", "STRING", "LONG", "BOOLEAN", "INTEGER", "DOUBLE", "LIST", "MAP"
resp.property_definitions["Name"].data_type.unit_of_measure #=> String
resp.property_definitions["Name"].default_value.boolean_value #=> Boolean
resp.property_definitions["Name"].default_value.double_value #=> Float
resp.property_definitions["Name"].default_value.expression #=> String
resp.property_definitions["Name"].default_value.integer_value #=> Integer
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.long_value #=> Integer
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_component_name #=> String
resp.property_definitions["Name"].default_value.relationship_value.target_entity_id #=> String
resp.property_definitions["Name"].default_value.string_value #=> String
resp.property_definitions["Name"].is_external_id #=> Boolean
resp.property_definitions["Name"].is_final #=> Boolean
resp.property_definitions["Name"].is_imported #=> Boolean
resp.property_definitions["Name"].is_inherited #=> Boolean
resp.property_definitions["Name"].is_required_in_entity #=> Boolean
resp.property_definitions["Name"].is_stored_externally #=> Boolean
resp.property_definitions["Name"].is_time_series #=> Boolean
resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.status.error.message #=> String
resp.status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
resp.update_date_time #=> Time
resp.workspace_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :component_type_id (required, String) —

    The ID of the component type.

  • :workspace_id (required, String) —

    The ID of the workspace that contains the component type.

Returns:



1062
1063
1064
1065
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1062

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

#get_entity(params = {}) ⇒ Types::GetEntityResponse

Retrieves information about an entity.

Examples:

Request syntax with placeholder values


resp = client.get_entity({
  entity_id: "EntityId", # required
  workspace_id: "Id", # required
})

Response structure


resp.arn #=> String
resp.components #=> Hash
resp.components["Name"].component_name #=> String
resp.components["Name"].component_type_id #=> String
resp.components["Name"].defined_in #=> String
resp.components["Name"].description #=> String
resp.components["Name"].properties #=> Hash
resp.components["Name"].properties["Name"].definition.configuration #=> Hash
resp.components["Name"].properties["Name"].definition.configuration["Name"] #=> String
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].expression #=> String
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].list_value #=> Types::DataValueList
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].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_component_name #=> String
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].string_value #=> String
resp.components["Name"].properties["Name"].definition.data_type.nested_type #=> Types::DataType
resp.components["Name"].properties["Name"].definition.data_type.relationship.relationship_type #=> String
resp.components["Name"].properties["Name"].definition.data_type.relationship.target_component_type_id #=> String
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.unit_of_measure #=> String
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.expression #=> String
resp.components["Name"].properties["Name"].definition.default_value.integer_value #=> Integer
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.long_value #=> Integer
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_component_name #=> String
resp.components["Name"].properties["Name"].definition.default_value.relationship_value.target_entity_id #=> String
resp.components["Name"].properties["Name"].definition.default_value.string_value #=> String
resp.components["Name"].properties["Name"].definition.is_external_id #=> Boolean
resp.components["Name"].properties["Name"].definition.is_final #=> Boolean
resp.components["Name"].properties["Name"].definition.is_imported #=> Boolean
resp.components["Name"].properties["Name"].definition.is_inherited #=> Boolean
resp.components["Name"].properties["Name"].definition.is_required_in_entity #=> Boolean
resp.components["Name"].properties["Name"].definition.is_stored_externally #=> Boolean
resp.components["Name"].properties["Name"].definition.is_time_series #=> Boolean
resp.components["Name"].properties["Name"].value.boolean_value #=> Boolean
resp.components["Name"].properties["Name"].value.double_value #=> Float
resp.components["Name"].properties["Name"].value.expression #=> String
resp.components["Name"].properties["Name"].value.integer_value #=> Integer
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.long_value #=> Integer
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_component_name #=> String
resp.components["Name"].properties["Name"].value.relationship_value.target_entity_id #=> String
resp.components["Name"].properties["Name"].value.string_value #=> String
resp.components["Name"].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.components["Name"].status.error.message #=> String
resp.components["Name"].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
resp.creation_date_time #=> Time
resp.description #=> String
resp.entity_id #=> String
resp.entity_name #=> String
resp.has_child_entities #=> Boolean
resp.parent_entity_id #=> String
resp.status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.status.error.message #=> String
resp.status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
resp.update_date_time #=> Time
resp.workspace_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :entity_id (required, String) —

    The ID of the entity.

  • :workspace_id (required, String) —

    The ID of the workspace.

Returns:



1172
1173
1174
1175
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1172

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

#get_property_value(params = {}) ⇒ Types::GetPropertyValueResponse

Gets the property values for a component, component type, entity, or workspace.

You must specify a value for either `componentName`, `componentTypeId`, `entityId`, or `workspaceId`.

Examples:

Request syntax with placeholder values


resp = client.get_property_value({
  component_name: "Name",
  component_type_id: "ComponentTypeId",
  entity_id: "EntityId",
  selected_properties: ["String"], # required
  workspace_id: "Id", # required
})

Response structure


resp.property_values #=> Hash
resp.property_values["Name"].property_reference.component_name #=> String
resp.property_values["Name"].property_reference.entity_id #=> 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.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.expression #=> String
resp.property_values["Name"].property_value.integer_value #=> Integer
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.long_value #=> Integer
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_component_name #=> String
resp.property_values["Name"].property_value.relationship_value.target_entity_id #=> String
resp.property_values["Name"].property_value.string_value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :component_name (String) —

    The name of the component whose property values the operation returns.

  • :component_type_id (String) —

    The ID of the component type whose property values the operation returns.

  • :entity_id (String) —

    The ID of the entity whose property values the operation returns.

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

    The properties whose values the operation returns.

  • :workspace_id (required, String) —

    The ID of the workspace whose values the operation returns.

Returns:



1236
1237
1238
1239
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1236

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

#get_property_value_history(params = {}) ⇒ Types::GetPropertyValueHistoryResponse

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

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

Examples:

Request syntax with placeholder values


resp = client.get_property_value_history({
  component_name: "Name",
  component_type_id: "ComponentTypeId",
  end_date_time: Time.now,
  end_time: "Time",
  entity_id: "EntityId",
  interpolation: {
    interpolation_type: "LINEAR", # accepts LINEAR
    interval_in_seconds: 1,
  },
  max_results: 1,
  next_token: "NextToken",
  order_by_time: "ASCENDING", # accepts ASCENDING, DESCENDING
  property_filters: [
    {
      operator: "String",
      property_name: "String",
      value: {
        boolean_value: false,
        double_value: 1.0,
        expression: "Expression",
        integer_value: 1,
        list_value: [
          {
            # recursive DataValue
          },
        ],
        long_value: 1,
        map_value: {
          "String" => {
            # recursive DataValue
          },
        },
        relationship_value: {
          target_component_name: "Name",
          target_entity_id: "EntityId",
        },
        string_value: "String",
      },
    },
  ],
  selected_properties: ["String"], # required
  start_date_time: Time.now,
  start_time: "Time",
  workspace_id: "Id", # required
})

Response structure


resp.next_token #=> String
resp.property_values #=> Array
resp.property_values[0].entity_property_reference.component_name #=> String
resp.property_values[0].entity_property_reference.entity_id #=> 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.property_name #=> String
resp.property_values[0].values #=> Array
resp.property_values[0].values[0].time #=> String
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.expression #=> String
resp.property_values[0].values[0].value.integer_value #=> Integer
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.long_value #=> Integer
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_component_name #=> String
resp.property_values[0].values[0].value.relationship_value.target_entity_id #=> String
resp.property_values[0].values[0].value.string_value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :component_name (String) —

    The name of the component.

  • :component_type_id (String) —

    The ID of the component type.

  • :end_date_time (Time, DateTime, Date, Integer, String) —

    The date and time of the latest property value to return.

  • :end_time (String) —

    The ISO8601 DateTime of the latest property value to return.

    For more information about the ISO8601 DateTime format, see the data type [PropertyValue].

    [1]: docs.aws.amazon.com/roci/latest/roci-api/API_PropertyValue.html

  • :entity_id (String) —

    The ID of the entity.

  • :interpolation (Types::InterpolationParameters) —

    An object that specifies the interpolation type and the interval over which to interpolate data.

  • :max_results (Integer) —

    The maximum number of results to return.

  • :next_token (String) —

    The string that specifies the next page of results.

  • :order_by_time (String) —

    The time direction to use in the result order.

  • :property_filters (Array<Types::PropertyFilter>) —

    A list of objects that filter the property value history request.

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

    A list of properties whose value histories the request retrieves.

  • :start_date_time (Time, DateTime, Date, Integer, String) —

    The date and time of the earliest property value to return.

  • :start_time (String) —

    The ISO8601 DateTime of the earliest property value to return.

    For more information about the ISO8601 DateTime format, see the data type [PropertyValue].

    [1]: docs.aws.amazon.com/roci/latest/roci-api/API_PropertyValue.html

  • :workspace_id (required, String) —

    The ID of the workspace.

Returns:



1388
1389
1390
1391
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1388

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

#get_scene(params = {}) ⇒ Types::GetSceneResponse

Retrieves information about a scene.

Examples:

Request syntax with placeholder values


resp = client.get_scene({
  scene_id: "Id", # required
  workspace_id: "Id", # required
})

Response structure


resp.arn #=> String
resp.capabilities #=> Array
resp.capabilities[0] #=> String
resp.content_location #=> String
resp.creation_date_time #=> Time
resp.description #=> String
resp.scene_id #=> String
resp.update_date_time #=> Time
resp.workspace_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :scene_id (required, String) —

    The ID of the scene.

  • :workspace_id (required, String) —

    The ID of the workspace that contains the scene.

Returns:



1433
1434
1435
1436
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1433

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

#get_workspace(params = {}) ⇒ Types::GetWorkspaceResponse

Retrieves information about a workspace.

Examples:

Request syntax with placeholder values


resp = client.get_workspace({
  workspace_id: "IdOrArn", # required
})

Response structure


resp.arn #=> String
resp.creation_date_time #=> Time
resp.description #=> String
resp.role #=> String
resp.s3_location #=> String
resp.update_date_time #=> Time
resp.workspace_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace.

Returns:



1471
1472
1473
1474
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1471

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

#list_component_types(params = {}) ⇒ Types::ListComponentTypesResponse

Lists all component types in a workspace.

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

Examples:

Request syntax with placeholder values


resp = client.list_component_types({
  filters: [
    {
      extends_from: "ComponentTypeId",
      is_abstract: false,
      namespace: "String",
    },
  ],
  max_results: 1,
  next_token: "NextToken",
  workspace_id: "Id", # required
})

Response structure


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].description #=> String
resp.component_type_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.component_type_summaries[0].status.error.message #=> String
resp.component_type_summaries[0].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
resp.component_type_summaries[0].update_date_time #=> Time
resp.max_results #=> Integer
resp.next_token #=> String
resp.workspace_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filters (Array<Types::ListComponentTypesFilter>) —

    A list of objects that filter the request.

  • :max_results (Integer) —

    The maximum number of results to display.

  • :next_token (String) —

    The string that specifies the next page of results.

  • :workspace_id (required, String) —

    The ID of the workspace.

Returns:



1531
1532
1533
1534
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1531

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

#list_entities(params = {}) ⇒ Types::ListEntitiesResponse

Lists all entities in a workspace.

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

Examples:

Request syntax with placeholder values


resp = client.list_entities({
  filters: [
    {
      component_type_id: "ComponentTypeId",
      external_id: "String",
      parent_entity_id: "ParentEntityId",
    },
  ],
  max_results: 1,
  next_token: "NextToken",
  workspace_id: "Id", # required
})

Response structure


resp.entity_summaries #=> Array
resp.entity_summaries[0].arn #=> String
resp.entity_summaries[0].creation_date_time #=> Time
resp.entity_summaries[0].description #=> String
resp.entity_summaries[0].entity_id #=> String
resp.entity_summaries[0].entity_name #=> String
resp.entity_summaries[0].has_child_entities #=> Boolean
resp.entity_summaries[0].parent_entity_id #=> String
resp.entity_summaries[0].status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
resp.entity_summaries[0].status.error.message #=> String
resp.entity_summaries[0].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
resp.entity_summaries[0].update_date_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :filters (Array<Types::ListEntitiesFilter>) —

    A list of objects that filter the request.

    <note markdown=“1”> Only one object is accepted as a valid input.

    </note>
  • :max_results (Integer) —

    The maximum number of results to display.

  • :next_token (String) —

    The string that specifies the next page of results.

  • :workspace_id (required, String) —

    The ID of the workspace.

Returns:



1594
1595
1596
1597
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1594

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

#list_scenes(params = {}) ⇒ Types::ListScenesResponse

Lists all scenes in a workspace.

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

Examples:

Request syntax with placeholder values


resp = client.list_scenes({
  max_results: 1,
  next_token: "NextToken",
  workspace_id: "Id", # required
})

Response structure


resp.next_token #=> String
resp.scene_summaries #=> Array
resp.scene_summaries[0].arn #=> String
resp.scene_summaries[0].content_location #=> String
resp.scene_summaries[0].creation_date_time #=> Time
resp.scene_summaries[0].description #=> String
resp.scene_summaries[0].scene_id #=> String
resp.scene_summaries[0].update_date_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Specifies the maximum number of results to display.

  • :next_token (String) —

    The string that specifies the next page of results.

  • :workspace_id (required, String) —

    The ID of the workspace that contains the scenes.

Returns:



1638
1639
1640
1641
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1638

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists all tags associated with a resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  max_results: 1,
  next_token: "NextToken",
  resource_arn: "TwinMakerArn", # required
})

Response structure


resp.next_token #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to display.

  • :next_token (String) —

    The string that specifies the next page of results.

  • :resource_arn (required, String) —

    The ARN of the resource.

Returns:



1675
1676
1677
1678
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1675

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

#list_workspaces(params = {}) ⇒ Types::ListWorkspacesResponse

Retrieves information about workspaces in the current account.

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

Examples:

Request syntax with placeholder values


resp = client.list_workspaces({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.workspace_summaries #=> Array
resp.workspace_summaries[0].arn #=> String
resp.workspace_summaries[0].creation_date_time #=> Time
resp.workspace_summaries[0].description #=> String
resp.workspace_summaries[0].update_date_time #=> Time
resp.workspace_summaries[0].workspace_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to display.

  • :next_token (String) —

    The string that specifies the next page of results.

Returns:



1714
1715
1716
1717
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1714

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

#tag_resource(params = {}) ⇒ Struct

Adds tags to a resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "TwinMakerArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource.

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

    Metadata to add to this resource.

Returns:

  • (Struct) —

    Returns an empty response.



1740
1741
1742
1743
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1740

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

#untag_resource(params = {}) ⇒ Struct

Removes tags from a resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "TwinMakerArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource.

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

    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.

Returns:

  • (Struct) —

    Returns an empty response.



1765
1766
1767
1768
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1765

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

#update_component_type(params = {}) ⇒ Types::UpdateComponentTypeResponse

Updates information in a component type.

Examples:

Request syntax with placeholder values


resp = client.update_component_type({
  component_type_id: "ComponentTypeId", # required
  description: "Description",
  extends_from: ["ComponentTypeId"],
  functions: {
    "Name" => {
      implemented_by: {
        is_native: false,
        lambda: {
          arn: "LambdaArn", # required
        },
      },
      required_properties: ["Name"],
      scope: "ENTITY", # accepts ENTITY, WORKSPACE
    },
  },
  is_singleton: false,
  property_definitions: {
    "Name" => {
      configuration: {
        "Name" => "Value",
      },
      data_type: {
        allowed_values: [
          {
            boolean_value: false,
            double_value: 1.0,
            expression: "Expression",
            integer_value: 1,
            list_value: {
              # recursive DataValueList
            },
            long_value: 1,
            map_value: {
              "String" => {
                # recursive DataValue
              },
            },
            relationship_value: {
              target_component_name: "Name",
              target_entity_id: "EntityId",
            },
            string_value: "String",
          },
        ],
        nested_type: {
          # recursive DataType
        },
        relationship: {
          relationship_type: "String",
          target_component_type_id: "ComponentTypeId",
        },
        type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
        unit_of_measure: "String",
      },
      default_value: {
        boolean_value: false,
        double_value: 1.0,
        expression: "Expression",
        integer_value: 1,
        list_value: [
          {
            # recursive DataValue
          },
        ],
        long_value: 1,
        map_value: {
          "String" => {
            # recursive DataValue
          },
        },
        relationship_value: {
          target_component_name: "Name",
          target_entity_id: "EntityId",
        },
        string_value: "String",
      },
      is_external_id: false,
      is_required_in_entity: false,
      is_stored_externally: false,
      is_time_series: false,
    },
  },
  workspace_id: "Id", # required
})

Response structure


resp.arn #=> String
resp.component_type_id #=> String
resp.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
resp.workspace_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :component_type_id (required, String) —

    The ID of the component type.

  • :description (String) —

    The description of the component type.

  • :extends_from (Array<String>) —

    Specifies the component type that this component type extends.

  • :functions (Hash<String,Types::FunctionRequest>) —

    An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.

  • :is_singleton (Boolean) —

    A Boolean value that specifies whether an entity can have more than one component of this type.

  • :property_definitions (Hash<String,Types::PropertyDefinitionRequest>) —

    An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.

  • :workspace_id (required, String) —

    The ID of the workspace that contains the component type.

Returns:



1901
1902
1903
1904
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1901

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

#update_entity(params = {}) ⇒ Types::UpdateEntityResponse

Updates an entity.

Examples:

Request syntax with placeholder values


resp = client.update_entity({
  component_updates: {
    "Name" => {
      component_type_id: "ComponentTypeId",
      description: "Description",
      property_updates: {
        "Name" => {
          definition: {
            configuration: {
              "Name" => "Value",
            },
            data_type: {
              allowed_values: [
                {
                  boolean_value: false,
                  double_value: 1.0,
                  expression: "Expression",
                  integer_value: 1,
                  list_value: {
                    # recursive DataValueList
                  },
                  long_value: 1,
                  map_value: {
                    "String" => {
                      # recursive DataValue
                    },
                  },
                  relationship_value: {
                    target_component_name: "Name",
                    target_entity_id: "EntityId",
                  },
                  string_value: "String",
                },
              ],
              nested_type: {
                # recursive DataType
              },
              relationship: {
                relationship_type: "String",
                target_component_type_id: "ComponentTypeId",
              },
              type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
              unit_of_measure: "String",
            },
            default_value: {
              boolean_value: false,
              double_value: 1.0,
              expression: "Expression",
              integer_value: 1,
              list_value: [
                {
                  # recursive DataValue
                },
              ],
              long_value: 1,
              map_value: {
                "String" => {
                  # recursive DataValue
                },
              },
              relationship_value: {
                target_component_name: "Name",
                target_entity_id: "EntityId",
              },
              string_value: "String",
            },
            is_external_id: false,
            is_required_in_entity: false,
            is_stored_externally: false,
            is_time_series: false,
          },
          update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
          value: {
            boolean_value: false,
            double_value: 1.0,
            expression: "Expression",
            integer_value: 1,
            list_value: [
              {
                # recursive DataValue
              },
            ],
            long_value: 1,
            map_value: {
              "String" => {
                # recursive DataValue
              },
            },
            relationship_value: {
              target_component_name: "Name",
              target_entity_id: "EntityId",
            },
            string_value: "String",
          },
        },
      },
      update_type: "CREATE", # accepts CREATE, UPDATE, DELETE
    },
  },
  description: "Description",
  entity_id: "EntityId", # required
  entity_name: "EntityName",
  parent_entity_update: {
    parent_entity_id: "ParentEntityId",
    update_type: "UPDATE", # required, accepts UPDATE, DELETE
  },
  workspace_id: "Id", # required
})

Response structure


resp.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "ERROR"
resp.update_date_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :component_updates (Hash<String,Types::ComponentUpdateRequest>) —

    An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.

  • :description (String) —

    The description of the entity.

  • :entity_id (required, String) —

    The ID of the entity.

  • :entity_name (String) —

    The name of the entity.

  • :parent_entity_update (Types::ParentEntityUpdateRequest) —

    An object that describes the update request for a parent entity.

  • :workspace_id (required, String) —

    The ID of the workspace that contains the entity.

Returns:



2050
2051
2052
2053
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2050

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

#update_scene(params = {}) ⇒ Types::UpdateSceneResponse

Updates a scene.

Examples:

Request syntax with placeholder values


resp = client.update_scene({
  capabilities: ["SceneCapability"],
  content_location: "S3Url",
  description: "Description",
  scene_id: "Id", # required
  workspace_id: "Id", # required
})

Response structure


resp.update_date_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :capabilities (Array<String>) —

    A list of capabilities that the scene uses to render.

  • :content_location (String) —

    The relative path that specifies the location of the content definition file.

  • :description (String) —

    The description of this scene.

  • :scene_id (required, String) —

    The ID of the scene.

  • :workspace_id (required, String) —

    The ID of the workspace that contains the scene.

Returns:



2093
2094
2095
2096
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2093

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

#update_workspace(params = {}) ⇒ Types::UpdateWorkspaceResponse

Updates a workspace.

Examples:

Request syntax with placeholder values


resp = client.update_workspace({
  description: "Description",
  role: "RoleArn",
  workspace_id: "Id", # required
})

Response structure


resp.update_date_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :description (String) —

    The description of the workspace.

  • :role (String) —

    The ARN of the execution role associated with the workspace.

  • :workspace_id (required, String) —

    The ID of the workspace.

Returns:



2127
2128
2129
2130
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2127

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

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


2151
2152
2153
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2151

def waiter_names
  []
end