Class: Aws::KendraRanking::Types::DescribeRescoreExecutionPlanResponse

Inherits:

Struct

• Object
• Struct
• Aws::KendraRanking::Types::DescribeRescoreExecutionPlanResponse

Defined in:

gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the rescore execution plan.

• #capacity_units ⇒ Types::CapacityUnitsConfiguration

  The capacity units set for the rescore execution plan.

• #created_at ⇒ Time

  The Unix timestamp of when the rescore execution plan was created.

• #description ⇒ String

  The description for the rescore execution plan.

• #error_message ⇒ String

  When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

• #id ⇒ String

  The identifier of the rescore execution plan.

• #name ⇒ String

  The name for the rescore execution plan.

• #status ⇒ String

  The current status of the rescore execution plan.

• #updated_at ⇒ Time

  The Unix timestamp of when the rescore execution plan was last updated.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the rescore execution plan.

Returns:

• (String)

# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/types.rb', line 206

class DescribeRescoreExecutionPlanResponse < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :capacity_units,
  :created_at,
  :updated_at,
  :status,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_units ⇒ Types::CapacityUnitsConfiguration

The capacity units set for the rescore execution plan. A capacity of zero indicates that the rescore execution plan is using the default capacity. For more information on the default capacity and additional capacity units, see Adjusting capacity.

Returns:

• (Types::CapacityUnitsConfiguration)

# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/types.rb', line 206

class DescribeRescoreExecutionPlanResponse < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :capacity_units,
  :created_at,
  :updated_at,
  :status,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The Unix timestamp of when the rescore execution plan was created.

Returns:

• (Time)

# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/types.rb', line 206

class DescribeRescoreExecutionPlanResponse < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :capacity_units,
  :created_at,
  :updated_at,
  :status,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description for the rescore execution plan.

Returns:

• (String)

# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/types.rb', line 206

class DescribeRescoreExecutionPlanResponse < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :capacity_units,
  :created_at,
  :updated_at,
  :status,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#error_message ⇒ String

When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

Returns:

• (String)

# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/types.rb', line 206

class DescribeRescoreExecutionPlanResponse < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :capacity_units,
  :created_at,
  :updated_at,
  :status,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The identifier of the rescore execution plan.

Returns:

• (String)

# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/types.rb', line 206

class DescribeRescoreExecutionPlanResponse < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :capacity_units,
  :created_at,
  :updated_at,
  :status,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name for the rescore execution plan.

Returns:

• (String)

# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/types.rb', line 206

class DescribeRescoreExecutionPlanResponse < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :capacity_units,
  :created_at,
  :updated_at,
  :status,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the rescore execution plan. When the value is ACTIVE, the rescore execution plan is ready for use. If the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

Returns:

• (String)

# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/types.rb', line 206

class DescribeRescoreExecutionPlanResponse < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :capacity_units,
  :created_at,
  :updated_at,
  :status,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The Unix timestamp of when the rescore execution plan was last updated.

Returns:

• (Time)

# File 'gems/aws-sdk-kendraranking/lib/aws-sdk-kendraranking/types.rb', line 206

class DescribeRescoreExecutionPlanResponse < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :capacity_units,
  :created_at,
  :updated_at,
  :status,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end