Struct aws_sdk_panorama::client::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for AWS Panorama
Client for invoking operations on AWS Panorama. Each operation on AWS Panorama 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_panorama::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_panorama::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 CreateApplicationInstance
operation has
a Client::create_application_instance
, 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.create_application_instance()
.name("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn create_application_instance(
&self
) -> CreateApplicationInstanceFluentBuilder
pub fn create_application_instance( &self ) -> CreateApplicationInstanceFluentBuilder
Constructs a fluent builder for the CreateApplicationInstance
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseA name for the application instance.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description for the application instance.
manifest_payload(ManifestPayload)
/set_manifest_payload(Option<ManifestPayload>)
:
required: trueThe application’s manifest document.
manifest_overrides_payload(ManifestOverridesPayload)
/set_manifest_overrides_payload(Option<ManifestOverridesPayload>)
:
required: falseSetting overrides for the application manifest.
application_instance_id_to_replace(impl Into<String>)
/set_application_instance_id_to_replace(Option<String>)
:
required: falseThe ID of an application instance to replace with the new instance.
runtime_role_arn(impl Into<String>)
/set_runtime_role_arn(Option<String>)
:
required: falseThe ARN of a runtime role for the application instance.
default_runtime_context_device(impl Into<String>)
/set_default_runtime_context_device(Option<String>)
:
required: trueA device’s ID.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseTags for the application instance.
- On success, responds with
CreateApplicationInstanceOutput
with field(s):application_instance_id(String)
:The application instance’s ID.
- On failure, responds with
SdkError<CreateApplicationInstanceError>
source§impl Client
impl Client
sourcepub fn create_job_for_devices(&self) -> CreateJobForDevicesFluentBuilder
pub fn create_job_for_devices(&self) -> CreateJobForDevicesFluentBuilder
Constructs a fluent builder for the CreateJobForDevices
operation.
- The fluent builder is configurable:
device_ids(impl Into<String>)
/set_device_ids(Option<Vec::<String>>)
:
required: trueID of target device.
device_job_config(DeviceJobConfig)
/set_device_job_config(Option<DeviceJobConfig>)
:
required: falseConfiguration settings for a software update job.
job_type(JobType)
/set_job_type(Option<JobType>)
:
required: trueThe type of job to run.
- On success, responds with
CreateJobForDevicesOutput
with field(s):jobs(Vec::<Job>)
:A list of jobs.
- On failure, responds with
SdkError<CreateJobForDevicesError>
source§impl Client
impl Client
sourcepub fn create_node_from_template_job(
&self
) -> CreateNodeFromTemplateJobFluentBuilder
pub fn create_node_from_template_job( &self ) -> CreateNodeFromTemplateJobFluentBuilder
Constructs a fluent builder for the CreateNodeFromTemplateJob
operation.
- The fluent builder is configurable:
template_type(TemplateType)
/set_template_type(Option<TemplateType>)
:
required: trueThe type of node.
output_package_name(impl Into<String>)
/set_output_package_name(Option<String>)
:
required: trueAn output package name for the node.
output_package_version(impl Into<String>)
/set_output_package_version(Option<String>)
:
required: trueAn output package version for the node.
node_name(impl Into<String>)
/set_node_name(Option<String>)
:
required: trueA name for the node.
node_description(impl Into<String>)
/set_node_description(Option<String>)
:
required: falseA description for the node.
template_parameters(impl Into<String>, impl Into<String>)
/set_template_parameters(Option<HashMap::<String, String>>)
:
required: trueTemplate parameters for the node.
job_tags(JobResourceTags)
/set_job_tags(Option<Vec::<JobResourceTags>>)
:
required: falseTags for the job.
- On success, responds with
CreateNodeFromTemplateJobOutput
with field(s):job_id(String)
:The job’s ID.
- On failure, responds with
SdkError<CreateNodeFromTemplateJobError>
source§impl Client
impl Client
sourcepub fn create_package(&self) -> CreatePackageFluentBuilder
pub fn create_package(&self) -> CreatePackageFluentBuilder
Constructs a fluent builder for the CreatePackage
operation.
- The fluent builder is configurable:
package_name(impl Into<String>)
/set_package_name(Option<String>)
:
required: trueA name for the package.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseTags for the package.
- On success, responds with
CreatePackageOutput
with field(s):package_id(Option<String>)
:The package’s ID.
arn(Option<String>)
:The package’s ARN.
storage_location(Option<StorageLocation>)
:The package’s storage location.
- On failure, responds with
SdkError<CreatePackageError>
source§impl Client
impl Client
sourcepub fn create_package_import_job(&self) -> CreatePackageImportJobFluentBuilder
pub fn create_package_import_job(&self) -> CreatePackageImportJobFluentBuilder
Constructs a fluent builder for the CreatePackageImportJob
operation.
- The fluent builder is configurable:
job_type(PackageImportJobType)
/set_job_type(Option<PackageImportJobType>)
:
required: trueA job type for the package import job.
input_config(PackageImportJobInputConfig)
/set_input_config(Option<PackageImportJobInputConfig>)
:
required: trueAn input config for the package import job.
output_config(PackageImportJobOutputConfig)
/set_output_config(Option<PackageImportJobOutputConfig>)
:
required: trueAn output config for the package import job.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: trueA client token for the package import job.
job_tags(JobResourceTags)
/set_job_tags(Option<Vec::<JobResourceTags>>)
:
required: falseTags for the package import job.
- On success, responds with
CreatePackageImportJobOutput
with field(s):job_id(String)
:The job’s ID.
- On failure, responds with
SdkError<CreatePackageImportJobError>
source§impl Client
impl Client
sourcepub fn delete_device(&self) -> DeleteDeviceFluentBuilder
pub fn delete_device(&self) -> DeleteDeviceFluentBuilder
Constructs a fluent builder for the DeleteDevice
operation.
- The fluent builder is configurable:
device_id(impl Into<String>)
/set_device_id(Option<String>)
:
required: trueThe device’s ID.
- On success, responds with
DeleteDeviceOutput
with field(s):device_id(Option<String>)
:The device’s ID.
- On failure, responds with
SdkError<DeleteDeviceError>
source§impl Client
impl Client
sourcepub fn delete_package(&self) -> DeletePackageFluentBuilder
pub fn delete_package(&self) -> DeletePackageFluentBuilder
Constructs a fluent builder for the DeletePackage
operation.
- The fluent builder is configurable:
package_id(impl Into<String>)
/set_package_id(Option<String>)
:
required: trueThe package’s ID.
force_delete(bool)
/set_force_delete(Option<bool>)
:
required: falseDelete the package even if it has artifacts stored in its access point. Deletes the package’s artifacts from Amazon S3.
- On success, responds with
DeletePackageOutput
- On failure, responds with
SdkError<DeletePackageError>
source§impl Client
impl Client
sourcepub fn deregister_package_version(
&self
) -> DeregisterPackageVersionFluentBuilder
pub fn deregister_package_version( &self ) -> DeregisterPackageVersionFluentBuilder
Constructs a fluent builder for the DeregisterPackageVersion
operation.
- The fluent builder is configurable:
owner_account(impl Into<String>)
/set_owner_account(Option<String>)
:
required: falseAn owner account.
package_id(impl Into<String>)
/set_package_id(Option<String>)
:
required: trueA package ID.
package_version(impl Into<String>)
/set_package_version(Option<String>)
:
required: trueA package version.
patch_version(impl Into<String>)
/set_patch_version(Option<String>)
:
required: trueA patch version.
updated_latest_patch_version(impl Into<String>)
/set_updated_latest_patch_version(Option<String>)
:
required: falseIf the version was marked latest, the new version to maker as latest.
- On success, responds with
DeregisterPackageVersionOutput
- On failure, responds with
SdkError<DeregisterPackageVersionError>
source§impl Client
impl Client
sourcepub fn describe_application_instance(
&self
) -> DescribeApplicationInstanceFluentBuilder
pub fn describe_application_instance( &self ) -> DescribeApplicationInstanceFluentBuilder
Constructs a fluent builder for the DescribeApplicationInstance
operation.
- The fluent builder is configurable:
application_instance_id(impl Into<String>)
/set_application_instance_id(Option<String>)
:
required: trueThe application instance’s ID.
- On success, responds with
DescribeApplicationInstanceOutput
with field(s):name(Option<String>)
:The application instance’s name.
description(Option<String>)
:The application instance’s description.
default_runtime_context_device(Option<String>)
:The device’s ID.
default_runtime_context_device_name(Option<String>)
:The device’s bane.
application_instance_id_to_replace(Option<String>)
:The ID of the application instance that this instance replaced.
runtime_role_arn(Option<String>)
:The application instance’s runtime role ARN.
status(Option<ApplicationInstanceStatus>)
:The application instance’s status.
health_status(Option<ApplicationInstanceHealthStatus>)
:The application instance’s health status.
status_description(Option<String>)
:The application instance’s status description.
created_time(Option<DateTime>)
:When the application instance was created.
last_updated_time(Option<DateTime>)
:The application instance was updated.
application_instance_id(Option<String>)
:The application instance’s ID.
arn(Option<String>)
:The application instance’s ARN.
tags(Option<HashMap::<String, String>>)
:The application instance’s tags.
runtime_context_states(Option<Vec::<ReportedRuntimeContextState>>)
:The application instance’s state.
- On failure, responds with
SdkError<DescribeApplicationInstanceError>
source§impl Client
impl Client
sourcepub fn describe_application_instance_details(
&self
) -> DescribeApplicationInstanceDetailsFluentBuilder
pub fn describe_application_instance_details( &self ) -> DescribeApplicationInstanceDetailsFluentBuilder
Constructs a fluent builder for the DescribeApplicationInstanceDetails
operation.
- The fluent builder is configurable:
application_instance_id(impl Into<String>)
/set_application_instance_id(Option<String>)
:
required: trueThe application instance’s ID.
- On success, responds with
DescribeApplicationInstanceDetailsOutput
with field(s):name(Option<String>)
:The application instance’s name.
description(Option<String>)
:The application instance’s description.
default_runtime_context_device(Option<String>)
:The application instance’s default runtime context device.
manifest_payload(Option<ManifestPayload>)
:The application instance’s configuration manifest.
manifest_overrides_payload(Option<ManifestOverridesPayload>)
:Parameter overrides for the configuration manifest.
application_instance_id_to_replace(Option<String>)
:The ID of the application instance that this instance replaced.
created_time(Option<DateTime>)
:When the application instance was created.
application_instance_id(Option<String>)
:The application instance’s ID.
- On failure, responds with
SdkError<DescribeApplicationInstanceDetailsError>
source§impl Client
impl Client
sourcepub fn describe_device(&self) -> DescribeDeviceFluentBuilder
pub fn describe_device(&self) -> DescribeDeviceFluentBuilder
Constructs a fluent builder for the DescribeDevice
operation.
- The fluent builder is configurable:
device_id(impl Into<String>)
/set_device_id(Option<String>)
:
required: trueThe device’s ID.
- On success, responds with
DescribeDeviceOutput
with field(s):device_id(Option<String>)
:The device’s ID.
name(Option<String>)
:The device’s name.
arn(Option<String>)
:The device’s ARN.
description(Option<String>)
:The device’s description.
r#type(Option<DeviceType>)
:The device’s type.
device_connection_status(Option<DeviceConnectionStatus>)
:The device’s connection status.
created_time(Option<DateTime>)
:When the device was created.
provisioning_status(Option<DeviceStatus>)
:The device’s provisioning status.
latest_software(Option<String>)
:The latest software version available for the device.
current_software(Option<String>)
:The device’s current software version.
serial_number(Option<String>)
:The device’s serial number.
tags(Option<HashMap::<String, String>>)
:The device’s tags.
networking_configuration(Option<NetworkPayload>)
:The device’s networking configuration.
current_networking_status(Option<NetworkStatus>)
:The device’s networking status.
lease_expiration_time(Option<DateTime>)
:The device’s lease expiration time.
alternate_softwares(Option<Vec::<AlternateSoftwareMetadata>>)
:Beta software releases available for the device.
latest_alternate_software(Option<String>)
:The most recent beta software release.
brand(Option<DeviceBrand>)
:The device’s maker.
latest_device_job(Option<LatestDeviceJob>)
:A device’s latest job. Includes the target image version, and the job status.
device_aggregated_status(Option<DeviceAggregatedStatus>)
:A device’s aggregated status. Including the device’s connection status, provisioning status, and lease status.
- On failure, responds with
SdkError<DescribeDeviceError>
source§impl Client
impl Client
sourcepub fn describe_device_job(&self) -> DescribeDeviceJobFluentBuilder
pub fn describe_device_job(&self) -> DescribeDeviceJobFluentBuilder
Constructs a fluent builder for the DescribeDeviceJob
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:
required: trueThe job’s ID.
- On success, responds with
DescribeDeviceJobOutput
with field(s):job_id(Option<String>)
:The job’s ID.
device_id(Option<String>)
:The device’s ID.
device_arn(Option<String>)
:The device’s ARN.
device_name(Option<String>)
:The device’s name.
device_type(Option<DeviceType>)
:The device’s type.
image_version(Option<String>)
:For an OTA job, the target version of the device software.
status(Option<UpdateProgress>)
:The job’s status.
created_time(Option<DateTime>)
:When the job was created.
job_type(Option<JobType>)
:The job’s type.
- On failure, responds with
SdkError<DescribeDeviceJobError>
source§impl Client
impl Client
sourcepub fn describe_node(&self) -> DescribeNodeFluentBuilder
pub fn describe_node(&self) -> DescribeNodeFluentBuilder
Constructs a fluent builder for the DescribeNode
operation.
- The fluent builder is configurable:
node_id(impl Into<String>)
/set_node_id(Option<String>)
:
required: trueThe node’s ID.
owner_account(impl Into<String>)
/set_owner_account(Option<String>)
:
required: falseThe account ID of the node’s owner.
- On success, responds with
DescribeNodeOutput
with field(s):node_id(String)
:The node’s ID.
name(String)
:The node’s name.
category(NodeCategory)
:The node’s category.
owner_account(String)
:The account ID of the node’s owner.
package_name(String)
:The node’s package name.
package_id(String)
:The node’s package ID.
package_arn(Option<String>)
:The node’s ARN.
package_version(String)
:The node’s package version.
patch_version(String)
:The node’s patch version.
node_interface(Option<NodeInterface>)
:The node’s interface.
asset_name(Option<String>)
:The node’s asset name.
description(String)
:The node’s description.
created_time(DateTime)
:When the node was created.
last_updated_time(DateTime)
:When the node was updated.
- On failure, responds with
SdkError<DescribeNodeError>
source§impl Client
impl Client
sourcepub fn describe_node_from_template_job(
&self
) -> DescribeNodeFromTemplateJobFluentBuilder
pub fn describe_node_from_template_job( &self ) -> DescribeNodeFromTemplateJobFluentBuilder
Constructs a fluent builder for the DescribeNodeFromTemplateJob
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:
required: trueThe job’s ID.
- On success, responds with
DescribeNodeFromTemplateJobOutput
with field(s):job_id(String)
:The job’s ID.
status(NodeFromTemplateJobStatus)
:The job’s status.
status_message(String)
:The job’s status message.
created_time(DateTime)
:When the job was created.
last_updated_time(DateTime)
:When the job was updated.
output_package_name(String)
:The job’s output package name.
output_package_version(String)
:The job’s output package version.
node_name(String)
:The node’s name.
node_description(Option<String>)
:The node’s description.
template_type(TemplateType)
:The job’s template type.
template_parameters(HashMap::<String, String>)
:The job’s template parameters.
job_tags(Option<Vec::<JobResourceTags>>)
:The job’s tags.
- On failure, responds with
SdkError<DescribeNodeFromTemplateJobError>
source§impl Client
impl Client
sourcepub fn describe_package(&self) -> DescribePackageFluentBuilder
pub fn describe_package(&self) -> DescribePackageFluentBuilder
Constructs a fluent builder for the DescribePackage
operation.
- The fluent builder is configurable:
package_id(impl Into<String>)
/set_package_id(Option<String>)
:
required: trueThe package’s ID.
- On success, responds with
DescribePackageOutput
with field(s):package_id(String)
:The package’s ID.
package_name(String)
:The package’s name.
arn(String)
:The package’s ARN.
storage_location(Option<StorageLocation>)
:The package’s storage location.
read_access_principal_arns(Option<Vec::<String>>)
:ARNs of accounts that have read access to the package.
write_access_principal_arns(Option<Vec::<String>>)
:ARNs of accounts that have write access to the package.
created_time(DateTime)
:When the package was created.
tags(HashMap::<String, String>)
:The package’s tags.
- On failure, responds with
SdkError<DescribePackageError>
source§impl Client
impl Client
sourcepub fn describe_package_import_job(
&self
) -> DescribePackageImportJobFluentBuilder
pub fn describe_package_import_job( &self ) -> DescribePackageImportJobFluentBuilder
Constructs a fluent builder for the DescribePackageImportJob
operation.
- The fluent builder is configurable:
job_id(impl Into<String>)
/set_job_id(Option<String>)
:
required: trueThe job’s ID.
- On success, responds with
DescribePackageImportJobOutput
with field(s):job_id(String)
:The job’s ID.
client_token(Option<String>)
:The job’s client token.
job_type(PackageImportJobType)
:The job’s type.
input_config(Option<PackageImportJobInputConfig>)
:The job’s input config.
output_config(Option<PackageImportJobOutputConfig>)
:The job’s output config.
output(Option<PackageImportJobOutput>)
:The job’s output.
created_time(DateTime)
:When the job was created.
last_updated_time(DateTime)
:When the job was updated.
status(PackageImportJobStatus)
:The job’s status.
status_message(String)
:The job’s status message.
job_tags(Option<Vec::<JobResourceTags>>)
:The job’s tags.
- On failure, responds with
SdkError<DescribePackageImportJobError>
source§impl Client
impl Client
sourcepub fn describe_package_version(&self) -> DescribePackageVersionFluentBuilder
pub fn describe_package_version(&self) -> DescribePackageVersionFluentBuilder
Constructs a fluent builder for the DescribePackageVersion
operation.
- The fluent builder is configurable:
owner_account(impl Into<String>)
/set_owner_account(Option<String>)
:
required: falseThe version’s owner account.
package_id(impl Into<String>)
/set_package_id(Option<String>)
:
required: trueThe version’s ID.
package_version(impl Into<String>)
/set_package_version(Option<String>)
:
required: trueThe version’s version.
patch_version(impl Into<String>)
/set_patch_version(Option<String>)
:
required: falseThe version’s patch version.
- On success, responds with
DescribePackageVersionOutput
with field(s):owner_account(Option<String>)
:The account ID of the version’s owner.
package_id(String)
:The version’s ID.
package_arn(Option<String>)
:The ARN of the package.
package_name(String)
:The version’s name.
package_version(String)
:The version’s version.
patch_version(String)
:The version’s patch version.
is_latest_patch(bool)
:Whether the version is the latest available.
status(PackageVersionStatus)
:The version’s status.
status_description(Option<String>)
:The version’s status description.
registered_time(Option<DateTime>)
:The version’s registered time.
- On failure, responds with
SdkError<DescribePackageVersionError>
source§impl Client
impl Client
sourcepub fn list_application_instance_dependencies(
&self
) -> ListApplicationInstanceDependenciesFluentBuilder
pub fn list_application_instance_dependencies( &self ) -> ListApplicationInstanceDependenciesFluentBuilder
Constructs a fluent builder for the ListApplicationInstanceDependencies
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_instance_id(impl Into<String>)
/set_application_instance_id(Option<String>)
:
required: trueThe application instance’s ID.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of application instance dependencies to return in one page of results.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseSpecify the pagination token from a previous request to retrieve the next page of results.
- On success, responds with
ListApplicationInstanceDependenciesOutput
with field(s):package_objects(Option<Vec::<PackageObject>>)
:A list of package objects.
next_token(Option<String>)
:A pagination token that’s included if more results are available.
- On failure, responds with
SdkError<ListApplicationInstanceDependenciesError>
source§impl Client
impl Client
sourcepub fn list_application_instance_node_instances(
&self
) -> ListApplicationInstanceNodeInstancesFluentBuilder
pub fn list_application_instance_node_instances( &self ) -> ListApplicationInstanceNodeInstancesFluentBuilder
Constructs a fluent builder for the ListApplicationInstanceNodeInstances
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
application_instance_id(impl Into<String>)
/set_application_instance_id(Option<String>)
:
required: trueThe node instances’ application instance ID.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of node instances to return in one page of results.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseSpecify the pagination token from a previous request to retrieve the next page of results.
- On success, responds with
ListApplicationInstanceNodeInstancesOutput
with field(s):node_instances(Option<Vec::<NodeInstance>>)
:A list of node instances.
next_token(Option<String>)
:A pagination token that’s included if more results are available.
- On failure, responds with
SdkError<ListApplicationInstanceNodeInstancesError>
source§impl Client
impl Client
sourcepub fn list_application_instances(
&self
) -> ListApplicationInstancesFluentBuilder
pub fn list_application_instances( &self ) -> ListApplicationInstancesFluentBuilder
Constructs a fluent builder for the ListApplicationInstances
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
device_id(impl Into<String>)
/set_device_id(Option<String>)
:
required: falseThe application instances’ device ID.
status_filter(StatusFilter)
/set_status_filter(Option<StatusFilter>)
:
required: falseOnly include instances with a specific status.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of application instances to return in one page of results.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseSpecify the pagination token from a previous request to retrieve the next page of results.
- On success, responds with
ListApplicationInstancesOutput
with field(s):application_instances(Option<Vec::<ApplicationInstance>>)
:A list of application instances.
next_token(Option<String>)
:A pagination token that’s included if more results are available.
- On failure, responds with
SdkError<ListApplicationInstancesError>
source§impl Client
impl Client
sourcepub fn list_devices(&self) -> ListDevicesFluentBuilder
pub fn list_devices(&self) -> ListDevicesFluentBuilder
Constructs a fluent builder for the ListDevices
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseSpecify the pagination token from a previous request to retrieve the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of devices to return in one page of results.
sort_by(ListDevicesSortBy)
/set_sort_by(Option<ListDevicesSortBy>)
:
required: falseThe target column to be sorted on. Default column sort is CREATED_TIME.
sort_order(SortOrder)
/set_sort_order(Option<SortOrder>)
:
required: falseThe sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.
name_filter(impl Into<String>)
/set_name_filter(Option<String>)
:
required: falseFilter based on device’s name. Prefixes supported.
device_aggregated_status_filter(DeviceAggregatedStatus)
/set_device_aggregated_status_filter(Option<DeviceAggregatedStatus>)
:
required: falseFilter based on a device’s status.
- On success, responds with
ListDevicesOutput
with field(s):devices(Vec::<Device>)
:A list of devices.
next_token(Option<String>)
:A pagination token that’s included if more results are available.
- On failure, responds with
SdkError<ListDevicesError>
source§impl Client
impl Client
sourcepub fn list_devices_jobs(&self) -> ListDevicesJobsFluentBuilder
pub fn list_devices_jobs(&self) -> ListDevicesJobsFluentBuilder
Constructs a fluent builder for the ListDevicesJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
device_id(impl Into<String>)
/set_device_id(Option<String>)
:
required: falseFilter results by the job’s target device ID.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseSpecify the pagination token from a previous request to retrieve the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of device jobs to return in one page of results.
- On success, responds with
ListDevicesJobsOutput
with field(s):device_jobs(Option<Vec::<DeviceJob>>)
:A list of jobs.
next_token(Option<String>)
:A pagination token that’s included if more results are available.
- On failure, responds with
SdkError<ListDevicesJobsError>
source§impl Client
impl Client
sourcepub fn list_node_from_template_jobs(
&self
) -> ListNodeFromTemplateJobsFluentBuilder
pub fn list_node_from_template_jobs( &self ) -> ListNodeFromTemplateJobsFluentBuilder
Constructs a fluent builder for the ListNodeFromTemplateJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseSpecify the pagination token from a previous request to retrieve the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of node from template jobs to return in one page of results.
- On success, responds with
ListNodeFromTemplateJobsOutput
with field(s):node_from_template_jobs(Vec::<NodeFromTemplateJob>)
:A list of jobs.
next_token(Option<String>)
:A pagination token that’s included if more results are available.
- On failure, responds with
SdkError<ListNodeFromTemplateJobsError>
source§impl Client
impl Client
sourcepub fn list_nodes(&self) -> ListNodesFluentBuilder
pub fn list_nodes(&self) -> ListNodesFluentBuilder
Constructs a fluent builder for the ListNodes
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
category(NodeCategory)
/set_category(Option<NodeCategory>)
:
required: falseSearch for nodes by category.
owner_account(impl Into<String>)
/set_owner_account(Option<String>)
:
required: falseSearch for nodes by the account ID of the nodes’ owner.
package_name(impl Into<String>)
/set_package_name(Option<String>)
:
required: falseSearch for nodes by name.
package_version(impl Into<String>)
/set_package_version(Option<String>)
:
required: falseSearch for nodes by version.
patch_version(impl Into<String>)
/set_patch_version(Option<String>)
:
required: falseSearch for nodes by patch version.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseSpecify the pagination token from a previous request to retrieve the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of nodes to return in one page of results.
- On success, responds with
ListNodesOutput
with field(s):nodes(Option<Vec::<Node>>)
:A list of nodes.
next_token(Option<String>)
:A pagination token that’s included if more results are available.
- On failure, responds with
SdkError<ListNodesError>
source§impl Client
impl Client
sourcepub fn list_package_import_jobs(&self) -> ListPackageImportJobsFluentBuilder
pub fn list_package_import_jobs(&self) -> ListPackageImportJobsFluentBuilder
Constructs a fluent builder for the ListPackageImportJobs
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseSpecify the pagination token from a previous request to retrieve the next page of results.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of package import jobs to return in one page of results.
- On success, responds with
ListPackageImportJobsOutput
with field(s):package_import_jobs(Vec::<PackageImportJob>)
:A list of package import jobs.
next_token(Option<String>)
:A pagination token that’s included if more results are available.
- On failure, responds with
SdkError<ListPackageImportJobsError>
source§impl Client
impl Client
sourcepub fn list_packages(&self) -> ListPackagesFluentBuilder
pub fn list_packages(&self) -> ListPackagesFluentBuilder
Constructs a fluent builder for the ListPackages
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of packages to return in one page of results.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseSpecify the pagination token from a previous request to retrieve the next page of results.
- On success, responds with
ListPackagesOutput
with field(s):packages(Option<Vec::<PackageListItem>>)
:A list of packages.
next_token(Option<String>)
:A pagination token that’s included if more results are available.
- On failure, responds with
SdkError<ListPackagesError>
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 resource’s ARN.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap::<String, String>>)
:A list of tags.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn provision_device(&self) -> ProvisionDeviceFluentBuilder
pub fn provision_device(&self) -> ProvisionDeviceFluentBuilder
Constructs a fluent builder for the ProvisionDevice
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueA name for the device.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description for the device.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseTags for the device.
networking_configuration(NetworkPayload)
/set_networking_configuration(Option<NetworkPayload>)
:
required: falseA networking configuration for the device.
- On success, responds with
ProvisionDeviceOutput
with field(s):device_id(Option<String>)
:The device’s ID.
arn(String)
:The device’s ARN.
status(DeviceStatus)
:The device’s status.
certificates(Option<Blob>)
:The device’s configuration bundle.
iot_thing_name(Option<String>)
:The device’s IoT thing name.
- On failure, responds with
SdkError<ProvisionDeviceError>
source§impl Client
impl Client
sourcepub fn register_package_version(&self) -> RegisterPackageVersionFluentBuilder
pub fn register_package_version(&self) -> RegisterPackageVersionFluentBuilder
Constructs a fluent builder for the RegisterPackageVersion
operation.
- The fluent builder is configurable:
owner_account(impl Into<String>)
/set_owner_account(Option<String>)
:
required: falseAn owner account.
package_id(impl Into<String>)
/set_package_id(Option<String>)
:
required: trueA package ID.
package_version(impl Into<String>)
/set_package_version(Option<String>)
:
required: trueA package version.
patch_version(impl Into<String>)
/set_patch_version(Option<String>)
:
required: trueA patch version.
mark_latest(bool)
/set_mark_latest(Option<bool>)
:
required: falseWhether to mark the new version as the latest version.
- On success, responds with
RegisterPackageVersionOutput
- On failure, responds with
SdkError<RegisterPackageVersionError>
source§impl Client
impl Client
sourcepub fn remove_application_instance(
&self
) -> RemoveApplicationInstanceFluentBuilder
pub fn remove_application_instance( &self ) -> RemoveApplicationInstanceFluentBuilder
Constructs a fluent builder for the RemoveApplicationInstance
operation.
- The fluent builder is configurable:
application_instance_id(impl Into<String>)
/set_application_instance_id(Option<String>)
:
required: trueAn application instance ID.
- On success, responds with
RemoveApplicationInstanceOutput
- On failure, responds with
SdkError<RemoveApplicationInstanceError>
source§impl Client
impl Client
sourcepub fn signal_application_instance_node_instances(
&self
) -> SignalApplicationInstanceNodeInstancesFluentBuilder
pub fn signal_application_instance_node_instances( &self ) -> SignalApplicationInstanceNodeInstancesFluentBuilder
Constructs a fluent builder for the SignalApplicationInstanceNodeInstances
operation.
- The fluent builder is configurable:
application_instance_id(impl Into<String>)
/set_application_instance_id(Option<String>)
:
required: trueAn application instance ID.
node_signals(NodeSignal)
/set_node_signals(Option<Vec::<NodeSignal>>)
:
required: trueA list of signals.
- On success, responds with
SignalApplicationInstanceNodeInstancesOutput
with field(s):application_instance_id(String)
:An application instance ID.
- On failure, responds with
SdkError<SignalApplicationInstanceNodeInstancesError>
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 resource’s ARN.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueTags for the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe resource’s ARN.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueTag keys to remove.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_device_metadata(&self) -> UpdateDeviceMetadataFluentBuilder
pub fn update_device_metadata(&self) -> UpdateDeviceMetadataFluentBuilder
Constructs a fluent builder for the UpdateDeviceMetadata
operation.
- The fluent builder is configurable:
device_id(impl Into<String>)
/set_device_id(Option<String>)
:
required: trueThe device’s ID.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description for the device.
- On success, responds with
UpdateDeviceMetadataOutput
with field(s):device_id(Option<String>)
:The device’s ID.
- On failure, responds with
SdkError<UpdateDeviceMetadataError>
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