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.

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.

Inheritance Hierarchy

System.Object
  Amazon.Snowball.Model.JobMetadata

Namespace: Amazon.Snowball.Model
Assembly: AWSSDK.Snowball.dll
Version: 3.x.y.z

Syntax

C#
public class JobMetadata

The JobMetadata type exposes the following members

Constructors

NameDescription
Public Method JobMetadata()

Properties

NameTypeDescription
Public Property AddressId System.String

Gets and sets the property AddressId.

The ID for the address that you want the Snow device shipped to.

Public Property ClusterId System.String

Gets and sets the property ClusterId.

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

Public Property CreationDate System.DateTime

Gets and sets the property CreationDate.

The creation date for this job.

Public Property DataTransferProgress Amazon.Snowball.Model.DataTransfer

Gets and sets the property DataTransferProgress.

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.

Public Property Description System.String

Gets and sets the property Description.

The description of the job, provided at job creation.

Public Property DeviceConfiguration Amazon.Snowball.Model.DeviceConfiguration

Gets and sets the property DeviceConfiguration.

Public Property ForwardingAddressId System.String

Gets and sets the property ForwardingAddressId.

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.

Public Property ImpactLevel Amazon.Snowball.ImpactLevel

Gets and sets the property ImpactLevel.

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

Public Property JobId System.String

Gets and sets the property JobId.

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

Public Property JobLogInfo Amazon.Snowball.Model.JobLogs

Gets and sets the property JobLogInfo.

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.

Public Property JobState Amazon.Snowball.JobState

Gets and sets the property JobState.

The current status of the jobs.

Public Property JobType Amazon.Snowball.JobType

Gets and sets the property JobType.

The type of job.

Public Property KmsKeyARN System.String

Gets and sets the property KmsKeyARN.

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.

Public Property LongTermPricingId System.String

Gets and sets the property LongTermPricingId.

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

Public Property Notification Amazon.Snowball.Model.Notification

Gets and sets the property 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.

Public Property OnDeviceServiceConfiguration Amazon.Snowball.Model.OnDeviceServiceConfiguration

Gets and sets the property OnDeviceServiceConfiguration.

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

Public Property PickupDetails Amazon.Snowball.Model.PickupDetails

Gets and sets the property PickupDetails.

Information identifying the person picking up the device.

Public Property RemoteManagement Amazon.Snowball.RemoteManagement

Gets and sets the property RemoteManagement.

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.

Public Property Resources Amazon.Snowball.Model.JobResource

Gets and sets the property Resources.

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

Public Property RoleARN System.String

Gets and sets the property RoleARN.

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

Public Property ShippingDetails Amazon.Snowball.Model.ShippingDetails

Gets and sets the property ShippingDetails.

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

Public Property SnowballCapacityPreference Amazon.Snowball.SnowballCapacity

Gets and sets the property SnowballCapacityPreference.

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.

Public Property SnowballId System.String

Gets and sets the property SnowballId.

Unique ID associated with a device.

Public Property SnowballType Amazon.Snowball.SnowballType

Gets and sets the property SnowballType.

The type of device used with this job.

Public Property TaxDocuments Amazon.Snowball.Model.TaxDocuments

Gets and sets the property TaxDocuments.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5