AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . snowball ]

create-job

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.

Note

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

Note

This device is replaced with T98.

  • Device type: STANDARD

    • Capacity: T50
    • Description: Original Snowball device

    Note

    This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region

  • Device type: STANDARD

    • Capacity: T80
    • Description: Original Snowball device

    Note

    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

See also: AWS API Documentation

Synopsis

  create-job
[--job-type <value>]
[--resources <value>]
[--on-device-service-configuration <value>]
[--description <value>]
[--address-id <value>]
[--kms-key-arn <value>]
[--role-arn <value>]
[--snowball-capacity-preference <value>]
[--shipping-option <value>]
[--notification <value>]
[--cluster-id <value>]
[--snowball-type <value>]
[--forwarding-address-id <value>]
[--tax-documents <value>]
[--device-configuration <value>]
[--remote-management <value>]
[--long-term-pricing-id <value>]
[--impact-level <value>]
[--pickup-details <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--job-type (string)

Defines the type of job that you're creating.

Possible values:

  • IMPORT
  • EXPORT
  • LOCAL_USE

--resources (structure)

Defines the Amazon S3 buckets associated with this job.

With IMPORT jobs, you specify the bucket or buckets that your transferred data will be imported into.

With EXPORT jobs, you specify the bucket or buckets that your transferred data will be exported from. Optionally, you can also specify a KeyRange value. If you choose to export a range, you define the length of the range by providing either an inclusive BeginMarker value, an inclusive EndMarker value, or both. Ranges are UTF-8 binary sorted.

S3Resources -> (list)

An array of S3Resource objects.

(structure)

Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into. For export jobs, this object can have an optional KeyRange value. The length of the range is defined at job creation, and has either an inclusive BeginMarker , an inclusive EndMarker , or both. Ranges are UTF-8 binary sorted.

BucketArn -> (string)

The Amazon Resource Name (ARN) of an Amazon S3 bucket.

KeyRange -> (structure)

For export jobs, you can provide an optional KeyRange within a specific Amazon S3 bucket. The length of the range is defined at job creation, and has either an inclusive BeginMarker , an inclusive EndMarker , or both. Ranges are UTF-8 binary sorted.

BeginMarker -> (string)

The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

EndMarker -> (string)

The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

TargetOnDeviceServices -> (list)

Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System).

(structure)

An object that represents the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System).

ServiceName -> (string)

Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.

TransferOption -> (string)

Specifies whether the data is being imported or exported. You can import or export the data, or use it locally on the device.

LambdaResources -> (list)

The Python-language Lambda functions for this job.

(structure)

Identifies

LambdaArn -> (string)

An Amazon Resource Name (ARN) that represents an Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.

EventTriggers -> (list)

The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.

(structure)

The container for the EventTriggerDefinition$EventResourceARN .

EventResourceARN -> (string)

The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an Lambda function's event trigger associated with this job.

Ec2AmiResources -> (list)

The Amazon Machine Images (AMIs) associated with this job.

(structure)

A JSON-formatted object that contains the IDs for an Amazon Machine Image (AMI), including the Amazon EC2-compatible AMI ID and the Snow device AMI ID. Each AMI has these two IDs to simplify identifying the AMI in both the Amazon Web Services Cloud and on the device.

AmiId -> (string)

The ID of the AMI in Amazon EC2.

SnowballAmiId -> (string)

The ID of the AMI on the Snow device.

JSON Syntax:

{
  "S3Resources": [
    {
      "BucketArn": "string",
      "KeyRange": {
        "BeginMarker": "string",
        "EndMarker": "string"
      },
      "TargetOnDeviceServices": [
        {
          "ServiceName": "NFS_ON_DEVICE_SERVICE"|"S3_ON_DEVICE_SERVICE",
          "TransferOption": "IMPORT"|"EXPORT"|"LOCAL_USE"
        }
        ...
      ]
    }
    ...
  ],
  "LambdaResources": [
    {
      "LambdaArn": "string",
      "EventTriggers": [
        {
          "EventResourceARN": "string"
        }
        ...
      ]
    }
    ...
  ],
  "Ec2AmiResources": [
    {
      "AmiId": "string",
      "SnowballAmiId": "string"
    }
    ...
  ]
}

--on-device-service-configuration (structure)

Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System) and the Amazon Web Services Storage Gateway service Tape Gateway type.

NFSOnDeviceService -> (structure)

Represents the NFS (Network File System) service on a Snow Family device.

StorageLimit -> (integer)

The maximum NFS storage for one Snow Family device.

StorageUnit -> (string)

The scale unit of the NFS storage on the device.

Valid values: TB.

TGWOnDeviceService -> (structure)

Represents the Storage Gateway service Tape Gateway type on a Snow Family device.

StorageLimit -> (integer)

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.

StorageUnit -> (string)

The scale unit of the virtual tapes on the device.

EKSOnDeviceService -> (structure)

The configuration of EKS Anywhere on the Snow Family device.

KubernetesVersion -> (string)

The Kubernetes version for EKS Anywhere on the Snow Family device.

EKSAnywhereVersion -> (string)

The optional version of EKS Anywhere on the Snow Family device.

S3OnDeviceService -> (structure)

Configuration for Amazon S3 compatible storage on Snow family devices.

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.

StorageUnit -> (string)

Storage unit. Currently the only supported unit is TB.

ServiceSize -> (integer)

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.

FaultTolerance -> (integer)

>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.

Shorthand Syntax:

NFSOnDeviceService={StorageLimit=integer,StorageUnit=string},TGWOnDeviceService={StorageLimit=integer,StorageUnit=string},EKSOnDeviceService={KubernetesVersion=string,EKSAnywhereVersion=string},S3OnDeviceService={StorageLimit=double,StorageUnit=string,ServiceSize=integer,FaultTolerance=integer}

JSON Syntax:

{
  "NFSOnDeviceService": {
    "StorageLimit": integer,
    "StorageUnit": "TB"
  },
  "TGWOnDeviceService": {
    "StorageLimit": integer,
    "StorageUnit": "TB"
  },
  "EKSOnDeviceService": {
    "KubernetesVersion": "string",
    "EKSAnywhereVersion": "string"
  },
  "S3OnDeviceService": {
    "StorageLimit": double,
    "StorageUnit": "TB",
    "ServiceSize": integer,
    "FaultTolerance": integer
  }
}

--description (string)

Defines an optional description of this specific job, for example Important Photos 2016-08-11 .

--address-id (string)

The ID for the address that you want the Snow device shipped to.

--kms-key-arn (string)

The KmsKeyARN that you want to associate with this job. KmsKeyARN s are created using the CreateKey Key Management Service (KMS) API action.

--role-arn (string)

The RoleARN that you want to associate with this job. RoleArn s are created using the CreateRole Identity and Access Management (IAM) API action.

--snowball-capacity-preference (string)

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 .

Possible values:

  • T50
  • T80
  • T100
  • T42
  • T98
  • T8
  • T14
  • T32
  • NoPreference
  • T240
  • T13

--shipping-option (string)

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.

Possible values:

  • SECOND_DAY
  • NEXT_DAY
  • EXPRESS
  • STANDARD

--notification (structure)

Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.

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.

JobStatesToNotify -> (list)

The list of job states that will trigger a notification for this job.

(string)

NotifyAll -> (boolean)

Any change in job state will trigger a notification for this job.

DevicePickupSnsTopicARN -> (string)

Used to send SNS notifications for the person picking up the device (identified during job creation).

Shorthand Syntax:

SnsTopicARN=string,JobStatesToNotify=string,string,NotifyAll=boolean,DevicePickupSnsTopicARN=string

JSON Syntax:

{
  "SnsTopicARN": "string",
  "JobStatesToNotify": ["New"|"PreparingAppliance"|"PreparingShipment"|"InTransitToCustomer"|"WithCustomer"|"InTransitToAWS"|"WithAWSSortingFacility"|"WithAWS"|"InProgress"|"Complete"|"Cancelled"|"Listing"|"Pending", ...],
  "NotifyAll": true|false,
  "DevicePickupSnsTopicARN": "string"
}

--cluster-id (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.

--snowball-type (string)

The type of Snow Family devices to use for this job.

Note

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 .

Possible values:

  • STANDARD
  • EDGE
  • EDGE_C
  • EDGE_CG
  • EDGE_S
  • SNC1_HDD
  • SNC1_SSD
  • V3_5C
  • V3_5S
  • RACK_5U_C

--forwarding-address-id (string)

The forwarding address ID for a job. This field is not supported in most Regions.

--tax-documents (structure)

The tax documents required in your Amazon Web Services Region.

IND -> (structure)

The tax documents required in Amazon Web Services Region in India.

GSTIN -> (string)

The Goods and Services Tax (GST) documents required in Amazon Web Services Region in India.

Shorthand Syntax:

IND={GSTIN=string}

JSON Syntax:

{
  "IND": {
    "GSTIN": "string"
  }
}

--device-configuration (structure)

Defines the device configuration for an Snowcone job.

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 .

SnowconeDeviceConfiguration -> (structure)

Returns information about the device configuration for an Snowcone job.

WirelessConnection -> (structure)

Configures the wireless connection for the Snowcone device.

IsWifiEnabled -> (boolean)

Enables the Wi-Fi adapter on an Snowcone device.

Shorthand Syntax:

SnowconeDeviceConfiguration={WirelessConnection={IsWifiEnabled=boolean}}

JSON Syntax:

{
  "SnowconeDeviceConfiguration": {
    "WirelessConnection": {
      "IsWifiEnabled": true|false
    }
  }
}

--remote-management (string)

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.

Possible values:

  • INSTALLED_ONLY
  • INSTALLED_AUTOSTART
  • NOT_INSTALLED

--long-term-pricing-id (string)

The ID of the long-term pricing type for the device.

--impact-level (string)

The highest impact level of data that will be stored or processed on the device, provided at job creation.

Possible values:

  • IL2
  • IL4
  • IL5
  • IL6
  • IL99

--pickup-details (structure)

Information identifying the person picking up the device.

Name -> (string)

The name of the person picking up the device.

PhoneNumber -> (string)

The phone number of the person picking up the device.

Email -> (string)

The email address of the person picking up the device.

IdentificationNumber -> (string)

The number on the credential identifying the person picking up the device.

IdentificationExpirationDate -> (timestamp)

Expiration date of the credential identifying the person picking up the device.

IdentificationIssuingOrg -> (string)

Organization that issued the credential identifying the person picking up the device.

DevicePickupId -> (string)

The unique ID for a device that will be picked up.

Shorthand Syntax:

Name=string,PhoneNumber=string,Email=string,IdentificationNumber=string,IdentificationExpirationDate=timestamp,IdentificationIssuingOrg=string,DevicePickupId=string

JSON Syntax:

{
  "Name": "string",
  "PhoneNumber": "string",
  "Email": "string",
  "IdentificationNumber": "string",
  "IdentificationExpirationDate": timestamp,
  "IdentificationIssuingOrg": "string",
  "DevicePickupId": "string"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

JobId -> (string)

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000 .