Class: Aws::Transfer::Types::DescribedWorkflow

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

Overview

Describes the properties of the specified workflow

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

Specifies the unique Amazon Resource Name (ARN) for the workflow.

Returns:

  • (String) 


3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3812

class DescribedWorkflow < Struct.new(
  :arn,
  :description,
  :steps,
  :on_exception_steps,
  :workflow_id,
  :tags,
  :structured_log_destinations)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

Specifies the text description for the workflow.

Returns:

  • (String) 


3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3812

class DescribedWorkflow < Struct.new(
  :arn,
  :description,
  :steps,
  :on_exception_steps,
  :workflow_id,
  :tags,
  :structured_log_destinations)
  SENSITIVE = []
  include Aws::Structure
end

#on_exception_steps ⇒ Array<Types::WorkflowStep>

Specifies the steps (actions) to take if errors are encountered during execution of the workflow.

Returns:



3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3812

class DescribedWorkflow < Struct.new(
  :arn,
  :description,
  :steps,
  :on_exception_steps,
  :workflow_id,
  :tags,
  :structured_log_destinations)
  SENSITIVE = []
  include Aws::Structure
end

#steps ⇒ Array<Types::WorkflowStep>

Specifies the details for the steps that are in the specified workflow.

Returns:



3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3812

class DescribedWorkflow < Struct.new(
  :arn,
  :description,
  :steps,
  :on_exception_steps,
  :workflow_id,
  :tags,
  :structured_log_destinations)
  SENSITIVE = []
  include Aws::Structure
end

#structured_log_destinations ⇒ Array<String>

Specifies the log groups to which your workflow logs are sent.

To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:

arn:partition:logs:region-name:amazon-account-id:log-group:log-group-name:*

For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*

Returns:

  • (Array<String>) 


3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3812

class DescribedWorkflow < Struct.new(
  :arn,
  :description,
  :steps,
  :on_exception_steps,
  :workflow_id,
  :tags,
  :structured_log_destinations)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

Returns:



3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3812

class DescribedWorkflow < Struct.new(
  :arn,
  :description,
  :steps,
  :on_exception_steps,
  :workflow_id,
  :tags,
  :structured_log_destinations)
  SENSITIVE = []
  include Aws::Structure
end

#workflow_id ⇒ String

A unique identifier for the workflow.

Returns:

  • (String) 


3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
 
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 3812

class DescribedWorkflow < Struct.new(
  :arn,
  :description,
  :steps,
  :on_exception_steps,
  :workflow_id,
  :tags,
  :structured_log_destinations)
  SENSITIVE = []
  include Aws::Structure
end