Type definitions#
Index > KendraRanking > Type definitions
Auto-generated documentation for KendraRanking type annotations stubs module mypy-boto3-kendra-ranking.
CapacityUnitsConfigurationTypeDef#
# CapacityUnitsConfigurationTypeDef definition
class CapacityUnitsConfigurationTypeDef(TypedDict):
RescoreCapacityUnits: int,
TagTypeDef#
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
DeleteRescoreExecutionPlanRequestRequestTypeDef#
# DeleteRescoreExecutionPlanRequestRequestTypeDef definition
class DeleteRescoreExecutionPlanRequestRequestTypeDef(TypedDict):
Id: str,
DescribeRescoreExecutionPlanRequestRequestTypeDef#
# DescribeRescoreExecutionPlanRequestRequestTypeDef definition
class DescribeRescoreExecutionPlanRequestRequestTypeDef(TypedDict):
Id: str,
DocumentTypeDef#
# DocumentTypeDef definition
class DocumentTypeDef(TypedDict):
Id: str,
OriginalScore: float,
GroupId: NotRequired[str],
Title: NotRequired[str],
Body: NotRequired[str],
TokenizedTitle: NotRequired[Sequence[str]],
TokenizedBody: NotRequired[Sequence[str]],
ListRescoreExecutionPlansRequestRequestTypeDef#
# ListRescoreExecutionPlansRequestRequestTypeDef definition
class ListRescoreExecutionPlansRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
RescoreExecutionPlanSummaryTypeDef#
# RescoreExecutionPlanSummaryTypeDef definition
class RescoreExecutionPlanSummaryTypeDef(TypedDict):
Name: NotRequired[str],
Id: NotRequired[str],
CreatedAt: NotRequired[datetime],
UpdatedAt: NotRequired[datetime],
Status: NotRequired[RescoreExecutionPlanStatusType], # (1)
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
RescoreResultItemTypeDef#
# RescoreResultItemTypeDef definition
class RescoreResultItemTypeDef(TypedDict):
DocumentId: NotRequired[str],
Score: NotRequired[float],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],
UpdateRescoreExecutionPlanRequestRequestTypeDef#
# UpdateRescoreExecutionPlanRequestRequestTypeDef definition
class UpdateRescoreExecutionPlanRequestRequestTypeDef(TypedDict):
Id: str,
Name: NotRequired[str],
Description: NotRequired[str],
CapacityUnits: NotRequired[CapacityUnitsConfigurationTypeDef], # (1)
CreateRescoreExecutionPlanRequestRequestTypeDef#
# CreateRescoreExecutionPlanRequestRequestTypeDef definition
class CreateRescoreExecutionPlanRequestRequestTypeDef(TypedDict):
Name: str,
Description: NotRequired[str],
CapacityUnits: NotRequired[CapacityUnitsConfigurationTypeDef], # (1)
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
ClientToken: NotRequired[str],
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateRescoreExecutionPlanResponseTypeDef#
# CreateRescoreExecutionPlanResponseTypeDef definition
class CreateRescoreExecutionPlanResponseTypeDef(TypedDict):
Id: str,
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeRescoreExecutionPlanResponseTypeDef#
# DescribeRescoreExecutionPlanResponseTypeDef definition
class DescribeRescoreExecutionPlanResponseTypeDef(TypedDict):
Id: str,
Arn: str,
Name: str,
Description: str,
CapacityUnits: CapacityUnitsConfigurationTypeDef, # (1)
CreatedAt: datetime,
UpdatedAt: datetime,
Status: RescoreExecutionPlanStatusType, # (2)
ErrorMessage: str,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See CapacityUnitsConfigurationTypeDef
- See RescoreExecutionPlanStatusType
- See ResponseMetadataTypeDef
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
RescoreRequestRequestTypeDef#
# RescoreRequestRequestTypeDef definition
class RescoreRequestRequestTypeDef(TypedDict):
RescoreExecutionPlanId: str,
SearchQuery: str,
Documents: Sequence[DocumentTypeDef], # (1)
- See DocumentTypeDef
ListRescoreExecutionPlansResponseTypeDef#
# ListRescoreExecutionPlansResponseTypeDef definition
class ListRescoreExecutionPlansResponseTypeDef(TypedDict):
SummaryItems: List[RescoreExecutionPlanSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RescoreResultTypeDef#
# RescoreResultTypeDef definition
class RescoreResultTypeDef(TypedDict):
RescoreId: str,
ResultItems: List[RescoreResultItemTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)