AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class Address

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.

Class CancelClusterRequest

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

Class CancelClusterResponse

This is the response object from the CancelCluster operation.

Class CancelJobRequest

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

Class CancelJobResponse

This is the response object from the CancelJob operation.

Class ClusterLimitExceededException

Snowball exception

Class ClusterListEntry

Contains a cluster's state, a cluster's ID, and other important information.

Class ClusterMetadata

Contains metadata about a specific cluster.

Class CreateAddressRequest

Container for the parameters to the CreateAddress operation. Creates an address for a Snowball to be shipped to. In most regions, 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.

Class CreateAddressResponse

This is the response object from the CreateAddress operation.

Class CreateClusterRequest

Container for the parameters to the CreateCluster operation. 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.

Class CreateClusterResponse

This is the response object from the CreateCluster operation.

Class CreateJobRequest

Container for the parameters to the CreateJob operation. 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.

Class CreateJobResponse

This is the response object from the CreateJob operation.

Class DataTransfer

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.

Class DescribeAddressesRequest

Container for the parameters to the DescribeAddresses operation. Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.

Class DescribeAddressesResponse

This is the response object from the DescribeAddresses operation.

Class DescribeAddressRequest

Container for the parameters to the DescribeAddress operation. Takes an AddressId and returns specific details about that address in the form of an Address object.

Class DescribeAddressResponse

This is the response object from the DescribeAddress operation.

Class DescribeClusterRequest

Container for the parameters to the DescribeCluster operation. Returns information about a specific cluster including shipping information, cluster status, and other important metadata.

Class DescribeClusterResponse

This is the response object from the DescribeCluster operation.

Class DescribeJobRequest

Container for the parameters to the DescribeJob operation. Returns information about a specific job including shipping information, job status, and other important metadata.

Class DescribeJobResponse

This is the response object from the DescribeJob operation.

Class EventTriggerDefinition

The container for the EventTriggerDefinition$EventResourceARN.

Class GetJobManifestRequest

Container for the parameters to the GetJobManifest operation. Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action.

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

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

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

Class GetJobManifestResponse

This is the response object from the GetJobManifest operation.

Class GetJobUnlockCodeRequest

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

The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the Snowball client when the client is started for the first time.

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

Class GetJobUnlockCodeResponse

This is the response object from the GetJobUnlockCode operation.

Class GetSnowballUsageRequest

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

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

Class GetSnowballUsageResponse

This is the response object from the GetSnowballUsage operation.

Class InvalidAddressException

Snowball exception

Class InvalidInputCombinationException

Snowball exception

Class InvalidJobStateException

Snowball exception

Class InvalidNextTokenException

Snowball exception

Class InvalidResourceException

Snowball exception

Class JobListEntry

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.

Class JobLogs

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.

Class JobMetadata

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

Class JobResource

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.

Class KeyRange

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.

Class KMSRequestFailedException

Snowball exception

Class LambdaResource

Identifies

Class ListClusterJobsRequest

Container for the parameters to the ListClusterJobs operation. 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.

Class ListClusterJobsResponse

This is the response object from the ListClusterJobs operation.

Class ListClustersRequest

Container for the parameters to the ListClusters operation. 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.

Class ListClustersResponse

This is the response object from the ListClusters operation.

Class ListJobsRequest

Container for the parameters to the ListJobs operation. 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.

Class ListJobsResponse

This is the response object from the ListJobs operation.

Class Notification

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.

Class S3Resource

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.

Class Shipment

The Status and TrackingNumber information for an inbound or outbound shipment.

Class ShippingDetails

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

Class UnsupportedAddressException

Snowball exception

Class UpdateClusterRequest

Container for the parameters to the UpdateCluster operation. While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available.

Class UpdateClusterResponse

This is the response object from the UpdateCluster operation.

Class UpdateJobRequest

Container for the parameters to the UpdateJob operation. While a job's JobState value is New, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.

Class UpdateJobResponse

This is the response object from the UpdateJob operation.