pub struct TestAuthorizationFluentBuilder { /* private fields */ }Expand description
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§
Source§impl TestAuthorizationFluentBuilder
impl TestAuthorizationFluentBuilder
Sourcepub fn as_input(&self) -> &TestAuthorizationInputBuilder
pub fn as_input(&self) -> &TestAuthorizationInputBuilder
Access the TestAuthorization as a reference.
Sourcepub async fn send(
self,
) -> Result<TestAuthorizationOutput, SdkError<TestAuthorizationError, HttpResponse>>
pub async fn send( self, ) -> Result<TestAuthorizationOutput, SdkError<TestAuthorizationError, 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<TestAuthorizationOutput, TestAuthorizationError, Self>
pub fn customize( self, ) -> CustomizableOperation<TestAuthorizationOutput, TestAuthorizationError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn principal(self, input: impl Into<String>) -> Self
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).
Sourcepub fn set_principal(self, input: Option<String>) -> Self
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).
Sourcepub fn get_principal(&self) -> &Option<String>
pub fn get_principal(&self) -> &Option<String>
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).
Sourcepub fn cognito_identity_pool_id(self, input: impl Into<String>) -> Self
pub fn cognito_identity_pool_id(self, input: impl Into<String>) -> Self
The Cognito identity pool ID.
Sourcepub fn set_cognito_identity_pool_id(self, input: Option<String>) -> Self
pub fn set_cognito_identity_pool_id(self, input: Option<String>) -> Self
The Cognito identity pool ID.
Sourcepub fn get_cognito_identity_pool_id(&self) -> &Option<String>
pub fn get_cognito_identity_pool_id(&self) -> &Option<String>
The Cognito identity pool ID.
Sourcepub fn auth_infos(self, input: AuthInfo) -> Self
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.
Sourcepub fn set_auth_infos(self, input: Option<Vec<AuthInfo>>) -> Self
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.
Sourcepub fn get_auth_infos(&self) -> &Option<Vec<AuthInfo>>
pub fn get_auth_infos(&self) -> &Option<Vec<AuthInfo>>
A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.
Sourcepub fn set_client_id(self, input: Option<String>) -> Self
pub fn set_client_id(self, input: Option<String>) -> Self
The MQTT client ID.
Sourcepub fn get_client_id(&self) -> &Option<String>
pub fn get_client_id(&self) -> &Option<String>
The MQTT client ID.
Sourcepub fn policy_names_to_add(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_policy_names_to_add(self, input: Option<Vec<String>>) -> Self
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.
Sourcepub fn get_policy_names_to_add(&self) -> &Option<Vec<String>>
pub fn get_policy_names_to_add(&self) -> &Option<Vec<String>>
When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
Sourcepub fn policy_names_to_skip(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_policy_names_to_skip(self, input: Option<Vec<String>>) -> Self
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.
Sourcepub fn get_policy_names_to_skip(&self) -> &Option<Vec<String>>
pub fn get_policy_names_to_skip(&self) -> &Option<Vec<String>>
When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
Trait Implementations§
Source§impl Clone for TestAuthorizationFluentBuilder
impl Clone for TestAuthorizationFluentBuilder
Source§fn clone(&self) -> TestAuthorizationFluentBuilder
fn clone(&self) -> TestAuthorizationFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for TestAuthorizationFluentBuilder
impl !RefUnwindSafe for TestAuthorizationFluentBuilder
impl Send for TestAuthorizationFluentBuilder
impl Sync for TestAuthorizationFluentBuilder
impl Unpin for TestAuthorizationFluentBuilder
impl !UnwindSafe for TestAuthorizationFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);