package snowball
- Alphabetic
- By Inheritance
- snowball
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
trait
Address extends Object
The address that you want the Snowball or Snowballs associated with a specific job to be shipped to.
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
Addressare required, if the address is invalid or unsupported, then an exception is thrown.- Annotations
- @RawJSType() @native()
- type AddressId = String
- type AddressList = Array[Address]
- type AmiId = String
-
trait
CancelClusterRequest extends Object
- Annotations
- @RawJSType() @native()
-
trait
CancelClusterResult extends Object
- Annotations
- @RawJSType() @native()
-
trait
CancelJobRequest extends Object
- Annotations
- @RawJSType() @native()
-
trait
CancelJobResult extends Object
- Annotations
- @RawJSType() @native()
- type ClusterId = String
-
trait
ClusterListEntry extends Object
Contains a cluster's state, a cluster's ID, and other important information.
Contains a cluster's state, a cluster's ID, and other important information.
- Annotations
- @RawJSType() @native()
- type ClusterListEntryList = Array[ClusterListEntry]
-
trait
ClusterMetadata extends Object
Contains metadata about a specific cluster.
Contains metadata about a specific cluster.
- Annotations
- @RawJSType() @native()
- type ClusterState = String
-
trait
CompatibleImage extends Object
A JSON-formatted object that describes a compatible Amazon Machine Image (AMI).
A JSON-formatted object that describes a compatible Amazon Machine Image (AMI). For more information on compatible AMIs, see Amazon EC2 Compute Instances in the AWS Snowball Developer Guide.
- Annotations
- @RawJSType() @native()
- type CompatibleImageList = Array[CompatibleImage]
-
trait
CreateAddressRequest extends Object
- Annotations
- @RawJSType() @native()
-
trait
CreateAddressResult extends Object
- Annotations
- @RawJSType() @native()
-
trait
CreateClusterRequest extends Object
- Annotations
- @RawJSType() @native()
-
trait
CreateClusterResult extends Object
- Annotations
- @RawJSType() @native()
-
trait
CreateJobRequest extends Object
- Annotations
- @RawJSType() @native()
-
trait
CreateJobResult extends Object
- Annotations
- @RawJSType() @native()
-
trait
DataTransfer extends Object
Defines the real-time status of a Snowball's data transfer while the device is at AWS.
Defines the real-time status of a Snowball's data transfer while the device is at AWS. This data is only available while a job has a
JobStatevalue ofInProgress, for both import and export jobs.- Annotations
- @RawJSType() @native()
-
trait
DescribeAddressRequest extends Object
- Annotations
- @RawJSType() @native()
-
trait
DescribeAddressResult extends Object
- Annotations
- @RawJSType() @native()
-
trait
DescribeAddressesRequest extends Object
- Annotations
- @RawJSType() @native()
-
trait
DescribeAddressesResult extends Object
- Annotations
- @RawJSType() @native()
-
trait
DescribeClusterRequest extends Object
- Annotations
- @RawJSType() @native()
-
trait
DescribeClusterResult extends Object
- Annotations
- @RawJSType() @native()
-
trait
DescribeJobRequest extends Object
- Annotations
- @RawJSType() @native()
-
trait
DescribeJobResult extends Object
- Annotations
- @RawJSType() @native()
-
trait
Ec2AmiResource extends Object
A JSON-formatted object that contains the IDs for an Amazon Machine Image (AMI), including the Amazon EC2 AMI ID and the Snowball Edge AMI ID.
A JSON-formatted object that contains the IDs for an Amazon Machine Image (AMI), including the Amazon EC2 AMI ID and the Snowball Edge AMI ID. Each AMI has these two IDs to simplify identifying the AMI in both the AWS Cloud and on the device.
- Annotations
- @RawJSType() @native()
- type Ec2AmiResourceList = Array[Ec2AmiResource]
-
trait
EventTriggerDefinition extends Object
The container for the EventResourceARN.
The container for the EventResourceARN.
- Annotations
- @RawJSType() @native()
- type EventTriggerDefinitionList = Array[EventTriggerDefinition]
-
trait
GetJobManifestRequest extends Object
- Annotations
- @RawJSType() @native()
-
trait
GetJobManifestResult extends Object
- Annotations
- @RawJSType() @native()
-
trait
GetJobUnlockCodeRequest extends Object
- Annotations
- @RawJSType() @native()
-
trait
GetJobUnlockCodeResult extends Object
- Annotations
- @RawJSType() @native()
-
trait
GetSnowballUsageRequest extends Object
- Annotations
- @RawJSType() @native()
-
trait
GetSnowballUsageResult extends Object
- Annotations
- @RawJSType() @native()
- type JobId = String
-
trait
JobListEntry extends Object
Each
JobListEntryobject 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.Each
JobListEntryobject 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.- Annotations
- @RawJSType() @native()
- type JobListEntryList = Array[JobListEntry]
-
trait
JobLogs extends Object
Contains job logs.
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
DescribeJobaction in theJobMetadatadata 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 theDescribeJobaction. 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.- Annotations
- @RawJSType() @native()
-
trait
JobMetadata extends Object
Contains information about a specific job including shipping information, job status, and other important metadata.
Contains information about a specific job including shipping information, job status, and other important metadata. This information is returned as a part of the response syntax of the
DescribeJobaction.- Annotations
- @RawJSType() @native()
- type JobMetadataList = Array[JobMetadata]
-
trait
JobResource extends Object
Contains an array of AWS resource objects.
Contains an array of AWS resource objects. Each object represents an Amazon S3 bucket, an AWS Lambda function, or an Amazon Machine Image (AMI) based on Amazon EC2 that is associated with a particular job.
- Annotations
- @RawJSType() @native()
- type JobState = String
- type JobStateList = Array[JobState]
- type JobType = String
-
trait
KeyRange extends Object
Contains a key range.
Contains a key range. For export jobs, a
S3Resourceobject can have an optionalKeyRangevalue. The length of the range is defined at job creation, and has either an inclusiveBeginMarker, an inclusiveEndMarker, or both. Ranges are UTF-8 binary sorted.- Annotations
- @RawJSType() @native()
- type KmsKeyARN = String
-
trait
LambdaResource extends Object
Identifies
Identifies
- Annotations
- @RawJSType() @native()
- type LambdaResourceList = Array[LambdaResource]
-
trait
ListClusterJobsRequest extends Object
- Annotations
- @RawJSType() @native()
-
trait
ListClusterJobsResult extends Object
- Annotations
- @RawJSType() @native()
-
trait
ListClustersRequest extends Object
- Annotations
- @RawJSType() @native()
-
trait
ListClustersResult extends Object
- Annotations
- @RawJSType() @native()
-
trait
ListCompatibleImagesRequest extends Object
- Annotations
- @RawJSType() @native()
-
trait
ListCompatibleImagesResult extends Object
- Annotations
- @RawJSType() @native()
-
trait
ListJobsRequest extends Object
- Annotations
- @RawJSType() @native()
-
trait
ListJobsResult extends Object
- Annotations
- @RawJSType() @native()
- type ListLimit = Int
-
trait
Notification extends Object
The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job.
The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The
Notificationobject is returned as a part of the response syntax of theDescribeJobaction in theJobMetadatadata type. When the notification settings are defined during job creation, you can choose to notify based on a specific set of job states using theJobStatesToNotifyarray of strings, or you can specify that you want to have Amazon SNS notifications sent out for all job states withNotifyAllset to true.- Annotations
- @RawJSType() @native()
- type ResourceARN = String
- type RoleARN = String
-
trait
S3Resource extends Object
Each
S3Resourceobject represents an Amazon S3 bucket that your transferred data will be exported from or imported into.Each
S3Resourceobject represents an Amazon S3 bucket that your transferred data will be exported from or imported into. For export jobs, this object can have an optionalKeyRangevalue. The length of the range is defined at job creation, and has either an inclusiveBeginMarker, an inclusiveEndMarker, or both. Ranges are UTF-8 binary sorted.- Annotations
- @RawJSType() @native()
- type S3ResourceList = Array[S3Resource]
-
trait
Shipment extends Object
The
StatusandTrackingNumberinformation for an inbound or outbound shipment.The
StatusandTrackingNumberinformation for an inbound or outbound shipment.- Annotations
- @RawJSType() @native()
-
trait
ShippingDetails extends Object
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
- Annotations
- @RawJSType() @native()
- type ShippingOption = String
-
class
Snowball extends Object
- Annotations
- @RawJSType() @native() @JSImport( "aws-sdk" , "Snowball" )
- type SnowballCapacity = String
- implicit final class SnowballOps extends AnyVal
- type SnowballType = String
- type SnsTopicARN = String
- type Timestamp = Date
-
trait
UpdateClusterRequest extends Object
- Annotations
- @RawJSType() @native()
-
trait
UpdateClusterResult extends Object
- Annotations
- @RawJSType() @native()
-
trait
UpdateJobRequest extends Object
- Annotations
- @RawJSType() @native()
-
trait
UpdateJobResult extends Object
- Annotations
- @RawJSType() @native()
Value Members
- object Address
- object CancelClusterRequest
- object CancelClusterResult
- object CancelJobRequest
- object CancelJobResult
- object ClusterListEntry
- object ClusterMetadata
- object ClusterStateEnum
- object CompatibleImage
- object CreateAddressRequest
- object CreateAddressResult
- object CreateClusterRequest
- object CreateClusterResult
- object CreateJobRequest
- object CreateJobResult
- object DataTransfer
- object DescribeAddressRequest
- object DescribeAddressResult
- object DescribeAddressesRequest
- object DescribeAddressesResult
- object DescribeClusterRequest
- object DescribeClusterResult
- object DescribeJobRequest
- object DescribeJobResult
- object Ec2AmiResource
- object EventTriggerDefinition
- object GetJobManifestRequest
- object GetJobManifestResult
- object GetJobUnlockCodeRequest
- object GetJobUnlockCodeResult
- object GetSnowballUsageRequest
- object GetSnowballUsageResult
- object JobListEntry
- object JobLogs
- object JobMetadata
- object JobResource
- object JobStateEnum
- object JobTypeEnum
- object KeyRange
- object LambdaResource
- object ListClusterJobsRequest
- object ListClusterJobsResult
- object ListClustersRequest
- object ListClustersResult
- object ListCompatibleImagesRequest
- object ListCompatibleImagesResult
- object ListJobsRequest
- object ListJobsResult
- object Notification
- object S3Resource
- object Shipment
- object ShippingDetails
- object ShippingOptionEnum
- object SnowballCapacityEnum
- object SnowballTypeEnum
- object UpdateClusterRequest
- object UpdateClusterResult
- object UpdateJobRequest
- object UpdateJobResult