Skip to content

Kendra Ranking Classes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

CapacityUnitsConfiguration

RescoreCapacityUnits

  • Type:
  • Required: Yes

CreateRescoreExecutionPlanRequest

Name

  • Type:
  • Required: Yes

Description

  • Type: typing.Optional[str]

CapacityUnits

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kendra_ranking.kendra_ranking_classes.CapacityUnitsConfiguration]

Tags

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.kendra_ranking.kendra_ranking_classes.Tag]]

ClientToken

  • Type: typing.Optional[str]

CreateRescoreExecutionPlanResponse

Id

  • Type:
  • Required: Yes

Arn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteRescoreExecutionPlanRequest

Id

  • Type:
  • Required: Yes

DescribeRescoreExecutionPlanRequest

Id

  • Type:
  • Required: Yes

DescribeRescoreExecutionPlanResponse

Id

  • Type:
  • Required: Yes

Arn

  • Type:
  • Required: Yes

Name

  • Type:
  • Required: Yes

Description

  • Type:
  • Required: Yes

CapacityUnits

  • Type:
  • Required: Yes

CreatedAt

  • Type:
  • Required: Yes

UpdatedAt

  • Type:
  • Required: Yes

Status

  • Type: typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']
  • Required: Yes

ErrorMessage

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Document

Id

  • Type:
  • Required: Yes

OriginalScore

  • Type:
  • Required: Yes

GroupId

  • Type: typing.Optional[str]

Title

  • Type: typing.Optional[str]

Body

  • Type: typing.Optional[str]

TokenizedTitle

  • Type: typing.Optional[typing.List[str]]

TokenizedBody

  • Type: typing.Optional[typing.List[str]]

EmptyResponseMetadata

ResponseMetadata

  • Type:
  • Required: Yes

ListRescoreExecutionPlansRequest

NextToken

  • Type: typing.Optional[str]

MaxResults

  • Type: typing.Optional[int]

ListRescoreExecutionPlansResponse

SummaryItems

  • Type: typing.List[aws_resource_validator.pydantic_models.kendra_ranking.kendra_ranking_classes.RescoreExecutionPlanSummary]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

NextToken

  • Type: typing.Optional[str]

ListTagsForResourceRequest

ResourceARN

  • Type:
  • Required: Yes

ListTagsForResourceResponse

Tags

  • Type: typing.List[aws_resource_validator.pydantic_models.kendra_ranking.kendra_ranking_classes.Tag]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

RescoreExecutionPlanSummary

Name

  • Type: typing.Optional[str]

Id

  • Type: typing.Optional[str]

CreatedAt

  • Type: typing.Optional[datetime.datetime]

UpdatedAt

  • Type: typing.Optional[datetime.datetime]

Status

  • Type: typing.Optional[typing.Literal['ACTIVE', 'CREATING', 'DELETING', 'FAILED', 'UPDATING']]

RescoreRequest

RescoreExecutionPlanId

  • Type:
  • Required: Yes

SearchQuery

  • Type:
  • Required: Yes

Documents

  • Type: typing.List[aws_resource_validator.pydantic_models.kendra_ranking.kendra_ranking_classes.Document]
  • Required: Yes

RescoreResult

RescoreId

  • Type:
  • Required: Yes

ResultItems

  • Type: typing.List[aws_resource_validator.pydantic_models.kendra_ranking.kendra_ranking_classes.RescoreResultItem]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

RescoreResultItem

DocumentId

  • Type: typing.Optional[str]

Score

  • Type: typing.Optional[float]

ResponseMetadata

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

Tag

Key

  • Type:
  • Required: Yes

Value

  • Type:
  • Required: Yes

TagResourceRequest

ResourceARN

  • Type:
  • Required: Yes

Tags

  • Type: typing.List[aws_resource_validator.pydantic_models.kendra_ranking.kendra_ranking_classes.Tag]
  • Required: Yes

UntagResourceRequest

ResourceARN

  • Type:
  • Required: Yes

TagKeys

  • Type: typing.List[str]
  • Required: Yes

UpdateRescoreExecutionPlanRequest

Id

  • Type:
  • Required: Yes

Name

  • Type: typing.Optional[str]

Description

  • Type: typing.Optional[str]

CapacityUnits

  • Type: typing.Optional[aws_resource_validator.pydantic_models.kendra_ranking.kendra_ranking_classes.CapacityUnitsConfiguration]