Struct aws_sdk_iottwinmaker::Client

source · [−]

pub struct Client { /* private fields */ }

Expand description

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.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_iottwinmaker::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_iottwinmaker::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_iottwinmaker::Client::from_conf(config);

Implementations

source

impl Client

source

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

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source

impl Client

source

pub fn batch_put_property_values(&self) -> BatchPutPropertyValues

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>

source

pub fn create_component_type(&self) -> CreateComponentType

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

source

pub fn create_entity(&self) -> CreateEntity

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>

source

pub fn create_scene(&self) -> CreateScene

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

source

pub fn create_workspace(&self) -> CreateWorkspace

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>

source

pub fn delete_component_type(&self) -> DeleteComponentType

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>

source

pub fn delete_entity(&self) -> DeleteEntity

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>

source

pub fn delete_scene(&self) -> DeleteScene

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>

source

pub fn delete_workspace(&self) -> DeleteWorkspace

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>

source

pub fn get_component_type(&self) -> GetComponentType

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.
On failure, responds with SdkError<GetComponentTypeError>

source

pub fn get_entity(&self) -> GetEntity

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.
On failure, responds with SdkError<GetEntityError>

source

pub fn get_property_value(&self) -> GetPropertyValue

Constructs a fluent builder for the GetPropertyValue operation.

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.
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.
On failure, responds with SdkError<GetPropertyValueError>

source

pub fn get_property_value_history(&self) -> GetPropertyValueHistory

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.
- order_by_time(OrderByTime) / set_order_by_time(Option<OrderByTime>):
 The time direction to use in the result order.
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>

source

pub fn get_scene(&self) -> GetScene

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.
On failure, responds with SdkError<GetSceneError>

source

pub fn get_workspace(&self) -> GetWorkspace

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>