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

Invokes the CreateJob operation against AWS Import/Export Snowball.

Syntax

New-SNOWJob
-AddressId <String>
-ClusterId <String>
-Description <String>
-ForwardingAddressId <String>
-Notification_JobStatesToNotify <String[]>
-JobType <JobType>
-KmsKeyARN <String>
-Resources_LambdaResource <LambdaResource[]>
-Notification_NotifyAll <Boolean>
-RoleARN <String>
-Resources_S3Resource <S3Resource[]>
-ShippingOption <ShippingOption>
-SnowballCapacityPreference <SnowballCapacity>
-SnowballType <SnowballType>
-Notification_SnsTopicARN <String>
-Force <SwitchParameter>

Description

Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must have the right trust policies and permissions in place to create a job for Snowball. 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.

Parameters

-AddressId <String>
The ID for the address that you want the Snowball shipped to.
Required?False
Position?1
Accept pipeline input?True (ByValue, 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?False
-Description <String>
Defines an optional description of this specific job, for example Important Photos 2016-08-11.
Required?False
Position?Named
Accept pipeline input?False
-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?False
-ForwardingAddressId <String>
The forwarding address ID for a job. This field is not supported in most regions.
Required?False
Position?Named
Accept pipeline input?False
-JobType <JobType>
Defines the type of job that you're creating.
Required?False
Position?Named
Accept pipeline input?False
-KmsKeyARN <String>
The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey AWS Key Management Service (KMS) API action.
Required?False
Position?Named
Accept pipeline input?False
-Notification_JobStatesToNotify <String[]>
The list of job states that will trigger a notification for this job.
Required?False
Position?Named
Accept pipeline input?False
-Notification_NotifyAll <Boolean>
Any change in job state will trigger a notification for this job.
Required?False
Position?Named
Accept pipeline input?False
-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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action.
Required?False
Position?Named
Accept pipeline input?False
-Resources_LambdaResource <LambdaResource[]>
The Python-language Lambda functions for this job.
Required?False
Position?Named
Accept pipeline input?False
-Resources_S3Resource <S3Resource[]>
An array of S3Resource objects.
Required?False
Position?Named
Accept pipeline input?False
-RoleARN <String>
The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole AWS Identity and Access Management (IAM) API action.
Required?False
Position?Named
Accept pipeline input?False
-ShippingOption <ShippingOption>
The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snowball, rather it represents how quickly the Snowball moves to its destination while in transit. Regional shipping speeds are as follows:
  • In Australia, you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day.
  • In the European Union (EU), you have access to express shipping. Typically, Snowballs 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, Snowballs 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?False
-SnowballCapacityPreference <SnowballCapacity>
If your job is being created in one of the US regions, you have the option of specifying what size Snowball you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.
Required?False
Position?Named
Accept pipeline input?False
-SnowballType <SnowballType>
The type of AWS Snowball appliance to use for this job. Currently, the only supported appliance type for cluster jobs is EDGE.
Required?False
Position?Named
Accept pipeline input?False

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? False
-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? False
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

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? False
-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? False
-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? False
-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? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-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? False

Inputs

You can pipe a String object to this cmdlet for the AddressId parameter.

Outputs

This cmdlet returns a 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.

Supported Version

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