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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-connect/types.rb

Overview

Contains information about a flow.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the flow.

Returns:

  • (String)


1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
# File 'lib/aws-sdk-connect/types.rb', line 1878

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

#contentString

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)


1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
# File 'lib/aws-sdk-connect/types.rb', line 1878

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

#descriptionString

The description of the flow.

Returns:

  • (String)


1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
# File 'lib/aws-sdk-connect/types.rb', line 1878

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

#idString

The identifier of the flow.

Returns:

  • (String)


1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
# File 'lib/aws-sdk-connect/types.rb', line 1878

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

#nameString

The name of the flow.

Returns:

  • (String)


1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
# File 'lib/aws-sdk-connect/types.rb', line 1878

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

#stateString

The type of flow.

Returns:

  • (String)


1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
# File 'lib/aws-sdk-connect/types.rb', line 1878

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

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


1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
# File 'lib/aws-sdk-connect/types.rb', line 1878

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

#typeString

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)


1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
# File 'lib/aws-sdk-connect/types.rb', line 1878

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