Typed dictionaries

Index > KendraRanking > Typed dictionaries

Auto-generated documentation for KendraRanking type annotations stubs module mypy-boto3-kendra-ranking.

CapacityUnitsConfigurationTypeDef

# CapacityUnitsConfigurationTypeDef usage example

from mypy_boto3_kendra_ranking.type_defs import CapacityUnitsConfigurationTypeDef

def get_value() -> CapacityUnitsConfigurationTypeDef:
    return {
        "RescoreCapacityUnits": ...,
    }

# CapacityUnitsConfigurationTypeDef definition

class CapacityUnitsConfigurationTypeDef(TypedDict):
    RescoreCapacityUnits: int,

TagTypeDef

# TagTypeDef usage example

from mypy_boto3_kendra_ranking.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

ResponseMetadataTypeDef

# ResponseMetadataTypeDef usage example

from mypy_boto3_kendra_ranking.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

DeleteRescoreExecutionPlanRequestRequestTypeDef

# DeleteRescoreExecutionPlanRequestRequestTypeDef usage example

from mypy_boto3_kendra_ranking.type_defs import DeleteRescoreExecutionPlanRequestRequestTypeDef

def get_value() -> DeleteRescoreExecutionPlanRequestRequestTypeDef:
    return {
        "Id": ...,
    }

# DeleteRescoreExecutionPlanRequestRequestTypeDef definition

class DeleteRescoreExecutionPlanRequestRequestTypeDef(TypedDict):
    Id: str,

DescribeRescoreExecutionPlanRequestRequestTypeDef

# DescribeRescoreExecutionPlanRequestRequestTypeDef usage example

from mypy_boto3_kendra_ranking.type_defs import DescribeRescoreExecutionPlanRequestRequestTypeDef

def get_value() -> DescribeRescoreExecutionPlanRequestRequestTypeDef:
    return {
        "Id": ...,
    }

# DescribeRescoreExecutionPlanRequestRequestTypeDef definition

class DescribeRescoreExecutionPlanRequestRequestTypeDef(TypedDict):
    Id: str,

DocumentTypeDef

# DocumentTypeDef usage example

from mypy_boto3_kendra_ranking.type_defs import DocumentTypeDef

def get_value() -> DocumentTypeDef:
    return {
        "Id": ...,
        "OriginalScore": ...,
    }

# 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 usage example

from mypy_boto3_kendra_ranking.type_defs import ListRescoreExecutionPlansRequestRequestTypeDef

def get_value() -> ListRescoreExecutionPlansRequestRequestTypeDef:
    return {
        "NextToken": ...,
    }

# ListRescoreExecutionPlansRequestRequestTypeDef definition

class ListRescoreExecutionPlansRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

RescoreExecutionPlanSummaryTypeDef

# RescoreExecutionPlanSummaryTypeDef usage example

from mypy_boto3_kendra_ranking.type_defs import RescoreExecutionPlanSummaryTypeDef

def get_value() -> RescoreExecutionPlanSummaryTypeDef:
    return {
        "Name": ...,
    }

# RescoreExecutionPlanSummaryTypeDef definition

class RescoreExecutionPlanSummaryTypeDef(TypedDict):
    Name: NotRequired[str],
    Id: NotRequired[str],
    CreatedAt: NotRequired[datetime],
    UpdatedAt: NotRequired[datetime],
    Status: NotRequired[RescoreExecutionPlanStatusType],  # (1)

1. See RescoreExecutionPlanStatusType

ListTagsForResourceRequestRequestTypeDef

# ListTagsForResourceRequestRequestTypeDef usage example

from mypy_boto3_kendra_ranking.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
    }

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,

RescoreResultItemTypeDef

# RescoreResultItemTypeDef usage example

from mypy_boto3_kendra_ranking.type_defs import RescoreResultItemTypeDef

def get_value() -> RescoreResultItemTypeDef:
    return {
        "DocumentId": ...,
    }

# RescoreResultItemTypeDef definition

class RescoreResultItemTypeDef(TypedDict):
    DocumentId: NotRequired[str],
    Score: NotRequired[float],

UntagResourceRequestRequestTypeDef

# UntagResourceRequestRequestTypeDef usage example

from mypy_boto3_kendra_ranking.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
        "TagKeys": ...,
    }

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

UpdateRescoreExecutionPlanRequestRequestTypeDef

# UpdateRescoreExecutionPlanRequestRequestTypeDef usage example

from mypy_boto3_kendra_ranking.type_defs import UpdateRescoreExecutionPlanRequestRequestTypeDef

def get_value() -> UpdateRescoreExecutionPlanRequestRequestTypeDef:
    return {
        "Id": ...,
    }

# UpdateRescoreExecutionPlanRequestRequestTypeDef definition

class UpdateRescoreExecutionPlanRequestRequestTypeDef(TypedDict):
    Id: str,
    Name: NotRequired[str],
    Description: NotRequired[str],
    CapacityUnits: NotRequired[CapacityUnitsConfigurationTypeDef],  # (1)

1. See CapacityUnitsConfigurationTypeDef

CreateRescoreExecutionPlanRequestRequestTypeDef

# CreateRescoreExecutionPlanRequestRequestTypeDef usage example

from mypy_boto3_kendra_ranking.type_defs import CreateRescoreExecutionPlanRequestRequestTypeDef

def get_value() -> CreateRescoreExecutionPlanRequestRequestTypeDef:
    return {
        "Name": ...,
    }

# CreateRescoreExecutionPlanRequestRequestTypeDef definition

class CreateRescoreExecutionPlanRequestRequestTypeDef(TypedDict):
    Name: str,
    Description: NotRequired[str],
    CapacityUnits: NotRequired[CapacityUnitsConfigurationTypeDef],  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    ClientToken: NotRequired[str],

1. See CapacityUnitsConfigurationTypeDef
2. See TagTypeDef

TagResourceRequestRequestTypeDef

# TagResourceRequestRequestTypeDef usage example

from mypy_boto3_kendra_ranking.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "ResourceARN": ...,
        "Tags": ...,
    }

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)

1. See TagTypeDef

CreateRescoreExecutionPlanResponseTypeDef

# CreateRescoreExecutionPlanResponseTypeDef usage example

from mypy_boto3_kendra_ranking.type_defs import CreateRescoreExecutionPlanResponseTypeDef

def get_value() -> CreateRescoreExecutionPlanResponseTypeDef:
    return {
        "Id": ...,
        "Arn": ...,
        "ResponseMetadata": ...,
    }

# CreateRescoreExecutionPlanResponseTypeDef definition

class CreateRescoreExecutionPlanResponseTypeDef(TypedDict):
    Id: str,
    Arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

DescribeRescoreExecutionPlanResponseTypeDef

# DescribeRescoreExecutionPlanResponseTypeDef usage example

from mypy_boto3_kendra_ranking.type_defs import DescribeRescoreExecutionPlanResponseTypeDef

def get_value() -> DescribeRescoreExecutionPlanResponseTypeDef:
    return {
        "Id": ...,
        "Arn": ...,
        "Name": ...,
        "Description": ...,
        "CapacityUnits": ...,
        "CreatedAt": ...,
        "UpdatedAt": ...,
        "Status": ...,
        "ErrorMessage": ...,
        "ResponseMetadata": ...,
    }

# 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)

1. See CapacityUnitsConfigurationTypeDef
2. See RescoreExecutionPlanStatusType
3. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

# EmptyResponseMetadataTypeDef usage example

from mypy_boto3_kendra_ranking.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef

# ListTagsForResourceResponseTypeDef usage example

from mypy_boto3_kendra_ranking.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See TagTypeDef
2. See ResponseMetadataTypeDef

RescoreRequestRequestTypeDef

# RescoreRequestRequestTypeDef usage example

from mypy_boto3_kendra_ranking.type_defs import RescoreRequestRequestTypeDef

def get_value() -> RescoreRequestRequestTypeDef:
    return {
        "RescoreExecutionPlanId": ...,
        "SearchQuery": ...,
        "Documents": ...,
    }

# RescoreRequestRequestTypeDef definition

class RescoreRequestRequestTypeDef(TypedDict):
    RescoreExecutionPlanId: str,
    SearchQuery: str,
    Documents: Sequence[DocumentTypeDef],  # (1)

1. See DocumentTypeDef

ListRescoreExecutionPlansResponseTypeDef

# ListRescoreExecutionPlansResponseTypeDef usage example

from mypy_boto3_kendra_ranking.type_defs import ListRescoreExecutionPlansResponseTypeDef

def get_value() -> ListRescoreExecutionPlansResponseTypeDef:
    return {
        "SummaryItems": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

# ListRescoreExecutionPlansResponseTypeDef definition

class ListRescoreExecutionPlansResponseTypeDef(TypedDict):
    SummaryItems: List[RescoreExecutionPlanSummaryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See RescoreExecutionPlanSummaryTypeDef
2. See ResponseMetadataTypeDef

RescoreResultTypeDef

# RescoreResultTypeDef usage example

from mypy_boto3_kendra_ranking.type_defs import RescoreResultTypeDef

def get_value() -> RescoreResultTypeDef:
    return {
        "RescoreId": ...,
        "ResultItems": ...,
        "ResponseMetadata": ...,
    }

# RescoreResultTypeDef definition

class RescoreResultTypeDef(TypedDict):
    RescoreId: str,
    ResultItems: List[RescoreResultItemTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See RescoreResultItemTypeDef
2. See ResponseMetadataTypeDef