#[non_exhaustive]pub struct DescribeStateMachineOutput {
pub state_machine_arn: String,
pub name: String,
pub status: Option<StateMachineStatus>,
pub definition: String,
pub role_arn: String,
pub type: StateMachineType,
pub creation_date: DateTime,
pub logging_configuration: Option<LoggingConfiguration>,
pub tracing_configuration: Option<TracingConfiguration>,
pub label: Option<String>,
pub revision_id: Option<String>,
pub description: Option<String>,
/* private fields */
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.state_machine_arn: String
The Amazon Resource Name (ARN) that identifies the state machine.
If you specified a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1
.
name: String
The name of the state machine.
A name must not contain:
-
white space
-
brackets
< > { } [ ]
-
wildcard characters
? *
-
special characters
" # % \ ^ | ~ ` $ & , ; : /
-
control characters (
U+0000-001F
,U+007F-009F
)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
status: Option<StateMachineStatus>
The current status of the state machine.
definition: String
The Amazon States Language definition of the state machine. See Amazon States Language.
role_arn: String
The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to Amazon Web Services resources.)
type: StateMachineType
The type
of the state machine (STANDARD
or EXPRESS
).
creation_date: DateTime
The date the state machine is created.
For a state machine version, creationDate
is the date the version was created.
logging_configuration: Option<LoggingConfiguration>
The LoggingConfiguration
data type is used to set CloudWatch Logs options.
tracing_configuration: Option<TracingConfiguration>
Selects whether X-Ray tracing is enabled.
label: Option<String>
A user-defined or an auto-generated string that identifies a Map
state. This parameter is present only if the stateMachineArn
specified in input is a qualified state machine ARN.
revision_id: Option<String>
The revision identifier for the state machine.
Use the revisionId
parameter to compare between versions of a state machine configuration used for executions without performing a diff of the properties, such as definition
and roleArn
.
description: Option<String>
The description of the state machine version.
Implementations§
source§impl DescribeStateMachineOutput
impl DescribeStateMachineOutput
sourcepub fn state_machine_arn(&self) -> &str
pub fn state_machine_arn(&self) -> &str
The Amazon Resource Name (ARN) that identifies the state machine.
If you specified a state machine version ARN in your request, the API returns the version ARN. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, stateMachineARN:1
.
sourcepub fn name(&self) -> &str
pub fn name(&self) -> &str
The name of the state machine.
A name must not contain:
-
white space
-
brackets
< > { } [ ]
-
wildcard characters
? *
-
special characters
" # % \ ^ | ~ ` $ & , ; : /
-
control characters (
U+0000-001F
,U+007F-009F
)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
sourcepub fn status(&self) -> Option<&StateMachineStatus>
pub fn status(&self) -> Option<&StateMachineStatus>
The current status of the state machine.
sourcepub fn definition(&self) -> &str
pub fn definition(&self) -> &str
The Amazon States Language definition of the state machine. See Amazon States Language.
sourcepub fn role_arn(&self) -> &str
pub fn role_arn(&self) -> &str
The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to Amazon Web Services resources.)
sourcepub fn type(&self) -> &StateMachineType
pub fn type(&self) -> &StateMachineType
The type
of the state machine (STANDARD
or EXPRESS
).
sourcepub fn creation_date(&self) -> &DateTime
pub fn creation_date(&self) -> &DateTime
The date the state machine is created.
For a state machine version, creationDate
is the date the version was created.
sourcepub fn logging_configuration(&self) -> Option<&LoggingConfiguration>
pub fn logging_configuration(&self) -> Option<&LoggingConfiguration>
The LoggingConfiguration
data type is used to set CloudWatch Logs options.
sourcepub fn tracing_configuration(&self) -> Option<&TracingConfiguration>
pub fn tracing_configuration(&self) -> Option<&TracingConfiguration>
Selects whether X-Ray tracing is enabled.
sourcepub fn label(&self) -> Option<&str>
pub fn label(&self) -> Option<&str>
A user-defined or an auto-generated string that identifies a Map
state. This parameter is present only if the stateMachineArn
specified in input is a qualified state machine ARN.
sourcepub fn revision_id(&self) -> Option<&str>
pub fn revision_id(&self) -> Option<&str>
The revision identifier for the state machine.
Use the revisionId
parameter to compare between versions of a state machine configuration used for executions without performing a diff of the properties, such as definition
and roleArn
.
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
The description of the state machine version.
source§impl DescribeStateMachineOutput
impl DescribeStateMachineOutput
sourcepub fn builder() -> DescribeStateMachineOutputBuilder
pub fn builder() -> DescribeStateMachineOutputBuilder
Creates a new builder-style object to manufacture DescribeStateMachineOutput
.
Trait Implementations§
source§impl Clone for DescribeStateMachineOutput
impl Clone for DescribeStateMachineOutput
source§fn clone(&self) -> DescribeStateMachineOutput
fn clone(&self) -> DescribeStateMachineOutput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for DescribeStateMachineOutput
impl Debug for DescribeStateMachineOutput
source§impl PartialEq for DescribeStateMachineOutput
impl PartialEq for DescribeStateMachineOutput
source§fn eq(&self, other: &DescribeStateMachineOutput) -> bool
fn eq(&self, other: &DescribeStateMachineOutput) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl RequestId for DescribeStateMachineOutput
impl RequestId for DescribeStateMachineOutput
source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for DescribeStateMachineOutput
Auto Trait Implementations§
impl Freeze for DescribeStateMachineOutput
impl RefUnwindSafe for DescribeStateMachineOutput
impl Send for DescribeStateMachineOutput
impl Sync for DescribeStateMachineOutput
impl Unpin for DescribeStateMachineOutput
impl UnwindSafe for DescribeStateMachineOutput
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> 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 more