Class: AWS.Snowball

Inherits:
AWS.Service show all
Identifier:
snowball
API Version:
2016-06-30
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Sending a Request Using Snowball

var snowball = new AWS.Snowball();
snowball.cancelCluster(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Snowball object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var snowball = new AWS.Snowball({apiVersion: '2016-06-30'});

You can also set the API version globally in AWS.config.apiVersions using the snowball service identifier:

AWS.config.apiVersions = {
  snowball: '2016-06-30',
  // other service API versions
};

var snowball = new AWS.Snowball();

Version:

  • 2016-06-30

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.Snowball(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Snowball object

var snowball = new AWS.Snowball({apiVersion: '2016-06-30'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.Snowball.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.Snowball.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Snowball.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

cancelCluster(params = {}, callback) ⇒ AWS.Request

Cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status. You'll have at least an hour after creating a cluster job to cancel it.

Service Reference:

Examples:

To cancel a cluster job


/* This operation cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status. */

 var params = {
  ClusterId: "CID123e4567-e89b-12d3-a456-426655440000"
 };
 snowball.cancelCluster(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the cancelCluster operation

var params = {
  ClusterId: 'STRING_VALUE' /* required */
};
snowball.cancelCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClusterId — (String)

      The 39-character ID for the cluster that you want to cancel, for example CID123e4567-e89b-12d3-a456-426655440000.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

cancelJob(params = {}, callback) ⇒ AWS.Request

Cancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action will return a job's JobState as part of the response element data returned.

Service Reference:

Examples:

To cancel a job for a Snowball device


/* This operation cancels a job. You can only cancel a job before its JobState value changes to PreparingAppliance. */

 var params = {
  JobId: "JID123e4567-e89b-12d3-a456-426655440000"
 };
 snowball.cancelJob(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the cancelJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
snowball.cancelJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

      The 39-character job ID for the job that you want to cancel, for example JID123e4567-e89b-12d3-a456-426655440000.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createAddress(params = {}, callback) ⇒ AWS.Request

Creates an address for a Snowball to be shipped to.

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.

Service Reference:

Examples:

To create an address for a job


/* This operation creates an address for a job. 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. */

 var params = {
  Address: {
   City: "Seattle", 
   Company: "My Company's Name", 
   Country: "USA", 
   Name: "My Name", 
   PhoneNumber: "425-555-5555", 
   PostalCode: "98101", 
   StateOrProvince: "WA", 
   Street1: "123 Main Street"
  }
 };
 snowball.createAddress(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    AddressId: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b"
   }
   */
 });

Calling the createAddress operation

var params = {
  Address: { /* required */
    AddressId: 'STRING_VALUE',
    City: 'STRING_VALUE',
    Company: 'STRING_VALUE',
    Country: 'STRING_VALUE',
    Landmark: 'STRING_VALUE',
    Name: 'STRING_VALUE',
    PhoneNumber: 'STRING_VALUE',
    PostalCode: 'STRING_VALUE',
    PrefectureOrDistrict: 'STRING_VALUE',
    StateOrProvince: 'STRING_VALUE',
    Street1: 'STRING_VALUE',
    Street2: 'STRING_VALUE',
    Street3: 'STRING_VALUE'
  }
};
snowball.createAddress(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Address — (map)

      The address that you want the Snowball shipped to.

      • AddressId — (String)

        The unique ID for an address.

      • Name — (String)

        The name of a person to receive a Snowball at an address.

      • Company — (String)

        The name of the company to receive a Snowball at an address.

      • Street1 — (String)

        The first line in a street address that a Snowball is to be delivered to.

      • Street2 — (String)

        The second line in a street address that a Snowball is to be delivered to.

      • Street3 — (String)

        The third line in a street address that a Snowball is to be delivered to.

      • City — (String)

        The city in an address that a Snowball is to be delivered to.

      • StateOrProvince — (String)

        The state or province in an address that a Snowball is to be delivered to.

      • PrefectureOrDistrict — (String)

        The prefecture or district that the appliance will be shipped to.

      • Landmark — (String)

        The landmark identifying the address that the appliance will be shipped to.

      • Country — (String)

        The country in an address that a Snowball is to be delivered to.

      • PostalCode — (String)

        The postal code in an address that a Snowball is to be delivered to.

      • PhoneNumber — (String)

        The phone number associated with an address that a Snowball is to be delivered to.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AddressId — (String)

        The automatically generated ID for a specific address. You'll use this ID when you create a job to specify which address you want the Snowball for that job shipped to.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createCluster(params = {}, callback) ⇒ AWS.Request

Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.

Service Reference:

Examples:

To create a cluster


/* Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created. */

 var params = {
  AddressId: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", 
  Description: "MyCluster", 
  JobType: "LOCAL_USE", 
  KmsKeyARN: "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456", 
  Notification: {
   JobStatesToNotify: [
   ], 
   NotifyAll: false
  }, 
  Resources: {
   S3Resources: [
      {
     BucketArn: "arn:aws:s3:::MyBucket", 
     KeyRange: {
     }
    }
   ]
  }, 
  RoleARN: "arn:aws:iam::123456789012:role/snowball-import-S3-role", 
  ShippingOption: "SECOND_DAY", 
  SnowballType: "EDGE"
 };
 snowball.createCluster(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ClusterId: "CID123e4567-e89b-12d3-a456-426655440000"
   }
   */
 });

Calling the createCluster operation

var params = {
  AddressId: 'STRING_VALUE', /* required */
  JobType: IMPORT | EXPORT | LOCAL_USE, /* required */
  Resources: { /* required */
    LambdaResources: [
      {
        EventTriggers: [
          {
            EventResourceARN: 'STRING_VALUE'
          },
          /* more items */
        ],
        LambdaArn: 'STRING_VALUE'
      },
      /* more items */
    ],
    S3Resources: [
      {
        BucketArn: 'STRING_VALUE',
        KeyRange: {
          BeginMarker: 'STRING_VALUE',
          EndMarker: 'STRING_VALUE'
        }
      },
      /* more items */
    ]
  },
  RoleARN: 'STRING_VALUE', /* required */
  ShippingOption: SECOND_DAY | NEXT_DAY | EXPRESS | STANDARD, /* required */
  Description: 'STRING_VALUE',
  KmsKeyARN: 'STRING_VALUE',
  Notification: {
    JobStatesToNotify: [
      New | PreparingAppliance | PreparingShipment | InTransitToCustomer | WithCustomer | InTransitToAWS | WithAWS | InProgress | Complete | Cancelled | Listing | Pending,
      /* more items */
    ],
    NotifyAll: true || false,
    SnsTopicARN: 'STRING_VALUE'
  },
  SnowballType: STANDARD | EDGE
};
snowball.createCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobType — (String)

      The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.

      Possible values include:
      • "IMPORT"
      • "EXPORT"
      • "LOCAL_USE"
    • Resources — (map)

      The resources associated with the cluster job. These resources include Amazon S3 buckets and optional AWS Lambda functions written in the Python language.

      • S3Resources — (Array<map>)

        An array of S3Resource objects.

        • BucketArn — (String)

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

        • KeyRange — (map)

          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.

      • LambdaResources — (Array<map>)

        The Python-language Lambda functions for this job.

        • LambdaArn — (String)

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

        • EventTriggers — (Array<map>)

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

          • EventResourceARN — (String)

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

    • Description — (String)

      An optional description of this specific cluster, for example Environmental Data Cluster-01.

    • AddressId — (String)

      The ID for the address that you want the cluster shipped to.>

    • KmsKeyARN — (String)

      The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in AWS Key Management Service (AWS KMS).

    • RoleARN — (String)

      The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in AWS Identity and Access Management (IAM).

    • SnowballType — (String)

      The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for cluster jobs is EDGE.

      Possible values include:
      • "STANDARD"
      • "EDGE"
    • ShippingOption — (String)

      The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge appliance, rather it represents how quickly each appliance moves to its destination while in transit. Regional shipping speeds are as follows:

      • In Australia, you have access to express shipping. Typically, appliances shipped express are delivered in about a day.

      • In the European Union (EU), you have access to express shipping. Typically, Snowball Edges 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, Snowball Edges are delivered in one to seven days.

      • In the US, you have access to one-day shipping and two-day shipping.

      Possible values include:
      • "SECOND_DAY"
      • "NEXT_DAY"
      • "EXPRESS"
      • "STANDARD"
    • Notification — (map)

      The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.

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

      • JobStatesToNotify — (Array<String>)

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

      • NotifyAll — (Boolean)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClusterId — (String)

        The automatically generated ID for a cluster.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createJob(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

To create a job


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

 var params = {
  AddressId: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", 
  Description: "My Job", 
  JobType: "IMPORT", 
  KmsKeyARN: "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456", 
  Notification: {
   JobStatesToNotify: [
   ], 
   NotifyAll: false
  }, 
  Resources: {
   S3Resources: [
      {
     BucketArn: "arn:aws:s3:::MyBucket", 
     KeyRange: {
     }
    }
   ]
  }, 
  RoleARN: "arn:aws:iam::123456789012:role/snowball-import-S3-role", 
  ShippingOption: "SECOND_DAY", 
  SnowballCapacityPreference: "T80", 
  SnowballType: "STANDARD"
 };
 snowball.createJob(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    JobId: "JID123e4567-e89b-12d3-a456-426655440000"
   }
   */
 });

Calling the createJob operation

var params = {
  AddressId: 'STRING_VALUE',
  ClusterId: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  JobType: IMPORT | EXPORT | LOCAL_USE,
  KmsKeyARN: 'STRING_VALUE',
  Notification: {
    JobStatesToNotify: [
      New | PreparingAppliance | PreparingShipment | InTransitToCustomer | WithCustomer | InTransitToAWS | WithAWS | InProgress | Complete | Cancelled | Listing | Pending,
      /* more items */
    ],
    NotifyAll: true || false,
    SnsTopicARN: 'STRING_VALUE'
  },
  Resources: {
    LambdaResources: [
      {
        EventTriggers: [
          {
            EventResourceARN: 'STRING_VALUE'
          },
          /* more items */
        ],
        LambdaArn: 'STRING_VALUE'
      },
      /* more items */
    ],
    S3Resources: [
      {
        BucketArn: 'STRING_VALUE',
        KeyRange: {
          BeginMarker: 'STRING_VALUE',
          EndMarker: 'STRING_VALUE'
        }
      },
      /* more items */
    ]
  },
  RoleARN: 'STRING_VALUE',
  ShippingOption: SECOND_DAY | NEXT_DAY | EXPRESS | STANDARD,
  SnowballCapacityPreference: T50 | T80 | T100 | NoPreference,
  SnowballType: STANDARD | EDGE
};
snowball.createJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobType — (String)

      Defines the type of job that you're creating.

      Possible values include:
      • "IMPORT"
      • "EXPORT"
      • "LOCAL_USE"
    • Resources — (map)

      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 — (Array<map>)

        An array of S3Resource objects.

        • BucketArn — (String)

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

        • KeyRange — (map)

          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.

      • LambdaResources — (Array<map>)

        The Python-language Lambda functions for this job.

        • LambdaArn — (String)

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

        • EventTriggers — (Array<map>)

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

          • EventResourceARN — (String)

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

    • Description — (String)

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

    • AddressId — (String)

      The ID for the address that you want the Snowball shipped to.

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

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

    • SnowballCapacityPreference — (String)

      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.

      Possible values include:
      • "T50"
      • "T80"
      • "T100"
      • "NoPreference"
    • ShippingOption — (String)

      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.

      Possible values include:
      • "SECOND_DAY"
      • "NEXT_DAY"
      • "EXPRESS"
      • "STANDARD"
    • Notification — (map)

      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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action.

      • JobStatesToNotify — (Array<String>)

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

      • NotifyAll — (Boolean)

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

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

    • SnowballType — (String)

      The type of AWS Snowball appliance to use for this job. Currently, the only supported appliance type for cluster jobs is EDGE.

      Possible values include:
      • "STANDARD"
      • "EDGE"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobId — (String)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeAddress(params = {}, callback) ⇒ AWS.Request

Takes an AddressId and returns specific details about that address in the form of an Address object.

Service Reference:

Examples:

To describe an address for a job


/* This operation describes an address for a job. */

 var params = {
  AddressId: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b"
 };
 snowball.describeAddress(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Address: {
     AddressId: "ADID5643ec50-3eec-4eb3-9be6-9374c10eb51b", 
     City: "Seattle", 
     Company: "My Company", 
     Country: "US", 
     Name: "My Name", 
     PhoneNumber: "425-555-5555", 
     PostalCode: "98101", 
     StateOrProvince: "WA", 
     Street1: "123 Main Street"
    }
   }
   */
 });

Calling the describeAddress operation

var params = {
  AddressId: 'STRING_VALUE' /* required */
};
snowball.describeAddress(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AddressId — (String)

      The automatically generated ID for a specific address.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Address — (map)

        The address that you want the Snowball or Snowballs associated with a specific job to be shipped to.

        • AddressId — (String)

          The unique ID for an address.

        • Name — (String)

          The name of a person to receive a Snowball at an address.

        • Company — (String)

          The name of the company to receive a Snowball at an address.

        • Street1 — (String)

          The first line in a street address that a Snowball is to be delivered to.

        • Street2 — (String)

          The second line in a street address that a Snowball is to be delivered to.

        • Street3 — (String)

          The third line in a street address that a Snowball is to be delivered to.

        • City — (String)

          The city in an address that a Snowball is to be delivered to.

        • StateOrProvince — (String)

          The state or province in an address that a Snowball is to be delivered to.

        • PrefectureOrDistrict — (String)

          The prefecture or district that the appliance will be shipped to.

        • Landmark — (String)

          The landmark identifying the address that the appliance will be shipped to.

        • Country — (String)

          The country in an address that a Snowball is to be delivered to.

        • PostalCode — (String)

          The postal code in an address that a Snowball is to be delivered to.

        • PhoneNumber — (String)

          The phone number associated with an address that a Snowball is to be delivered to.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeAddresses(params = {}, callback) ⇒ AWS.Request

Returns a specified number of ADDRESS 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.

Service Reference:

Examples:

To describe all the addresses you've created for AWS Snowball


/* This operation describes all the addresses that you've created for AWS Snowball. 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. */

 var params = {
 };
 snowball.describeAddresses(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Addresses: [
       {
      AddressId: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", 
      City: "Seattle", 
      Company: "My Company", 
      Country: "US", 
      Name: "My Name", 
      PhoneNumber: "425-555-5555", 
      PostalCode: "98101", 
      StateOrProvince: "WA", 
      Street1: "123 Main Street"
     }
    ]
   }
   */
 });

Calling the describeAddresses operation

var params = {
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
snowball.describeAddresses(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

      The number of ADDRESS objects to return.

    • NextToken — (String)

      HTTP requests are stateless. To identify what object comes "next" in the list of ADDRESS objects, you have the option of specifying a value for NextToken as the starting point for your list of returned addresses.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Addresses — (Array<map>)

        The Snowball shipping addresses that were created for this account.

        • AddressId — (String)

          The unique ID for an address.

        • Name — (String)

          The name of a person to receive a Snowball at an address.

        • Company — (String)

          The name of the company to receive a Snowball at an address.

        • Street1 — (String)

          The first line in a street address that a Snowball is to be delivered to.

        • Street2 — (String)

          The second line in a street address that a Snowball is to be delivered to.

        • Street3 — (String)

          The third line in a street address that a Snowball is to be delivered to.

        • City — (String)

          The city in an address that a Snowball is to be delivered to.

        • StateOrProvince — (String)

          The state or province in an address that a Snowball is to be delivered to.

        • PrefectureOrDistrict — (String)

          The prefecture or district that the appliance will be shipped to.

        • Landmark — (String)

          The landmark identifying the address that the appliance will be shipped to.

        • Country — (String)

          The country in an address that a Snowball is to be delivered to.

        • PostalCode — (String)

          The postal code in an address that a Snowball is to be delivered to.

        • PhoneNumber — (String)

          The phone number associated with an address that a Snowball is to be delivered to.

      • NextToken — (String)

        HTTP requests are stateless. If you use the automatically generated NextToken value in your next DescribeAddresses call, your list of returned addresses will start from this point in the array.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeCluster(params = {}, callback) ⇒ AWS.Request

Returns information about a specific cluster including shipping information, cluster status, and other important metadata.

Service Reference:

Examples:

To describe a cluster


/* Returns information about a specific cluster including shipping information, cluster status, and other important metadata. */

 var params = {
  ClusterId: "CID123e4567-e89b-12d3-a456-426655440000"
 };
 snowball.describeCluster(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ClusterMetadata: {
     AddressId: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", 
     ClusterId: "CID123e4567-e89b-12d3-a456-426655440000", 
     ClusterState: "Pending", 
     CreationDate: <Date Representation>, 
     Description: "MyCluster", 
     JobType: "LOCAL_USE", 
     KmsKeyARN: "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456", 
     Notification: {
      JobStatesToNotify: [
      ], 
      NotifyAll: false
     }, 
     Resources: {
      S3Resources: [
         {
        BucketArn: "arn:aws:s3:::MyBucket", 
        KeyRange: {
        }
       }
      ]
     }, 
     RoleARN: "arn:aws:iam::123456789012:role/snowball-import-S3-role", 
     ShippingOption: "SECOND_DAY"
    }
   }
   */
 });

Calling the describeCluster operation

var params = {
  ClusterId: 'STRING_VALUE' /* required */
};
snowball.describeCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClusterId — (String)

      The automatically generated ID for a cluster.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClusterMetadata — (map)

        Information about a specific cluster, including shipping information, cluster status, and other important metadata.

        • ClusterId — (String)

          The automatically generated ID for a cluster.

        • Description — (String)

          The optional description of the cluster.

        • KmsKeyARN — (String)

          The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in AWS Key Management Service (AWS KMS).

        • RoleARN — (String)

          The role ARN associated with this cluster. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

        • ClusterState — (String)

          The current status of the cluster.

          Possible values include:
          • "AwaitingQuorum"
          • "Pending"
          • "InUse"
          • "Complete"
          • "Cancelled"
        • JobType — (String)

          The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.

          Possible values include:
          • "IMPORT"
          • "EXPORT"
          • "LOCAL_USE"
        • SnowballType — (String)

          The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for cluster jobs is EDGE.

          Possible values include:
          • "STANDARD"
          • "EDGE"
        • CreationDate — (Date)

          The creation date for this cluster.

        • Resources — (map)

          The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

          • S3Resources — (Array<map>)

            An array of S3Resource objects.

            • BucketArn — (String)

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

            • KeyRange — (map)

              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.

          • LambdaResources — (Array<map>)

            The Python-language Lambda functions for this job.

            • LambdaArn — (String)

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

            • EventTriggers — (Array<map>)

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

              • EventResourceARN — (String)

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

        • AddressId — (String)

          The automatically generated ID for a specific address.

        • ShippingOption — (String)

          The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge appliance, rather it represents how quickly each appliance moves to its destination while in transit. Regional shipping speeds are as follows:

          • In Australia, you have access to express shipping. Typically, appliances shipped express are delivered in about a day.

          • In the European Union (EU), you have access to express shipping. Typically, Snowball Edges 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, Snowball Edges are delivered in one to seven days.

          • In the US, you have access to one-day shipping and two-day shipping.

          Possible values include:
          • "SECOND_DAY"
          • "NEXT_DAY"
          • "EXPRESS"
          • "STANDARD"
        • Notification — (map)

          The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.

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

          • JobStatesToNotify — (Array<String>)

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

          • NotifyAll — (Boolean)

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

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeJob(params = {}, callback) ⇒ AWS.Request

Returns information about a specific job including shipping information, job status, and other important metadata. .

Service Reference:

Examples:

To describe a job you've created for AWS Snowball


/* This operation describes a job you've created for AWS Snowball. */

 var params = {
  JobId: "JID123e4567-e89b-12d3-a456-426655440000"
 };
 snowball.describeJob(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    JobMetadata: {
     AddressId: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", 
     CreationDate: <Date Representation>, 
     Description: "My Job", 
     JobId: "JID123e4567-e89b-12d3-a456-426655440000", 
     JobState: "New", 
     JobType: "IMPORT", 
     KmsKeyARN: "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456", 
     Notification: {
      JobStatesToNotify: [
      ], 
      NotifyAll: false
     }, 
     Resources: {
      S3Resources: [
         {
        BucketArn: "arn:aws:s3:::MyBucket", 
        KeyRange: {
        }
       }
      ]
     }, 
     RoleARN: "arn:aws:iam::123456789012:role/snowball-import-S3-role", 
     ShippingDetails: {
      ShippingOption: "SECOND_DAY"
     }, 
     SnowballCapacityPreference: "T80", 
     SnowballType: "STANDARD"
    }
   }
   */
 });

Calling the describeJob operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
snowball.describeJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobMetadata — (map)

        Information about a specific job, including shipping information, job status, and other important metadata.

        • JobId — (String)

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

        • JobState — (String)

          The current status of the jobs.

          Possible values include:
          • "New"
          • "PreparingAppliance"
          • "PreparingShipment"
          • "InTransitToCustomer"
          • "WithCustomer"
          • "InTransitToAWS"
          • "WithAWS"
          • "InProgress"
          • "Complete"
          • "Cancelled"
          • "Listing"
          • "Pending"
        • JobType — (String)

          The type of job.

          Possible values include:
          • "IMPORT"
          • "EXPORT"
          • "LOCAL_USE"
        • SnowballType — (String)

          The type of appliance used with this job.

          Possible values include:
          • "STANDARD"
          • "EDGE"
        • CreationDate — (Date)

          The creation date for this job.

        • Resources — (map)

          An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.

          • S3Resources — (Array<map>)

            An array of S3Resource objects.

            • BucketArn — (String)

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

            • KeyRange — (map)

              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.

          • LambdaResources — (Array<map>)

            The Python-language Lambda functions for this job.

            • LambdaArn — (String)

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

            • EventTriggers — (Array<map>)

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

              • EventResourceARN — (String)

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

        • Description — (String)

          The description of the job, provided at job creation.

        • KmsKeyARN — (String)

          The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job. This ARN was created using the CreateKey API action in AWS KMS.

        • RoleARN — (String)

          The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

        • AddressId — (String)

          The ID for the address that you want the Snowball shipped to.

        • ShippingDetails — (map)

          A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.

          • ShippingOption — (String)

            The shipping speed for a particular job. This speed doesn't dictate how soon you'll get the Snowball from the job's creation date. This speed represents how quickly it 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 United States of America (US), you have access to one-day shipping and two-day shipping.

            Possible values include:
            • "SECOND_DAY"
            • "NEXT_DAY"
            • "EXPRESS"
            • "STANDARD"
          • InboundShipment — (map)

            The Status and TrackingNumber values for a Snowball being delivered to the address that you specified for a particular job.

            • Status — (String)

              Status information for a shipment. Valid statuses include NEW, IN_TRANSIT, and DELIVERED.

            • TrackingNumber — (String)

              The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snowball as the carrier transports it.

              For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier.

          • OutboundShipment — (map)

            The Status and TrackingNumber values for a Snowball being returned to AWS for a particular job.

            • Status — (String)

              Status information for a shipment. Valid statuses include NEW, IN_TRANSIT, and DELIVERED.

            • TrackingNumber — (String)

              The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snowball as the carrier transports it.

              For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier.

        • SnowballCapacityPreference — (String)

          The Snowball capacity preference for this job, specified at job creation. In US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB capacity Snowballs.

          Possible values include:
          • "T50"
          • "T80"
          • "T100"
          • "NoPreference"
        • Notification — (map)

          The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type.

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

          • JobStatesToNotify — (Array<String>)

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

          • NotifyAll — (Boolean)

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

        • DataTransferProgress — (map)

          A value that defines the real-time status of a Snowball's data transfer while the appliance is at AWS. This data is only available while a job has a JobState value of InProgress, for both import and export jobs.

          • BytesTransferred — (Integer)

            The number of bytes transferred between a Snowball and Amazon S3.

          • ObjectsTransferred — (Integer)

            The number of objects transferred between a Snowball and Amazon S3.

          • TotalBytes — (Integer)

            The total bytes of data for a transfer between a Snowball and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.

          • TotalObjects — (Integer)

            The total number of objects for a transfer between a Snowball and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.

        • JobLogInfo — (map)

          Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snowball for your job part is being delivered to you.

          • JobCompletionReportURI — (String)

            A link to an Amazon S3 presigned URL where the job completion report is located.

          • JobSuccessLogURI — (String)

            A link to an Amazon S3 presigned URL where the job success log is located.

          • JobFailureLogURI — (String)

            A link to an Amazon S3 presigned URL where the job failure log is located.

        • ClusterId — (String)

          The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.

      • SubJobMetadata — (Array<map>)

        Information about a specific job part (in the case of an export job), including shipping information, job status, and other important metadata.

        • JobId — (String)

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

        • JobState — (String)

          The current status of the jobs.

          Possible values include:
          • "New"
          • "PreparingAppliance"
          • "PreparingShipment"
          • "InTransitToCustomer"
          • "WithCustomer"
          • "InTransitToAWS"
          • "WithAWS"
          • "InProgress"
          • "Complete"
          • "Cancelled"
          • "Listing"
          • "Pending"
        • JobType — (String)

          The type of job.

          Possible values include:
          • "IMPORT"
          • "EXPORT"
          • "LOCAL_USE"
        • SnowballType — (String)

          The type of appliance used with this job.

          Possible values include:
          • "STANDARD"
          • "EDGE"
        • CreationDate — (Date)

          The creation date for this job.

        • Resources — (map)

          An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.

          • S3Resources — (Array<map>)

            An array of S3Resource objects.

            • BucketArn — (String)

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

            • KeyRange — (map)

              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.

          • LambdaResources — (Array<map>)

            The Python-language Lambda functions for this job.

            • LambdaArn — (String)

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

            • EventTriggers — (Array<map>)

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

              • EventResourceARN — (String)

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

        • Description — (String)

          The description of the job, provided at job creation.

        • KmsKeyARN — (String)

          The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job. This ARN was created using the CreateKey API action in AWS KMS.

        • RoleARN — (String)

          The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

        • AddressId — (String)

          The ID for the address that you want the Snowball shipped to.

        • ShippingDetails — (map)

          A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.

          • ShippingOption — (String)

            The shipping speed for a particular job. This speed doesn't dictate how soon you'll get the Snowball from the job's creation date. This speed represents how quickly it 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 United States of America (US), you have access to one-day shipping and two-day shipping.

            Possible values include:
            • "SECOND_DAY"
            • "NEXT_DAY"
            • "EXPRESS"
            • "STANDARD"
          • InboundShipment — (map)

            The Status and TrackingNumber values for a Snowball being delivered to the address that you specified for a particular job.

            • Status — (String)

              Status information for a shipment. Valid statuses include NEW, IN_TRANSIT, and DELIVERED.

            • TrackingNumber — (String)

              The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snowball as the carrier transports it.

              For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier.

          • OutboundShipment — (map)

            The Status and TrackingNumber values for a Snowball being returned to AWS for a particular job.

            • Status — (String)

              Status information for a shipment. Valid statuses include NEW, IN_TRANSIT, and DELIVERED.

            • TrackingNumber — (String)

              The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snowball as the carrier transports it.

              For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier.

        • SnowballCapacityPreference — (String)

          The Snowball capacity preference for this job, specified at job creation. In US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB capacity Snowballs.

          Possible values include:
          • "T50"
          • "T80"
          • "T100"
          • "NoPreference"
        • Notification — (map)

          The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type.

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

          • JobStatesToNotify — (Array<String>)

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

          • NotifyAll — (Boolean)

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

        • DataTransferProgress — (map)

          A value that defines the real-time status of a Snowball's data transfer while the appliance is at AWS. This data is only available while a job has a JobState value of InProgress, for both import and export jobs.

          • BytesTransferred — (Integer)

            The number of bytes transferred between a Snowball and Amazon S3.

          • ObjectsTransferred — (Integer)

            The number of objects transferred between a Snowball and Amazon S3.

          • TotalBytes — (Integer)

            The total bytes of data for a transfer between a Snowball and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.

          • TotalObjects — (Integer)

            The total number of objects for a transfer between a Snowball and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.

        • JobLogInfo — (map)

          Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snowball for your job part is being delivered to you.

          • JobCompletionReportURI — (String)

            A link to an Amazon S3 presigned URL where the job completion report is located.

          • JobSuccessLogURI — (String)

            A link to an Amazon S3 presigned URL where the job success log is located.

          • JobFailureLogURI — (String)

            A link to an Amazon S3 presigned URL where the job failure log is located.

        • ClusterId — (String)

          The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getJobManifest(params = {}, callback) ⇒ AWS.Request

Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId 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 GetJobManifest action.

The manifest is an encrypted file that you can download after your job enters the WithCustomer status. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snowball through the Snowball client when the client is started for the first time.

As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.

The credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.

The manifest is an encrypted file that you can download after your job enters the WithCustomer status. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snowball through the Snowball client when the client is started for the first time.

As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.

The credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created. */

var params = { JobId: "JID123e4567-e89b-12d3-a456-426655440000" }; snowball.getJobManifest(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response / data = { ManifestURI: "https://awsie-frosty-manifests-prod.s3.amazonaws.com/JID123e4567-e89b-12d3-a456-426655440000_manifest.bin?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20161224T005115Z&X-Amz-SignedHeaders=..." } / });

Service Reference:

Examples:

To get the manifest for a job you've created for AWS Snowball


/* Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId 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 GetJobManifest action.

Calling the getJobManifest operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
snowball.getJobManifest(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

      The ID for a job that you want to get the manifest file for, for example JID123e4567-e89b-12d3-a456-426655440000.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ManifestURI — (String)

        The Amazon S3 presigned URL for the manifest file associated with the specified JobId value.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getJobUnlockCode(params = {}, callback) ⇒ AWS.Request

Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 90 days after the associated job has been created.

The UnlockCode 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 Snowball through the Snowball client when the client is started for the first time.

As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.

The UnlockCode 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 Snowball through the Snowball client when the client is started for the first time.

As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job. */

var params = { JobId: "JID123e4567-e89b-12d3-a456-426655440000" }; snowball.getJobUnlockCode(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response / data = { UnlockCode: "12345-abcde-56789-fghij-01234" } / });

Service Reference:

Examples:

To get the unlock code for a job you've created for AWS Snowball


/* Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 90 days after the associated job has been created.

Calling the getJobUnlockCode operation

var params = {
  JobId: 'STRING_VALUE' /* required */
};
snowball.getJobUnlockCode(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

      The ID for the job that you want to get the UnlockCode value for, for example JID123e4567-e89b-12d3-a456-426655440000.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • UnlockCode — (String)

        The UnlockCode value for the specified job. The UnlockCode value can be accessed for up to 90 days after the job has been created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getSnowballUsage(params = {}, callback) ⇒ AWS.Request

Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.

The default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support.

The default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support. */

var params = { }; snowball.getSnowballUsage(params, function(err, data) { if (err) console.log(err, err.stack); // an error occurred else console.log(data); // successful response / data = { SnowballLimit: 1, SnowballsInUse: 0 } / });

Service Reference:

Examples:

To see your Snowball service limit and the number of Snowballs you have in use


/* Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.

Calling the getSnowballUsage operation

var params = {
};
snowball.getSnowballUsage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SnowballLimit — (Integer)

        The service limit for number of Snowballs this account can have at once. The default service limit is 1 (one).

      • SnowballsInUse — (Integer)

        The number of Snowballs that this account is currently using.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listClusterJobs(params = {}, callback) ⇒ AWS.Request

Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.

Service Reference:

Examples:

To get a list of jobs in a cluster that you've created for AWS Snowball


/* Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information. */

 var params = {
  ClusterId: "CID123e4567-e89b-12d3-a456-426655440000"
 };
 snowball.listClusterJobs(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    JobListEntries: [
       {
      CreationDate: <Date Representation>, 
      Description: "MyClustrer-node-001", 
      IsMaster: false, 
      JobId: "JID123e4567-e89b-12d3-a456-426655440000", 
      JobState: "New", 
      JobType: "LOCAL_USE", 
      SnowballType: "EDGE"
     }, 
       {
      CreationDate: <Date Representation>, 
      Description: "MyClustrer-node-002", 
      IsMaster: false, 
      JobId: "JID123e4567-e89b-12d3-a456-426655440001", 
      JobState: "New", 
      JobType: "LOCAL_USE", 
      SnowballType: "EDGE"
     }, 
       {
      CreationDate: <Date Representation>, 
      Description: "MyClustrer-node-003", 
      IsMaster: false, 
      JobId: "JID123e4567-e89b-12d3-a456-426655440002", 
      JobState: "New", 
      JobType: "LOCAL_USE", 
      SnowballType: "EDGE"
     }, 
       {
      CreationDate: <Date Representation>, 
      Description: "MyClustrer-node-004", 
      IsMaster: false, 
      JobId: "JID123e4567-e89b-12d3-a456-426655440003", 
      JobState: "New", 
      JobType: "LOCAL_USE", 
      SnowballType: "EDGE"
     }, 
       {
      CreationDate: <Date Representation>, 
      Description: "MyClustrer-node-005", 
      IsMaster: false, 
      JobId: "JID123e4567-e89b-12d3-a456-426655440004", 
      JobState: "New", 
      JobType: "LOCAL_USE", 
      SnowballType: "EDGE"
     }
    ]
   }
   */
 });

Calling the listClusterJobs operation

var params = {
  ClusterId: 'STRING_VALUE', /* required */
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
snowball.listClusterJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClusterId — (String)

      The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000.

    • MaxResults — (Integer)

      The number of JobListEntry objects to return.

    • NextToken — (String)

      HTTP requests are stateless. To identify what object comes "next" in the list of JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobListEntries — (Array<map>)

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

        • JobId — (String)

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

        • JobState — (String)

          The current state of this job.

          Possible values include:
          • "New"
          • "PreparingAppliance"
          • "PreparingShipment"
          • "InTransitToCustomer"
          • "WithCustomer"
          • "InTransitToAWS"
          • "WithAWS"
          • "InProgress"
          • "Complete"
          • "Cancelled"
          • "Listing"
          • "Pending"
        • IsMaster — (Boolean)

          A value that indicates that this job is a master job. A master job represents a successful request to create an export job. Master jobs aren't associated with any Snowballs. Instead, each master job will have at least one job part, and each job part is associated with a Snowball. It might take some time before the job parts associated with a particular master job are listed, because they are created after the master job is created.

        • JobType — (String)

          The type of job.

          Possible values include:
          • "IMPORT"
          • "EXPORT"
          • "LOCAL_USE"
        • SnowballType — (String)

          The type of appliance used with this job.

          Possible values include:
          • "STANDARD"
          • "EDGE"
        • CreationDate — (Date)

          The creation date for this job.

        • Description — (String)

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

      • NextToken — (String)

        HTTP requests are stateless. If you use the automatically generated NextToken value in your next ListClusterJobsResult call, your list of returned jobs will start from this point in the array.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listClusters(params = {}, callback) ⇒ AWS.Request

Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

Service Reference:

Examples:

To get a list of clusters that you've created for AWS Snowball


/* Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information. */

 var params = {
 };
 snowball.listClusters(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ClusterListEntries: [
       {
      ClusterId: "CID123e4567-e89b-12d3-a456-426655440000", 
      ClusterState: "Pending", 
      CreationDate: <Date Representation>, 
      Description: "MyCluster"
     }
    ]
   }
   */
 });

Calling the listClusters operation

var params = {
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
snowball.listClusters(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

      The number of ClusterListEntry objects to return.

    • NextToken — (String)

      HTTP requests are stateless. To identify what object comes "next" in the list of ClusterListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClusterListEntries — (Array<map>)

        Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

        • ClusterId — (String)

          The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000.

        • ClusterState — (String)

          The current state of this cluster. For information about the state of a specific node, see JobListEntry$JobState.

          Possible values include:
          • "AwaitingQuorum"
          • "Pending"
          • "InUse"
          • "Complete"
          • "Cancelled"
        • CreationDate — (Date)

          The creation date for this cluster.

        • Description — (String)

          Defines an optional description of the cluster, for example Environmental Data Cluster-01.

      • NextToken — (String)

        HTTP requests are stateless. If you use the automatically generated NextToken value in your next ClusterListEntry call, your list of returned clusters will start from this point in the array.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listJobs(params = {}, callback) ⇒ AWS.Request

Returns an array of JobListEntry objects of the specified length. Each JobListEntry 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.

Service Reference:

Examples:

To get a list of jobs that you've created for AWS Snowball


/* Returns an array of JobListEntry objects of the specified length. Each JobListEntry 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. */

 var params = {
 };
 snowball.listJobs(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    JobListEntries: [
       {
      CreationDate: <Date Representation>, 
      Description: "MyJob", 
      IsMaster: false, 
      JobId: "JID123e4567-e89b-12d3-a456-426655440000", 
      JobState: "New", 
      JobType: "IMPORT", 
      SnowballType: "STANDARD"
     }
    ]
   }
   */
 });

Calling the listJobs operation

var params = {
  MaxResults: 0,
  NextToken: 'STRING_VALUE'
};
snowball.listJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

      The number of JobListEntry objects to return.

    • NextToken — (String)

      HTTP requests are stateless. To identify what object comes "next" in the list of JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • JobListEntries — (Array<map>)

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

        • JobId — (String)

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

        • JobState — (String)

          The current state of this job.

          Possible values include:
          • "New"
          • "PreparingAppliance"
          • "PreparingShipment"
          • "InTransitToCustomer"
          • "WithCustomer"
          • "InTransitToAWS"
          • "WithAWS"
          • "InProgress"
          • "Complete"
          • "Cancelled"
          • "Listing"
          • "Pending"
        • IsMaster — (Boolean)

          A value that indicates that this job is a master job. A master job represents a successful request to create an export job. Master jobs aren't associated with any Snowballs. Instead, each master job will have at least one job part, and each job part is associated with a Snowball. It might take some time before the job parts associated with a particular master job are listed, because they are created after the master job is created.

        • JobType — (String)

          The type of job.

          Possible values include:
          • "IMPORT"
          • "EXPORT"
          • "LOCAL_USE"
        • SnowballType — (String)

          The type of appliance used with this job.

          Possible values include:
          • "STANDARD"
          • "EDGE"
        • CreationDate — (Date)

          The creation date for this job.

        • Description — (String)

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

      • NextToken — (String)

        HTTP requests are stateless. If you use this automatically generated NextToken value in your next ListJobs call, your returned JobListEntry objects will start from this point in the array.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateCluster(params = {}, callback) ⇒ AWS.Request

While a cluster's ClusterState value is in the AwaitingQuorum 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.

Service Reference:

Examples:

To update a cluster


/* This action allows you to update certain parameters for a cluster. Once the cluster changes to a different state, usually within 60 minutes of it being created, this action is no longer available. */

 var params = {
  AddressId: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", 
  ClusterId: "CID123e4567-e89b-12d3-a456-426655440000", 
  Description: "Updated the address to send this to image processing - RJ"
 };
 snowball.updateCluster(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the updateCluster operation

var params = {
  ClusterId: 'STRING_VALUE', /* required */
  AddressId: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Notification: {
    JobStatesToNotify: [
      New | PreparingAppliance | PreparingShipment | InTransitToCustomer | WithCustomer | InTransitToAWS | WithAWS | InProgress | Complete | Cancelled | Listing | Pending,
      /* more items */
    ],
    NotifyAll: true || false,
    SnsTopicARN: 'STRING_VALUE'
  },
  Resources: {
    LambdaResources: [
      {
        EventTriggers: [
          {
            EventResourceARN: 'STRING_VALUE'
          },
          /* more items */
        ],
        LambdaArn: 'STRING_VALUE'
      },
      /* more items */
    ],
    S3Resources: [
      {
        BucketArn: 'STRING_VALUE',
        KeyRange: {
          BeginMarker: 'STRING_VALUE',
          EndMarker: 'STRING_VALUE'
        }
      },
      /* more items */
    ]
  },
  RoleARN: 'STRING_VALUE',
  ShippingOption: SECOND_DAY | NEXT_DAY | EXPRESS | STANDARD
};
snowball.updateCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClusterId — (String)

      The cluster ID of the cluster that you want to update, for example CID123e4567-e89b-12d3-a456-426655440000.

    • RoleARN — (String)

      The new role Amazon Resource Name (ARN) that you want to associate with this cluster. To create a role ARN, use the CreateRole API action in AWS Identity and Access Management (IAM).

    • Description — (String)

      The updated description of this cluster.

    • Resources — (map)

      The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

      • S3Resources — (Array<map>)

        An array of S3Resource objects.

        • BucketArn — (String)

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

        • KeyRange — (map)

          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.

      • LambdaResources — (Array<map>)

        The Python-language Lambda functions for this job.

        • LambdaArn — (String)

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

        • EventTriggers — (Array<map>)

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

          • EventResourceARN — (String)

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

    • AddressId — (String)

      The ID of the updated Address object.

    • ShippingOption — (String)

      The updated shipping option value of this cluster's ShippingDetails object.

      Possible values include:
      • "SECOND_DAY"
      • "NEXT_DAY"
      • "EXPRESS"
      • "STANDARD"
    • Notification — (map)

      The new or updated Notification object.

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

      • JobStatesToNotify — (Array<String>)

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

      • NotifyAll — (Boolean)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateJob(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To update a job


/* This action allows you to update certain parameters for 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. */

 var params = {
  AddressId: "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", 
  Description: "Upgraded to Edge, shipped to Finance Dept, and requested faster shipping speed - TS.", 
  JobId: "JID123e4567-e89b-12d3-a456-426655440000", 
  ShippingOption: "NEXT_DAY", 
  SnowballCapacityPreference: "T100"
 };
 snowball.updateJob(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the updateJob operation

var params = {
  JobId: 'STRING_VALUE', /* required */
  AddressId: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Notification: {
    JobStatesToNotify: [
      New | PreparingAppliance | PreparingShipment | InTransitToCustomer | WithCustomer | InTransitToAWS | WithAWS | InProgress | Complete | Cancelled | Listing | Pending,
      /* more items */
    ],
    NotifyAll: true || false,
    SnsTopicARN: 'STRING_VALUE'
  },
  Resources: {
    LambdaResources: [
      {
        EventTriggers: [
          {
            EventResourceARN: 'STRING_VALUE'
          },
          /* more items */
        ],
        LambdaArn: 'STRING_VALUE'
      },
      /* more items */
    ],
    S3Resources: [
      {
        BucketArn: 'STRING_VALUE',
        KeyRange: {
          BeginMarker: 'STRING_VALUE',
          EndMarker: 'STRING_VALUE'
        }
      },
      /* more items */
    ]
  },
  RoleARN: 'STRING_VALUE',
  ShippingOption: SECOND_DAY | NEXT_DAY | EXPRESS | STANDARD,
  SnowballCapacityPreference: T50 | T80 | T100 | NoPreference
};
snowball.updateJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • JobId — (String)

      The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.

    • RoleARN — (String)

      The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the CreateRole AWS Identity and Access Management (IAM) API action.

    • Notification — (map)

      The new or updated Notification object.

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

      • JobStatesToNotify — (Array<String>)

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

      • NotifyAll — (Boolean)

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

    • Resources — (map)

      The updated S3Resource object (for a single Amazon S3 bucket or key range), or the updated JobResource object (for multiple buckets or key ranges).

      • S3Resources — (Array<map>)

        An array of S3Resource objects.

        • BucketArn — (String)

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

        • KeyRange — (map)

          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.

      • LambdaResources — (Array<map>)

        The Python-language Lambda functions for this job.

        • LambdaArn — (String)

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

        • EventTriggers — (Array<map>)

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

          • EventResourceARN — (String)

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

    • AddressId — (String)

      The ID of the updated Address object.

    • ShippingOption — (String)

      The updated shipping option value of this job's ShippingDetails object.

      Possible values include:
      • "SECOND_DAY"
      • "NEXT_DAY"
      • "EXPRESS"
      • "STANDARD"
    • Description — (String)

      The updated description of this job's JobMetadata object.

    • SnowballCapacityPreference — (String)

      The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs are only available in the US regions.

      Possible values include:
      • "T50"
      • "T80"
      • "T100"
      • "NoPreference"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.