aws_sdk_iot/client/

list_thing_principals_v2.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListThingPrincipalsV2`](crate::operation::list_thing_principals_v2::builders::ListThingPrincipalsV2FluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_thing_principals_v2::builders::ListThingPrincipalsV2FluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_thing_principals_v2::builders::ListThingPrincipalsV2FluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_thing_principals_v2::builders::ListThingPrincipalsV2FluentBuilder::set_next_token):<br>required: **false**<br><p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <b>null</b> to receive the first set of results.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_thing_principals_v2::builders::ListThingPrincipalsV2FluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_thing_principals_v2::builders::ListThingPrincipalsV2FluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in this operation.</p><br>
    ///   - [`thing_name(impl Into<String>)`](crate::operation::list_thing_principals_v2::builders::ListThingPrincipalsV2FluentBuilder::thing_name) / [`set_thing_name(Option<String>)`](crate::operation::list_thing_principals_v2::builders::ListThingPrincipalsV2FluentBuilder::set_thing_name):<br>required: **true**<br><p>The name of the thing.</p><br>
    ///   - [`thing_principal_type(ThingPrincipalType)`](crate::operation::list_thing_principals_v2::builders::ListThingPrincipalsV2FluentBuilder::thing_principal_type) / [`set_thing_principal_type(Option<ThingPrincipalType>)`](crate::operation::list_thing_principals_v2::builders::ListThingPrincipalsV2FluentBuilder::set_thing_principal_type):<br>required: **false**<br><p>The type of the relation you want to filter in the response. If no value is provided in this field, the response will list all principals, including both the <code>EXCLUSIVE_THING</code> and <code>NON_EXCLUSIVE_THING</code> attachment types.</p> <ul>  <li>   <p><code>EXCLUSIVE_THING</code> - Attaches the specified principal to the specified thing, exclusively. The thing will be the only thing that’s attached to the principal.</p></li> </ul> <ul>  <li>   <p><code>NON_EXCLUSIVE_THING</code> - Attaches the specified principal to the specified thing. Multiple things can be attached to the principal.</p></li> </ul><br>
    /// - On success, responds with [`ListThingPrincipalsV2Output`](crate::operation::list_thing_principals_v2::ListThingPrincipalsV2Output) with field(s):
    ///   - [`thing_principal_objects(Option<Vec::<ThingPrincipalObject>>)`](crate::operation::list_thing_principals_v2::ListThingPrincipalsV2Output::thing_principal_objects): <p>A list of <code>thingPrincipalObject</code> that represents the principal and the type of relation it has with the thing.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_thing_principals_v2::ListThingPrincipalsV2Output::next_token): <p>The token to use to get the next set of results, or <b>null</b> if there are no additional results.</p>
    /// - On failure, responds with [`SdkError<ListThingPrincipalsV2Error>`](crate::operation::list_thing_principals_v2::ListThingPrincipalsV2Error)
    pub fn list_thing_principals_v2(&self) -> crate::operation::list_thing_principals_v2::builders::ListThingPrincipalsV2FluentBuilder {
        crate::operation::list_thing_principals_v2::builders::ListThingPrincipalsV2FluentBuilder::new(self.handle.clone())
    }
}