AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Bedrock CreateModelCustomizationJob API operation.

Syntax

New-BDRModelCustomizationJob
-RequestMetadataFilters_AndAll <RequestMetadataBaseFilters[]>
-BaseModelIdentifier <String>
-ClientRequestToken <String>
-CustomizationType <CustomizationType>
-CustomModelKmsKeyId <String>
-CustomModelName <String>
-CustomModelTag <Tag[]>
-RequestMetadataFilters_Equal <Hashtable>
-HyperParameter <Hashtable>
-JobName <String>
-JobTag <Tag[]>
-TeacherModelConfig_MaxResponseLengthForInference <Int32>
-RequestMetadataFilters_NotEqual <Hashtable>
-RequestMetadataFilters_OrAll <RequestMetadataBaseFilters[]>
-RoleArn <String>
-OutputDataConfig_S3Uri <String>
-InvocationLogSource_S3Uri <String>
-TrainingDataConfig_S3Uri <String>
-VpcConfig_SecurityGroupId <String[]>
-VpcConfig_SubnetId <String[]>
-TeacherModelConfig_TeacherModelIdentifier <String>
-InvocationLogsConfig_UsePromptResponse <Boolean>
-ValidationDataConfig_Validator <Validator[]>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonBedrockConfig>

Description

Creates a fine-tuning job to customize a base model. You specify the base foundation model and the location of the training data. After the model-customization job completes successfully, your custom model resource will be ready to use. Amazon Bedrock returns validation loss metrics and output generations after the job completes. For information on the format of training and validation data, see Prepare the datasets. Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size. To monitor a job, use the GetModelCustomizationJob operation to retrieve the job status. For more information, see Custom models in the Amazon Bedrock User Guide.

Parameters

-BaseModelIdentifier <String>
Name of the base model.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonBedrockConfig>
Amazon.PowerShell.Cmdlets.BDR.AmazonBedrockClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientRequestToken <String>
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomizationType <CustomizationType>
The customization type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomModelKmsKeyId <String>
The custom model is encrypted at rest using this key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomModelName <String>
A name for the resulting custom model.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-CustomModelTag <Tag[]>
Tags to attach to the resulting custom model. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCustomModelTags
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-HyperParameter <Hashtable>
Parameters related to tuning the model. For details on the format for different models, see Custom model hyperparameters. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHyperParameters
-InvocationLogsConfig_UsePromptResponse <Boolean>
Whether to use the model's response for training, or just the prompt. The default value is False.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTrainingDataConfig_InvocationLogsConfig_UsePromptResponse
-InvocationLogSource_S3Uri <String>
The URI of an invocation log in a bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTrainingDataConfig_InvocationLogsConfig_InvocationLogSource_S3Uri
-JobName <String>
A name for the fine-tuning job.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobTag <Tag[]>
Tags to attach to the job. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobTags
-OutputDataConfig_S3Uri <String>
The S3 URI where the output data is stored.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-RequestMetadataFilters_AndAll <RequestMetadataBaseFilters[]>
Include results where all of the based filters match. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTrainingDataConfig_InvocationLogsConfig_RequestMetadataFilters_AndAll
-RequestMetadataFilters_Equal <Hashtable>
Include results where the key equals the value. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTrainingDataConfig_InvocationLogsConfig_RequestMetadataFilters_Equals
-RequestMetadataFilters_NotEqual <Hashtable>
Include results where the key does not equal the value. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTrainingDataConfig_InvocationLogsConfig_RequestMetadataFilters_NotEquals
-RequestMetadataFilters_OrAll <RequestMetadataBaseFilters[]>
Include results where any of the base filters match. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTrainingDataConfig_InvocationLogsConfig_RequestMetadataFilters_OrAll
-RoleArn <String>
The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. For example, during model training, Amazon Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket. To pass this role to Amazon Bedrock, the caller of this API must have the iam:PassRole permission.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'JobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Bedrock.Model.CreateModelCustomizationJobResponse). Specifying the name of a property of type Amazon.Bedrock.Model.CreateModelCustomizationJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TeacherModelConfig_MaxResponseLengthForInference <Int32>
The maximum number of tokens requested when the customization job invokes the teacher model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCustomizationConfig_DistillationConfig_TeacherModelConfig_MaxResponseLengthForInference
-TeacherModelConfig_TeacherModelIdentifier <String>
The identifier of the teacher model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCustomizationConfig_DistillationConfig_TeacherModelConfig_TeacherModelIdentifier
-TrainingDataConfig_S3Uri <String>
The S3 URI where the training data is stored.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ValidationDataConfig_Validator <Validator[]>
Information about the validators. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesValidationDataConfig_Validators
-VpcConfig_SecurityGroupId <String[]>
An array of IDs for each security group in the VPC to use. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcConfig_SecurityGroupIds
-VpcConfig_SubnetId <String[]>
An array of IDs for each subnet in the VPC to use. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVpcConfig_SubnetIds

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.Bedrock.Model.CreateModelCustomizationJobResponse
This cmdlet returns a System.String object. The service call response (type Amazon.Bedrock.Model.CreateModelCustomizationJobResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z