pub struct TestStateFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to TestState.
Accepts the definition of a single state and executes it. You can test a state without creating a state machine or updating an existing state machine. Using this API, you can test the following:
-
A state's input and output processing data flow
-
An Amazon Web Services service integration request and response
-
An HTTP Task request and response
You can call this API on only one state at a time. The states that you can test include the following:
The TestState API assumes an IAM role which must contain the required IAM permissions for the resources your state is accessing. For information about the permissions a state might need, see IAM permissions to test a state.
The TestState API can run for up to five minutes. If the execution of a state exceeds this duration, it fails with the States.Timeout error.
TestState doesn't support Activity tasks, .sync or .waitForTaskToken service integration patterns, Parallel, or Map states.
Implementations§
Source§impl TestStateFluentBuilder
impl TestStateFluentBuilder
Sourcepub fn as_input(&self) -> &TestStateInputBuilder
pub fn as_input(&self) -> &TestStateInputBuilder
Access the TestState as a reference.
Sourcepub async fn send(
self,
) -> Result<TestStateOutput, SdkError<TestStateError, HttpResponse>>
pub async fn send( self, ) -> Result<TestStateOutput, SdkError<TestStateError, 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<TestStateOutput, TestStateError, Self>
pub fn customize( self, ) -> CustomizableOperation<TestStateOutput, TestStateError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn definition(self, input: impl Into<String>) -> Self
pub fn definition(self, input: impl Into<String>) -> Self
The Amazon States Language (ASL) definition of the state.
Sourcepub fn set_definition(self, input: Option<String>) -> Self
pub fn set_definition(self, input: Option<String>) -> Self
The Amazon States Language (ASL) definition of the state.
Sourcepub fn get_definition(&self) -> &Option<String>
pub fn get_definition(&self) -> &Option<String>
The Amazon States Language (ASL) definition of the state.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.
Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.
Sourcepub fn input(self, input: impl Into<String>) -> Self
pub fn input(self, input: impl Into<String>) -> Self
A string that contains the JSON input data for the state.
Sourcepub fn set_input(self, input: Option<String>) -> Self
pub fn set_input(self, input: Option<String>) -> Self
A string that contains the JSON input data for the state.
Sourcepub fn get_input(&self) -> &Option<String>
pub fn get_input(&self) -> &Option<String>
A string that contains the JSON input data for the state.
Sourcepub fn inspection_level(self, input: InspectionLevel) -> Self
pub fn inspection_level(self, input: InspectionLevel) -> Self
Determines the values to return when a state is tested. You can specify one of the following types:
-
INFO: Shows the final state output. By default, Step Functions setsinspectionLeveltoINFOif you don't specify a level. -
DEBUG: Shows the final state output along with the input and output data processing result. -
TRACE: Shows the HTTP request and response for an HTTP Task. This level also shows the final state output along with the input and output data processing result.
Each of these levels also provide information about the status of the state execution and the next state to transition to.
Sourcepub fn set_inspection_level(self, input: Option<InspectionLevel>) -> Self
pub fn set_inspection_level(self, input: Option<InspectionLevel>) -> Self
Determines the values to return when a state is tested. You can specify one of the following types:
-
INFO: Shows the final state output. By default, Step Functions setsinspectionLeveltoINFOif you don't specify a level. -
DEBUG: Shows the final state output along with the input and output data processing result. -
TRACE: Shows the HTTP request and response for an HTTP Task. This level also shows the final state output along with the input and output data processing result.
Each of these levels also provide information about the status of the state execution and the next state to transition to.
Sourcepub fn get_inspection_level(&self) -> &Option<InspectionLevel>
pub fn get_inspection_level(&self) -> &Option<InspectionLevel>
Determines the values to return when a state is tested. You can specify one of the following types:
-
INFO: Shows the final state output. By default, Step Functions setsinspectionLeveltoINFOif you don't specify a level. -
DEBUG: Shows the final state output along with the input and output data processing result. -
TRACE: Shows the HTTP request and response for an HTTP Task. This level also shows the final state output along with the input and output data processing result.
Each of these levels also provide information about the status of the state execution and the next state to transition to.
Sourcepub fn reveal_secrets(self, input: bool) -> Self
pub fn reveal_secrets(self, input: bool) -> Self
Specifies whether or not to include secret information in the test result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to modify the HTTP request headers, query parameters, and body. Step Functions doesn't omit any information included in the state definition or the HTTP response.
If you set revealSecrets to true, you must make sure that the IAM user that calls the TestState API has permission for the states:RevealSecrets action. For an example of IAM policy that sets the states:RevealSecrets permission, see IAM permissions to test a state. Without this permission, Step Functions throws an access denied error.
By default, revealSecrets is set to false.
Sourcepub fn set_reveal_secrets(self, input: Option<bool>) -> Self
pub fn set_reveal_secrets(self, input: Option<bool>) -> Self
Specifies whether or not to include secret information in the test result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to modify the HTTP request headers, query parameters, and body. Step Functions doesn't omit any information included in the state definition or the HTTP response.
If you set revealSecrets to true, you must make sure that the IAM user that calls the TestState API has permission for the states:RevealSecrets action. For an example of IAM policy that sets the states:RevealSecrets permission, see IAM permissions to test a state. Without this permission, Step Functions throws an access denied error.
By default, revealSecrets is set to false.
Sourcepub fn get_reveal_secrets(&self) -> &Option<bool>
pub fn get_reveal_secrets(&self) -> &Option<bool>
Specifies whether or not to include secret information in the test result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to modify the HTTP request headers, query parameters, and body. Step Functions doesn't omit any information included in the state definition or the HTTP response.
If you set revealSecrets to true, you must make sure that the IAM user that calls the TestState API has permission for the states:RevealSecrets action. For an example of IAM policy that sets the states:RevealSecrets permission, see IAM permissions to test a state. Without this permission, Step Functions throws an access denied error.
By default, revealSecrets is set to false.
Sourcepub fn variables(self, input: impl Into<String>) -> Self
pub fn variables(self, input: impl Into<String>) -> Self
JSON object literal that sets variables used in the state under test. Object keys are the variable names and values are the variable values.
Sourcepub fn set_variables(self, input: Option<String>) -> Self
pub fn set_variables(self, input: Option<String>) -> Self
JSON object literal that sets variables used in the state under test. Object keys are the variable names and values are the variable values.
Sourcepub fn get_variables(&self) -> &Option<String>
pub fn get_variables(&self) -> &Option<String>
JSON object literal that sets variables used in the state under test. Object keys are the variable names and values are the variable values.
Trait Implementations§
Source§impl Clone for TestStateFluentBuilder
impl Clone for TestStateFluentBuilder
Source§fn clone(&self) -> TestStateFluentBuilder
fn clone(&self) -> TestStateFluentBuilder
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 TestStateFluentBuilder
impl !RefUnwindSafe for TestStateFluentBuilder
impl Send for TestStateFluentBuilder
impl Sync for TestStateFluentBuilder
impl Unpin for TestStateFluentBuilder
impl !UnwindSafe for TestStateFluentBuilder
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);