Struct aws_sdk_iotthingsgraph::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS IoT Things Graph
Client for invoking operations on AWS IoT Things Graph. Each operation on AWS IoT Things Graph 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_iotthingsgraph::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 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_iotthingsgraph::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 AssociateEntityToThing
operation has
a Client::associate_entity_to_thing
, 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.associate_entity_to_thing()
.thing_name("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 associate_entity_to_thing(&self) -> AssociateEntityToThingFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn associate_entity_to_thing(&self) -> AssociateEntityToThingFluentBuilder
Constructs a fluent builder for the AssociateEntityToThing
operation.
- The fluent builder is configurable:
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:
required: trueThe name of the thing to which the entity is to be associated.
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:
required: trueThe ID of the device to be associated with the thing.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME
namespace_version(i64)
/set_namespace_version(Option<i64>)
:
required: falseThe version of the user’s namespace. Defaults to the latest version of the user’s namespace.
- On success, responds with
AssociateEntityToThingOutput
- On failure, responds with
SdkError<AssociateEntityToThingError>
source§impl Client
impl Client
sourcepub fn create_flow_template(&self) -> CreateFlowTemplateFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn create_flow_template(&self) -> CreateFlowTemplateFluentBuilder
Constructs a fluent builder for the CreateFlowTemplate
operation.
- The fluent builder is configurable:
definition(DefinitionDocument)
/set_definition(Option<DefinitionDocument>)
:
required: trueThe workflow
DefinitionDocument
.compatible_namespace_version(i64)
/set_compatible_namespace_version(Option<i64>)
:
required: falseThe namespace version in which the workflow is to be created.
If no value is specified, the latest version is used by default.
- On success, responds with
CreateFlowTemplateOutput
with field(s):summary(Option<FlowTemplateSummary>)
:The summary object that describes the created workflow.
- On failure, responds with
SdkError<CreateFlowTemplateError>
source§impl Client
impl Client
sourcepub fn create_system_instance(&self) -> CreateSystemInstanceFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn create_system_instance(&self) -> CreateSystemInstanceFluentBuilder
Constructs a fluent builder for the CreateSystemInstance
operation.
- The fluent builder is configurable:
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseMetadata, consisting of key-value pairs, that can be used to categorize your system instances.
definition(DefinitionDocument)
/set_definition(Option<DefinitionDocument>)
:
required: trueA document that defines an entity.
target(DeploymentTarget)
/set_target(Option<DeploymentTarget>)
:
required: trueThe target type of the deployment. Valid values are
GREENGRASS
andCLOUD
.greengrass_group_name(impl Into<String>)
/set_greengrass_group_name(Option<String>)
:
required: falseThe name of the Greengrass group where the system instance will be deployed. This value is required if the value of the
target
parameter isGREENGRASS
.s3_bucket_name(impl Into<String>)
/set_s3_bucket_name(Option<String>)
:
required: falseThe name of the Amazon Simple Storage Service bucket that will be used to store and deploy the system instance’s resource file. This value is required if the value of the
target
parameter isGREENGRASS
.metrics_configuration(MetricsConfiguration)
/set_metrics_configuration(Option<MetricsConfiguration>)
:
required: falseAn object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.
flow_actions_role_arn(impl Into<String>)
/set_flow_actions_role_arn(Option<String>)
:
required: falseThe ARN of the IAM role that AWS IoT Things Graph will assume when it executes the flow. This role must have read and write access to AWS Lambda and AWS IoT and any other AWS services that the flow uses when it executes. This value is required if the value of the
target
parameter isCLOUD
.
- On success, responds with
CreateSystemInstanceOutput
with field(s):summary(Option<SystemInstanceSummary>)
:The summary object that describes the new system instance.
- On failure, responds with
SdkError<CreateSystemInstanceError>
source§impl Client
impl Client
sourcepub fn create_system_template(&self) -> CreateSystemTemplateFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn create_system_template(&self) -> CreateSystemTemplateFluentBuilder
Constructs a fluent builder for the CreateSystemTemplate
operation.
- The fluent builder is configurable:
definition(DefinitionDocument)
/set_definition(Option<DefinitionDocument>)
:
required: trueThe
DefinitionDocument
used to create the system.compatible_namespace_version(i64)
/set_compatible_namespace_version(Option<i64>)
:
required: falseThe namespace version in which the system is to be created.
If no value is specified, the latest version is used by default.
- On success, responds with
CreateSystemTemplateOutput
with field(s):summary(Option<SystemTemplateSummary>)
:The summary object that describes the created system.
- On failure, responds with
SdkError<CreateSystemTemplateError>
source§impl Client
impl Client
sourcepub fn delete_flow_template(&self) -> DeleteFlowTemplateFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn delete_flow_template(&self) -> DeleteFlowTemplateFluentBuilder
Constructs a fluent builder for the DeleteFlowTemplate
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the workflow to be deleted.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
- On success, responds with
DeleteFlowTemplateOutput
- On failure, responds with
SdkError<DeleteFlowTemplateError>
source§impl Client
impl Client
sourcepub fn delete_namespace(&self) -> DeleteNamespaceFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn delete_namespace(&self) -> DeleteNamespaceFluentBuilder
Constructs a fluent builder for the DeleteNamespace
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
DeleteNamespaceOutput
with field(s):namespace_arn(Option<String>)
:The ARN of the namespace to be deleted.
namespace_name(Option<String>)
:The name of the namespace to be deleted.
- On failure, responds with
SdkError<DeleteNamespaceError>
source§impl Client
impl Client
sourcepub fn delete_system_instance(&self) -> DeleteSystemInstanceFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn delete_system_instance(&self) -> DeleteSystemInstanceFluentBuilder
Constructs a fluent builder for the DeleteSystemInstance
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: falseThe ID of the system instance to be deleted.
- On success, responds with
DeleteSystemInstanceOutput
- On failure, responds with
SdkError<DeleteSystemInstanceError>
source§impl Client
impl Client
sourcepub fn delete_system_template(&self) -> DeleteSystemTemplateFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn delete_system_template(&self) -> DeleteSystemTemplateFluentBuilder
Constructs a fluent builder for the DeleteSystemTemplate
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the system to be deleted.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
- On success, responds with
DeleteSystemTemplateOutput
- On failure, responds with
SdkError<DeleteSystemTemplateError>
source§impl Client
impl Client
sourcepub fn deploy_system_instance(&self) -> DeploySystemInstanceFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn deploy_system_instance(&self) -> DeploySystemInstanceFluentBuilder
Constructs a fluent builder for the DeploySystemInstance
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: falseThe ID of the system instance. This value is returned by the
CreateSystemInstance
action.The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME
- On success, responds with
DeploySystemInstanceOutput
with field(s):summary(Option<SystemInstanceSummary>)
:An object that contains summary information about a system instance that was deployed.
greengrass_deployment_id(Option<String>)
:The ID of the Greengrass deployment used to deploy the system instance.
- On failure, responds with
SdkError<DeploySystemInstanceError>
source§impl Client
impl Client
sourcepub fn deprecate_flow_template(&self) -> DeprecateFlowTemplateFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn deprecate_flow_template(&self) -> DeprecateFlowTemplateFluentBuilder
Constructs a fluent builder for the DeprecateFlowTemplate
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the workflow to be deleted.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
- On success, responds with
DeprecateFlowTemplateOutput
- On failure, responds with
SdkError<DeprecateFlowTemplateError>
source§impl Client
impl Client
sourcepub fn deprecate_system_template(&self) -> DeprecateSystemTemplateFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn deprecate_system_template(&self) -> DeprecateSystemTemplateFluentBuilder
Constructs a fluent builder for the DeprecateSystemTemplate
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the system to delete.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
- On success, responds with
DeprecateSystemTemplateOutput
- On failure, responds with
SdkError<DeprecateSystemTemplateError>
source§impl Client
impl Client
sourcepub fn describe_namespace(&self) -> DescribeNamespaceFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn describe_namespace(&self) -> DescribeNamespaceFluentBuilder
Constructs a fluent builder for the DescribeNamespace
operation.
- The fluent builder is configurable:
namespace_name(impl Into<String>)
/set_namespace_name(Option<String>)
:
required: falseThe name of the user’s namespace. Set this to
aws
to get the public namespace.
- On success, responds with
DescribeNamespaceOutput
with field(s):namespace_arn(Option<String>)
:The ARN of the namespace.
namespace_name(Option<String>)
:The name of the namespace.
tracking_namespace_name(Option<String>)
:The name of the public namespace that the latest namespace version is tracking.
tracking_namespace_version(Option<i64>)
:The version of the public namespace that the latest version is tracking.
namespace_version(Option<i64>)
:The version of the user’s namespace to describe.
- On failure, responds with
SdkError<DescribeNamespaceError>
source§impl Client
impl Client
sourcepub fn dissociate_entity_from_thing(
&self
) -> DissociateEntityFromThingFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn dissociate_entity_from_thing( &self ) -> DissociateEntityFromThingFluentBuilder
Constructs a fluent builder for the DissociateEntityFromThing
operation.
- The fluent builder is configurable:
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:
required: trueThe name of the thing to disassociate.
entity_type(EntityType)
/set_entity_type(Option<EntityType>)
:
required: trueThe entity type from which to disassociate the thing.
- On success, responds with
DissociateEntityFromThingOutput
- On failure, responds with
SdkError<DissociateEntityFromThingError>
source§impl Client
impl Client
sourcepub fn get_entities(&self) -> GetEntitiesFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn get_entities(&self) -> GetEntitiesFluentBuilder
Constructs a fluent builder for the GetEntities
operation.
- The fluent builder is configurable:
ids(impl Into<String>)
/set_ids(Option<Vec::<String>>)
:
required: trueAn array of entity IDs.
The IDs should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME
namespace_version(i64)
/set_namespace_version(Option<i64>)
:
required: falseThe version of the user’s namespace. Defaults to the latest version of the user’s namespace.
- On success, responds with
GetEntitiesOutput
with field(s):descriptions(Option<Vec::<EntityDescription>>)
:An array of descriptions for the specified entities.
- On failure, responds with
SdkError<GetEntitiesError>
source§impl Client
impl Client
sourcepub fn get_flow_template(&self) -> GetFlowTemplateFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn get_flow_template(&self) -> GetFlowTemplateFluentBuilder
Constructs a fluent builder for the GetFlowTemplate
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the workflow.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
revision_number(i64)
/set_revision_number(Option<i64>)
:
required: falseThe number of the workflow revision to retrieve.
- On success, responds with
GetFlowTemplateOutput
with field(s):description(Option<FlowTemplateDescription>)
:The object that describes the specified workflow.
- On failure, responds with
SdkError<GetFlowTemplateError>
source§impl Client
impl Client
sourcepub fn get_flow_template_revisions(
&self
) -> GetFlowTemplateRevisionsFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn get_flow_template_revisions( &self ) -> GetFlowTemplateRevisionsFluentBuilder
Constructs a fluent builder for the GetFlowTemplateRevisions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the workflow.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe string that specifies the next page of results. Use this when you’re paginating results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response.
- On success, responds with
GetFlowTemplateRevisionsOutput
with field(s):summaries(Option<Vec::<FlowTemplateSummary>>)
:An array of objects that provide summary data about each revision.
next_token(Option<String>)
:The string to specify as
nextToken
when you request the next page of results.
- On failure, responds with
SdkError<GetFlowTemplateRevisionsError>
source§impl Client
impl Client
sourcepub fn get_namespace_deletion_status(
&self
) -> GetNamespaceDeletionStatusFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn get_namespace_deletion_status( &self ) -> GetNamespaceDeletionStatusFluentBuilder
Constructs a fluent builder for the GetNamespaceDeletionStatus
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetNamespaceDeletionStatusOutput
with field(s):namespace_arn(Option<String>)
:The ARN of the namespace that is being deleted.
namespace_name(Option<String>)
:The name of the namespace that is being deleted.
status(Option<NamespaceDeletionStatus>)
:The status of the deletion request.
error_code(Option<NamespaceDeletionStatusErrorCodes>)
:An error code returned by the namespace deletion task.
error_message(Option<String>)
:An error code returned by the namespace deletion task.
- On failure, responds with
SdkError<GetNamespaceDeletionStatusError>
source§impl Client
impl Client
sourcepub fn get_system_instance(&self) -> GetSystemInstanceFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn get_system_instance(&self) -> GetSystemInstanceFluentBuilder
Constructs a fluent builder for the GetSystemInstance
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the system deployment instance. This value is returned by
CreateSystemInstance
.The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME
- On success, responds with
GetSystemInstanceOutput
with field(s):description(Option<SystemInstanceDescription>)
:An object that describes the system instance.
- On failure, responds with
SdkError<GetSystemInstanceError>
source§impl Client
impl Client
sourcepub fn get_system_template(&self) -> GetSystemTemplateFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn get_system_template(&self) -> GetSystemTemplateFluentBuilder
Constructs a fluent builder for the GetSystemTemplate
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the system to get. This ID must be in the user’s namespace.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
revision_number(i64)
/set_revision_number(Option<i64>)
:
required: falseThe number that specifies the revision of the system to get.
- On success, responds with
GetSystemTemplateOutput
with field(s):description(Option<SystemTemplateDescription>)
:An object that contains summary data about the system.
- On failure, responds with
SdkError<GetSystemTemplateError>
source§impl Client
impl Client
sourcepub fn get_system_template_revisions(
&self
) -> GetSystemTemplateRevisionsFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn get_system_template_revisions( &self ) -> GetSystemTemplateRevisionsFluentBuilder
Constructs a fluent builder for the GetSystemTemplateRevisions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the system template.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe string that specifies the next page of results. Use this when you’re paginating results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response.
- On success, responds with
GetSystemTemplateRevisionsOutput
with field(s):summaries(Option<Vec::<SystemTemplateSummary>>)
:An array of objects that contain summary data about the system template revisions.
next_token(Option<String>)
:The string to specify as
nextToken
when you request the next page of results.
- On failure, responds with
SdkError<GetSystemTemplateRevisionsError>
source§impl Client
impl Client
sourcepub fn get_upload_status(&self) -> GetUploadStatusFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn get_upload_status(&self) -> GetUploadStatusFluentBuilder
Constructs a fluent builder for the GetUploadStatus
operation.
- The fluent builder is configurable:
upload_id(impl Into<String>)
/set_upload_id(Option<String>)
:
required: trueThe ID of the upload. This value is returned by the
UploadEntityDefinitions
action.
- On success, responds with
GetUploadStatusOutput
with field(s):upload_id(String)
:The ID of the upload.
upload_status(UploadStatus)
:The status of the upload. The initial status is
IN_PROGRESS
. The response show all validation failures if the upload fails.namespace_arn(Option<String>)
:The ARN of the upload.
namespace_name(Option<String>)
:The name of the upload’s namespace.
namespace_version(Option<i64>)
:The version of the user’s namespace. Defaults to the latest version of the user’s namespace.
failure_reason(Option<Vec::<String>>)
:The reason for an upload failure.
created_date(DateTime)
:The date at which the upload was created.
- On failure, responds with
SdkError<GetUploadStatusError>
source§impl Client
impl Client
sourcepub fn list_flow_execution_messages(
&self
) -> ListFlowExecutionMessagesFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn list_flow_execution_messages( &self ) -> ListFlowExecutionMessagesFluentBuilder
Constructs a fluent builder for the ListFlowExecutionMessages
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
flow_execution_id(impl Into<String>)
/set_flow_execution_id(Option<String>)
:
required: trueThe ID of the flow execution.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe string that specifies the next page of results. Use this when you’re paginating results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response.
- On success, responds with
ListFlowExecutionMessagesOutput
with field(s):messages(Option<Vec::<FlowExecutionMessage>>)
:A list of objects that contain information about events in the specified flow execution.
next_token(Option<String>)
:The string to specify as
nextToken
when you request the next page of results.
- On failure, responds with
SdkError<ListFlowExecutionMessagesError>
source§impl Client
impl Client
👎Deprecated: since: 2022-08-30
Constructs a fluent builder for the ListTagsForResource
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 tags to return.
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the resource whose tags are to be returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token that specifies the next page of results to return.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec::<Tag>>)
:List of tags returned by the
ListTagsForResource
operation.next_token(Option<String>)
:The token that specifies the next page of results to return.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn search_entities(&self) -> SearchEntitiesFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn search_entities(&self) -> SearchEntitiesFluentBuilder
Constructs a fluent builder for the SearchEntities
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
entity_types(EntityType)
/set_entity_types(Option<Vec::<EntityType>>)
:
required: trueThe entity types for which to search.
filters(EntityFilter)
/set_filters(Option<Vec::<EntityFilter>>)
:
required: falseOptional filter to apply to the search. Valid filters are
NAME
NAMESPACE
,SEMANTIC_TYPE_PATH
andREFERENCED_ENTITY_ID
.REFERENCED_ENTITY_ID
filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe string that specifies the next page of results. Use this when you’re paginating results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response.
namespace_version(i64)
/set_namespace_version(Option<i64>)
:
required: falseThe version of the user’s namespace. Defaults to the latest version of the user’s namespace.
- On success, responds with
SearchEntitiesOutput
with field(s):descriptions(Option<Vec::<EntityDescription>>)
:An array of descriptions for each entity returned in the search result.
next_token(Option<String>)
:The string to specify as
nextToken
when you request the next page of results.
- On failure, responds with
SdkError<SearchEntitiesError>
source§impl Client
impl Client
sourcepub fn search_flow_executions(&self) -> SearchFlowExecutionsFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn search_flow_executions(&self) -> SearchFlowExecutionsFluentBuilder
Constructs a fluent builder for the SearchFlowExecutions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
system_instance_id(impl Into<String>)
/set_system_instance_id(Option<String>)
:
required: trueThe ID of the system instance that contains the flow.
flow_execution_id(impl Into<String>)
/set_flow_execution_id(Option<String>)
:
required: falseThe ID of a flow execution.
start_time(DateTime)
/set_start_time(Option<DateTime>)
:
required: falseThe date and time of the earliest flow execution to return.
end_time(DateTime)
/set_end_time(Option<DateTime>)
:
required: falseThe date and time of the latest flow execution to return.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe string that specifies the next page of results. Use this when you’re paginating results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response.
- On success, responds with
SearchFlowExecutionsOutput
with field(s):summaries(Option<Vec::<FlowExecutionSummary>>)
:An array of objects that contain summary information about each workflow execution in the result set.
next_token(Option<String>)
:The string to specify as
nextToken
when you request the next page of results.
- On failure, responds with
SdkError<SearchFlowExecutionsError>
source§impl Client
impl Client
sourcepub fn search_flow_templates(&self) -> SearchFlowTemplatesFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn search_flow_templates(&self) -> SearchFlowTemplatesFluentBuilder
Constructs a fluent builder for the SearchFlowTemplates
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(FlowTemplateFilter)
/set_filters(Option<Vec::<FlowTemplateFilter>>)
:
required: falseAn array of objects that limit the result set. The only valid filter is
DEVICE_MODEL_ID
.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe string that specifies the next page of results. Use this when you’re paginating results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response.
- On success, responds with
SearchFlowTemplatesOutput
with field(s):summaries(Option<Vec::<FlowTemplateSummary>>)
:An array of objects that contain summary information about each workflow in the result set.
next_token(Option<String>)
:The string to specify as
nextToken
when you request the next page of results.
- On failure, responds with
SdkError<SearchFlowTemplatesError>
source§impl Client
impl Client
sourcepub fn search_system_instances(&self) -> SearchSystemInstancesFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn search_system_instances(&self) -> SearchSystemInstancesFluentBuilder
Constructs a fluent builder for the SearchSystemInstances
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(SystemInstanceFilter)
/set_filters(Option<Vec::<SystemInstanceFilter>>)
:
required: falseOptional filter to apply to the search. Valid filters are
SYSTEM_TEMPLATE_ID
,STATUS
, andGREENGRASS_GROUP_NAME
.Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe string that specifies the next page of results. Use this when you’re paginating results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response.
- On success, responds with
SearchSystemInstancesOutput
with field(s):summaries(Option<Vec::<SystemInstanceSummary>>)
:An array of objects that contain summary data abour the system instances in the result set.
next_token(Option<String>)
:The string to specify as
nextToken
when you request the next page of results.
- On failure, responds with
SdkError<SearchSystemInstancesError>
source§impl Client
impl Client
sourcepub fn search_system_templates(&self) -> SearchSystemTemplatesFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn search_system_templates(&self) -> SearchSystemTemplatesFluentBuilder
Constructs a fluent builder for the SearchSystemTemplates
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filters(SystemTemplateFilter)
/set_filters(Option<Vec::<SystemTemplateFilter>>)
:
required: falseAn array of filters that limit the result set. The only valid filter is
FLOW_TEMPLATE_ID
.next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe string that specifies the next page of results. Use this when you’re paginating results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response.
- On success, responds with
SearchSystemTemplatesOutput
with field(s):summaries(Option<Vec::<SystemTemplateSummary>>)
:An array of objects that contain summary information about each system deployment in the result set.
next_token(Option<String>)
:The string to specify as
nextToken
when you request the next page of results.
- On failure, responds with
SdkError<SearchSystemTemplatesError>
source§impl Client
impl Client
sourcepub fn search_things(&self) -> SearchThingsFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn search_things(&self) -> SearchThingsFluentBuilder
Constructs a fluent builder for the SearchThings
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
entity_id(impl Into<String>)
/set_entity_id(Option<String>)
:
required: trueThe ID of the entity to which the things are associated.
The IDs should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe string that specifies the next page of results. Use this when you’re paginating results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in the response.
namespace_version(i64)
/set_namespace_version(Option<i64>)
:
required: falseThe version of the user’s namespace. Defaults to the latest version of the user’s namespace.
- On success, responds with
SearchThingsOutput
with field(s):things(Option<Vec::<Thing>>)
:An array of things in the result set.
next_token(Option<String>)
:The string to specify as
nextToken
when you request the next page of results.
- On failure, responds with
SdkError<SearchThingsError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
👎Deprecated: since: 2022-08-30
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 Amazon Resource Name (ARN) of the resource whose tags are returned.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: trueA list of tags to add to the resource.>
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn undeploy_system_instance(&self) -> UndeploySystemInstanceFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn undeploy_system_instance(&self) -> UndeploySystemInstanceFluentBuilder
Constructs a fluent builder for the UndeploySystemInstance
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: falseThe ID of the system instance to remove from its target.
- On success, responds with
UndeploySystemInstanceOutput
with field(s):summary(Option<SystemInstanceSummary>)
:An object that contains summary information about the system instance that was removed from its target.
- On failure, responds with
SdkError<UndeploySystemInstanceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
👎Deprecated: since: 2022-08-30
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 Amazon Resource Name (ARN) of the resource whose tags are to be removed.
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.
This parameter to the API requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_flow_template(&self) -> UpdateFlowTemplateFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn update_flow_template(&self) -> UpdateFlowTemplateFluentBuilder
Constructs a fluent builder for the UpdateFlowTemplate
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the workflow to be updated.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
definition(DefinitionDocument)
/set_definition(Option<DefinitionDocument>)
:
required: trueThe
DefinitionDocument
that contains the updated workflow definition.compatible_namespace_version(i64)
/set_compatible_namespace_version(Option<i64>)
:
required: falseThe version of the user’s namespace.
If no value is specified, the latest version is used by default. Use the
GetFlowTemplateRevisions
if you want to find earlier revisions of the flow to update.
- On success, responds with
UpdateFlowTemplateOutput
with field(s):summary(Option<FlowTemplateSummary>)
:An object containing summary information about the updated workflow.
- On failure, responds with
SdkError<UpdateFlowTemplateError>
source§impl Client
impl Client
sourcepub fn update_system_template(&self) -> UpdateSystemTemplateFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn update_system_template(&self) -> UpdateSystemTemplateFluentBuilder
Constructs a fluent builder for the UpdateSystemTemplate
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe ID of the system to be updated.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
definition(DefinitionDocument)
/set_definition(Option<DefinitionDocument>)
:
required: trueThe
DefinitionDocument
that contains the updated system definition.compatible_namespace_version(i64)
/set_compatible_namespace_version(Option<i64>)
:
required: falseThe version of the user’s namespace. Defaults to the latest version of the user’s namespace.
If no value is specified, the latest version is used by default.
- On success, responds with
UpdateSystemTemplateOutput
with field(s):summary(Option<SystemTemplateSummary>)
:An object containing summary information about the updated system.
- On failure, responds with
SdkError<UpdateSystemTemplateError>
source§impl Client
impl Client
sourcepub fn upload_entity_definitions(&self) -> UploadEntityDefinitionsFluentBuilder
👎Deprecated: since: 2022-08-30
pub fn upload_entity_definitions(&self) -> UploadEntityDefinitionsFluentBuilder
Constructs a fluent builder for the UploadEntityDefinitions
operation.
- The fluent builder is configurable:
document(DefinitionDocument)
/set_document(Option<DefinitionDocument>)
:
required: falseThe
DefinitionDocument
that defines the updated entities.sync_with_public_namespace(bool)
/set_sync_with_public_namespace(Option<bool>)
:
required: falseA Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to
true
, the upload will create a new namespace version.deprecate_existing_entities(bool)
/set_deprecate_existing_entities(Option<bool>)
:
required: falseA Boolean that specifies whether to deprecate all entities in the latest version before uploading the new
DefinitionDocument
. If set totrue
, the upload will create a new namespace version.
- On success, responds with
UploadEntityDefinitionsOutput
with field(s):upload_id(String)
:The ID that specifies the upload action. You can use this to track the status of the upload.
- On failure, responds with
SdkError<UploadEntityDefinitionsError>
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> 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 more