github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/bedrock/getCustomModel.go (about)

     1  // Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
     2  // *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***
     3  
     4  package bedrock
     5  
     6  import (
     7  	"context"
     8  	"reflect"
     9  
    10  	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
    11  	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    12  )
    13  
    14  // Returns properties of a specific Amazon Bedrock custom model.
    15  //
    16  // ## Example Usage
    17  //
    18  // <!--Start PulumiCodeChooser -->
    19  // ```go
    20  // package main
    21  //
    22  // import (
    23  //
    24  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/bedrock"
    25  //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    26  //
    27  // )
    28  //
    29  //	func main() {
    30  //		pulumi.Run(func(ctx *pulumi.Context) error {
    31  //			_, err := bedrock.LookupCustomModel(ctx, &bedrock.LookupCustomModelArgs{
    32  //				ModelId: "arn:aws:bedrock:us-west-2:123456789012:custom-model/amazon.titan-text-express-v1:0:8k/ly16hhi765j4 ",
    33  //			}, nil)
    34  //			if err != nil {
    35  //				return err
    36  //			}
    37  //			return nil
    38  //		})
    39  //	}
    40  //
    41  // ```
    42  // <!--End PulumiCodeChooser -->
    43  func LookupCustomModel(ctx *pulumi.Context, args *LookupCustomModelArgs, opts ...pulumi.InvokeOption) (*LookupCustomModelResult, error) {
    44  	opts = internal.PkgInvokeDefaultOpts(opts)
    45  	var rv LookupCustomModelResult
    46  	err := ctx.Invoke("aws:bedrock/getCustomModel:getCustomModel", args, &rv, opts...)
    47  	if err != nil {
    48  		return nil, err
    49  	}
    50  	return &rv, nil
    51  }
    52  
    53  // A collection of arguments for invoking getCustomModel.
    54  type LookupCustomModelArgs struct {
    55  	// Name or ARN of the custom model.
    56  	ModelId string `pulumi:"modelId"`
    57  }
    58  
    59  // A collection of values returned by getCustomModel.
    60  type LookupCustomModelResult struct {
    61  	// ARN of the base model.
    62  	BaseModelArn string `pulumi:"baseModelArn"`
    63  	// Creation time of the model.
    64  	CreationTime string `pulumi:"creationTime"`
    65  	// Hyperparameter values associated with this model.
    66  	Hyperparameters map[string]string `pulumi:"hyperparameters"`
    67  	Id              string            `pulumi:"id"`
    68  	// Job ARN associated with this model.
    69  	JobArn string `pulumi:"jobArn"`
    70  	// Job name associated with this model.
    71  	JobName string `pulumi:"jobName"`
    72  	// Key-value mapping of tags for the fine-tuning job.
    73  	JobTags map[string]string `pulumi:"jobTags"`
    74  	// ARN associated with this model.
    75  	ModelArn string `pulumi:"modelArn"`
    76  	ModelId  string `pulumi:"modelId"`
    77  	// The custom model is encrypted at rest using this key.
    78  	ModelKmsKeyArn string `pulumi:"modelKmsKeyArn"`
    79  	// Model name associated with this model.
    80  	ModelName string `pulumi:"modelName"`
    81  	// Key-value mapping of tags for the model.
    82  	ModelTags map[string]string `pulumi:"modelTags"`
    83  	// Output data configuration associated with this custom model.
    84  	OutputDataConfigs []GetCustomModelOutputDataConfig `pulumi:"outputDataConfigs"`
    85  	// Information about the training dataset.
    86  	TrainingDataConfigs []GetCustomModelTrainingDataConfig `pulumi:"trainingDataConfigs"`
    87  	// Metrics associated with the customization job.
    88  	TrainingMetrics []GetCustomModelTrainingMetric `pulumi:"trainingMetrics"`
    89  	// Information about the validation dataset.
    90  	ValidationDataConfigs []GetCustomModelValidationDataConfig `pulumi:"validationDataConfigs"`
    91  	// The loss metric for each validator that you provided.
    92  	ValidationMetrics []GetCustomModelValidationMetric `pulumi:"validationMetrics"`
    93  }
    94  
    95  func LookupCustomModelOutput(ctx *pulumi.Context, args LookupCustomModelOutputArgs, opts ...pulumi.InvokeOption) LookupCustomModelResultOutput {
    96  	return pulumi.ToOutputWithContext(context.Background(), args).
    97  		ApplyT(func(v interface{}) (LookupCustomModelResult, error) {
    98  			args := v.(LookupCustomModelArgs)
    99  			r, err := LookupCustomModel(ctx, &args, opts...)
   100  			var s LookupCustomModelResult
   101  			if r != nil {
   102  				s = *r
   103  			}
   104  			return s, err
   105  		}).(LookupCustomModelResultOutput)
   106  }
   107  
   108  // A collection of arguments for invoking getCustomModel.
   109  type LookupCustomModelOutputArgs struct {
   110  	// Name or ARN of the custom model.
   111  	ModelId pulumi.StringInput `pulumi:"modelId"`
   112  }
   113  
   114  func (LookupCustomModelOutputArgs) ElementType() reflect.Type {
   115  	return reflect.TypeOf((*LookupCustomModelArgs)(nil)).Elem()
   116  }
   117  
   118  // A collection of values returned by getCustomModel.
   119  type LookupCustomModelResultOutput struct{ *pulumi.OutputState }
   120  
   121  func (LookupCustomModelResultOutput) ElementType() reflect.Type {
   122  	return reflect.TypeOf((*LookupCustomModelResult)(nil)).Elem()
   123  }
   124  
   125  func (o LookupCustomModelResultOutput) ToLookupCustomModelResultOutput() LookupCustomModelResultOutput {
   126  	return o
   127  }
   128  
   129  func (o LookupCustomModelResultOutput) ToLookupCustomModelResultOutputWithContext(ctx context.Context) LookupCustomModelResultOutput {
   130  	return o
   131  }
   132  
   133  // ARN of the base model.
   134  func (o LookupCustomModelResultOutput) BaseModelArn() pulumi.StringOutput {
   135  	return o.ApplyT(func(v LookupCustomModelResult) string { return v.BaseModelArn }).(pulumi.StringOutput)
   136  }
   137  
   138  // Creation time of the model.
   139  func (o LookupCustomModelResultOutput) CreationTime() pulumi.StringOutput {
   140  	return o.ApplyT(func(v LookupCustomModelResult) string { return v.CreationTime }).(pulumi.StringOutput)
   141  }
   142  
   143  // Hyperparameter values associated with this model.
   144  func (o LookupCustomModelResultOutput) Hyperparameters() pulumi.StringMapOutput {
   145  	return o.ApplyT(func(v LookupCustomModelResult) map[string]string { return v.Hyperparameters }).(pulumi.StringMapOutput)
   146  }
   147  
   148  func (o LookupCustomModelResultOutput) Id() pulumi.StringOutput {
   149  	return o.ApplyT(func(v LookupCustomModelResult) string { return v.Id }).(pulumi.StringOutput)
   150  }
   151  
   152  // Job ARN associated with this model.
   153  func (o LookupCustomModelResultOutput) JobArn() pulumi.StringOutput {
   154  	return o.ApplyT(func(v LookupCustomModelResult) string { return v.JobArn }).(pulumi.StringOutput)
   155  }
   156  
   157  // Job name associated with this model.
   158  func (o LookupCustomModelResultOutput) JobName() pulumi.StringOutput {
   159  	return o.ApplyT(func(v LookupCustomModelResult) string { return v.JobName }).(pulumi.StringOutput)
   160  }
   161  
   162  // Key-value mapping of tags for the fine-tuning job.
   163  func (o LookupCustomModelResultOutput) JobTags() pulumi.StringMapOutput {
   164  	return o.ApplyT(func(v LookupCustomModelResult) map[string]string { return v.JobTags }).(pulumi.StringMapOutput)
   165  }
   166  
   167  // ARN associated with this model.
   168  func (o LookupCustomModelResultOutput) ModelArn() pulumi.StringOutput {
   169  	return o.ApplyT(func(v LookupCustomModelResult) string { return v.ModelArn }).(pulumi.StringOutput)
   170  }
   171  
   172  func (o LookupCustomModelResultOutput) ModelId() pulumi.StringOutput {
   173  	return o.ApplyT(func(v LookupCustomModelResult) string { return v.ModelId }).(pulumi.StringOutput)
   174  }
   175  
   176  // The custom model is encrypted at rest using this key.
   177  func (o LookupCustomModelResultOutput) ModelKmsKeyArn() pulumi.StringOutput {
   178  	return o.ApplyT(func(v LookupCustomModelResult) string { return v.ModelKmsKeyArn }).(pulumi.StringOutput)
   179  }
   180  
   181  // Model name associated with this model.
   182  func (o LookupCustomModelResultOutput) ModelName() pulumi.StringOutput {
   183  	return o.ApplyT(func(v LookupCustomModelResult) string { return v.ModelName }).(pulumi.StringOutput)
   184  }
   185  
   186  // Key-value mapping of tags for the model.
   187  func (o LookupCustomModelResultOutput) ModelTags() pulumi.StringMapOutput {
   188  	return o.ApplyT(func(v LookupCustomModelResult) map[string]string { return v.ModelTags }).(pulumi.StringMapOutput)
   189  }
   190  
   191  // Output data configuration associated with this custom model.
   192  func (o LookupCustomModelResultOutput) OutputDataConfigs() GetCustomModelOutputDataConfigArrayOutput {
   193  	return o.ApplyT(func(v LookupCustomModelResult) []GetCustomModelOutputDataConfig { return v.OutputDataConfigs }).(GetCustomModelOutputDataConfigArrayOutput)
   194  }
   195  
   196  // Information about the training dataset.
   197  func (o LookupCustomModelResultOutput) TrainingDataConfigs() GetCustomModelTrainingDataConfigArrayOutput {
   198  	return o.ApplyT(func(v LookupCustomModelResult) []GetCustomModelTrainingDataConfig { return v.TrainingDataConfigs }).(GetCustomModelTrainingDataConfigArrayOutput)
   199  }
   200  
   201  // Metrics associated with the customization job.
   202  func (o LookupCustomModelResultOutput) TrainingMetrics() GetCustomModelTrainingMetricArrayOutput {
   203  	return o.ApplyT(func(v LookupCustomModelResult) []GetCustomModelTrainingMetric { return v.TrainingMetrics }).(GetCustomModelTrainingMetricArrayOutput)
   204  }
   205  
   206  // Information about the validation dataset.
   207  func (o LookupCustomModelResultOutput) ValidationDataConfigs() GetCustomModelValidationDataConfigArrayOutput {
   208  	return o.ApplyT(func(v LookupCustomModelResult) []GetCustomModelValidationDataConfig { return v.ValidationDataConfigs }).(GetCustomModelValidationDataConfigArrayOutput)
   209  }
   210  
   211  // The loss metric for each validator that you provided.
   212  func (o LookupCustomModelResultOutput) ValidationMetrics() GetCustomModelValidationMetricArrayOutput {
   213  	return o.ApplyT(func(v LookupCustomModelResult) []GetCustomModelValidationMetric { return v.ValidationMetrics }).(GetCustomModelValidationMetricArrayOutput)
   214  }
   215  
   216  func init() {
   217  	pulumi.RegisterOutputType(LookupCustomModelResultOutput{})
   218  }