Class: Aws::Connect::Types::CreateEvaluationFormRequest

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::CreateEvaluationFormRequest

Includes:

Structure

Defined in:

lib/aws-sdk-connect/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #as_draft ⇒ Boolean

  A boolean flag indicating whether to create evaluation form in draft state.

• #auto_evaluation_configuration ⇒ Types::EvaluationFormAutoEvaluationConfiguration

  Configuration information about automated evaluations.

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

• #description ⇒ String

  The description of the evaluation form.

• #instance_id ⇒ String

  The identifier of the Amazon Connect instance.

• #items ⇒ Array<Types::EvaluationFormItem>

  Items that are part of the evaluation form.

• #language_configuration ⇒ Types::EvaluationFormLanguageConfiguration

  Configuration for language settings of the evaluation form.

• #scoring_strategy ⇒ Types::EvaluationFormScoringStrategy

  A scoring strategy of the evaluation form.

• #tags ⇒ Hash<String,String>

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

• #target_configuration ⇒ Types::EvaluationFormTargetConfiguration

  Configuration that specifies the target for the evaluation form.

• #title ⇒ String

  A title of the evaluation form.

Instance Attribute Details

#as_draft ⇒ Boolean

A boolean flag indicating whether to create evaluation form in draft state.

Returns:

• (Boolean)

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

class CreateEvaluationFormRequest < Struct.new(
  :instance_id,
  :title,
  :description,
  :items,
  :scoring_strategy,
  :auto_evaluation_configuration,
  :client_token,
  :as_draft,
  :tags,
  :target_configuration,
  :language_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#auto_evaluation_configuration ⇒ Types::EvaluationFormAutoEvaluationConfiguration

Configuration information about automated evaluations.

Returns:

• (Types::EvaluationFormAutoEvaluationConfiguration)

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

class CreateEvaluationFormRequest < Struct.new(
  :instance_id,
  :title,
  :description,
  :items,
  :scoring_strategy,
  :auto_evaluation_configuration,
  :client_token,
  :as_draft,
  :tags,
  :target_configuration,
  :language_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see [Making retries safe with idempotent APIs].

**A suitable default value is auto-generated.** You should normally not need to pass this option.

[1]: aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/

Returns:

• (String)

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

class CreateEvaluationFormRequest < Struct.new(
  :instance_id,
  :title,
  :description,
  :items,
  :scoring_strategy,
  :auto_evaluation_configuration,
  :client_token,
  :as_draft,
  :tags,
  :target_configuration,
  :language_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the evaluation form.

Returns:

• (String)

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

class CreateEvaluationFormRequest < Struct.new(
  :instance_id,
  :title,
  :description,
  :items,
  :scoring_strategy,
  :auto_evaluation_configuration,
  :client_token,
  :as_draft,
  :tags,
  :target_configuration,
  :language_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#instance_id ⇒ String

The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource Name (ARN) of the instance.

[1]: docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html

Returns:

• (String)

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

class CreateEvaluationFormRequest < Struct.new(
  :instance_id,
  :title,
  :description,
  :items,
  :scoring_strategy,
  :auto_evaluation_configuration,
  :client_token,
  :as_draft,
  :tags,
  :target_configuration,
  :language_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#items ⇒ Array<Types::EvaluationFormItem>

Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.

Returns:

• (Array<Types::EvaluationFormItem>)

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

class CreateEvaluationFormRequest < Struct.new(
  :instance_id,
  :title,
  :description,
  :items,
  :scoring_strategy,
  :auto_evaluation_configuration,
  :client_token,
  :as_draft,
  :tags,
  :target_configuration,
  :language_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#language_configuration ⇒ Types::EvaluationFormLanguageConfiguration

Configuration for language settings of the evaluation form.

Returns:

• (Types::EvaluationFormLanguageConfiguration)

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

class CreateEvaluationFormRequest < Struct.new(
  :instance_id,
  :title,
  :description,
  :items,
  :scoring_strategy,
  :auto_evaluation_configuration,
  :client_token,
  :as_draft,
  :tags,
  :target_configuration,
  :language_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#scoring_strategy ⇒ Types::EvaluationFormScoringStrategy

A scoring strategy of the evaluation form.

Returns:

• (Types::EvaluationFormScoringStrategy)

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

class CreateEvaluationFormRequest < Struct.new(
  :instance_id,
  :title,
  :description,
  :items,
  :scoring_strategy,
  :auto_evaluation_configuration,
  :client_token,
  :as_draft,
  :tags,
  :target_configuration,
  :language_configuration)
  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 5583

class CreateEvaluationFormRequest < Struct.new(
  :instance_id,
  :title,
  :description,
  :items,
  :scoring_strategy,
  :auto_evaluation_configuration,
  :client_token,
  :as_draft,
  :tags,
  :target_configuration,
  :language_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#target_configuration ⇒ Types::EvaluationFormTargetConfiguration

Configuration that specifies the target for the evaluation form.

Returns:

• (Types::EvaluationFormTargetConfiguration)

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

class CreateEvaluationFormRequest < Struct.new(
  :instance_id,
  :title,
  :description,
  :items,
  :scoring_strategy,
  :auto_evaluation_configuration,
  :client_token,
  :as_draft,
  :tags,
  :target_configuration,
  :language_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

A title of the evaluation form.

Returns:

• (String)

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

class CreateEvaluationFormRequest < Struct.new(
  :instance_id,
  :title,
  :description,
  :items,
  :scoring_strategy,
  :auto_evaluation_configuration,
  :client_token,
  :as_draft,
  :tags,
  :target_configuration,
  :language_configuration)
  SENSITIVE = []
  include Aws::Structure
end