1. Packages
  2. AWS Classic
  3. API Docs
  4. bedrock
  5. getCustomModel

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.30.0 published on Thursday, Apr 11, 2024 by Pulumi

aws.bedrock.getCustomModel

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.30.0 published on Thursday, Apr 11, 2024 by Pulumi

    Returns properties of a specific Amazon Bedrock custom model.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const test = aws.bedrock.getCustomModel({
        modelId: "arn:aws:bedrock:us-west-2:123456789012:custom-model/amazon.titan-text-express-v1:0:8k/ly16hhi765j4 ",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    test = aws.bedrock.get_custom_model(model_id="arn:aws:bedrock:us-west-2:123456789012:custom-model/amazon.titan-text-express-v1:0:8k/ly16hhi765j4 ")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/bedrock"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := bedrock.LookupCustomModel(ctx, &bedrock.LookupCustomModelArgs{
    			ModelId: "arn:aws:bedrock:us-west-2:123456789012:custom-model/amazon.titan-text-express-v1:0:8k/ly16hhi765j4 ",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var test = Aws.Bedrock.GetCustomModel.Invoke(new()
        {
            ModelId = "arn:aws:bedrock:us-west-2:123456789012:custom-model/amazon.titan-text-express-v1:0:8k/ly16hhi765j4 ",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.bedrock.BedrockFunctions;
    import com.pulumi.aws.bedrock.inputs.GetCustomModelArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var test = BedrockFunctions.getCustomModel(GetCustomModelArgs.builder()
                .modelId("arn:aws:bedrock:us-west-2:123456789012:custom-model/amazon.titan-text-express-v1:0:8k/ly16hhi765j4 ")
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          Function: aws:bedrock:getCustomModel
          Arguments:
            modelId: 'arn:aws:bedrock:us-west-2:123456789012:custom-model/amazon.titan-text-express-v1:0:8k/ly16hhi765j4 '
    

    Using getCustomModel

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCustomModel(args: GetCustomModelArgs, opts?: InvokeOptions): Promise<GetCustomModelResult>
    function getCustomModelOutput(args: GetCustomModelOutputArgs, opts?: InvokeOptions): Output<GetCustomModelResult>
    def get_custom_model(model_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetCustomModelResult
    def get_custom_model_output(model_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetCustomModelResult]
    func LookupCustomModel(ctx *Context, args *LookupCustomModelArgs, opts ...InvokeOption) (*LookupCustomModelResult, error)
    func LookupCustomModelOutput(ctx *Context, args *LookupCustomModelOutputArgs, opts ...InvokeOption) LookupCustomModelResultOutput

    > Note: This function is named LookupCustomModel in the Go SDK.

    public static class GetCustomModel 
    {
        public static Task<GetCustomModelResult> InvokeAsync(GetCustomModelArgs args, InvokeOptions? opts = null)
        public static Output<GetCustomModelResult> Invoke(GetCustomModelInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCustomModelResult> getCustomModel(GetCustomModelArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:bedrock/getCustomModel:getCustomModel
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ModelId string
    Name or ARN of the custom model.
    ModelId string
    Name or ARN of the custom model.
    modelId String
    Name or ARN of the custom model.
    modelId string
    Name or ARN of the custom model.
    model_id str
    Name or ARN of the custom model.
    modelId String
    Name or ARN of the custom model.

    getCustomModel Result

    The following output properties are available:

    BaseModelArn string
    ARN of the base model.
    CreationTime string
    Creation time of the model.
    Hyperparameters Dictionary<string, string>
    Hyperparameter values associated with this model.
    Id string
    JobArn string
    Job ARN associated with this model.
    JobName string
    Job name associated with this model.
    JobTags Dictionary<string, string>
    Key-value mapping of tags for the fine-tuning job.
    ModelArn string
    ARN associated with this model.
    ModelId string
    ModelKmsKeyArn string
    The custom model is encrypted at rest using this key.
    ModelName string
    Model name associated with this model.
    ModelTags Dictionary<string, string>
    Key-value mapping of tags for the model.
    OutputDataConfigs List<GetCustomModelOutputDataConfig>
    Output data configuration associated with this custom model.
    TrainingDataConfigs List<GetCustomModelTrainingDataConfig>
    Information about the training dataset.
    TrainingMetrics List<GetCustomModelTrainingMetric>
    Metrics associated with the customization job.
    ValidationDataConfigs List<GetCustomModelValidationDataConfig>
    Information about the validation dataset.
    ValidationMetrics List<GetCustomModelValidationMetric>
    The loss metric for each validator that you provided.
    BaseModelArn string
    ARN of the base model.
    CreationTime string
    Creation time of the model.
    Hyperparameters map[string]string
    Hyperparameter values associated with this model.
    Id string
    JobArn string
    Job ARN associated with this model.
    JobName string
    Job name associated with this model.
    JobTags map[string]string
    Key-value mapping of tags for the fine-tuning job.
    ModelArn string
    ARN associated with this model.
    ModelId string
    ModelKmsKeyArn string
    The custom model is encrypted at rest using this key.
    ModelName string
    Model name associated with this model.
    ModelTags map[string]string
    Key-value mapping of tags for the model.
    OutputDataConfigs []GetCustomModelOutputDataConfig
    Output data configuration associated with this custom model.
    TrainingDataConfigs []GetCustomModelTrainingDataConfig
    Information about the training dataset.
    TrainingMetrics []GetCustomModelTrainingMetric
    Metrics associated with the customization job.
    ValidationDataConfigs []GetCustomModelValidationDataConfig
    Information about the validation dataset.
    ValidationMetrics []GetCustomModelValidationMetric
    The loss metric for each validator that you provided.
    baseModelArn String
    ARN of the base model.
    creationTime String
    Creation time of the model.
    hyperparameters Map<String,String>
    Hyperparameter values associated with this model.
    id String
    jobArn String
    Job ARN associated with this model.
    jobName String
    Job name associated with this model.
    jobTags Map<String,String>
    Key-value mapping of tags for the fine-tuning job.
    modelArn String
    ARN associated with this model.
    modelId String
    modelKmsKeyArn String
    The custom model is encrypted at rest using this key.
    modelName String
    Model name associated with this model.
    modelTags Map<String,String>
    Key-value mapping of tags for the model.
    outputDataConfigs List<GetCustomModelOutputDataConfig>
    Output data configuration associated with this custom model.
    trainingDataConfigs List<GetCustomModelTrainingDataConfig>
    Information about the training dataset.
    trainingMetrics List<GetCustomModelTrainingMetric>
    Metrics associated with the customization job.
    validationDataConfigs List<GetCustomModelValidationDataConfig>
    Information about the validation dataset.
    validationMetrics List<GetCustomModelValidationMetric>
    The loss metric for each validator that you provided.
    baseModelArn string
    ARN of the base model.
    creationTime string
    Creation time of the model.
    hyperparameters {[key: string]: string}
    Hyperparameter values associated with this model.
    id string
    jobArn string
    Job ARN associated with this model.
    jobName string
    Job name associated with this model.
    jobTags {[key: string]: string}
    Key-value mapping of tags for the fine-tuning job.
    modelArn string
    ARN associated with this model.
    modelId string
    modelKmsKeyArn string
    The custom model is encrypted at rest using this key.
    modelName string
    Model name associated with this model.
    modelTags {[key: string]: string}
    Key-value mapping of tags for the model.
    outputDataConfigs GetCustomModelOutputDataConfig[]
    Output data configuration associated with this custom model.
    trainingDataConfigs GetCustomModelTrainingDataConfig[]
    Information about the training dataset.
    trainingMetrics GetCustomModelTrainingMetric[]
    Metrics associated with the customization job.
    validationDataConfigs GetCustomModelValidationDataConfig[]
    Information about the validation dataset.
    validationMetrics GetCustomModelValidationMetric[]
    The loss metric for each validator that you provided.
    base_model_arn str
    ARN of the base model.
    creation_time str
    Creation time of the model.
    hyperparameters Mapping[str, str]
    Hyperparameter values associated with this model.
    id str
    job_arn str
    Job ARN associated with this model.
    job_name str
    Job name associated with this model.
    job_tags Mapping[str, str]
    Key-value mapping of tags for the fine-tuning job.
    model_arn str
    ARN associated with this model.
    model_id str
    model_kms_key_arn str
    The custom model is encrypted at rest using this key.
    model_name str
    Model name associated with this model.
    model_tags Mapping[str, str]
    Key-value mapping of tags for the model.
    output_data_configs Sequence[GetCustomModelOutputDataConfig]
    Output data configuration associated with this custom model.
    training_data_configs Sequence[GetCustomModelTrainingDataConfig]
    Information about the training dataset.
    training_metrics Sequence[GetCustomModelTrainingMetric]
    Metrics associated with the customization job.
    validation_data_configs Sequence[GetCustomModelValidationDataConfig]
    Information about the validation dataset.
    validation_metrics Sequence[GetCustomModelValidationMetric]
    The loss metric for each validator that you provided.
    baseModelArn String
    ARN of the base model.
    creationTime String
    Creation time of the model.
    hyperparameters Map<String>
    Hyperparameter values associated with this model.
    id String
    jobArn String
    Job ARN associated with this model.
    jobName String
    Job name associated with this model.
    jobTags Map<String>
    Key-value mapping of tags for the fine-tuning job.
    modelArn String
    ARN associated with this model.
    modelId String
    modelKmsKeyArn String
    The custom model is encrypted at rest using this key.
    modelName String
    Model name associated with this model.
    modelTags Map<String>
    Key-value mapping of tags for the model.
    outputDataConfigs List<Property Map>
    Output data configuration associated with this custom model.
    trainingDataConfigs List<Property Map>
    Information about the training dataset.
    trainingMetrics List<Property Map>
    Metrics associated with the customization job.
    validationDataConfigs List<Property Map>
    Information about the validation dataset.
    validationMetrics List<Property Map>
    The loss metric for each validator that you provided.

    Supporting Types

    GetCustomModelOutputDataConfig

    S3Uri string
    The S3 URI where the validation data is stored..
    S3Uri string
    The S3 URI where the validation data is stored..
    s3Uri String
    The S3 URI where the validation data is stored..
    s3Uri string
    The S3 URI where the validation data is stored..
    s3_uri str
    The S3 URI where the validation data is stored..
    s3Uri String
    The S3 URI where the validation data is stored..

    GetCustomModelTrainingDataConfig

    S3Uri string
    The S3 URI where the validation data is stored..
    S3Uri string
    The S3 URI where the validation data is stored..
    s3Uri String
    The S3 URI where the validation data is stored..
    s3Uri string
    The S3 URI where the validation data is stored..
    s3_uri str
    The S3 URI where the validation data is stored..
    s3Uri String
    The S3 URI where the validation data is stored..

    GetCustomModelTrainingMetric

    TrainingLoss double
    Loss metric associated with the customization job.
    TrainingLoss float64
    Loss metric associated with the customization job.
    trainingLoss Double
    Loss metric associated with the customization job.
    trainingLoss number
    Loss metric associated with the customization job.
    training_loss float
    Loss metric associated with the customization job.
    trainingLoss Number
    Loss metric associated with the customization job.

    GetCustomModelValidationDataConfig

    Validators List<object>
    Information about the validators.
    Validators []interface{}
    Information about the validators.
    validators List<Object>
    Information about the validators.
    validators any[]
    Information about the validators.
    validators Sequence[Any]
    Information about the validators.
    validators List<Any>
    Information about the validators.

    GetCustomModelValidationMetric

    ValidationLoss double
    The validation loss associated with the validator.
    ValidationLoss float64
    The validation loss associated with the validator.
    validationLoss Double
    The validation loss associated with the validator.
    validationLoss number
    The validation loss associated with the validator.
    validation_loss float
    The validation loss associated with the validator.
    validationLoss Number
    The validation loss associated with the validator.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.30.0 published on Thursday, Apr 11, 2024 by Pulumi