AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | List of all members
Aws::SFN::Model::DescribeStateMachineResult Class Reference

#include <DescribeStateMachineResult.h>

Public Member Functions

 DescribeStateMachineResult ()
 
 DescribeStateMachineResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
DescribeStateMachineResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetStateMachineArn () const
 
void SetStateMachineArn (const Aws::String &value)
 
void SetStateMachineArn (Aws::String &&value)
 
void SetStateMachineArn (const char *value)
 
DescribeStateMachineResultWithStateMachineArn (const Aws::String &value)
 
DescribeStateMachineResultWithStateMachineArn (Aws::String &&value)
 
DescribeStateMachineResultWithStateMachineArn (const char *value)
 
const Aws::StringGetName () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
DescribeStateMachineResultWithName (const Aws::String &value)
 
DescribeStateMachineResultWithName (Aws::String &&value)
 
DescribeStateMachineResultWithName (const char *value)
 
const StateMachineStatusGetStatus () const
 
void SetStatus (const StateMachineStatus &value)
 
void SetStatus (StateMachineStatus &&value)
 
DescribeStateMachineResultWithStatus (const StateMachineStatus &value)
 
DescribeStateMachineResultWithStatus (StateMachineStatus &&value)
 
const Aws::StringGetDefinition () const
 
void SetDefinition (const Aws::String &value)
 
void SetDefinition (Aws::String &&value)
 
void SetDefinition (const char *value)
 
DescribeStateMachineResultWithDefinition (const Aws::String &value)
 
DescribeStateMachineResultWithDefinition (Aws::String &&value)
 
DescribeStateMachineResultWithDefinition (const char *value)
 
const Aws::StringGetRoleArn () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
DescribeStateMachineResultWithRoleArn (const Aws::String &value)
 
DescribeStateMachineResultWithRoleArn (Aws::String &&value)
 
DescribeStateMachineResultWithRoleArn (const char *value)
 
const StateMachineTypeGetType () const
 
void SetType (const StateMachineType &value)
 
void SetType (StateMachineType &&value)
 
DescribeStateMachineResultWithType (const StateMachineType &value)
 
DescribeStateMachineResultWithType (StateMachineType &&value)
 
const Aws::Utils::DateTimeGetCreationDate () const
 
void SetCreationDate (const Aws::Utils::DateTime &value)
 
void SetCreationDate (Aws::Utils::DateTime &&value)
 
DescribeStateMachineResultWithCreationDate (const Aws::Utils::DateTime &value)
 
DescribeStateMachineResultWithCreationDate (Aws::Utils::DateTime &&value)
 
const LoggingConfigurationGetLoggingConfiguration () const
 
void SetLoggingConfiguration (const LoggingConfiguration &value)
 
void SetLoggingConfiguration (LoggingConfiguration &&value)
 
DescribeStateMachineResultWithLoggingConfiguration (const LoggingConfiguration &value)
 
DescribeStateMachineResultWithLoggingConfiguration (LoggingConfiguration &&value)
 
const TracingConfigurationGetTracingConfiguration () const
 
void SetTracingConfiguration (const TracingConfiguration &value)
 
void SetTracingConfiguration (TracingConfiguration &&value)
 
DescribeStateMachineResultWithTracingConfiguration (const TracingConfiguration &value)
 
DescribeStateMachineResultWithTracingConfiguration (TracingConfiguration &&value)
 

Detailed Description

Definition at line 32 of file DescribeStateMachineResult.h.

Constructor & Destructor Documentation

◆ DescribeStateMachineResult() [1/2]

Aws::SFN::Model::DescribeStateMachineResult::DescribeStateMachineResult ( )

◆ DescribeStateMachineResult() [2/2]

Aws::SFN::Model::DescribeStateMachineResult::DescribeStateMachineResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ GetCreationDate()

const Aws::Utils::DateTime& Aws::SFN::Model::DescribeStateMachineResult::GetCreationDate ( ) const
inline

The date the state machine is created.

Definition at line 314 of file DescribeStateMachineResult.h.

◆ GetDefinition()

const Aws::String& Aws::SFN::Model::DescribeStateMachineResult::GetDefinition ( ) const
inline

The Amazon States Language definition of the state machine. See Amazon States Language.

Definition at line 185 of file DescribeStateMachineResult.h.

◆ GetLoggingConfiguration()

const LoggingConfiguration& Aws::SFN::Model::DescribeStateMachineResult::GetLoggingConfiguration ( ) const
inline

Definition at line 338 of file DescribeStateMachineResult.h.

◆ GetName()

const Aws::String& Aws::SFN::Model::DescribeStateMachineResult::GetName ( ) const
inline

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 _.

Definition at line 85 of file DescribeStateMachineResult.h.

◆ GetRoleArn()

const Aws::String& Aws::SFN::Model::DescribeStateMachineResult::GetRoleArn ( ) const
inline

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 AWS resources.)

Definition at line 235 of file DescribeStateMachineResult.h.

◆ GetStateMachineArn()

const Aws::String& Aws::SFN::Model::DescribeStateMachineResult::GetStateMachineArn ( ) const
inline

The Amazon Resource Name (ARN) that identifies the state machine.

Definition at line 43 of file DescribeStateMachineResult.h.

◆ GetStatus()

const StateMachineStatus& Aws::SFN::Model::DescribeStateMachineResult::GetStatus ( ) const
inline

The current status of the state machine.

Definition at line 157 of file DescribeStateMachineResult.h.

◆ GetTracingConfiguration()

const TracingConfiguration& Aws::SFN::Model::DescribeStateMachineResult::GetTracingConfiguration ( ) const
inline

Selects whether AWS X-Ray tracing is enabled.

Definition at line 356 of file DescribeStateMachineResult.h.

◆ GetType()

const StateMachineType& Aws::SFN::Model::DescribeStateMachineResult::GetType ( ) const
inline

The type of the state machine (STANDARD or EXPRESS).

Definition at line 284 of file DescribeStateMachineResult.h.

◆ operator=()

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetCreationDate() [1/2]

void Aws::SFN::Model::DescribeStateMachineResult::SetCreationDate ( Aws::Utils::DateTime &&  value)
inline

The date the state machine is created.

Definition at line 324 of file DescribeStateMachineResult.h.

◆ SetCreationDate() [2/2]

void Aws::SFN::Model::DescribeStateMachineResult::SetCreationDate ( const Aws::Utils::DateTime value)
inline

The date the state machine is created.

Definition at line 319 of file DescribeStateMachineResult.h.

◆ SetDefinition() [1/3]

void Aws::SFN::Model::DescribeStateMachineResult::SetDefinition ( Aws::String &&  value)
inline

The Amazon States Language definition of the state machine. See Amazon States Language.

Definition at line 199 of file DescribeStateMachineResult.h.

◆ SetDefinition() [2/3]

void Aws::SFN::Model::DescribeStateMachineResult::SetDefinition ( const Aws::String value)
inline

The Amazon States Language definition of the state machine. See Amazon States Language.

Definition at line 192 of file DescribeStateMachineResult.h.

◆ SetDefinition() [3/3]

void Aws::SFN::Model::DescribeStateMachineResult::SetDefinition ( const char *  value)
inline

The Amazon States Language definition of the state machine. See Amazon States Language.

Definition at line 206 of file DescribeStateMachineResult.h.

◆ SetLoggingConfiguration() [1/2]

void Aws::SFN::Model::DescribeStateMachineResult::SetLoggingConfiguration ( const LoggingConfiguration value)
inline

Definition at line 341 of file DescribeStateMachineResult.h.

◆ SetLoggingConfiguration() [2/2]

void Aws::SFN::Model::DescribeStateMachineResult::SetLoggingConfiguration ( LoggingConfiguration &&  value)
inline

Definition at line 344 of file DescribeStateMachineResult.h.

◆ SetName() [1/3]

void Aws::SFN::Model::DescribeStateMachineResult::SetName ( Aws::String &&  value)
inline

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 _.

Definition at line 107 of file DescribeStateMachineResult.h.

◆ SetName() [2/3]

void Aws::SFN::Model::DescribeStateMachineResult::SetName ( const Aws::String value)
inline

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 _.

Definition at line 96 of file DescribeStateMachineResult.h.

◆ SetName() [3/3]

void Aws::SFN::Model::DescribeStateMachineResult::SetName ( const char *  value)
inline

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 _.

Definition at line 118 of file DescribeStateMachineResult.h.

◆ SetRoleArn() [1/3]

void Aws::SFN::Model::DescribeStateMachineResult::SetRoleArn ( Aws::String &&  value)
inline

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 AWS resources.)

Definition at line 249 of file DescribeStateMachineResult.h.

◆ SetRoleArn() [2/3]

void Aws::SFN::Model::DescribeStateMachineResult::SetRoleArn ( const Aws::String value)
inline

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 AWS resources.)

Definition at line 242 of file DescribeStateMachineResult.h.

◆ SetRoleArn() [3/3]

void Aws::SFN::Model::DescribeStateMachineResult::SetRoleArn ( const char *  value)
inline

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 AWS resources.)

Definition at line 256 of file DescribeStateMachineResult.h.

◆ SetStateMachineArn() [1/3]

void Aws::SFN::Model::DescribeStateMachineResult::SetStateMachineArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) that identifies the state machine.

Definition at line 53 of file DescribeStateMachineResult.h.

◆ SetStateMachineArn() [2/3]

void Aws::SFN::Model::DescribeStateMachineResult::SetStateMachineArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) that identifies the state machine.

Definition at line 48 of file DescribeStateMachineResult.h.

◆ SetStateMachineArn() [3/3]

void Aws::SFN::Model::DescribeStateMachineResult::SetStateMachineArn ( const char *  value)
inline

The Amazon Resource Name (ARN) that identifies the state machine.

Definition at line 58 of file DescribeStateMachineResult.h.

◆ SetStatus() [1/2]

void Aws::SFN::Model::DescribeStateMachineResult::SetStatus ( const StateMachineStatus value)
inline

The current status of the state machine.

Definition at line 162 of file DescribeStateMachineResult.h.

◆ SetStatus() [2/2]

void Aws::SFN::Model::DescribeStateMachineResult::SetStatus ( StateMachineStatus &&  value)
inline

The current status of the state machine.

Definition at line 167 of file DescribeStateMachineResult.h.

◆ SetTracingConfiguration() [1/2]

void Aws::SFN::Model::DescribeStateMachineResult::SetTracingConfiguration ( const TracingConfiguration value)
inline

Selects whether AWS X-Ray tracing is enabled.

Definition at line 361 of file DescribeStateMachineResult.h.

◆ SetTracingConfiguration() [2/2]

void Aws::SFN::Model::DescribeStateMachineResult::SetTracingConfiguration ( TracingConfiguration &&  value)
inline

Selects whether AWS X-Ray tracing is enabled.

Definition at line 366 of file DescribeStateMachineResult.h.

◆ SetType() [1/2]

void Aws::SFN::Model::DescribeStateMachineResult::SetType ( const StateMachineType value)
inline

The type of the state machine (STANDARD or EXPRESS).

Definition at line 290 of file DescribeStateMachineResult.h.

◆ SetType() [2/2]

void Aws::SFN::Model::DescribeStateMachineResult::SetType ( StateMachineType &&  value)
inline

The type of the state machine (STANDARD or EXPRESS).

Definition at line 296 of file DescribeStateMachineResult.h.

◆ WithCreationDate() [1/2]

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::WithCreationDate ( Aws::Utils::DateTime &&  value)
inline

The date the state machine is created.

Definition at line 334 of file DescribeStateMachineResult.h.

◆ WithCreationDate() [2/2]

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::WithCreationDate ( const Aws::Utils::DateTime value)
inline

The date the state machine is created.

Definition at line 329 of file DescribeStateMachineResult.h.

◆ WithDefinition() [1/3]

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::WithDefinition ( Aws::String &&  value)
inline

The Amazon States Language definition of the state machine. See Amazon States Language.

Definition at line 220 of file DescribeStateMachineResult.h.

◆ WithDefinition() [2/3]

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::WithDefinition ( const Aws::String value)
inline

The Amazon States Language definition of the state machine. See Amazon States Language.

Definition at line 213 of file DescribeStateMachineResult.h.

◆ WithDefinition() [3/3]

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::WithDefinition ( const char *  value)
inline

The Amazon States Language definition of the state machine. See Amazon States Language.

Definition at line 227 of file DescribeStateMachineResult.h.

◆ WithLoggingConfiguration() [1/2]

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::WithLoggingConfiguration ( const LoggingConfiguration value)
inline

Definition at line 347 of file DescribeStateMachineResult.h.

◆ WithLoggingConfiguration() [2/2]

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::WithLoggingConfiguration ( LoggingConfiguration &&  value)
inline

Definition at line 350 of file DescribeStateMachineResult.h.

◆ WithName() [1/3]

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::WithName ( Aws::String &&  value)
inline

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 _.

Definition at line 140 of file DescribeStateMachineResult.h.

◆ WithName() [2/3]

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::WithName ( const Aws::String value)
inline

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 _.

Definition at line 129 of file DescribeStateMachineResult.h.

◆ WithName() [3/3]

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::WithName ( const char *  value)
inline

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 _.

Definition at line 151 of file DescribeStateMachineResult.h.

◆ WithRoleArn() [1/3]

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::WithRoleArn ( Aws::String &&  value)
inline

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 AWS resources.)

Definition at line 270 of file DescribeStateMachineResult.h.

◆ WithRoleArn() [2/3]

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::WithRoleArn ( const Aws::String value)
inline

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 AWS resources.)

Definition at line 263 of file DescribeStateMachineResult.h.

◆ WithRoleArn() [3/3]

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::WithRoleArn ( const char *  value)
inline

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 AWS resources.)

Definition at line 277 of file DescribeStateMachineResult.h.

◆ WithStateMachineArn() [1/3]

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::WithStateMachineArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) that identifies the state machine.

Definition at line 68 of file DescribeStateMachineResult.h.

◆ WithStateMachineArn() [2/3]

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::WithStateMachineArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) that identifies the state machine.

Definition at line 63 of file DescribeStateMachineResult.h.

◆ WithStateMachineArn() [3/3]

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::WithStateMachineArn ( const char *  value)
inline

The Amazon Resource Name (ARN) that identifies the state machine.

Definition at line 73 of file DescribeStateMachineResult.h.

◆ WithStatus() [1/2]

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::WithStatus ( const StateMachineStatus value)
inline

The current status of the state machine.

Definition at line 172 of file DescribeStateMachineResult.h.

◆ WithStatus() [2/2]

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::WithStatus ( StateMachineStatus &&  value)
inline

The current status of the state machine.

Definition at line 177 of file DescribeStateMachineResult.h.

◆ WithTracingConfiguration() [1/2]

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::WithTracingConfiguration ( const TracingConfiguration value)
inline

Selects whether AWS X-Ray tracing is enabled.

Definition at line 371 of file DescribeStateMachineResult.h.

◆ WithTracingConfiguration() [2/2]

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::WithTracingConfiguration ( TracingConfiguration &&  value)
inline

Selects whether AWS X-Ray tracing is enabled.

Definition at line 376 of file DescribeStateMachineResult.h.

◆ WithType() [1/2]

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::WithType ( const StateMachineType value)
inline

The type of the state machine (STANDARD or EXPRESS).

Definition at line 302 of file DescribeStateMachineResult.h.

◆ WithType() [2/2]

DescribeStateMachineResult& Aws::SFN::Model::DescribeStateMachineResult::WithType ( StateMachineType &&  value)
inline

The type of the state machine (STANDARD or EXPRESS).

Definition at line 308 of file DescribeStateMachineResult.h.


The documentation for this class was generated from the following file: