Struct aws_sdk_iot1clickprojects::Client

pub struct Client { /* private fields */ }

Client for AWS IoT 1-Click Projects Service

Client for invoking operations on AWS IoT 1-Click Projects Service. Each operation on AWS IoT 1-Click Projects Service 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_iot1clickprojects::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

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

Implementations

impl Client

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

Creates a client with the given service configuration.

pub fn conf(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn associate_device_with_placement(&self) -> AssociateDeviceWithPlacement

Constructs a fluent builder for the AssociateDeviceWithPlacement operation.

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

    The name of the project containing the placement in which to associate the device.

  • placement_name(impl Into<String>) / set_placement_name(Option<String>):

    The name of the placement in which to associate the device.

  • device_id(impl Into<String>) / set_device_id(Option<String>):

    The ID of the physical device to be associated with the given placement in the project. Note that a mandatory 4 character prefix is required for all deviceId values.

  • device_template_name(impl Into<String>) / set_device_template_name(Option<String>):

    The device template name to associate with the device ID.

• On success, responds with AssociateDeviceWithPlacementOutput
• On failure, responds with SdkError<AssociateDeviceWithPlacementError>

pub fn create_placement(&self) -> CreatePlacement

Constructs a fluent builder for the CreatePlacement operation.

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

    The name of the placement to be created.

  • project_name(impl Into<String>) / set_project_name(Option<String>):

    The name of the project in which to create the placement.

  • attributes(HashMap<String, String>) / set_attributes(Option<HashMap<String, String>>):

    Optional user-defined key/value pairs providing contextual data (such as location or function) for the placement.

• On success, responds with CreatePlacementOutput
• On failure, responds with SdkError<CreatePlacementError>

pub fn create_project(&self) -> CreateProject

Constructs a fluent builder for the CreateProject operation.

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

    The name of the project to create.

  • description(impl Into<String>) / set_description(Option<String>):

    An optional description for the project.

  • placement_template(PlacementTemplate) / set_placement_template(Option<PlacementTemplate>):

    The schema defining the placement to be created. A placement template defines placement default attributes and device templates. You cannot add or remove device templates after the project has been created. However, you can update callbackOverrides for the device templates using the UpdateProject API.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    Optional tags (metadata key/value pairs) to be associated with the project. For example, { {“key1”: “value1”, “key2”: “value2”} }. For more information, see AWS Tagging Strategies.

• On success, responds with CreateProjectOutput
• On failure, responds with SdkError<CreateProjectError>

pub fn delete_placement(&self) -> DeletePlacement

Constructs a fluent builder for the DeletePlacement operation.

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

    The name of the empty placement to delete.

  • project_name(impl Into<String>) / set_project_name(Option<String>):

    The project containing the empty placement to delete.

• On success, responds with DeletePlacementOutput
• On failure, responds with SdkError<DeletePlacementError>

pub fn delete_project(&self) -> DeleteProject

Constructs a fluent builder for the DeleteProject operation.

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

    The name of the empty project to delete.

• On success, responds with DeleteProjectOutput
• On failure, responds with SdkError<DeleteProjectError>

pub fn describe_placement(&self) -> DescribePlacement

Constructs a fluent builder for the DescribePlacement operation.

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

    The name of the placement within a project.

  • project_name(impl Into<String>) / set_project_name(Option<String>):

    The project containing the placement to be described.

• On success, responds with DescribePlacementOutput with field(s):
  • placement(Option<PlacementDescription>):

    An object describing the placement.

• On failure, responds with SdkError<DescribePlacementError>

pub fn describe_project(&self) -> DescribeProject

Constructs a fluent builder for the DescribeProject operation.

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

    The name of the project to be described.

• On success, responds with DescribeProjectOutput with field(s):
  • project(Option<ProjectDescription>):

    An object describing the project.

• On failure, responds with SdkError<DescribeProjectError>

pub fn disassociate_device_from_placement(
    &self
) -> DisassociateDeviceFromPlacement

Constructs a fluent builder for the DisassociateDeviceFromPlacement operation.

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

    The name of the project that contains the placement.

  • placement_name(impl Into<String>) / set_placement_name(Option<String>):

    The name of the placement that the device should be removed from.

  • device_template_name(impl Into<String>) / set_device_template_name(Option<String>):

    The device ID that should be removed from the placement.

• On success, responds with DisassociateDeviceFromPlacementOutput
• On failure, responds with SdkError<DisassociateDeviceFromPlacementError>

pub fn get_devices_in_placement(&self) -> GetDevicesInPlacement

Constructs a fluent builder for the GetDevicesInPlacement operation.

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

    The name of the project containing the placement.

  • placement_name(impl Into<String>) / set_placement_name(Option<String>):

    The name of the placement to get the devices from.

• On success, responds with GetDevicesInPlacementOutput with field(s):
  • devices(Option<HashMap<String, String>>):

    An object containing the devices (zero or more) within the placement.

• On failure, responds with SdkError<GetDevicesInPlacementError>

pub fn list_placements(&self) -> ListPlacements

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

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

    The project containing the placements to be listed.

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

    The token to retrieve the next set of results.

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

    The maximum number of results to return per request. If not set, a default value of 100 is used.

• On success, responds with ListPlacementsOutput with field(s):
  • placements(Option<Vec<PlacementSummary>>):

    An object listing the requested placements.

  • next_token(Option<String>):

    The token used to retrieve the next set of results - will be effectively empty if there are no further results.

• On failure, responds with SdkError<ListPlacementsError>

pub fn list_projects(&self) -> ListProjects

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

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

    The token to retrieve the next set of results.

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

    The maximum number of results to return per request. If not set, a default value of 100 is used.

• On success, responds with ListProjectsOutput with field(s):
  • projects(Option<Vec<ProjectSummary>>):

    An object containing the list of projects.

  • next_token(Option<String>):

    The token used to retrieve the next set of results - will be effectively empty if there are no further results.

• On failure, responds with SdkError<ListProjectsError>

pub fn list_tags_for_resource(&self) -> ListTagsForResource

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 whose tags you want to list.

• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap<String, String>>):

    The tags (metadata key/value pairs) which you have assigned to the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

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 resouce for which tag(s) should be added or modified.

  • tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):

    The new or modifying tag(s) for the resource. See AWS IoT 1-Click Service Limits for the maximum number of tags allowed per resource.

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

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 whose tag you want to remove.

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

    The keys of those tags which you want to remove.

• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

pub fn update_placement(&self) -> UpdatePlacement

Constructs a fluent builder for the UpdatePlacement operation.

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

    The name of the placement to update.

  • project_name(impl Into<String>) / set_project_name(Option<String>):

    The name of the project containing the placement to be updated.

  • attributes(HashMap<String, String>) / set_attributes(Option<HashMap<String, String>>):

    The user-defined object of attributes used to update the placement. The maximum number of key/value pairs is 50.

• On success, responds with UpdatePlacementOutput
• On failure, responds with SdkError<UpdatePlacementError>

pub fn update_project(&self) -> UpdateProject

Constructs a fluent builder for the UpdateProject operation.

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

    The name of the project to be updated.

  • description(impl Into<String>) / set_description(Option<String>):

    An optional user-defined description for the project.

  • placement_template(PlacementTemplate) / set_placement_template(Option<PlacementTemplate>):

    An object defining the project update. Once a project has been created, you cannot add device template names to the project. However, for a given placementTemplate, you can update the associated callbackOverrides for the device definition using this API.

• On success, responds with UpdateProjectOutput
• On failure, responds with SdkError<UpdateProjectError>

impl Client

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

Creates a new client from an SDK Config.

Panics

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

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

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

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.