Type definitions#
Auto-generated documentation for Bedrock type annotations stubs module mypy-boto3-bedrock.
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
VpcConfigUnionTypeDef#
# VpcConfigUnionTypeDef definition
VpcConfigUnionTypeDef = Union[
VpcConfigTypeDef, # (1)
VpcConfigOutputTypeDef, # (2)
]
ValidationDataConfigUnionTypeDef#
# ValidationDataConfigUnionTypeDef definition
ValidationDataConfigUnionTypeDef = Union[
ValidationDataConfigTypeDef, # (1)
ValidationDataConfigOutputTypeDef, # (2)
]
EvaluationInferenceConfigUnionTypeDef#
# EvaluationInferenceConfigUnionTypeDef definition
EvaluationInferenceConfigUnionTypeDef = Union[
EvaluationInferenceConfigTypeDef, # (1)
EvaluationInferenceConfigOutputTypeDef, # (2)
]
EvaluationConfigUnionTypeDef#
# EvaluationConfigUnionTypeDef definition
EvaluationConfigUnionTypeDef = Union[
EvaluationConfigTypeDef, # (1)
EvaluationConfigOutputTypeDef, # (2)
]
S3ConfigTypeDef#
# S3ConfigTypeDef definition
class S3ConfigTypeDef(TypedDict):
bucketName: str,
keyPrefix: NotRequired[str],
EvaluationOutputDataConfigTypeDef#
# EvaluationOutputDataConfigTypeDef definition
class EvaluationOutputDataConfigTypeDef(TypedDict):
s3Uri: str,
TagTypeDef#
# TagTypeDef definition
class TagTypeDef(TypedDict):
key: str,
value: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
CreateGuardrailVersionRequestRequestTypeDef#
# CreateGuardrailVersionRequestRequestTypeDef definition
class CreateGuardrailVersionRequestRequestTypeDef(TypedDict):
guardrailIdentifier: str,
description: NotRequired[str],
clientRequestToken: NotRequired[str],
OutputDataConfigTypeDef#
# OutputDataConfigTypeDef definition
class OutputDataConfigTypeDef(TypedDict):
s3Uri: str,
TrainingDataConfigTypeDef#
# TrainingDataConfigTypeDef definition
class TrainingDataConfigTypeDef(TypedDict):
s3Uri: str,
VpcConfigTypeDef#
# VpcConfigTypeDef definition
class VpcConfigTypeDef(TypedDict):
subnetIds: Sequence[str],
securityGroupIds: Sequence[str],
CustomModelSummaryTypeDef#
# CustomModelSummaryTypeDef definition
class CustomModelSummaryTypeDef(TypedDict):
modelArn: str,
modelName: str,
creationTime: datetime,
baseModelArn: str,
baseModelName: str,
customizationType: NotRequired[CustomizationTypeType], # (1)
DeleteCustomModelRequestRequestTypeDef#
# DeleteCustomModelRequestRequestTypeDef definition
class DeleteCustomModelRequestRequestTypeDef(TypedDict):
modelIdentifier: str,
DeleteGuardrailRequestRequestTypeDef#
# DeleteGuardrailRequestRequestTypeDef definition
class DeleteGuardrailRequestRequestTypeDef(TypedDict):
guardrailIdentifier: str,
guardrailVersion: NotRequired[str],
DeleteProvisionedModelThroughputRequestRequestTypeDef#
# DeleteProvisionedModelThroughputRequestRequestTypeDef definition
class DeleteProvisionedModelThroughputRequestRequestTypeDef(TypedDict):
provisionedModelId: str,
EvaluationBedrockModelTypeDef#
# EvaluationBedrockModelTypeDef definition
class EvaluationBedrockModelTypeDef(TypedDict):
modelIdentifier: str,
inferenceParams: str,
EvaluationDatasetLocationTypeDef#
# EvaluationDatasetLocationTypeDef definition
class EvaluationDatasetLocationTypeDef(TypedDict):
s3Uri: NotRequired[str],
EvaluationSummaryTypeDef#
# EvaluationSummaryTypeDef definition
class EvaluationSummaryTypeDef(TypedDict):
jobArn: str,
jobName: str,
status: EvaluationJobStatusType, # (1)
creationTime: datetime,
jobType: EvaluationJobTypeType, # (2)
evaluationTaskTypes: List[EvaluationTaskTypeType], # (3)
modelIdentifiers: List[str],
FoundationModelLifecycleTypeDef#
# FoundationModelLifecycleTypeDef definition
class FoundationModelLifecycleTypeDef(TypedDict):
status: FoundationModelLifecycleStatusType, # (1)
GetCustomModelRequestRequestTypeDef#
# GetCustomModelRequestRequestTypeDef definition
class GetCustomModelRequestRequestTypeDef(TypedDict):
modelIdentifier: str,
TrainingMetricsTypeDef#
# TrainingMetricsTypeDef definition
class TrainingMetricsTypeDef(TypedDict):
trainingLoss: NotRequired[float],
ValidatorMetricTypeDef#
# ValidatorMetricTypeDef definition
class ValidatorMetricTypeDef(TypedDict):
validationLoss: NotRequired[float],
GetEvaluationJobRequestRequestTypeDef#
# GetEvaluationJobRequestRequestTypeDef definition
class GetEvaluationJobRequestRequestTypeDef(TypedDict):
jobIdentifier: str,
GetFoundationModelRequestRequestTypeDef#
# GetFoundationModelRequestRequestTypeDef definition
class GetFoundationModelRequestRequestTypeDef(TypedDict):
modelIdentifier: str,
GetGuardrailRequestRequestTypeDef#
# GetGuardrailRequestRequestTypeDef definition
class GetGuardrailRequestRequestTypeDef(TypedDict):
guardrailIdentifier: str,
guardrailVersion: NotRequired[str],
GetModelCustomizationJobRequestRequestTypeDef#
# GetModelCustomizationJobRequestRequestTypeDef definition
class GetModelCustomizationJobRequestRequestTypeDef(TypedDict):
jobIdentifier: str,
VpcConfigOutputTypeDef#
# VpcConfigOutputTypeDef definition
class VpcConfigOutputTypeDef(TypedDict):
subnetIds: List[str],
securityGroupIds: List[str],
GetProvisionedModelThroughputRequestRequestTypeDef#
# GetProvisionedModelThroughputRequestRequestTypeDef definition
class GetProvisionedModelThroughputRequestRequestTypeDef(TypedDict):
provisionedModelId: str,
GuardrailContentFilterConfigTypeDef#
# GuardrailContentFilterConfigTypeDef definition
class GuardrailContentFilterConfigTypeDef(TypedDict):
type: GuardrailContentFilterTypeType, # (1)
inputStrength: GuardrailFilterStrengthType, # (2)
outputStrength: GuardrailFilterStrengthType, # (2)
GuardrailContentFilterTypeDef#
# GuardrailContentFilterTypeDef definition
class GuardrailContentFilterTypeDef(TypedDict):
type: GuardrailContentFilterTypeType, # (1)
inputStrength: GuardrailFilterStrengthType, # (2)
outputStrength: GuardrailFilterStrengthType, # (2)
GuardrailManagedWordsConfigTypeDef#
# GuardrailManagedWordsConfigTypeDef definition
class GuardrailManagedWordsConfigTypeDef(TypedDict):
type: GuardrailManagedWordsTypeType, # (1)
GuardrailManagedWordsTypeDef#
# GuardrailManagedWordsTypeDef definition
class GuardrailManagedWordsTypeDef(TypedDict):
type: GuardrailManagedWordsTypeType, # (1)
GuardrailPiiEntityConfigTypeDef#
# GuardrailPiiEntityConfigTypeDef definition
class GuardrailPiiEntityConfigTypeDef(TypedDict):
type: GuardrailPiiEntityTypeType, # (1)
action: GuardrailSensitiveInformationActionType, # (2)
GuardrailPiiEntityTypeDef#
# GuardrailPiiEntityTypeDef definition
class GuardrailPiiEntityTypeDef(TypedDict):
type: GuardrailPiiEntityTypeType, # (1)
action: GuardrailSensitiveInformationActionType, # (2)
GuardrailRegexConfigTypeDef#
# GuardrailRegexConfigTypeDef definition
class GuardrailRegexConfigTypeDef(TypedDict):
name: str,
pattern: str,
action: GuardrailSensitiveInformationActionType, # (1)
description: NotRequired[str],
GuardrailRegexTypeDef#
# GuardrailRegexTypeDef definition
class GuardrailRegexTypeDef(TypedDict):
name: str,
pattern: str,
action: GuardrailSensitiveInformationActionType, # (1)
description: NotRequired[str],
GuardrailSummaryTypeDef#
# GuardrailSummaryTypeDef definition
class GuardrailSummaryTypeDef(TypedDict):
id: str,
arn: str,
status: GuardrailStatusType, # (1)
name: str,
version: str,
createdAt: datetime,
updatedAt: datetime,
description: NotRequired[str],
GuardrailTopicConfigTypeDef#
# GuardrailTopicConfigTypeDef definition
class GuardrailTopicConfigTypeDef(TypedDict):
name: str,
definition: str,
type: GuardrailTopicTypeType, # (1)
examples: NotRequired[Sequence[str]],
GuardrailTopicTypeDef#
# GuardrailTopicTypeDef definition
class GuardrailTopicTypeDef(TypedDict):
name: str,
definition: str,
examples: NotRequired[List[str]],
type: NotRequired[GuardrailTopicTypeType], # (1)
GuardrailWordConfigTypeDef#
# GuardrailWordConfigTypeDef definition
class GuardrailWordConfigTypeDef(TypedDict):
text: str,
GuardrailWordTypeDef#
# GuardrailWordTypeDef definition
class GuardrailWordTypeDef(TypedDict):
text: str,
HumanEvaluationCustomMetricTypeDef#
# HumanEvaluationCustomMetricTypeDef definition
class HumanEvaluationCustomMetricTypeDef(TypedDict):
name: str,
ratingMethod: str,
description: NotRequired[str],
HumanWorkflowConfigTypeDef#
# HumanWorkflowConfigTypeDef definition
class HumanWorkflowConfigTypeDef(TypedDict):
flowDefinitionArn: str,
instructions: NotRequired[str],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListFoundationModelsRequestRequestTypeDef#
# ListFoundationModelsRequestRequestTypeDef definition
class ListFoundationModelsRequestRequestTypeDef(TypedDict):
byProvider: NotRequired[str],
byCustomizationType: NotRequired[ModelCustomizationType], # (1)
byOutputModality: NotRequired[ModelModalityType], # (2)
byInferenceType: NotRequired[InferenceTypeType], # (3)
- See ModelCustomizationType
- See ModelModalityType
- See InferenceTypeType
ListGuardrailsRequestRequestTypeDef#
# ListGuardrailsRequestRequestTypeDef definition
class ListGuardrailsRequestRequestTypeDef(TypedDict):
guardrailIdentifier: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ModelCustomizationJobSummaryTypeDef#
# ModelCustomizationJobSummaryTypeDef definition
class ModelCustomizationJobSummaryTypeDef(TypedDict):
jobArn: str,
baseModelArn: str,
jobName: str,
status: ModelCustomizationJobStatusType, # (1)
creationTime: datetime,
lastModifiedTime: NotRequired[datetime],
endTime: NotRequired[datetime],
customModelArn: NotRequired[str],
customModelName: NotRequired[str],
customizationType: NotRequired[CustomizationTypeType], # (2)
ProvisionedModelSummaryTypeDef#
# ProvisionedModelSummaryTypeDef definition
class ProvisionedModelSummaryTypeDef(TypedDict):
provisionedModelName: str,
provisionedModelArn: str,
modelArn: str,
desiredModelArn: str,
foundationModelArn: str,
modelUnits: int,
desiredModelUnits: int,
status: ProvisionedModelStatusType, # (1)
creationTime: datetime,
lastModifiedTime: datetime,
commitmentDuration: NotRequired[CommitmentDurationType], # (2)
commitmentExpirationTime: NotRequired[datetime],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceARN: str,
StopEvaluationJobRequestRequestTypeDef#
# StopEvaluationJobRequestRequestTypeDef definition
class StopEvaluationJobRequestRequestTypeDef(TypedDict):
jobIdentifier: str,
StopModelCustomizationJobRequestRequestTypeDef#
# StopModelCustomizationJobRequestRequestTypeDef definition
class StopModelCustomizationJobRequestRequestTypeDef(TypedDict):
jobIdentifier: str,
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceARN: str,
tagKeys: Sequence[str],
UpdateProvisionedModelThroughputRequestRequestTypeDef#
# UpdateProvisionedModelThroughputRequestRequestTypeDef definition
class UpdateProvisionedModelThroughputRequestRequestTypeDef(TypedDict):
provisionedModelId: str,
desiredProvisionedModelName: NotRequired[str],
desiredModelId: NotRequired[str],
ValidatorTypeDef#
# ValidatorTypeDef definition
class ValidatorTypeDef(TypedDict):
s3Uri: str,
CloudWatchConfigTypeDef#
# CloudWatchConfigTypeDef definition
class CloudWatchConfigTypeDef(TypedDict):
logGroupName: str,
roleArn: str,
largeDataDeliveryS3Config: NotRequired[S3ConfigTypeDef], # (1)
- See S3ConfigTypeDef
CreateProvisionedModelThroughputRequestRequestTypeDef#
# CreateProvisionedModelThroughputRequestRequestTypeDef definition
class CreateProvisionedModelThroughputRequestRequestTypeDef(TypedDict):
modelUnits: int,
provisionedModelName: str,
modelId: str,
clientRequestToken: NotRequired[str],
commitmentDuration: NotRequired[CommitmentDurationType], # (1)
tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See CommitmentDurationType
- See TagTypeDef
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceARN: str,
tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateEvaluationJobResponseTypeDef#
# CreateEvaluationJobResponseTypeDef definition
class CreateEvaluationJobResponseTypeDef(TypedDict):
jobArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateGuardrailResponseTypeDef#
# CreateGuardrailResponseTypeDef definition
class CreateGuardrailResponseTypeDef(TypedDict):
guardrailId: str,
guardrailArn: str,
version: str,
createdAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateGuardrailVersionResponseTypeDef#
# CreateGuardrailVersionResponseTypeDef definition
class CreateGuardrailVersionResponseTypeDef(TypedDict):
guardrailId: str,
version: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateModelCustomizationJobResponseTypeDef#
# CreateModelCustomizationJobResponseTypeDef definition
class CreateModelCustomizationJobResponseTypeDef(TypedDict):
jobArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateProvisionedModelThroughputResponseTypeDef#
# CreateProvisionedModelThroughputResponseTypeDef definition
class CreateProvisionedModelThroughputResponseTypeDef(TypedDict):
provisionedModelArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetProvisionedModelThroughputResponseTypeDef#
# GetProvisionedModelThroughputResponseTypeDef definition
class GetProvisionedModelThroughputResponseTypeDef(TypedDict):
modelUnits: int,
desiredModelUnits: int,
provisionedModelName: str,
provisionedModelArn: str,
modelArn: str,
desiredModelArn: str,
foundationModelArn: str,
status: ProvisionedModelStatusType, # (1)
creationTime: datetime,
lastModifiedTime: datetime,
failureMessage: str,
commitmentDuration: CommitmentDurationType, # (2)
commitmentExpirationTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
UpdateGuardrailResponseTypeDef#
# UpdateGuardrailResponseTypeDef definition
class UpdateGuardrailResponseTypeDef(TypedDict):
guardrailId: str,
guardrailArn: str,
version: str,
updatedAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListCustomModelsResponseTypeDef#
# ListCustomModelsResponseTypeDef definition
class ListCustomModelsResponseTypeDef(TypedDict):
nextToken: str,
modelSummaries: List[CustomModelSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
EvaluationModelConfigTypeDef#
# EvaluationModelConfigTypeDef definition
class EvaluationModelConfigTypeDef(TypedDict):
bedrockModel: NotRequired[EvaluationBedrockModelTypeDef], # (1)
EvaluationDatasetTypeDef#
# EvaluationDatasetTypeDef definition
class EvaluationDatasetTypeDef(TypedDict):
name: str,
datasetLocation: NotRequired[EvaluationDatasetLocationTypeDef], # (1)
ListEvaluationJobsResponseTypeDef#
# ListEvaluationJobsResponseTypeDef definition
class ListEvaluationJobsResponseTypeDef(TypedDict):
nextToken: str,
jobSummaries: List[EvaluationSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
FoundationModelDetailsTypeDef#
# FoundationModelDetailsTypeDef definition
class FoundationModelDetailsTypeDef(TypedDict):
modelArn: str,
modelId: str,
modelName: NotRequired[str],
providerName: NotRequired[str],
inputModalities: NotRequired[List[ModelModalityType]], # (1)
outputModalities: NotRequired[List[ModelModalityType]], # (1)
responseStreamingSupported: NotRequired[bool],
customizationsSupported: NotRequired[List[ModelCustomizationType]], # (3)
inferenceTypesSupported: NotRequired[List[InferenceTypeType]], # (4)
modelLifecycle: NotRequired[FoundationModelLifecycleTypeDef], # (5)
- See ModelModalityType
- See ModelModalityType
- See ModelCustomizationType
- See InferenceTypeType
- See FoundationModelLifecycleTypeDef
FoundationModelSummaryTypeDef#
# FoundationModelSummaryTypeDef definition
class FoundationModelSummaryTypeDef(TypedDict):
modelArn: str,
modelId: str,
modelName: NotRequired[str],
providerName: NotRequired[str],
inputModalities: NotRequired[List[ModelModalityType]], # (1)
outputModalities: NotRequired[List[ModelModalityType]], # (1)
responseStreamingSupported: NotRequired[bool],
customizationsSupported: NotRequired[List[ModelCustomizationType]], # (3)
inferenceTypesSupported: NotRequired[List[InferenceTypeType]], # (4)
modelLifecycle: NotRequired[FoundationModelLifecycleTypeDef], # (5)
- See ModelModalityType
- See ModelModalityType
- See ModelCustomizationType
- See InferenceTypeType
- See FoundationModelLifecycleTypeDef
GuardrailContentPolicyConfigTypeDef#
# GuardrailContentPolicyConfigTypeDef definition
class GuardrailContentPolicyConfigTypeDef(TypedDict):
filtersConfig: Sequence[GuardrailContentFilterConfigTypeDef], # (1)
GuardrailContentPolicyTypeDef#
# GuardrailContentPolicyTypeDef definition
class GuardrailContentPolicyTypeDef(TypedDict):
filters: NotRequired[List[GuardrailContentFilterTypeDef]], # (1)
GuardrailSensitiveInformationPolicyConfigTypeDef#
# GuardrailSensitiveInformationPolicyConfigTypeDef definition
class GuardrailSensitiveInformationPolicyConfigTypeDef(TypedDict):
piiEntitiesConfig: NotRequired[Sequence[GuardrailPiiEntityConfigTypeDef]], # (1)
regexesConfig: NotRequired[Sequence[GuardrailRegexConfigTypeDef]], # (2)
GuardrailSensitiveInformationPolicyTypeDef#
# GuardrailSensitiveInformationPolicyTypeDef definition
class GuardrailSensitiveInformationPolicyTypeDef(TypedDict):
piiEntities: NotRequired[List[GuardrailPiiEntityTypeDef]], # (1)
regexes: NotRequired[List[GuardrailRegexTypeDef]], # (2)
ListGuardrailsResponseTypeDef#
# ListGuardrailsResponseTypeDef definition
class ListGuardrailsResponseTypeDef(TypedDict):
guardrails: List[GuardrailSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GuardrailTopicPolicyConfigTypeDef#
# GuardrailTopicPolicyConfigTypeDef definition
class GuardrailTopicPolicyConfigTypeDef(TypedDict):
topicsConfig: Sequence[GuardrailTopicConfigTypeDef], # (1)
GuardrailTopicPolicyTypeDef#
# GuardrailTopicPolicyTypeDef definition
class GuardrailTopicPolicyTypeDef(TypedDict):
topics: List[GuardrailTopicTypeDef], # (1)
GuardrailWordPolicyConfigTypeDef#
# GuardrailWordPolicyConfigTypeDef definition
class GuardrailWordPolicyConfigTypeDef(TypedDict):
wordsConfig: NotRequired[Sequence[GuardrailWordConfigTypeDef]], # (1)
managedWordListsConfig: NotRequired[Sequence[GuardrailManagedWordsConfigTypeDef]], # (2)
GuardrailWordPolicyTypeDef#
# GuardrailWordPolicyTypeDef definition
class GuardrailWordPolicyTypeDef(TypedDict):
words: NotRequired[List[GuardrailWordTypeDef]], # (1)
managedWordLists: NotRequired[List[GuardrailManagedWordsTypeDef]], # (2)
ListGuardrailsRequestListGuardrailsPaginateTypeDef#
# ListGuardrailsRequestListGuardrailsPaginateTypeDef definition
class ListGuardrailsRequestListGuardrailsPaginateTypeDef(TypedDict):
guardrailIdentifier: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListCustomModelsRequestListCustomModelsPaginateTypeDef#
# ListCustomModelsRequestListCustomModelsPaginateTypeDef definition
class ListCustomModelsRequestListCustomModelsPaginateTypeDef(TypedDict):
creationTimeBefore: NotRequired[Union[datetime, str]],
creationTimeAfter: NotRequired[Union[datetime, str]],
nameContains: NotRequired[str],
baseModelArnEquals: NotRequired[str],
foundationModelArnEquals: NotRequired[str],
sortBy: NotRequired[SortModelsByType], # (1)
sortOrder: NotRequired[SortOrderType], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
- See SortModelsByType
- See SortOrderType
- See PaginatorConfigTypeDef
ListCustomModelsRequestRequestTypeDef#
# ListCustomModelsRequestRequestTypeDef definition
class ListCustomModelsRequestRequestTypeDef(TypedDict):
creationTimeBefore: NotRequired[Union[datetime, str]],
creationTimeAfter: NotRequired[Union[datetime, str]],
nameContains: NotRequired[str],
baseModelArnEquals: NotRequired[str],
foundationModelArnEquals: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
sortBy: NotRequired[SortModelsByType], # (1)
sortOrder: NotRequired[SortOrderType], # (2)
- See SortModelsByType
- See SortOrderType
ListEvaluationJobsRequestListEvaluationJobsPaginateTypeDef#
# ListEvaluationJobsRequestListEvaluationJobsPaginateTypeDef definition
class ListEvaluationJobsRequestListEvaluationJobsPaginateTypeDef(TypedDict):
creationTimeAfter: NotRequired[Union[datetime, str]],
creationTimeBefore: NotRequired[Union[datetime, str]],
statusEquals: NotRequired[EvaluationJobStatusType], # (1)
nameContains: NotRequired[str],
sortBy: NotRequired[SortJobsByType], # (2)
sortOrder: NotRequired[SortOrderType], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)
- See EvaluationJobStatusType
- See SortJobsByType
- See SortOrderType
- See PaginatorConfigTypeDef
ListEvaluationJobsRequestRequestTypeDef#
# ListEvaluationJobsRequestRequestTypeDef definition
class ListEvaluationJobsRequestRequestTypeDef(TypedDict):
creationTimeAfter: NotRequired[Union[datetime, str]],
creationTimeBefore: NotRequired[Union[datetime, str]],
statusEquals: NotRequired[EvaluationJobStatusType], # (1)
nameContains: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
sortBy: NotRequired[SortJobsByType], # (2)
sortOrder: NotRequired[SortOrderType], # (3)
- See EvaluationJobStatusType
- See SortJobsByType
- See SortOrderType
ListModelCustomizationJobsRequestListModelCustomizationJobsPaginateTypeDef#
# ListModelCustomizationJobsRequestListModelCustomizationJobsPaginateTypeDef definition
class ListModelCustomizationJobsRequestListModelCustomizationJobsPaginateTypeDef(TypedDict):
creationTimeAfter: NotRequired[Union[datetime, str]],
creationTimeBefore: NotRequired[Union[datetime, str]],
statusEquals: NotRequired[FineTuningJobStatusType], # (1)
nameContains: NotRequired[str],
sortBy: NotRequired[SortJobsByType], # (2)
sortOrder: NotRequired[SortOrderType], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)
- See FineTuningJobStatusType
- See SortJobsByType
- See SortOrderType
- See PaginatorConfigTypeDef
ListModelCustomizationJobsRequestRequestTypeDef#
# ListModelCustomizationJobsRequestRequestTypeDef definition
class ListModelCustomizationJobsRequestRequestTypeDef(TypedDict):
creationTimeAfter: NotRequired[Union[datetime, str]],
creationTimeBefore: NotRequired[Union[datetime, str]],
statusEquals: NotRequired[FineTuningJobStatusType], # (1)
nameContains: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
sortBy: NotRequired[SortJobsByType], # (2)
sortOrder: NotRequired[SortOrderType], # (3)
- See FineTuningJobStatusType
- See SortJobsByType
- See SortOrderType
ListProvisionedModelThroughputsRequestListProvisionedModelThroughputsPaginateTypeDef#
# ListProvisionedModelThroughputsRequestListProvisionedModelThroughputsPaginateTypeDef definition
class ListProvisionedModelThroughputsRequestListProvisionedModelThroughputsPaginateTypeDef(TypedDict):
creationTimeAfter: NotRequired[Union[datetime, str]],
creationTimeBefore: NotRequired[Union[datetime, str]],
statusEquals: NotRequired[ProvisionedModelStatusType], # (1)
modelArnEquals: NotRequired[str],
nameContains: NotRequired[str],
sortBy: NotRequired[SortByProvisionedModelsType], # (2)
sortOrder: NotRequired[SortOrderType], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)
- See ProvisionedModelStatusType
- See SortByProvisionedModelsType
- See SortOrderType
- See PaginatorConfigTypeDef
ListProvisionedModelThroughputsRequestRequestTypeDef#
# ListProvisionedModelThroughputsRequestRequestTypeDef definition
class ListProvisionedModelThroughputsRequestRequestTypeDef(TypedDict):
creationTimeAfter: NotRequired[Union[datetime, str]],
creationTimeBefore: NotRequired[Union[datetime, str]],
statusEquals: NotRequired[ProvisionedModelStatusType], # (1)
modelArnEquals: NotRequired[str],
nameContains: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
sortBy: NotRequired[SortByProvisionedModelsType], # (2)
sortOrder: NotRequired[SortOrderType], # (3)
ListModelCustomizationJobsResponseTypeDef#
# ListModelCustomizationJobsResponseTypeDef definition
class ListModelCustomizationJobsResponseTypeDef(TypedDict):
nextToken: str,
modelCustomizationJobSummaries: List[ModelCustomizationJobSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListProvisionedModelThroughputsResponseTypeDef#
# ListProvisionedModelThroughputsResponseTypeDef definition
class ListProvisionedModelThroughputsResponseTypeDef(TypedDict):
nextToken: str,
provisionedModelSummaries: List[ProvisionedModelSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ValidationDataConfigOutputTypeDef#
# ValidationDataConfigOutputTypeDef definition
class ValidationDataConfigOutputTypeDef(TypedDict):
validators: List[ValidatorTypeDef], # (1)
- See ValidatorTypeDef
ValidationDataConfigTypeDef#
# ValidationDataConfigTypeDef definition
class ValidationDataConfigTypeDef(TypedDict):
validators: Sequence[ValidatorTypeDef], # (1)
- See ValidatorTypeDef
LoggingConfigTypeDef#
# LoggingConfigTypeDef definition
class LoggingConfigTypeDef(TypedDict):
cloudWatchConfig: NotRequired[CloudWatchConfigTypeDef], # (1)
s3Config: NotRequired[S3ConfigTypeDef], # (2)
textDataDeliveryEnabled: NotRequired[bool],
imageDataDeliveryEnabled: NotRequired[bool],
embeddingDataDeliveryEnabled: NotRequired[bool],
EvaluationInferenceConfigOutputTypeDef#
# EvaluationInferenceConfigOutputTypeDef definition
class EvaluationInferenceConfigOutputTypeDef(TypedDict):
models: NotRequired[List[EvaluationModelConfigTypeDef]], # (1)
EvaluationInferenceConfigTypeDef#
# EvaluationInferenceConfigTypeDef definition
class EvaluationInferenceConfigTypeDef(TypedDict):
models: NotRequired[Sequence[EvaluationModelConfigTypeDef]], # (1)
EvaluationDatasetMetricConfigOutputTypeDef#
# EvaluationDatasetMetricConfigOutputTypeDef definition
class EvaluationDatasetMetricConfigOutputTypeDef(TypedDict):
taskType: EvaluationTaskTypeType, # (1)
dataset: EvaluationDatasetTypeDef, # (2)
metricNames: List[str],
EvaluationDatasetMetricConfigTypeDef#
# EvaluationDatasetMetricConfigTypeDef definition
class EvaluationDatasetMetricConfigTypeDef(TypedDict):
taskType: EvaluationTaskTypeType, # (1)
dataset: EvaluationDatasetTypeDef, # (2)
metricNames: Sequence[str],
GetFoundationModelResponseTypeDef#
# GetFoundationModelResponseTypeDef definition
class GetFoundationModelResponseTypeDef(TypedDict):
modelDetails: FoundationModelDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListFoundationModelsResponseTypeDef#
# ListFoundationModelsResponseTypeDef definition
class ListFoundationModelsResponseTypeDef(TypedDict):
modelSummaries: List[FoundationModelSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateGuardrailRequestRequestTypeDef#
# CreateGuardrailRequestRequestTypeDef definition
class CreateGuardrailRequestRequestTypeDef(TypedDict):
name: str,
blockedInputMessaging: str,
blockedOutputsMessaging: str,
description: NotRequired[str],
topicPolicyConfig: NotRequired[GuardrailTopicPolicyConfigTypeDef], # (1)
contentPolicyConfig: NotRequired[GuardrailContentPolicyConfigTypeDef], # (2)
wordPolicyConfig: NotRequired[GuardrailWordPolicyConfigTypeDef], # (3)
sensitiveInformationPolicyConfig: NotRequired[GuardrailSensitiveInformationPolicyConfigTypeDef], # (4)
kmsKeyId: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (5)
clientRequestToken: NotRequired[str],
- See GuardrailTopicPolicyConfigTypeDef
- See GuardrailContentPolicyConfigTypeDef
- See GuardrailWordPolicyConfigTypeDef
- See GuardrailSensitiveInformationPolicyConfigTypeDef
- See TagTypeDef
UpdateGuardrailRequestRequestTypeDef#
# UpdateGuardrailRequestRequestTypeDef definition
class UpdateGuardrailRequestRequestTypeDef(TypedDict):
guardrailIdentifier: str,
name: str,
blockedInputMessaging: str,
blockedOutputsMessaging: str,
description: NotRequired[str],
topicPolicyConfig: NotRequired[GuardrailTopicPolicyConfigTypeDef], # (1)
contentPolicyConfig: NotRequired[GuardrailContentPolicyConfigTypeDef], # (2)
wordPolicyConfig: NotRequired[GuardrailWordPolicyConfigTypeDef], # (3)
sensitiveInformationPolicyConfig: NotRequired[GuardrailSensitiveInformationPolicyConfigTypeDef], # (4)
kmsKeyId: NotRequired[str],
- See GuardrailTopicPolicyConfigTypeDef
- See GuardrailContentPolicyConfigTypeDef
- See GuardrailWordPolicyConfigTypeDef
- See GuardrailSensitiveInformationPolicyConfigTypeDef
GetGuardrailResponseTypeDef#
# GetGuardrailResponseTypeDef definition
class GetGuardrailResponseTypeDef(TypedDict):
name: str,
description: str,
guardrailId: str,
guardrailArn: str,
version: str,
status: GuardrailStatusType, # (1)
topicPolicy: GuardrailTopicPolicyTypeDef, # (2)
contentPolicy: GuardrailContentPolicyTypeDef, # (3)
wordPolicy: GuardrailWordPolicyTypeDef, # (4)
sensitiveInformationPolicy: GuardrailSensitiveInformationPolicyTypeDef, # (5)
createdAt: datetime,
updatedAt: datetime,
statusReasons: List[str],
failureRecommendations: List[str],
blockedInputMessaging: str,
blockedOutputsMessaging: str,
kmsKeyArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See GuardrailStatusType
- See GuardrailTopicPolicyTypeDef
- See GuardrailContentPolicyTypeDef
- See GuardrailWordPolicyTypeDef
- See GuardrailSensitiveInformationPolicyTypeDef
- See ResponseMetadataTypeDef
GetCustomModelResponseTypeDef#
# GetCustomModelResponseTypeDef definition
class GetCustomModelResponseTypeDef(TypedDict):
modelArn: str,
modelName: str,
jobName: str,
jobArn: str,
baseModelArn: str,
customizationType: CustomizationTypeType, # (1)
modelKmsKeyArn: str,
hyperParameters: Dict[str, str],
trainingDataConfig: TrainingDataConfigTypeDef, # (2)
validationDataConfig: ValidationDataConfigOutputTypeDef, # (3)
outputDataConfig: OutputDataConfigTypeDef, # (4)
trainingMetrics: TrainingMetricsTypeDef, # (5)
validationMetrics: List[ValidatorMetricTypeDef], # (6)
creationTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (7)
- See CustomizationTypeType
- See TrainingDataConfigTypeDef
- See ValidationDataConfigOutputTypeDef
- See OutputDataConfigTypeDef
- See TrainingMetricsTypeDef
- See ValidatorMetricTypeDef
- See ResponseMetadataTypeDef
GetModelCustomizationJobResponseTypeDef#
# GetModelCustomizationJobResponseTypeDef definition
class GetModelCustomizationJobResponseTypeDef(TypedDict):
jobArn: str,
jobName: str,
outputModelName: str,
outputModelArn: str,
clientRequestToken: str,
roleArn: str,
status: ModelCustomizationJobStatusType, # (1)
failureMessage: str,
creationTime: datetime,
lastModifiedTime: datetime,
endTime: datetime,
baseModelArn: str,
hyperParameters: Dict[str, str],
trainingDataConfig: TrainingDataConfigTypeDef, # (2)
validationDataConfig: ValidationDataConfigOutputTypeDef, # (3)
outputDataConfig: OutputDataConfigTypeDef, # (4)
customizationType: CustomizationTypeType, # (5)
outputModelKmsKeyArn: str,
trainingMetrics: TrainingMetricsTypeDef, # (6)
validationMetrics: List[ValidatorMetricTypeDef], # (7)
vpcConfig: VpcConfigOutputTypeDef, # (8)
ResponseMetadata: ResponseMetadataTypeDef, # (9)
- See ModelCustomizationJobStatusType
- See TrainingDataConfigTypeDef
- See ValidationDataConfigOutputTypeDef
- See OutputDataConfigTypeDef
- See CustomizationTypeType
- See TrainingMetricsTypeDef
- See ValidatorMetricTypeDef
- See VpcConfigOutputTypeDef
- See ResponseMetadataTypeDef
CreateModelCustomizationJobRequestRequestTypeDef#
# CreateModelCustomizationJobRequestRequestTypeDef definition
class CreateModelCustomizationJobRequestRequestTypeDef(TypedDict):
jobName: str,
customModelName: str,
roleArn: str,
baseModelIdentifier: str,
trainingDataConfig: TrainingDataConfigTypeDef, # (1)
outputDataConfig: OutputDataConfigTypeDef, # (2)
hyperParameters: Mapping[str, str],
clientRequestToken: NotRequired[str],
customizationType: NotRequired[CustomizationTypeType], # (3)
customModelKmsKeyId: NotRequired[str],
jobTags: NotRequired[Sequence[TagTypeDef]], # (4)
customModelTags: NotRequired[Sequence[TagTypeDef]], # (4)
validationDataConfig: NotRequired[ValidationDataConfigTypeDef], # (6)
vpcConfig: NotRequired[VpcConfigTypeDef], # (7)
- See TrainingDataConfigTypeDef
- See OutputDataConfigTypeDef
- See CustomizationTypeType
- See TagTypeDef
- See TagTypeDef
- See ValidationDataConfigTypeDef
- See VpcConfigTypeDef
GetModelInvocationLoggingConfigurationResponseTypeDef#
# GetModelInvocationLoggingConfigurationResponseTypeDef definition
class GetModelInvocationLoggingConfigurationResponseTypeDef(TypedDict):
loggingConfig: LoggingConfigTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutModelInvocationLoggingConfigurationRequestRequestTypeDef#
# PutModelInvocationLoggingConfigurationRequestRequestTypeDef definition
class PutModelInvocationLoggingConfigurationRequestRequestTypeDef(TypedDict):
loggingConfig: LoggingConfigTypeDef, # (1)
AutomatedEvaluationConfigOutputTypeDef#
# AutomatedEvaluationConfigOutputTypeDef definition
class AutomatedEvaluationConfigOutputTypeDef(TypedDict):
datasetMetricConfigs: List[EvaluationDatasetMetricConfigOutputTypeDef], # (1)
HumanEvaluationConfigOutputTypeDef#
# HumanEvaluationConfigOutputTypeDef definition
class HumanEvaluationConfigOutputTypeDef(TypedDict):
datasetMetricConfigs: List[EvaluationDatasetMetricConfigOutputTypeDef], # (3)
humanWorkflowConfig: NotRequired[HumanWorkflowConfigTypeDef], # (1)
customMetrics: NotRequired[List[HumanEvaluationCustomMetricTypeDef]], # (2)
- See HumanWorkflowConfigTypeDef
- See HumanEvaluationCustomMetricTypeDef
- See EvaluationDatasetMetricConfigOutputTypeDef
AutomatedEvaluationConfigTypeDef#
# AutomatedEvaluationConfigTypeDef definition
class AutomatedEvaluationConfigTypeDef(TypedDict):
datasetMetricConfigs: Sequence[EvaluationDatasetMetricConfigTypeDef], # (1)
HumanEvaluationConfigTypeDef#
# HumanEvaluationConfigTypeDef definition
class HumanEvaluationConfigTypeDef(TypedDict):
datasetMetricConfigs: Sequence[EvaluationDatasetMetricConfigTypeDef], # (3)
humanWorkflowConfig: NotRequired[HumanWorkflowConfigTypeDef], # (1)
customMetrics: NotRequired[Sequence[HumanEvaluationCustomMetricTypeDef]], # (2)
- See HumanWorkflowConfigTypeDef
- See HumanEvaluationCustomMetricTypeDef
- See EvaluationDatasetMetricConfigTypeDef
EvaluationConfigOutputTypeDef#
# EvaluationConfigOutputTypeDef definition
class EvaluationConfigOutputTypeDef(TypedDict):
automated: NotRequired[AutomatedEvaluationConfigOutputTypeDef], # (1)
human: NotRequired[HumanEvaluationConfigOutputTypeDef], # (2)
EvaluationConfigTypeDef#
# EvaluationConfigTypeDef definition
class EvaluationConfigTypeDef(TypedDict):
automated: NotRequired[AutomatedEvaluationConfigTypeDef], # (1)
human: NotRequired[HumanEvaluationConfigTypeDef], # (2)
GetEvaluationJobResponseTypeDef#
# GetEvaluationJobResponseTypeDef definition
class GetEvaluationJobResponseTypeDef(TypedDict):
jobName: str,
status: EvaluationJobStatusType, # (1)
jobArn: str,
jobDescription: str,
roleArn: str,
customerEncryptionKeyId: str,
jobType: EvaluationJobTypeType, # (2)
evaluationConfig: EvaluationConfigOutputTypeDef, # (3)
inferenceConfig: EvaluationInferenceConfigOutputTypeDef, # (4)
outputDataConfig: EvaluationOutputDataConfigTypeDef, # (5)
creationTime: datetime,
lastModifiedTime: datetime,
failureMessages: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (6)
- See EvaluationJobStatusType
- See EvaluationJobTypeType
- See EvaluationConfigOutputTypeDef
- See EvaluationInferenceConfigOutputTypeDef
- See EvaluationOutputDataConfigTypeDef
- See ResponseMetadataTypeDef
CreateEvaluationJobRequestRequestTypeDef#
# CreateEvaluationJobRequestRequestTypeDef definition
class CreateEvaluationJobRequestRequestTypeDef(TypedDict):
jobName: str,
roleArn: str,
evaluationConfig: EvaluationConfigTypeDef, # (1)
inferenceConfig: EvaluationInferenceConfigTypeDef, # (2)
outputDataConfig: EvaluationOutputDataConfigTypeDef, # (3)
jobDescription: NotRequired[str],
clientRequestToken: NotRequired[str],
customerEncryptionKeyId: NotRequired[str],
jobTags: NotRequired[Sequence[TagTypeDef]], # (4)