AWS.Tools.Braket.XML
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Braket</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.BRKT.AddBRKTResourceTagCmdlet"> <summary> Add a tag to the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.AddBRKTResourceTagCmdlet.ResourceArn"> <summary> <para> <para>Specify the <c>resourceArn</c> of the resource to which a tag will be added.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.AddBRKTResourceTagCmdlet.Tag"> <summary> <para> <para>Specify the tags to add to the resource. Tags can be specified as a key-value map.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.AddBRKTResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Braket.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.AddBRKTResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.AddBRKTResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BRKT.GetBRKTDeviceCmdlet"> <summary> Retrieves the devices available in Amazon Braket. <note><para> For backwards compatibility with older versions of BraketSchemas, OpenQASM information is omitted from GetDevice API calls. To get this information the user-agent needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK automatically reports this for you. If you do not see OpenQASM results in the GetDevice response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment variable to configure user-agent. See the code examples provided below for how to do this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.GetBRKTDeviceCmdlet.DeviceArn"> <summary> <para> <para>The ARN of the device to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.GetBRKTDeviceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Braket.Model.GetDeviceResponse). Specifying the name of a property of type Amazon.Braket.Model.GetDeviceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.GetBRKTDeviceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DeviceArn parameter. The -PassThru parameter is deprecated, use -Select '^DeviceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BRKT.GetBRKTJobCmdlet"> <summary> Retrieves the specified Amazon Braket hybrid job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.GetBRKTJobCmdlet.AdditionalAttributeName"> <summary> <para> <para>A list of attributes to return additional information for. Only the QueueInfo additional attribute name is currently supported. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.GetBRKTJobCmdlet.JobArn"> <summary> <para> <para>The ARN of the hybrid job to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.GetBRKTJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Braket.Model.GetJobResponse). Specifying the name of a property of type Amazon.Braket.Model.GetJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.GetBRKTJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobArn parameter. The -PassThru parameter is deprecated, use -Select '^JobArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BRKT.GetBRKTQuantumTaskCmdlet"> <summary> Retrieves the specified quantum task. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.GetBRKTQuantumTaskCmdlet.AdditionalAttributeName"> <summary> <para> <para>A list of attributes to return additional information for. Only the QueueInfo additional attribute name is currently supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.GetBRKTQuantumTaskCmdlet.QuantumTaskArn"> <summary> <para> <para>The ARN of the quantum task to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.GetBRKTQuantumTaskCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Braket.Model.GetQuantumTaskResponse). Specifying the name of a property of type Amazon.Braket.Model.GetQuantumTaskResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.GetBRKTQuantumTaskCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QuantumTaskArn parameter. The -PassThru parameter is deprecated, use -Select '^QuantumTaskArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BRKT.GetBRKTResourceTagCmdlet"> <summary> Shows the tags associated with this resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.GetBRKTResourceTagCmdlet.ResourceArn"> <summary> <para> <para>Specify the <c>resourceArn</c> for the resource whose tags to display.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.GetBRKTResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Braket.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.Braket.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.GetBRKTResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet"> <summary> Creates an Amazon Braket hybrid job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet.Association"> <summary> <para> <para>The list of Amazon Braket resources associated with the hybrid job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet.ScriptModeConfig_CompressionType"> <summary> <para> <para>The type of compression used to store the algorithm scripts in Amazon S3 storage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet.DeviceConfig_Device"> <summary> <para> <para>The primary device ARN used to create and run an Amazon Braket hybrid job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet.ScriptModeConfig_EntryPoint"> <summary> <para> <para>The entry point in the algorithm scripts from where the execution begins in the hybrid job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet.HyperParameter"> <summary> <para> <para>Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the training job. The values are set with a map of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of the hyperparameter.</para><important><para>Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet.InputDataConfig"> <summary> <para> <para>A list of parameters that specify the name and type of input data and where it is located.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet.InstanceConfig_InstanceCount"> <summary> <para> <para>Configures the number of resource instances to use while running an Amazon Braket hybrid job on Amazon Braket. The default value is 1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet.InstanceConfig_InstanceType"> <summary> <para> <para>Configures the type of resource instances to use while running an Amazon Braket hybrid job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet.JobName"> <summary> <para> <para>The name of the Amazon Braket hybrid job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet.OutputDataConfig_KmsKeyId"> <summary> <para> <para>The AWS Key Management Service (AWS KMS) key that Amazon Braket uses to encrypt the hybrid job training artifacts at rest using Amazon S3 server-side encryption.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet.CheckpointConfig_LocalPath"> <summary> <para> <para>(Optional) The local directory where checkpoint data is stored. The default directory is <c>/opt/braket/checkpoints/</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet.StoppingCondition_MaxRuntimeInSecond"> <summary> <para> <para>The maximum length of time, in seconds, that an Amazon Braket hybrid job can run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet.RoleArn"> <summary> <para> <para>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 results and hybrid job details to the users' s3 buckets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet.OutputDataConfig_S3Path"> <summary> <para> <para>Identifies the S3 path where you want Amazon Braket to store the hybrid job training artifacts. For example, <c>s3://bucket-name/key-name-prefix</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet.ScriptModeConfig_S3Uri"> <summary> <para> <para>The URI that specifies the S3 path to the algorithm scripts used by an Amazon Braket hybrid job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet.CheckpointConfig_S3Uri"> <summary> <para> <para>Identifies the S3 path where you want Amazon Braket to store checkpoint data. For example, <c>s3://bucket-name/key-name-prefix</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet.Tag"> <summary> <para> <para>Tags to be added to the hybrid job you're creating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet.ContainerImage_Uri"> <summary> <para> <para>The URI locating the container image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet.InstanceConfig_VolumeSizeInGb"> <summary> <para> <para>The size of the storage volume, in GB, to provision.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet.ClientToken"> <summary> <para> <para>The client token associated with this request that guarantees that the request is idempotent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTQuantumTaskCmdlet"> <summary> Creates a quantum task. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTQuantumTaskCmdlet.Action"> <summary> <para> <para>The action associated with the quantum task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTQuantumTaskCmdlet.Association"> <summary> <para> <para>The list of Amazon Braket resources associated with the quantum task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTQuantumTaskCmdlet.DeviceArn"> <summary> <para> <para>The ARN of the device to run the quantum task on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTQuantumTaskCmdlet.DeviceParameter"> <summary> <para> <para>The parameters for the device to run the quantum task on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTQuantumTaskCmdlet.JobToken"> <summary> <para> <para>The token for an Amazon Braket hybrid job that associates it with the quantum task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTQuantumTaskCmdlet.OutputS3Bucket"> <summary> <para> <para>The S3 bucket to store quantum task result files in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTQuantumTaskCmdlet.OutputS3KeyPrefix"> <summary> <para> <para>The key prefix for the location in the S3 bucket to store quantum task results in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTQuantumTaskCmdlet.Shot"> <summary> <para> <para>The number of shots to use for the quantum task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTQuantumTaskCmdlet.Tag"> <summary> <para> <para>Tags to be added to the quantum task you're creating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTQuantumTaskCmdlet.ClientToken"> <summary> <para> <para>The client token associated with the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTQuantumTaskCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QuantumTaskArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Braket.Model.CreateQuantumTaskResponse). Specifying the name of a property of type Amazon.Braket.Model.CreateQuantumTaskResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTQuantumTaskCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BRKT.RemoveBRKTResourceTagCmdlet"> <summary> Remove tags from a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.RemoveBRKTResourceTagCmdlet.ResourceArn"> <summary> <para> <para>Specify the <c>resourceArn</c> for the resource from which to remove the tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.RemoveBRKTResourceTagCmdlet.TagKey"> <summary> <para> <para>Specify the keys for the tags to remove from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.RemoveBRKTResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Braket.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.RemoveBRKTResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.RemoveBRKTResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BRKT.SearchBRKTDeviceCmdlet"> <summary> Searches for devices using the specified filters. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.SearchBRKTDeviceCmdlet.Filter"> <summary> <para> <para>Array of SearchDevicesFilter objects to use when searching for devices.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.SearchBRKTDeviceCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.SearchBRKTDeviceCmdlet.NextToken"> <summary> <para> <para>A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.SearchBRKTDeviceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Devices'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Braket.Model.SearchDevicesResponse). Specifying the name of a property of type Amazon.Braket.Model.SearchDevicesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.SearchBRKTDeviceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BRKT.SearchBRKTJobCmdlet"> <summary> Searches for Amazon Braket hybrid jobs that match the specified filter values. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.SearchBRKTJobCmdlet.Filter"> <summary> <para> <para>Array of SearchJobsFilter objects to use when searching for hybrid jobs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.SearchBRKTJobCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.SearchBRKTJobCmdlet.NextToken"> <summary> <para> <para>A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.SearchBRKTJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Jobs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Braket.Model.SearchJobsResponse). Specifying the name of a property of type Amazon.Braket.Model.SearchJobsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.SearchBRKTJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BRKT.SearchBRKTQuantumTaskCmdlet"> <summary> Searches for tasks that match the specified filter values. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.SearchBRKTQuantumTaskCmdlet.Filter"> <summary> <para> <para>Array of <c>SearchQuantumTasksFilter</c> objects to use when searching for quantum tasks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.SearchBRKTQuantumTaskCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.SearchBRKTQuantumTaskCmdlet.NextToken"> <summary> <para> <para>A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.SearchBRKTQuantumTaskCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QuantumTasks'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Braket.Model.SearchQuantumTasksResponse). Specifying the name of a property of type Amazon.Braket.Model.SearchQuantumTasksResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.SearchBRKTQuantumTaskCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BRKT.StopBRKTJobCmdlet"> <summary> Cancels an Amazon Braket hybrid job. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.StopBRKTJobCmdlet.JobArn"> <summary> <para> <para>The ARN of the Amazon Braket hybrid job to cancel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.StopBRKTJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Braket.Model.CancelJobResponse). Specifying the name of a property of type Amazon.Braket.Model.CancelJobResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.StopBRKTJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobArn parameter. The -PassThru parameter is deprecated, use -Select '^JobArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.StopBRKTJobCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.BRKT.StopBRKTQuantumTaskCmdlet"> <summary> Cancels the specified task. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.StopBRKTQuantumTaskCmdlet.QuantumTaskArn"> <summary> <para> <para>The ARN of the quantum task to cancel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.StopBRKTQuantumTaskCmdlet.ClientToken"> <summary> <para> <para>The client token associated with the cancellation request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.StopBRKTQuantumTaskCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Braket.Model.CancelQuantumTaskResponse). Specifying the name of a property of type Amazon.Braket.Model.CancelQuantumTaskResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.StopBRKTQuantumTaskCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QuantumTaskArn parameter. The -PassThru parameter is deprecated, use -Select '^QuantumTaskArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.StopBRKTQuantumTaskCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |