Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Creates a job to import or export data between Amazon S3 and your
on-premises data center. Your Amazon Web Services account must have the
right trust policies and permissions in place to create a job for a Snow
device. 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.
Only the Snowball; Edge device type is supported when ordering clustered jobs.
The device capacity is optional.
Availability of device types differ by Amazon Web Services Region. For more information about Region availability, see Amazon Web Services Regional Services.
Snow Family devices and their capacities.
Snow Family device type: SNC1_SSD
- Capacity: T14
- Description: Snowcone
Snow Family device type: SNC1_HDD
- Capacity: T8
- Description: Snowcone
Device type: EDGE_S
- Capacity: T98
- Description: Snowball Edge Storage Optimized for data transfer only
Device type: EDGE_CG
- Capacity: T42
- Description: Snowball Edge Compute Optimized with GPU
Device type: EDGE_C
- Capacity: T42
- Description: Snowball Edge Compute Optimized without GPU
Device type: EDGE
- Capacity: T100
- Description: Snowball Edge Storage Optimized with EC2 Compute
Device type: V3_5C
- Capacity: T32
- Description: Snowball Edge Compute Optimized without GPU
Device type: STANDARD
- Capacity: T50
Description: Original Snowball device
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region
Device type: STANDARD
- Capacity: T80
Description: Original Snowball device
This device is only available in the Ningxia, Beijing, and Singapore Amazon Web Services Region.
Synopsis
- data CreateJob = CreateJob' {
- addressId :: Maybe Text
- clusterId :: Maybe Text
- description :: Maybe Text
- deviceConfiguration :: Maybe DeviceConfiguration
- forwardingAddressId :: Maybe Text
- jobType :: Maybe JobType
- kmsKeyARN :: Maybe Text
- longTermPricingId :: Maybe Text
- notification :: Maybe Notification
- onDeviceServiceConfiguration :: Maybe OnDeviceServiceConfiguration
- remoteManagement :: Maybe RemoteManagement
- resources :: Maybe JobResource
- roleARN :: Maybe Text
- shippingOption :: Maybe ShippingOption
- snowballCapacityPreference :: Maybe SnowballCapacity
- snowballType :: Maybe SnowballType
- taxDocuments :: Maybe TaxDocuments
- newCreateJob :: CreateJob
- createJob_addressId :: Lens' CreateJob (Maybe Text)
- createJob_clusterId :: Lens' CreateJob (Maybe Text)
- createJob_description :: Lens' CreateJob (Maybe Text)
- createJob_deviceConfiguration :: Lens' CreateJob (Maybe DeviceConfiguration)
- createJob_forwardingAddressId :: Lens' CreateJob (Maybe Text)
- createJob_jobType :: Lens' CreateJob (Maybe JobType)
- createJob_kmsKeyARN :: Lens' CreateJob (Maybe Text)
- createJob_longTermPricingId :: Lens' CreateJob (Maybe Text)
- createJob_notification :: Lens' CreateJob (Maybe Notification)
- createJob_onDeviceServiceConfiguration :: Lens' CreateJob (Maybe OnDeviceServiceConfiguration)
- createJob_remoteManagement :: Lens' CreateJob (Maybe RemoteManagement)
- createJob_resources :: Lens' CreateJob (Maybe JobResource)
- createJob_roleARN :: Lens' CreateJob (Maybe Text)
- createJob_shippingOption :: Lens' CreateJob (Maybe ShippingOption)
- createJob_snowballCapacityPreference :: Lens' CreateJob (Maybe SnowballCapacity)
- createJob_snowballType :: Lens' CreateJob (Maybe SnowballType)
- createJob_taxDocuments :: Lens' CreateJob (Maybe TaxDocuments)
- data CreateJobResponse = CreateJobResponse' {
- jobId :: Maybe Text
- httpStatus :: Int
- newCreateJobResponse :: Int -> CreateJobResponse
- createJobResponse_jobId :: Lens' CreateJobResponse (Maybe Text)
- createJobResponse_httpStatus :: Lens' CreateJobResponse Int
Creating a Request
See: newCreateJob
smart constructor.
CreateJob' | |
|
Instances
newCreateJob :: CreateJob Source #
Create a value of CreateJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateJob
, createJob_addressId
- The ID for the address that you want the Snow device shipped to.
CreateJob
, createJob_clusterId
- 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.
CreateJob
, createJob_description
- Defines an optional description of this specific job, for example
Important Photos 2016-08-11
.
CreateJob
, createJob_deviceConfiguration
- 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.
CreateJob
, createJob_forwardingAddressId
- The forwarding address ID for a job. This field is not supported in most
Regions.
CreateJob
, createJob_jobType
- Defines the type of job that you're creating.
CreateJob
, createJob_kmsKeyARN
- The KmsKeyARN
that you want to associate with this job. KmsKeyARN
s
are created using the
CreateKey
Key Management Service (KMS) API action.
CreateJob
, createJob_longTermPricingId
- The ID of the long-term pricing type for the device.
CreateJob
, createJob_notification
- Defines the Amazon Simple Notification Service (Amazon SNS) notification
settings for this job.
CreateJob
, createJob_onDeviceServiceConfiguration
- 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.
CreateJob
, createJob_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.
CreateJob
, createJob_resources
- 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.
CreateJob
, createJob_roleARN
- The RoleARN
that you want to associate with this job. RoleArn
s are
created using the
CreateRole
Identity and Access Management (IAM) API action.
CreateJob
, createJob_shippingOption
- 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.
CreateJob
, createJob_snowballCapacityPreference
- 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.
CreateJob
, createJob_snowballType
- The type of Snow Family devices to use for this job.
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.
CreateJob
, createJob_taxDocuments
- The tax documents required in your Amazon Web Services Region.
Request Lenses
createJob_addressId :: Lens' CreateJob (Maybe Text) Source #
The ID for the address that you want the Snow device shipped to.
createJob_clusterId :: Lens' CreateJob (Maybe Text) Source #
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.
createJob_description :: Lens' CreateJob (Maybe Text) Source #
Defines an optional description of this specific job, for example
Important Photos 2016-08-11
.
createJob_deviceConfiguration :: Lens' CreateJob (Maybe DeviceConfiguration) Source #
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.
createJob_forwardingAddressId :: Lens' CreateJob (Maybe Text) Source #
The forwarding address ID for a job. This field is not supported in most Regions.
createJob_jobType :: Lens' CreateJob (Maybe JobType) Source #
Defines the type of job that you're creating.
createJob_kmsKeyARN :: Lens' CreateJob (Maybe Text) Source #
The KmsKeyARN
that you want to associate with this job. KmsKeyARN
s
are created using the
CreateKey
Key Management Service (KMS) API action.
createJob_longTermPricingId :: Lens' CreateJob (Maybe Text) Source #
The ID of the long-term pricing type for the device.
createJob_notification :: Lens' CreateJob (Maybe Notification) Source #
Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.
createJob_onDeviceServiceConfiguration :: Lens' CreateJob (Maybe OnDeviceServiceConfiguration) Source #
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.
createJob_remoteManagement :: Lens' CreateJob (Maybe RemoteManagement) Source #
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.
createJob_resources :: Lens' CreateJob (Maybe JobResource) Source #
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.
createJob_roleARN :: Lens' CreateJob (Maybe Text) Source #
The RoleARN
that you want to associate with this job. RoleArn
s are
created using the
CreateRole
Identity and Access Management (IAM) API action.
createJob_shippingOption :: Lens' CreateJob (Maybe ShippingOption) Source #
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.
createJob_snowballCapacityPreference :: Lens' CreateJob (Maybe SnowballCapacity) Source #
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.
createJob_snowballType :: Lens' CreateJob (Maybe SnowballType) Source #
The type of Snow Family devices to use for this job.
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.
createJob_taxDocuments :: Lens' CreateJob (Maybe TaxDocuments) Source #
The tax documents required in your Amazon Web Services Region.
Destructuring the Response
data CreateJobResponse Source #
See: newCreateJobResponse
smart constructor.
CreateJobResponse' | |
|
Instances
Create a value of CreateJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateJobResponse
, createJobResponse_jobId
- The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000
.
$sel:httpStatus:CreateJobResponse'
, createJobResponse_httpStatus
- The response's http status code.
Response Lenses
createJobResponse_jobId :: Lens' CreateJobResponse (Maybe Text) Source #
The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000
.
createJobResponse_httpStatus :: Lens' CreateJobResponse Int Source #
The response's http status code.