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.

• #flow_content_sha_256 ⇒ String

  Indicates the checksum value of the flow content.

• #id ⇒ String

  The identifier of the flow.

• #is_default ⇒ Boolean

  Amazon Connect includes a set of default flows that have already been published.

• #last_modified_region ⇒ String

  The region in which the contact flow was last modified.

• #last_modified_time ⇒ Time

  The time at which the contact flow was last modified.

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

• #version ⇒ Integer

  The identifier of the flow version.

• #version_description ⇒ String

  The description of the flow version.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the flow.

Returns:

• (String)

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

class ContactFlow < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :state,
  :status,
  :description,
  :content,
  :tags,
  :is_default,
  :flow_content_sha_256,
  :version,
  :version_description,
  :last_modified_time,
  :last_modified_region)
  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 2534

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

#description ⇒ String

The description of the flow.

Returns:

• (String)

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

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

#flow_content_sha_256 ⇒ String

Indicates the checksum value of the flow content.

Returns:

• (String)

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

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

#id ⇒ String

The identifier of the flow.

Returns:

• (String)

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

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

#is_default ⇒ Boolean

Amazon Connect includes a set of default flows that have already been published. It uses them to power your contact center.

Returns:

• (Boolean)

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

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

#last_modified_region ⇒ String

The region in which the contact flow was last modified

Returns:

• (String)

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

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

#last_modified_time ⇒ Time

The time at which the contact flow was last modified.

Returns:

• (Time)

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

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

#name ⇒ String

The name of the flow.

Returns:

• (String)

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

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

#state ⇒ String

The type of flow.

Returns:

• (String)

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

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

#status ⇒ String

The status of the contact flow.

Returns:

• (String)

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

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

#tags ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

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

class ContactFlow < Struct.new(
  :arn,
  :id,
  :name,
  :type,
  :state,
  :status,
  :description,
  :content,
  :tags,
  :is_default,
  :flow_content_sha_256,
  :version,
  :version_description,
  :last_modified_time,
  :last_modified_region)
  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 2534

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

#version ⇒ Integer

The identifier of the flow version.

Returns:

• (Integer)

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

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

#version_description ⇒ String

The description of the flow version.

Returns:

• (String)

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

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