Class: Aws::States::Types::DescribeStateMachineOutput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-states/lib/aws-sdk-states/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:definition, :description, :variable_references]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_date ⇒ Time

The date the state machine is created.

For a state machine version, creationDate is the date the version was created.

Returns:

  • (Time) 


1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
 
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1296

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label,
  :revision_id,
  :description,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :description, :variable_references]
  include Aws::Structure
end

#definition ⇒ String

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

If called with includedData = METADATA_ONLY, the returned definition will be {}.

Returns:

  • (String) 


1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
 
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1296

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label,
  :revision_id,
  :description,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :description, :variable_references]
  include Aws::Structure
end

#description ⇒ String

The description of the state machine version.

Returns:

  • (String) 


1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
 
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1296

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label,
  :revision_id,
  :description,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :description, :variable_references]
  include Aws::Structure
end

#encryption_configuration ⇒ Types::EncryptionConfiguration

Settings to configure server-side encryption.

Returns:



1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
 
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1296

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label,
  :revision_id,
  :description,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :description, :variable_references]
  include Aws::Structure
end

#label ⇒ 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.

Returns:

  • (String) 


1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
 
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1296

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label,
  :revision_id,
  :description,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :description, :variable_references]
  include Aws::Structure
end

#logging_configuration ⇒ Types::LoggingConfiguration

The LoggingConfiguration data type is used to set CloudWatch Logs options.

Returns:



1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
 
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1296

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label,
  :revision_id,
  :description,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :description, :variable_references]
  include Aws::Structure
end

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

Returns:

  • (String) 


1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
 
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1296

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label,
  :revision_id,
  :description,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :description, :variable_references]
  include Aws::Structure
end

#revision_id ⇒ 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.

Returns:

  • (String) 


1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
 
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1296

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label,
  :revision_id,
  :description,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :description, :variable_references]
  include Aws::Structure
end

#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.)

Returns:

  • (String) 


1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
 
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1296

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label,
  :revision_id,
  :description,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :description, :variable_references]
  include Aws::Structure
end

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

Returns:

  • (String) 


1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
 
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1296

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label,
  :revision_id,
  :description,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :description, :variable_references]
  include Aws::Structure
end

#status ⇒ String

The current status of the state machine.

Returns:

  • (String) 


1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
 
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1296

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label,
  :revision_id,
  :description,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :description, :variable_references]
  include Aws::Structure
end

#tracing_configuration ⇒ Types::TracingConfiguration

Selects whether X-Ray tracing is enabled.

Returns:



1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
 
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1296

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label,
  :revision_id,
  :description,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :description, :variable_references]
  include Aws::Structure
end

#type ⇒ String

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

Returns:

  • (String) 


1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
 
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1296

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label,
  :revision_id,
  :description,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :description, :variable_references]
  include Aws::Structure
end

#variable_references ⇒ Hash<String,Array<String>>

A map of state name to a list of variables referenced by that state. States that do not use variable references will not be shown in the response.

Returns:

  • (Hash<String,Array<String>>) 


1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
 
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1296

class DescribeStateMachineOutput < Struct.new(
  :state_machine_arn,
  :name,
  :status,
  :definition,
  :role_arn,
  :type,
  :creation_date,
  :logging_configuration,
  :tracing_configuration,
  :label,
  :revision_id,
  :description,
  :encryption_configuration,
  :variable_references)
  SENSITIVE = [:definition, :description, :variable_references]
  include Aws::Structure
end