Struct aws_sdk_iot::operation::list_things::builders::ListThingsFluentBuilder
source · pub struct ListThingsFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to ListThings
.
Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings
with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red. For more information, see List Things from the Amazon Web Services IoT Core Developer Guide.
Requires permission to access the ListThings action.
You will not be charged for calling this API if an Access denied
error is returned. You will also not be charged if no attributes or pagination token was provided in request and no pagination token and no results were returned.
Implementations§
source§impl ListThingsFluentBuilder
impl ListThingsFluentBuilder
sourcepub fn as_input(&self) -> &ListThingsInputBuilder
pub fn as_input(&self) -> &ListThingsInputBuilder
Access the ListThings as a reference.
sourcepub async fn send(
self
) -> Result<ListThingsOutput, SdkError<ListThingsError, HttpResponse>>
pub async fn send( self ) -> Result<ListThingsOutput, SdkError<ListThingsError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self
) -> CustomizableOperation<ListThingsOutput, ListThingsError, Self>
pub fn customize( self ) -> CustomizableOperation<ListThingsOutput, ListThingsError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn into_paginator(self) -> ListThingsPaginator
pub fn into_paginator(self) -> ListThingsPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a PaginationStream
.
sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
To retrieve the next set of results, the nextToken
value from a previous response; otherwise null to receive the first set of results.
sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
The maximum number of results to return in this operation.
sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
The maximum number of results to return in this operation.
sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_max_results(&self) -> &Option<i32>
The maximum number of results to return in this operation.
sourcepub fn attribute_name(self, input: impl Into<String>) -> Self
pub fn attribute_name(self, input: impl Into<String>) -> Self
The attribute name used to search for things.
sourcepub fn set_attribute_name(self, input: Option<String>) -> Self
pub fn set_attribute_name(self, input: Option<String>) -> Self
The attribute name used to search for things.
sourcepub fn get_attribute_name(&self) -> &Option<String>
pub fn get_attribute_name(&self) -> &Option<String>
The attribute name used to search for things.
sourcepub fn attribute_value(self, input: impl Into<String>) -> Self
pub fn attribute_value(self, input: impl Into<String>) -> Self
The attribute value used to search for things.
sourcepub fn set_attribute_value(self, input: Option<String>) -> Self
pub fn set_attribute_value(self, input: Option<String>) -> Self
The attribute value used to search for things.
sourcepub fn get_attribute_value(&self) -> &Option<String>
pub fn get_attribute_value(&self) -> &Option<String>
The attribute value used to search for things.
sourcepub fn thing_type_name(self, input: impl Into<String>) -> Self
pub fn thing_type_name(self, input: impl Into<String>) -> Self
The name of the thing type used to search for things.
sourcepub fn set_thing_type_name(self, input: Option<String>) -> Self
pub fn set_thing_type_name(self, input: Option<String>) -> Self
The name of the thing type used to search for things.
sourcepub fn get_thing_type_name(&self) -> &Option<String>
pub fn get_thing_type_name(&self) -> &Option<String>
The name of the thing type used to search for things.
sourcepub fn use_prefix_attribute_value(self, input: bool) -> Self
pub fn use_prefix_attribute_value(self, input: bool) -> Self
When true
, the action returns the thing resources with attribute values that start with the attributeValue
provided.
When false
, or not present, the action returns only the thing resources with attribute values that match the entire attributeValue
provided.
sourcepub fn set_use_prefix_attribute_value(self, input: Option<bool>) -> Self
pub fn set_use_prefix_attribute_value(self, input: Option<bool>) -> Self
When true
, the action returns the thing resources with attribute values that start with the attributeValue
provided.
When false
, or not present, the action returns only the thing resources with attribute values that match the entire attributeValue
provided.
sourcepub fn get_use_prefix_attribute_value(&self) -> &Option<bool>
pub fn get_use_prefix_attribute_value(&self) -> &Option<bool>
When true
, the action returns the thing resources with attribute values that start with the attributeValue
provided.
When false
, or not present, the action returns only the thing resources with attribute values that match the entire attributeValue
provided.
Trait Implementations§
source§impl Clone for ListThingsFluentBuilder
impl Clone for ListThingsFluentBuilder
source§fn clone(&self) -> ListThingsFluentBuilder
fn clone(&self) -> ListThingsFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more