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.
§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 values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Builder
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 send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.batch_put_property_values()
.workspace_id("example")
.send()
.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§
Source§impl Client
impl Client
Sourcepub fn batch_put_property_values(&self) -> BatchPutPropertyValuesFluentBuilder
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>)
:
required: trueThe ID of the workspace that contains the properties to set.
entries(PropertyValueEntry)
/set_entries(Option<Vec::<PropertyValueEntry>>)
:
required: trueAn 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(Vec::<BatchPutPropertyErrorEntry>)
:Entries that caused errors in the batch put operation.
- On failure, responds with
SdkError<BatchPutPropertyValuesError>
Source§impl Client
impl Client
Sourcepub fn cancel_metadata_transfer_job(
&self,
) -> CancelMetadataTransferJobFluentBuilder
pub fn cancel_metadata_transfer_job( &self, ) -> CancelMetadataTransferJobFluentBuilder
Constructs a fluent builder for the CancelMetadataTransferJob
operation.
- The fluent builder is configurable:
metadata_transfer_job_id(impl Into<String>)
/set_metadata_transfer_job_id(Option<String>)
:
required: trueThe metadata transfer job Id.
- On success, responds with
CancelMetadataTransferJobOutput
with field(s):metadata_transfer_job_id(String)
:The metadata transfer job Id.
arn(String)
:The metadata transfer job ARN.
update_date_time(DateTime)
:Used to update the DateTime property.
status(Option<MetadataTransferJobStatus>)
:The metadata transfer job’s status.
progress(Option<MetadataTransferJobProgress>)
:The metadata transfer job’s progress.
- On failure, responds with
SdkError<CancelMetadataTransferJobError>
Source§impl Client
impl Client
Sourcepub fn create_component_type(&self) -> CreateComponentTypeFluentBuilder
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>)
:
required: trueThe ID of the workspace that contains the component type.
is_singleton(bool)
/set_is_singleton(Option<bool>)
:
required: falseA 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>)
:
required: trueThe ID of the component type.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the component type.
property_definitions(impl Into<String>, PropertyDefinitionRequest)
/set_property_definitions(Option<HashMap::<String, PropertyDefinitionRequest>>)
:
required: falseAn 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(impl Into<String>)
/set_extends_from(Option<Vec::<String>>)
:
required: falseSpecifies the parent component type to extend.
functions(impl Into<String>, FunctionRequest)
/set_functions(Option<HashMap::<String, FunctionRequest>>)
:
required: falseAn object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseMetadata that you can use to manage the component type.
property_groups(impl Into<String>, PropertyGroupRequest)
/set_property_groups(Option<HashMap::<String, PropertyGroupRequest>>)
:
required: falsecomponent_type_name(impl Into<String>)
/set_component_type_name(Option<String>)
:
required: falseA friendly name for the component type.
composite_component_types(impl Into<String>, CompositeComponentTypeRequest)
/set_composite_component_types(Option<HashMap::<String, CompositeComponentTypeRequest>>)
:
required: falseThis is an object that maps strings to
compositeComponentTypes
of thecomponentType
.CompositeComponentType
is referenced bycomponentTypeId
.
- On success, responds with
CreateComponentTypeOutput
with field(s):arn(String)
:The ARN of the component type.
creation_date_time(DateTime)
:The date and time when the entity was created.
state(State)
:The current state of the component type.
- On failure, responds with
SdkError<CreateComponentTypeError>
Source§impl Client
impl Client
Sourcepub fn create_entity(&self) -> CreateEntityFluentBuilder
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>)
:
required: trueThe ID of the workspace that contains the entity.
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:
required: falseThe ID of the entity.
entity_name(impl Into<String>)
/set_entity_name(Option<String>)
:
required: trueThe name of the entity.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the entity.
components(impl Into<String>, ComponentRequest)
/set_components(Option<HashMap::<String, ComponentRequest>>)
:
required: falseAn object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
composite_components(impl Into<String>, CompositeComponentRequest)
/set_composite_components(Option<HashMap::<String, CompositeComponentRequest>>)
:
required: falseThis is an object that maps strings to
compositeComponent
updates in the request. Each key of the map represents thecomponentPath
of thecompositeComponent
.parent_entity_id(impl Into<String>)
/set_parent_entity_id(Option<String>)
:
required: falseThe ID of the entity’s parent entity.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseMetadata that you can use to manage the entity.
- On success, responds with
CreateEntityOutput
with field(s):entity_id(String)
:The ID of the entity.
arn(String)
:The ARN of the entity.
creation_date_time(DateTime)
:The date and time when the entity was created.
state(State)
:The current state of the entity.
- On failure, responds with
SdkError<CreateEntityError>
Source§impl Client
impl Client
Sourcepub fn create_metadata_transfer_job(
&self,
) -> CreateMetadataTransferJobFluentBuilder
pub fn create_metadata_transfer_job( &self, ) -> CreateMetadataTransferJobFluentBuilder
Constructs a fluent builder for the CreateMetadataTransferJob
operation.
- The fluent builder is configurable:
metadata_transfer_job_id(impl Into<String>)
/set_metadata_transfer_job_id(Option<String>)
:
required: falseThe metadata transfer job Id.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe metadata transfer job description.
sources(SourceConfiguration)
/set_sources(Option<Vec::<SourceConfiguration>>)
:
required: trueThe metadata transfer job sources.
destination(DestinationConfiguration)
/set_destination(Option<DestinationConfiguration>)
:
required: trueThe metadata transfer job destination.
- On success, responds with
CreateMetadataTransferJobOutput
with field(s):metadata_transfer_job_id(String)
:The metadata transfer job Id.
arn(String)
:The metadata transfer job ARN.
creation_date_time(DateTime)
:The The metadata transfer job creation DateTime property.
status(Option<MetadataTransferJobStatus>)
:The metadata transfer job response status.
- On failure, responds with
SdkError<CreateMetadataTransferJobError>
Source§impl Client
impl Client
Sourcepub fn create_scene(&self) -> CreateSceneFluentBuilder
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>)
:
required: trueThe ID of the workspace that contains the scene.
scene_id(impl Into<String>)
/set_scene_id(Option<String>)
:
required: trueThe ID of the scene.
content_location(impl Into<String>)
/set_content_location(Option<String>)
:
required: trueThe relative path that specifies the location of the content definition file.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description for this scene.
capabilities(impl Into<String>)
/set_capabilities(Option<Vec::<String>>)
:
required: falseA list of capabilities that the scene uses to render itself.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseMetadata that you can use to manage the scene.
scene_metadata(impl Into<String>, impl Into<String>)
/set_scene_metadata(Option<HashMap::<String, String>>)
:
required: falseThe request metadata.
- On success, responds with
CreateSceneOutput
with field(s):arn(String)
:The ARN of the scene.
creation_date_time(DateTime)
:The date and time when the scene was created.
- On failure, responds with
SdkError<CreateSceneError>
Source§impl Client
impl Client
Sourcepub fn create_sync_job(&self) -> CreateSyncJobFluentBuilder
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>)
:
required: trueThe workspace ID.
sync_source(impl Into<String>)
/set_sync_source(Option<String>)
:
required: trueThe sync source.
Currently the only supported syncSoource is
SITEWISE
.sync_role(impl Into<String>)
/set_sync_role(Option<String>)
:
required: trueThe 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(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe SyncJob tags.
- On success, responds with
CreateSyncJobOutput
with field(s):arn(String)
:The SyncJob ARN.
creation_date_time(DateTime)
:The date and time for the SyncJob creation.
state(SyncJobState)
:The SyncJob response state.
- On failure, responds with
SdkError<CreateSyncJobError>
Source§impl Client
impl Client
Sourcepub fn create_workspace(&self) -> CreateWorkspaceFluentBuilder
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>)
:
required: trueThe ID of the workspace.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the workspace.
s3_location(impl Into<String>)
/set_s3_location(Option<String>)
:
required: falseThe ARN of the S3 bucket where resources associated with the workspace are stored.
role(impl Into<String>)
/set_role(Option<String>)
:
required: falseThe ARN of the execution role associated with the workspace.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseMetadata that you can use to manage the workspace
- On success, responds with
CreateWorkspaceOutput
with field(s):arn(String)
:The ARN of the workspace.
creation_date_time(DateTime)
:The date and time when the workspace was created.
- On failure, responds with
SdkError<CreateWorkspaceError>
Source§impl Client
impl Client
Sourcepub fn delete_component_type(&self) -> DeleteComponentTypeFluentBuilder
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>)
:
required: trueThe ID of the workspace that contains the component type.
component_type_id(impl Into<String>)
/set_component_type_id(Option<String>)
:
required: trueThe ID of the component type to delete.
- On success, responds with
DeleteComponentTypeOutput
with field(s):state(State)
:The current state of the component type to be deleted.
- On failure, responds with
SdkError<DeleteComponentTypeError>
Source§impl Client
impl Client
Sourcepub fn delete_entity(&self) -> DeleteEntityFluentBuilder
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>)
:
required: trueThe ID of the workspace that contains the entity to delete.
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:
required: trueThe ID of the entity to delete.
is_recursive(bool)
/set_is_recursive(Option<bool>)
:
required: falseA Boolean value that specifies whether the operation deletes child entities.
- On success, responds with
DeleteEntityOutput
with field(s):state(State)
:The current state of the deleted entity.
- On failure, responds with
SdkError<DeleteEntityError>
Source§impl Client
impl Client
Sourcepub fn delete_scene(&self) -> DeleteSceneFluentBuilder
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>)
:
required: trueThe ID of the workspace.
scene_id(impl Into<String>)
/set_scene_id(Option<String>)
:
required: trueThe ID of the scene to delete.
- On success, responds with
DeleteSceneOutput
- On failure, responds with
SdkError<DeleteSceneError>
Source§impl Client
impl Client
Sourcepub fn delete_sync_job(&self) -> DeleteSyncJobFluentBuilder
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>)
:
required: trueThe workspace ID.
sync_source(impl Into<String>)
/set_sync_source(Option<String>)
:
required: trueThe sync source.
Currently the only supported syncSource is
SITEWISE
.
- On success, responds with
DeleteSyncJobOutput
with field(s):state(SyncJobState)
:The SyncJob response state.
- On failure, responds with
SdkError<DeleteSyncJobError>
Source§impl Client
impl Client
Sourcepub fn delete_workspace(&self) -> DeleteWorkspaceFluentBuilder
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>)
:
required: trueThe ID of the workspace to delete.
- On success, responds with
DeleteWorkspaceOutput
with field(s):message(Option<String>)
:The string that specifies the delete result for the workspace.
- On failure, responds with
SdkError<DeleteWorkspaceError>
Source§impl Client
impl Client
Sourcepub fn execute_query(&self) -> ExecuteQueryFluentBuilder
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>)
:
required: trueThe ID of the workspace.
query_statement(impl Into<String>)
/set_query_statement(Option<String>)
:
required: trueThe query statement.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return at one time. The default is 50.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn get_component_type(&self) -> GetComponentTypeFluentBuilder
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>)
:
required: trueThe ID of the workspace that contains the component type.
component_type_id(impl Into<String>)
/set_component_type_id(Option<String>)
:
required: trueThe ID of the component type.
- On success, responds with
GetComponentTypeOutput
with field(s):workspace_id(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(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(DateTime)
:The date and time when the component type was created.
update_date_time(DateTime)
:The date and time when the component was last updated.
arn(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.
composite_component_types(Option<HashMap::<String, CompositeComponentTypeResponse>>)
:This is an object that maps strings to
compositeComponentTypes
of thecomponentType
.CompositeComponentType
is referenced bycomponentTypeId
.
- On failure, responds with
SdkError<GetComponentTypeError>
Source§impl Client
impl Client
Sourcepub fn get_entity(&self) -> GetEntityFluentBuilder
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>)
:
required: trueThe ID of the workspace.
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:
required: trueThe ID of the entity.
- On success, responds with
GetEntityOutput
with field(s):entity_id(String)
:The ID of the entity.
entity_name(String)
:The name of the entity.
arn(String)
:The ARN of the entity.
status(Option<Status>)
:The current status of the entity.
workspace_id(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(String)
:The ID of the parent entity for this entity.
has_child_entities(bool)
:A Boolean value that specifies whether the entity has associated child entities.
creation_date_time(DateTime)
:The date and time when the entity was created.
update_date_time(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.
are_all_components_returned(Option<bool>)
:This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.
- On failure, responds with
SdkError<GetEntityError>
Source§impl Client
impl Client
Sourcepub fn get_metadata_transfer_job(&self) -> GetMetadataTransferJobFluentBuilder
pub fn get_metadata_transfer_job(&self) -> GetMetadataTransferJobFluentBuilder
Constructs a fluent builder for the GetMetadataTransferJob
operation.
- The fluent builder is configurable:
metadata_transfer_job_id(impl Into<String>)
/set_metadata_transfer_job_id(Option<String>)
:
required: trueThe metadata transfer job Id.
- On success, responds with
GetMetadataTransferJobOutput
with field(s):metadata_transfer_job_id(String)
:The metadata transfer job Id.
arn(String)
:The metadata transfer job ARN.
description(Option<String>)
:The metadata transfer job description.
sources(Vec::<SourceConfiguration>)
:The metadata transfer job’s sources.
destination(Option<DestinationConfiguration>)
:The metadata transfer job’s destination.
metadata_transfer_job_role(String)
:The metadata transfer job’s role.
report_url(Option<String>)
:The metadata transfer job’s report URL.
creation_date_time(DateTime)
:The metadata transfer job’s creation DateTime property.
update_date_time(DateTime)
:The metadata transfer job’s update DateTime property.
status(Option<MetadataTransferJobStatus>)
:The metadata transfer job’s status.
progress(Option<MetadataTransferJobProgress>)
:The metadata transfer job’s progress.
- On failure, responds with
SdkError<GetMetadataTransferJobError>
Source§impl Client
impl Client
Sourcepub fn get_pricing_plan(&self) -> GetPricingPlanFluentBuilder
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>
Source§impl Client
impl Client
Sourcepub fn get_property_value(&self) -> GetPropertyValueFluentBuilder
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>)
:
required: falseThe name of the component whose property values the operation returns.
component_path(impl Into<String>)
/set_component_path(Option<String>)
:
required: falseThis string specifies the path to the composite component, starting from the top-level component.
component_type_id(impl Into<String>)
/set_component_type_id(Option<String>)
:
required: falseThe ID of the component type whose property values the operation returns.
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:
required: falseThe ID of the entity whose property values the operation returns.
selected_properties(impl Into<String>)
/set_selected_properties(Option<Vec::<String>>)
:
required: trueThe properties whose values the operation returns.
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe ID of the workspace whose values the operation returns.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe 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>)
:
required: falseThe string that specifies the next page of results.
property_group_name(impl Into<String>)
/set_property_group_name(Option<String>)
:
required: falseThe property group name.
tabular_conditions(TabularConditions)
/set_tabular_conditions(Option<TabularConditions>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn get_property_value_history(&self) -> GetPropertyValueHistoryFluentBuilder
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>)
:
required: trueThe ID of the workspace.
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:
required: falseThe ID of the entity.
component_name(impl Into<String>)
/set_component_name(Option<String>)
:
required: falseThe name of the component.
component_path(impl Into<String>)
/set_component_path(Option<String>)
:
required: falseThis string specifies the path to the composite component, starting from the top-level component.
component_type_id(impl Into<String>)
/set_component_type_id(Option<String>)
:
required: falseThe ID of the component type.
selected_properties(impl Into<String>)
/set_selected_properties(Option<Vec::<String>>)
:
required: trueA list of properties whose value histories the request retrieves.
property_filters(PropertyFilter)
/set_property_filters(Option<Vec::<PropertyFilter>>)
:
required: falseA list of objects that filter the property value history request.
start_date_time(DateTime)
/set_start_date_time(Option<DateTime>)
:
required: falseThe date and time of the earliest property value to return.
end_date_time(DateTime)
/set_end_date_time(Option<DateTime>)
:
required: falseThe date and time of the latest property value to return.
interpolation(InterpolationParameters)
/set_interpolation(Option<InterpolationParameters>)
:
required: falseAn object that specifies the interpolation type and the interval over which to interpolate data.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe string that specifies the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe 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>)
:
required: falseThe time direction to use in the result order.
start_time(impl Into<String>)
/set_start_time(Option<String>)
:
required: falseThe 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>)
:
required: falseThe 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(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§impl Client
impl Client
Sourcepub fn get_scene(&self) -> GetSceneFluentBuilder
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>)
:
required: trueThe ID of the workspace that contains the scene.
scene_id(impl Into<String>)
/set_scene_id(Option<String>)
:
required: trueThe ID of the scene.
- On success, responds with
GetSceneOutput
with field(s):workspace_id(String)
:The ID of the workspace that contains the scene.
scene_id(String)
:The ID of the scene.
content_location(String)
:The relative path that specifies the location of the content definition file.
arn(String)
:The ARN of the scene.
creation_date_time(DateTime)
:The date and time when the scene was created.
update_date_time(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.
error(Option<SceneError>)
:The SceneResponse error.
- On failure, responds with
SdkError<GetSceneError>
Source§impl Client
impl Client
Sourcepub fn get_sync_job(&self) -> GetSyncJobFluentBuilder
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>)
:
required: trueThe sync source.
Currently the only supported syncSource is
SITEWISE
.workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: falseThe workspace ID.
- On success, responds with
GetSyncJobOutput
with field(s):arn(String)
:The sync job ARN.
workspace_id(String)
:The ID of the workspace that contains the sync job.
sync_source(String)
:The sync soucre.
Currently the only supported syncSource is
SITEWISE
.sync_role(String)
:The sync IAM role.
status(Option<SyncJobStatus>)
:The SyncJob response status.
creation_date_time(DateTime)
:The creation date and time.
update_date_time(DateTime)
:The update date and time.
- On failure, responds with
SdkError<GetSyncJobError>
Source§impl Client
impl Client
Sourcepub fn get_workspace(&self) -> GetWorkspaceFluentBuilder
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>)
:
required: trueThe ID of the workspace.
- On success, responds with
GetWorkspaceOutput
with field(s):workspace_id(String)
:The ID of the workspace.
arn(String)
:The ARN of the workspace.
description(Option<String>)
:The description of the workspace.
linked_services(Option<Vec::<String>>)
:A list of services that are linked to 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(DateTime)
:The date and time when the workspace was created.
update_date_time(DateTime)
:The date and time when the workspace was last updated.
- On failure, responds with
SdkError<GetWorkspaceError>
Source§impl Client
impl Client
Sourcepub fn list_component_types(&self) -> ListComponentTypesFluentBuilder
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>)
:
required: trueThe ID of the workspace.
filters(ListComponentTypesFilter)
/set_filters(Option<Vec::<ListComponentTypesFilter>>)
:
required: falseA list of objects that filter the request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe string that specifies the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe 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(String)
:The ID of the workspace.
component_type_summaries(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>
Source§impl Client
impl Client
Sourcepub fn list_components(&self) -> ListComponentsFluentBuilder
pub fn list_components(&self) -> ListComponentsFluentBuilder
Constructs a fluent builder for the ListComponents
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe workspace ID.
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:
required: trueThe ID for the entity whose metadata (component/properties) is returned by the operation.
component_path(impl Into<String>)
/set_component_path(Option<String>)
:
required: falseThis string specifies the path to the composite component, starting from the top-level component.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results returned at one time. The default is 25.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe string that specifies the next page of results.
- On success, responds with
ListComponentsOutput
with field(s):component_summaries(Vec::<ComponentSummary>)
:A list of objects that contain information about the components.
next_token(Option<String>)
:The string that specifies the next page of component results.
- On failure, responds with
SdkError<ListComponentsError>
Source§impl Client
impl Client
Sourcepub fn list_entities(&self) -> ListEntitiesFluentBuilder
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>)
:
required: trueThe ID of the workspace.
filters(ListEntitiesFilter)
/set_filters(Option<Vec::<ListEntitiesFilter>>)
:
required: falseA list of objects that filter the request.
Only one object is accepted as a valid input.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe 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>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn list_metadata_transfer_jobs(
&self,
) -> ListMetadataTransferJobsFluentBuilder
pub fn list_metadata_transfer_jobs( &self, ) -> ListMetadataTransferJobsFluentBuilder
Constructs a fluent builder for the ListMetadataTransferJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
source_type(SourceType)
/set_source_type(Option<SourceType>)
:
required: trueThe metadata transfer job’s source type.
destination_type(DestinationType)
/set_destination_type(Option<DestinationType>)
:
required: trueThe metadata transfer job’s destination type.
filters(ListMetadataTransferJobsFilter)
/set_filters(Option<Vec::<ListMetadataTransferJobsFilter>>)
:
required: falseAn object that filters metadata transfer jobs.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe string that specifies the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return at one time.
- On success, responds with
ListMetadataTransferJobsOutput
with field(s):metadata_transfer_job_summaries(Vec::<MetadataTransferJobSummary>)
:The metadata transfer job summaries.
next_token(Option<String>)
:The string that specifies the next page of results.
- On failure, responds with
SdkError<ListMetadataTransferJobsError>
Source§impl Client
impl Client
Sourcepub fn list_properties(&self) -> ListPropertiesFluentBuilder
pub fn list_properties(&self) -> ListPropertiesFluentBuilder
Constructs a fluent builder for the ListProperties
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe workspace ID.
component_name(impl Into<String>)
/set_component_name(Option<String>)
:
required: falseThe name of the component whose properties are returned by the operation.
component_path(impl Into<String>)
/set_component_path(Option<String>)
:
required: falseThis string specifies the path to the composite component, starting from the top-level component.
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:
required: trueThe ID for the entity whose metadata (component/properties) is returned by the operation.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results returned at one time. The default is 25.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe string that specifies the next page of results.
- On success, responds with
ListPropertiesOutput
with field(s):property_summaries(Vec::<PropertySummary>)
:A list of objects that contain information about the properties.
next_token(Option<String>)
:The string that specifies the next page of property results.
- On failure, responds with
SdkError<ListPropertiesError>
Source§impl Client
impl Client
Sourcepub fn list_scenes(&self) -> ListScenesFluentBuilder
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>)
:
required: trueThe ID of the workspace that contains the scenes.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseSpecifies the maximum number of results to display.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn list_sync_jobs(&self) -> ListSyncJobsFluentBuilder
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>)
:
required: trueThe ID of the workspace that contains the sync job.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe 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>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn list_sync_resources(&self) -> ListSyncResourcesFluentBuilder
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>)
:
required: trueThe ID of the workspace that contains the sync job.
sync_source(impl Into<String>)
/set_sync_source(Option<String>)
:
required: trueThe sync source.
Currently the only supported syncSource is
SITEWISE
.filters(SyncResourceFilter)
/set_filters(Option<Vec::<SyncResourceFilter>>)
:
required: falseA 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>)
:
required: falseThe 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>)
:
required: falseThe 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>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the resource.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe 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>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn list_workspaces(&self) -> ListWorkspacesFluentBuilder
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>)
:
required: falseThe 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>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
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>)
:
required: trueThe ARN of the resource.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueMetadata to add to this resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
Source§impl Client
impl Client
Sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
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>)
:
required: trueThe ARN of the resource.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueA 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>
Source§impl Client
impl Client
Sourcepub fn update_component_type(&self) -> UpdateComponentTypeFluentBuilder
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>)
:
required: trueThe ID of the workspace.
is_singleton(bool)
/set_is_singleton(Option<bool>)
:
required: falseA 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>)
:
required: trueThe ID of the component type.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the component type.
property_definitions(impl Into<String>, PropertyDefinitionRequest)
/set_property_definitions(Option<HashMap::<String, PropertyDefinitionRequest>>)
:
required: falseAn 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(impl Into<String>)
/set_extends_from(Option<Vec::<String>>)
:
required: falseSpecifies the component type that this component type extends.
functions(impl Into<String>, FunctionRequest)
/set_functions(Option<HashMap::<String, FunctionRequest>>)
:
required: falseAn object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
property_groups(impl Into<String>, PropertyGroupRequest)
/set_property_groups(Option<HashMap::<String, PropertyGroupRequest>>)
:
required: falseThe property groups.
component_type_name(impl Into<String>)
/set_component_type_name(Option<String>)
:
required: falseThe component type name.
composite_component_types(impl Into<String>, CompositeComponentTypeRequest)
/set_composite_component_types(Option<HashMap::<String, CompositeComponentTypeRequest>>)
:
required: falseThis is an object that maps strings to
compositeComponentTypes
of thecomponentType
.CompositeComponentType
is referenced bycomponentTypeId
.
- On success, responds with
UpdateComponentTypeOutput
with field(s):workspace_id(String)
:The ID of the workspace that contains the component type.
arn(String)
:The ARN of the component type.
component_type_id(String)
:The ID of the component type.
state(State)
:The current state of the component type.
- On failure, responds with
SdkError<UpdateComponentTypeError>
Source§impl Client
impl Client
Sourcepub fn update_entity(&self) -> UpdateEntityFluentBuilder
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>)
:
required: trueThe ID of the workspace that contains the entity.
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:
required: trueThe ID of the entity.
entity_name(impl Into<String>)
/set_entity_name(Option<String>)
:
required: falseThe name of the entity.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the entity.
component_updates(impl Into<String>, ComponentUpdateRequest)
/set_component_updates(Option<HashMap::<String, ComponentUpdateRequest>>)
:
required: falseAn 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(impl Into<String>, CompositeComponentUpdateRequest)
/set_composite_component_updates(Option<HashMap::<String, CompositeComponentUpdateRequest>>)
:
required: falseThis is an object that maps strings to
compositeComponent
updates in the request. Each key of the map represents thecomponentPath
of thecompositeComponent
.parent_entity_update(ParentEntityUpdateRequest)
/set_parent_entity_update(Option<ParentEntityUpdateRequest>)
:
required: falseAn object that describes the update request for a parent entity.
- On success, responds with
UpdateEntityOutput
with field(s):update_date_time(DateTime)
:The date and time when the entity was last updated.
state(State)
:The current state of the entity update.
- On failure, responds with
SdkError<UpdateEntityError>
Source§impl Client
impl Client
Sourcepub fn update_pricing_plan(&self) -> UpdatePricingPlanFluentBuilder
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>)
:
required: trueThe pricing mode.
bundle_names(impl Into<String>)
/set_bundle_names(Option<Vec::<String>>)
:
required: falseThe 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>
Source§impl Client
impl Client
Sourcepub fn update_scene(&self) -> UpdateSceneFluentBuilder
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>)
:
required: trueThe ID of the workspace that contains the scene.
scene_id(impl Into<String>)
/set_scene_id(Option<String>)
:
required: trueThe ID of the scene.
content_location(impl Into<String>)
/set_content_location(Option<String>)
:
required: falseThe relative path that specifies the location of the content definition file.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of this scene.
capabilities(impl Into<String>)
/set_capabilities(Option<Vec::<String>>)
:
required: falseA list of capabilities that the scene uses to render.
scene_metadata(impl Into<String>, impl Into<String>)
/set_scene_metadata(Option<HashMap::<String, String>>)
:
required: falseThe scene metadata.
- On success, responds with
UpdateSceneOutput
with field(s):update_date_time(DateTime)
:The date and time when the scene was last updated.
- On failure, responds with
SdkError<UpdateSceneError>
Source§impl Client
impl Client
Sourcepub fn update_workspace(&self) -> UpdateWorkspaceFluentBuilder
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>)
:
required: trueThe ID of the workspace.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the workspace.
role(impl Into<String>)
/set_role(Option<String>)
:
required: falseThe ARN of the execution role associated with the workspace.
s3_location(impl Into<String>)
/set_s3_location(Option<String>)
:
required: falseThe ARN of the S3 bucket where resources associated with the workspace are stored.
- On success, responds with
UpdateWorkspaceOutput
with field(s):update_date_time(DateTime)
:The date and time of the current update.
- On failure, responds with
SdkError<UpdateWorkspaceError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
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 thesleep_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 thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);