AWS.Tools.Snowball.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Snowball</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWAddressCmdlet"> <summary> Takes an <code>AddressId</code> and returns specific details about that address in the form of an <code>Address</code> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWAddressCmdlet.AddressId"> <summary> <para> <para>The automatically generated ID for a specific address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWAddressCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Address'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Snowball.Model.DescribeAddressResponse). Specifying the name of a property of type Amazon.Snowball.Model.DescribeAddressResponse 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.SNOW.GetSNOWAddressCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AddressId parameter. The -PassThru parameter is deprecated, use -Select '^AddressId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWAddressListCmdlet"> <summary> Returns a specified number of <code>ADDRESS</code> objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWAddressListCmdlet.MaxResult"> <summary> <para> <para>The number of <code>ADDRESS</code> objects to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWAddressListCmdlet.NextToken"> <summary> <para> <para>HTTP requests are stateless. To identify what object comes "next" in the list of <code>ADDRESS</code> objects, you have the option of specifying a value for <code>NextToken</code> as the starting point for your list of returned addresses.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWAddressListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Addresses'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Snowball.Model.DescribeAddressesResponse). Specifying the name of a property of type Amazon.Snowball.Model.DescribeAddressesResponse 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.SNOW.GetSNOWAddressListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWClusterCmdlet"> <summary> Returns information about a specific cluster including shipping information, cluster status, and other important metadata. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWClusterCmdlet.ClusterId"> <summary> <para> <para>The automatically generated ID for a cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ClusterMetadata'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Snowball.Model.DescribeClusterResponse). Specifying the name of a property of type Amazon.Snowball.Model.DescribeClusterResponse 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.SNOW.GetSNOWClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterId parameter. The -PassThru parameter is deprecated, use -Select '^ClusterId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWClusterJobListCmdlet"> <summary> Returns an array of <code>JobListEntry</code> objects of the specified length. Each <code>JobListEntry</code> object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWClusterJobListCmdlet.ClusterId"> <summary> <para> <para>The 39-character ID for the cluster that you want to list, for example <code>CID123e4567-e89b-12d3-a456-426655440000</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWClusterJobListCmdlet.MaxResult"> <summary> <para> <para>The number of <code>JobListEntry</code> objects to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWClusterJobListCmdlet.NextToken"> <summary> <para> <para>HTTP requests are stateless. To identify what object comes "next" in the list of <code>JobListEntry</code> objects, you have the option of specifying <code>NextToken</code> as the starting point for your returned list.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWClusterJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobListEntries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Snowball.Model.ListClusterJobsResponse). Specifying the name of a property of type Amazon.Snowball.Model.ListClusterJobsResponse 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.SNOW.GetSNOWClusterJobListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterId parameter. The -PassThru parameter is deprecated, use -Select '^ClusterId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWClusterJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWClusterListCmdlet"> <summary> Returns an array of <code>ClusterListEntry</code> objects of the specified length. Each <code>ClusterListEntry</code> object contains a cluster's state, a cluster's ID, and other important status information.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWClusterListCmdlet.MaxResult"> <summary> <para> <para>The number of <code>ClusterListEntry</code> objects to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWClusterListCmdlet.NextToken"> <summary> <para> <para>HTTP requests are stateless. To identify what object comes "next" in the list of <code>ClusterListEntry</code> objects, you have the option of specifying <code>NextToken</code> as the starting point for your returned list.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWClusterListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ClusterListEntries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Snowball.Model.ListClustersResponse). Specifying the name of a property of type Amazon.Snowball.Model.ListClustersResponse 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.SNOW.GetSNOWClusterListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWCompatibleImageListCmdlet"> <summary> This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your Amazon Web Services accountthat would be supported for use on a Snow device. Currently, supported AMIs are based on the Amazon Linux-2, Ubuntu 20.04 LTS - Focal, or Ubuntu 22.04 LTS - Jammy images, available on the Amazon Web Services Marketplace. Ubuntu 16.04 LTS - Xenial (HVM) images are no longer supported in the Market, but still supported for use on devices through Amazon EC2 VM Import/Export and running locally in AMIs.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWCompatibleImageListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results for the list of compatible images. Currently, a Snowball Edge device can store 10 AMIs.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWCompatibleImageListCmdlet.NextToken"> <summary> <para> <para>HTTP requests are stateless. To identify what object comes "next" in the list of compatible images, you can specify a value for <code>NextToken</code> as the starting point for your list of returned images.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWCompatibleImageListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CompatibleImages'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Snowball.Model.ListCompatibleImagesResponse). Specifying the name of a property of type Amazon.Snowball.Model.ListCompatibleImagesResponse 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.SNOW.GetSNOWCompatibleImageListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWJobCmdlet"> <summary> Returns information about a specific job including shipping information, job status, and other important metadata. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWJobCmdlet.JobId"> <summary> <para> <para>The automatically generated ID for a job, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWJobCmdlet.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.Snowball.Model.DescribeJobResponse). Specifying the name of a property of type Amazon.Snowball.Model.DescribeJobResponse 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.SNOW.GetSNOWJobCmdlet.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.SNOW.GetSNOWJobListCmdlet"> <summary> Returns an array of <code>JobListEntry</code> objects of the specified length. Each <code>JobListEntry</code> object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWJobListCmdlet.MaxResult"> <summary> <para> <para>The number of <code>JobListEntry</code> objects to return.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWJobListCmdlet.NextToken"> <summary> <para> <para>HTTP requests are stateless. To identify what object comes "next" in the list of <code>JobListEntry</code> objects, you have the option of specifying <code>NextToken</code> as the starting point for your returned list.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWJobListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobListEntries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Snowball.Model.ListJobsResponse). Specifying the name of a property of type Amazon.Snowball.Model.ListJobsResponse 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.SNOW.GetSNOWJobListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWJobManifestCmdlet"> <summary> Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified <code>JobId</code> value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the <code>GetJobManifest</code> action. <para> The manifest is an encrypted file that you can download after your job enters the <code>WithCustomer</code> status. This is the only valid status for calling this API as the manifest and <code>UnlockCode</code> code value are used for securing your device and should only be used when you have the device. The manifest is decrypted by using the <code>UnlockCode</code> code value, when you pass both values to the Snow device through the Snowball client when the client is started for the first time. </para><para> As a best practice, we recommend that you don't save a copy of an <code>UnlockCode</code> value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snow device associated with that job. </para><para> The credentials of a given job, including its manifest file and unlock code, expire 360 days after the job is created. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWJobManifestCmdlet.JobId"> <summary> <para> <para>The ID for a job that you want to get the manifest file for, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWJobManifestCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ManifestURI'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Snowball.Model.GetJobManifestResponse). Specifying the name of a property of type Amazon.Snowball.Model.GetJobManifestResponse 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.SNOW.GetSNOWJobManifestCmdlet.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.SNOW.GetSNOWJobUnlockCodeCmdlet"> <summary> Returns the <code>UnlockCode</code> code value for the specified job. A particular <code>UnlockCode</code> value can be accessed for up to 360 days after the associated job has been created. <para> The <code>UnlockCode</code> value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snow device through the Snowball client when the client is started for the first time. The only valid status for calling this API is <code>WithCustomer</code> as the manifest and <code>Unlock</code> code values are used for securing your device and should only be used when you have the device. </para><para> As a best practice, we recommend that you don't save a copy of the <code>UnlockCode</code> in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snow device associated with that job. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWJobUnlockCodeCmdlet.JobId"> <summary> <para> <para>The ID for the job that you want to get the <code>UnlockCode</code> value for, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWJobUnlockCodeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UnlockCode'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Snowball.Model.GetJobUnlockCodeResponse). Specifying the name of a property of type Amazon.Snowball.Model.GetJobUnlockCodeResponse 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.SNOW.GetSNOWJobUnlockCodeCmdlet.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.SNOW.GetSNOWLongTermPricingCmdlet"> <summary> Lists all long-term pricing types.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWLongTermPricingCmdlet.MaxResult"> <summary> <para> <para>The maximum number of <code>ListLongTermPricing</code> objects to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWLongTermPricingCmdlet.NextToken"> <summary> <para> <para>Because HTTP requests are stateless, this is the starting point for your next list of <code>ListLongTermPricing</code> to return.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWLongTermPricingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LongTermPricingEntries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Snowball.Model.ListLongTermPricingResponse). Specifying the name of a property of type Amazon.Snowball.Model.ListLongTermPricingResponse 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.SNOW.GetSNOWLongTermPricingCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWReturnShippingLabelCmdlet"> <summary> Information on the shipping label of a Snow device that is being returned to Amazon Web Services. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWReturnShippingLabelCmdlet.JobId"> <summary> <para> <para>The automatically generated ID for a job, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWReturnShippingLabelCmdlet.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.Snowball.Model.DescribeReturnShippingLabelResponse). Specifying the name of a property of type Amazon.Snowball.Model.DescribeReturnShippingLabelResponse 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.SNOW.GetSNOWReturnShippingLabelCmdlet.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.SNOW.GetSNOWServiceVersionCmdlet"> <summary> Lists all supported versions for Snow on-device services. Returns an array of <code>ServiceVersion</code> object containing the supported versions for a particular service.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWServiceVersionCmdlet.DependentService"> <summary> <para> <para>A list of names and versions of dependant services of the requested service.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWServiceVersionCmdlet.ServiceName"> <summary> <para> <para>The name of the service for which you're requesting supported versions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWServiceVersionCmdlet.MaxResult"> <summary> <para> <para>The maximum number of <code>ListServiceVersions</code> objects to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWServiceVersionCmdlet.NextToken"> <summary> <para> <para>Because HTTP requests are stateless, this is the starting point for the next list of returned <code>ListServiceVersionsRequest</code> versions.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWServiceVersionCmdlet.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.Snowball.Model.ListServiceVersionsResponse). Specifying the name of a property of type Amazon.Snowball.Model.ListServiceVersionsResponse 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.SNOW.GetSNOWServiceVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ServiceName parameter. The -PassThru parameter is deprecated, use -Select '^ServiceName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWServiceVersionCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWSnowballUsageCmdlet"> <summary> Returns information about the Snow Family service limit for your account, and also the number of Snow devices your account has in use. <para> The default service limit for the number of Snow devices that you can have at one time is 1. If you want to increase your service limit, contact Amazon Web Services Support. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWSnowballUsageCmdlet.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.Snowball.Model.GetSnowballUsageResponse). Specifying the name of a property of type Amazon.Snowball.Model.GetSnowballUsageResponse 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.SNOW.GetSNOWSoftwareUpdateCmdlet"> <summary> Returns an Amazon S3 presigned URL for an update file associated with a specified <code>JobId</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWSoftwareUpdateCmdlet.JobId"> <summary> <para> <para>The ID for a job that you want to get the software update file for, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.GetSNOWSoftwareUpdateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UpdatesURI'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Snowball.Model.GetSoftwareUpdatesResponse). Specifying the name of a property of type Amazon.Snowball.Model.GetSoftwareUpdatesResponse 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.SNOW.GetSNOWSoftwareUpdateCmdlet.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.SNOW.NewSNOWAddressCmdlet"> <summary> Creates an address for a Snow device to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWAddressCmdlet.Address_AddressId"> <summary> <para> <para>The unique ID for an address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWAddressCmdlet.Address_City"> <summary> <para> <para>The city in an address that a Snow device is to be delivered to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWAddressCmdlet.Address_Company"> <summary> <para> <para>The name of the company to receive a Snow device at an address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWAddressCmdlet.Address_Country"> <summary> <para> <para>The country in an address that a Snow device is to be delivered to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWAddressCmdlet.Address_IsRestricted"> <summary> <para> <para>If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWAddressCmdlet.Address_Landmark"> <summary> <para> <para>This field is no longer used and the value is ignored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWAddressCmdlet.Address_Name"> <summary> <para> <para>The name of a person to receive a Snow device at an address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWAddressCmdlet.Address_PhoneNumber"> <summary> <para> <para>The phone number associated with an address that a Snow device is to be delivered to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWAddressCmdlet.Address_PostalCode"> <summary> <para> <para>The postal code in an address that a Snow device is to be delivered to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWAddressCmdlet.Address_PrefectureOrDistrict"> <summary> <para> <para>This field is no longer used and the value is ignored.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWAddressCmdlet.Address_StateOrProvince"> <summary> <para> <para>The state or province in an address that a Snow device is to be delivered to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWAddressCmdlet.Address_Street1"> <summary> <para> <para>The first line in a street address that a Snow device is to be delivered to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWAddressCmdlet.Address_Street2"> <summary> <para> <para>The second line in a street address that a Snow device is to be delivered to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWAddressCmdlet.Address_Street3"> <summary> <para> <para>The third line in a street address that a Snow device is to be delivered to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWAddressCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AddressId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Snowball.Model.CreateAddressResponse). Specifying the name of a property of type Amazon.Snowball.Model.CreateAddressResponse 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.SNOW.NewSNOWAddressCmdlet.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.SNOW.NewSNOWClusterCmdlet"> <summary> Creates an empty cluster. Each cluster supports five nodes. You use the <a>CreateJob</a> action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.AddressId"> <summary> <para> <para>The ID for the address that you want the cluster shipped to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.Description"> <summary> <para> <para>An optional description of this specific cluster, for example <code>Environmental Data Cluster-01</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.Resources_Ec2AmiResource"> <summary> <para> <para>The Amazon Machine Images (AMIs) associated with this job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.EKSOnDeviceService_EKSAnywhereVersion"> <summary> <para> <para>The version of EKS Anywhere on the Snow Family device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.S3OnDeviceService_FaultTolerance"> <summary> <para> <para>>Fault tolerance level of the cluster. This indicates the number of nodes that can go down without degrading the performance of the cluster. This additional input helps when the specified <code>StorageLimit</code> matches more than one Amazon S3 compatible storage on Snow family devices service configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.ForceCreateJob"> <summary> <para> <para>Force to create cluster when user attempts to overprovision or underprovision a cluster. A cluster is overprovisioned or underprovisioned if the initial size of the cluster is more (overprovisioned) or less (underprovisioned) than what needed to meet capacity requirement specified with <code>OnDeviceServiceConfiguration</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.ForwardingAddressId"> <summary> <para> <para>The forwarding address ID for a cluster. This field is not supported in most regions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.IND_GSTIN"> <summary> <para> <para>The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.InitialClusterSize"> <summary> <para> <para>If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.Notification_JobStatesToNotify"> <summary> <para> <para>The list of job states that will trigger a notification for this job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.JobType"> <summary> <para> <para>The type of job for this cluster. Currently, the only job type supported for clusters is <code>LOCAL_USE</code>.</para><para>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.KmsKeyARN"> <summary> <para> <para>The <code>KmsKeyARN</code> value that you want to associate with this cluster. <code>KmsKeyARN</code> values are created by using the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html">CreateKey</a> API action in Key Management Service (KMS). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.EKSOnDeviceService_KubernetesVersion"> <summary> <para> <para>The Kubernetes version for EKS Anywhere on the Snow Family device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.Resources_LambdaResource"> <summary> <para> <para>The Python-language Lambda functions for this job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.LongTermPricingId"> <summary> <para> <para>Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.Notification_NotifyAll"> <summary> <para> <para>Any change in job state will trigger a notification for this job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.RemoteManagement"> <summary> <para> <para>Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set to <code>INSTALLED_AUTOSTART</code>, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.RoleARN"> <summary> <para> <para>The <code>RoleARN</code> that you want to associate with this cluster. <code>RoleArn</code> values are created by using the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a> API action in Identity and Access Management (IAM).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.Resources_S3Resource"> <summary> <para> <para>An array of <code>S3Resource</code> objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.S3OnDeviceService_ServiceSize"> <summary> <para> <para>Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snow family devices. If specified, the other input can be omitted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.ShippingOption"> <summary> <para> <para>The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows: </para><ul><li><para>In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.</para></li><li><para>In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.</para></li><li><para>In India, Snow devices are delivered in one to seven days.</para></li><li><para>In the United States of America (US), you have access to one-day shipping and two-day shipping.</para></li></ul><ul><li><para>In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.</para></li><li><para>In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.</para></li><li><para>In India, Snow devices are delivered in one to seven days.</para></li><li><para>In the US, you have access to one-day shipping and two-day shipping.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.SnowballCapacityPreference"> <summary> <para> <para>If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.</para><para>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.SnowballType"> <summary> <para> <para>The type of Snow Family devices to use for this cluster. </para><note><para>For cluster jobs, Amazon Web Services Snow Family currently supports only the <code>EDGE</code> device type.</para></note><para>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.Notification_SnsTopicARN"> <summary> <para> <para>The new SNS <code>TopicArn</code> that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html">CreateTopic</a> Amazon SNS API action.</para><para>You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html">Subscribe</a> Amazon Simple Notification Service (Amazon SNS) API action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.NFSOnDeviceService_StorageLimit"> <summary> <para> <para>The maximum NFS storage for one Snow Family device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.S3OnDeviceService_StorageLimit"> <summary> <para> <para>If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used. If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has the same storage limit as specified, the other input need to be provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.TGWOnDeviceService_StorageLimit"> <summary> <para> <para>The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.NFSOnDeviceService_StorageUnit"> <summary> <para> <para>The scale unit of the NFS storage on the device.</para><para>Valid values: TB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.S3OnDeviceService_StorageUnit"> <summary> <para> <para>Storage unit. Currently the only supported unit is TB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.TGWOnDeviceService_StorageUnit"> <summary> <para> <para>The scale unit of the virtual tapes on the device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ClusterId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Snowball.Model.CreateClusterResponse). Specifying the name of a property of type Amazon.Snowball.Model.CreateClusterResponse 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.SNOW.NewSNOWClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AddressId parameter. The -PassThru parameter is deprecated, use -Select '^AddressId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWClusterCmdlet.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.SNOW.NewSNOWJobCmdlet"> <summary> Amazon.Snowball.IAmazonSnowball.CreateJob </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.AddressId"> <summary> <para> <para>The ID for the address that you want the Snow device shipped to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.ClusterId"> <summary> <para> <para>The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this <code>clusterId</code> value. The other job attributes are inherited from the cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.Description"> <summary> <para> <para>Defines an optional description of this specific job, for example <code>Important Photos 2016-08-11</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.Resources_Ec2AmiResource"> <summary> <para> <para>The Amazon Machine Images (AMIs) associated with this job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.EKSOnDeviceService_EKSAnywhereVersion"> <summary> <para> <para>The version of EKS Anywhere on the Snow Family device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.S3OnDeviceService_FaultTolerance"> <summary> <para> <para>>Fault tolerance level of the cluster. This indicates the number of nodes that can go down without degrading the performance of the cluster. This additional input helps when the specified <code>StorageLimit</code> matches more than one Amazon S3 compatible storage on Snow family devices service configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.ForwardingAddressId"> <summary> <para> <para>The forwarding address ID for a job. This field is not supported in most Regions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.IND_GSTIN"> <summary> <para> <para>The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.WirelessConnection_IsWifiEnabled"> <summary> <para> <para>Enables the Wi-Fi adapter on an Snowcone device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.Notification_JobStatesToNotify"> <summary> <para> <para>The list of job states that will trigger a notification for this job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.JobType"> <summary> <para> <para>Defines the type of job that you're creating. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.KmsKeyARN"> <summary> <para> <para>The <code>KmsKeyARN</code> that you want to associate with this job. <code>KmsKeyARN</code>s are created using the <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html">CreateKey</a> Key Management Service (KMS) API action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.EKSOnDeviceService_KubernetesVersion"> <summary> <para> <para>The Kubernetes version for EKS Anywhere on the Snow Family device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.Resources_LambdaResource"> <summary> <para> <para>The Python-language Lambda functions for this job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.LongTermPricingId"> <summary> <para> <para>The ID of the long-term pricing type for the device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.Notification_NotifyAll"> <summary> <para> <para>Any change in job state will trigger a notification for this job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.RemoteManagement"> <summary> <para> <para>Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network. When set to <code>INSTALLED_AUTOSTART</code>, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.RoleARN"> <summary> <para> <para>The <code>RoleARN</code> that you want to associate with this job. <code>RoleArn</code>s are created using the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a> Identity and Access Management (IAM) API action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.Resources_S3Resource"> <summary> <para> <para>An array of <code>S3Resource</code> objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.S3OnDeviceService_ServiceSize"> <summary> <para> <para>Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snow family devices. If specified, the other input can be omitted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.ShippingOption"> <summary> <para> <para>The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snow device, rather it represents how quickly the Snow device moves to its destination while in transit. Regional shipping speeds are as follows:</para><ul><li><para>In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.</para></li><li><para>In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.</para></li><li><para>In India, Snow devices are delivered in one to seven days.</para></li><li><para>In the US, you have access to one-day shipping and two-day shipping.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.SnowballCapacityPreference"> <summary> <para> <para>If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.</para><para>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.SnowballType"> <summary> <para> <para>The type of Snow Family devices to use for this job. </para><note><para>For cluster jobs, Amazon Web Services Snow Family currently supports only the <code>EDGE</code> device type.</para></note><para>The type of Amazon Web Services Snow device to use for this job. Currently, the only supported device type for cluster jobs is <code>EDGE</code>.</para><para>For more information, see <a href="https://docs.aws.amazon.com/snowball/latest/developer-guide/device-differences.html">Snowball Edge Device Options</a> in the Snowball Edge Developer Guide.</para><para>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.Notification_SnsTopicARN"> <summary> <para> <para>The new SNS <code>TopicArn</code> that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html">CreateTopic</a> Amazon SNS API action.</para><para>You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html">Subscribe</a> Amazon Simple Notification Service (Amazon SNS) API action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.NFSOnDeviceService_StorageLimit"> <summary> <para> <para>The maximum NFS storage for one Snow Family device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.S3OnDeviceService_StorageLimit"> <summary> <para> <para>If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used. If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has the same storage limit as specified, the other input need to be provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.TGWOnDeviceService_StorageLimit"> <summary> <para> <para>The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.NFSOnDeviceService_StorageUnit"> <summary> <para> <para>The scale unit of the NFS storage on the device.</para><para>Valid values: TB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.S3OnDeviceService_StorageUnit"> <summary> <para> <para>Storage unit. Currently the only supported unit is TB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.TGWOnDeviceService_StorageUnit"> <summary> <para> <para>The scale unit of the virtual tapes on the device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'JobId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Snowball.Model.CreateJobResponse). Specifying the name of a property of type Amazon.Snowball.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.SNOW.NewSNOWJobCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AddressId parameter. The -PassThru parameter is deprecated, use -Select '^AddressId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWJobCmdlet.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.SNOW.NewSNOWLongTermPricingCmdlet"> <summary> Creates a job with the long-term usage option for a device. The long-term usage is a 1-year or 3-year long-term pricing type for the device. You are billed upfront, and Amazon Web Services provides discounts for long-term pricing. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWLongTermPricingCmdlet.IsLongTermPricingAutoRenew"> <summary> <para> <para>Specifies whether the current long-term pricing type for the device should be renewed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWLongTermPricingCmdlet.LongTermPricingType"> <summary> <para> <para>The type of long-term pricing option you want for the device, either 1-year or 3-year long-term pricing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWLongTermPricingCmdlet.SnowballType"> <summary> <para> <para>The type of Snow Family devices to use for the long-term pricing job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWLongTermPricingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LongTermPricingId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Snowball.Model.CreateLongTermPricingResponse). Specifying the name of a property of type Amazon.Snowball.Model.CreateLongTermPricingResponse 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.SNOW.NewSNOWLongTermPricingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LongTermPricingType parameter. The -PassThru parameter is deprecated, use -Select '^LongTermPricingType' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWLongTermPricingCmdlet.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.SNOW.NewSNOWReturnShippingLabelCmdlet"> <summary> Creates a shipping label that will be used to return the Snow device to Amazon Web Services. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWReturnShippingLabelCmdlet.JobId"> <summary> <para> <para>The ID for a job that you want to create the return shipping label for; for example, <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWReturnShippingLabelCmdlet.ShippingOption"> <summary> <para> <para>The shipping speed for a particular job. This speed doesn't dictate how soon the device is returned to Amazon Web Services. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows:</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWReturnShippingLabelCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Status'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Snowball.Model.CreateReturnShippingLabelResponse). Specifying the name of a property of type Amazon.Snowball.Model.CreateReturnShippingLabelResponse 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.SNOW.NewSNOWReturnShippingLabelCmdlet.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="P:Amazon.PowerShell.Cmdlets.SNOW.NewSNOWReturnShippingLabelCmdlet.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.SNOW.StopSNOWClusterCmdlet"> <summary> Cancels a cluster job. You can only cancel a cluster job while it's in the <code>AwaitingQuorum</code> status. You'll have at least an hour after creating a cluster job to cancel it. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.StopSNOWClusterCmdlet.ClusterId"> <summary> <para> <para>The 39-character ID for the cluster that you want to cancel, for example <code>CID123e4567-e89b-12d3-a456-426655440000</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.StopSNOWClusterCmdlet.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.Snowball.Model.CancelClusterResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.StopSNOWClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterId parameter. The -PassThru parameter is deprecated, use -Select '^ClusterId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.StopSNOWClusterCmdlet.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.SNOW.StopSNOWJobCmdlet"> <summary> Cancels the specified job. You can only cancel a job before its <code>JobState</code> value changes to <code>PreparingAppliance</code>. Requesting the <code>ListJobs</code> or <code>DescribeJob</code> action returns a job's <code>JobState</code> as part of the response element data returned. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.StopSNOWJobCmdlet.JobId"> <summary> <para> <para>The 39-character job ID for the job that you want to cancel, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.StopSNOWJobCmdlet.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.Snowball.Model.CancelJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.StopSNOWJobCmdlet.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="P:Amazon.PowerShell.Cmdlets.SNOW.StopSNOWJobCmdlet.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.SNOW.UpdateSNOWClusterCmdlet"> <summary> While a cluster's <code>ClusterState</code> value is in the <code>AwaitingQuorum</code> state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.AddressId"> <summary> <para> <para>The ID of the updated <a>Address</a> object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.ClusterId"> <summary> <para> <para>The cluster ID of the cluster that you want to update, for example <code>CID123e4567-e89b-12d3-a456-426655440000</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.Description"> <summary> <para> <para>The updated description of this cluster.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.Resources_Ec2AmiResource"> <summary> <para> <para>The Amazon Machine Images (AMIs) associated with this job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.EKSOnDeviceService_EKSAnywhereVersion"> <summary> <para> <para>The version of EKS Anywhere on the Snow Family device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.S3OnDeviceService_FaultTolerance"> <summary> <para> <para>>Fault tolerance level of the cluster. This indicates the number of nodes that can go down without degrading the performance of the cluster. This additional input helps when the specified <code>StorageLimit</code> matches more than one Amazon S3 compatible storage on Snow family devices service configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.ForwardingAddressId"> <summary> <para> <para>The updated ID for the forwarding address for a cluster. This field is not supported in most regions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.Notification_JobStatesToNotify"> <summary> <para> <para>The list of job states that will trigger a notification for this job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.EKSOnDeviceService_KubernetesVersion"> <summary> <para> <para>The Kubernetes version for EKS Anywhere on the Snow Family device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.Resources_LambdaResource"> <summary> <para> <para>The Python-language Lambda functions for this job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.Notification_NotifyAll"> <summary> <para> <para>Any change in job state will trigger a notification for this job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.RoleARN"> <summary> <para> <para>The new role Amazon Resource Name (ARN) that you want to associate with this cluster. To create a role ARN, use the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a> API action in Identity and Access Management (IAM).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.Resources_S3Resource"> <summary> <para> <para>An array of <code>S3Resource</code> objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.S3OnDeviceService_ServiceSize"> <summary> <para> <para>Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snow family devices. If specified, the other input can be omitted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.ShippingOption"> <summary> <para> <para>The updated shipping option value of this cluster's <a>ShippingDetails</a> object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.Notification_SnsTopicARN"> <summary> <para> <para>The new SNS <code>TopicArn</code> that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html">CreateTopic</a> Amazon SNS API action.</para><para>You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html">Subscribe</a> Amazon Simple Notification Service (Amazon SNS) API action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.NFSOnDeviceService_StorageLimit"> <summary> <para> <para>The maximum NFS storage for one Snow Family device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.S3OnDeviceService_StorageLimit"> <summary> <para> <para>If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used. If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has the same storage limit as specified, the other input need to be provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.TGWOnDeviceService_StorageLimit"> <summary> <para> <para>The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.NFSOnDeviceService_StorageUnit"> <summary> <para> <para>The scale unit of the NFS storage on the device.</para><para>Valid values: TB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.S3OnDeviceService_StorageUnit"> <summary> <para> <para>Storage unit. Currently the only supported unit is TB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.TGWOnDeviceService_StorageUnit"> <summary> <para> <para>The scale unit of the virtual tapes on the device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.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.Snowball.Model.UpdateClusterResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ClusterId parameter. The -PassThru parameter is deprecated, use -Select '^ClusterId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWClusterCmdlet.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.SNOW.UpdateSNOWJobCmdlet"> <summary> While a job's <code>JobState</code> value is <code>New</code>, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.AddressId"> <summary> <para> <para>The ID of the updated <a>Address</a> object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.Description"> <summary> <para> <para>The updated description of this job's <a>JobMetadata</a> object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.Resources_Ec2AmiResource"> <summary> <para> <para>The Amazon Machine Images (AMIs) associated with this job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.EKSOnDeviceService_EKSAnywhereVersion"> <summary> <para> <para>The version of EKS Anywhere on the Snow Family device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.S3OnDeviceService_FaultTolerance"> <summary> <para> <para>>Fault tolerance level of the cluster. This indicates the number of nodes that can go down without degrading the performance of the cluster. This additional input helps when the specified <code>StorageLimit</code> matches more than one Amazon S3 compatible storage on Snow family devices service configuration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.ForwardingAddressId"> <summary> <para> <para>The updated ID for the forwarding address for a job. This field is not supported in most regions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.JobId"> <summary> <para> <para>The job ID of the job that you want to update, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.Notification_JobStatesToNotify"> <summary> <para> <para>The list of job states that will trigger a notification for this job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.EKSOnDeviceService_KubernetesVersion"> <summary> <para> <para>The Kubernetes version for EKS Anywhere on the Snow Family device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.Resources_LambdaResource"> <summary> <para> <para>The Python-language Lambda functions for this job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.Notification_NotifyAll"> <summary> <para> <para>Any change in job state will trigger a notification for this job.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.RoleARN"> <summary> <para> <para>The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the <a href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html">CreateRole</a>Identity and Access Management (IAM) API action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.Resources_S3Resource"> <summary> <para> <para>An array of <code>S3Resource</code> objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.S3OnDeviceService_ServiceSize"> <summary> <para> <para>Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snow family devices. If specified, the other input can be omitted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.ShippingOption"> <summary> <para> <para>The updated shipping option value of this job's <a>ShippingDetails</a> object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.SnowballCapacityPreference"> <summary> <para> <para>The updated <code>SnowballCapacityPreference</code> of this job's <a>JobMetadata</a> object. The 50 TB Snowballs are only available in the US regions.</para><para>For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i> or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the <i>Snowcone User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.Notification_SnsTopicARN"> <summary> <para> <para>The new SNS <code>TopicArn</code> that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html">CreateTopic</a> Amazon SNS API action.</para><para>You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the <a href="https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html">Subscribe</a> Amazon Simple Notification Service (Amazon SNS) API action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.NFSOnDeviceService_StorageLimit"> <summary> <para> <para>The maximum NFS storage for one Snow Family device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.S3OnDeviceService_StorageLimit"> <summary> <para> <para>If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used. If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has the same storage limit as specified, the other input need to be provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.TGWOnDeviceService_StorageLimit"> <summary> <para> <para>The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.NFSOnDeviceService_StorageUnit"> <summary> <para> <para>The scale unit of the NFS storage on the device.</para><para>Valid values: TB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.S3OnDeviceService_StorageUnit"> <summary> <para> <para>Storage unit. Currently the only supported unit is TB.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.TGWOnDeviceService_StorageUnit"> <summary> <para> <para>The scale unit of the virtual tapes on the device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.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.Snowball.Model.UpdateJobResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.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="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobCmdlet.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.SNOW.UpdateSNOWJobShipmentStateCmdlet"> <summary> Updates the state when a shipment state changes to a different state. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobShipmentStateCmdlet.JobId"> <summary> <para> <para>The job ID of the job whose shipment date you want to update, for example <code>JID123e4567-e89b-12d3-a456-426655440000</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobShipmentStateCmdlet.ShipmentState"> <summary> <para> <para>The state of a device when it is being shipped. </para><para>Set to <code>RECEIVED</code> when the device arrives at your location.</para><para>Set to <code>RETURNED</code> when you have returned the device to Amazon Web Services.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobShipmentStateCmdlet.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.Snowball.Model.UpdateJobShipmentStateResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobShipmentStateCmdlet.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="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWJobShipmentStateCmdlet.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.SNOW.UpdateSNOWLongTermPricingCmdlet"> <summary> Updates the long-term pricing type. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWLongTermPricingCmdlet.IsLongTermPricingAutoRenew"> <summary> <para> <para>If set to <code>true</code>, specifies that the current long-term pricing type for the device should be automatically renewed before the long-term pricing contract expires.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWLongTermPricingCmdlet.LongTermPricingId"> <summary> <para> <para>The ID of the long-term pricing type for the device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWLongTermPricingCmdlet.ReplacementJob"> <summary> <para> <para>Specifies that a device that is ordered with long-term pricing should be replaced with a new device.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWLongTermPricingCmdlet.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.Snowball.Model.UpdateLongTermPricingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWLongTermPricingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LongTermPricingId parameter. The -PassThru parameter is deprecated, use -Select '^LongTermPricingId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.SNOW.UpdateSNOWLongTermPricingCmdlet.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> |