AWS.Tools.SnowDeviceManagement.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.SnowDeviceManagement</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SDMS.AddSDMSResourceTagCmdlet"> <summary> Adds or replaces tags on a device or task. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.AddSDMSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the device or task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.AddSDMSResourceTagCmdlet.Tag"> <summary> <para> <para>Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.AddSDMSResourceTagCmdlet.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.SnowDeviceManagement.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.AddSDMSResourceTagCmdlet.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.SDMS.AddSDMSResourceTagCmdlet.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.SDMS.GetSDMSDeviceCmdlet"> <summary> Checks device-specific information, such as the device type, software version, IP addresses, and lock status. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSDeviceCmdlet.ManagedDeviceId"> <summary> <para> <para>The ID of the device that you are checking the information of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSDeviceCmdlet.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.SnowDeviceManagement.Model.DescribeDeviceResponse). Specifying the name of a property of type Amazon.SnowDeviceManagement.Model.DescribeDeviceResponse 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.SDMS.GetSDMSDeviceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ManagedDeviceId parameter. The -PassThru parameter is deprecated, use -Select '^ManagedDeviceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSDeviceEc2InstanceCmdlet"> <summary> Checks the current state of the Amazon EC2 instances. The output is similar to <code>describeDevice</code>, but the results are sourced from the device cache in the Amazon Web Services Cloud and include a subset of the available fields. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSDeviceEc2InstanceCmdlet.InstanceId"> <summary> <para> <para>A list of instance IDs associated with the managed device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSDeviceEc2InstanceCmdlet.ManagedDeviceId"> <summary> <para> <para>The ID of the managed device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSDeviceEc2InstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Instances'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SnowDeviceManagement.Model.DescribeDeviceEc2InstancesResponse). Specifying the name of a property of type Amazon.SnowDeviceManagement.Model.DescribeDeviceEc2InstancesResponse 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.SDMS.GetSDMSDeviceEc2InstanceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ManagedDeviceId parameter. The -PassThru parameter is deprecated, use -Select '^ManagedDeviceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSDeviceListCmdlet"> <summary> Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device Management enabled in the Amazon Web Services Region where the command is run. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSDeviceListCmdlet.JobId"> <summary> <para> <para>The ID of the job used to order the device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSDeviceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of devices to list per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSDeviceListCmdlet.NextToken"> <summary> <para> <para>A pagination token to continue to the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSDeviceListCmdlet.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.SnowDeviceManagement.Model.ListDevicesResponse). Specifying the name of a property of type Amazon.SnowDeviceManagement.Model.ListDevicesResponse 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.SDMS.GetSDMSDeviceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSDeviceResourceListCmdlet"> <summary> Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSDeviceResourceListCmdlet.ManagedDeviceId"> <summary> <para> <para>The ID of the managed device that you are listing the resources of.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSDeviceResourceListCmdlet.Type"> <summary> <para> <para>A structure used to filter the results by type of resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSDeviceResourceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of resources per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSDeviceResourceListCmdlet.NextToken"> <summary> <para> <para>A pagination token to continue to the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSDeviceResourceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Resources'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SnowDeviceManagement.Model.ListDeviceResourcesResponse). Specifying the name of a property of type Amazon.SnowDeviceManagement.Model.ListDeviceResourcesResponse 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.SDMS.GetSDMSDeviceResourceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ManagedDeviceId parameter. The -PassThru parameter is deprecated, use -Select '^ManagedDeviceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSExecutionCmdlet"> <summary> Checks the status of a remote task running on one or more target devices. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSExecutionCmdlet.ManagedDeviceId"> <summary> <para> <para>The ID of the managed device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSExecutionCmdlet.TaskId"> <summary> <para> <para>The ID of the task that the action is describing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSExecutionCmdlet.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.SnowDeviceManagement.Model.DescribeExecutionResponse). Specifying the name of a property of type Amazon.SnowDeviceManagement.Model.DescribeExecutionResponse 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="T:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSExecutionListCmdlet"> <summary> Returns the status of tasks for one or more target devices. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSExecutionListCmdlet.State"> <summary> <para> <para>A structure used to filter the tasks by their current state.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSExecutionListCmdlet.TaskId"> <summary> <para> <para>The ID of the task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSExecutionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of tasks to list per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSExecutionListCmdlet.NextToken"> <summary> <para> <para>A pagination token to continue to the next page of tasks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSExecutionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Executions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SnowDeviceManagement.Model.ListExecutionsResponse). Specifying the name of a property of type Amazon.SnowDeviceManagement.Model.ListExecutionsResponse 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.SDMS.GetSDMSExecutionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TaskId parameter. The -PassThru parameter is deprecated, use -Select '^TaskId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSResourceTagCmdlet"> <summary> Returns a list of tags for a managed device or task. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the device or task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSResourceTagCmdlet.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.SnowDeviceManagement.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.SnowDeviceManagement.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.SDMS.GetSDMSResourceTagCmdlet.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.SDMS.GetSDMSTaskCmdlet"> <summary> Checks the metadata for a given task on a device. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSTaskCmdlet.TaskId"> <summary> <para> <para>The ID of the task to be described.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSTaskCmdlet.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.SnowDeviceManagement.Model.DescribeTaskResponse). Specifying the name of a property of type Amazon.SnowDeviceManagement.Model.DescribeTaskResponse 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.SDMS.GetSDMSTaskCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TaskId parameter. The -PassThru parameter is deprecated, use -Select '^TaskId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSTaskListCmdlet"> <summary> Returns a list of tasks that can be filtered by state. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSTaskListCmdlet.State"> <summary> <para> <para>A structure used to filter the list of tasks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSTaskListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of tasks per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSTaskListCmdlet.NextToken"> <summary> <para> <para>A pagination token to continue to the next page of tasks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.GetSDMSTaskListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tasks'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SnowDeviceManagement.Model.ListTasksResponse). Specifying the name of a property of type Amazon.SnowDeviceManagement.Model.ListTasksResponse 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.SDMS.GetSDMSTaskListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the State parameter. The -PassThru parameter is deprecated, use -Select '^State' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SDMS.NewSDMSTaskCmdlet"> <summary> Instructs one or more devices to start a task, such as unlocking or rebooting. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.NewSDMSTaskCmdlet.Description"> <summary> <para> <para>A description of the task and its targets.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.NewSDMSTaskCmdlet.Command_Reboot"> <summary> <para> <para>Reboots the device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.NewSDMSTaskCmdlet.Tag"> <summary> <para> <para>Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.NewSDMSTaskCmdlet.Target"> <summary> <para> <para>A list of managed device IDs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.NewSDMSTaskCmdlet.Command_Unlock"> <summary> <para> <para>Unlocks the device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.NewSDMSTaskCmdlet.ClientToken"> <summary> <para> <para>A token ensuring that the action is called only once with the specified details.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.NewSDMSTaskCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TaskId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SnowDeviceManagement.Model.CreateTaskResponse). Specifying the name of a property of type Amazon.SnowDeviceManagement.Model.CreateTaskResponse 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.SDMS.NewSDMSTaskCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Description parameter. The -PassThru parameter is deprecated, use -Select '^Description' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.NewSDMSTaskCmdlet.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.SDMS.RemoveSDMSResourceTagCmdlet"> <summary> Removes a tag from a device or task. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.RemoveSDMSResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the device or task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.RemoveSDMSResourceTagCmdlet.TagKey"> <summary> <para> <para>Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.RemoveSDMSResourceTagCmdlet.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.SnowDeviceManagement.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.RemoveSDMSResourceTagCmdlet.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.SDMS.RemoveSDMSResourceTagCmdlet.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.SDMS.StopSDMSTaskCmdlet"> <summary> Sends a cancel request for a specified task. You can cancel a task only if it's still in a <code>QUEUED</code> state. Tasks that are already running can't be cancelled. <note><para> A task might still run if it's processed from the queue before the <code>CancelTask</code> operation changes the task's state. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.StopSDMSTaskCmdlet.TaskId"> <summary> <para> <para>The ID of the task that you are attempting to cancel. You can retrieve a task ID by using the <code>ListTasks</code> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.StopSDMSTaskCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TaskId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SnowDeviceManagement.Model.CancelTaskResponse). Specifying the name of a property of type Amazon.SnowDeviceManagement.Model.CancelTaskResponse 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.SDMS.StopSDMSTaskCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TaskId parameter. The -PassThru parameter is deprecated, use -Select '^TaskId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SDMS.StopSDMSTaskCmdlet.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> |