5.0.0 • Published 7 years ago

@datafire/amazonaws_snowball v5.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
7 years ago

@datafire/amazonaws_snowball

Client library for Amazon Import/Export Snowball

Installation and Usage

npm install --save @datafire/amazonaws_snowball
let amazonaws_snowball = require('@datafire/amazonaws_snowball').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_snowball.CancelCluster({
  "ClusterId": ""
}).then(data => {
  console.log(data);
});

Description

AWS Snowball is a petabyte-scale data transport solution that uses secure appliances to transfer large amounts of data between your on-premises data centers and Amazon Simple Storage Service (Amazon S3). The Snowball commands described here provide access to the same functionality that is available in the AWS Snowball Management Console, which enables you to create and manage jobs for Snowball. To transfer data locally with a Snowball appliance, you'll need to use the Snowball client or the Amazon S3 API adapter for Snowball. For more information, see the User Guide.

Actions

CancelCluster

amazonaws_snowball.CancelCluster({
  "ClusterId": ""
}, context)

Input

Output

CancelJob

amazonaws_snowball.CancelJob({
  "JobId": ""
}, context)

Input

  • input object

Output

CreateAddress

amazonaws_snowball.CreateAddress({
  "Address": {}
}, context)

Input

  • input object

Output

CreateCluster

amazonaws_snowball.CreateCluster({
  "JobType": "",
  "Resources": {},
  "AddressId": "",
  "RoleARN": "",
  "ShippingOption": ""
}, context)

Input

Output

CreateJob

amazonaws_snowball.CreateJob({}, context)

Input

Output

DescribeAddress

amazonaws_snowball.DescribeAddress({
  "AddressId": ""
}, context)

Input

Output

DescribeAddresses

amazonaws_snowball.DescribeAddresses({}, context)

Input

  • input object

Output

DescribeCluster

amazonaws_snowball.DescribeCluster({
  "ClusterId": ""
}, context)

Input

Output

DescribeJob

amazonaws_snowball.DescribeJob({
  "JobId": ""
}, context)

Input

  • input object

Output

GetJobManifest

amazonaws_snowball.GetJobManifest({
  "JobId": ""
}, context)

Input

  • input object

Output

GetJobUnlockCode

amazonaws_snowball.GetJobUnlockCode({
  "JobId": ""
}, context)

Input

  • input object

Output

GetSnowballUsage

amazonaws_snowball.GetSnowballUsage({}, context)

Input

  • input object

Output

ListClusterJobs

amazonaws_snowball.ListClusterJobs({
  "ClusterId": ""
}, context)

Input

Output

ListClusters

amazonaws_snowball.ListClusters({}, context)

Input

Output

ListJobs

amazonaws_snowball.ListJobs({}, context)

Input

  • input object

Output

UpdateCluster

amazonaws_snowball.UpdateCluster({
  "ClusterId": ""
}, context)

Input

Output

UpdateJob

amazonaws_snowball.UpdateJob({
  "JobId": ""
}, context)

Input

Output

Definitions

Address

  • Address object: The address that you want the Snowball or Snowballs associated with a specific job to be shipped to. Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. Although no individual elements of the Address are required, if the address is invalid or unsupported, then an exception is thrown.

AddressId

  • AddressId string

AddressList

Boolean

  • Boolean boolean

CancelClusterRequest

  • CancelClusterRequest object

CancelClusterResult

  • CancelClusterResult object

CancelJobRequest

  • CancelJobRequest object

CancelJobResult

  • CancelJobResult object

ClusterId

  • ClusterId string

ClusterLimitExceededException

  • ClusterLimitExceededException object: Job creation failed. Currently, clusters support five nodes. If you have less than five nodes for your cluster and you have more nodes to create for this cluster, try again and create jobs until your cluster has exactly five notes.

ClusterListEntry

  • ClusterListEntry object: Contains a cluster's state, a cluster's ID, and other important information.

ClusterListEntryList

ClusterMetadata

ClusterState

  • ClusterState string (values: AwaitingQuorum, Pending, InUse, Complete, Cancelled)

CreateAddressRequest

  • CreateAddressRequest object

CreateAddressResult

  • CreateAddressResult object

CreateClusterRequest

CreateClusterResult

  • CreateClusterResult object

CreateJobRequest

CreateJobResult

  • CreateJobResult object

DataTransfer

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

DescribeAddressRequest

  • DescribeAddressRequest object

DescribeAddressResult

  • DescribeAddressResult object

DescribeAddressesRequest

DescribeAddressesResult

DescribeClusterRequest

  • DescribeClusterRequest object

DescribeClusterResult

DescribeJobRequest

  • DescribeJobRequest object

DescribeJobResult

EventTriggerDefinition

  • EventTriggerDefinition object: The container for the EventTriggerDefinition$EventResourceARN.

EventTriggerDefinitionList

GetJobManifestRequest

  • GetJobManifestRequest object

GetJobManifestResult

  • GetJobManifestResult object

GetJobUnlockCodeRequest

  • GetJobUnlockCodeRequest object

GetJobUnlockCodeResult

  • GetJobUnlockCodeResult object

GetSnowballUsageRequest

  • GetSnowballUsageRequest object

GetSnowballUsageResult

  • GetSnowballUsageResult object

Integer

  • Integer integer

InvalidAddressException

  • InvalidAddressException object: The address provided was invalid. Check the address with your region's carrier, and try again.

InvalidInputCombinationException

  • InvalidInputCombinationException object: Job or cluster creation failed. One ore more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.

InvalidJobStateException

  • InvalidJobStateException object: The action can't be performed because the job's current state doesn't allow that action to be performed.

InvalidNextTokenException

  • InvalidNextTokenException object: The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.

InvalidResourceException

  • InvalidResourceException object: The specified resource can't be found. Check the information you provided in your last request, and try again.

JobId

  • JobId string

JobListEntry

  • JobListEntry object: 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 an export job.

JobListEntryList

JobLogs

  • JobLogs object: Contains job logs. Whenever Snowball is used to import data into or export data out of Amazon S3, you'll have the option of downloading a PDF job report. Job logs are returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type. The job logs can be accessed for up to 60 minutes after this request has been made. To access any of the job logs after 60 minutes have passed, you'll have to make another call to the DescribeJob action. For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snowball for your job part is being delivered to you. The job report provides you insight into the state of your Amazon S3 data transfer. The report includes details about your job or job part for your records. For deeper visibility into the status of your transferred objects, you can look at the two associated logs: a success log and a failure log. The logs are saved in comma-separated value (CSV) format, and the name of each log includes the ID of the job or job part that the log describes.

JobMetadata

JobMetadataList

JobResource

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

JobState

  • JobState string (values: New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWS, InProgress, Complete, Cancelled, Listing, Pending)

JobStateList

JobType

  • JobType string (values: IMPORT, EXPORT, LOCAL_USE)

KMSRequestFailedException

  • KMSRequestFailedException object: The provided AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

KeyRange

  • KeyRange object: Contains a key range. For export jobs, a S3Resource object can have an optional KeyRange value. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary sorted.

KmsKeyARN

  • KmsKeyARN string

LambdaResource

LambdaResourceList

ListClusterJobsRequest

ListClusterJobsResult

ListClustersRequest

ListClustersResult

ListJobsRequest

ListJobsResult

ListLimit

  • ListLimit integer

Long

  • Long integer

Notification

  • Notification object: 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. When the notification settings are defined during job creation, you can choose to notify based on a specific set of job states using the JobStatesToNotify array of strings, or you can specify that you want to have Amazon SNS notifications sent out for all job states with NotifyAll set to true.

ResourceARN

  • ResourceARN string

RoleARN

  • RoleARN string

S3Resource

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

S3ResourceList

Shipment

  • Shipment object: The Status and TrackingNumber information for an inbound or outbound shipment.

ShippingDetails

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

ShippingOption

  • ShippingOption string (values: SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD)

SnowballCapacity

  • SnowballCapacity string (values: T50, T80, T100, NoPreference)

SnowballType

  • SnowballType string (values: STANDARD, EDGE)

SnsTopicARN

  • SnsTopicARN string

String

  • String string

Timestamp

  • Timestamp string

UnsupportedAddressException

  • UnsupportedAddressException object: The address is either outside the serviceable area for your region, or an error occurred. Check the address with your region's carrier and try again. If the issue persists, contact AWS Support.

UpdateClusterRequest

UpdateClusterResult

  • UpdateClusterResult object

UpdateJobRequest

UpdateJobResult

  • UpdateJobResult object
datafireaws-sdk
@infinitebrahmanuniverse/nolb-_datafire_am@everything-registry/sub-chunk-220
5.0.0

7 years ago

4.0.0

8 years ago

3.0.4

8 years ago

3.0.3

8 years ago

3.0.2

8 years ago

3.0.1

8 years ago

3.0.0

8 years ago

2.0.2

8 years ago

2.0.1

8 years ago

2.0.0

8 years ago