Struct aws_sdk_iotdeviceadvisor::Client

source · [−]

pub struct Client { /* private fields */ }

Expand description

Client for AWS IoT Core Device Advisor

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

Constructing a client with custom configuration

use aws_config::RetryConfig;
    let shared_config = aws_config::load_from_env().await;
    let config = aws_sdk_iotdeviceadvisor::config::Builder::from(&shared_config)
        .retry_config(RetryConfig::disabled())
        .build();
    let client = aws_sdk_iotdeviceadvisor::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 create_suite_definition(&self) -> CreateSuiteDefinition

Constructs a fluent builder for the CreateSuiteDefinition operation.

The fluent builder is configurable:
- suite_definition_configuration(SuiteDefinitionConfiguration) / set_suite_definition_configuration(Option<SuiteDefinitionConfiguration>):
  Creates a Device Advisor test suite with suite definition configuration.
- tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
  The tags to be attached to the suite definition.
On success, responds with CreateSuiteDefinitionOutput with field(s):
- suite_definition_id(Option<String>):
  Creates a Device Advisor test suite with suite UUID.
- suite_definition_arn(Option<String>):
  Creates a Device Advisor test suite with Amazon Resource Name (ARN).
- suite_definition_name(Option<String>):
  Creates a Device Advisor test suite with suite definition name.
- created_at(Option<DateTime>):
  Creates a Device Advisor test suite with TimeStamp of when it was created.
On failure, responds with SdkError<CreateSuiteDefinitionError>

pub fn delete_suite_definition(&self) -> DeleteSuiteDefinition

Constructs a fluent builder for the DeleteSuiteDefinition operation.

The fluent builder is configurable:
- suite_definition_id(impl Into<String>) / set_suite_definition_id(Option<String>):
  Suite definition ID of the test suite to be deleted.
On success, responds with DeleteSuiteDefinitionOutput
On failure, responds with SdkError<DeleteSuiteDefinitionError>

pub fn get_endpoint(&self) -> GetEndpoint

Constructs a fluent builder for the GetEndpoint operation.

The fluent builder is configurable:
- thing_arn(impl Into<String>) / set_thing_arn(Option<String>):
  The thing ARN of the device. This is an optional parameter.
- certificate_arn(impl Into<String>) / set_certificate_arn(Option<String>):
  The certificate ARN of the device. This is an optional parameter.
On success, responds with GetEndpointOutput with field(s):
- endpoint(Option<String>):
  The response of an Device Advisor endpoint.
On failure, responds with SdkError<GetEndpointError>

pub fn get_suite_definition(&self) -> GetSuiteDefinition

Constructs a fluent builder for the GetSuiteDefinition operation.

The fluent builder is configurable:
- suite_definition_id(impl Into<String>) / set_suite_definition_id(Option<String>):
  Suite definition ID of the test suite to get.
- suite_definition_version(impl Into<String>) / set_suite_definition_version(Option<String>):
  Suite definition version of the test suite to get.
On success, responds with GetSuiteDefinitionOutput with field(s):
- suite_definition_id(Option<String>):
  Suite definition ID of the suite definition.
- suite_definition_arn(Option<String>):
  The ARN of the suite definition.
- suite_definition_version(Option<String>):
  Suite definition version of the suite definition.
- latest_version(Option<String>):
  Latest suite definition version of the suite definition.
- suite_definition_configuration(Option<SuiteDefinitionConfiguration>):
  Suite configuration of the suite definition.
- created_at(Option<DateTime>):
  Date (in Unix epoch time) when the suite definition was created.
- last_modified_at(Option<DateTime>):
  Date (in Unix epoch time) when the suite definition was last modified.
- tags(Option<HashMap<String, String>>):
  Tags attached to the suite definition.
On failure, responds with SdkError<GetSuiteDefinitionError>

pub fn get_suite_run(&self) -> GetSuiteRun

Constructs a fluent builder for the GetSuiteRun operation.

The fluent builder is configurable:
- suite_definition_id(impl Into<String>) / set_suite_definition_id(Option<String>):
  Suite definition ID for the test suite run.
- suite_run_id(impl Into<String>) / set_suite_run_id(Option<String>):
  Suite run ID for the test suite run.
On success, responds with GetSuiteRunOutput with field(s):
- suite_definition_id(Option<String>):
  Suite definition ID for the test suite run.
- suite_definition_version(Option<String>):
  Suite definition version for the test suite run.
- suite_run_id(Option<String>):
  Suite run ID for the test suite run.
- suite_run_arn(Option<String>):
  The ARN of the suite run.
- suite_run_configuration(Option<SuiteRunConfiguration>):
  Suite run configuration for the test suite run.
- test_result(Option<TestResult>):
  Test results for the test suite run.
- start_time(Option<DateTime>):
  Date (in Unix epoch time) when the test suite run started.
- end_time(Option<DateTime>):
  Date (in Unix epoch time) when the test suite run ended.
- status(Option<SuiteRunStatus>):
  Status for the test suite run.
- error_reason(Option<String>):
  Error reason for any test suite run failure.
- tags(Option<HashMap<String, String>>):
  The tags attached to the suite run.
On failure, responds with SdkError<GetSuiteRunError>

pub fn get_suite_run_report(&self) -> GetSuiteRunReport

Constructs a fluent builder for the GetSuiteRunReport operation.

The fluent builder is configurable:
- suite_definition_id(impl Into<String>) / set_suite_definition_id(Option<String>):
  Suite definition ID of the test suite.
- suite_run_id(impl Into<String>) / set_suite_run_id(Option<String>):
  Suite run ID of the test suite run.
On success, responds with GetSuiteRunReportOutput with field(s):
- qualification_report_download_url(Option<String>):
  Download URL of the qualification report.
On failure, responds with SdkError<GetSuiteRunReportError>

pub fn list_suite_definitions(&self) -> ListSuiteDefinitions

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

The fluent builder is configurable:
- max_results(i32) / set_max_results(i32):
  The maximum number of results to return at once.
- next_token(impl Into<String>) / set_next_token(Option<String>):
  A token used to get the next set of results.
On success, responds with ListSuiteDefinitionsOutput with field(s):
- suite_definition_information_list(Option<Vec<SuiteDefinitionInformation>>):
  An array of objects that provide summaries of information about the suite definitions in the list.
- next_token(Option<String>):
  A token used to get the next set of results.
On failure, responds with SdkError<ListSuiteDefinitionsError>

pub fn list_suite_runs(&self) -> ListSuiteRuns

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

The fluent builder is configurable:
- suite_definition_id(impl Into<String>) / set_suite_definition_id(Option<String>):
  Lists the test suite runs of the specified test suite based on suite definition ID.
- suite_definition_version(impl Into<String>) / set_suite_definition_version(Option<String>):
  Must be passed along with suiteDefinitionId. Lists the test suite runs of the specified test suite based on suite definition version.
- max_results(i32) / set_max_results(i32):
  The maximum number of results to return at once.
- next_token(impl Into<String>) / set_next_token(Option<String>):
  A token to retrieve the next set of results.
On success, responds with ListSuiteRunsOutput with field(s):
- suite_runs_list(Option<Vec<SuiteRunInformation>>):
  An array of objects that provide summaries of information about the suite runs in the list.
- next_token(Option<String>):
  A token to retrieve the next set of results.
On failure, responds with SdkError<ListSuiteRunsError>

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 IoT Device Advisor resource.
On success, responds with ListTagsForResourceOutput with field(s):
- tags(Option<HashMap<String, String>>):
  The tags attached to the IoT Device Advisor resource.
On failure, responds with SdkError<ListTagsForResourceError>

pub fn start_suite_run(&self) -> StartSuiteRun

Constructs a fluent builder for the StartSuiteRun operation.

The fluent builder is configurable:
- suite_definition_id(impl Into<String>) / set_suite_definition_id(Option<String>):
  Suite definition ID of the test suite.
- suite_definition_version(impl Into<String>) / set_suite_definition_version(Option<String>):
  Suite definition version of the test suite.
- suite_run_configuration(SuiteRunConfiguration) / set_suite_run_configuration(Option<SuiteRunConfiguration>):
  Suite run configuration.
- tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
  The tags to be attached to the suite run.
On success, responds with StartSuiteRunOutput with field(s):
- suite_run_id(Option<String>):
  Suite Run ID of the started suite run.
- suite_run_arn(Option<String>):
  Amazon Resource Name (ARN) of the started suite run.
- created_at(Option<DateTime>):
  Starts a Device Advisor test suite run based on suite create time.
On failure, responds with SdkError<StartSuiteRunError>

pub fn stop_suite_run(&self) -> StopSuiteRun

Constructs a fluent builder for the StopSuiteRun operation.

The fluent builder is configurable:
- suite_definition_id(impl Into<String>) / set_suite_definition_id(Option<String>):
  Suite definition ID of the test suite run to be stopped.
- suite_run_id(impl Into<String>) / set_suite_run_id(Option<String>):
  Suite run ID of the test suite run to be stopped.
On success, responds with StopSuiteRunOutput
On failure, responds with SdkError<StopSuiteRunError>

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 resource ARN of an IoT Device Advisor resource.
- tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
  The tags to be attached to the IoT Device Advisor 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 resource ARN of an IoT Device Advisor resource.
- tag_keys(Vec<String>) / set_tag_keys(Option<Vec<String>>):
  List of tag keys to remove from the IoT Device Advisor resource.
On success, responds with UntagResourceOutput
On failure, responds with SdkError<UntagResourceError>

pub fn update_suite_definition(&self) -> UpdateSuiteDefinition

Constructs a fluent builder for the UpdateSuiteDefinition operation.

The fluent builder is configurable:
- suite_definition_id(impl Into<String>) / set_suite_definition_id(Option<String>):
  Suite definition ID of the test suite to be updated.
- suite_definition_configuration(SuiteDefinitionConfiguration) / set_suite_definition_configuration(Option<SuiteDefinitionConfiguration>):
  Updates a Device Advisor test suite with suite definition configuration.
On success, responds with UpdateSuiteDefinitionOutput with field(s):
- suite_definition_id(Option<String>):
  Suite definition ID of the updated test suite.
- suite_definition_arn(Option<String>):
  Amazon Resource Name (ARN) of the updated test suite.
- suite_definition_name(Option<String>):
  Suite definition name of the updated test suite.
- suite_definition_version(Option<String>):
  Suite definition version of the updated test suite.
- created_at(Option<DateTime>):
  Timestamp of when the test suite was created.
- last_updated_at(Option<DateTime>):
  Timestamp of when the test suite was updated.
On failure, responds with SdkError<UpdateSuiteDefinitionError>

impl Client

pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,

Creates a client with the given service config and connector override.

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

Creates a new client from a shared config.

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for Client

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

Formats the value using the given formatter. Read more

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

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

Performs the conversion.

Auto Trait Implementations

impl !RefUnwindSafe for Client

impl Send for Client

impl Sync for Client

impl Unpin for Client

impl !UnwindSafe for Client

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more