Struct aws_sdk_iot::client::fluent_builders::TestAuthorization

pub struct TestAuthorization<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to TestAuthorization.

Tests if a specified principal is authorized to perform an IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the IoT device gateway.

Requires permission to access the TestAuthorization action.

Implementations

impl<C, M, R> TestAuthorization<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<TestAuthorizationOutput, SdkError<TestAuthorizationError>> where
    R::Policy: SmithyRetryPolicy<TestAuthorizationInputOperationOutputAlias, TestAuthorizationOutput, TestAuthorizationError, TestAuthorizationInputOperationRetryAlias>, 

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.

pub fn principal(self, input: impl Into<String>) -> Self

The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

pub fn set_principal(self, input: Option<String>) -> Self

The principal. Valid principals are CertificateArn (arn:aws:iot:region:accountId:cert/certificateId), thingGroupArn (arn:aws:iot:region:accountId:thinggroup/groupName) and CognitoId (region:id).

pub fn cognito_identity_pool_id(self, input: impl Into<String>) -> Self

The Cognito identity pool ID.

pub fn set_cognito_identity_pool_id(self, input: Option<String>) -> Self

The Cognito identity pool ID.

pub fn auth_infos(self, input: AuthInfo) -> Self

Appends an item to authInfos.

To override the contents of this collection use set_auth_infos.

A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.

pub fn set_auth_infos(self, input: Option<Vec<AuthInfo>>) -> Self

A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.

pub fn client_id(self, input: impl Into<String>) -> Self

The MQTT client ID.

pub fn set_client_id(self, input: Option<String>) -> Self

The MQTT client ID.

pub fn policy_names_to_add(self, input: impl Into<String>) -> Self

Appends an item to policyNamesToAdd.

To override the contents of this collection use set_policy_names_to_add.

When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.

pub fn set_policy_names_to_add(self, input: Option<Vec<String>>) -> Self

When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.

pub fn policy_names_to_skip(self, input: impl Into<String>) -> Self

Appends an item to policyNamesToSkip.

To override the contents of this collection use set_policy_names_to_skip.

When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.

pub fn set_policy_names_to_skip(self, input: Option<Vec<String>>) -> Self

When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for TestAuthorization<C, M, R>

fn clone(&self) -> TestAuthorization<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for TestAuthorization<C, M, R>

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

Formats the value using the given formatter.