Class: AWS.Snowball

/* 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 = {
   }
   */
 });

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.

/* 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"
   }
   */
 });

var params = {
  Address: { /* required */
    AddressId: 'STRING_VALUE',
    City: 'STRING_VALUE',
    Company: 'STRING_VALUE',
    Country: 'STRING_VALUE',
    IsRestricted: true || false,
    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',
    Type: CUST_PICKUP | AWS_SHIP
  }
};
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 Snow device shipped to.

    • AddressId — (String)

      The unique ID for an address.

    • Name — (String)

      The name of a person to receive a Snow device at an address.

    • Company — (String)

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

    • Street1 — (String)

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

    • Street2 — (String)

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

    • Street3 — (String)

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

    • City — (String)

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

    • StateOrProvince — (String)

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

    • PrefectureOrDistrict — (String)

      This field is no longer used and the value is ignored.

    • Landmark — (String)

      This field is no longer used and the value is ignored.

    • Country — (String)

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

    • PostalCode — (String)

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

    • PhoneNumber — (String)

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

    • IsRestricted — (Boolean)

      If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.

    • Type — (String)

      Differentiates between delivery address and pickup address in the customer account. Provided at job creation.

      Possible values include:
      • "CUST_PICKUP"
      • "AWS_SHIP"

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 Snow device for that job shipped to.

Returns:

• (AWS.Request) —

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

/* 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"
   }
   */
 });

var params = {
  AddressId: 'STRING_VALUE', /* required */
  JobType: IMPORT | EXPORT | LOCAL_USE, /* required */
  ShippingOption: SECOND_DAY | NEXT_DAY | EXPRESS | STANDARD, /* required */
  SnowballType: STANDARD | EDGE | EDGE_C | EDGE_CG | EDGE_S | SNC1_HDD | SNC1_SSD | V3_5C | V3_5S | RACK_5U_C, /* required */
  Description: 'STRING_VALUE',
  ForceCreateJobs: true || false,
  ForwardingAddressId: 'STRING_VALUE',
  InitialClusterSize: 'NUMBER_VALUE',
  KmsKeyARN: 'STRING_VALUE',
  LongTermPricingIds: [
    'STRING_VALUE',
    /* more items */
  ],
  Notification: {
    DevicePickupSnsTopicARN: 'STRING_VALUE',
    JobStatesToNotify: [
      New | PreparingAppliance | PreparingShipment | InTransitToCustomer | WithCustomer | InTransitToAWS | WithAWSSortingFacility | WithAWS | InProgress | Complete | Cancelled | Listing | Pending,
      /* more items */
    ],
    NotifyAll: true || false,
    SnsTopicARN: 'STRING_VALUE'
  },
  OnDeviceServiceConfiguration: {
    EKSOnDeviceService: {
      EKSAnywhereVersion: 'STRING_VALUE',
      KubernetesVersion: 'STRING_VALUE'
    },
    NFSOnDeviceService: {
      StorageLimit: 'NUMBER_VALUE',
      StorageUnit: TB
    },
    S3OnDeviceService: {
      FaultTolerance: 'NUMBER_VALUE',
      ServiceSize: 'NUMBER_VALUE',
      StorageLimit: 'NUMBER_VALUE',
      StorageUnit: TB
    },
    TGWOnDeviceService: {
      StorageLimit: 'NUMBER_VALUE',
      StorageUnit: TB
    }
  },
  RemoteManagement: INSTALLED_ONLY | INSTALLED_AUTOSTART | NOT_INSTALLED,
  Resources: {
    Ec2AmiResources: [
      {
        AmiId: 'STRING_VALUE', /* required */
        SnowballAmiId: 'STRING_VALUE'
      },
      /* more items */
    ],
    LambdaResources: [
      {
        EventTriggers: [
          {
            EventResourceARN: 'STRING_VALUE'
          },
          /* more items */
        ],
        LambdaArn: 'STRING_VALUE'
      },
      /* more items */
    ],
    S3Resources: [
      {
        BucketArn: 'STRING_VALUE',
        KeyRange: {
          BeginMarker: 'STRING_VALUE',
          EndMarker: 'STRING_VALUE'
        },
        TargetOnDeviceServices: [
          {
            ServiceName: NFS_ON_DEVICE_SERVICE | S3_ON_DEVICE_SERVICE,
            TransferOption: IMPORT | EXPORT | LOCAL_USE
          },
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  RoleARN: 'STRING_VALUE',
  SnowballCapacityPreference: T50 | T80 | T100 | T42 | T98 | T8 | T14 | T32 | NoPreference | T240 | T13,
  TaxDocuments: {
    IND: {
      GSTIN: 'STRING_VALUE'
    }
  }
};
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.

    For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

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

    The resources associated with the cluster job. These resources include Amazon S3 buckets and optional 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.

      • TargetOnDeviceServices — (Array<map>)

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

        • ServiceName — (String)

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

          Possible values include:
          • "NFS_ON_DEVICE_SERVICE"
          • "S3_ON_DEVICE_SERVICE"
        • TransferOption — (String)

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

          Possible values include:
          • "IMPORT"
          • "EXPORT"
          • "LOCAL_USE"
    • LambdaResources — (Array<map>)

      The Python-language Lambda functions for this job.

      • LambdaArn — (String)

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

      • EventTriggers — (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 Lambda function's event trigger associated with this job.

    • Ec2AmiResources — (Array<map>)

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

      • AmiId — required — (String)

        The ID of the AMI in Amazon EC2.

      • SnowballAmiId — (String)

        The ID of the AMI on the Snow device.

  • OnDeviceServiceConfiguration — (map)

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

    • NFSOnDeviceService — (map)

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

      • StorageLimit — (Integer)

        The maximum NFS storage for one Snow Family device.

      • StorageUnit — (String)

        The scale unit of the NFS storage on the device.

        Valid values: TB.

        Possible values include:
        • "TB"
    • TGWOnDeviceService — (map)

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

      • StorageLimit — (Integer)

        The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.

      • StorageUnit — (String)

        The scale unit of the virtual tapes on the device.

        Possible values include:
        • "TB"
    • EKSOnDeviceService — (map)

      The configuration of EKS Anywhere on the Snow Family device.

      • KubernetesVersion — (String)

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

      • EKSAnywhereVersion — (String)

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

    • S3OnDeviceService — (map)

      Configuration for Amazon S3 compatible storage on Snow family devices.

      • StorageLimit — (Float)

        If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used. If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has the same storage limit as specified, the other input need to be provided.

      • StorageUnit — (String)

        Storage unit. Currently the only supported unit is TB.

        Possible values include:
        • "TB"
      • ServiceSize — (Integer)

        Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snow family devices. If specified, the other input can be omitted.

      • FaultTolerance — (Integer)

        >Fault tolerance level of the cluster. This indicates the number of nodes that can go down without degrading the performance of the cluster. This additional input helps when the specified StorageLimit matches more than one Amazon S3 compatible storage on Snow family devices service configuration.

  • 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 Key Management Service (KMS).

  • RoleARN — (String)

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

  • SnowballType — (String)

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

    Note: For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.

    For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

    Possible values include:
    • "STANDARD"
    • "EDGE"
    • "EDGE_C"
    • "EDGE_CG"
    • "EDGE_S"
    • "SNC1_HDD"
    • "SNC1_SSD"
    • "V3_5C"
    • "V3_5S"
    • "RACK_5U_C"
  • ShippingOption — (String)

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

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

    • In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

    • In India, Snow devices are delivered in one to seven days.

    • In the United States of America (US), you have access to one-day shipping and two-day shipping.

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

    • In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

    • In India, Snow devices are delivered in one to seven days.

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

    Possible values 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 Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon 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.

    • DevicePickupSnsTopicARN — (String)

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

  • ForwardingAddressId — (String)

    The forwarding address ID for a cluster. This field is not supported in most regions.

  • TaxDocuments — (map)

    The tax documents required in your Amazon Web Services Region.

    • IND — (map)

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

      • GSTIN — (String)

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

  • RemoteManagement — (String)

    Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.

    Possible values include:
    • "INSTALLED_ONLY"
    • "INSTALLED_AUTOSTART"
    • "NOT_INSTALLED"
  • InitialClusterSize — (Integer)

    If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.

  • ForceCreateJobs — (Boolean)

    Force to create cluster when user attempts to overprovision or underprovision a cluster. A cluster is overprovisioned or underprovisioned if the initial size of the cluster is more (overprovisioned) or less (underprovisioned) than what needed to meet capacity requirement specified with OnDeviceServiceConfiguration.

  • LongTermPricingIds — (Array<String>)

    Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.

  • SnowballCapacityPreference — (String)

    If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.

    For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

    Possible values include:
    • "T50"
    • "T80"
    • "T100"
    • "T42"
    • "T98"
    • "T8"
    • "T14"
    • "T32"
    • "NoPreference"
    • "T240"
    • "T13"

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.

    • JobListEntries — (Array<map>)

      List of jobs created for this cluster. For syntax, see ListJobsResult$JobListEntries in this guide.

      • 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"
        • "WithAWSSortingFacility"
        • "WithAWS"
        • "InProgress"
        • "Complete"
        • "Cancelled"
        • "Listing"
        • "Pending"
      • IsMaster — (Boolean)

        A value that indicates that this job is a main job. A main job represents a successful request to create an export job. Main jobs aren't associated with any Snowballs. Instead, each main 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 main job are listed, because they are created after the main job is created.

      • JobType — (String)

        The type of job.

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

        The type of device used with this job.

        Possible values include:
        • "STANDARD"
        • "EDGE"
        • "EDGE_C"
        • "EDGE_CG"
        • "EDGE_S"
        • "SNC1_HDD"
        • "SNC1_SSD"
        • "V3_5C"
        • "V3_5S"
        • "RACK_5U_C"
      • CreationDate — (Date)

        The creation date for this job.

      • Description — (String)

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

Returns:

• (AWS.Request) —

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

/* 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"
   }
   */
 });

var params = {
  AddressId: 'STRING_VALUE',
  ClusterId: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  DeviceConfiguration: {
    SnowconeDeviceConfiguration: {
      WirelessConnection: {
        IsWifiEnabled: true || false
      }
    }
  },
  ForwardingAddressId: 'STRING_VALUE',
  ImpactLevel: IL2 | IL4 | IL5 | IL6 | IL99,
  JobType: IMPORT | EXPORT | LOCAL_USE,
  KmsKeyARN: 'STRING_VALUE',
  LongTermPricingId: 'STRING_VALUE',
  Notification: {
    DevicePickupSnsTopicARN: 'STRING_VALUE',
    JobStatesToNotify: [
      New | PreparingAppliance | PreparingShipment | InTransitToCustomer | WithCustomer | InTransitToAWS | WithAWSSortingFacility | WithAWS | InProgress | Complete | Cancelled | Listing | Pending,
      /* more items */
    ],
    NotifyAll: true || false,
    SnsTopicARN: 'STRING_VALUE'
  },
  OnDeviceServiceConfiguration: {
    EKSOnDeviceService: {
      EKSAnywhereVersion: 'STRING_VALUE',
      KubernetesVersion: 'STRING_VALUE'
    },
    NFSOnDeviceService: {
      StorageLimit: 'NUMBER_VALUE',
      StorageUnit: TB
    },
    S3OnDeviceService: {
      FaultTolerance: 'NUMBER_VALUE',
      ServiceSize: 'NUMBER_VALUE',
      StorageLimit: 'NUMBER_VALUE',
      StorageUnit: TB
    },
    TGWOnDeviceService: {
      StorageLimit: 'NUMBER_VALUE',
      StorageUnit: TB
    }
  },
  PickupDetails: {
    DevicePickupId: 'STRING_VALUE',
    Email: 'STRING_VALUE',
    IdentificationExpirationDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    IdentificationIssuingOrg: 'STRING_VALUE',
    IdentificationNumber: 'STRING_VALUE',
    Name: 'STRING_VALUE',
    PhoneNumber: 'STRING_VALUE'
  },
  RemoteManagement: INSTALLED_ONLY | INSTALLED_AUTOSTART | NOT_INSTALLED,
  Resources: {
    Ec2AmiResources: [
      {
        AmiId: 'STRING_VALUE', /* required */
        SnowballAmiId: 'STRING_VALUE'
      },
      /* more items */
    ],
    LambdaResources: [
      {
        EventTriggers: [
          {
            EventResourceARN: 'STRING_VALUE'
          },
          /* more items */
        ],
        LambdaArn: 'STRING_VALUE'
      },
      /* more items */
    ],
    S3Resources: [
      {
        BucketArn: 'STRING_VALUE',
        KeyRange: {
          BeginMarker: 'STRING_VALUE',
          EndMarker: 'STRING_VALUE'
        },
        TargetOnDeviceServices: [
          {
            ServiceName: NFS_ON_DEVICE_SERVICE | S3_ON_DEVICE_SERVICE,
            TransferOption: IMPORT | EXPORT | LOCAL_USE
          },
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  RoleARN: 'STRING_VALUE',
  ShippingOption: SECOND_DAY | NEXT_DAY | EXPRESS | STANDARD,
  SnowballCapacityPreference: T50 | T80 | T100 | T42 | T98 | T8 | T14 | T32 | NoPreference | T240 | T13,
  SnowballType: STANDARD | EDGE | EDGE_C | EDGE_CG | EDGE_S | SNC1_HDD | SNC1_SSD | V3_5C | V3_5S | RACK_5U_C,
  TaxDocuments: {
    IND: {
      GSTIN: 'STRING_VALUE'
    }
  }
};
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.

      • TargetOnDeviceServices — (Array<map>)

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

        • ServiceName — (String)

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

          Possible values include:
          • "NFS_ON_DEVICE_SERVICE"
          • "S3_ON_DEVICE_SERVICE"
        • TransferOption — (String)

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

          Possible values include:
          • "IMPORT"
          • "EXPORT"
          • "LOCAL_USE"
    • LambdaResources — (Array<map>)

      The Python-language Lambda functions for this job.

      • LambdaArn — (String)

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

      • EventTriggers — (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 Lambda function's event trigger associated with this job.

    • Ec2AmiResources — (Array<map>)

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

      • AmiId — required — (String)

        The ID of the AMI in Amazon EC2.

      • SnowballAmiId — (String)

        The ID of the AMI on the Snow device.

  • OnDeviceServiceConfiguration — (map)

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

    • NFSOnDeviceService — (map)

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

      • StorageLimit — (Integer)

        The maximum NFS storage for one Snow Family device.

      • StorageUnit — (String)

        The scale unit of the NFS storage on the device.

        Valid values: TB.

        Possible values include:
        • "TB"
    • TGWOnDeviceService — (map)

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

      • StorageLimit — (Integer)

        The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.

      • StorageUnit — (String)

        The scale unit of the virtual tapes on the device.

        Possible values include:
        • "TB"
    • EKSOnDeviceService — (map)

      The configuration of EKS Anywhere on the Snow Family device.

      • KubernetesVersion — (String)

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

      • EKSAnywhereVersion — (String)

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

    • S3OnDeviceService — (map)

      Configuration for Amazon S3 compatible storage on Snow family devices.

      • StorageLimit — (Float)

        If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used. If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has the same storage limit as specified, the other input need to be provided.

      • StorageUnit — (String)

        Storage unit. Currently the only supported unit is TB.

        Possible values include:
        • "TB"
      • ServiceSize — (Integer)

        Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snow family devices. If specified, the other input can be omitted.

      • FaultTolerance — (Integer)

        >Fault tolerance level of the cluster. This indicates the number of nodes that can go down without degrading the performance of the cluster. This additional input helps when the specified StorageLimit matches more than one Amazon S3 compatible storage on Snow family devices service configuration.

  • 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 Snow device shipped to.

  • KmsKeyARN — (String)

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

  • RoleARN — (String)

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

  • SnowballCapacityPreference — (String)

    If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.

    For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

    Possible values include:
    • "T50"
    • "T80"
    • "T100"
    • "T42"
    • "T98"
    • "T8"
    • "T14"
    • "T32"
    • "NoPreference"
    • "T240"
    • "T13"
  • ShippingOption — (String)

    The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snow device, rather it represents how quickly the Snow device moves to its destination while in transit. Regional shipping speeds are as follows:

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

    • In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

    • In India, Snow devices are delivered in one to seven days.

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

    Possible values 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 Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon 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.

    • DevicePickupSnsTopicARN — (String)

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

  • 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 Snow Family devices to use for this job.

    Note: For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.

    The type of Amazon Web Services Snow device to use for this job. Currently, the only supported device type for cluster jobs is EDGE.

    For more information, see Snowball Edge Device Options in the Snowball Edge Developer Guide.

    For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

    Possible values include:
    • "STANDARD"
    • "EDGE"
    • "EDGE_C"
    • "EDGE_CG"
    • "EDGE_S"
    • "SNC1_HDD"
    • "SNC1_SSD"
    • "V3_5C"
    • "V3_5S"
    • "RACK_5U_C"
  • ForwardingAddressId — (String)

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

  • TaxDocuments — (map)

    The tax documents required in your Amazon Web Services Region.

    • IND — (map)

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

      • GSTIN — (String)

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

  • DeviceConfiguration — (map)

    Defines the device configuration for an Snowcone job.

    For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

    • SnowconeDeviceConfiguration — (map)

      Returns information about the device configuration for an Snowcone job.

      • WirelessConnection — (map)

        Configures the wireless connection for the Snowcone device.

        • IsWifiEnabled — (Boolean)

          Enables the Wi-Fi adapter on an Snowcone device.

  • RemoteManagement — (String)

    Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Edge client to manage the device. When set to NOT_INSTALLED, remote management will not be available on the device.

    Possible values include:
    • "INSTALLED_ONLY"
    • "INSTALLED_AUTOSTART"
    • "NOT_INSTALLED"
  • LongTermPricingId — (String)

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

  • ImpactLevel — (String)

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

    Possible values include:
    • "IL2"
    • "IL4"
    • "IL5"
    • "IL6"
    • "IL99"
  • PickupDetails — (map)

    Information identifying the person picking up the device.

    • Name — (String)

      The name of the person picking up the device.

    • PhoneNumber — (String)

      The phone number of the person picking up the device.

    • Email — (String)

      The email address of the person picking up the device.

    • IdentificationNumber — (String)

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

    • IdentificationExpirationDate — (Date)

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

    • IdentificationIssuingOrg — (String)

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

    • DevicePickupId — (String)

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

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.

var params = {
  LongTermPricingType: OneYear | ThreeYear | OneMonth, /* required */
  SnowballType: STANDARD | EDGE | EDGE_C | EDGE_CG | EDGE_S | SNC1_HDD | SNC1_SSD | V3_5C | V3_5S | RACK_5U_C, /* required */
  IsLongTermPricingAutoRenew: true || false
};
snowball.createLongTermPricing(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: {}) —
  • LongTermPricingType — (String)

    The type of long-term pricing option you want for the device, either 1-year or 3-year long-term pricing.

    Possible values include:
    • "OneYear"
    • "ThreeYear"
    • "OneMonth"
  • IsLongTermPricingAutoRenew — (Boolean)

    Specifies whether the current long-term pricing type for the device should be renewed.

  • SnowballType — (String)

    The type of Snow Family devices to use for the long-term pricing job.

    Possible values include:
    • "STANDARD"
    • "EDGE"
    • "EDGE_C"
    • "EDGE_CG"
    • "EDGE_S"
    • "SNC1_HDD"
    • "SNC1_SSD"
    • "V3_5C"
    • "V3_5S"
    • "RACK_5U_C"

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:

    • LongTermPricingId — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  JobId: 'STRING_VALUE', /* required */
  ShippingOption: SECOND_DAY | NEXT_DAY | EXPRESS | STANDARD
};
snowball.createReturnShippingLabel(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 create the return shipping label for; for example, JID123e4567-e89b-12d3-a456-426655440000.

  • ShippingOption — (String)

    The shipping speed for a particular job. This speed doesn't dictate how soon the device is returned to Amazon Web Services. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows:

    Possible values include:
    • "SECOND_DAY"
    • "NEXT_DAY"
    • "EXPRESS"
    • "STANDARD"

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:

    • Status — (String)

      The status information of the task on a Snow device that is being returned to Amazon Web Services.

      Possible values include:
      • "InProgress"
      • "TimedOut"
      • "Succeeded"
      • "Failed"

Returns:

• (AWS.Request) —

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

/* 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"
    }
   }
   */
 });

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 Snow device(s) 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 Snow device at an address.

      • Company — (String)

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

      • Street1 — (String)

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

      • Street2 — (String)

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

      • Street3 — (String)

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

      • City — (String)

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

      • StateOrProvince — (String)

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

      • PrefectureOrDistrict — (String)

        This field is no longer used and the value is ignored.

      • Landmark — (String)

        This field is no longer used and the value is ignored.

      • Country — (String)

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

      • PostalCode — (String)

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

      • PhoneNumber — (String)

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

      • IsRestricted — (Boolean)

        If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.

      • Type — (String)

        Differentiates between delivery address and pickup address in the customer account. Provided at job creation.

        Possible values include:
        • "CUST_PICKUP"
        • "AWS_SHIP"

Returns:

• (AWS.Request) —

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

/* 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"
     }
    ]
   }
   */
 });

var params = {
  MaxResults: 'NUMBER_VALUE',
  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 Snow device 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 Snow device at an address.

      • Company — (String)

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

      • Street1 — (String)

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

      • Street2 — (String)

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

      • Street3 — (String)

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

      • City — (String)

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

      • StateOrProvince — (String)

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

      • PrefectureOrDistrict — (String)

        This field is no longer used and the value is ignored.

      • Landmark — (String)

        This field is no longer used and the value is ignored.

      • Country — (String)

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

      • PostalCode — (String)

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

      • PhoneNumber — (String)

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

      • IsRestricted — (Boolean)

        If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.

      • Type — (String)

        Differentiates between delivery address and pickup address in the customer account. Provided at job creation.

        Possible values include:
        • "CUST_PICKUP"
        • "AWS_SHIP"
    • 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.

/* 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"
    }
   }
   */
 });

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 Key Management Service (KMS.

      • RoleARN — (String)

        The role ARN associated with this cluster. This ARN was created using the CreateRole API action in 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 Snowcone device to use for this cluster.

        Note: For cluster jobs, Amazon Web Services Snow Family currently supports only the EDGE device type.
        Possible values include:
        • "STANDARD"
        • "EDGE"
        • "EDGE_C"
        • "EDGE_CG"
        • "EDGE_S"
        • "SNC1_HDD"
        • "SNC1_SSD"
        • "V3_5C"
        • "V3_5S"
        • "RACK_5U_C"
      • 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.

          • TargetOnDeviceServices — (Array<map>)

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

            • ServiceName — (String)

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

              Possible values include:
              • "NFS_ON_DEVICE_SERVICE"
              • "S3_ON_DEVICE_SERVICE"
            • TransferOption — (String)

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

              Possible values include:
              • "IMPORT"
              • "EXPORT"
              • "LOCAL_USE"
        • LambdaResources — (Array<map>)

          The Python-language Lambda functions for this job.

          • LambdaArn — (String)

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

          • EventTriggers — (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 Lambda function's event trigger associated with this job.

        • Ec2AmiResources — (Array<map>)

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

          • AmiId — required — (String)

            The ID of the AMI in Amazon EC2.

          • SnowballAmiId — (String)

            The ID of the AMI on the Snow device.

      • 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 device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows:

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

        • In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

        • In India, Snow devices are delivered in one to seven days.

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

        Possible values 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 Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon 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.

        • DevicePickupSnsTopicARN — (String)

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

      • ForwardingAddressId — (String)

        The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address. This field is not supported in most regions.

      • TaxDocuments — (map)

        The tax documents required in your Amazon Web Services Region.

        • IND — (map)

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

          • GSTIN — (String)

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

      • OnDeviceServiceConfiguration — (map)

        Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.

        • NFSOnDeviceService — (map)

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

          • StorageLimit — (Integer)

            The maximum NFS storage for one Snow Family device.

          • StorageUnit — (String)

            The scale unit of the NFS storage on the device.

            Valid values: TB.

            Possible values include:
            • "TB"
        • TGWOnDeviceService — (map)

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

          • StorageLimit — (Integer)

            The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.

          • StorageUnit — (String)

            The scale unit of the virtual tapes on the device.

            Possible values include:
            • "TB"
        • EKSOnDeviceService — (map)

          The configuration of EKS Anywhere on the Snow Family device.

          • KubernetesVersion — (String)

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

          • EKSAnywhereVersion — (String)

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

        • S3OnDeviceService — (map)

          Configuration for Amazon S3 compatible storage on Snow family devices.

          • StorageLimit — (Float)

            If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used. If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has the same storage limit as specified, the other input need to be provided.

          • StorageUnit — (String)

            Storage unit. Currently the only supported unit is TB.

            Possible values include:
            • "TB"
          • ServiceSize — (Integer)

            Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snow family devices. If specified, the other input can be omitted.

          • FaultTolerance — (Integer)

            >Fault tolerance level of the cluster. This indicates the number of nodes that can go down without degrading the performance of the cluster. This additional input helps when the specified StorageLimit matches more than one Amazon S3 compatible storage on Snow family devices service configuration.

Returns:

• (AWS.Request) —

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

/* 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"
    }
   }
   */
 });

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"
        • "WithAWSSortingFacility"
        • "WithAWS"
        • "InProgress"
        • "Complete"
        • "Cancelled"
        • "Listing"
        • "Pending"
      • JobType — (String)

        The type of job.

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

        The type of device used with this job.

        Possible values include:
        • "STANDARD"
        • "EDGE"
        • "EDGE_C"
        • "EDGE_CG"
        • "EDGE_S"
        • "SNC1_HDD"
        • "SNC1_SSD"
        • "V3_5C"
        • "V3_5S"
        • "RACK_5U_C"
      • 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.

          • TargetOnDeviceServices — (Array<map>)

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

            • ServiceName — (String)

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

              Possible values include:
              • "NFS_ON_DEVICE_SERVICE"
              • "S3_ON_DEVICE_SERVICE"
            • TransferOption — (String)

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

              Possible values include:
              • "IMPORT"
              • "EXPORT"
              • "LOCAL_USE"
        • LambdaResources — (Array<map>)

          The Python-language Lambda functions for this job.

          • LambdaArn — (String)

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

          • EventTriggers — (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 Lambda function's event trigger associated with this job.

        • Ec2AmiResources — (Array<map>)

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

          • AmiId — required — (String)

            The ID of the AMI in Amazon EC2.

          • SnowballAmiId — (String)

            The ID of the AMI on the Snow device.

      • Description — (String)

        The description of the job, provided at job creation.

      • KmsKeyARN — (String)

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

      • RoleARN — (String)

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

      • AddressId — (String)

        The ID for the address that you want the Snow device 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 Snow device 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, Snow devices shipped express are delivered in about a day.

          • In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

          • In India, Snow devices are delivered in one to seven days.

          • In the 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 Snow device being returned to Amazon Web Services for a particular job.

          • Status — (String)

            Status information for a shipment.

          • TrackingNumber — (String)

            The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snow device 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 Snow device being delivered to the address that you specified for a particular job.

          • Status — (String)

            Status information for a shipment.

          • TrackingNumber — (String)

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

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

      • SnowballCapacityPreference — (String)

        The Snow device 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.

        For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

        Possible values include:
        • "T50"
        • "T80"
        • "T100"
        • "T42"
        • "T98"
        • "T8"
        • "T14"
        • "T32"
        • "NoPreference"
        • "T240"
        • "T13"
      • 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 Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon 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.

        • DevicePickupSnsTopicARN — (String)

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

      • DataTransferProgress — (map)

        A value that defines the real-time status of a Snow device's data transfer while the device is at Amazon Web Services. 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 Snow device and Amazon S3.

        • ObjectsTransferred — (Integer)

          The number of objects transferred between a Snow device and Amazon S3.

        • TotalBytes — (Integer)

          The total bytes of data for a transfer between a Snow device 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 Snow device 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 Snow device 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.

      • ForwardingAddressId — (String)

        The ID of the address that you want a job shipped to, after it will be shipped to its primary address. This field is not supported in most regions.

      • TaxDocuments — (map)

        The metadata associated with the tax documents required in your Amazon Web Services Region.

        • IND — (map)

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

          • GSTIN — (String)

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

      • DeviceConfiguration — (map)

        The container for SnowconeDeviceConfiguration.

        • SnowconeDeviceConfiguration — (map)

          Returns information about the device configuration for an Snowcone job.

          • WirelessConnection — (map)

            Configures the wireless connection for the Snowcone device.

            • IsWifiEnabled — (Boolean)

              Enables the Wi-Fi adapter on an Snowcone device.

      • RemoteManagement — (String)

        Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.

        Possible values include:
        • "INSTALLED_ONLY"
        • "INSTALLED_AUTOSTART"
        • "NOT_INSTALLED"
      • LongTermPricingId — (String)

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

      • OnDeviceServiceConfiguration — (map)

        Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.

        • NFSOnDeviceService — (map)

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

          • StorageLimit — (Integer)

            The maximum NFS storage for one Snow Family device.

          • StorageUnit — (String)

            The scale unit of the NFS storage on the device.

            Valid values: TB.

            Possible values include:
            • "TB"
        • TGWOnDeviceService — (map)

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

          • StorageLimit — (Integer)

            The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.

          • StorageUnit — (String)

            The scale unit of the virtual tapes on the device.

            Possible values include:
            • "TB"
        • EKSOnDeviceService — (map)

          The configuration of EKS Anywhere on the Snow Family device.

          • KubernetesVersion — (String)

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

          • EKSAnywhereVersion — (String)

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

        • S3OnDeviceService — (map)

          Configuration for Amazon S3 compatible storage on Snow family devices.

          • StorageLimit — (Float)

            If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used. If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has the same storage limit as specified, the other input need to be provided.

          • StorageUnit — (String)

            Storage unit. Currently the only supported unit is TB.

            Possible values include:
            • "TB"
          • ServiceSize — (Integer)

            Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snow family devices. If specified, the other input can be omitted.

          • FaultTolerance — (Integer)

            >Fault tolerance level of the cluster. This indicates the number of nodes that can go down without degrading the performance of the cluster. This additional input helps when the specified StorageLimit matches more than one Amazon S3 compatible storage on Snow family devices service configuration.

      • ImpactLevel — (String)

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

        Possible values include:
        • "IL2"
        • "IL4"
        • "IL5"
        • "IL6"
        • "IL99"
      • PickupDetails — (map)

        Information identifying the person picking up the device.

        • Name — (String)

          The name of the person picking up the device.

        • PhoneNumber — (String)

          The phone number of the person picking up the device.

        • Email — (String)

          The email address of the person picking up the device.

        • IdentificationNumber — (String)

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

        • IdentificationExpirationDate — (Date)

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

        • IdentificationIssuingOrg — (String)

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

        • DevicePickupId — (String)

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

      • SnowballId — (String)

        Unique ID associated with a device.

    • 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"
        • "WithAWSSortingFacility"
        • "WithAWS"
        • "InProgress"
        • "Complete"
        • "Cancelled"
        • "Listing"
        • "Pending"
      • JobType — (String)

        The type of job.

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

        The type of device used with this job.

        Possible values include:
        • "STANDARD"
        • "EDGE"
        • "EDGE_C"
        • "EDGE_CG"
        • "EDGE_S"
        • "SNC1_HDD"
        • "SNC1_SSD"
        • "V3_5C"
        • "V3_5S"
        • "RACK_5U_C"
      • 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.

          • TargetOnDeviceServices — (Array<map>)

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

            • ServiceName — (String)

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

              Possible values include:
              • "NFS_ON_DEVICE_SERVICE"
              • "S3_ON_DEVICE_SERVICE"
            • TransferOption — (String)

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

              Possible values include:
              • "IMPORT"
              • "EXPORT"
              • "LOCAL_USE"
        • LambdaResources — (Array<map>)

          The Python-language Lambda functions for this job.

          • LambdaArn — (String)

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

          • EventTriggers — (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 Lambda function's event trigger associated with this job.

        • Ec2AmiResources — (Array<map>)

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

          • AmiId — required — (String)

            The ID of the AMI in Amazon EC2.

          • SnowballAmiId — (String)

            The ID of the AMI on the Snow device.

      • Description — (String)

        The description of the job, provided at job creation.

      • KmsKeyARN — (String)

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

      • RoleARN — (String)

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

      • AddressId — (String)

        The ID for the address that you want the Snow device 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 Snow device 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, Snow devices shipped express are delivered in about a day.

          • In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

          • In India, Snow devices are delivered in one to seven days.

          • In the 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 Snow device being returned to Amazon Web Services for a particular job.

          • Status — (String)

            Status information for a shipment.

          • TrackingNumber — (String)

            The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snow device 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 Snow device being delivered to the address that you specified for a particular job.

          • Status — (String)

            Status information for a shipment.

          • TrackingNumber — (String)

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

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

      • SnowballCapacityPreference — (String)

        The Snow device 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.

        For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

        Possible values include:
        • "T50"
        • "T80"
        • "T100"
        • "T42"
        • "T98"
        • "T8"
        • "T14"
        • "T32"
        • "NoPreference"
        • "T240"
        • "T13"
      • 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 Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon 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.

        • DevicePickupSnsTopicARN — (String)

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

      • DataTransferProgress — (map)

        A value that defines the real-time status of a Snow device's data transfer while the device is at Amazon Web Services. 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 Snow device and Amazon S3.

        • ObjectsTransferred — (Integer)

          The number of objects transferred between a Snow device and Amazon S3.

        • TotalBytes — (Integer)

          The total bytes of data for a transfer between a Snow device 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 Snow device 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 Snow device 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.

      • ForwardingAddressId — (String)

        The ID of the address that you want a job shipped to, after it will be shipped to its primary address. This field is not supported in most regions.

      • TaxDocuments — (map)

        The metadata associated with the tax documents required in your Amazon Web Services Region.

        • IND — (map)

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

          • GSTIN — (String)

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

      • DeviceConfiguration — (map)

        The container for SnowconeDeviceConfiguration.

        • SnowconeDeviceConfiguration — (map)

          Returns information about the device configuration for an Snowcone job.

          • WirelessConnection — (map)

            Configures the wireless connection for the Snowcone device.

            • IsWifiEnabled — (Boolean)

              Enables the Wi-Fi adapter on an Snowcone device.

      • RemoteManagement — (String)

        Allows you to securely operate and manage Snowcone devices remotely from outside of your internal network. When set to INSTALLED_AUTOSTART, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.

        Possible values include:
        • "INSTALLED_ONLY"
        • "INSTALLED_AUTOSTART"
        • "NOT_INSTALLED"
      • LongTermPricingId — (String)

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

      • OnDeviceServiceConfiguration — (map)

        Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.

        • NFSOnDeviceService — (map)

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

          • StorageLimit — (Integer)

            The maximum NFS storage for one Snow Family device.

          • StorageUnit — (String)

            The scale unit of the NFS storage on the device.

            Valid values: TB.

            Possible values include:
            • "TB"
        • TGWOnDeviceService — (map)

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

          • StorageLimit — (Integer)

            The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.

          • StorageUnit — (String)

            The scale unit of the virtual tapes on the device.

            Possible values include:
            • "TB"
        • EKSOnDeviceService — (map)

          The configuration of EKS Anywhere on the Snow Family device.

          • KubernetesVersion — (String)

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

          • EKSAnywhereVersion — (String)

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

        • S3OnDeviceService — (map)

          Configuration for Amazon S3 compatible storage on Snow family devices.

          • StorageLimit — (Float)

            If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used. If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has the same storage limit as specified, the other input need to be provided.

          • StorageUnit — (String)

            Storage unit. Currently the only supported unit is TB.

            Possible values include:
            • "TB"
          • ServiceSize — (Integer)

            Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snow family devices. If specified, the other input can be omitted.

          • FaultTolerance — (Integer)

            >Fault tolerance level of the cluster. This indicates the number of nodes that can go down without degrading the performance of the cluster. This additional input helps when the specified StorageLimit matches more than one Amazon S3 compatible storage on Snow family devices service configuration.

      • ImpactLevel — (String)

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

        Possible values include:
        • "IL2"
        • "IL4"
        • "IL5"
        • "IL6"
        • "IL99"
      • PickupDetails — (map)

        Information identifying the person picking up the device.

        • Name — (String)

          The name of the person picking up the device.

        • PhoneNumber — (String)

          The phone number of the person picking up the device.

        • Email — (String)

          The email address of the person picking up the device.

        • IdentificationNumber — (String)

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

        • IdentificationExpirationDate — (Date)

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

        • IdentificationIssuingOrg — (String)

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

        • DevicePickupId — (String)

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

      • SnowballId — (String)

        Unique ID associated with a device.

Returns:

• (AWS.Request) —

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

var params = {
  JobId: 'STRING_VALUE' /* required */
};
snowball.describeReturnShippingLabel(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:

    • Status — (String)

      The status information of the task on a Snow device that is being returned to Amazon Web Services.

      Possible values include:
      • "InProgress"
      • "TimedOut"
      • "Succeeded"
      • "Failed"
    • ExpirationDate — (Date)

      The expiration date of the current return shipping label.

    • ReturnShippingLabelURI — (String)

      The pre-signed Amazon S3 URI used to download the return shipping label.

Returns:

• (AWS.Request) —

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

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

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.

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

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 360 days after the job has been created.

Returns:

• (AWS.Request) —

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

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

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 Snow devices this account can have at once. The default service limit is 1 (one).

    • SnowballsInUse — (Integer)

      The number of Snow devices that this account is currently using.

Returns:

• (AWS.Request) —

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

var params = {
  JobId: 'STRING_VALUE' /* required */
};
snowball.getSoftwareUpdates(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 software update 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:

    • UpdatesURI — (String)

      The Amazon S3 presigned URL for the update file associated with the specified JobId value. The software update will be available for 2 days after this request is made. To access an update after the 2 days have passed, you'll have to make another call to GetSoftwareUpdates.

Returns:

• (AWS.Request) —

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

/* 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"
     }
    ]
   }
   */
 });

var params = {
  ClusterId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  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"
        • "WithAWSSortingFacility"
        • "WithAWS"
        • "InProgress"
        • "Complete"
        • "Cancelled"
        • "Listing"
        • "Pending"
      • IsMaster — (Boolean)

        A value that indicates that this job is a main job. A main job represents a successful request to create an export job. Main jobs aren't associated with any Snowballs. Instead, each main 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 main job are listed, because they are created after the main job is created.

      • JobType — (String)

        The type of job.

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

        The type of device used with this job.

        Possible values include:
        • "STANDARD"
        • "EDGE"
        • "EDGE_C"
        • "EDGE_CG"
        • "EDGE_S"
        • "SNC1_HDD"
        • "SNC1_SSD"
        • "V3_5C"
        • "V3_5S"
        • "RACK_5U_C"
      • 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.

/* 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"
     }
    ]
   }
   */
 });

var params = {
  MaxResults: 'NUMBER_VALUE',
  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.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
snowball.listCompatibleImages(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 maximum number of results for the list of compatible images. Currently, a Snowball Edge device can store 10 AMIs.

  • NextToken — (String)

    HTTP requests are stateless. To identify what object comes "next" in the list of compatible images, you can specify a value for NextToken as the starting point for your list of returned images.

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:

    • CompatibleImages — (Array<map>)

      A JSON-formatted object that describes a compatible AMI, including the ID and name for a Snow device AMI.

      • AmiId — (String)

        The unique identifier for an individual Snow device AMI.

      • Name — (String)

        The optional name of a compatible image.

    • NextToken — (String)

      Because HTTP requests are stateless, this is the starting point for your next list of returned images.

Returns:

• (AWS.Request) —

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

/* 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"
     }
    ]
   }
   */
 });

var params = {
  MaxResults: 'NUMBER_VALUE',
  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"
        • "WithAWSSortingFacility"
        • "WithAWS"
        • "InProgress"
        • "Complete"
        • "Cancelled"
        • "Listing"
        • "Pending"
      • IsMaster — (Boolean)

        A value that indicates that this job is a main job. A main job represents a successful request to create an export job. Main jobs aren't associated with any Snowballs. Instead, each main 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 main job are listed, because they are created after the main job is created.

      • JobType — (String)

        The type of job.

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

        The type of device used with this job.

        Possible values include:
        • "STANDARD"
        • "EDGE"
        • "EDGE_C"
        • "EDGE_CG"
        • "EDGE_S"
        • "SNC1_HDD"
        • "SNC1_SSD"
        • "V3_5C"
        • "V3_5S"
        • "RACK_5U_C"
      • 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.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
snowball.listLongTermPricing(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 maximum number of ListLongTermPricing objects to return.

  • NextToken — (String)

    Because HTTP requests are stateless, this is the starting point for your next list of ListLongTermPricing to return.

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:

    • LongTermPricingEntries — (Array<map>)

      Each LongTermPricingEntry object contains a status, ID, and other information about the LongTermPricing type.

      • LongTermPricingId — (String)

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

      • LongTermPricingEndDate — (Date)

        The end date the long-term pricing contract.

      • LongTermPricingStartDate — (Date)

        The start date of the long-term pricing contract.

      • LongTermPricingType — (String)

        The type of long-term pricing that was selected for the device.

        Possible values include:
        • "OneYear"
        • "ThreeYear"
        • "OneMonth"
      • CurrentActiveJob — (String)

        The current active jobs on the device the long-term pricing type.

      • ReplacementJob — (String)

        A new device that replaces a device that is ordered with long-term pricing.

      • IsLongTermPricingAutoRenew — (Boolean)

        If set to true, specifies that the current long-term pricing type for the device should be automatically renewed before the long-term pricing contract expires.

      • LongTermPricingStatus — (String)

        The status of the long-term pricing type.

      • SnowballType — (String)

        The type of Snow Family devices associated with this long-term pricing job.

        Possible values include:
        • "STANDARD"
        • "EDGE"
        • "EDGE_C"
        • "EDGE_CG"
        • "EDGE_S"
        • "SNC1_HDD"
        • "SNC1_SSD"
        • "V3_5C"
        • "V3_5S"
        • "RACK_5U_C"
      • JobIds — (Array<String>)

        The IDs of the jobs that are associated with a long-term pricing type.

    • NextToken — (String)

      Because HTTP requests are stateless, this is the starting point for your next list of returned ListLongTermPricing list.

Returns:

• (AWS.Request) —

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

/* Returns a specified number of Address objects. Each Address is a pickup location address for Snow Family devices. */

 var params = {
 };
 snowball.listPickupLocations(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"
     }
    ]
   }
   */
 });

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
snowball.listPickupLocations(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 maximum number of locations to list per page.

  • NextToken — (String)

    HTTP requests are stateless. To identify what object comes "next" in the list of ListPickupLocationsRequest 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:

    • Addresses — (Array<map>)

      Information about the address of pickup locations.

      • AddressId — (String)

        The unique ID for an address.

      • Name — (String)

        The name of a person to receive a Snow device at an address.

      • Company — (String)

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

      • Street1 — (String)

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

      • Street2 — (String)

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

      • Street3 — (String)

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

      • City — (String)

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

      • StateOrProvince — (String)

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

      • PrefectureOrDistrict — (String)

        This field is no longer used and the value is ignored.

      • Landmark — (String)

        This field is no longer used and the value is ignored.

      • Country — (String)

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

      • PostalCode — (String)

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

      • PhoneNumber — (String)

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

      • IsRestricted — (Boolean)

        If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.

      • Type — (String)

        Differentiates between delivery address and pickup address in the customer account. Provided at job creation.

        Possible values include:
        • "CUST_PICKUP"
        • "AWS_SHIP"
    • NextToken — (String)

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

Returns:

• (AWS.Request) —

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

var params = {
  ServiceName: KUBERNETES | EKS_ANYWHERE, /* required */
  DependentServices: [
    {
      ServiceName: KUBERNETES | EKS_ANYWHERE,
      ServiceVersion: {
        Version: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
snowball.listServiceVersions(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: {}) —
  • ServiceName — (String)

    The name of the service for which you're requesting supported versions.

    Possible values include:
    • "KUBERNETES"
    • "EKS_ANYWHERE"
  • DependentServices — (Array<map>)

    A list of names and versions of dependant services of the requested service.

    • ServiceName — (String)

      The name of the dependent service.

      Possible values include:
      • "KUBERNETES"
      • "EKS_ANYWHERE"
    • ServiceVersion — (map)

      The version of the dependent service.

      • Version — (String)

        The version number of the requested service.

  • MaxResults — (Integer)

    The maximum number of ListServiceVersions objects to return.

  • NextToken — (String)

    Because HTTP requests are stateless, this is the starting point for the next list of returned ListServiceVersionsRequest versions.

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:

    • ServiceVersions — (Array<map>)

      A list of supported versions.

      • Version — (String)

        The version number of the requested service.

    • ServiceName — (String)

      The name of the service for which the system provided supported versions.

      Possible values include:
      • "KUBERNETES"
      • "EKS_ANYWHERE"
    • DependentServices — (Array<map>)

      A list of names and versions of dependant services of the service for which the system provided supported versions.

      • ServiceName — (String)

        The name of the dependent service.

        Possible values include:
        • "KUBERNETES"
        • "EKS_ANYWHERE"
      • ServiceVersion — (map)

        The version of the dependent service.

        • Version — (String)

          The version number of the requested service.

    • NextToken — (String)

      Because HTTP requests are stateless, this is the starting point of the next list of returned ListServiceVersionsResult results.

Returns:

• (AWS.Request) —

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

/* 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-cluster-name"
 };
 snowball.updateCluster(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

var params = {
  ClusterId: 'STRING_VALUE', /* required */
  AddressId: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  ForwardingAddressId: 'STRING_VALUE',
  Notification: {
    DevicePickupSnsTopicARN: 'STRING_VALUE',
    JobStatesToNotify: [
      New | PreparingAppliance | PreparingShipment | InTransitToCustomer | WithCustomer | InTransitToAWS | WithAWSSortingFacility | WithAWS | InProgress | Complete | Cancelled | Listing | Pending,
      /* more items */
    ],
    NotifyAll: true || false,
    SnsTopicARN: 'STRING_VALUE'
  },
  OnDeviceServiceConfiguration: {
    EKSOnDeviceService: {
      EKSAnywhereVersion: 'STRING_VALUE',
      KubernetesVersion: 'STRING_VALUE'
    },
    NFSOnDeviceService: {
      StorageLimit: 'NUMBER_VALUE',
      StorageUnit: TB
    },
    S3OnDeviceService: {
      FaultTolerance: 'NUMBER_VALUE',
      ServiceSize: 'NUMBER_VALUE',
      StorageLimit: 'NUMBER_VALUE',
      StorageUnit: TB
    },
    TGWOnDeviceService: {
      StorageLimit: 'NUMBER_VALUE',
      StorageUnit: TB
    }
  },
  Resources: {
    Ec2AmiResources: [
      {
        AmiId: 'STRING_VALUE', /* required */
        SnowballAmiId: 'STRING_VALUE'
      },
      /* more items */
    ],
    LambdaResources: [
      {
        EventTriggers: [
          {
            EventResourceARN: 'STRING_VALUE'
          },
          /* more items */
        ],
        LambdaArn: 'STRING_VALUE'
      },
      /* more items */
    ],
    S3Resources: [
      {
        BucketArn: 'STRING_VALUE',
        KeyRange: {
          BeginMarker: 'STRING_VALUE',
          EndMarker: 'STRING_VALUE'
        },
        TargetOnDeviceServices: [
          {
            ServiceName: NFS_ON_DEVICE_SERVICE | S3_ON_DEVICE_SERVICE,
            TransferOption: IMPORT | EXPORT | LOCAL_USE
          },
          /* more items */
        ]
      },
      /* 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 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.

      • TargetOnDeviceServices — (Array<map>)

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

        • ServiceName — (String)

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

          Possible values include:
          • "NFS_ON_DEVICE_SERVICE"
          • "S3_ON_DEVICE_SERVICE"
        • TransferOption — (String)

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

          Possible values include:
          • "IMPORT"
          • "EXPORT"
          • "LOCAL_USE"
    • LambdaResources — (Array<map>)

      The Python-language Lambda functions for this job.

      • LambdaArn — (String)

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

      • EventTriggers — (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 Lambda function's event trigger associated with this job.

    • Ec2AmiResources — (Array<map>)

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

      • AmiId — required — (String)

        The ID of the AMI in Amazon EC2.

      • SnowballAmiId — (String)

        The ID of the AMI on the Snow device.

  • OnDeviceServiceConfiguration — (map)

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

    • NFSOnDeviceService — (map)

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

      • StorageLimit — (Integer)

        The maximum NFS storage for one Snow Family device.

      • StorageUnit — (String)

        The scale unit of the NFS storage on the device.

        Valid values: TB.

        Possible values include:
        • "TB"
    • TGWOnDeviceService — (map)

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

      • StorageLimit — (Integer)

        The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.

      • StorageUnit — (String)

        The scale unit of the virtual tapes on the device.

        Possible values include:
        • "TB"
    • EKSOnDeviceService — (map)

      The configuration of EKS Anywhere on the Snow Family device.

      • KubernetesVersion — (String)

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

      • EKSAnywhereVersion — (String)

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

    • S3OnDeviceService — (map)

      Configuration for Amazon S3 compatible storage on Snow family devices.

      • StorageLimit — (Float)

        If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used. If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has the same storage limit as specified, the other input need to be provided.

      • StorageUnit — (String)

        Storage unit. Currently the only supported unit is TB.

        Possible values include:
        • "TB"
      • ServiceSize — (Integer)

        Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snow family devices. If specified, the other input can be omitted.

      • FaultTolerance — (Integer)

        >Fault tolerance level of the cluster. This indicates the number of nodes that can go down without degrading the performance of the cluster. This additional input helps when the specified StorageLimit matches more than one Amazon S3 compatible storage on Snow family devices service configuration.

  • 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 Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon 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.

    • DevicePickupSnsTopicARN — (String)

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

  • ForwardingAddressId — (String)

    The updated ID for the forwarding address for a cluster. This field is not supported in most regions.

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.

/* 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: "updated-job-name", 
  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 = {
   }
   */
 });

var params = {
  JobId: 'STRING_VALUE', /* required */
  AddressId: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  ForwardingAddressId: 'STRING_VALUE',
  Notification: {
    DevicePickupSnsTopicARN: 'STRING_VALUE',
    JobStatesToNotify: [
      New | PreparingAppliance | PreparingShipment | InTransitToCustomer | WithCustomer | InTransitToAWS | WithAWSSortingFacility | WithAWS | InProgress | Complete | Cancelled | Listing | Pending,
      /* more items */
    ],
    NotifyAll: true || false,
    SnsTopicARN: 'STRING_VALUE'
  },
  OnDeviceServiceConfiguration: {
    EKSOnDeviceService: {
      EKSAnywhereVersion: 'STRING_VALUE',
      KubernetesVersion: 'STRING_VALUE'
    },
    NFSOnDeviceService: {
      StorageLimit: 'NUMBER_VALUE',
      StorageUnit: TB
    },
    S3OnDeviceService: {
      FaultTolerance: 'NUMBER_VALUE',
      ServiceSize: 'NUMBER_VALUE',
      StorageLimit: 'NUMBER_VALUE',
      StorageUnit: TB
    },
    TGWOnDeviceService: {
      StorageLimit: 'NUMBER_VALUE',
      StorageUnit: TB
    }
  },
  PickupDetails: {
    DevicePickupId: 'STRING_VALUE',
    Email: 'STRING_VALUE',
    IdentificationExpirationDate: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    IdentificationIssuingOrg: 'STRING_VALUE',
    IdentificationNumber: 'STRING_VALUE',
    Name: 'STRING_VALUE',
    PhoneNumber: 'STRING_VALUE'
  },
  Resources: {
    Ec2AmiResources: [
      {
        AmiId: 'STRING_VALUE', /* required */
        SnowballAmiId: 'STRING_VALUE'
      },
      /* more items */
    ],
    LambdaResources: [
      {
        EventTriggers: [
          {
            EventResourceARN: 'STRING_VALUE'
          },
          /* more items */
        ],
        LambdaArn: 'STRING_VALUE'
      },
      /* more items */
    ],
    S3Resources: [
      {
        BucketArn: 'STRING_VALUE',
        KeyRange: {
          BeginMarker: 'STRING_VALUE',
          EndMarker: 'STRING_VALUE'
        },
        TargetOnDeviceServices: [
          {
            ServiceName: NFS_ON_DEVICE_SERVICE | S3_ON_DEVICE_SERVICE,
            TransferOption: IMPORT | EXPORT | LOCAL_USE
          },
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  RoleARN: 'STRING_VALUE',
  ShippingOption: SECOND_DAY | NEXT_DAY | EXPRESS | STANDARD,
  SnowballCapacityPreference: T50 | T80 | T100 | T42 | T98 | T8 | T14 | T32 | NoPreference | T240 | T13
};
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 CreateRoleIdentity 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 Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon 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.

    • DevicePickupSnsTopicARN — (String)

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

  • Resources — (map)

    The updated JobResource object, or the updated JobResource object.

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

      • TargetOnDeviceServices — (Array<map>)

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

        • ServiceName — (String)

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

          Possible values include:
          • "NFS_ON_DEVICE_SERVICE"
          • "S3_ON_DEVICE_SERVICE"
        • TransferOption — (String)

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

          Possible values include:
          • "IMPORT"
          • "EXPORT"
          • "LOCAL_USE"
    • LambdaResources — (Array<map>)

      The Python-language Lambda functions for this job.

      • LambdaArn — (String)

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

      • EventTriggers — (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 Lambda function's event trigger associated with this job.

    • Ec2AmiResources — (Array<map>)

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

      • AmiId — required — (String)

        The ID of the AMI in Amazon EC2.

      • SnowballAmiId — (String)

        The ID of the AMI on the Snow device.

  • OnDeviceServiceConfiguration — (map)

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

    • NFSOnDeviceService — (map)

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

      • StorageLimit — (Integer)

        The maximum NFS storage for one Snow Family device.

      • StorageUnit — (String)

        The scale unit of the NFS storage on the device.

        Valid values: TB.

        Possible values include:
        • "TB"
    • TGWOnDeviceService — (map)

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

      • StorageLimit — (Integer)

        The maximum number of virtual tapes to store on one Snow Family device. Due to physical resource limitations, this value must be set to 80 for Snowball Edge.

      • StorageUnit — (String)

        The scale unit of the virtual tapes on the device.

        Possible values include:
        • "TB"
    • EKSOnDeviceService — (map)

      The configuration of EKS Anywhere on the Snow Family device.

      • KubernetesVersion — (String)

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

      • EKSAnywhereVersion — (String)

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

    • S3OnDeviceService — (map)

      Configuration for Amazon S3 compatible storage on Snow family devices.

      • StorageLimit — (Float)

        If the specified storage limit value matches storage limit of one of the defined configurations, that configuration will be used. If the specified storage limit value does not match any defined configuration, the request will fail. If more than one configuration has the same storage limit as specified, the other input need to be provided.

      • StorageUnit — (String)

        Storage unit. Currently the only supported unit is TB.

        Possible values include:
        • "TB"
      • ServiceSize — (Integer)

        Applicable when creating a cluster. Specifies how many nodes are needed for Amazon S3 compatible storage on Snow family devices. If specified, the other input can be omitted.

      • FaultTolerance — (Integer)

        >Fault tolerance level of the cluster. This indicates the number of nodes that can go down without degrading the performance of the cluster. This additional input helps when the specified StorageLimit matches more than one Amazon S3 compatible storage on Snow family devices service configuration.

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

    For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.

    Possible values include:
    • "T50"
    • "T80"
    • "T100"
    • "T42"
    • "T98"
    • "T8"
    • "T14"
    • "T32"
    • "NoPreference"
    • "T240"
    • "T13"
  • ForwardingAddressId — (String)

    The updated ID for the forwarding address for a job. This field is not supported in most regions.

  • PickupDetails — (map)

    Information identifying the person picking up the device.

    • Name — (String)

      The name of the person picking up the device.

    • PhoneNumber — (String)

      The phone number of the person picking up the device.

    • Email — (String)

      The email address of the person picking up the device.

    • IdentificationNumber — (String)

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

    • IdentificationExpirationDate — (Date)

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

    • IdentificationIssuingOrg — (String)

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

    • DevicePickupId — (String)

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

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.

var params = {
  JobId: 'STRING_VALUE', /* required */
  ShipmentState: RECEIVED | RETURNED /* required */
};
snowball.updateJobShipmentState(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 whose shipment date you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.

  • ShipmentState — (String)

    The state of a device when it is being shipped.

    Set to RECEIVED when the device arrives at your location.

    Set to RETURNED when you have returned the device to Amazon Web Services.

    Possible values include:
    • "RECEIVED"
    • "RETURNED"

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.

var params = {
  LongTermPricingId: 'STRING_VALUE', /* required */
  IsLongTermPricingAutoRenew: true || false,
  ReplacementJob: 'STRING_VALUE'
};
snowball.updateLongTermPricing(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: {}) —
  • LongTermPricingId — (String)

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

  • ReplacementJob — (String)

    Specifies that a device that is ordered with long-term pricing should be replaced with a new device.

  • IsLongTermPricingAutoRenew — (Boolean)

    If set to true, specifies that the current long-term pricing type for the device should be automatically renewed before the long-term pricing contract expires.

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.