Struct aws_sdk_greengrassv2::client::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.
§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_greengrassv2::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_greengrassv2::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 AssociateServiceRoleToAccount
operation has
a Client::associate_service_role_to_account
, 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_service_role_to_account()
.role_arn("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_service_role_to_account(
&self
) -> AssociateServiceRoleToAccountFluentBuilder
pub fn associate_service_role_to_account( &self ) -> AssociateServiceRoleToAccountFluentBuilder
Constructs a fluent builder for the AssociateServiceRoleToAccount
operation.
- The fluent builder is configurable:
role_arn(impl Into<String>)
/set_role_arn(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn batch_associate_client_device_with_core_device(
&self
) -> BatchAssociateClientDeviceWithCoreDeviceFluentBuilder
pub fn batch_associate_client_device_with_core_device( &self ) -> BatchAssociateClientDeviceWithCoreDeviceFluentBuilder
Constructs a fluent builder for the BatchAssociateClientDeviceWithCoreDevice
operation.
- The fluent builder is configurable:
entries(AssociateClientDeviceWithCoreDeviceEntry)
/set_entries(Option<Vec::<AssociateClientDeviceWithCoreDeviceEntry>>)
:
required: falseThe list of client devices to associate.
core_device_thing_name(impl Into<String>)
/set_core_device_thing_name(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn batch_disassociate_client_device_from_core_device(
&self
) -> BatchDisassociateClientDeviceFromCoreDeviceFluentBuilder
pub fn batch_disassociate_client_device_from_core_device( &self ) -> BatchDisassociateClientDeviceFromCoreDeviceFluentBuilder
Constructs a fluent builder for the BatchDisassociateClientDeviceFromCoreDevice
operation.
- The fluent builder is configurable:
entries(DisassociateClientDeviceFromCoreDeviceEntry)
/set_entries(Option<Vec::<DisassociateClientDeviceFromCoreDeviceEntry>>)
:
required: falseThe list of client devices to disassociate.
core_device_thing_name(impl Into<String>)
/set_core_device_thing_name(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn cancel_deployment(&self) -> CancelDeploymentFluentBuilder
pub fn cancel_deployment(&self) -> CancelDeploymentFluentBuilder
Constructs a fluent builder for the CancelDeployment
operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn create_component_version(&self) -> CreateComponentVersionFluentBuilder
pub fn create_component_version(&self) -> CreateComponentVersionFluentBuilder
Constructs a fluent builder for the CreateComponentVersion
operation.
- The fluent builder is configurable:
inline_recipe(Blob)
/set_inline_recipe(Option<Blob>)
:
required: falseThe 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>)
:
required: falseThe parameters to create a component from a Lambda function.
You must specify either
inlineRecipe
orlambdaFunction
.tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA 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>)
:
required: falseA 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(String)
:The name of the component.
component_version(String)
:The version of the component.
creation_timestamp(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>
source§impl Client
impl Client
sourcepub fn create_deployment(&self) -> CreateDeploymentFluentBuilder
pub fn create_deployment(&self) -> CreateDeploymentFluentBuilder
Constructs a fluent builder for the CreateDeployment
operation.
- The fluent builder is configurable:
target_arn(impl Into<String>)
/set_target_arn(Option<String>)
:
required: trueThe ARN of the target IoT thing or thing group. When creating a subdeployment, the targetARN can only be a thing group.
deployment_name(impl Into<String>)
/set_deployment_name(Option<String>)
:
required: falseThe name of the deployment.
components(impl Into<String>, ComponentDeploymentSpecification)
/set_components(Option<HashMap::<String, ComponentDeploymentSpecification>>)
:
required: falseThe 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>)
:
required: falseThe 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>)
:
required: falseThe deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
parent_target_arn(impl Into<String>)
/set_parent_target_arn(Option<String>)
:
required: falseThe parent deployment’s target ARN within a subdeployment.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA 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>)
:
required: falseA 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>
source§impl Client
impl Client
sourcepub fn delete_component(&self) -> DeleteComponentFluentBuilder
pub fn delete_component(&self) -> DeleteComponentFluentBuilder
Constructs a fluent builder for the DeleteComponent
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: trueThe ARN of the component version.
- On success, responds with
DeleteComponentOutput
- On failure, responds with
SdkError<DeleteComponentError>
source§impl Client
impl Client
sourcepub fn delete_core_device(&self) -> DeleteCoreDeviceFluentBuilder
pub fn delete_core_device(&self) -> DeleteCoreDeviceFluentBuilder
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>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn delete_deployment(&self) -> DeleteDeploymentFluentBuilder
pub fn delete_deployment(&self) -> DeleteDeploymentFluentBuilder
Constructs a fluent builder for the DeleteDeployment
operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:
required: trueThe ID of the deployment.
- On success, responds with
DeleteDeploymentOutput
- On failure, responds with
SdkError<DeleteDeploymentError>
source§impl Client
impl Client
sourcepub fn describe_component(&self) -> DescribeComponentFluentBuilder
pub fn describe_component(&self) -> DescribeComponentFluentBuilder
Constructs a fluent builder for the DescribeComponent
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn disassociate_service_role_from_account(
&self
) -> DisassociateServiceRoleFromAccountFluentBuilder
pub fn disassociate_service_role_from_account( &self ) -> DisassociateServiceRoleFromAccountFluentBuilder
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>
source§impl Client
impl Client
sourcepub fn get_component(&self) -> GetComponentFluentBuilder
pub fn get_component(&self) -> GetComponentFluentBuilder
Constructs a fluent builder for the GetComponent
operation.
- The fluent builder is configurable:
recipe_output_format(RecipeOutputFormat)
/set_recipe_output_format(Option<RecipeOutputFormat>)
:
required: falseThe format of the recipe.
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: trueThe ARN of the component version.
- On success, responds with
GetComponentOutput
with field(s):recipe_output_format(RecipeOutputFormat)
:The format of the recipe.
recipe(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>
source§impl Client
impl Client
sourcepub fn get_component_version_artifact(
&self
) -> GetComponentVersionArtifactFluentBuilder
pub fn get_component_version_artifact( &self ) -> GetComponentVersionArtifactFluentBuilder
Constructs a fluent builder for the GetComponentVersionArtifact
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: trueThe 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>)
:
required: trueThe 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(String)
:The URL of the artifact.
- On failure, responds with
SdkError<GetComponentVersionArtifactError>
source§impl Client
impl Client
sourcepub fn get_connectivity_info(&self) -> GetConnectivityInfoFluentBuilder
pub fn get_connectivity_info(&self) -> GetConnectivityInfoFluentBuilder
Constructs a fluent builder for the GetConnectivityInfo
operation.
- The fluent builder is configurable:
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn get_core_device(&self) -> GetCoreDeviceFluentBuilder
pub fn get_core_device(&self) -> GetCoreDeviceFluentBuilder
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>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn get_deployment(&self) -> GetDeploymentFluentBuilder
pub fn get_deployment(&self) -> GetDeploymentFluentBuilder
Constructs a fluent builder for the GetDeployment
operation.
- The fluent builder is configurable:
deployment_id(impl Into<String>)
/set_deployment_id(Option<String>)
:
required: trueThe 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.
parent_target_arn(Option<String>)
:The parent deployment’s target ARN within a subdeployment.
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>
source§impl Client
impl Client
sourcepub fn get_service_role_for_account(
&self
) -> GetServiceRoleForAccountFluentBuilder
pub fn get_service_role_for_account( &self ) -> GetServiceRoleForAccountFluentBuilder
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>
source§impl Client
impl Client
sourcepub fn list_client_devices_associated_with_core_device(
&self
) -> ListClientDevicesAssociatedWithCoreDeviceFluentBuilder
pub fn list_client_devices_associated_with_core_device( &self ) -> ListClientDevicesAssociatedWithCoreDeviceFluentBuilder
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>)
:
required: trueThe name of the core device. This is also the name of the IoT thing.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be returned per paginated request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn list_component_versions(&self) -> ListComponentVersionsFluentBuilder
pub fn list_component_versions(&self) -> ListComponentVersionsFluentBuilder
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>)
:
required: trueThe ARN of the component.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be returned per paginated request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn list_components(&self) -> ListComponentsFluentBuilder
pub fn list_components(&self) -> ListComponentsFluentBuilder
Constructs a fluent builder for the ListComponents
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
scope(ComponentVisibilityScope)
/set_scope(Option<ComponentVisibilityScope>)
:
required: falseThe scope of the components to list.
Default:
PRIVATE
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be returned per paginated request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn list_core_devices(&self) -> ListCoreDevicesFluentBuilder
pub fn list_core_devices(&self) -> ListCoreDevicesFluentBuilder
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>)
:
required: falseThe 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>)
:
required: falseThe 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>)
:
required: falseThe maximum number of results to be returned per paginated request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn list_deployments(&self) -> ListDeploymentsFluentBuilder
pub fn list_deployments(&self) -> ListDeploymentsFluentBuilder
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>)
:
required: falseThe ARN of the target IoT thing or thing group.
history_filter(DeploymentHistoryFilter)
/set_history_filter(Option<DeploymentHistoryFilter>)
:
required: falseThe 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
-
parent_target_arn(impl Into<String>)
/set_parent_target_arn(Option<String>)
:
required: falseThe parent deployment’s target ARN within a subdeployment.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be returned per paginated request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn list_effective_deployments(
&self
) -> ListEffectiveDeploymentsFluentBuilder
pub fn list_effective_deployments( &self ) -> ListEffectiveDeploymentsFluentBuilder
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>)
:
required: trueThe name of the core device. This is also the name of the IoT thing.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be returned per paginated request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn list_installed_components(&self) -> ListInstalledComponentsFluentBuilder
pub fn list_installed_components(&self) -> ListInstalledComponentsFluentBuilder
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>)
:
required: trueThe name of the core device. This is also the name of the IoT thing.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to be returned per paginated request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to be used for the next set of paginated results.
topology_filter(InstalledComponentTopologyFilter)
/set_topology_filter(Option<InstalledComponentTopologyFilter>)
:
required: falseThe filter for the list of components. Choose from the following options:
-
ALL
– The list includes all components installed on the core device. -
ROOT
– The list includes only root components, which are components that you specify in a deployment. When you choose this option, the list doesn’t include components that the core device installs as dependencies of other components.
Default:
ROOT
-
- On success, responds with
ListInstalledComponentsOutput
with field(s):installed_components(Option<Vec::<InstalledComponent>>)
:A list that summarizes each component on the core device.
Greengrass nucleus v2.7.0 or later is required to get an accurate
lastStatusChangeTimestamp
response. This response can be inaccurate in earlier Greengrass nucleus versions.Greengrass nucleus v2.8.0 or later is required to get an accurate
lastInstallationSource
andlastReportedTimestamp
response. This response can be inaccurate or null in earlier Greengrass nucleus versions.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>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the resource.
- 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>
source§impl Client
impl Client
sourcepub fn resolve_component_candidates(
&self
) -> ResolveComponentCandidatesFluentBuilder
pub fn resolve_component_candidates( &self ) -> ResolveComponentCandidatesFluentBuilder
Constructs a fluent builder for the ResolveComponentCandidates
operation.
- The fluent builder is configurable:
platform(ComponentPlatform)
/set_platform(Option<ComponentPlatform>)
:
required: falseThe platform to use to resolve compatible components.
component_candidates(ComponentCandidate)
/set_component_candidates(Option<Vec::<ComponentCandidate>>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the resource to tag.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueA 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>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the resource to untag.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueA list of keys for tags to remove from the resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_connectivity_info(&self) -> UpdateConnectivityInfoFluentBuilder
pub fn update_connectivity_info(&self) -> UpdateConnectivityInfoFluentBuilder
Constructs a fluent builder for the UpdateConnectivityInfo
operation.
- The fluent builder is configurable:
thing_name(impl Into<String>)
/set_thing_name(Option<String>)
:
required: trueThe name of the core device. This is also the name of the IoT thing.
connectivity_info(ConnectivityInfo)
/set_connectivity_info(Option<Vec::<ConnectivityInfo>>)
:
required: trueThe 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>
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