Struct aws_sdk_iottwinmaker::Client

pub struct Client { /* private fields */ }

Client for AWS IoT TwinMaker

Client for invoking operations on AWS IoT TwinMaker. Each operation on AWS IoT TwinMaker is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_iottwinmaker::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = aws_config::load_from_env().await;
let config = aws_sdk_iottwinmaker::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the BatchPutPropertyValues operation has a Client::batch_put_property_values, function which returns a builder for that operation. The fluent builder ultimately has a call() function that returns an async future that returns a result, as illustrated below:

let result = client.batch_put_property_values()
    .workspace_id("example")
    .call()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn batch_put_property_values(&self) -> BatchPutPropertyValuesFluentBuilder

Constructs a fluent builder for the BatchPutPropertyValues operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

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

  • entries(Vec<PropertyValueEntry>) / set_entries(Option<Vec<PropertyValueEntry>>):

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

• On success, responds with BatchPutPropertyValuesOutput with field(s):
  • error_entries(Option<Vec<BatchPutPropertyErrorEntry>>):

    Entries that caused errors in the batch put operation.

• On failure, responds with SdkError<BatchPutPropertyValuesError>

impl Client

pub fn create_component_type(&self) -> CreateComponentTypeFluentBuilder

Constructs a fluent builder for the CreateComponentType operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace that contains the component type.

  • is_singleton(bool) / set_is_singleton(Option<bool>):

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

  • component_type_id(impl Into<String>) / set_component_type_id(Option<String>):

    The ID of the component type.

  • description(impl Into<String>) / set_description(Option<String>):

    The description of the component type.

  • property_definitions(HashMap<String, PropertyDefinitionRequest>) / set_property_definitions(Option<HashMap<String, 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(Vec<String>) / set_extends_from(Option<Vec<String>>):

    Specifies the parent component type to extend.

  • functions(HashMap<String, FunctionRequest>) / set_functions(Option<HashMap<String, 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(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    Metadata that you can use to manage the component type.

  • property_groups(HashMap<String, PropertyGroupRequest>) / set_property_groups(Option<HashMap<String, PropertyGroupRequest>>):

  • component_type_name(impl Into<String>) / set_component_type_name(Option<String>):

    A friendly name for the component type.

• On success, responds with CreateComponentTypeOutput with field(s):
  • arn(Option<String>):

    The ARN of the component type.

  • creation_date_time(Option<DateTime>):

    The date and time when the entity was created.

  • state(Option<State>):

    The current state of the component type.

• On failure, responds with SdkError<CreateComponentTypeError>

impl Client

pub fn create_entity(&self) -> CreateEntityFluentBuilder

Constructs a fluent builder for the CreateEntity operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace that contains the entity.

  • entity_id(impl Into<String>) / set_entity_id(Option<String>):

    The ID of the entity.

  • entity_name(impl Into<String>) / set_entity_name(Option<String>):

    The name of the entity.

  • description(impl Into<String>) / set_description(Option<String>):

    The description of the entity.

  • components(HashMap<String, ComponentRequest>) / set_components(Option<HashMap<String, ComponentRequest>>):

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

  • parent_entity_id(impl Into<String>) / set_parent_entity_id(Option<String>):

    The ID of the entity’s parent entity.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    Metadata that you can use to manage the entity.

• On success, responds with CreateEntityOutput with field(s):
  • entity_id(Option<String>):

    The ID of the entity.

  • arn(Option<String>):

    The ARN of the entity.

  • creation_date_time(Option<DateTime>):

    The date and time when the entity was created.

  • state(Option<State>):

    The current state of the entity.

• On failure, responds with SdkError<CreateEntityError>

impl Client

pub fn create_scene(&self) -> CreateSceneFluentBuilder

Constructs a fluent builder for the CreateScene operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace that contains the scene.

  • scene_id(impl Into<String>) / set_scene_id(Option<String>):

    The ID of the scene.

  • content_location(impl Into<String>) / set_content_location(Option<String>):

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

  • description(impl Into<String>) / set_description(Option<String>):

    The description for this scene.

  • capabilities(Vec<String>) / set_capabilities(Option<Vec<String>>):

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

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    Metadata that you can use to manage the scene.

  • scene_metadata(HashMap<String, String>) / set_scene_metadata(Option<HashMap<String, String>>):

    The request metadata.

• On success, responds with CreateSceneOutput with field(s):
  • arn(Option<String>):

    The ARN of the scene.

  • creation_date_time(Option<DateTime>):

    The date and time when the scene was created.

• On failure, responds with SdkError<CreateSceneError>

impl Client

pub fn create_sync_job(&self) -> CreateSyncJobFluentBuilder

Constructs a fluent builder for the CreateSyncJob operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The workspace ID.

  • sync_source(impl Into<String>) / set_sync_source(Option<String>):

    The sync source.

    Currently the only supported syncSoource is SITEWISE .

  • sync_role(impl Into<String>) / set_sync_role(Option<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(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    The SyncJob tags.

• On success, responds with CreateSyncJobOutput with field(s):
  • arn(Option<String>):

    The SyncJob ARN.

  • creation_date_time(Option<DateTime>):

    The date and time for the SyncJob creation.

  • state(Option<SyncJobState>):

    The SyncJob response state.

• On failure, responds with SdkError<CreateSyncJobError>

impl Client

pub fn create_workspace(&self) -> CreateWorkspaceFluentBuilder

Constructs a fluent builder for the CreateWorkspace operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace.

  • description(impl Into<String>) / set_description(Option<String>):

    The description of the workspace.

  • s3_location(impl Into<String>) / set_s3_location(Option<String>):

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

  • role(impl Into<String>) / set_role(Option<String>):

    The ARN of the execution role associated with the workspace.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    Metadata that you can use to manage the workspace

• On success, responds with CreateWorkspaceOutput with field(s):
  • arn(Option<String>):

    The ARN of the workspace.

  • creation_date_time(Option<DateTime>):

    The date and time when the workspace was created.

• On failure, responds with SdkError<CreateWorkspaceError>

impl Client

pub fn delete_component_type(&self) -> DeleteComponentTypeFluentBuilder

Constructs a fluent builder for the DeleteComponentType operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace that contains the component type.

  • component_type_id(impl Into<String>) / set_component_type_id(Option<String>):

    The ID of the component type to delete.

• On success, responds with DeleteComponentTypeOutput with field(s):
  • state(Option<State>):

    The current state of the component type to be deleted.

• On failure, responds with SdkError<DeleteComponentTypeError>

impl Client

pub fn delete_entity(&self) -> DeleteEntityFluentBuilder

Constructs a fluent builder for the DeleteEntity operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

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

  • entity_id(impl Into<String>) / set_entity_id(Option<String>):

    The ID of the entity to delete.

  • is_recursive(bool) / set_is_recursive(Option<bool>):

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

• On success, responds with DeleteEntityOutput with field(s):
  • state(Option<State>):

    The current state of the deleted entity.

• On failure, responds with SdkError<DeleteEntityError>

impl Client

pub fn delete_scene(&self) -> DeleteSceneFluentBuilder

Constructs a fluent builder for the DeleteScene operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace.

  • scene_id(impl Into<String>) / set_scene_id(Option<String>):

    The ID of the scene to delete.

• On success, responds with DeleteSceneOutput
• On failure, responds with SdkError<DeleteSceneError>

impl Client

pub fn delete_sync_job(&self) -> DeleteSyncJobFluentBuilder

Constructs a fluent builder for the DeleteSyncJob operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The workspace ID.

  • sync_source(impl Into<String>) / set_sync_source(Option<String>):

    The sync source.

    Currently the only supported syncSource is SITEWISE .

• On success, responds with DeleteSyncJobOutput with field(s):
  • state(Option<SyncJobState>):

    The SyncJob response state.

• On failure, responds with SdkError<DeleteSyncJobError>

impl Client

pub fn delete_workspace(&self) -> DeleteWorkspaceFluentBuilder

Constructs a fluent builder for the DeleteWorkspace operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace to delete.

• On success, responds with DeleteWorkspaceOutput
• On failure, responds with SdkError<DeleteWorkspaceError>

impl Client

pub fn execute_query(&self) -> ExecuteQueryFluentBuilder

Constructs a fluent builder for the ExecuteQuery operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace.

  • query_statement(impl Into<String>) / set_query_statement(Option<String>):

    The query statement.

  • max_results(i32) / set_max_results(Option<i32>):

    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(impl Into<String>) / set_next_token(Option<String>):

    The string that specifies the next page of results.

• On success, responds with ExecuteQueryOutput with field(s):
  • column_descriptions(Option<Vec<ColumnDescription>>):

    A list of ColumnDescription objects.

  • rows(Option<Vec<Row>>):

    Represents a single row in the query results.

  • next_token(Option<String>):

    The string that specifies the next page of results.

• On failure, responds with SdkError<ExecuteQueryError>

impl Client

pub fn get_component_type(&self) -> GetComponentTypeFluentBuilder

Constructs a fluent builder for the GetComponentType operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace that contains the component type.

  • component_type_id(impl Into<String>) / set_component_type_id(Option<String>):

    The ID of the component type.

• On success, responds with GetComponentTypeOutput with field(s):
  • workspace_id(Option<String>):

    The ID of the workspace that contains the component type.

  • is_singleton(Option<bool>):

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

  • component_type_id(Option<String>):

    The ID of the component type.

  • description(Option<String>):

    The description of the component type.

  • property_definitions(Option<HashMap<String, PropertyDefinitionResponse>>):

    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(Option<Vec<String>>):

    The name of the parent component type that this component type extends.

  • functions(Option<HashMap<String, FunctionResponse>>):

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

  • creation_date_time(Option<DateTime>):

    The date and time when the component type was created.

  • update_date_time(Option<DateTime>):

    The date and time when the component was last updated.

  • arn(Option<String>):

    The ARN of the component type.

  • is_abstract(Option<bool>):

    A Boolean value that specifies whether the component type is abstract.

  • is_schema_initialized(Option<bool>):

    A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.

  • status(Option<Status>):

    The current status of the component type.

  • property_groups(Option<HashMap<String, PropertyGroupResponse>>):

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

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

  • sync_source(Option<String>):

    The syncSource of the SyncJob, if this entity was created by a SyncJob.

  • component_type_name(Option<String>):

    The component type name.

• On failure, responds with SdkError<GetComponentTypeError>

impl Client

pub fn get_entity(&self) -> GetEntityFluentBuilder

Constructs a fluent builder for the GetEntity operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace.

  • entity_id(impl Into<String>) / set_entity_id(Option<String>):

    The ID of the entity.

• On success, responds with GetEntityOutput with field(s):
  • entity_id(Option<String>):

    The ID of the entity.

  • entity_name(Option<String>):

    The name of the entity.

  • arn(Option<String>):

    The ARN of the entity.

  • status(Option<Status>):

    The current status of the entity.

  • workspace_id(Option<String>):

    The ID of the workspace.

  • description(Option<String>):

    The description of the entity.

  • components(Option<HashMap<String, ComponentResponse>>):

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

  • parent_entity_id(Option<String>):

    The ID of the parent entity for this entity.

  • has_child_entities(Option<bool>):

    A Boolean value that specifies whether the entity has associated child entities.

  • creation_date_time(Option<DateTime>):

    The date and time when the entity was created.

  • update_date_time(Option<DateTime>):

    The date and time when the entity was last updated.

  • sync_source(Option<String>):

    The syncSource of the sync job, if this entity was created by a sync job.

• On failure, responds with SdkError<GetEntityError>

impl Client

pub fn get_pricing_plan(&self) -> GetPricingPlanFluentBuilder

Constructs a fluent builder for the GetPricingPlan operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetPricingPlanOutput with field(s):
  • current_pricing_plan(Option<PricingPlan>):

    The chosen pricing plan for the current billing cycle.

  • pending_pricing_plan(Option<PricingPlan>):

    The pending pricing plan.

• On failure, responds with SdkError<GetPricingPlanError>

impl Client

pub fn get_property_value(&self) -> GetPropertyValueFluentBuilder

Constructs a fluent builder for the GetPropertyValue operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • component_name(impl Into<String>) / set_component_name(Option<String>):

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

  • component_type_id(impl Into<String>) / set_component_type_id(Option<String>):

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

  • entity_id(impl Into<String>) / set_entity_id(Option<String>):

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

  • selected_properties(Vec<String>) / set_selected_properties(Option<Vec<String>>):

    The properties whose values the operation returns.

  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace whose values the operation returns.

  • max_results(i32) / set_max_results(Option<i32>):

    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(impl Into<String>) / set_next_token(Option<String>):

    The string that specifies the next page of results.

  • property_group_name(impl Into<String>) / set_property_group_name(Option<String>):

    The property group name.

  • tabular_conditions(TabularConditions) / set_tabular_conditions(Option<TabularConditions>):

    The tabular conditions.

• On success, responds with GetPropertyValueOutput with field(s):
  • property_values(Option<HashMap<String, PropertyLatestValue>>):

    An object that maps strings to the properties and latest property values in the response. Each string in the mapping must be unique to this object.

  • next_token(Option<String>):

    The string that specifies the next page of results.

  • tabular_property_values(Option<Vec<Vec<HashMap<String, DataValue>>>>):

    A table of property values.

• On failure, responds with SdkError<GetPropertyValueError>

impl Client

pub fn get_property_value_history(&self) -> GetPropertyValueHistoryFluentBuilder

Constructs a fluent builder for the GetPropertyValueHistory operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace.

  • entity_id(impl Into<String>) / set_entity_id(Option<String>):

    The ID of the entity.

  • component_name(impl Into<String>) / set_component_name(Option<String>):

    The name of the component.

  • component_type_id(impl Into<String>) / set_component_type_id(Option<String>):

    The ID of the component type.

  • selected_properties(Vec<String>) / set_selected_properties(Option<Vec<String>>):

    A list of properties whose value histories the request retrieves.

  • property_filters(Vec<PropertyFilter>) / set_property_filters(Option<Vec<PropertyFilter>>):

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

  • start_date_time(DateTime) / set_start_date_time(Option<DateTime>):

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

  • end_date_time(DateTime) / set_end_date_time(Option<DateTime>):

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

  • interpolation(InterpolationParameters) / set_interpolation(Option<InterpolationParameters>):

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

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The string that specifies the next page of results.

  • max_results(i32) / set_max_results(Option<i32>):

    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(OrderByTime) / set_order_by_time(Option<OrderByTime>):

    The time direction to use in the result order.

  • start_time(impl Into<String>) / set_start_time(Option<String>):

    The ISO8601 DateTime of the earliest property value to return.

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

  • end_time(impl Into<String>) / set_end_time(Option<String>):

    The ISO8601 DateTime of the latest property value to return.

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

• On success, responds with GetPropertyValueHistoryOutput with field(s):
  • property_values(Option<Vec<PropertyValueHistory>>):

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

  • next_token(Option<String>):

    The string that specifies the next page of results.

• On failure, responds with SdkError<GetPropertyValueHistoryError>

impl Client

pub fn get_scene(&self) -> GetSceneFluentBuilder

Constructs a fluent builder for the GetScene operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace that contains the scene.

  • scene_id(impl Into<String>) / set_scene_id(Option<String>):

    The ID of the scene.

• On success, responds with GetSceneOutput with field(s):
  • workspace_id(Option<String>):

    The ID of the workspace that contains the scene.

  • scene_id(Option<String>):

    The ID of the scene.

  • content_location(Option<String>):

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

  • arn(Option<String>):

    The ARN of the scene.

  • creation_date_time(Option<DateTime>):

    The date and time when the scene was created.

  • update_date_time(Option<DateTime>):

    The date and time when the scene was last updated.

  • description(Option<String>):

    The description of the scene.

  • capabilities(Option<Vec<String>>):

    A list of capabilities that the scene uses to render.

  • scene_metadata(Option<HashMap<String, String>>):

    The response metadata.

  • generated_scene_metadata(Option<HashMap<String, String>>):

    The generated scene metadata.

• On failure, responds with SdkError<GetSceneError>

impl Client

pub fn get_sync_job(&self) -> GetSyncJobFluentBuilder

Constructs a fluent builder for the GetSyncJob operation.

• The fluent builder is configurable:
  • sync_source(impl Into<String>) / set_sync_source(Option<String>):

    The sync source.

    Currently the only supported syncSource is SITEWISE .

  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The workspace ID.

• On success, responds with GetSyncJobOutput with field(s):
  • arn(Option<String>):

    The sync job ARN.

  • workspace_id(Option<String>):

    The ID of the workspace that contains the sync job.

  • sync_source(Option<String>):

    The sync soucre.

    Currently the only supported syncSource is SITEWISE .

  • sync_role(Option<String>):

    The sync IAM role.

  • status(Option<SyncJobStatus>):

    The SyncJob response status.

  • creation_date_time(Option<DateTime>):

    The creation date and time.

  • update_date_time(Option<DateTime>):

    The update date and time.

• On failure, responds with SdkError<GetSyncJobError>

impl Client

pub fn get_workspace(&self) -> GetWorkspaceFluentBuilder

Constructs a fluent builder for the GetWorkspace operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace.

• On success, responds with GetWorkspaceOutput with field(s):
  • workspace_id(Option<String>):

    The ID of the workspace.

  • arn(Option<String>):

    The ARN of the workspace.

  • description(Option<String>):

    The description of the workspace.

  • s3_location(Option<String>):

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

  • role(Option<String>):

    The ARN of the execution role associated with the workspace.

  • creation_date_time(Option<DateTime>):

    The date and time when the workspace was created.

  • update_date_time(Option<DateTime>):

    The date and time when the workspace was last updated.

• On failure, responds with SdkError<GetWorkspaceError>

impl Client

pub fn list_component_types(&self) -> ListComponentTypesFluentBuilder

Constructs a fluent builder for the ListComponentTypes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace.

  • filters(Vec<ListComponentTypesFilter>) / set_filters(Option<Vec<ListComponentTypesFilter>>):

    A list of objects that filter the request.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The string that specifies the next page of results.

  • max_results(i32) / set_max_results(Option<i32>):

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

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

• On success, responds with ListComponentTypesOutput with field(s):
  • workspace_id(Option<String>):

    The ID of the workspace.

  • component_type_summaries(Option<Vec<ComponentTypeSummary>>):

    A list of objects that contain information about the component types.

  • next_token(Option<String>):

    The string that specifies the next page of results.

  • max_results(Option<i32>):

    Specifies the maximum number of results to display.

• On failure, responds with SdkError<ListComponentTypesError>

impl Client

pub fn list_entities(&self) -> ListEntitiesFluentBuilder

Constructs a fluent builder for the ListEntities operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace.

  • filters(Vec<ListEntitiesFilter>) / set_filters(Option<Vec<ListEntitiesFilter>>):

    A list of objects that filter the request.

    Only one object is accepted as a valid input.

  • max_results(i32) / set_max_results(Option<i32>):

    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(impl Into<String>) / set_next_token(Option<String>):

    The string that specifies the next page of results.

• On success, responds with ListEntitiesOutput with field(s):
  • entity_summaries(Option<Vec<EntitySummary>>):

    A list of objects that contain information about the entities.

  • next_token(Option<String>):

    The string that specifies the next page of results.

• On failure, responds with SdkError<ListEntitiesError>

impl Client

pub fn list_scenes(&self) -> ListScenesFluentBuilder

Constructs a fluent builder for the ListScenes operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace that contains the scenes.

  • max_results(i32) / set_max_results(Option<i32>):

    Specifies the maximum number of results to display.

  • next_token(impl Into<String>) / set_next_token(Option<String>):

    The string that specifies the next page of results.

• On success, responds with ListScenesOutput with field(s):
  • scene_summaries(Option<Vec<SceneSummary>>):

    A list of objects that contain information about the scenes.

  • next_token(Option<String>):

    The string that specifies the next page of results.

• On failure, responds with SdkError<ListScenesError>

impl Client

pub fn list_sync_jobs(&self) -> ListSyncJobsFluentBuilder

Constructs a fluent builder for the ListSyncJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace that contains the sync job.

  • max_results(i32) / set_max_results(Option<i32>):

    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(impl Into<String>) / set_next_token(Option<String>):

    The string that specifies the next page of results.

• On success, responds with ListSyncJobsOutput with field(s):
  • sync_job_summaries(Option<Vec<SyncJobSummary>>):

    The listed SyncJob summaries.

  • next_token(Option<String>):

    The string that specifies the next page of results.

• On failure, responds with SdkError<ListSyncJobsError>

impl Client

pub fn list_sync_resources(&self) -> ListSyncResourcesFluentBuilder

Constructs a fluent builder for the ListSyncResources operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace that contains the sync job.

  • sync_source(impl Into<String>) / set_sync_source(Option<String>):

    The sync source.

    Currently the only supported syncSource is SITEWISE .

  • filters(Vec<SyncResourceFilter>) / set_filters(Option<Vec<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(i32) / set_max_results(Option<i32>):

    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(impl Into<String>) / set_next_token(Option<String>):

    The string that specifies the next page of results.

• On success, responds with ListSyncResourcesOutput with field(s):
  • sync_resources(Option<Vec<SyncResourceSummary>>):

    The sync resources.

  • next_token(Option<String>):

    The string that specifies the next page of results.

• On failure, responds with SdkError<ListSyncResourcesError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The ARN of the resource.

  • max_results(i32) / set_max_results(Option<i32>):

    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(impl Into<String>) / set_next_token(Option<String>):

    The string that specifies the next page of results.

• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap<String, String>>):

    Metadata that you can use to manage a resource.

  • next_token(Option<String>):

    The string that specifies the next page of results.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_workspaces(&self) -> ListWorkspacesFluentBuilder

Constructs a fluent builder for the ListWorkspaces operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):

    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(impl Into<String>) / set_next_token(Option<String>):

    The string that specifies the next page of results.

• On success, responds with ListWorkspacesOutput with field(s):
  • workspace_summaries(Option<Vec<WorkspaceSummary>>):

    A list of objects that contain information about the workspaces.

  • next_token(Option<String>):

    The string that specifies the next page of results.

• On failure, responds with SdkError<ListWorkspacesError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The ARN of the resource.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    Metadata to add to this resource.

• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The ARN of the resource.

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<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.

• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_component_type(&self) -> UpdateComponentTypeFluentBuilder

Constructs a fluent builder for the UpdateComponentType operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace.

  • is_singleton(bool) / set_is_singleton(Option<bool>):

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

  • component_type_id(impl Into<String>) / set_component_type_id(Option<String>):

    The ID of the component type.

  • description(impl Into<String>) / set_description(Option<String>):

    The description of the component type.

  • property_definitions(HashMap<String, PropertyDefinitionRequest>) / set_property_definitions(Option<HashMap<String, 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(Vec<String>) / set_extends_from(Option<Vec<String>>):

    Specifies the component type that this component type extends.

  • functions(HashMap<String, FunctionRequest>) / set_functions(Option<HashMap<String, 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(HashMap<String, PropertyGroupRequest>) / set_property_groups(Option<HashMap<String, PropertyGroupRequest>>):

    The property groups.

  • component_type_name(impl Into<String>) / set_component_type_name(Option<String>):

    The component type name.

• On success, responds with UpdateComponentTypeOutput with field(s):
  • workspace_id(Option<String>):

    The ID of the workspace that contains the component type.

  • arn(Option<String>):

    The ARN of the component type.

  • component_type_id(Option<String>):

    The ID of the component type.

  • state(Option<State>):

    The current state of the component type.

• On failure, responds with SdkError<UpdateComponentTypeError>

impl Client

pub fn update_entity(&self) -> UpdateEntityFluentBuilder

Constructs a fluent builder for the UpdateEntity operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace that contains the entity.

  • entity_id(impl Into<String>) / set_entity_id(Option<String>):

    The ID of the entity.

  • entity_name(impl Into<String>) / set_entity_name(Option<String>):

    The name of the entity.

  • description(impl Into<String>) / set_description(Option<String>):

    The description of the entity.

  • component_updates(HashMap<String, ComponentUpdateRequest>) / set_component_updates(Option<HashMap<String, ComponentUpdateRequest>>):

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

  • parent_entity_update(ParentEntityUpdateRequest) / set_parent_entity_update(Option<ParentEntityUpdateRequest>):

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

• On success, responds with UpdateEntityOutput with field(s):
  • update_date_time(Option<DateTime>):

    The date and time when the entity was last updated.

  • state(Option<State>):

    The current state of the entity update.

• On failure, responds with SdkError<UpdateEntityError>

impl Client

pub fn update_pricing_plan(&self) -> UpdatePricingPlanFluentBuilder

Constructs a fluent builder for the UpdatePricingPlan operation.

• The fluent builder is configurable:
  • pricing_mode(PricingMode) / set_pricing_mode(Option<PricingMode>):

    The pricing mode.

  • bundle_names(Vec<String>) / set_bundle_names(Option<Vec<String>>):

    The bundle names.

• On success, responds with UpdatePricingPlanOutput with field(s):
  • current_pricing_plan(Option<PricingPlan>):

    Update the current pricing plan.

  • pending_pricing_plan(Option<PricingPlan>):

    Update the pending pricing plan.

• On failure, responds with SdkError<UpdatePricingPlanError>

impl Client

pub fn update_scene(&self) -> UpdateSceneFluentBuilder

Constructs a fluent builder for the UpdateScene operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace that contains the scene.

  • scene_id(impl Into<String>) / set_scene_id(Option<String>):

    The ID of the scene.

  • content_location(impl Into<String>) / set_content_location(Option<String>):

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

  • description(impl Into<String>) / set_description(Option<String>):

    The description of this scene.

  • capabilities(Vec<String>) / set_capabilities(Option<Vec<String>>):

    A list of capabilities that the scene uses to render.

  • scene_metadata(HashMap<String, String>) / set_scene_metadata(Option<HashMap<String, String>>):

    The scene metadata.

• On success, responds with UpdateSceneOutput with field(s):
  • update_date_time(Option<DateTime>):

    The date and time when the scene was last updated.

• On failure, responds with SdkError<UpdateSceneError>

impl Client

pub fn update_workspace(&self) -> UpdateWorkspaceFluentBuilder

Constructs a fluent builder for the UpdateWorkspace operation.

• The fluent builder is configurable:
  • workspace_id(impl Into<String>) / set_workspace_id(Option<String>):

    The ID of the workspace.

  • description(impl Into<String>) / set_description(Option<String>):

    The description of the workspace.

  • role(impl Into<String>) / set_role(Option<String>):

    The ARN of the execution role associated with the workspace.

• On success, responds with UpdateWorkspaceOutput with field(s):
  • update_date_time(Option<DateTime>):

    The date and time of the current update.

• On failure, responds with SdkError<UpdateWorkspaceError>

impl Client

pub fn with_config( client: Client<DynConnector, DynMiddleware<DynConnector>>, conf: Config ) -> Self

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

• This method will panic if the conf is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the conf is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client

fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self

Converts to this type from the input type.