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

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

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

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

    Your AWS credentials used for authentication. This can be 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`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `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::InstanceProfileCredentials` 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)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

  • :auth_scheme_preference (Array<String>) —

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

  • :client_side_monitoring (Boolean) — default: false —

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

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

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000 —

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

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

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

  • :convert_params (Boolean) — default: true —

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

  • :correct_clock_skew (Boolean) — default: true —

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

  • :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 —

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

  • :disable_request_compression (Boolean) — default: false —

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

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

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

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

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

  • :endpoint_cache_max_threads (Integer) — default: 10 —

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

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

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

  • :endpoint_discovery (Boolean) — default: false —

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

  • :ignore_configured_endpoint_urls (Boolean) —

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

  • :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.

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

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

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

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

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

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

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :retry_backoff (Proc) —

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

  • :retry_base_delay (Float) — default: 0.3 —

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

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

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

    @see 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.

  • :sdk_ua_app_id (String) —

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

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

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

  • :stub_responses (Boolean) — default: false —

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

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

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

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

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be 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_continue_timeout (Float) — default: 1 —

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

  • :http_idle_timeout (Float) — default: 5 —

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

  • :http_open_timeout (Float) — default: 15 —

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

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

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

  • :http_read_timeout (Float) — default: 60 —

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

  • :http_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

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

  • :on_chunk_sent (Proc) —

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

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

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

  • :ssl_ca_directory (String) —

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

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

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



476
477
478
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 476

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. 



3568
3569
3570
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 3568

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. 



3571
3572
3573
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 3571

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({
  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",
        },
      ],
    },
  ],
})

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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

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

  • :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.

Returns:



572
573
574
575
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 572

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: {}) 


3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 3541

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.44.0'
  Seahorse::Client::Request.new(handlers, context)
end

#cancel_metadata_transfer_job(params = {}) ⇒ Types::CancelMetadataTransferJobResponse

Cancels the metadata transfer job.

Examples:

Request syntax with placeholder values


resp = client.cancel_metadata_transfer_job({
  metadata_transfer_job_id: "Id", # required
})

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

Parameters:

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

    ({})

Options Hash (params):

  • :metadata_transfer_job_id (required, String) —

    The metadata transfer job Id.

Returns:



612
613
614
615
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 612

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

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

Creates a component type.

Examples:

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",
    },
  },
})

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

  • :workspace_id (required, String) —

    The ID of the workspace that contains the component type.

  • :is_singleton (Boolean) —

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

  • :component_type_id (required, String) —

    The ID of the component type.

  • :description (String) —

    The description of the component 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.

  • :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.

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

    Metadata that you can use to manage the component type.

  • :property_groups (Hash<String,Types::PropertyGroupRequest>)
  • :component_type_name (String) —

    A friendly name for the component type.

  • :composite_component_types (Hash<String,Types::CompositeComponentTypeRequest>) —

    This is an object that maps strings to ‘compositeComponentTypes` of the `componentType`. `CompositeComponentType` is referenced by `componentTypeId`.

Returns:



775
776
777
778
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 775

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({
  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",
  },
})

Response structure


resp.entity_id #=> String
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):

  • :workspace_id (required, String) —

    The ID of the workspace that contains the entity.

  • :entity_id (String) —

    The ID of the entity.

  • :entity_name (required, String) —

    The name of the entity.

  • :description (String) —

    The description of the entity.

  • :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.

  • :composite_components (Hash<String,Types::CompositeComponentRequest>) —

    This is an object that maps strings to ‘compositeComponent` updates in the request. Each key of the map represents the `componentPath` of the `compositeComponent`.

  • :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.

Returns:



1047
1048
1049
1050
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1047

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

#create_metadata_transfer_job(params = {}) ⇒ Types::CreateMetadataTransferJobResponse

Creates a new metadata transfer job.

Examples:

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
    },
  },
})

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

Parameters:

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

    ({})

Options Hash (params):

  • :metadata_transfer_job_id (String) —

    The metadata transfer job Id.

  • :description (String) —

    The metadata transfer job description.

  • :sources (required, Array<Types::SourceConfiguration>) —

    The metadata transfer job sources.

  • :destination (required, Types::DestinationConfiguration) —

    The metadata transfer job destination.

Returns:



1140
1141
1142
1143
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1140

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

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

Creates a scene.

Examples:

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",
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace that contains the scene.

  • :scene_id (required, String) —

    The ID of the scene.

  • :content_location (required, String) —

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

  • :description (String) —

    The description for this scene.

  • :capabilities (Array<String>) —

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

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

    Metadata that you can use to manage the scene.

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

    The request metadata.

Returns:



1197
1198
1199
1200
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1197

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

#create_sync_job(params = {}) ⇒ Types::CreateSyncJobResponse

This action creates a SyncJob.

Examples:

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",
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The workspace ID.

  • :sync_source (required, String) —

    The sync source.

    <note markdown=“1”> Currently the only supported syncSoource is ‘SITEWISE `.

    </note>
  • :sync_role (required, String) —

    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.

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

    The SyncJob tags.

Returns:



1247
1248
1249
1250
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1247

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

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

Creates a workplace.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace.

  • :description (String) —

    The description of the workspace.

  • :s3_location (String) —

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

  • :role (String) —

    The ARN of the execution role associated with the workspace.

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

    Metadata that you can use to manage the workspace

Returns:



1294
1295
1296
1297
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1294

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({
  workspace_id: "Id", # required
  component_type_id: "ComponentTypeId", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace that contains the component type.

  • :component_type_id (required, String) —

    The ID of the component type to delete.

Returns:



1324
1325
1326
1327
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1324

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({
  workspace_id: "Id", # required
  entity_id: "EntityId", # required
  is_recursive: false,
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

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

  • :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.

Returns:



1359
1360
1361
1362
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1359

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({
  workspace_id: "Id", # required
  scene_id: "Id", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace.

  • :scene_id (required, String) —

    The ID of the scene to delete.

Returns:

  • (Struct) —

    Returns an empty response.



1383
1384
1385
1386
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1383

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

#delete_sync_job(params = {}) ⇒ Types::DeleteSyncJobResponse

Delete the SyncJob.

Examples:

Request syntax with placeholder values


resp = client.delete_sync_job({
  workspace_id: "Id", # required
  sync_source: "SyncSource", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The workspace ID.

  • :sync_source (required, String) —

    The sync source.

    <note markdown=“1”> Currently the only supported syncSource is ‘SITEWISE `.

    </note>

Returns:



1417
1418
1419
1420
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1417

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

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

Deletes a workspace.

Examples:

Request syntax with placeholder values


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

Response structure


resp.message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace to delete.

Returns:



1443
1444
1445
1446
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1443

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

#execute_query(params = {}) ⇒ Types::ExecuteQueryResponse

Run queries to access information from your knowledge graph of entities within individual workspaces.

<note markdown=“1”> The ExecuteQuery action only works with [Amazon Web Services Java SDK2]. ExecuteQuery will not work with any Amazon Web Services Java SDK version &lt; 2.x.

</note>

[1]: docs.aws.amazon.com/sdk-for-java/latest/developer-guide/home.html

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

Examples:

Request syntax with placeholder values


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

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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace.

  • :query_statement (required, String) —

    The query statement.

  • :max_results (Integer) —

    The maximum number of results to return at one time. The default is 50.

  • :next_token (String) —

    The string that specifies the next page of results.

Returns:



1502
1503
1504
1505
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1502

def execute_query(params = {}, options = {})
  req = build_request(:execute_query, 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({
  workspace_id: "Id", # required
  component_type_id: "ComponentTypeId", # required
})

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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace that contains the component type.

  • :component_type_id (required, String) —

    The ID of the component type.

Returns:



1618
1619
1620
1621
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1618

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({
  workspace_id: "Id", # required
  entity_id: "EntityId", # required
})

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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace.

  • :entity_id (required, String) —

    The ID of the entity.

Returns:



1757
1758
1759
1760
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1757

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

#get_metadata_transfer_job(params = {}) ⇒ Types::GetMetadataTransferJobResponse

Gets a nmetadata transfer job.

Examples:

Request syntax with placeholder values


resp = client.get_metadata_transfer_job({
  metadata_transfer_job_id: "Id", # required
})

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

Parameters:

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

    ({})

Options Hash (params):

  • :metadata_transfer_job_id (required, String) —

    The metadata transfer job Id.

Returns:



1826
1827
1828
1829
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1826

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

#get_pricing_plan(params = {}) ⇒ Types::GetPricingPlanResponse

Gets the pricing plan.

Examples:

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"

Parameters:

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

    ({})

Returns:



1859
1860
1861
1862
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 1859

def get_pricing_plan(params = {}, options = {})
  req = build_request(:get_pricing_plan, 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`.

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({
  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",
        },
      },
    ],
  },
})

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

Parameters:

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

    ({})

Options Hash (params):

  • :component_name (String) —

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

  • :component_path (String) —

    This string specifies the path to the composite component, starting from the top-level component.

  • :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.

  • :max_results (Integer) —

    The maximum number of results to return at one time. The default is 25.

    Valid Range: Minimum value of 1. Maximum value of 250.

  • :next_token (String) —

    The string that specifies the next page of results.

  • :property_group_name (String) —

    The property group name.

  • :tabular_conditions (Types::TabularConditions) —

    The tabular conditions.

Returns:



2003
2004
2005
2006
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2003

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({
  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",
})

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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace.

  • :entity_id (String) —

    The ID of the entity.

  • :component_name (String) —

    The name of the component.

  • :component_path (String) —

    This string specifies the path to the composite component, starting from the top-level component.

  • :component_type_id (String) —

    The ID of the component type.

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

    A list of properties whose value histories the request retrieves.

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

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

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

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

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

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

  • :interpolation (Types::InterpolationParameters) —

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

  • :next_token (String) —

    The string that specifies the next page of results.

  • :max_results (Integer) —

    The maximum number of results to return at one time. The default is 25.

    Valid Range: Minimum value of 1. Maximum value of 250.

  • :order_by_time (String) —

    The time direction to use in the result order.

  • :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/iot-twinmaker/latest/apireference/API_PropertyValue.html

  • :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/iot-twinmaker/latest/apireference/API_PropertyValue.html

Returns:



2164
2165
2166
2167
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2164

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({
  workspace_id: "Id", # required
  scene_id: "Id", # required
})

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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace that contains the scene.

  • :scene_id (required, String) —

    The ID of the scene.

Returns:



2218
2219
2220
2221
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2218

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

#get_sync_job(params = {}) ⇒ Types::GetSyncJobResponse

Gets the SyncJob.

Examples:

Request syntax with placeholder values


resp = client.get_sync_job({
  sync_source: "SyncSource", # required
  workspace_id: "Id",
})

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

Parameters:

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

    ({})

Options Hash (params):

  • :sync_source (required, String) —

    The sync source.

    <note markdown=“1”> Currently the only supported syncSource is ‘SITEWISE `.

    </note>
  • :workspace_id (String) —

    The workspace ID.

Returns:



2266
2267
2268
2269
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2266

def get_sync_job(params = {}, options = {})
  req = build_request(:get_sync_job, 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.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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace.

Returns:



2307
2308
2309
2310
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2307

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({
  workspace_id: "Id", # required
  filters: [
    {
      extends_from: "ComponentTypeId",
      namespace: "String",
      is_abstract: false,
    },
  ],
  next_token: "NextToken",
  max_results: 1,
})

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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace.

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

    A list of objects that filter the request.

  • :next_token (String) —

    The string that specifies the next page of results.

  • :max_results (Integer) —

    The maximum number of results to return at one time. The default is 25.

    Valid Range: Minimum value of 1. Maximum value of 250.

Returns:



2371
2372
2373
2374
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2371

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

#list_components(params = {}) ⇒ Types::ListComponentsResponse

This API lists the components of an entity.

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_components({
  workspace_id: "Id", # required
  entity_id: "EntityId", # required
  component_path: "ComponentPath",
  max_results: 1,
  next_token: "NextToken",
})

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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The workspace ID.

  • :entity_id (required, String) —

    The ID for the entity whose metadata (component/properties) is returned by the operation.

  • :component_path (String) —

    This string specifies the path to the composite component, starting from the top-level component.

  • :max_results (Integer) —

    The maximum number of results returned at one time. The default is 25.

  • :next_token (String) —

    The string that specifies the next page of results.

Returns:



2433
2434
2435
2436
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2433

def list_components(params = {}, options = {})
  req = build_request(:list_components, 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({
  workspace_id: "Id", # required
  filters: [
    {
      parent_entity_id: "ParentEntityId",
      component_type_id: "ComponentTypeId",
      external_id: "String",
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace.

  • :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 return at one time. The default is 25.

    Valid Range: Minimum value of 1. Maximum value of 250.

  • :next_token (String) —

    The string that specifies the next page of results.

Returns:



2499
2500
2501
2502
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2499

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

#list_metadata_transfer_jobs(params = {}) ⇒ Types::ListMetadataTransferJobsResponse

Lists the metadata transfer jobs.

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_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,
})

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

Parameters:

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

    ({})

Options Hash (params):

  • :source_type (required, String) —

    The metadata transfer job’s source type.

  • :destination_type (required, String) —

    The metadata transfer job’s destination type.

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

    An object that filters metadata transfer jobs.

  • :next_token (String) —

    The string that specifies the next page of results.

  • :max_results (Integer) —

    The maximum number of results to return at one time.

Returns:



2562
2563
2564
2565
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2562

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

#list_properties(params = {}) ⇒ Types::ListPropertiesResponse

This API lists the properties of a component.

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_properties({
  workspace_id: "Id", # required
  component_name: "Name",
  component_path: "ComponentPath",
  entity_id: "EntityId", # required
  max_results: 1,
  next_token: "NextToken",
})

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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The workspace ID.

  • :component_name (String) —

    The name of the component whose properties are returned by the operation.

  • :component_path (String) —

    This string specifies the path to the composite component, starting from the top-level component.

  • :entity_id (required, String) —

    The ID for the entity whose metadata (component/properties) is returned by the operation.

  • :max_results (Integer) —

    The maximum number of results returned at one time. The default is 25.

  • :next_token (String) —

    The string that specifies the next page of results.

Returns:



2668
2669
2670
2671
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2668

def list_properties(params = {}, options = {})
  req = build_request(:list_properties, 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({
  workspace_id: "Id", # required
  max_results: 1,
  next_token: "NextToken",
})

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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace that contains the scenes.

  • :max_results (Integer) —

    Specifies the maximum number of results to display.

  • :next_token (String) —

    The string that specifies the next page of results.

Returns:



2712
2713
2714
2715
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2712

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

#list_sync_jobs(params = {}) ⇒ Types::ListSyncJobsResponse

List all SyncJobs.

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_sync_jobs({
  workspace_id: "Id", # required
  max_results: 1,
  next_token: "NextToken",
})

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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace that contains the sync job.

  • :max_results (Integer) —

    The maximum number of results to return at one time. The default is 50.

    Valid Range: Minimum value of 0. Maximum value of 200.

  • :next_token (String) —

    The string that specifies the next page of results.

Returns:



2761
2762
2763
2764
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2761

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

#list_sync_resources(params = {}) ⇒ Types::ListSyncResourcesResponse

Lists the sync resources.

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_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",
})

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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace that contains the sync job.

  • :sync_source (required, String) —

    The sync source.

    <note markdown=“1”> Currently the only supported syncSource is ‘SITEWISE `.

    </note>
  • :filters (Array<Types::SyncResourceFilter>) —

    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

  • :max_results (Integer) —

    The maximum number of results to return at one time. The default is 50.

    Valid Range: Minimum value of 0. Maximum value of 200.

  • :next_token (String) —

    The string that specifies the next page of results.

Returns:



2836
2837
2838
2839
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2836

def list_sync_resources(params = {}, options = {})
  req = build_request(:list_sync_resources, 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({
  resource_arn: "TwinMakerArn", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource.

  • :max_results (Integer) —

    The maximum number of results to return at one time. The default is 25.

    Valid Range: Minimum value of 1. Maximum value of 250.

  • :next_token (String) —

    The string that specifies the next page of results.

Returns:



2876
2877
2878
2879
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2876

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

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return at one time. The default is 25.

    Valid Range: Minimum value of 1. Maximum value of 250.

  • :next_token (String) —

    The string that specifies the next page of results.

Returns:



2920
2921
2922
2923
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2920

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.



2946
2947
2948
2949
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2946

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.



2971
2972
2973
2974
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 2971

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({
  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",
    },
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace.

  • :is_singleton (Boolean) —

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

  • :component_type_id (required, String) —

    The ID of the component type.

  • :description (String) —

    The description of the component 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.

  • :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.

  • :property_groups (Hash<String,Types::PropertyGroupRequest>) —

    The property groups.

  • :component_type_name (String) —

    The component type name.

  • :composite_component_types (Hash<String,Types::CompositeComponentTypeRequest>) —

    This is an object that maps strings to ‘compositeComponentTypes` of the `componentType`. `CompositeComponentType` is referenced by `componentTypeId`.

Returns:



3131
3132
3133
3134
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 3131

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({
  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",
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace that contains the entity.

  • :entity_id (required, String) —

    The ID of the entity.

  • :entity_name (String) —

    The name of the entity.

  • :description (String) —

    The description of the entity.

  • :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.

  • :composite_component_updates (Hash<String,Types::CompositeComponentUpdateRequest>) —

    This is an object that maps strings to ‘compositeComponent` updates in the request. Each key of the map represents the `componentPath` of the `compositeComponent`.

  • :parent_entity_update (Types::ParentEntityUpdateRequest) —

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

Returns:



3398
3399
3400
3401
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 3398

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

#update_pricing_plan(params = {}) ⇒ Types::UpdatePricingPlanResponse

Update the pricing plan.

Examples:

Request syntax with placeholder values


resp = client.update_pricing_plan({
  pricing_mode: "BASIC", # required, accepts BASIC, STANDARD, TIERED_BUNDLE
  bundle_names: ["BundleName"],
})

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"

Parameters:

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

    ({})

Options Hash (params):

  • :pricing_mode (required, String) —

    The pricing mode.

  • :bundle_names (Array<String>) —

    The bundle names.

Returns:



3444
3445
3446
3447
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 3444

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

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

Updates a scene.

Examples:

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",
  },
})

Response structure


resp.update_date_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace that contains the scene.

  • :scene_id (required, String) —

    The ID of the scene.

  • :content_location (String) —

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

  • :description (String) —

    The description of this scene.

  • :capabilities (Array<String>) —

    A list of capabilities that the scene uses to render.

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

    The scene metadata.

Returns:



3493
3494
3495
3496
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 3493

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({
  workspace_id: "Id", # required
  description: "Description",
  role: "RoleArn",
  s3_location: "S3Location",
})

Response structure


resp.update_date_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace.

  • :description (String) —

    The description of the workspace.

  • :role (String) —

    The ARN of the execution role associated with the workspace.

  • :s3_location (String) —

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

Returns:



3532
3533
3534
3535
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 3532

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. 


3561
3562
3563
 
# File 'lib/aws-sdk-iottwinmaker/client.rb', line 3561

def waiter_names
  []
end