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 Braket CreateJob API operation.

Syntax

New-BRKTJob
-ScriptModeConfig_CompressionType <CompressionType>
-DeviceConfig_Device <String>
-ScriptModeConfig_EntryPoint <String>
-HyperParameter <Hashtable>
-InputDataConfig <InputFileConfig[]>
-InstanceConfig_InstanceCount <Int32>
-InstanceConfig_InstanceType <InstanceType>
-JobName <String>
-OutputDataConfig_KmsKeyId <String>
-CheckpointConfig_LocalPath <String>
-StoppingCondition_MaxRuntimeInSecond <Int32>
-RoleArn <String>
-OutputDataConfig_S3Path <String>
-ScriptModeConfig_S3Uri <String>
-CheckpointConfig_S3Uri <String>
-Tag <Hashtable>
-ContainerImage_Uri <String>
-InstanceConfig_VolumeSizeInGb <Int32>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>

Description

Creates an Amazon Braket job.

Parameters

-CheckpointConfig_LocalPath <String>
(Optional) The local directory where checkpoints are written. The default directory is /opt/braket/checkpoints/.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CheckpointConfig_S3Uri <String>
Identifies the S3 path where you want Amazon Braket to store checkpoints. For example, s3://bucket-name/key-name-prefix.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
A unique token that guarantees that the call to this API is idempotent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContainerImage_Uri <String>
The URI locating the container image.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAlgorithmSpecification_ContainerImage_Uri
-DeviceConfig_Device <String>
The primary quantum processing unit (QPU) or simulator used to create and run an Amazon Braket job.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
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>
Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the training job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesHyperParameters
-InputDataConfig <InputFileConfig[]>
A list of parameters that specify the name and type of input data and where it is located.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceConfig_InstanceCount <Int32>
Configures the number of resource instances to use while running an Amazon Braket job on Amazon Braket. The default value is 1.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceConfig_InstanceType <InstanceType>
Configures the type resource instances to use while running an Amazon Braket hybrid job.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceConfig_VolumeSizeInGb <Int32>
The size of the storage volume, in GB, that user wants to provision.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobName <String>
The name of the Amazon Braket job.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputDataConfig_KmsKeyId <String>
The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the job training artifacts at rest using Amazon S3 server-side encryption.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputDataConfig_S3Path <String>
Identifies the S3 path where you want Amazon Braket to store the job training artifacts. For example, s3://bucket-name/key-name-prefix.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-RoleArn <String>
The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output resources to the users' s3 buckets.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ScriptModeConfig_CompressionType <CompressionType>
The type of compression used by the Python scripts for an Amazon Braket job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAlgorithmSpecification_ScriptModeConfig_CompressionType
-ScriptModeConfig_EntryPoint <String>
The path to the Python script that serves as the entry point for an Amazon Braket job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAlgorithmSpecification_ScriptModeConfig_EntryPoint
-ScriptModeConfig_S3Uri <String>
The URI that specifies the S3 path to the Python script module that contains the training script used by an Amazon Braket job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAlgorithmSpecification_ScriptModeConfig_S3Uri
-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.Braket.Model.CreateJobResponse). Specifying the name of a property of type Amazon.Braket.Model.CreateJobResponse 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)
-StoppingCondition_MaxRuntimeInSecond <Int32>
The maximum length of time, in seconds, that an Amazon Braket job can run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoppingCondition_MaxRuntimeInSeconds
-Tag <Hashtable>
A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

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

This cmdlet returns a System.String object. The service call response (type Amazon.Braket.Model.CreateJobResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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