Struct aws_sdk_greengrassv2::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
Client for AWS IoT Greengrass V2
Client for invoking operations on AWS IoT Greengrass V2. Each operation on AWS IoT Greengrass V2 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_greengrassv2::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_greengrassv2::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_greengrassv2::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn associate_service_role_to_account(&self) -> AssociateServiceRoleToAccount
pub fn associate_service_role_to_account(&self) -> AssociateServiceRoleToAccount
Constructs a fluent builder for the AssociateServiceRoleToAccount
operation.
- The fluent builder is configurable:
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:The Amazon Resource Name (ARN) of the service role to associate with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.
- On success, responds with
AssociateServiceRoleToAccountOutput
with field(s):associated_at(Option<String>)
:The time when the service role was associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.
- On failure, responds with
SdkError<AssociateServiceRoleToAccountError>
sourcepub fn batch_associate_client_device_with_core_device(
&self
) -> BatchAssociateClientDeviceWithCoreDevice
pub fn batch_associate_client_device_with_core_device(
&self
) -> BatchAssociateClientDeviceWithCoreDevice
Constructs a fluent builder for the BatchAssociateClientDeviceWithCoreDevice
operation.
- The fluent builder is configurable:
entries(Vec<AssociateClientDeviceWithCoreDeviceEntry>)
/set_entries(Option<Vec<AssociateClientDeviceWithCoreDeviceEntry>>)
:The list of client devices to associate.
core_device_thing_name(impl Into<String>)
/set_core_device_thing_name(Option<String>)
:The name of the core device. This is also the name of the IoT thing.
- On success, responds with
BatchAssociateClientDeviceWithCoreDeviceOutput
with field(s):error_entries(Option<Vec<AssociateClientDeviceWithCoreDeviceErrorEntry>>)
:The list of any errors for the entries in the request. Each error entry contains the name of the IoT thing that failed to associate.
- On failure, responds with
SdkError<BatchAssociateClientDeviceWithCoreDeviceError>
sourcepub fn batch_disassociate_client_device_from_core_device(
&self
) -> BatchDisassociateClientDeviceFromCoreDevice
pub fn batch_disassociate_client_device_from_core_device(
&self
) -> BatchDisassociateClientDeviceFromCoreDevice
Constructs a fluent builder for the BatchDisassociateClientDeviceFromCoreDevice
operation.
- The fluent builder is configurable:
entries(Vec<DisassociateClientDeviceFromCoreDeviceEntry>)
/set_entries(Option<Vec<DisassociateClientDeviceFromCoreDeviceEntry>>)
:The list of client devices to disassociate.
core_device_thing_name(impl Into<String>)
/set_core_device_thing_name(Option<String>)
:The name of the core device. This is also the name of the IoT thing.
- On success, responds with
BatchDisassociateClientDeviceFromCoreDeviceOutput
with field(s):error_entries(Option<Vec<DisassociateClientDeviceFromCoreDeviceErrorEntry>>)
:The list of any errors for the entries in the request. Each error entry contains the name of the IoT thing that failed to disassociate.
- On failure, responds with
SdkError<BatchDisassociateClientDeviceFromCoreDeviceError>
sourcepub fn cancel_deployment(&self) -> CancelDeployment
pub fn cancel_deployment(&self) -> CancelDeployment
Constructs a fluent builder for the CancelDeployment
operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:The ID of the deployment.
- On success, responds with
CancelDeploymentOutput
with field(s):message(Option<String>)
:A message that communicates if the cancel was successful.
- On failure, responds with
SdkError<CancelDeploymentError>
sourcepub fn create_component_version(&self) -> CreateComponentVersion
pub fn create_component_version(&self) -> CreateComponentVersion
Constructs a fluent builder for the CreateComponentVersion
operation.
- The fluent builder is configurable:
inline_recipe(Blob)
/set_inline_recipe(Option<Blob>)
:The recipe to use to create the component. The recipe defines the component’s metadata, parameters, dependencies, lifecycle, artifacts, and platform compatibility.
You must specify either
inlineRecipe
orlambdaFunction
.lambda_function(LambdaFunctionRecipeSource)
/set_lambda_function(Option<LambdaFunctionRecipeSource>)
:The parameters to create a component from a Lambda function.
You must specify either
inlineRecipe
orlambdaFunction
.tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent. Idempotency means that the request is successfully processed only once, even if you send the request multiple times. When a request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2 service returns the successful response that it caches from the previous request. IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.
- On success, responds with
CreateComponentVersionOutput
with field(s):arn(Option<String>)
:The ARN of the component version.
component_name(Option<String>)
:The name of the component.
component_version(Option<String>)
:The version of the component.
creation_timestamp(Option<DateTime>)
:The time at which the component was created, expressed in ISO 8601 format.
status(Option<CloudComponentStatus>)
:The status of the component version in IoT Greengrass V2. This status is different from the status of the component on a core device.
- On failure, responds with
SdkError<CreateComponentVersionError>
sourcepub fn create_deployment(&self) -> CreateDeployment
pub fn create_deployment(&self) -> CreateDeployment
Constructs a fluent builder for the CreateDeployment
operation.
- The fluent builder is configurable:
target_arn(impl Into<String>)
/set_target_arn(Option<String>)
:The ARN of the target IoT thing or thing group.
deployment_name(impl Into<String>)
/set_deployment_name(Option<String>)
:The name of the deployment.
components(HashMap<String, ComponentDeploymentSpecification>)
/set_components(Option<HashMap<String, ComponentDeploymentSpecification>>)
:The components to deploy. This is a dictionary, where each key is the name of a component, and each key’s value is the version and configuration to deploy for that component.
iot_job_configuration(DeploymentIoTJobConfiguration)
/set_iot_job_configuration(Option<DeploymentIoTJobConfiguration>)
:The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
deployment_policies(DeploymentPolicies)
/set_deployment_policies(Option<DeploymentPolicies>)
:The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent. Idempotency means that the request is successfully processed only once, even if you send the request multiple times. When a request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2 service returns the successful response that it caches from the previous request. IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.
- On success, responds with
CreateDeploymentOutput
with field(s):deployment_id(Option<String>)
:The ID of the deployment.
iot_job_id(Option<String>)
:The ID of the IoT job that applies the deployment to target devices.
iot_job_arn(Option<String>)
:The ARN of the IoT job that applies the deployment to target devices.
- On failure, responds with
SdkError<CreateDeploymentError>
sourcepub fn delete_component(&self) -> DeleteComponent
pub fn delete_component(&self) -> DeleteComponent
Constructs a fluent builder for the DeleteComponent
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:The ARN of the component version.
- On success, responds with
DeleteComponentOutput
- On failure, responds with
SdkError<DeleteComponentError>
sourcepub fn delete_core_device(&self) -> DeleteCoreDevice
pub fn delete_core_device(&self) -> DeleteCoreDevice
Constructs a fluent builder for the DeleteCoreDevice
operation.
- The fluent builder is configurable:
core_device_thing_name(impl Into<String>)
/set_core_device_thing_name(Option<String>)
:The name of the core device. This is also the name of the IoT thing.
- On success, responds with
DeleteCoreDeviceOutput
- On failure, responds with
SdkError<DeleteCoreDeviceError>
sourcepub fn delete_deployment(&self) -> DeleteDeployment
pub fn delete_deployment(&self) -> DeleteDeployment
Constructs a fluent builder for the DeleteDeployment
operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:The ID of the deployment.
- On success, responds with
DeleteDeploymentOutput
- On failure, responds with
SdkError<DeleteDeploymentError>
sourcepub fn describe_component(&self) -> DescribeComponent
pub fn describe_component(&self) -> DescribeComponent
Constructs a fluent builder for the DescribeComponent
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:The ARN of the component version.
- On success, responds with
DescribeComponentOutput
with field(s):arn(Option<String>)
:The ARN of the component version.
component_name(Option<String>)
:The name of the component.
component_version(Option<String>)
:The version of the component.
creation_timestamp(Option<DateTime>)
:The time at which the component was created, expressed in ISO 8601 format.
publisher(Option<String>)
:The publisher of the component version.
description(Option<String>)
:The description of the component version.
status(Option<CloudComponentStatus>)
:The status of the component version in IoT Greengrass V2. This status is different from the status of the component on a core device.
platforms(Option<Vec<ComponentPlatform>>)
:The platforms that the component version supports.
tags(Option<HashMap<String, String>>)
:A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
- On failure, responds with
SdkError<DescribeComponentError>
sourcepub fn disassociate_service_role_from_account(
&self
) -> DisassociateServiceRoleFromAccount
pub fn disassociate_service_role_from_account(
&self
) -> DisassociateServiceRoleFromAccount
Constructs a fluent builder for the DisassociateServiceRoleFromAccount
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
DisassociateServiceRoleFromAccountOutput
with field(s):disassociated_at(Option<String>)
:The time when the service role was disassociated from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.
- On failure, responds with
SdkError<DisassociateServiceRoleFromAccountError>
sourcepub fn get_component(&self) -> GetComponent
pub fn get_component(&self) -> GetComponent
Constructs a fluent builder for the GetComponent
operation.
- The fluent builder is configurable:
recipe_output_format(RecipeOutputFormat)
/set_recipe_output_format(Option<RecipeOutputFormat>)
:The format of the recipe.
arn(impl Into<String>)
/set_arn(Option<String>)
:The ARN of the component version.
- On success, responds with
GetComponentOutput
with field(s):recipe_output_format(Option<RecipeOutputFormat>)
:The format of the recipe.
recipe(Option<Blob>)
:The recipe of the component version.
tags(Option<HashMap<String, String>>)
:A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
- On failure, responds with
SdkError<GetComponentError>
sourcepub fn get_component_version_artifact(&self) -> GetComponentVersionArtifact
pub fn get_component_version_artifact(&self) -> GetComponentVersionArtifact
Constructs a fluent builder for the GetComponentVersionArtifact
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:The ARN of the component version. Specify the ARN of a public or a Lambda component version.
artifact_name(impl Into<String>)
/set_artifact_name(Option<String>)
:The name of the artifact.
You can use the GetComponent operation to download the component recipe, which includes the URI of the artifact. The artifact name is the section of the URI after the scheme. For example, in the artifact URI
greengrass:SomeArtifact.zip
, the artifact name isSomeArtifact.zip
.
- On success, responds with
GetComponentVersionArtifactOutput
with field(s):pre_signed_url(Option<String>)
:The URL of the artifact.
- On failure, responds with
SdkError<GetComponentVersionArtifactError>
sourcepub fn get_connectivity_info(&self) -> GetConnectivityInfo
pub fn get_connectivity_info(&self) -> GetConnectivityInfo
Constructs a fluent builder for the GetConnectivityInfo
operation.
- The fluent builder is configurable:
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:The name of the core device. This is also the name of the IoT thing.
- On success, responds with
GetConnectivityInfoOutput
with field(s):connectivity_info(Option<Vec<ConnectivityInfo>>)
:The connectivity information for the core device.
message(Option<String>)
:A message about the connectivity information request.
- On failure, responds with
SdkError<GetConnectivityInfoError>
sourcepub fn get_core_device(&self) -> GetCoreDevice
pub fn get_core_device(&self) -> GetCoreDevice
Constructs a fluent builder for the GetCoreDevice
operation.
- The fluent builder is configurable:
core_device_thing_name(impl Into<String>)
/set_core_device_thing_name(Option<String>)
:The name of the core device. This is also the name of the IoT thing.
- On success, responds with
GetCoreDeviceOutput
with field(s):core_device_thing_name(Option<String>)
:The name of the core device. This is also the name of the IoT thing.
core_version(Option<String>)
:The version of the IoT Greengrass Core software that the core device runs. This version is equivalent to the version of the Greengrass nucleus component that runs on the core device. For more information, see the Greengrass nucleus component in the IoT Greengrass V2 Developer Guide.
platform(Option<String>)
:The operating system platform that the core device runs.
architecture(Option<String>)
:The computer architecture of the core device.
status(Option<CoreDeviceStatus>)
:The status of the core device. The core device status can be:
-
HEALTHY
– The IoT Greengrass Core software and all components run on the core device without issue. -
UNHEALTHY
– The IoT Greengrass Core software or a component is in a failed state on the core device.
-
last_status_update_timestamp(Option<DateTime>)
:The time at which the core device’s status last updated, expressed in ISO 8601 format.
tags(Option<HashMap<String, String>>)
:A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
- On failure, responds with
SdkError<GetCoreDeviceError>
sourcepub fn get_deployment(&self) -> GetDeployment
pub fn get_deployment(&self) -> GetDeployment
Constructs a fluent builder for the GetDeployment
operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:The ID of the deployment.
- On success, responds with
GetDeploymentOutput
with field(s):target_arn(Option<String>)
:The ARN of the target IoT thing or thing group.
revision_id(Option<String>)
:The revision number of the deployment.
deployment_id(Option<String>)
:The ID of the deployment.
deployment_name(Option<String>)
:The name of the deployment.
deployment_status(Option<DeploymentStatus>)
:The status of the deployment.
iot_job_id(Option<String>)
:The ID of the IoT job that applies the deployment to target devices.
iot_job_arn(Option<String>)
:The ARN of the IoT job that applies the deployment to target devices.
components(Option<HashMap<String, ComponentDeploymentSpecification>>)
:The components to deploy. This is a dictionary, where each key is the name of a component, and each key’s value is the version and configuration to deploy for that component.
deployment_policies(Option<DeploymentPolicies>)
:The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
iot_job_configuration(Option<DeploymentIoTJobConfiguration>)
:The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
creation_timestamp(Option<DateTime>)
:The time at which the deployment was created, expressed in ISO 8601 format.
is_latest_for_target(bool)
:Whether or not the deployment is the latest revision for its target.
tags(Option<HashMap<String, String>>)
:A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
- On failure, responds with
SdkError<GetDeploymentError>
sourcepub fn get_service_role_for_account(&self) -> GetServiceRoleForAccount
pub fn get_service_role_for_account(&self) -> GetServiceRoleForAccount
Constructs a fluent builder for the GetServiceRoleForAccount
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetServiceRoleForAccountOutput
with field(s):associated_at(Option<String>)
:The time when the service role was associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.
role_arn(Option<String>)
:The ARN of the service role that is associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.
- On failure, responds with
SdkError<GetServiceRoleForAccountError>
sourcepub fn list_client_devices_associated_with_core_device(
&self
) -> ListClientDevicesAssociatedWithCoreDevice
pub fn list_client_devices_associated_with_core_device(
&self
) -> ListClientDevicesAssociatedWithCoreDevice
Constructs a fluent builder for the ListClientDevicesAssociatedWithCoreDevice
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
core_device_thing_name(impl Into<String>)
/set_core_device_thing_name(Option<String>)
:The name of the core device. This is also the name of the IoT thing.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to be returned per paginated request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to be used for the next set of paginated results.
- On success, responds with
ListClientDevicesAssociatedWithCoreDeviceOutput
with field(s):associated_client_devices(Option<Vec<AssociatedClientDevice>>)
:A list that describes the client devices that are associated with the core device.
next_token(Option<String>)
:The token for the next set of results, or null if there are no additional results.
- On failure, responds with
SdkError<ListClientDevicesAssociatedWithCoreDeviceError>
sourcepub fn list_components(&self) -> ListComponents
pub fn list_components(&self) -> ListComponents
Constructs a fluent builder for the ListComponents
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
scope(ComponentVisibilityScope)
/set_scope(Option<ComponentVisibilityScope>)
:The scope of the components to list.
Default:
PRIVATE
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to be returned per paginated request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to be used for the next set of paginated results.
- On success, responds with
ListComponentsOutput
with field(s):components(Option<Vec<Component>>)
:A list that summarizes each component.
next_token(Option<String>)
:The token for the next set of results, or null if there are no additional results.
- On failure, responds with
SdkError<ListComponentsError>
sourcepub fn list_component_versions(&self) -> ListComponentVersions
pub fn list_component_versions(&self) -> ListComponentVersions
Constructs a fluent builder for the ListComponentVersions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:The ARN of the component.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to be returned per paginated request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to be used for the next set of paginated results.
- On success, responds with
ListComponentVersionsOutput
with field(s):component_versions(Option<Vec<ComponentVersionListItem>>)
:A list of versions that exist for the component.
next_token(Option<String>)
:The token for the next set of results, or null if there are no additional results.
- On failure, responds with
SdkError<ListComponentVersionsError>
sourcepub fn list_core_devices(&self) -> ListCoreDevices
pub fn list_core_devices(&self) -> ListCoreDevices
Constructs a fluent builder for the ListCoreDevices
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
thing_group_arn(impl Into<String>)
/set_thing_group_arn(Option<String>)
:The ARN of the IoT thing group by which to filter. If you specify this parameter, the list includes only core devices that have successfully deployed a deployment that targets the thing group. When you remove a core device from a thing group, the list continues to include that core device.
status(CoreDeviceStatus)
/set_status(Option<CoreDeviceStatus>)
:The core device status by which to filter. If you specify this parameter, the list includes only core devices that have this status. Choose one of the following options:
-
HEALTHY
– The IoT Greengrass Core software and all components run on the core device without issue. -
UNHEALTHY
– The IoT Greengrass Core software or a component is in a failed state on the core device.
-
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to be returned per paginated request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to be used for the next set of paginated results.
- On success, responds with
ListCoreDevicesOutput
with field(s):core_devices(Option<Vec<CoreDevice>>)
:A list that summarizes each core device.
next_token(Option<String>)
:The token for the next set of results, or null if there are no additional results.
- On failure, responds with
SdkError<ListCoreDevicesError>
sourcepub fn list_deployments(&self) -> ListDeployments
pub fn list_deployments(&self) -> ListDeployments
Constructs a fluent builder for the ListDeployments
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
target_arn(impl Into<String>)
/set_target_arn(Option<String>)
:The ARN of the target IoT thing or thing group.
history_filter(DeploymentHistoryFilter)
/set_history_filter(Option<DeploymentHistoryFilter>)
:The filter for the list of deployments. Choose one of the following options:
-
ALL
– The list includes all deployments. -
LATEST_ONLY
– The list includes only the latest revision of each deployment.
Default:
LATEST_ONLY
-
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to be returned per paginated request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to be used for the next set of paginated results.
- On success, responds with
ListDeploymentsOutput
with field(s):deployments(Option<Vec<Deployment>>)
:A list that summarizes each deployment.
next_token(Option<String>)
:The token for the next set of results, or null if there are no additional results.
- On failure, responds with
SdkError<ListDeploymentsError>
sourcepub fn list_effective_deployments(&self) -> ListEffectiveDeployments
pub fn list_effective_deployments(&self) -> ListEffectiveDeployments
Constructs a fluent builder for the ListEffectiveDeployments
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
core_device_thing_name(impl Into<String>)
/set_core_device_thing_name(Option<String>)
:The name of the core device. This is also the name of the IoT thing.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to be returned per paginated request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to be used for the next set of paginated results.
- On success, responds with
ListEffectiveDeploymentsOutput
with field(s):effective_deployments(Option<Vec<EffectiveDeployment>>)
:A list that summarizes each deployment on the core device.
next_token(Option<String>)
:The token for the next set of results, or null if there are no additional results.
- On failure, responds with
SdkError<ListEffectiveDeploymentsError>
sourcepub fn list_installed_components(&self) -> ListInstalledComponents
pub fn list_installed_components(&self) -> ListInstalledComponents
Constructs a fluent builder for the ListInstalledComponents
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
core_device_thing_name(impl Into<String>)
/set_core_device_thing_name(Option<String>)
:The name of the core device. This is also the name of the IoT thing.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to be returned per paginated request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token to be used for the next set of paginated results.
- On success, responds with
ListInstalledComponentsOutput
with field(s):installed_components(Option<Vec<InstalledComponent>>)
:A list that summarizes each component on the core device.
next_token(Option<String>)
:The token for the next set of results, or null if there are no additional results.
- On failure, responds with
SdkError<ListInstalledComponentsError>
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The ARN of the resource.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap<String, String>>)
:A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
- On failure, responds with
SdkError<ListTagsForResourceError>
sourcepub fn resolve_component_candidates(&self) -> ResolveComponentCandidates
pub fn resolve_component_candidates(&self) -> ResolveComponentCandidates
Constructs a fluent builder for the ResolveComponentCandidates
operation.
- The fluent builder is configurable:
platform(ComponentPlatform)
/set_platform(Option<ComponentPlatform>)
:The platform to use to resolve compatible components.
component_candidates(Vec<ComponentCandidate>)
/set_component_candidates(Option<Vec<ComponentCandidate>>)
:The list of components to resolve.
- On success, responds with
ResolveComponentCandidatesOutput
with field(s):resolved_component_versions(Option<Vec<ResolvedComponentVersion>>)
:A list of components that meet the requirements that you specify in the request. This list includes each component’s recipe that you can use to install the component.
- On failure, responds with
SdkError<ResolveComponentCandidatesError>
sourcepub fn tag_resource(&self) -> TagResource
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 ARN of the resource to tag.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
sourcepub fn untag_resource(&self) -> UntagResource
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 ARN of the resource to untag.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:A list of keys for tags to remove from the resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
sourcepub fn update_connectivity_info(&self) -> UpdateConnectivityInfo
pub fn update_connectivity_info(&self) -> UpdateConnectivityInfo
Constructs a fluent builder for the UpdateConnectivityInfo
operation.
- The fluent builder is configurable:
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:The name of the core device. This is also the name of the IoT thing.
connectivity_info(Vec<ConnectivityInfo>)
/set_connectivity_info(Option<Vec<ConnectivityInfo>>)
:The connectivity information for the core device.
- On success, responds with
UpdateConnectivityInfoOutput
with field(s):version(Option<String>)
:The new version of the connectivity information for the core device.
message(Option<String>)
:A message about the connectivity information update request.
- On failure, responds with
SdkError<UpdateConnectivityInfoError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more