Skip to content

Type definitions#

Index > Bedrock > Type definitions

Auto-generated documentation for Bedrock type annotations stubs module mypy-boto3-bedrock.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

EvaluationDatasetMetricConfigUnionTypeDef#

# EvaluationDatasetMetricConfigUnionTypeDef definition

EvaluationDatasetMetricConfigUnionTypeDef = Union[
    EvaluationDatasetMetricConfigTypeDef,  # (1)
    EvaluationDatasetMetricConfigOutputTypeDef,  # (2)
]
  1. See EvaluationDatasetMetricConfigTypeDef
  2. See EvaluationDatasetMetricConfigOutputTypeDef

HumanEvaluationConfigUnionTypeDef#

# HumanEvaluationConfigUnionTypeDef definition

HumanEvaluationConfigUnionTypeDef = Union[
    HumanEvaluationConfigTypeDef,  # (1)
    HumanEvaluationConfigOutputTypeDef,  # (2)
]
  1. See HumanEvaluationConfigTypeDef
  2. See HumanEvaluationConfigOutputTypeDef

AutomatedEvaluationConfigUnionTypeDef#

# AutomatedEvaluationConfigUnionTypeDef definition

AutomatedEvaluationConfigUnionTypeDef = Union[
    AutomatedEvaluationConfigTypeDef,  # (1)
    AutomatedEvaluationConfigOutputTypeDef,  # (2)
]
  1. See AutomatedEvaluationConfigTypeDef
  2. See AutomatedEvaluationConfigOutputTypeDef

BatchDeleteEvaluationJobErrorTypeDef#

# BatchDeleteEvaluationJobErrorTypeDef definition

class BatchDeleteEvaluationJobErrorTypeDef(TypedDict):
    jobIdentifier: str,
    code: str,
    message: NotRequired[str],

BatchDeleteEvaluationJobItemTypeDef#

# BatchDeleteEvaluationJobItemTypeDef definition

class BatchDeleteEvaluationJobItemTypeDef(TypedDict):
    jobIdentifier: str,
    jobStatus: EvaluationJobStatusType,  # (1)
  1. See EvaluationJobStatusType

BatchDeleteEvaluationJobRequestRequestTypeDef#

# BatchDeleteEvaluationJobRequestRequestTypeDef definition

class BatchDeleteEvaluationJobRequestRequestTypeDef(TypedDict):
    jobIdentifiers: Sequence[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

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,

CreateGuardrailVersionRequestRequestTypeDef#

# CreateGuardrailVersionRequestRequestTypeDef definition

class CreateGuardrailVersionRequestRequestTypeDef(TypedDict):
    guardrailIdentifier: str,
    description: NotRequired[str],
    clientRequestToken: NotRequired[str],

InferenceProfileModelSourceTypeDef#

# InferenceProfileModelSourceTypeDef definition

class InferenceProfileModelSourceTypeDef(TypedDict):
    copyFrom: 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)
    ownerAccountId: NotRequired[str],
  1. See CustomizationTypeType

DeleteCustomModelRequestRequestTypeDef#

# DeleteCustomModelRequestRequestTypeDef definition

class DeleteCustomModelRequestRequestTypeDef(TypedDict):
    modelIdentifier: str,

DeleteGuardrailRequestRequestTypeDef#

# DeleteGuardrailRequestRequestTypeDef definition

class DeleteGuardrailRequestRequestTypeDef(TypedDict):
    guardrailIdentifier: str,
    guardrailVersion: NotRequired[str],

DeleteImportedModelRequestRequestTypeDef#

# DeleteImportedModelRequestRequestTypeDef definition

class DeleteImportedModelRequestRequestTypeDef(TypedDict):
    modelIdentifier: str,

DeleteInferenceProfileRequestRequestTypeDef#

# DeleteInferenceProfileRequestRequestTypeDef definition

class DeleteInferenceProfileRequestRequestTypeDef(TypedDict):
    inferenceProfileIdentifier: 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],
  1. See EvaluationJobStatusType
  2. See EvaluationJobTypeType
  3. See EvaluationTaskTypeType

FoundationModelLifecycleTypeDef#

# FoundationModelLifecycleTypeDef definition

class FoundationModelLifecycleTypeDef(TypedDict):
    status: FoundationModelLifecycleStatusType,  # (1)
  1. See FoundationModelLifecycleStatusType

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],

GetImportedModelRequestRequestTypeDef#

# GetImportedModelRequestRequestTypeDef definition

class GetImportedModelRequestRequestTypeDef(TypedDict):
    modelIdentifier: str,

GetInferenceProfileRequestRequestTypeDef#

# GetInferenceProfileRequestRequestTypeDef definition

class GetInferenceProfileRequestRequestTypeDef(TypedDict):
    inferenceProfileIdentifier: str,

InferenceProfileModelTypeDef#

# InferenceProfileModelTypeDef definition

class InferenceProfileModelTypeDef(TypedDict):
    modelArn: NotRequired[str],

GetModelCopyJobRequestRequestTypeDef#

# GetModelCopyJobRequestRequestTypeDef definition

class GetModelCopyJobRequestRequestTypeDef(TypedDict):
    jobArn: str,

GetModelCustomizationJobRequestRequestTypeDef#

# GetModelCustomizationJobRequestRequestTypeDef definition

class GetModelCustomizationJobRequestRequestTypeDef(TypedDict):
    jobIdentifier: str,

VpcConfigOutputTypeDef#

# VpcConfigOutputTypeDef definition

class VpcConfigOutputTypeDef(TypedDict):
    subnetIds: List[str],
    securityGroupIds: List[str],

GetModelImportJobRequestRequestTypeDef#

# GetModelImportJobRequestRequestTypeDef definition

class GetModelImportJobRequestRequestTypeDef(TypedDict):
    jobIdentifier: str,

GetModelInvocationJobRequestRequestTypeDef#

# GetModelInvocationJobRequestRequestTypeDef definition

class GetModelInvocationJobRequestRequestTypeDef(TypedDict):
    jobIdentifier: str,

GetProvisionedModelThroughputRequestRequestTypeDef#

# GetProvisionedModelThroughputRequestRequestTypeDef definition

class GetProvisionedModelThroughputRequestRequestTypeDef(TypedDict):
    provisionedModelId: str,

GuardrailContentFilterConfigTypeDef#

# GuardrailContentFilterConfigTypeDef definition

class GuardrailContentFilterConfigTypeDef(TypedDict):
    type: GuardrailContentFilterTypeType,  # (1)
    inputStrength: GuardrailFilterStrengthType,  # (2)
    outputStrength: GuardrailFilterStrengthType,  # (2)
  1. See GuardrailContentFilterTypeType
  2. See GuardrailFilterStrengthType
  3. See GuardrailFilterStrengthType

GuardrailContentFilterTypeDef#

# GuardrailContentFilterTypeDef definition

class GuardrailContentFilterTypeDef(TypedDict):
    type: GuardrailContentFilterTypeType,  # (1)
    inputStrength: GuardrailFilterStrengthType,  # (2)
    outputStrength: GuardrailFilterStrengthType,  # (2)
  1. See GuardrailContentFilterTypeType
  2. See GuardrailFilterStrengthType
  3. See GuardrailFilterStrengthType

GuardrailContextualGroundingFilterConfigTypeDef#

# GuardrailContextualGroundingFilterConfigTypeDef definition

class GuardrailContextualGroundingFilterConfigTypeDef(TypedDict):
    type: GuardrailContextualGroundingFilterTypeType,  # (1)
    threshold: float,
  1. See GuardrailContextualGroundingFilterTypeType

GuardrailContextualGroundingFilterTypeDef#

# GuardrailContextualGroundingFilterTypeDef definition

class GuardrailContextualGroundingFilterTypeDef(TypedDict):
    type: GuardrailContextualGroundingFilterTypeType,  # (1)
    threshold: float,
  1. See GuardrailContextualGroundingFilterTypeType

GuardrailManagedWordsConfigTypeDef#

# GuardrailManagedWordsConfigTypeDef definition

class GuardrailManagedWordsConfigTypeDef(TypedDict):
    type: GuardrailManagedWordsTypeType,  # (1)
  1. See GuardrailManagedWordsTypeType

GuardrailManagedWordsTypeDef#

# GuardrailManagedWordsTypeDef definition

class GuardrailManagedWordsTypeDef(TypedDict):
    type: GuardrailManagedWordsTypeType,  # (1)
  1. See GuardrailManagedWordsTypeType

GuardrailPiiEntityConfigTypeDef#

# GuardrailPiiEntityConfigTypeDef definition

class GuardrailPiiEntityConfigTypeDef(TypedDict):
    type: GuardrailPiiEntityTypeType,  # (1)
    action: GuardrailSensitiveInformationActionType,  # (2)
  1. See GuardrailPiiEntityTypeType
  2. See GuardrailSensitiveInformationActionType

GuardrailPiiEntityTypeDef#

# GuardrailPiiEntityTypeDef definition

class GuardrailPiiEntityTypeDef(TypedDict):
    type: GuardrailPiiEntityTypeType,  # (1)
    action: GuardrailSensitiveInformationActionType,  # (2)
  1. See GuardrailPiiEntityTypeType
  2. See GuardrailSensitiveInformationActionType

GuardrailRegexConfigTypeDef#

# GuardrailRegexConfigTypeDef definition

class GuardrailRegexConfigTypeDef(TypedDict):
    name: str,
    pattern: str,
    action: GuardrailSensitiveInformationActionType,  # (1)
    description: NotRequired[str],
  1. See GuardrailSensitiveInformationActionType

GuardrailRegexTypeDef#

# GuardrailRegexTypeDef definition

class GuardrailRegexTypeDef(TypedDict):
    name: str,
    pattern: str,
    action: GuardrailSensitiveInformationActionType,  # (1)
    description: NotRequired[str],
  1. See GuardrailSensitiveInformationActionType

GuardrailSummaryTypeDef#

# GuardrailSummaryTypeDef definition

class GuardrailSummaryTypeDef(TypedDict):
    id: str,
    arn: str,
    status: GuardrailStatusType,  # (1)
    name: str,
    version: str,
    createdAt: datetime,
    updatedAt: datetime,
    description: NotRequired[str],
  1. See GuardrailStatusType

GuardrailTopicConfigTypeDef#

# GuardrailTopicConfigTypeDef definition

class GuardrailTopicConfigTypeDef(TypedDict):
    name: str,
    definition: str,
    type: GuardrailTopicTypeType,  # (1)
    examples: NotRequired[Sequence[str]],
  1. See GuardrailTopicTypeType

GuardrailTopicTypeDef#

# GuardrailTopicTypeDef definition

class GuardrailTopicTypeDef(TypedDict):
    name: str,
    definition: str,
    examples: NotRequired[List[str]],
    type: NotRequired[GuardrailTopicTypeType],  # (1)
  1. See GuardrailTopicTypeType

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],

ImportedModelSummaryTypeDef#

# ImportedModelSummaryTypeDef definition

class ImportedModelSummaryTypeDef(TypedDict):
    modelArn: str,
    modelName: str,
    creationTime: datetime,
    instructSupported: NotRequired[bool],
    modelArchitecture: 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)
  1. See ModelCustomizationType
  2. See ModelModalityType
  3. See InferenceTypeType

ListGuardrailsRequestRequestTypeDef#

# ListGuardrailsRequestRequestTypeDef definition

class ListGuardrailsRequestRequestTypeDef(TypedDict):
    guardrailIdentifier: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListInferenceProfilesRequestRequestTypeDef#

# ListInferenceProfilesRequestRequestTypeDef definition

class ListInferenceProfilesRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    typeEquals: NotRequired[InferenceProfileTypeType],  # (1)
  1. See InferenceProfileTypeType

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)
  1. See ModelCustomizationJobStatusType
  2. See CustomizationTypeType

ModelImportJobSummaryTypeDef#

# ModelImportJobSummaryTypeDef definition

class ModelImportJobSummaryTypeDef(TypedDict):
    jobArn: str,
    jobName: str,
    status: ModelImportJobStatusType,  # (1)
    creationTime: datetime,
    lastModifiedTime: NotRequired[datetime],
    endTime: NotRequired[datetime],
    importedModelArn: NotRequired[str],
    importedModelName: NotRequired[str],
  1. See ModelImportJobStatusType

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],
  1. See ProvisionedModelStatusType
  2. See CommitmentDurationType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceARN: str,

S3DataSourceTypeDef#

# S3DataSourceTypeDef definition

class S3DataSourceTypeDef(TypedDict):
    s3Uri: str,

ModelInvocationJobS3InputDataConfigTypeDef#

# ModelInvocationJobS3InputDataConfigTypeDef definition

class ModelInvocationJobS3InputDataConfigTypeDef(TypedDict):
    s3Uri: str,
    s3InputFormat: NotRequired[S3InputFormatType],  # (1)
    s3BucketOwner: NotRequired[str],
  1. See S3InputFormatType

ModelInvocationJobS3OutputDataConfigTypeDef#

# ModelInvocationJobS3OutputDataConfigTypeDef definition

class ModelInvocationJobS3OutputDataConfigTypeDef(TypedDict):
    s3Uri: str,
    s3EncryptionKeyId: NotRequired[str],
    s3BucketOwner: NotRequired[str],

StopEvaluationJobRequestRequestTypeDef#

# StopEvaluationJobRequestRequestTypeDef definition

class StopEvaluationJobRequestRequestTypeDef(TypedDict):
    jobIdentifier: str,

StopModelCustomizationJobRequestRequestTypeDef#

# StopModelCustomizationJobRequestRequestTypeDef definition

class StopModelCustomizationJobRequestRequestTypeDef(TypedDict):
    jobIdentifier: str,

StopModelInvocationJobRequestRequestTypeDef#

# StopModelInvocationJobRequestRequestTypeDef definition

class StopModelInvocationJobRequestRequestTypeDef(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,

BatchDeleteEvaluationJobResponseTypeDef#

# BatchDeleteEvaluationJobResponseTypeDef definition

class BatchDeleteEvaluationJobResponseTypeDef(TypedDict):
    errors: List[BatchDeleteEvaluationJobErrorTypeDef],  # (1)
    evaluationJobs: List[BatchDeleteEvaluationJobItemTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See BatchDeleteEvaluationJobErrorTypeDef
  2. See BatchDeleteEvaluationJobItemTypeDef
  3. See ResponseMetadataTypeDef

CreateEvaluationJobResponseTypeDef#

# CreateEvaluationJobResponseTypeDef definition

class CreateEvaluationJobResponseTypeDef(TypedDict):
    jobArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateGuardrailResponseTypeDef#

# CreateGuardrailResponseTypeDef definition

class CreateGuardrailResponseTypeDef(TypedDict):
    guardrailId: str,
    guardrailArn: str,
    version: str,
    createdAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateGuardrailVersionResponseTypeDef#

# CreateGuardrailVersionResponseTypeDef definition

class CreateGuardrailVersionResponseTypeDef(TypedDict):
    guardrailId: str,
    version: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateInferenceProfileResponseTypeDef#

# CreateInferenceProfileResponseTypeDef definition

class CreateInferenceProfileResponseTypeDef(TypedDict):
    inferenceProfileArn: str,
    status: InferenceProfileStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InferenceProfileStatusType
  2. See ResponseMetadataTypeDef

CreateModelCopyJobResponseTypeDef#

# CreateModelCopyJobResponseTypeDef definition

class CreateModelCopyJobResponseTypeDef(TypedDict):
    jobArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateModelCustomizationJobResponseTypeDef#

# CreateModelCustomizationJobResponseTypeDef definition

class CreateModelCustomizationJobResponseTypeDef(TypedDict):
    jobArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateModelImportJobResponseTypeDef#

# CreateModelImportJobResponseTypeDef definition

class CreateModelImportJobResponseTypeDef(TypedDict):
    jobArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateModelInvocationJobResponseTypeDef#

# CreateModelInvocationJobResponseTypeDef definition

class CreateModelInvocationJobResponseTypeDef(TypedDict):
    jobArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateProvisionedModelThroughputResponseTypeDef#

# CreateProvisionedModelThroughputResponseTypeDef definition

class CreateProvisionedModelThroughputResponseTypeDef(TypedDict):
    provisionedModelArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

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)
  1. See ProvisionedModelStatusType
  2. See CommitmentDurationType
  3. See ResponseMetadataTypeDef

UpdateGuardrailResponseTypeDef#

# UpdateGuardrailResponseTypeDef definition

class UpdateGuardrailResponseTypeDef(TypedDict):
    guardrailId: str,
    guardrailArn: str,
    version: str,
    updatedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CloudWatchConfigTypeDef#

# CloudWatchConfigTypeDef definition

class CloudWatchConfigTypeDef(TypedDict):
    logGroupName: str,
    roleArn: str,
    largeDataDeliveryS3Config: NotRequired[S3ConfigTypeDef],  # (1)
  1. See S3ConfigTypeDef

CreateModelCopyJobRequestRequestTypeDef#

# CreateModelCopyJobRequestRequestTypeDef definition

class CreateModelCopyJobRequestRequestTypeDef(TypedDict):
    sourceModelArn: str,
    targetModelName: str,
    modelKmsKeyId: NotRequired[str],
    targetModelTags: NotRequired[Sequence[TagTypeDef]],  # (1)
    clientRequestToken: NotRequired[str],
  1. See TagTypeDef

CreateProvisionedModelThroughputRequestRequestTypeDef#

# CreateProvisionedModelThroughputRequestRequestTypeDef definition

class CreateProvisionedModelThroughputRequestRequestTypeDef(TypedDict):
    modelUnits: int,
    provisionedModelName: str,
    modelId: str,
    clientRequestToken: NotRequired[str],
    commitmentDuration: NotRequired[CommitmentDurationType],  # (1)
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See CommitmentDurationType
  2. See TagTypeDef

GetModelCopyJobResponseTypeDef#

# GetModelCopyJobResponseTypeDef definition

class GetModelCopyJobResponseTypeDef(TypedDict):
    jobArn: str,
    status: ModelCopyJobStatusType,  # (1)
    creationTime: datetime,
    targetModelArn: str,
    targetModelName: str,
    sourceAccountId: str,
    sourceModelArn: str,
    targetModelKmsKeyArn: str,
    targetModelTags: List[TagTypeDef],  # (2)
    failureMessage: str,
    sourceModelName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ModelCopyJobStatusType
  2. See TagTypeDef
  3. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

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

ModelCopyJobSummaryTypeDef#

# ModelCopyJobSummaryTypeDef definition

class ModelCopyJobSummaryTypeDef(TypedDict):
    jobArn: str,
    status: ModelCopyJobStatusType,  # (1)
    creationTime: datetime,
    targetModelArn: str,
    sourceAccountId: str,
    sourceModelArn: str,
    targetModelName: NotRequired[str],
    targetModelKmsKeyArn: NotRequired[str],
    targetModelTags: NotRequired[List[TagTypeDef]],  # (2)
    failureMessage: NotRequired[str],
    sourceModelName: NotRequired[str],
  1. See ModelCopyJobStatusType
  2. See TagTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceARN: str,
    tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateInferenceProfileRequestRequestTypeDef#

# CreateInferenceProfileRequestRequestTypeDef definition

class CreateInferenceProfileRequestRequestTypeDef(TypedDict):
    inferenceProfileName: str,
    modelSource: InferenceProfileModelSourceTypeDef,  # (1)
    description: NotRequired[str],
    clientRequestToken: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See InferenceProfileModelSourceTypeDef
  2. See TagTypeDef

ListCustomModelsResponseTypeDef#

# ListCustomModelsResponseTypeDef definition

class ListCustomModelsResponseTypeDef(TypedDict):
    modelSummaries: List[CustomModelSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See CustomModelSummaryTypeDef
  2. See ResponseMetadataTypeDef

EvaluationModelConfigTypeDef#

# EvaluationModelConfigTypeDef definition

class EvaluationModelConfigTypeDef(TypedDict):
    bedrockModel: NotRequired[EvaluationBedrockModelTypeDef],  # (1)
  1. See EvaluationBedrockModelTypeDef

EvaluationDatasetTypeDef#

# EvaluationDatasetTypeDef definition

class EvaluationDatasetTypeDef(TypedDict):
    name: str,
    datasetLocation: NotRequired[EvaluationDatasetLocationTypeDef],  # (1)
  1. See EvaluationDatasetLocationTypeDef

ListEvaluationJobsResponseTypeDef#

# ListEvaluationJobsResponseTypeDef definition

class ListEvaluationJobsResponseTypeDef(TypedDict):
    jobSummaries: List[EvaluationSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See EvaluationSummaryTypeDef
  2. See ResponseMetadataTypeDef

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)
  1. See ModelModalityType
  2. See ModelModalityType
  3. See ModelCustomizationType
  4. See InferenceTypeType
  5. 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)
  1. See ModelModalityType
  2. See ModelModalityType
  3. See ModelCustomizationType
  4. See InferenceTypeType
  5. See FoundationModelLifecycleTypeDef

GetInferenceProfileResponseTypeDef#

# GetInferenceProfileResponseTypeDef definition

class GetInferenceProfileResponseTypeDef(TypedDict):
    inferenceProfileName: str,
    description: str,
    createdAt: datetime,
    updatedAt: datetime,
    inferenceProfileArn: str,
    models: List[InferenceProfileModelTypeDef],  # (1)
    inferenceProfileId: str,
    status: InferenceProfileStatusType,  # (2)
    type: InferenceProfileTypeType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See InferenceProfileModelTypeDef
  2. See InferenceProfileStatusType
  3. See InferenceProfileTypeType
  4. See ResponseMetadataTypeDef

InferenceProfileSummaryTypeDef#

# InferenceProfileSummaryTypeDef definition

class InferenceProfileSummaryTypeDef(TypedDict):
    inferenceProfileName: str,
    inferenceProfileArn: str,
    models: List[InferenceProfileModelTypeDef],  # (1)
    inferenceProfileId: str,
    status: InferenceProfileStatusType,  # (2)
    type: InferenceProfileTypeType,  # (3)
    description: NotRequired[str],
    createdAt: NotRequired[datetime],
    updatedAt: NotRequired[datetime],
  1. See InferenceProfileModelTypeDef
  2. See InferenceProfileStatusType
  3. See InferenceProfileTypeType

GuardrailContentPolicyConfigTypeDef#

# GuardrailContentPolicyConfigTypeDef definition

class GuardrailContentPolicyConfigTypeDef(TypedDict):
    filtersConfig: Sequence[GuardrailContentFilterConfigTypeDef],  # (1)
  1. See GuardrailContentFilterConfigTypeDef

GuardrailContentPolicyTypeDef#

# GuardrailContentPolicyTypeDef definition

class GuardrailContentPolicyTypeDef(TypedDict):
    filters: NotRequired[List[GuardrailContentFilterTypeDef]],  # (1)
  1. See GuardrailContentFilterTypeDef

GuardrailContextualGroundingPolicyConfigTypeDef#

# GuardrailContextualGroundingPolicyConfigTypeDef definition

class GuardrailContextualGroundingPolicyConfigTypeDef(TypedDict):
    filtersConfig: Sequence[GuardrailContextualGroundingFilterConfigTypeDef],  # (1)
  1. See GuardrailContextualGroundingFilterConfigTypeDef

GuardrailContextualGroundingPolicyTypeDef#

# GuardrailContextualGroundingPolicyTypeDef definition

class GuardrailContextualGroundingPolicyTypeDef(TypedDict):
    filters: List[GuardrailContextualGroundingFilterTypeDef],  # (1)
  1. See GuardrailContextualGroundingFilterTypeDef

GuardrailSensitiveInformationPolicyConfigTypeDef#

# GuardrailSensitiveInformationPolicyConfigTypeDef definition

class GuardrailSensitiveInformationPolicyConfigTypeDef(TypedDict):
    piiEntitiesConfig: NotRequired[Sequence[GuardrailPiiEntityConfigTypeDef]],  # (1)
    regexesConfig: NotRequired[Sequence[GuardrailRegexConfigTypeDef]],  # (2)
  1. See GuardrailPiiEntityConfigTypeDef
  2. See GuardrailRegexConfigTypeDef

GuardrailSensitiveInformationPolicyTypeDef#

# GuardrailSensitiveInformationPolicyTypeDef definition

class GuardrailSensitiveInformationPolicyTypeDef(TypedDict):
    piiEntities: NotRequired[List[GuardrailPiiEntityTypeDef]],  # (1)
    regexes: NotRequired[List[GuardrailRegexTypeDef]],  # (2)
  1. See GuardrailPiiEntityTypeDef
  2. See GuardrailRegexTypeDef

ListGuardrailsResponseTypeDef#

# ListGuardrailsResponseTypeDef definition

class ListGuardrailsResponseTypeDef(TypedDict):
    guardrails: List[GuardrailSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See GuardrailSummaryTypeDef
  2. See ResponseMetadataTypeDef

GuardrailTopicPolicyConfigTypeDef#

# GuardrailTopicPolicyConfigTypeDef definition

class GuardrailTopicPolicyConfigTypeDef(TypedDict):
    topicsConfig: Sequence[GuardrailTopicConfigTypeDef],  # (1)
  1. See GuardrailTopicConfigTypeDef

GuardrailTopicPolicyTypeDef#

# GuardrailTopicPolicyTypeDef definition

class GuardrailTopicPolicyTypeDef(TypedDict):
    topics: List[GuardrailTopicTypeDef],  # (1)
  1. See GuardrailTopicTypeDef

GuardrailWordPolicyConfigTypeDef#

# GuardrailWordPolicyConfigTypeDef definition

class GuardrailWordPolicyConfigTypeDef(TypedDict):
    wordsConfig: NotRequired[Sequence[GuardrailWordConfigTypeDef]],  # (1)
    managedWordListsConfig: NotRequired[Sequence[GuardrailManagedWordsConfigTypeDef]],  # (2)
  1. See GuardrailWordConfigTypeDef
  2. See GuardrailManagedWordsConfigTypeDef

GuardrailWordPolicyTypeDef#

# GuardrailWordPolicyTypeDef definition

class GuardrailWordPolicyTypeDef(TypedDict):
    words: NotRequired[List[GuardrailWordTypeDef]],  # (1)
    managedWordLists: NotRequired[List[GuardrailManagedWordsTypeDef]],  # (2)
  1. See GuardrailWordTypeDef
  2. See GuardrailManagedWordsTypeDef

ListImportedModelsResponseTypeDef#

# ListImportedModelsResponseTypeDef definition

class ListImportedModelsResponseTypeDef(TypedDict):
    modelSummaries: List[ImportedModelSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ImportedModelSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListGuardrailsRequestListGuardrailsPaginateTypeDef#

# ListGuardrailsRequestListGuardrailsPaginateTypeDef definition

class ListGuardrailsRequestListGuardrailsPaginateTypeDef(TypedDict):
    guardrailIdentifier: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListInferenceProfilesRequestListInferenceProfilesPaginateTypeDef#

# ListInferenceProfilesRequestListInferenceProfilesPaginateTypeDef definition

class ListInferenceProfilesRequestListInferenceProfilesPaginateTypeDef(TypedDict):
    typeEquals: NotRequired[InferenceProfileTypeType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See InferenceProfileTypeType
  2. See PaginatorConfigTypeDef

ListCustomModelsRequestListCustomModelsPaginateTypeDef#

# ListCustomModelsRequestListCustomModelsPaginateTypeDef definition

class ListCustomModelsRequestListCustomModelsPaginateTypeDef(TypedDict):
    creationTimeBefore: NotRequired[TimestampTypeDef],
    creationTimeAfter: NotRequired[TimestampTypeDef],
    nameContains: NotRequired[str],
    baseModelArnEquals: NotRequired[str],
    foundationModelArnEquals: NotRequired[str],
    sortBy: NotRequired[SortModelsByType],  # (1)
    sortOrder: NotRequired[SortOrderType],  # (2)
    isOwned: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See SortModelsByType
  2. See SortOrderType
  3. See PaginatorConfigTypeDef

ListCustomModelsRequestRequestTypeDef#

# ListCustomModelsRequestRequestTypeDef definition

class ListCustomModelsRequestRequestTypeDef(TypedDict):
    creationTimeBefore: NotRequired[TimestampTypeDef],
    creationTimeAfter: NotRequired[TimestampTypeDef],
    nameContains: NotRequired[str],
    baseModelArnEquals: NotRequired[str],
    foundationModelArnEquals: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    sortBy: NotRequired[SortModelsByType],  # (1)
    sortOrder: NotRequired[SortOrderType],  # (2)
    isOwned: NotRequired[bool],
  1. See SortModelsByType
  2. See SortOrderType

ListEvaluationJobsRequestListEvaluationJobsPaginateTypeDef#

# ListEvaluationJobsRequestListEvaluationJobsPaginateTypeDef definition

class ListEvaluationJobsRequestListEvaluationJobsPaginateTypeDef(TypedDict):
    creationTimeAfter: NotRequired[TimestampTypeDef],
    creationTimeBefore: NotRequired[TimestampTypeDef],
    statusEquals: NotRequired[EvaluationJobStatusType],  # (1)
    nameContains: NotRequired[str],
    sortBy: NotRequired[SortJobsByType],  # (2)
    sortOrder: NotRequired[SortOrderType],  # (3)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (4)
  1. See EvaluationJobStatusType
  2. See SortJobsByType
  3. See SortOrderType
  4. See PaginatorConfigTypeDef

ListEvaluationJobsRequestRequestTypeDef#

# ListEvaluationJobsRequestRequestTypeDef definition

class ListEvaluationJobsRequestRequestTypeDef(TypedDict):
    creationTimeAfter: NotRequired[TimestampTypeDef],
    creationTimeBefore: NotRequired[TimestampTypeDef],
    statusEquals: NotRequired[EvaluationJobStatusType],  # (1)
    nameContains: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    sortBy: NotRequired[SortJobsByType],  # (2)
    sortOrder: NotRequired[SortOrderType],  # (3)
  1. See EvaluationJobStatusType
  2. See SortJobsByType
  3. See SortOrderType

ListImportedModelsRequestListImportedModelsPaginateTypeDef#

# ListImportedModelsRequestListImportedModelsPaginateTypeDef definition

class ListImportedModelsRequestListImportedModelsPaginateTypeDef(TypedDict):
    creationTimeBefore: NotRequired[TimestampTypeDef],
    creationTimeAfter: NotRequired[TimestampTypeDef],
    nameContains: NotRequired[str],
    sortBy: NotRequired[SortModelsByType],  # (1)
    sortOrder: NotRequired[SortOrderType],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See SortModelsByType
  2. See SortOrderType
  3. See PaginatorConfigTypeDef

ListImportedModelsRequestRequestTypeDef#

# ListImportedModelsRequestRequestTypeDef definition

class ListImportedModelsRequestRequestTypeDef(TypedDict):
    creationTimeBefore: NotRequired[TimestampTypeDef],
    creationTimeAfter: NotRequired[TimestampTypeDef],
    nameContains: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    sortBy: NotRequired[SortModelsByType],  # (1)
    sortOrder: NotRequired[SortOrderType],  # (2)
  1. See SortModelsByType
  2. See SortOrderType

ListModelCopyJobsRequestListModelCopyJobsPaginateTypeDef#

# ListModelCopyJobsRequestListModelCopyJobsPaginateTypeDef definition

class ListModelCopyJobsRequestListModelCopyJobsPaginateTypeDef(TypedDict):
    creationTimeAfter: NotRequired[TimestampTypeDef],
    creationTimeBefore: NotRequired[TimestampTypeDef],
    statusEquals: NotRequired[ModelCopyJobStatusType],  # (1)
    sourceAccountEquals: NotRequired[str],
    sourceModelArnEquals: NotRequired[str],
    targetModelNameContains: NotRequired[str],
    sortBy: NotRequired[SortJobsByType],  # (2)
    sortOrder: NotRequired[SortOrderType],  # (3)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (4)
  1. See ModelCopyJobStatusType
  2. See SortJobsByType
  3. See SortOrderType
  4. See PaginatorConfigTypeDef

ListModelCopyJobsRequestRequestTypeDef#

# ListModelCopyJobsRequestRequestTypeDef definition

class ListModelCopyJobsRequestRequestTypeDef(TypedDict):
    creationTimeAfter: NotRequired[TimestampTypeDef],
    creationTimeBefore: NotRequired[TimestampTypeDef],
    statusEquals: NotRequired[ModelCopyJobStatusType],  # (1)
    sourceAccountEquals: NotRequired[str],
    sourceModelArnEquals: NotRequired[str],
    targetModelNameContains: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    sortBy: NotRequired[SortJobsByType],  # (2)
    sortOrder: NotRequired[SortOrderType],  # (3)
  1. See ModelCopyJobStatusType
  2. See SortJobsByType
  3. See SortOrderType

ListModelCustomizationJobsRequestListModelCustomizationJobsPaginateTypeDef#

# ListModelCustomizationJobsRequestListModelCustomizationJobsPaginateTypeDef definition

class ListModelCustomizationJobsRequestListModelCustomizationJobsPaginateTypeDef(TypedDict):
    creationTimeAfter: NotRequired[TimestampTypeDef],
    creationTimeBefore: NotRequired[TimestampTypeDef],
    statusEquals: NotRequired[FineTuningJobStatusType],  # (1)
    nameContains: NotRequired[str],
    sortBy: NotRequired[SortJobsByType],  # (2)
    sortOrder: NotRequired[SortOrderType],  # (3)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (4)
  1. See FineTuningJobStatusType
  2. See SortJobsByType
  3. See SortOrderType
  4. See PaginatorConfigTypeDef

ListModelCustomizationJobsRequestRequestTypeDef#

# ListModelCustomizationJobsRequestRequestTypeDef definition

class ListModelCustomizationJobsRequestRequestTypeDef(TypedDict):
    creationTimeAfter: NotRequired[TimestampTypeDef],
    creationTimeBefore: NotRequired[TimestampTypeDef],
    statusEquals: NotRequired[FineTuningJobStatusType],  # (1)
    nameContains: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    sortBy: NotRequired[SortJobsByType],  # (2)
    sortOrder: NotRequired[SortOrderType],  # (3)
  1. See FineTuningJobStatusType
  2. See SortJobsByType
  3. See SortOrderType

ListModelImportJobsRequestListModelImportJobsPaginateTypeDef#

# ListModelImportJobsRequestListModelImportJobsPaginateTypeDef definition

class ListModelImportJobsRequestListModelImportJobsPaginateTypeDef(TypedDict):
    creationTimeAfter: NotRequired[TimestampTypeDef],
    creationTimeBefore: NotRequired[TimestampTypeDef],
    statusEquals: NotRequired[ModelImportJobStatusType],  # (1)
    nameContains: NotRequired[str],
    sortBy: NotRequired[SortJobsByType],  # (2)
    sortOrder: NotRequired[SortOrderType],  # (3)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (4)
  1. See ModelImportJobStatusType
  2. See SortJobsByType
  3. See SortOrderType
  4. See PaginatorConfigTypeDef

ListModelImportJobsRequestRequestTypeDef#

# ListModelImportJobsRequestRequestTypeDef definition

class ListModelImportJobsRequestRequestTypeDef(TypedDict):
    creationTimeAfter: NotRequired[TimestampTypeDef],
    creationTimeBefore: NotRequired[TimestampTypeDef],
    statusEquals: NotRequired[ModelImportJobStatusType],  # (1)
    nameContains: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    sortBy: NotRequired[SortJobsByType],  # (2)
    sortOrder: NotRequired[SortOrderType],  # (3)
  1. See ModelImportJobStatusType
  2. See SortJobsByType
  3. See SortOrderType

ListModelInvocationJobsRequestListModelInvocationJobsPaginateTypeDef#

# ListModelInvocationJobsRequestListModelInvocationJobsPaginateTypeDef definition

class ListModelInvocationJobsRequestListModelInvocationJobsPaginateTypeDef(TypedDict):
    submitTimeAfter: NotRequired[TimestampTypeDef],
    submitTimeBefore: NotRequired[TimestampTypeDef],
    statusEquals: NotRequired[ModelInvocationJobStatusType],  # (1)
    nameContains: NotRequired[str],
    sortBy: NotRequired[SortJobsByType],  # (2)
    sortOrder: NotRequired[SortOrderType],  # (3)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (4)
  1. See ModelInvocationJobStatusType
  2. See SortJobsByType
  3. See SortOrderType
  4. See PaginatorConfigTypeDef

ListModelInvocationJobsRequestRequestTypeDef#

# ListModelInvocationJobsRequestRequestTypeDef definition

class ListModelInvocationJobsRequestRequestTypeDef(TypedDict):
    submitTimeAfter: NotRequired[TimestampTypeDef],
    submitTimeBefore: NotRequired[TimestampTypeDef],
    statusEquals: NotRequired[ModelInvocationJobStatusType],  # (1)
    nameContains: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    sortBy: NotRequired[SortJobsByType],  # (2)
    sortOrder: NotRequired[SortOrderType],  # (3)
  1. See ModelInvocationJobStatusType
  2. See SortJobsByType
  3. See SortOrderType

ListProvisionedModelThroughputsRequestListProvisionedModelThroughputsPaginateTypeDef#

# ListProvisionedModelThroughputsRequestListProvisionedModelThroughputsPaginateTypeDef definition

class ListProvisionedModelThroughputsRequestListProvisionedModelThroughputsPaginateTypeDef(TypedDict):
    creationTimeAfter: NotRequired[TimestampTypeDef],
    creationTimeBefore: NotRequired[TimestampTypeDef],
    statusEquals: NotRequired[ProvisionedModelStatusType],  # (1)
    modelArnEquals: NotRequired[str],
    nameContains: NotRequired[str],
    sortBy: NotRequired[SortByProvisionedModelsType],  # (2)
    sortOrder: NotRequired[SortOrderType],  # (3)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (4)
  1. See ProvisionedModelStatusType
  2. See SortByProvisionedModelsType
  3. See SortOrderType
  4. See PaginatorConfigTypeDef

ListProvisionedModelThroughputsRequestRequestTypeDef#

# ListProvisionedModelThroughputsRequestRequestTypeDef definition

class ListProvisionedModelThroughputsRequestRequestTypeDef(TypedDict):
    creationTimeAfter: NotRequired[TimestampTypeDef],
    creationTimeBefore: NotRequired[TimestampTypeDef],
    statusEquals: NotRequired[ProvisionedModelStatusType],  # (1)
    modelArnEquals: NotRequired[str],
    nameContains: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    sortBy: NotRequired[SortByProvisionedModelsType],  # (2)
    sortOrder: NotRequired[SortOrderType],  # (3)
  1. See ProvisionedModelStatusType
  2. See SortByProvisionedModelsType
  3. See SortOrderType

ListModelCustomizationJobsResponseTypeDef#

# ListModelCustomizationJobsResponseTypeDef definition

class ListModelCustomizationJobsResponseTypeDef(TypedDict):
    modelCustomizationJobSummaries: List[ModelCustomizationJobSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ModelCustomizationJobSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListModelImportJobsResponseTypeDef#

# ListModelImportJobsResponseTypeDef definition

class ListModelImportJobsResponseTypeDef(TypedDict):
    modelImportJobSummaries: List[ModelImportJobSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ModelImportJobSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListProvisionedModelThroughputsResponseTypeDef#

# ListProvisionedModelThroughputsResponseTypeDef definition

class ListProvisionedModelThroughputsResponseTypeDef(TypedDict):
    provisionedModelSummaries: List[ProvisionedModelSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ProvisionedModelSummaryTypeDef
  2. See ResponseMetadataTypeDef

ModelDataSourceTypeDef#

# ModelDataSourceTypeDef definition

class ModelDataSourceTypeDef(TypedDict):
    s3DataSource: NotRequired[S3DataSourceTypeDef],  # (1)
  1. See S3DataSourceTypeDef

ModelInvocationJobInputDataConfigTypeDef#

# ModelInvocationJobInputDataConfigTypeDef definition

class ModelInvocationJobInputDataConfigTypeDef(TypedDict):
    s3InputDataConfig: NotRequired[ModelInvocationJobS3InputDataConfigTypeDef],  # (1)
  1. See ModelInvocationJobS3InputDataConfigTypeDef

ModelInvocationJobOutputDataConfigTypeDef#

# ModelInvocationJobOutputDataConfigTypeDef definition

class ModelInvocationJobOutputDataConfigTypeDef(TypedDict):
    s3OutputDataConfig: NotRequired[ModelInvocationJobS3OutputDataConfigTypeDef],  # (1)
  1. See ModelInvocationJobS3OutputDataConfigTypeDef

ValidationDataConfigOutputTypeDef#

# ValidationDataConfigOutputTypeDef definition

class ValidationDataConfigOutputTypeDef(TypedDict):
    validators: List[ValidatorTypeDef],  # (1)
  1. See ValidatorTypeDef

ValidationDataConfigTypeDef#

# ValidationDataConfigTypeDef definition

class ValidationDataConfigTypeDef(TypedDict):
    validators: Sequence[ValidatorTypeDef],  # (1)
  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],
  1. See CloudWatchConfigTypeDef
  2. See S3ConfigTypeDef

ListModelCopyJobsResponseTypeDef#

# ListModelCopyJobsResponseTypeDef definition

class ListModelCopyJobsResponseTypeDef(TypedDict):
    modelCopyJobSummaries: List[ModelCopyJobSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ModelCopyJobSummaryTypeDef
  2. See ResponseMetadataTypeDef

EvaluationInferenceConfigOutputTypeDef#

# EvaluationInferenceConfigOutputTypeDef definition

class EvaluationInferenceConfigOutputTypeDef(TypedDict):
    models: NotRequired[List[EvaluationModelConfigTypeDef]],  # (1)
  1. See EvaluationModelConfigTypeDef

EvaluationInferenceConfigTypeDef#

# EvaluationInferenceConfigTypeDef definition

class EvaluationInferenceConfigTypeDef(TypedDict):
    models: NotRequired[Sequence[EvaluationModelConfigTypeDef]],  # (1)
  1. See EvaluationModelConfigTypeDef

EvaluationDatasetMetricConfigOutputTypeDef#

# EvaluationDatasetMetricConfigOutputTypeDef definition

class EvaluationDatasetMetricConfigOutputTypeDef(TypedDict):
    taskType: EvaluationTaskTypeType,  # (1)
    dataset: EvaluationDatasetTypeDef,  # (2)
    metricNames: List[str],
  1. See EvaluationTaskTypeType
  2. See EvaluationDatasetTypeDef

EvaluationDatasetMetricConfigTypeDef#

# EvaluationDatasetMetricConfigTypeDef definition

class EvaluationDatasetMetricConfigTypeDef(TypedDict):
    taskType: EvaluationTaskTypeType,  # (1)
    dataset: EvaluationDatasetTypeDef,  # (2)
    metricNames: Sequence[str],
  1. See EvaluationTaskTypeType
  2. See EvaluationDatasetTypeDef

GetFoundationModelResponseTypeDef#

# GetFoundationModelResponseTypeDef definition

class GetFoundationModelResponseTypeDef(TypedDict):
    modelDetails: FoundationModelDetailsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FoundationModelDetailsTypeDef
  2. See ResponseMetadataTypeDef

ListFoundationModelsResponseTypeDef#

# ListFoundationModelsResponseTypeDef definition

class ListFoundationModelsResponseTypeDef(TypedDict):
    modelSummaries: List[FoundationModelSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FoundationModelSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListInferenceProfilesResponseTypeDef#

# ListInferenceProfilesResponseTypeDef definition

class ListInferenceProfilesResponseTypeDef(TypedDict):
    inferenceProfileSummaries: List[InferenceProfileSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See InferenceProfileSummaryTypeDef
  2. See ResponseMetadataTypeDef

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)
    contextualGroundingPolicyConfig: NotRequired[GuardrailContextualGroundingPolicyConfigTypeDef],  # (5)
    kmsKeyId: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (6)
    clientRequestToken: NotRequired[str],
  1. See GuardrailTopicPolicyConfigTypeDef
  2. See GuardrailContentPolicyConfigTypeDef
  3. See GuardrailWordPolicyConfigTypeDef
  4. See GuardrailSensitiveInformationPolicyConfigTypeDef
  5. See GuardrailContextualGroundingPolicyConfigTypeDef
  6. 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)
    contextualGroundingPolicyConfig: NotRequired[GuardrailContextualGroundingPolicyConfigTypeDef],  # (5)
    kmsKeyId: NotRequired[str],
  1. See GuardrailTopicPolicyConfigTypeDef
  2. See GuardrailContentPolicyConfigTypeDef
  3. See GuardrailWordPolicyConfigTypeDef
  4. See GuardrailSensitiveInformationPolicyConfigTypeDef
  5. See GuardrailContextualGroundingPolicyConfigTypeDef

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)
    contextualGroundingPolicy: GuardrailContextualGroundingPolicyTypeDef,  # (6)
    createdAt: datetime,
    updatedAt: datetime,
    statusReasons: List[str],
    failureRecommendations: List[str],
    blockedInputMessaging: str,
    blockedOutputsMessaging: str,
    kmsKeyArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (7)
  1. See GuardrailStatusType
  2. See GuardrailTopicPolicyTypeDef
  3. See GuardrailContentPolicyTypeDef
  4. See GuardrailWordPolicyTypeDef
  5. See GuardrailSensitiveInformationPolicyTypeDef
  6. See GuardrailContextualGroundingPolicyTypeDef
  7. See ResponseMetadataTypeDef

CreateModelImportJobRequestRequestTypeDef#

# CreateModelImportJobRequestRequestTypeDef definition

class CreateModelImportJobRequestRequestTypeDef(TypedDict):
    jobName: str,
    importedModelName: str,
    roleArn: str,
    modelDataSource: ModelDataSourceTypeDef,  # (1)
    jobTags: NotRequired[Sequence[TagTypeDef]],  # (2)
    importedModelTags: NotRequired[Sequence[TagTypeDef]],  # (2)
    clientRequestToken: NotRequired[str],
    vpcConfig: NotRequired[VpcConfigTypeDef],  # (4)
    importedModelKmsKeyId: NotRequired[str],
  1. See ModelDataSourceTypeDef
  2. See TagTypeDef
  3. See TagTypeDef
  4. See VpcConfigTypeDef

GetImportedModelResponseTypeDef#

# GetImportedModelResponseTypeDef definition

class GetImportedModelResponseTypeDef(TypedDict):
    modelArn: str,
    modelName: str,
    jobName: str,
    jobArn: str,
    modelDataSource: ModelDataSourceTypeDef,  # (1)
    creationTime: datetime,
    modelArchitecture: str,
    modelKmsKeyArn: str,
    instructSupported: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ModelDataSourceTypeDef
  2. See ResponseMetadataTypeDef

GetModelImportJobResponseTypeDef#

# GetModelImportJobResponseTypeDef definition

class GetModelImportJobResponseTypeDef(TypedDict):
    jobArn: str,
    jobName: str,
    importedModelName: str,
    importedModelArn: str,
    roleArn: str,
    modelDataSource: ModelDataSourceTypeDef,  # (1)
    status: ModelImportJobStatusType,  # (2)
    failureMessage: str,
    creationTime: datetime,
    lastModifiedTime: datetime,
    endTime: datetime,
    vpcConfig: VpcConfigOutputTypeDef,  # (3)
    importedModelKmsKeyArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ModelDataSourceTypeDef
  2. See ModelImportJobStatusType
  3. See VpcConfigOutputTypeDef
  4. See ResponseMetadataTypeDef

CreateModelInvocationJobRequestRequestTypeDef#

# CreateModelInvocationJobRequestRequestTypeDef definition

class CreateModelInvocationJobRequestRequestTypeDef(TypedDict):
    jobName: str,
    roleArn: str,
    modelId: str,
    inputDataConfig: ModelInvocationJobInputDataConfigTypeDef,  # (1)
    outputDataConfig: ModelInvocationJobOutputDataConfigTypeDef,  # (2)
    clientRequestToken: NotRequired[str],
    vpcConfig: NotRequired[VpcConfigTypeDef],  # (3)
    timeoutDurationInHours: NotRequired[int],
    tags: NotRequired[Sequence[TagTypeDef]],  # (4)
  1. See ModelInvocationJobInputDataConfigTypeDef
  2. See ModelInvocationJobOutputDataConfigTypeDef
  3. See VpcConfigTypeDef
  4. See TagTypeDef

GetModelInvocationJobResponseTypeDef#

# GetModelInvocationJobResponseTypeDef definition

class GetModelInvocationJobResponseTypeDef(TypedDict):
    jobArn: str,
    jobName: str,
    modelId: str,
    clientRequestToken: str,
    roleArn: str,
    status: ModelInvocationJobStatusType,  # (1)
    message: str,
    submitTime: datetime,
    lastModifiedTime: datetime,
    endTime: datetime,
    inputDataConfig: ModelInvocationJobInputDataConfigTypeDef,  # (2)
    outputDataConfig: ModelInvocationJobOutputDataConfigTypeDef,  # (3)
    vpcConfig: VpcConfigOutputTypeDef,  # (4)
    timeoutDurationInHours: int,
    jobExpirationTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See ModelInvocationJobStatusType
  2. See ModelInvocationJobInputDataConfigTypeDef
  3. See ModelInvocationJobOutputDataConfigTypeDef
  4. See VpcConfigOutputTypeDef
  5. See ResponseMetadataTypeDef

ModelInvocationJobSummaryTypeDef#

# ModelInvocationJobSummaryTypeDef definition

class ModelInvocationJobSummaryTypeDef(TypedDict):
    jobArn: str,
    jobName: str,
    modelId: str,
    roleArn: str,
    submitTime: datetime,
    inputDataConfig: ModelInvocationJobInputDataConfigTypeDef,  # (2)
    outputDataConfig: ModelInvocationJobOutputDataConfigTypeDef,  # (3)
    clientRequestToken: NotRequired[str],
    status: NotRequired[ModelInvocationJobStatusType],  # (1)
    message: NotRequired[str],
    lastModifiedTime: NotRequired[datetime],
    endTime: NotRequired[datetime],
    vpcConfig: NotRequired[VpcConfigOutputTypeDef],  # (4)
    timeoutDurationInHours: NotRequired[int],
    jobExpirationTime: NotRequired[datetime],
  1. See ModelInvocationJobStatusType
  2. See ModelInvocationJobInputDataConfigTypeDef
  3. See ModelInvocationJobOutputDataConfigTypeDef
  4. See VpcConfigOutputTypeDef

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)
  1. See CustomizationTypeType
  2. See TrainingDataConfigTypeDef
  3. See ValidationDataConfigOutputTypeDef
  4. See OutputDataConfigTypeDef
  5. See TrainingMetricsTypeDef
  6. See ValidatorMetricTypeDef
  7. 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)
  1. See ModelCustomizationJobStatusType
  2. See TrainingDataConfigTypeDef
  3. See ValidationDataConfigOutputTypeDef
  4. See OutputDataConfigTypeDef
  5. See CustomizationTypeType
  6. See TrainingMetricsTypeDef
  7. See ValidatorMetricTypeDef
  8. See VpcConfigOutputTypeDef
  9. 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)
  1. See TrainingDataConfigTypeDef
  2. See OutputDataConfigTypeDef
  3. See CustomizationTypeType
  4. See TagTypeDef
  5. See TagTypeDef
  6. See ValidationDataConfigTypeDef
  7. See VpcConfigTypeDef

GetModelInvocationLoggingConfigurationResponseTypeDef#

# GetModelInvocationLoggingConfigurationResponseTypeDef definition

class GetModelInvocationLoggingConfigurationResponseTypeDef(TypedDict):
    loggingConfig: LoggingConfigTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LoggingConfigTypeDef
  2. See ResponseMetadataTypeDef

PutModelInvocationLoggingConfigurationRequestRequestTypeDef#

# PutModelInvocationLoggingConfigurationRequestRequestTypeDef definition

class PutModelInvocationLoggingConfigurationRequestRequestTypeDef(TypedDict):
    loggingConfig: LoggingConfigTypeDef,  # (1)
  1. See LoggingConfigTypeDef

AutomatedEvaluationConfigOutputTypeDef#

# AutomatedEvaluationConfigOutputTypeDef definition

class AutomatedEvaluationConfigOutputTypeDef(TypedDict):
    datasetMetricConfigs: List[EvaluationDatasetMetricConfigOutputTypeDef],  # (1)
  1. See EvaluationDatasetMetricConfigOutputTypeDef

HumanEvaluationConfigOutputTypeDef#

# HumanEvaluationConfigOutputTypeDef definition

class HumanEvaluationConfigOutputTypeDef(TypedDict):
    datasetMetricConfigs: List[EvaluationDatasetMetricConfigOutputTypeDef],  # (3)
    humanWorkflowConfig: NotRequired[HumanWorkflowConfigTypeDef],  # (1)
    customMetrics: NotRequired[List[HumanEvaluationCustomMetricTypeDef]],  # (2)
  1. See HumanWorkflowConfigTypeDef
  2. See HumanEvaluationCustomMetricTypeDef
  3. See EvaluationDatasetMetricConfigOutputTypeDef

HumanEvaluationConfigTypeDef#

# HumanEvaluationConfigTypeDef definition

class HumanEvaluationConfigTypeDef(TypedDict):
    datasetMetricConfigs: Sequence[EvaluationDatasetMetricConfigTypeDef],  # (3)
    humanWorkflowConfig: NotRequired[HumanWorkflowConfigTypeDef],  # (1)
    customMetrics: NotRequired[Sequence[HumanEvaluationCustomMetricTypeDef]],  # (2)
  1. See HumanWorkflowConfigTypeDef
  2. See HumanEvaluationCustomMetricTypeDef
  3. See EvaluationDatasetMetricConfigTypeDef

ListModelInvocationJobsResponseTypeDef#

# ListModelInvocationJobsResponseTypeDef definition

class ListModelInvocationJobsResponseTypeDef(TypedDict):
    invocationJobSummaries: List[ModelInvocationJobSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See ModelInvocationJobSummaryTypeDef
  2. See ResponseMetadataTypeDef

EvaluationConfigOutputTypeDef#

# EvaluationConfigOutputTypeDef definition

class EvaluationConfigOutputTypeDef(TypedDict):
    automated: NotRequired[AutomatedEvaluationConfigOutputTypeDef],  # (1)
    human: NotRequired[HumanEvaluationConfigOutputTypeDef],  # (2)
  1. See AutomatedEvaluationConfigOutputTypeDef
  2. See HumanEvaluationConfigOutputTypeDef

AutomatedEvaluationConfigTypeDef#

# AutomatedEvaluationConfigTypeDef definition

class AutomatedEvaluationConfigTypeDef(TypedDict):
    datasetMetricConfigs: Sequence[EvaluationDatasetMetricConfigUnionTypeDef],  # (1)
  1. See EvaluationDatasetMetricConfigTypeDef EvaluationDatasetMetricConfigOutputTypeDef

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)
  1. See EvaluationJobStatusType
  2. See EvaluationJobTypeType
  3. See EvaluationConfigOutputTypeDef
  4. See EvaluationInferenceConfigOutputTypeDef
  5. See EvaluationOutputDataConfigTypeDef
  6. See ResponseMetadataTypeDef

EvaluationConfigTypeDef#

# EvaluationConfigTypeDef definition

class EvaluationConfigTypeDef(TypedDict):
    automated: NotRequired[AutomatedEvaluationConfigUnionTypeDef],  # (1)
    human: NotRequired[HumanEvaluationConfigUnionTypeDef],  # (2)
  1. See AutomatedEvaluationConfigTypeDef AutomatedEvaluationConfigOutputTypeDef
  2. See HumanEvaluationConfigTypeDef HumanEvaluationConfigOutputTypeDef

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)
  1. See EvaluationConfigTypeDef
  2. See EvaluationInferenceConfigTypeDef
  3. See EvaluationOutputDataConfigTypeDef
  4. See TagTypeDef