AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Import/Export Snowball UpdateJob API operation.

Syntax

Update-SNOWJob
-JobId <String>
-AddressId <String>
-Description <String>
-PickupDetails_DevicePickupId <String>
-Notification_DevicePickupSnsTopicARN <String>
-Resources_Ec2AmiResource <Ec2AmiResource[]>
-EKSOnDeviceService_EKSAnywhereVersion <String>
-PickupDetails_Email <String>
-S3OnDeviceService_FaultTolerance <Int32>
-ForwardingAddressId <String>
-PickupDetails_IdentificationExpirationDate <DateTime>
-PickupDetails_IdentificationIssuingOrg <String>
-PickupDetails_IdentificationNumber <String>
-Notification_JobStatesToNotify <String[]>
-EKSOnDeviceService_KubernetesVersion <String>
-Resources_LambdaResource <LambdaResource[]>
-PickupDetails_Name <String>
-Notification_NotifyAll <Boolean>
-PickupDetails_PhoneNumber <String>
-RoleARN <String>
-Resources_S3Resource <S3Resource[]>
-S3OnDeviceService_ServiceSize <Int32>
-ShippingOption <ShippingOption>
-SnowballCapacityPreference <SnowballCapacity>
-Notification_SnsTopicARN <String>
-NFSOnDeviceService_StorageLimit <Int32>
-S3OnDeviceService_StorageLimit <Double>
-TGWOnDeviceService_StorageLimit <Int32>
-NFSOnDeviceService_StorageUnit <StorageUnit>
-S3OnDeviceService_StorageUnit <StorageUnit>
-TGWOnDeviceService_StorageUnit <StorageUnit>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonSnowballConfig>

Description

While a job's JobState value is New, 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.

Parameters

-AddressId <String>
The ID of the updated Address object.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonSnowballConfig>
Amazon.PowerShell.Cmdlets.SNOW.AmazonSnowballClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
The updated description of this job's JobMetadata object.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EKSOnDeviceService_EKSAnywhereVersion <String>
The optional version of EKS Anywhere on the Snow Family device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnDeviceServiceConfiguration_EKSOnDeviceService_EKSAnywhereVersion
-EKSOnDeviceService_KubernetesVersion <String>
The Kubernetes version for EKS Anywhere on the Snow Family device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnDeviceServiceConfiguration_EKSOnDeviceService_KubernetesVersion
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ForwardingAddressId <String>
The updated ID for the forwarding address for a job. This field is not supported in most regions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobId <String>
The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-NFSOnDeviceService_StorageLimit <Int32>
The maximum NFS storage for one Snow Family device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnDeviceServiceConfiguration_NFSOnDeviceService_StorageLimit
-NFSOnDeviceService_StorageUnit <StorageUnit>
The scale unit of the NFS storage on the device.Valid values: TB.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnDeviceServiceConfiguration_NFSOnDeviceService_StorageUnit
-Notification_DevicePickupSnsTopicARN <String>
Used to send SNS notifications for the person picking up the device (identified during job creation).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Notification_JobStatesToNotify <String[]>
The list of job states that will trigger a notification for this job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Notification_NotifyAll <Boolean>
Any change in job state will trigger a notification for this job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Notification_SnsTopicARN <String>
The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action.You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PickupDetails_DevicePickupId <String>
The unique ID for a device that will be picked up.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PickupDetails_Email <String>
The email address of the person picking up the device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PickupDetails_IdentificationExpirationDate <DateTime>
Expiration date of the credential identifying the person picking up the device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PickupDetails_IdentificationIssuingOrg <String>
Organization that issued the credential identifying the person picking up the device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PickupDetails_IdentificationNumber <String>
The number on the credential identifying the person picking up the device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PickupDetails_Name <String>
The name of the person picking up the device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PickupDetails_PhoneNumber <String>
The phone number of the person picking up the device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Resources_Ec2AmiResource <Ec2AmiResource[]>
The Amazon Machine Images (AMIs) associated with this job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResources_Ec2AmiResources
-Resources_LambdaResource <LambdaResource[]>
The Python-language Lambda functions for this job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResources_LambdaResources
-Resources_S3Resource <S3Resource[]>
An array of S3Resource objects.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesResources_S3Resources
-RoleARN <String>
The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the CreateRoleIdentity and Access Management (IAM) API action.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3OnDeviceService_FaultTolerance <Int32>
>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 StorageLimit matches more than one Amazon S3 compatible storage on Snow family devices service configuration.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnDeviceServiceConfiguration_S3OnDeviceService_FaultTolerance
-S3OnDeviceService_ServiceSize <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnDeviceServiceConfiguration_S3OnDeviceService_ServiceSize
-S3OnDeviceService_StorageLimit <Double>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnDeviceServiceConfiguration_S3OnDeviceService_StorageLimit
-S3OnDeviceService_StorageUnit <StorageUnit>
Storage unit. Currently the only supported unit is TB.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnDeviceServiceConfiguration_S3OnDeviceService_StorageUnit
-Select <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ShippingOption <ShippingOption>
The updated shipping option value of this job's ShippingDetails object.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SnowballCapacityPreference <SnowballCapacity>
The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs are only available in the US regions.For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TGWOnDeviceService_StorageLimit <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnDeviceServiceConfiguration_TGWOnDeviceService_StorageLimit
-TGWOnDeviceService_StorageUnit <StorageUnit>
The scale unit of the virtual tapes on the device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOnDeviceServiceConfiguration_TGWOnDeviceService_StorageUnit

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

None or Amazon.Snowball.Model.UpdateJobResponse
This cmdlet does not generate any output.The service response (type Amazon.Snowball.Model.UpdateJobResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Service User Guide
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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