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 <code>resourceArn</code> 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.</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. </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.GetBRKTQuantumTaskCmdlet"> <summary> Retrieves the specified quantum task. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.GetBRKTQuantumTaskCmdlet.QuantumTaskArn"> <summary> <para> <para>the ARN of the 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 <code>resourceArn</code> 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.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 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 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 task on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.NewBRKTQuantumTaskCmdlet.OutputS3Bucket"> <summary> <para> <para>The S3 bucket to store 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 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 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 <code>resourceArn</code> 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>The filter values to use to search for a device.</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 continue results 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.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 <code>SearchQuantumTasksFilter</code> objects.</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 continue results 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.StopBRKTQuantumTaskCmdlet"> <summary> Cancels the specified task. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.BRKT.StopBRKTQuantumTaskCmdlet.QuantumTaskArn"> <summary> <para> <para>The ARN of the 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 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> |