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 CreateJob API operation.

Syntax

New-SNOWJob
-AddressId <String>
-ClusterId <String>
-Description <String>
-PickupDetails_DevicePickupId <String>
-Notification_DevicePickupSnsTopicARN <String>
-Resources_Ec2AmiResource <Ec2AmiResource[]>
-EKSOnDeviceService_EKSAnywhereVersion <String>
-PickupDetails_Email <String>
-S3OnDeviceService_FaultTolerance <Int32>
-ForwardingAddressId <String>
-IND_GSTIN <String>
-PickupDetails_IdentificationExpirationDate <DateTime>
-PickupDetails_IdentificationIssuingOrg <String>
-PickupDetails_IdentificationNumber <String>
-ImpactLevel <ImpactLevel>
-WirelessConnection_IsWifiEnabled <Boolean>
-Notification_JobStatesToNotify <String[]>
-JobType <JobType>
-KmsKeyARN <String>
-EKSOnDeviceService_KubernetesVersion <String>
-Resources_LambdaResource <LambdaResource[]>
-LongTermPricingId <String>
-PickupDetails_Name <String>
-Notification_NotifyAll <Boolean>
-PickupDetails_PhoneNumber <String>
-RemoteManagement <RemoteManagement>
-RoleARN <String>
-Resources_S3Resource <S3Resource[]>
-S3OnDeviceService_ServiceSize <Int32>
-ShippingOption <ShippingOption>
-SnowballCapacityPreference <SnowballCapacity>
-SnowballType <SnowballType>
-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

Creates a job to import or export data between Amazon S3 and your on-premises data center. Your Amazon Web Services account must have the right trust policies and permissions in place to create a job for a Snow device. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster. Only the Snowball; Edge device type is supported when ordering clustered jobs. The device capacity is optional. Availability of device types differ by Amazon Web Services Region. For more information about Region availability, see Amazon Web Services Regional Services. Snow Family devices and their capacities.
  • Device type: SNC1_SSD
    • Capacity: T14
    • Description: Snowcone
  • Device type: SNC1_HDD
    • Capacity: T8
    • Description: Snowcone
  • Device type: EDGE_S
    • Capacity: T98
    • Description: Snowball Edge Storage Optimized for data transfer only
  • Device type: EDGE_CG
    • Capacity: T42
    • Description: Snowball Edge Compute Optimized with GPU
  • Device type: EDGE_C
    • Capacity: T42
    • Description: Snowball Edge Compute Optimized without GPU
  • Device type: EDGE
    • Capacity: T100
    • Description: Snowball Edge Storage Optimized with EC2 Compute
    This device is replaced with T98.
  • Device type: STANDARD
    • Capacity: T50
    • Description: Original Snowball device This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region
  • Device type: STANDARD
    • Capacity: T80
    • Description: Original Snowball device This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region.
  • Snow Family device type: RACK_5U_C
    • Capacity: T13
    • Description: Snowblade.
  • Device type: V3_5S
    • Capacity: T240
    • Description: Snowball Edge Storage Optimized 210TB

Parameters

-AddressId <String>
The ID for the address that you want the Snow device shipped to.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ClientConfig <AmazonSnowballConfig>
Amazon.PowerShell.Cmdlets.SNOW.AmazonSnowballClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterId <String>
The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
Defines an optional description of this specific job, for example Important Photos 2016-08-11.
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 forwarding address ID for a job. This field is not supported in most Regions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImpactLevel <ImpactLevel>
The highest impact level of data that will be stored or processed on the device, provided at job creation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IND_GSTIN <String>
The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTaxDocuments_IND_GSTIN
-JobType <JobType>
Defines the type of job that you're creating.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KmsKeyARN <String>
The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey Key Management Service (KMS) API action.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LongTermPricingId <String>
The ID of the long-term pricing type for the device.
Required?False
Position?Named
Accept pipeline input?True (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 AddressId parameter. The -PassThru parameter is deprecated, use -Select '^AddressId' 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)
-RemoteManagement <RemoteManagement>
Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Edge client to manage the device. When set to NOT_INSTALLED, remote management will not be available on 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 RoleARN that you want to associate with this job. RoleArns are created using the CreateRole Identity 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 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ShippingOption <ShippingOption>
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:
  • In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day.
  • 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.
  • In India, Snow devices are delivered in one to seven days.
  • In the US, you have access to one-day shipping and two-day shipping.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SnowballCapacityPreference <SnowballCapacity>
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.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)
-SnowballType <SnowballType>
The type of Snow Family devices to use for this job. For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.The type of Amazon Web Services Snow device to use for this job. Currently, the only supported device type for cluster jobs is EDGE.For more information, see Snowball Edge Device Options in the Snowball Edge Developer Guide.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
-WirelessConnection_IsWifiEnabled <Boolean>
Enables the Wi-Fi adapter on an Snowcone device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeviceConfiguration_SnowconeDeviceConfiguration_WirelessConnection_IsWifiEnabled

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

System.String or Amazon.Snowball.Model.CreateJobResponse
This cmdlet returns a System.String object. The service call response (type Amazon.Snowball.Model.CreateJobResponse) can also 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