Struct aws_sdk_iotthingsgraph::Client

pub struct Client { /* private fields */ }

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.

Examples

Constructing a client and invoking an operation

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

Constructing a client with custom configuration

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

Implementations

impl Client

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

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn associate_entity_to_thing(&self) -> AssociateEntityToThing

Constructs a fluent builder for the AssociateEntityToThing operation.

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

    The name of the thing to which the entity is to be associated.

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

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

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

pub fn create_flow_template(&self) -> CreateFlowTemplate

Constructs a fluent builder for the CreateFlowTemplate operation.

• The fluent builder is configurable:
  • definition(DefinitionDocument) / set_definition(Option<DefinitionDocument>):

    The workflow DefinitionDocument.

  • compatible_namespace_version(i64) / set_compatible_namespace_version(Option<i64>):

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

pub fn create_system_instance(&self) -> CreateSystemInstance

Constructs a fluent builder for the CreateSystemInstance operation.

• The fluent builder is configurable:
  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    Metadata, consisting of key-value pairs, that can be used to categorize your system instances.

  • definition(DefinitionDocument) / set_definition(Option<DefinitionDocument>):

    A document that defines an entity.

  • target(DeploymentTarget) / set_target(Option<DeploymentTarget>):

    The target type of the deployment. Valid values are GREENGRASS and CLOUD.

  • greengrass_group_name(impl Into<String>) / set_greengrass_group_name(Option<String>):

    The name of the Greengrass group where the system instance will be deployed. This value is required if the value of the target parameter is GREENGRASS.

  • s3_bucket_name(impl Into<String>) / set_s3_bucket_name(Option<String>):

    The 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 is GREENGRASS.

  • metrics_configuration(MetricsConfiguration) / set_metrics_configuration(Option<MetricsConfiguration>):

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

    The 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 is CLOUD.

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

pub fn create_system_template(&self) -> CreateSystemTemplate

Constructs a fluent builder for the CreateSystemTemplate operation.

• The fluent builder is configurable:
  • definition(DefinitionDocument) / set_definition(Option<DefinitionDocument>):

    The DefinitionDocument used to create the system.

  • compatible_namespace_version(i64) / set_compatible_namespace_version(Option<i64>):

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

pub fn delete_flow_template(&self) -> DeleteFlowTemplate

Constructs a fluent builder for the DeleteFlowTemplate operation.

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

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

pub fn delete_namespace(&self) -> DeleteNamespace

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>

pub fn delete_system_instance(&self) -> DeleteSystemInstance

Constructs a fluent builder for the DeleteSystemInstance operation.

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

    The ID of the system instance to be deleted.

• On success, responds with DeleteSystemInstanceOutput
• On failure, responds with SdkError<DeleteSystemInstanceError>

pub fn delete_system_template(&self) -> DeleteSystemTemplate

Constructs a fluent builder for the DeleteSystemTemplate operation.

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

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

pub fn deploy_system_instance(&self) -> DeploySystemInstance

Constructs a fluent builder for the DeploySystemInstance operation.

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

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

pub fn deprecate_flow_template(&self) -> DeprecateFlowTemplate

Constructs a fluent builder for the DeprecateFlowTemplate operation.

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

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

pub fn deprecate_system_template(&self) -> DeprecateSystemTemplate

Constructs a fluent builder for the DeprecateSystemTemplate operation.

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

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

pub fn describe_namespace(&self) -> DescribeNamespace

Constructs a fluent builder for the DescribeNamespace operation.

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

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

pub fn dissociate_entity_from_thing(&self) -> DissociateEntityFromThing

Constructs a fluent builder for the DissociateEntityFromThing operation.

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

    The name of the thing to disassociate.

  • entity_type(EntityType) / set_entity_type(Option<EntityType>):

    The entity type from which to disassociate the thing.

• On success, responds with DissociateEntityFromThingOutput
• On failure, responds with SdkError<DissociateEntityFromThingError>

pub fn get_entities(&self) -> GetEntities

Constructs a fluent builder for the GetEntities operation.

• The fluent builder is configurable:
  • ids(Vec<String>) / set_ids(Option<Vec<String>>):

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

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

pub fn get_flow_template(&self) -> GetFlowTemplate

Constructs a fluent builder for the GetFlowTemplate operation.

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

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

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

pub fn get_flow_template_revisions(&self) -> GetFlowTemplateRevisions

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

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

    The string that specifies the next page of results. Use this when you’re paginating results.

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

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

pub fn get_namespace_deletion_status(&self) -> GetNamespaceDeletionStatus

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>

pub fn get_system_instance(&self) -> GetSystemInstance

Constructs a fluent builder for the GetSystemInstance operation.

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

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

pub fn get_system_template(&self) -> GetSystemTemplate

Constructs a fluent builder for the GetSystemTemplate operation.

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

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

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

pub fn get_system_template_revisions(&self) -> GetSystemTemplateRevisions

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

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

    The string that specifies the next page of results. Use this when you’re paginating results.

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

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

pub fn get_upload_status(&self) -> GetUploadStatus

Constructs a fluent builder for the GetUploadStatus operation.

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

    The ID of the upload. This value is returned by the UploadEntityDefinitions action.

• On success, responds with GetUploadStatusOutput with field(s):
  • upload_id(Option<String>):

    The ID of the upload.

  • upload_status(Option<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(Option<DateTime>):

    The date at which the upload was created.

• On failure, responds with SdkError<GetUploadStatusError>

pub fn list_flow_execution_messages(&self) -> ListFlowExecutionMessages

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

    The ID of the flow execution.

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

    The string that specifies the next page of results. Use this when you’re paginating results.

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

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

pub fn list_tags_for_resource(&self) -> ListTagsForResource

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

    The maximum number of tags to return.

  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):

    The Amazon Resource Name (ARN) of the resource whose tags are to be returned.

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

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

pub fn search_entities(&self) -> SearchEntities

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

• The fluent builder is configurable:
  • entity_types(Vec<EntityType>) / set_entity_types(Option<Vec<EntityType>>):

    The entity types for which to search.

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

    Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_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>):

    The string that specifies the next page of results. Use this when you’re paginating results.

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

    The maximum number of results to return in the response.

  • namespace_version(i64) / set_namespace_version(Option<i64>):

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

pub fn search_flow_executions(&self) -> SearchFlowExecutions

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

    The ID of the system instance that contains the flow.

  • flow_execution_id(impl Into<String>) / set_flow_execution_id(Option<String>):

    The ID of a flow execution.

  • start_time(DateTime) / set_start_time(Option<DateTime>):

    The date and time of the earliest flow execution to return.

  • end_time(DateTime) / set_end_time(Option<DateTime>):

    The date and time of the latest flow execution to return.

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

    The string that specifies the next page of results. Use this when you’re paginating results.

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

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

pub fn search_flow_templates(&self) -> SearchFlowTemplates

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

• The fluent builder is configurable:
  • filters(Vec<FlowTemplateFilter>) / set_filters(Option<Vec<FlowTemplateFilter>>):

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

    The string that specifies the next page of results. Use this when you’re paginating results.

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

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

pub fn search_system_instances(&self) -> SearchSystemInstances

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

• The fluent builder is configurable:
  • filters(Vec<SystemInstanceFilter>) / set_filters(Option<Vec<SystemInstanceFilter>>):

    Optional filter to apply to the search. Valid filters are SYSTEM_TEMPLATE_ID, STATUS, and GREENGRASS_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>):

    The string that specifies the next page of results. Use this when you’re paginating results.

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

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

pub fn search_system_templates(&self) -> SearchSystemTemplates

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

• The fluent builder is configurable:
  • filters(Vec<SystemTemplateFilter>) / set_filters(Option<Vec<SystemTemplateFilter>>):

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

    The string that specifies the next page of results. Use this when you’re paginating results.

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

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

pub fn search_things(&self) -> SearchThings

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

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

    The string that specifies the next page of results. Use this when you’re paginating results.

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

    The maximum number of results to return in the response.

  • namespace_version(i64) / set_namespace_version(Option<i64>):

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

pub fn tag_resource(&self) -> TagResource

Constructs a fluent builder for the TagResource operation.

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

    The Amazon Resource Name (ARN) of the resource whose tags are returned.

  • tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):

    A list of tags to add to the resource.>

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

pub fn undeploy_system_instance(&self) -> UndeploySystemInstance

Constructs a fluent builder for the UndeploySystemInstance operation.

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

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

pub fn untag_resource(&self) -> UntagResource

Constructs a fluent builder for the UntagResource operation.

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

    The Amazon Resource Name (ARN) of the resource whose tags are to be removed.

  • tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):

    A list of tag key names to remove from the resource. You don’t specify the value. Both the key and its associated value are removed.

    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>

pub fn update_flow_template(&self) -> UpdateFlowTemplate

Constructs a fluent builder for the UpdateFlowTemplate operation.

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

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

    The DefinitionDocument that contains the updated workflow definition.

  • compatible_namespace_version(i64) / set_compatible_namespace_version(Option<i64>):

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

pub fn update_system_template(&self) -> UpdateSystemTemplate

Constructs a fluent builder for the UpdateSystemTemplate operation.

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

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

    The DefinitionDocument that contains the updated system definition.

  • compatible_namespace_version(i64) / set_compatible_namespace_version(Option<i64>):

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

pub fn upload_entity_definitions(&self) -> UploadEntityDefinitions

Constructs a fluent builder for the UploadEntityDefinitions operation.

• The fluent builder is configurable:
  • document(DefinitionDocument) / set_document(Option<DefinitionDocument>):

    The DefinitionDocument that defines the updated entities.

  • sync_with_public_namespace(bool) / set_sync_with_public_namespace(bool):

    A 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(bool):

    A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new DefinitionDocument. If set to true, the upload will create a new namespace version.

• On success, responds with UploadEntityDefinitionsOutput with field(s):
  • upload_id(Option<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>

impl Client

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

Creates a new client from an SDK Config.

Panics

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

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

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

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.