Class: Aws::Connect::Types::ContactFlow

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::ContactFlow

Includes:

Structure

Defined in:

lib/aws-sdk-connect/types.rb

Overview

Contains information about a flow.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the flow.

• #content ⇒ String

  The JSON string that represents the content of the flow.

• #description ⇒ String

  The description of the flow.

• #id ⇒ String

  The identifier of the flow.

• #name ⇒ String

  The name of the flow.

• #state ⇒ String

  The type of flow.

• #status ⇒ String

  The status of the contact flow.

• #tags ⇒ Hash<String,String>

  The tags used to organize, track, or control access for this resource.

• #type ⇒ String

  The type of the flow.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the flow.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 2504

class ContactFlow < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :state,
  :status,
  :description,
  :content,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#content ⇒ String

The JSON string that represents the content of the flow. For an example, see [Example flow in Amazon Connect Flow language].

Length Constraints: Minimum length of 1. Maximum length of 256000.

[1]: docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 2504

class ContactFlow < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :state,
  :status,
  :description,
  :content,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the flow.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 2504

class ContactFlow < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :state,
  :status,
  :description,
  :content,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The identifier of the flow.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 2504

class ContactFlow < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :state,
  :status,
  :description,
  :content,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the flow.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 2504

class ContactFlow < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :state,
  :status,
  :description,
  :content,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The type of flow.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 2504

class ContactFlow < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :state,
  :status,
  :description,
  :content,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the contact flow.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 2504

class ContactFlow < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :state,
  :status,
  :description,
  :content,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags used to organize, track, or control access for this resource. For example, \{ “Tags”: {“key1”:“value1”, “key2”:“value2”\} \}.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-connect/types.rb', line 2504

class ContactFlow < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :state,
  :status,
  :description,
  :content,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of the flow. For descriptions of the available types, see

Choose a flow type][1

in the *Amazon Connect Administrator Guide*.

[1]: docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 2504

class ContactFlow < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :state,
  :status,
  :description,
  :content,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end