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 |
- Service Configuration
- Errors
- Waiters
- Operations
- CancelCluster
- CancelJob
- CreateAddress
- CreateCluster
- CreateJob
- CreateLongTermPricing
- CreateReturnShippingLabel
- DescribeAddress
- DescribeAddresses (Paginated)
- DescribeCluster
- DescribeJob
- DescribeReturnShippingLabel
- GetJobManifest
- GetJobUnlockCode
- GetSnowballUsage
- GetSoftwareUpdates
- ListClusterJobs (Paginated)
- ListClusters (Paginated)
- ListCompatibleImages (Paginated)
- ListJobs (Paginated)
- ListLongTermPricing (Paginated)
- UpdateCluster
- UpdateJob
- UpdateJobShipmentState
- UpdateLongTermPricing
- Types
- ClusterState
- DeviceServiceName
- JobState
- JobType
- LongTermPricingType
- RemoteManagement
- ShipmentState
- ShippingLabelStatus
- ShippingOption
- SnowballCapacity
- SnowballType
- StorageUnit
- TransferOption
- Address
- ClusterListEntry
- ClusterMetadata
- CompatibleImage
- DataTransfer
- DeviceConfiguration
- Ec2AmiResource
- EventTriggerDefinition
- INDTaxDocuments
- JobListEntry
- JobLogs
- JobMetadata
- JobResource
- KeyRange
- LambdaResource
- LongTermPricingListEntry
- NFSOnDeviceServiceConfiguration
- Notification
- OnDeviceServiceConfiguration
- S3Resource
- Shipment
- ShippingDetails
- SnowconeDeviceConfiguration
- TGWOnDeviceServiceConfiguration
- TargetOnDeviceService
- TaxDocuments
- WirelessConnection
Derived from API version 2016-06-30
of the AWS service descriptions, licensed under Apache 2.0.
The Amazon Web Services Snow Family provides a petabyte-scale data transport solution that uses secure devices to transfer large amounts of data between your on-premises data centers and Amazon Simple Storage Service (Amazon S3). The Snow Family commands described here provide access to the same functionality that is available in the Amazon Web Services Snow Family Management Console, which enables you to create and manage jobs for a Snow Family device. To transfer data locally with a Snow Family device, you'll need to use the Snowball Edge client or the Amazon S3 API Interface for Snowball or OpsHub for Snow Family. For more information, see the User Guide.
Synopsis
- defaultService :: Service
- _ClusterLimitExceededException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _Ec2RequestFailedException :: AsError a => Fold a ServiceError
- _InvalidAddressException :: AsError a => Fold a ServiceError
- _InvalidInputCombinationException :: AsError a => Fold a ServiceError
- _InvalidJobStateException :: AsError a => Fold a ServiceError
- _InvalidNextTokenException :: AsError a => Fold a ServiceError
- _InvalidResourceException :: AsError a => Fold a ServiceError
- _KMSRequestFailedException :: AsError a => Fold a ServiceError
- _ReturnShippingLabelAlreadyExistsException :: AsError a => Fold a ServiceError
- _UnsupportedAddressException :: AsError a => Fold a ServiceError
- data CancelCluster = CancelCluster' Text
- newCancelCluster :: Text -> CancelCluster
- data CancelClusterResponse = CancelClusterResponse' Int
- newCancelClusterResponse :: Int -> CancelClusterResponse
- data CancelJob = CancelJob' Text
- newCancelJob :: Text -> CancelJob
- data CancelJobResponse = CancelJobResponse' Int
- newCancelJobResponse :: Int -> CancelJobResponse
- data CreateAddress = CreateAddress' Address
- newCreateAddress :: Address -> CreateAddress
- data CreateAddressResponse = CreateAddressResponse' (Maybe Text) Int
- newCreateAddressResponse :: Int -> CreateAddressResponse
- data CreateCluster = CreateCluster' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Notification) (Maybe OnDeviceServiceConfiguration) (Maybe RemoteManagement) (Maybe TaxDocuments) JobType JobResource Text Text SnowballType ShippingOption
- newCreateCluster :: JobType -> JobResource -> Text -> Text -> SnowballType -> ShippingOption -> CreateCluster
- data CreateClusterResponse = CreateClusterResponse' (Maybe Text) Int
- newCreateClusterResponse :: Int -> CreateClusterResponse
- data CreateJob = CreateJob' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DeviceConfiguration) (Maybe Text) (Maybe JobType) (Maybe Text) (Maybe Text) (Maybe Notification) (Maybe OnDeviceServiceConfiguration) (Maybe RemoteManagement) (Maybe JobResource) (Maybe Text) (Maybe ShippingOption) (Maybe SnowballCapacity) (Maybe SnowballType) (Maybe TaxDocuments)
- newCreateJob :: CreateJob
- data CreateJobResponse = CreateJobResponse' (Maybe Text) Int
- newCreateJobResponse :: Int -> CreateJobResponse
- data CreateLongTermPricing = CreateLongTermPricing' (Maybe Bool) (Maybe SnowballType) LongTermPricingType
- newCreateLongTermPricing :: LongTermPricingType -> CreateLongTermPricing
- data CreateLongTermPricingResponse = CreateLongTermPricingResponse' (Maybe Text) Int
- newCreateLongTermPricingResponse :: Int -> CreateLongTermPricingResponse
- data CreateReturnShippingLabel = CreateReturnShippingLabel' (Maybe ShippingOption) Text
- newCreateReturnShippingLabel :: Text -> CreateReturnShippingLabel
- data CreateReturnShippingLabelResponse = CreateReturnShippingLabelResponse' (Maybe ShippingLabelStatus) Int
- newCreateReturnShippingLabelResponse :: Int -> CreateReturnShippingLabelResponse
- data DescribeAddress = DescribeAddress' Text
- newDescribeAddress :: Text -> DescribeAddress
- data DescribeAddressResponse = DescribeAddressResponse' (Maybe Address) Int
- newDescribeAddressResponse :: Int -> DescribeAddressResponse
- data DescribeAddresses = DescribeAddresses' (Maybe Natural) (Maybe Text)
- newDescribeAddresses :: DescribeAddresses
- data DescribeAddressesResponse = DescribeAddressesResponse' (Maybe [Address]) (Maybe Text) Int
- newDescribeAddressesResponse :: Int -> DescribeAddressesResponse
- data DescribeCluster = DescribeCluster' Text
- newDescribeCluster :: Text -> DescribeCluster
- data DescribeClusterResponse = DescribeClusterResponse' (Maybe ClusterMetadata) Int
- newDescribeClusterResponse :: Int -> DescribeClusterResponse
- data DescribeJob = DescribeJob' Text
- newDescribeJob :: Text -> DescribeJob
- data DescribeJobResponse = DescribeJobResponse' (Maybe JobMetadata) (Maybe [JobMetadata]) Int
- newDescribeJobResponse :: Int -> DescribeJobResponse
- data DescribeReturnShippingLabel = DescribeReturnShippingLabel' Text
- newDescribeReturnShippingLabel :: Text -> DescribeReturnShippingLabel
- data DescribeReturnShippingLabelResponse = DescribeReturnShippingLabelResponse' (Maybe POSIX) (Maybe Text) (Maybe ShippingLabelStatus) Int
- newDescribeReturnShippingLabelResponse :: Int -> DescribeReturnShippingLabelResponse
- data GetJobManifest = GetJobManifest' Text
- newGetJobManifest :: Text -> GetJobManifest
- data GetJobManifestResponse = GetJobManifestResponse' (Maybe Text) Int
- newGetJobManifestResponse :: Int -> GetJobManifestResponse
- data GetJobUnlockCode = GetJobUnlockCode' Text
- newGetJobUnlockCode :: Text -> GetJobUnlockCode
- data GetJobUnlockCodeResponse = GetJobUnlockCodeResponse' (Maybe Text) Int
- newGetJobUnlockCodeResponse :: Int -> GetJobUnlockCodeResponse
- data GetSnowballUsage = GetSnowballUsage' {
- newGetSnowballUsage :: GetSnowballUsage
- data GetSnowballUsageResponse = GetSnowballUsageResponse' (Maybe Int) (Maybe Int) Int
- newGetSnowballUsageResponse :: Int -> GetSnowballUsageResponse
- data GetSoftwareUpdates = GetSoftwareUpdates' Text
- newGetSoftwareUpdates :: Text -> GetSoftwareUpdates
- data GetSoftwareUpdatesResponse = GetSoftwareUpdatesResponse' (Maybe Text) Int
- newGetSoftwareUpdatesResponse :: Int -> GetSoftwareUpdatesResponse
- data ListClusterJobs = ListClusterJobs' (Maybe Natural) (Maybe Text) Text
- newListClusterJobs :: Text -> ListClusterJobs
- data ListClusterJobsResponse = ListClusterJobsResponse' (Maybe [JobListEntry]) (Maybe Text) Int
- newListClusterJobsResponse :: Int -> ListClusterJobsResponse
- data ListClusters = ListClusters' (Maybe Natural) (Maybe Text)
- newListClusters :: ListClusters
- data ListClustersResponse = ListClustersResponse' (Maybe [ClusterListEntry]) (Maybe Text) Int
- newListClustersResponse :: Int -> ListClustersResponse
- data ListCompatibleImages = ListCompatibleImages' (Maybe Natural) (Maybe Text)
- newListCompatibleImages :: ListCompatibleImages
- data ListCompatibleImagesResponse = ListCompatibleImagesResponse' (Maybe [CompatibleImage]) (Maybe Text) Int
- newListCompatibleImagesResponse :: Int -> ListCompatibleImagesResponse
- data ListJobs = ListJobs' (Maybe Natural) (Maybe Text)
- newListJobs :: ListJobs
- data ListJobsResponse = ListJobsResponse' (Maybe [JobListEntry]) (Maybe Text) Int
- newListJobsResponse :: Int -> ListJobsResponse
- data ListLongTermPricing = ListLongTermPricing' (Maybe Natural) (Maybe Text)
- newListLongTermPricing :: ListLongTermPricing
- data ListLongTermPricingResponse = ListLongTermPricingResponse' (Maybe [LongTermPricingListEntry]) (Maybe Text) Int
- newListLongTermPricingResponse :: Int -> ListLongTermPricingResponse
- data UpdateCluster = UpdateCluster' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Notification) (Maybe OnDeviceServiceConfiguration) (Maybe JobResource) (Maybe Text) (Maybe ShippingOption) Text
- newUpdateCluster :: Text -> UpdateCluster
- data UpdateClusterResponse = UpdateClusterResponse' Int
- newUpdateClusterResponse :: Int -> UpdateClusterResponse
- data UpdateJob = UpdateJob' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Notification) (Maybe OnDeviceServiceConfiguration) (Maybe JobResource) (Maybe Text) (Maybe ShippingOption) (Maybe SnowballCapacity) Text
- newUpdateJob :: Text -> UpdateJob
- data UpdateJobResponse = UpdateJobResponse' Int
- newUpdateJobResponse :: Int -> UpdateJobResponse
- data UpdateJobShipmentState = UpdateJobShipmentState' Text ShipmentState
- newUpdateJobShipmentState :: Text -> ShipmentState -> UpdateJobShipmentState
- data UpdateJobShipmentStateResponse = UpdateJobShipmentStateResponse' Int
- newUpdateJobShipmentStateResponse :: Int -> UpdateJobShipmentStateResponse
- data UpdateLongTermPricing = UpdateLongTermPricing' (Maybe Bool) (Maybe Text) Text
- newUpdateLongTermPricing :: Text -> UpdateLongTermPricing
- data UpdateLongTermPricingResponse = UpdateLongTermPricingResponse' Int
- newUpdateLongTermPricingResponse :: Int -> UpdateLongTermPricingResponse
- newtype ClusterState where
- ClusterState' { }
- pattern ClusterState_AwaitingQuorum :: ClusterState
- pattern ClusterState_Cancelled :: ClusterState
- pattern ClusterState_Complete :: ClusterState
- pattern ClusterState_InUse :: ClusterState
- pattern ClusterState_Pending :: ClusterState
- newtype DeviceServiceName where
- newtype JobState where
- JobState' {
- fromJobState :: Text
- pattern JobState_Cancelled :: JobState
- pattern JobState_Complete :: JobState
- pattern JobState_InProgress :: JobState
- pattern JobState_InTransitToAWS :: JobState
- pattern JobState_InTransitToCustomer :: JobState
- pattern JobState_Listing :: JobState
- pattern JobState_New :: JobState
- pattern JobState_Pending :: JobState
- pattern JobState_PreparingAppliance :: JobState
- pattern JobState_PreparingShipment :: JobState
- pattern JobState_WithAWS :: JobState
- pattern JobState_WithAWSSortingFacility :: JobState
- pattern JobState_WithCustomer :: JobState
- JobState' {
- newtype JobType where
- JobType' {
- fromJobType :: Text
- pattern JobType_EXPORT :: JobType
- pattern JobType_IMPORT :: JobType
- pattern JobType_LOCAL_USE :: JobType
- JobType' {
- newtype LongTermPricingType where
- newtype RemoteManagement where
- newtype ShipmentState where
- ShipmentState' { }
- pattern ShipmentState_RECEIVED :: ShipmentState
- pattern ShipmentState_RETURNED :: ShipmentState
- newtype ShippingLabelStatus where
- newtype ShippingOption where
- ShippingOption' { }
- pattern ShippingOption_EXPRESS :: ShippingOption
- pattern ShippingOption_NEXT_DAY :: ShippingOption
- pattern ShippingOption_SECOND_DAY :: ShippingOption
- pattern ShippingOption_STANDARD :: ShippingOption
- newtype SnowballCapacity where
- SnowballCapacity' { }
- pattern SnowballCapacity_NoPreference :: SnowballCapacity
- pattern SnowballCapacity_T100 :: SnowballCapacity
- pattern SnowballCapacity_T14 :: SnowballCapacity
- pattern SnowballCapacity_T32 :: SnowballCapacity
- pattern SnowballCapacity_T42 :: SnowballCapacity
- pattern SnowballCapacity_T50 :: SnowballCapacity
- pattern SnowballCapacity_T8 :: SnowballCapacity
- pattern SnowballCapacity_T80 :: SnowballCapacity
- pattern SnowballCapacity_T98 :: SnowballCapacity
- newtype SnowballType where
- SnowballType' { }
- pattern SnowballType_EDGE :: SnowballType
- pattern SnowballType_EDGE_C :: SnowballType
- pattern SnowballType_EDGE_CG :: SnowballType
- pattern SnowballType_EDGE_S :: SnowballType
- pattern SnowballType_SNC1_HDD :: SnowballType
- pattern SnowballType_SNC1_SSD :: SnowballType
- pattern SnowballType_STANDARD :: SnowballType
- pattern SnowballType_V3_5C :: SnowballType
- newtype StorageUnit where
- StorageUnit' { }
- pattern StorageUnit_TB :: StorageUnit
- newtype TransferOption where
- TransferOption' { }
- pattern TransferOption_EXPORT :: TransferOption
- pattern TransferOption_IMPORT :: TransferOption
- pattern TransferOption_LOCAL_USE :: TransferOption
- data Address = Address' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newAddress :: Address
- data ClusterListEntry = ClusterListEntry' (Maybe Text) (Maybe ClusterState) (Maybe POSIX) (Maybe Text)
- newClusterListEntry :: ClusterListEntry
- data ClusterMetadata = ClusterMetadata' (Maybe Text) (Maybe Text) (Maybe ClusterState) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe JobType) (Maybe Text) (Maybe Notification) (Maybe OnDeviceServiceConfiguration) (Maybe JobResource) (Maybe Text) (Maybe ShippingOption) (Maybe SnowballType) (Maybe TaxDocuments)
- newClusterMetadata :: ClusterMetadata
- data CompatibleImage = CompatibleImage' (Maybe Text) (Maybe Text)
- newCompatibleImage :: CompatibleImage
- data DataTransfer = DataTransfer' (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer)
- newDataTransfer :: DataTransfer
- data DeviceConfiguration = DeviceConfiguration' (Maybe SnowconeDeviceConfiguration)
- newDeviceConfiguration :: DeviceConfiguration
- data Ec2AmiResource = Ec2AmiResource' (Maybe Text) Text
- newEc2AmiResource :: Text -> Ec2AmiResource
- data EventTriggerDefinition = EventTriggerDefinition' (Maybe Text)
- newEventTriggerDefinition :: EventTriggerDefinition
- data INDTaxDocuments = INDTaxDocuments' (Maybe Text)
- newINDTaxDocuments :: INDTaxDocuments
- data JobListEntry = JobListEntry' (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe JobState) (Maybe JobType) (Maybe SnowballType)
- newJobListEntry :: JobListEntry
- data JobLogs = JobLogs' (Maybe Text) (Maybe Text) (Maybe Text)
- newJobLogs :: JobLogs
- data JobMetadata = JobMetadata' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe DataTransfer) (Maybe Text) (Maybe DeviceConfiguration) (Maybe Text) (Maybe Text) (Maybe JobLogs) (Maybe JobState) (Maybe JobType) (Maybe Text) (Maybe Text) (Maybe Notification) (Maybe OnDeviceServiceConfiguration) (Maybe RemoteManagement) (Maybe JobResource) (Maybe Text) (Maybe ShippingDetails) (Maybe SnowballCapacity) (Maybe SnowballType) (Maybe TaxDocuments)
- newJobMetadata :: JobMetadata
- data JobResource = JobResource' (Maybe [Ec2AmiResource]) (Maybe [LambdaResource]) (Maybe [S3Resource])
- newJobResource :: JobResource
- data KeyRange = KeyRange' (Maybe Text) (Maybe Text)
- newKeyRange :: KeyRange
- data LambdaResource = LambdaResource' (Maybe [EventTriggerDefinition]) (Maybe Text)
- newLambdaResource :: LambdaResource
- data LongTermPricingListEntry = LongTermPricingListEntry' (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe LongTermPricingType) (Maybe Text) (Maybe SnowballType)
- newLongTermPricingListEntry :: LongTermPricingListEntry
- data NFSOnDeviceServiceConfiguration = NFSOnDeviceServiceConfiguration' (Maybe Natural) (Maybe StorageUnit)
- newNFSOnDeviceServiceConfiguration :: NFSOnDeviceServiceConfiguration
- data Notification = Notification' (Maybe [JobState]) (Maybe Bool) (Maybe Text)
- newNotification :: Notification
- data OnDeviceServiceConfiguration = OnDeviceServiceConfiguration' (Maybe NFSOnDeviceServiceConfiguration) (Maybe TGWOnDeviceServiceConfiguration)
- newOnDeviceServiceConfiguration :: OnDeviceServiceConfiguration
- data S3Resource = S3Resource' (Maybe Text) (Maybe KeyRange) (Maybe [TargetOnDeviceService])
- newS3Resource :: S3Resource
- data Shipment = Shipment' (Maybe Text) (Maybe Text)
- newShipment :: Shipment
- data ShippingDetails = ShippingDetails' (Maybe Shipment) (Maybe Shipment) (Maybe ShippingOption)
- newShippingDetails :: ShippingDetails
- data SnowconeDeviceConfiguration = SnowconeDeviceConfiguration' (Maybe WirelessConnection)
- newSnowconeDeviceConfiguration :: SnowconeDeviceConfiguration
- data TGWOnDeviceServiceConfiguration = TGWOnDeviceServiceConfiguration' (Maybe Natural) (Maybe StorageUnit)
- newTGWOnDeviceServiceConfiguration :: TGWOnDeviceServiceConfiguration
- data TargetOnDeviceService = TargetOnDeviceService' (Maybe DeviceServiceName) (Maybe TransferOption)
- newTargetOnDeviceService :: TargetOnDeviceService
- data TaxDocuments = TaxDocuments' (Maybe INDTaxDocuments)
- newTaxDocuments :: TaxDocuments
- data WirelessConnection = WirelessConnection' (Maybe Bool)
- newWirelessConnection :: WirelessConnection
Service Configuration
defaultService :: Service Source #
API version 2016-06-30
of the Amazon Import/Export Snowball SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Snowball
.
ClusterLimitExceededException
_ClusterLimitExceededException :: AsError a => Fold a ServiceError Source #
Job creation failed. Currently, clusters support five nodes. If you have fewer 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 nodes.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
You get this exception when you call CreateReturnShippingLabel
more
than once when other requests are not completed.
Ec2RequestFailedException
_Ec2RequestFailedException :: AsError a => Fold a ServiceError Source #
Your IAM user lacks the necessary Amazon EC2 permissions to perform the attempted action.
InvalidAddressException
_InvalidAddressException :: AsError a => Fold a ServiceError Source #
The address provided was invalid. Check the address with your region's carrier, and try again.
InvalidInputCombinationException
_InvalidInputCombinationException :: AsError a => Fold a ServiceError Source #
Job or cluster creation failed. One or more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.
InvalidJobStateException
_InvalidJobStateException :: AsError a => Fold a ServiceError Source #
The action can't be performed because the job's current state doesn't allow that action to be performed.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Fold a ServiceError Source #
The NextToken
string was altered unexpectedly, and the operation has
stopped. Run the operation without changing the NextToken
string, and
try again.
InvalidResourceException
_InvalidResourceException :: AsError a => Fold a ServiceError Source #
The specified resource can't be found. Check the information you provided in your last request, and try again.
KMSRequestFailedException
_KMSRequestFailedException :: AsError a => Fold a ServiceError Source #
The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
ReturnShippingLabelAlreadyExistsException
_ReturnShippingLabelAlreadyExistsException :: AsError a => Fold a ServiceError Source #
You get this exception if you call CreateReturnShippingLabel
and a
valid return shipping label already exists. In this case, use
DescribeReturnShippingLabel
to get the URL.
UnsupportedAddressException
_UnsupportedAddressException :: AsError a => Fold a ServiceError Source #
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 Amazon Web Services Support.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CancelCluster
data CancelCluster Source #
See: newCancelCluster
smart constructor.
Instances
Create a value of CancelCluster
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:
CancelCluster
, cancelCluster_clusterId
- The 39-character ID for the cluster that you want to cancel, for example
CID123e4567-e89b-12d3-a456-426655440000
.
data CancelClusterResponse Source #
See: newCancelClusterResponse
smart constructor.
Instances
newCancelClusterResponse Source #
Create a value of CancelClusterResponse
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:
$sel:httpStatus:CancelClusterResponse'
, cancelClusterResponse_httpStatus
- The response's http status code.
CancelJob
See: newCancelJob
smart constructor.
Instances
Create a value of CancelJob
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:
CancelJob
, cancelJob_jobId
- The 39-character job ID for the job that you want to cancel, for example
JID123e4567-e89b-12d3-a456-426655440000
.
data CancelJobResponse Source #
See: newCancelJobResponse
smart constructor.
Instances
Create a value of CancelJobResponse
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:
$sel:httpStatus:CancelJobResponse'
, cancelJobResponse_httpStatus
- The response's http status code.
CreateAddress
data CreateAddress Source #
See: newCreateAddress
smart constructor.
Instances
Create a value of CreateAddress
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:
$sel:address:CreateAddress'
, createAddress_address
- The address that you want the Snow device shipped to.
data CreateAddressResponse Source #
See: newCreateAddressResponse
smart constructor.
Instances
newCreateAddressResponse Source #
Create a value of CreateAddressResponse
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:
CreateAddressResponse
, createAddressResponse_addressId
- The automatically generated ID for a specific address. You'll use this
ID when you create a job to specify which address you want the Snow
device for that job shipped to.
$sel:httpStatus:CreateAddressResponse'
, createAddressResponse_httpStatus
- The response's http status code.
CreateCluster
data CreateCluster Source #
See: newCreateCluster
smart constructor.
Instances
:: JobType | |
-> JobResource | |
-> Text | |
-> Text | |
-> SnowballType | |
-> ShippingOption | |
-> CreateCluster |
Create a value of CreateCluster
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:
CreateCluster
, createCluster_description
- An optional description of this specific cluster, for example
Environmental Data Cluster-01
.
CreateCluster
, createCluster_forwardingAddressId
- The forwarding address ID for a cluster. This field is not supported in
most regions.
CreateCluster
, createCluster_kmsKeyARN
- The KmsKeyARN
value that you want to associate with this cluster.
KmsKeyARN
values are created by using the
CreateKey
API action in Key Management Service (KMS).
CreateCluster
, createCluster_notification
- The Amazon Simple Notification Service (Amazon SNS) notification
settings for this cluster.
CreateCluster
, createCluster_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 device clusters support Amazon S3 and NFS (Network
File System).
CreateCluster
, createCluster_remoteManagement
- Allows you to securely operate and manage Snow devices in a cluster
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.
CreateCluster
, createCluster_taxDocuments
- The tax documents required in your Amazon Web Services Region.
CreateCluster
, createCluster_jobType
- The type of job for this cluster. Currently, the only job type supported
for clusters is LOCAL_USE
.
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.
CreateCluster
, createCluster_resources
- The resources associated with the cluster job. These resources include
Amazon S3 buckets and optional Lambda functions written in the Python
language.
CreateCluster
, createCluster_addressId
- The ID for the address that you want the cluster shipped to.
CreateCluster
, createCluster_roleARN
- The RoleARN
that you want to associate with this cluster. RoleArn
values are created by using the
CreateRole
API action in Identity and Access Management (IAM).
CreateCluster
, createCluster_snowballType
- The type of Snow Family devices to use for this cluster.
For cluster jobs, Amazon Web Services Snow Family currently supports
only the EDGE
device type.
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.
CreateCluster
, createCluster_shippingOption
- The shipping speed for each node in this cluster. This speed doesn't
dictate how soon you'll get each Snowball Edge device, rather it
represents how quickly each 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 United States of America (US), you have access to one-day shipping and two-day shipping.
- In Australia, you have access to express shipping. Typically, 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.
data CreateClusterResponse Source #
See: newCreateClusterResponse
smart constructor.
Instances
newCreateClusterResponse Source #
Create a value of CreateClusterResponse
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:
CreateClusterResponse
, createClusterResponse_clusterId
- The automatically generated ID for a cluster.
$sel:httpStatus:CreateClusterResponse'
, createClusterResponse_httpStatus
- The response's http status code.
CreateJob
See: newCreateJob
smart constructor.
CreateJob' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DeviceConfiguration) (Maybe Text) (Maybe JobType) (Maybe Text) (Maybe Text) (Maybe Notification) (Maybe OnDeviceServiceConfiguration) (Maybe RemoteManagement) (Maybe JobResource) (Maybe Text) (Maybe ShippingOption) (Maybe SnowballCapacity) (Maybe SnowballType) (Maybe TaxDocuments) |
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.
data CreateJobResponse Source #
See: newCreateJobResponse
smart constructor.
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.
CreateLongTermPricing
data CreateLongTermPricing Source #
See: newCreateLongTermPricing
smart constructor.
Instances
newCreateLongTermPricing Source #
Create a value of CreateLongTermPricing
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:
CreateLongTermPricing
, createLongTermPricing_isLongTermPricingAutoRenew
- snowballty
Specifies whether the current long-term pricing type for the device should be renewed.
CreateLongTermPricing
, createLongTermPricing_snowballType
- The type of Snow Family devices to use for the long-term pricing job.
CreateLongTermPricing
, createLongTermPricing_longTermPricingType
- The type of long-term pricing option you want for the device, either
1-year or 3-year long-term pricing.
data CreateLongTermPricingResponse Source #
See: newCreateLongTermPricingResponse
smart constructor.
Instances
newCreateLongTermPricingResponse Source #
Create a value of CreateLongTermPricingResponse
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:
CreateLongTermPricingResponse
, createLongTermPricingResponse_longTermPricingId
- The ID of the long-term pricing type for the device.
$sel:httpStatus:CreateLongTermPricingResponse'
, createLongTermPricingResponse_httpStatus
- The response's http status code.
CreateReturnShippingLabel
data CreateReturnShippingLabel Source #
See: newCreateReturnShippingLabel
smart constructor.
Instances
newCreateReturnShippingLabel Source #
Create a value of CreateReturnShippingLabel
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:
CreateReturnShippingLabel
, createReturnShippingLabel_shippingOption
- The shipping speed for a particular job. This speed doesn't dictate how
soon the device is returned to Amazon Web Services. This speed
represents how quickly it moves to its destination while in transit.
Regional shipping speeds are as follows:
CreateReturnShippingLabel
, createReturnShippingLabel_jobId
- The ID for a job that you want to create the return shipping label for;
for example, JID123e4567-e89b-12d3-a456-426655440000
.
data CreateReturnShippingLabelResponse Source #
See: newCreateReturnShippingLabelResponse
smart constructor.
Instances
Generic CreateReturnShippingLabelResponse Source # | |
Read CreateReturnShippingLabelResponse Source # | |
Show CreateReturnShippingLabelResponse Source # | |
NFData CreateReturnShippingLabelResponse Source # | |
Defined in Amazonka.Snowball.CreateReturnShippingLabel rnf :: CreateReturnShippingLabelResponse -> () # | |
Eq CreateReturnShippingLabelResponse Source # | |
type Rep CreateReturnShippingLabelResponse Source # | |
Defined in Amazonka.Snowball.CreateReturnShippingLabel type Rep CreateReturnShippingLabelResponse = D1 ('MetaData "CreateReturnShippingLabelResponse" "Amazonka.Snowball.CreateReturnShippingLabel" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "CreateReturnShippingLabelResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ShippingLabelStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newCreateReturnShippingLabelResponse Source #
Create a value of CreateReturnShippingLabelResponse
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:
CreateReturnShippingLabelResponse
, createReturnShippingLabelResponse_status
- The status information of the task on a Snow device that is being
returned to Amazon Web Services.
$sel:httpStatus:CreateReturnShippingLabelResponse'
, createReturnShippingLabelResponse_httpStatus
- The response's http status code.
DescribeAddress
data DescribeAddress Source #
See: newDescribeAddress
smart constructor.
Instances
Create a value of DescribeAddress
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:
DescribeAddress
, describeAddress_addressId
- The automatically generated ID for a specific address.
data DescribeAddressResponse Source #
See: newDescribeAddressResponse
smart constructor.
Instances
newDescribeAddressResponse Source #
Create a value of DescribeAddressResponse
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:
$sel:address:DescribeAddressResponse'
, describeAddressResponse_address
- The address that you want the Snow device(s) associated with a specific
job to be shipped to.
$sel:httpStatus:DescribeAddressResponse'
, describeAddressResponse_httpStatus
- The response's http status code.
DescribeAddresses (Paginated)
data DescribeAddresses Source #
See: newDescribeAddresses
smart constructor.
Instances
newDescribeAddresses :: DescribeAddresses Source #
Create a value of DescribeAddresses
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:
$sel:maxResults:DescribeAddresses'
, describeAddresses_maxResults
- The number of ADDRESS
objects to return.
DescribeAddresses
, describeAddresses_nextToken
- HTTP requests are stateless. To identify what object comes "next" in
the list of ADDRESS
objects, you have the option of specifying a value
for NextToken
as the starting point for your list of returned
addresses.
data DescribeAddressesResponse Source #
See: newDescribeAddressesResponse
smart constructor.
Instances
newDescribeAddressesResponse Source #
Create a value of DescribeAddressesResponse
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:
$sel:addresses:DescribeAddressesResponse'
, describeAddressesResponse_addresses
- The Snow device shipping addresses that were created for this account.
DescribeAddresses
, describeAddressesResponse_nextToken
- HTTP requests are stateless. If you use the automatically generated
NextToken
value in your next DescribeAddresses
call, your list of
returned addresses will start from this point in the array.
$sel:httpStatus:DescribeAddressesResponse'
, describeAddressesResponse_httpStatus
- The response's http status code.
DescribeCluster
data DescribeCluster Source #
See: newDescribeCluster
smart constructor.
Instances
Create a value of DescribeCluster
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:
DescribeCluster
, describeCluster_clusterId
- The automatically generated ID for a cluster.
data DescribeClusterResponse Source #
See: newDescribeClusterResponse
smart constructor.
Instances
newDescribeClusterResponse Source #
Create a value of DescribeClusterResponse
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:
$sel:clusterMetadata:DescribeClusterResponse'
, describeClusterResponse_clusterMetadata
- Information about a specific cluster, including shipping information,
cluster status, and other important metadata.
$sel:httpStatus:DescribeClusterResponse'
, describeClusterResponse_httpStatus
- The response's http status code.
DescribeJob
data DescribeJob Source #
See: newDescribeJob
smart constructor.
Instances
Create a value of DescribeJob
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:
DescribeJob
, describeJob_jobId
- The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000
.
data DescribeJobResponse Source #
See: newDescribeJobResponse
smart constructor.
Instances
newDescribeJobResponse Source #
Create a value of DescribeJobResponse
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:
$sel:jobMetadata:DescribeJobResponse'
, describeJobResponse_jobMetadata
- Information about a specific job, including shipping information, job
status, and other important metadata.
$sel:subJobMetadata:DescribeJobResponse'
, describeJobResponse_subJobMetadata
- Information about a specific job part (in the case of an export job),
including shipping information, job status, and other important
metadata.
$sel:httpStatus:DescribeJobResponse'
, describeJobResponse_httpStatus
- The response's http status code.
DescribeReturnShippingLabel
data DescribeReturnShippingLabel Source #
See: newDescribeReturnShippingLabel
smart constructor.
Instances
newDescribeReturnShippingLabel Source #
Create a value of DescribeReturnShippingLabel
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:
DescribeReturnShippingLabel
, describeReturnShippingLabel_jobId
- The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000
.
data DescribeReturnShippingLabelResponse Source #
See: newDescribeReturnShippingLabelResponse
smart constructor.
Instances
newDescribeReturnShippingLabelResponse Source #
Create a value of DescribeReturnShippingLabelResponse
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:
$sel:expirationDate:DescribeReturnShippingLabelResponse'
, describeReturnShippingLabelResponse_expirationDate
- The expiration date of the current return shipping label.
$sel:returnShippingLabelURI:DescribeReturnShippingLabelResponse'
, describeReturnShippingLabelResponse_returnShippingLabelURI
- The pre-signed Amazon S3 URI used to download the return shipping label.
DescribeReturnShippingLabelResponse
, describeReturnShippingLabelResponse_status
- The status information of the task on a Snow device that is being
returned to Amazon Web Services.
$sel:httpStatus:DescribeReturnShippingLabelResponse'
, describeReturnShippingLabelResponse_httpStatus
- The response's http status code.
GetJobManifest
data GetJobManifest Source #
See: newGetJobManifest
smart constructor.
Instances
Create a value of GetJobManifest
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:
GetJobManifest
, getJobManifest_jobId
- The ID for a job that you want to get the manifest file for, for example
JID123e4567-e89b-12d3-a456-426655440000
.
data GetJobManifestResponse Source #
See: newGetJobManifestResponse
smart constructor.
Instances
newGetJobManifestResponse Source #
Create a value of GetJobManifestResponse
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:
$sel:manifestURI:GetJobManifestResponse'
, getJobManifestResponse_manifestURI
- The Amazon S3 presigned URL for the manifest file associated with the
specified JobId
value.
$sel:httpStatus:GetJobManifestResponse'
, getJobManifestResponse_httpStatus
- The response's http status code.
GetJobUnlockCode
data GetJobUnlockCode Source #
See: newGetJobUnlockCode
smart constructor.
Instances
Create a value of GetJobUnlockCode
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:
GetJobUnlockCode
, getJobUnlockCode_jobId
- The ID for the job that you want to get the UnlockCode
value for, for
example JID123e4567-e89b-12d3-a456-426655440000
.
data GetJobUnlockCodeResponse Source #
See: newGetJobUnlockCodeResponse
smart constructor.
Instances
newGetJobUnlockCodeResponse Source #
Create a value of GetJobUnlockCodeResponse
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:
$sel:unlockCode:GetJobUnlockCodeResponse'
, getJobUnlockCodeResponse_unlockCode
- The UnlockCode
value for the specified job. The UnlockCode
value can
be accessed for up to 360 days after the job has been created.
$sel:httpStatus:GetJobUnlockCodeResponse'
, getJobUnlockCodeResponse_httpStatus
- The response's http status code.
GetSnowballUsage
data GetSnowballUsage Source #
See: newGetSnowballUsage
smart constructor.
Instances
newGetSnowballUsage :: GetSnowballUsage Source #
Create a value of GetSnowballUsage
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetSnowballUsageResponse Source #
See: newGetSnowballUsageResponse
smart constructor.
Instances
newGetSnowballUsageResponse Source #
Create a value of GetSnowballUsageResponse
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:
$sel:snowballLimit:GetSnowballUsageResponse'
, getSnowballUsageResponse_snowballLimit
- The service limit for number of Snow devices this account can have at
once. The default service limit is 1 (one).
$sel:snowballsInUse:GetSnowballUsageResponse'
, getSnowballUsageResponse_snowballsInUse
- The number of Snow devices that this account is currently using.
$sel:httpStatus:GetSnowballUsageResponse'
, getSnowballUsageResponse_httpStatus
- The response's http status code.
GetSoftwareUpdates
data GetSoftwareUpdates Source #
See: newGetSoftwareUpdates
smart constructor.
Instances
newGetSoftwareUpdates Source #
Create a value of GetSoftwareUpdates
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:
GetSoftwareUpdates
, getSoftwareUpdates_jobId
- The ID for a job that you want to get the software update file for, for
example JID123e4567-e89b-12d3-a456-426655440000
.
data GetSoftwareUpdatesResponse Source #
See: newGetSoftwareUpdatesResponse
smart constructor.
Instances
newGetSoftwareUpdatesResponse Source #
Create a value of GetSoftwareUpdatesResponse
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:
$sel:updatesURI:GetSoftwareUpdatesResponse'
, getSoftwareUpdatesResponse_updatesURI
- The Amazon S3 presigned URL for the update file associated with the
specified JobId
value. The software update will be available for 2
days after this request is made. To access an update after the 2 days
have passed, you'll have to make another call to GetSoftwareUpdates
.
$sel:httpStatus:GetSoftwareUpdatesResponse'
, getSoftwareUpdatesResponse_httpStatus
- The response's http status code.
ListClusterJobs (Paginated)
data ListClusterJobs Source #
See: newListClusterJobs
smart constructor.
Instances
Create a value of ListClusterJobs
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:
$sel:maxResults:ListClusterJobs'
, listClusterJobs_maxResults
- The number of JobListEntry
objects to return.
ListClusterJobs
, listClusterJobs_nextToken
- HTTP requests are stateless. To identify what object comes "next" in
the list of JobListEntry
objects, you have the option of specifying
NextToken
as the starting point for your returned list.
ListClusterJobs
, listClusterJobs_clusterId
- The 39-character ID for the cluster that you want to list, for example
CID123e4567-e89b-12d3-a456-426655440000
.
data ListClusterJobsResponse Source #
See: newListClusterJobsResponse
smart constructor.
Instances
newListClusterJobsResponse Source #
Create a value of ListClusterJobsResponse
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:
$sel:jobListEntries:ListClusterJobsResponse'
, listClusterJobsResponse_jobListEntries
- 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.
ListClusterJobs
, listClusterJobsResponse_nextToken
- HTTP requests are stateless. If you use the automatically generated
NextToken
value in your next ListClusterJobsResult
call, your list
of returned jobs will start from this point in the array.
$sel:httpStatus:ListClusterJobsResponse'
, listClusterJobsResponse_httpStatus
- The response's http status code.
ListClusters (Paginated)
data ListClusters Source #
See: newListClusters
smart constructor.
Instances
newListClusters :: ListClusters Source #
Create a value of ListClusters
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:
$sel:maxResults:ListClusters'
, listClusters_maxResults
- The number of ClusterListEntry
objects to return.
ListClusters
, listClusters_nextToken
- HTTP requests are stateless. To identify what object comes "next" in
the list of ClusterListEntry
objects, you have the option of
specifying NextToken
as the starting point for your returned list.
data ListClustersResponse Source #
See: newListClustersResponse
smart constructor.
Instances
newListClustersResponse Source #
Create a value of ListClustersResponse
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:
$sel:clusterListEntries:ListClustersResponse'
, listClustersResponse_clusterListEntries
- Each ClusterListEntry
object contains a cluster's state, a cluster's
ID, and other important status information.
ListClusters
, listClustersResponse_nextToken
- HTTP requests are stateless. If you use the automatically generated
NextToken
value in your next ClusterListEntry
call, your list of
returned clusters will start from this point in the array.
$sel:httpStatus:ListClustersResponse'
, listClustersResponse_httpStatus
- The response's http status code.
ListCompatibleImages (Paginated)
data ListCompatibleImages Source #
See: newListCompatibleImages
smart constructor.
Instances
newListCompatibleImages :: ListCompatibleImages Source #
Create a value of ListCompatibleImages
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:
$sel:maxResults:ListCompatibleImages'
, listCompatibleImages_maxResults
- The maximum number of results for the list of compatible images.
Currently, a Snowball Edge device can store 10 AMIs.
ListCompatibleImages
, listCompatibleImages_nextToken
- HTTP requests are stateless. To identify what object comes "next" in
the list of compatible images, you can specify a value for NextToken
as the starting point for your list of returned images.
data ListCompatibleImagesResponse Source #
See: newListCompatibleImagesResponse
smart constructor.
Instances
newListCompatibleImagesResponse Source #
Create a value of ListCompatibleImagesResponse
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:
$sel:compatibleImages:ListCompatibleImagesResponse'
, listCompatibleImagesResponse_compatibleImages
- A JSON-formatted object that describes a compatible AMI, including the
ID and name for a Snow device AMI.
ListCompatibleImages
, listCompatibleImagesResponse_nextToken
- Because HTTP requests are stateless, this is the starting point for your
next list of returned images.
$sel:httpStatus:ListCompatibleImagesResponse'
, listCompatibleImagesResponse_httpStatus
- The response's http status code.
ListJobs (Paginated)
See: newListJobs
smart constructor.
Instances
newListJobs :: ListJobs Source #
Create a value of ListJobs
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:
$sel:maxResults:ListJobs'
, listJobs_maxResults
- The number of JobListEntry
objects to return.
ListJobs
, listJobs_nextToken
- HTTP requests are stateless. To identify what object comes "next" in
the list of JobListEntry
objects, you have the option of specifying
NextToken
as the starting point for your returned list.
data ListJobsResponse Source #
See: newListJobsResponse
smart constructor.
Instances
Create a value of ListJobsResponse
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:
$sel:jobListEntries:ListJobsResponse'
, listJobsResponse_jobListEntries
- 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.
ListJobs
, listJobsResponse_nextToken
- HTTP requests are stateless. If you use this automatically generated
NextToken
value in your next ListJobs
call, your returned
JobListEntry
objects will start from this point in the array.
$sel:httpStatus:ListJobsResponse'
, listJobsResponse_httpStatus
- The response's http status code.
ListLongTermPricing (Paginated)
data ListLongTermPricing Source #
See: newListLongTermPricing
smart constructor.
Instances
newListLongTermPricing :: ListLongTermPricing Source #
Create a value of ListLongTermPricing
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:
$sel:maxResults:ListLongTermPricing'
, listLongTermPricing_maxResults
- The maximum number of ListLongTermPricing
objects to return.
ListLongTermPricing
, listLongTermPricing_nextToken
- Because HTTP requests are stateless, this is the starting point for your
next list of ListLongTermPricing
to return.
data ListLongTermPricingResponse Source #
See: newListLongTermPricingResponse
smart constructor.
Instances
newListLongTermPricingResponse Source #
Create a value of ListLongTermPricingResponse
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:
$sel:longTermPricingEntries:ListLongTermPricingResponse'
, listLongTermPricingResponse_longTermPricingEntries
- Each LongTermPricingEntry
object contains a status, ID, and other
information about the LongTermPricing
type.
ListLongTermPricing
, listLongTermPricingResponse_nextToken
- Because HTTP requests are stateless, this is the starting point for your
next list of returned ListLongTermPricing
list.
$sel:httpStatus:ListLongTermPricingResponse'
, listLongTermPricingResponse_httpStatus
- The response's http status code.
UpdateCluster
data UpdateCluster Source #
See: newUpdateCluster
smart constructor.
UpdateCluster' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Notification) (Maybe OnDeviceServiceConfiguration) (Maybe JobResource) (Maybe Text) (Maybe ShippingOption) Text |
Instances
Create a value of UpdateCluster
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:
UpdateCluster
, updateCluster_addressId
- The ID of the updated Address object.
UpdateCluster
, updateCluster_description
- The updated description of this cluster.
UpdateCluster
, updateCluster_forwardingAddressId
- The updated ID for the forwarding address for a cluster. This field is
not supported in most regions.
UpdateCluster
, updateCluster_notification
- The new or updated Notification object.
UpdateCluster
, updateCluster_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 device clusters support Amazon S3 and NFS (Network
File System).
UpdateCluster
, updateCluster_resources
- The updated arrays of JobResource objects that can include updated
S3Resource objects or LambdaResource objects.
UpdateCluster
, updateCluster_roleARN
- The new role Amazon Resource Name (ARN) that you want to associate with
this cluster. To create a role ARN, use the
CreateRole
API action in Identity and Access Management (IAM).
UpdateCluster
, updateCluster_shippingOption
- The updated shipping option value of this cluster's ShippingDetails
object.
UpdateCluster
, updateCluster_clusterId
- The cluster ID of the cluster that you want to update, for example
CID123e4567-e89b-12d3-a456-426655440000
.
data UpdateClusterResponse Source #
See: newUpdateClusterResponse
smart constructor.
Instances
newUpdateClusterResponse Source #
Create a value of UpdateClusterResponse
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:
$sel:httpStatus:UpdateClusterResponse'
, updateClusterResponse_httpStatus
- The response's http status code.
UpdateJob
See: newUpdateJob
smart constructor.
UpdateJob' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Notification) (Maybe OnDeviceServiceConfiguration) (Maybe JobResource) (Maybe Text) (Maybe ShippingOption) (Maybe SnowballCapacity) Text |
Instances
Create a value of UpdateJob
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:
UpdateJob
, updateJob_addressId
- The ID of the updated Address object.
UpdateJob
, updateJob_description
- The updated description of this job's JobMetadata object.
UpdateJob
, updateJob_forwardingAddressId
- The updated ID for the forwarding address for a job. This field is not
supported in most regions.
UpdateJob
, updateJob_notification
- The new or updated Notification object.
UpdateJob
, updateJob_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.
UpdateJob
, updateJob_resources
- The updated JobResource
object, or the updated JobResource object.
UpdateJob
, updateJob_roleARN
- The new role Amazon Resource Name (ARN) that you want to associate with
this job. To create a role ARN, use the
CreateRoleIdentity
and Access Management (IAM) API action.
UpdateJob
, updateJob_shippingOption
- The updated shipping option value of this job's ShippingDetails object.
UpdateJob
, updateJob_snowballCapacityPreference
- The updated SnowballCapacityPreference
of this job's JobMetadata
object. The 50 TB Snowballs are only available in the US regions.
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.
UpdateJob
, updateJob_jobId
- The job ID of the job that you want to update, for example
JID123e4567-e89b-12d3-a456-426655440000
.
data UpdateJobResponse Source #
See: newUpdateJobResponse
smart constructor.
Instances
Create a value of UpdateJobResponse
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:
$sel:httpStatus:UpdateJobResponse'
, updateJobResponse_httpStatus
- The response's http status code.
UpdateJobShipmentState
data UpdateJobShipmentState Source #
See: newUpdateJobShipmentState
smart constructor.
Instances
newUpdateJobShipmentState Source #
Create a value of UpdateJobShipmentState
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:
UpdateJobShipmentState
, updateJobShipmentState_jobId
- The job ID of the job whose shipment date you want to update, for
example JID123e4567-e89b-12d3-a456-426655440000
.
$sel:shipmentState:UpdateJobShipmentState'
, updateJobShipmentState_shipmentState
- The state of a device when it is being shipped.
Set to RECEIVED
when the device arrives at your location.
Set to RETURNED
when you have returned the device to Amazon Web
Services.
data UpdateJobShipmentStateResponse Source #
See: newUpdateJobShipmentStateResponse
smart constructor.
Instances
Generic UpdateJobShipmentStateResponse Source # | |
Read UpdateJobShipmentStateResponse Source # | |
Show UpdateJobShipmentStateResponse Source # | |
Defined in Amazonka.Snowball.UpdateJobShipmentState | |
NFData UpdateJobShipmentStateResponse Source # | |
Defined in Amazonka.Snowball.UpdateJobShipmentState rnf :: UpdateJobShipmentStateResponse -> () # | |
Eq UpdateJobShipmentStateResponse Source # | |
type Rep UpdateJobShipmentStateResponse Source # | |
Defined in Amazonka.Snowball.UpdateJobShipmentState type Rep UpdateJobShipmentStateResponse = D1 ('MetaData "UpdateJobShipmentStateResponse" "Amazonka.Snowball.UpdateJobShipmentState" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "UpdateJobShipmentStateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newUpdateJobShipmentStateResponse Source #
Create a value of UpdateJobShipmentStateResponse
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:
$sel:httpStatus:UpdateJobShipmentStateResponse'
, updateJobShipmentStateResponse_httpStatus
- The response's http status code.
UpdateLongTermPricing
data UpdateLongTermPricing Source #
See: newUpdateLongTermPricing
smart constructor.
Instances
newUpdateLongTermPricing Source #
Create a value of UpdateLongTermPricing
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:
UpdateLongTermPricing
, updateLongTermPricing_isLongTermPricingAutoRenew
- If set to true
, specifies that the current long-term pricing type for
the device should be automatically renewed before the long-term pricing
contract expires.
UpdateLongTermPricing
, updateLongTermPricing_replacementJob
- Specifies that a device that is ordered with long-term pricing should be
replaced with a new device.
UpdateLongTermPricing
, updateLongTermPricing_longTermPricingId
- The ID of the long-term pricing type for the device.
data UpdateLongTermPricingResponse Source #
See: newUpdateLongTermPricingResponse
smart constructor.
Instances
Generic UpdateLongTermPricingResponse Source # | |
Read UpdateLongTermPricingResponse Source # | |
Show UpdateLongTermPricingResponse Source # | |
Defined in Amazonka.Snowball.UpdateLongTermPricing showsPrec :: Int -> UpdateLongTermPricingResponse -> ShowS # show :: UpdateLongTermPricingResponse -> String # showList :: [UpdateLongTermPricingResponse] -> ShowS # | |
NFData UpdateLongTermPricingResponse Source # | |
Defined in Amazonka.Snowball.UpdateLongTermPricing rnf :: UpdateLongTermPricingResponse -> () # | |
Eq UpdateLongTermPricingResponse Source # | |
type Rep UpdateLongTermPricingResponse Source # | |
Defined in Amazonka.Snowball.UpdateLongTermPricing type Rep UpdateLongTermPricingResponse = D1 ('MetaData "UpdateLongTermPricingResponse" "Amazonka.Snowball.UpdateLongTermPricing" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "UpdateLongTermPricingResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newUpdateLongTermPricingResponse Source #
Create a value of UpdateLongTermPricingResponse
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:
$sel:httpStatus:UpdateLongTermPricingResponse'
, updateLongTermPricingResponse_httpStatus
- The response's http status code.
Types
ClusterState
newtype ClusterState Source #
pattern ClusterState_AwaitingQuorum :: ClusterState | |
pattern ClusterState_Cancelled :: ClusterState | |
pattern ClusterState_Complete :: ClusterState | |
pattern ClusterState_InUse :: ClusterState | |
pattern ClusterState_Pending :: ClusterState |
Instances
DeviceServiceName
newtype DeviceServiceName Source #
pattern DeviceServiceName_NFS_ON_DEVICE_SERVICE :: DeviceServiceName | |
pattern DeviceServiceName_S3_ON_DEVICE_SERVICE :: DeviceServiceName |
Instances
JobState
pattern JobState_Cancelled :: JobState | |
pattern JobState_Complete :: JobState | |
pattern JobState_InProgress :: JobState | |
pattern JobState_InTransitToAWS :: JobState | |
pattern JobState_InTransitToCustomer :: JobState | |
pattern JobState_Listing :: JobState | |
pattern JobState_New :: JobState | |
pattern JobState_Pending :: JobState | |
pattern JobState_PreparingAppliance :: JobState | |
pattern JobState_PreparingShipment :: JobState | |
pattern JobState_WithAWS :: JobState | |
pattern JobState_WithAWSSortingFacility :: JobState | |
pattern JobState_WithCustomer :: JobState |
Instances
JobType
pattern JobType_EXPORT :: JobType | |
pattern JobType_IMPORT :: JobType | |
pattern JobType_LOCAL_USE :: JobType |
Instances
LongTermPricingType
newtype LongTermPricingType Source #
pattern LongTermPricingType_OneYear :: LongTermPricingType | |
pattern LongTermPricingType_ThreeYear :: LongTermPricingType |
Instances
RemoteManagement
newtype RemoteManagement Source #
pattern RemoteManagement_INSTALLED_AUTOSTART :: RemoteManagement | |
pattern RemoteManagement_INSTALLED_ONLY :: RemoteManagement |
Instances
ShipmentState
newtype ShipmentState Source #
pattern ShipmentState_RECEIVED :: ShipmentState | |
pattern ShipmentState_RETURNED :: ShipmentState |
Instances
ShippingLabelStatus
newtype ShippingLabelStatus Source #
pattern ShippingLabelStatus_Failed :: ShippingLabelStatus | |
pattern ShippingLabelStatus_InProgress :: ShippingLabelStatus | |
pattern ShippingLabelStatus_Succeeded :: ShippingLabelStatus | |
pattern ShippingLabelStatus_TimedOut :: ShippingLabelStatus |
Instances
ShippingOption
newtype ShippingOption Source #
pattern ShippingOption_EXPRESS :: ShippingOption | |
pattern ShippingOption_NEXT_DAY :: ShippingOption | |
pattern ShippingOption_SECOND_DAY :: ShippingOption | |
pattern ShippingOption_STANDARD :: ShippingOption |
Instances
SnowballCapacity
newtype SnowballCapacity Source #
pattern SnowballCapacity_NoPreference :: SnowballCapacity | |
pattern SnowballCapacity_T100 :: SnowballCapacity | |
pattern SnowballCapacity_T14 :: SnowballCapacity | |
pattern SnowballCapacity_T32 :: SnowballCapacity | |
pattern SnowballCapacity_T42 :: SnowballCapacity | |
pattern SnowballCapacity_T50 :: SnowballCapacity | |
pattern SnowballCapacity_T8 :: SnowballCapacity | |
pattern SnowballCapacity_T80 :: SnowballCapacity | |
pattern SnowballCapacity_T98 :: SnowballCapacity |
Instances
SnowballType
newtype SnowballType Source #
pattern SnowballType_EDGE :: SnowballType | |
pattern SnowballType_EDGE_C :: SnowballType | |
pattern SnowballType_EDGE_CG :: SnowballType | |
pattern SnowballType_EDGE_S :: SnowballType | |
pattern SnowballType_SNC1_HDD :: SnowballType | |
pattern SnowballType_SNC1_SSD :: SnowballType | |
pattern SnowballType_STANDARD :: SnowballType | |
pattern SnowballType_V3_5C :: SnowballType |
Instances
StorageUnit
newtype StorageUnit Source #
pattern StorageUnit_TB :: StorageUnit |
Instances
TransferOption
newtype TransferOption Source #
pattern TransferOption_EXPORT :: TransferOption | |
pattern TransferOption_IMPORT :: TransferOption | |
pattern TransferOption_LOCAL_USE :: TransferOption |
Instances
Address
The address that you want the Snow device(s) 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.
See: newAddress
smart constructor.
Address' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newAddress :: Address Source #
Create a value of Address
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:
$sel:addressId:Address'
, address_addressId
- The unique ID for an address.
$sel:city:Address'
, address_city
- The city in an address that a Snow device is to be delivered to.
$sel:company:Address'
, address_company
- The name of the company to receive a Snow device at an address.
$sel:country:Address'
, address_country
- The country in an address that a Snow device is to be delivered to.
$sel:isRestricted:Address'
, address_isRestricted
- If the address you are creating is a primary address, then set this
option to true. This field is not supported in most regions.
$sel:landmark:Address'
, address_landmark
- This field is no longer used and the value is ignored.
$sel:name:Address'
, address_name
- The name of a person to receive a Snow device at an address.
$sel:phoneNumber:Address'
, address_phoneNumber
- The phone number associated with an address that a Snow device is to be
delivered to.
$sel:postalCode:Address'
, address_postalCode
- The postal code in an address that a Snow device is to be delivered to.
$sel:prefectureOrDistrict:Address'
, address_prefectureOrDistrict
- This field is no longer used and the value is ignored.
$sel:stateOrProvince:Address'
, address_stateOrProvince
- The state or province in an address that a Snow device is to be
delivered to.
$sel:street1:Address'
, address_street1
- The first line in a street address that a Snow device is to be delivered
to.
$sel:street2:Address'
, address_street2
- The second line in a street address that a Snow device is to be
delivered to.
$sel:street3:Address'
, address_street3
- The third line in a street address that a Snow device is to be delivered
to.
ClusterListEntry
data ClusterListEntry Source #
Contains a cluster's state, a cluster's ID, and other important information.
See: newClusterListEntry
smart constructor.
ClusterListEntry' (Maybe Text) (Maybe ClusterState) (Maybe POSIX) (Maybe Text) |
Instances
newClusterListEntry :: ClusterListEntry Source #
Create a value of ClusterListEntry
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:
$sel:clusterId:ClusterListEntry'
, clusterListEntry_clusterId
- The 39-character ID for the cluster that you want to list, for example
CID123e4567-e89b-12d3-a456-426655440000
.
$sel:clusterState:ClusterListEntry'
, clusterListEntry_clusterState
- The current state of this cluster. For information about the state of a
specific node, see JobListEntry$JobState.
$sel:creationDate:ClusterListEntry'
, clusterListEntry_creationDate
- The creation date for this cluster.
$sel:description:ClusterListEntry'
, clusterListEntry_description
- Defines an optional description of the cluster, for example
Environmental Data Cluster-01
.
ClusterMetadata
data ClusterMetadata Source #
Contains metadata about a specific cluster.
See: newClusterMetadata
smart constructor.
ClusterMetadata' (Maybe Text) (Maybe Text) (Maybe ClusterState) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe JobType) (Maybe Text) (Maybe Notification) (Maybe OnDeviceServiceConfiguration) (Maybe JobResource) (Maybe Text) (Maybe ShippingOption) (Maybe SnowballType) (Maybe TaxDocuments) |
Instances
newClusterMetadata :: ClusterMetadata Source #
Create a value of ClusterMetadata
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:
$sel:addressId:ClusterMetadata'
, clusterMetadata_addressId
- The automatically generated ID for a specific address.
$sel:clusterId:ClusterMetadata'
, clusterMetadata_clusterId
- The automatically generated ID for a cluster.
$sel:clusterState:ClusterMetadata'
, clusterMetadata_clusterState
- The current status of the cluster.
$sel:creationDate:ClusterMetadata'
, clusterMetadata_creationDate
- The creation date for this cluster.
$sel:description:ClusterMetadata'
, clusterMetadata_description
- The optional description of the cluster.
$sel:forwardingAddressId:ClusterMetadata'
, clusterMetadata_forwardingAddressId
- The ID of the address that you want a cluster shipped to, after it will
be shipped to its primary address. This field is not supported in most
regions.
$sel:jobType:ClusterMetadata'
, clusterMetadata_jobType
- The type of job for this cluster. Currently, the only job type supported
for clusters is LOCAL_USE
.
$sel:kmsKeyARN:ClusterMetadata'
, clusterMetadata_kmsKeyARN
- The KmsKeyARN
Amazon Resource Name (ARN) associated with this cluster.
This ARN was created using the
CreateKey
API action in Key Management Service (KMS.
$sel:notification:ClusterMetadata'
, clusterMetadata_notification
- The Amazon Simple Notification Service (Amazon SNS) notification
settings for this cluster.
$sel:onDeviceServiceConfiguration:ClusterMetadata'
, clusterMetadata_onDeviceServiceConfiguration
- Represents metadata and configuration settings for services on an Amazon
Web Services Snow Family device.
$sel:resources:ClusterMetadata'
, clusterMetadata_resources
- The arrays of JobResource objects that can include updated S3Resource
objects or LambdaResource objects.
$sel:roleARN:ClusterMetadata'
, clusterMetadata_roleARN
- The role ARN associated with this cluster. This ARN was created using
the
CreateRole
API action in Identity and Access Management (IAM).
$sel:shippingOption:ClusterMetadata'
, clusterMetadata_shippingOption
- The shipping speed for each node in this cluster. This speed doesn't
dictate how soon you'll get each device, rather it represents how
quickly each device moves to its destination while in transit. Regional
shipping speeds are as follows:
- In Australia, you have access to express shipping. Typically, 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.
$sel:snowballType:ClusterMetadata'
, clusterMetadata_snowballType
- The type of Snowcone device to use for this cluster.
For cluster jobs, Amazon Web Services Snow Family currently supports
only the EDGE
device type.
$sel:taxDocuments:ClusterMetadata'
, clusterMetadata_taxDocuments
- The tax documents required in your Amazon Web Services Region.
CompatibleImage
data CompatibleImage Source #
A JSON-formatted object that describes a compatible Amazon Machine Image (AMI), including the ID and name for a Snow device AMI. This AMI is compatible with the device's physical hardware requirements, and it should be able to be run in an SBE1 instance on the device.
See: newCompatibleImage
smart constructor.
Instances
newCompatibleImage :: CompatibleImage Source #
Create a value of CompatibleImage
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:
$sel:amiId:CompatibleImage'
, compatibleImage_amiId
- The unique identifier for an individual Snow device AMI.
$sel:name:CompatibleImage'
, compatibleImage_name
- The optional name of a compatible image.
DataTransfer
data DataTransfer Source #
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.
See: newDataTransfer
smart constructor.
Instances
newDataTransfer :: DataTransfer Source #
Create a value of DataTransfer
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:
$sel:bytesTransferred:DataTransfer'
, dataTransfer_bytesTransferred
- The number of bytes transferred between a Snow device and Amazon S3.
$sel:objectsTransferred:DataTransfer'
, dataTransfer_objectsTransferred
- The number of objects transferred between a Snow device and Amazon S3.
$sel:totalBytes:DataTransfer'
, dataTransfer_totalBytes
- The total bytes of data for a transfer between a Snow device and Amazon
S3. This value is set to 0 (zero) until all the keys that will be
transferred have been listed.
$sel:totalObjects:DataTransfer'
, dataTransfer_totalObjects
- The total number of objects for a transfer between a Snow device and
Amazon S3. This value is set to 0 (zero) until all the keys that will be
transferred have been listed.
DeviceConfiguration
data DeviceConfiguration Source #
The container for SnowconeDeviceConfiguration
.
See: newDeviceConfiguration
smart constructor.
Instances
newDeviceConfiguration :: DeviceConfiguration Source #
Create a value of DeviceConfiguration
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:
$sel:snowconeDeviceConfiguration:DeviceConfiguration'
, deviceConfiguration_snowconeDeviceConfiguration
- Returns information about the device configuration for an Snowcone job.
Ec2AmiResource
data Ec2AmiResource Source #
A JSON-formatted object that contains the IDs for an Amazon Machine Image (AMI), including the Amazon EC2 AMI ID and the Snow device AMI ID. Each AMI has these two IDs to simplify identifying the AMI in both the Amazon Web Services Cloud and on the device.
See: newEc2AmiResource
smart constructor.
Instances
Create a value of Ec2AmiResource
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:
$sel:snowballAmiId:Ec2AmiResource'
, ec2AmiResource_snowballAmiId
- The ID of the AMI on the Snow device.
$sel:amiId:Ec2AmiResource'
, ec2AmiResource_amiId
- The ID of the AMI in Amazon EC2.
EventTriggerDefinition
data EventTriggerDefinition Source #
The container for the EventTriggerDefinition$EventResourceARN.
See: newEventTriggerDefinition
smart constructor.
Instances
newEventTriggerDefinition :: EventTriggerDefinition Source #
Create a value of EventTriggerDefinition
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:
$sel:eventResourceARN:EventTriggerDefinition'
, eventTriggerDefinition_eventResourceARN
- The Amazon Resource Name (ARN) for any local Amazon S3 resource that is
an Lambda function's event trigger associated with this job.
INDTaxDocuments
data INDTaxDocuments Source #
The tax documents required in Amazon Web Services Region in India.
See: newINDTaxDocuments
smart constructor.
Instances
newINDTaxDocuments :: INDTaxDocuments Source #
Create a value of INDTaxDocuments
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:
$sel:gstin:INDTaxDocuments'
, iNDTaxDocuments_gstin
- The Goods and Services Tax (GST) documents required in Amazon Web
Services Region in India.
JobListEntry
data JobListEntry Source #
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.
See: newJobListEntry
smart constructor.
JobListEntry' (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe JobState) (Maybe JobType) (Maybe SnowballType) |
Instances
newJobListEntry :: JobListEntry Source #
Create a value of JobListEntry
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:
$sel:creationDate:JobListEntry'
, jobListEntry_creationDate
- The creation date for this job.
$sel:description:JobListEntry'
, jobListEntry_description
- The optional description of this specific job, for example
Important Photos 2016-08-11
.
$sel:isMaster:JobListEntry'
, jobListEntry_isMaster
- A value that indicates that this job is a main job. A main job
represents a successful request to create an export job. Main jobs
aren't associated with any Snowballs. Instead, each main job will have
at least one job part, and each job part is associated with a Snowball.
It might take some time before the job parts associated with a
particular main job are listed, because they are created after the main
job is created.
$sel:jobId:JobListEntry'
, jobListEntry_jobId
- The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000
.
$sel:jobState:JobListEntry'
, jobListEntry_jobState
- The current state of this job.
$sel:jobType:JobListEntry'
, jobListEntry_jobType
- The type of job.
$sel:snowballType:JobListEntry'
, jobListEntry_snowballType
- The type of device used with this job.
JobLogs
Contains job logs. Whenever a Snow device 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 Snow device 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.
See: newJobLogs
smart constructor.
Instances
FromJSON JobLogs Source # | |
Generic JobLogs Source # | |
Read JobLogs Source # | |
Show JobLogs Source # | |
NFData JobLogs Source # | |
Defined in Amazonka.Snowball.Types.JobLogs | |
Eq JobLogs Source # | |
Hashable JobLogs Source # | |
Defined in Amazonka.Snowball.Types.JobLogs | |
type Rep JobLogs Source # | |
Defined in Amazonka.Snowball.Types.JobLogs type Rep JobLogs = D1 ('MetaData "JobLogs" "Amazonka.Snowball.Types.JobLogs" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "JobLogs'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobCompletionReportURI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobFailureLogURI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobSuccessLogURI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) |
newJobLogs :: JobLogs Source #
Create a value of JobLogs
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:
$sel:jobCompletionReportURI:JobLogs'
, jobLogs_jobCompletionReportURI
- A link to an Amazon S3 presigned URL where the job completion report is
located.
$sel:jobFailureLogURI:JobLogs'
, jobLogs_jobFailureLogURI
- A link to an Amazon S3 presigned URL where the job failure log is
located.
$sel:jobSuccessLogURI:JobLogs'
, jobLogs_jobSuccessLogURI
- A link to an Amazon S3 presigned URL where the job success log is
located.
JobMetadata
data JobMetadata Source #
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.
See: newJobMetadata
smart constructor.
JobMetadata' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe DataTransfer) (Maybe Text) (Maybe DeviceConfiguration) (Maybe Text) (Maybe Text) (Maybe JobLogs) (Maybe JobState) (Maybe JobType) (Maybe Text) (Maybe Text) (Maybe Notification) (Maybe OnDeviceServiceConfiguration) (Maybe RemoteManagement) (Maybe JobResource) (Maybe Text) (Maybe ShippingDetails) (Maybe SnowballCapacity) (Maybe SnowballType) (Maybe TaxDocuments) |
Instances
newJobMetadata :: JobMetadata Source #
Create a value of JobMetadata
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:
$sel:addressId:JobMetadata'
, jobMetadata_addressId
- The ID for the address that you want the Snow device shipped to.
$sel:clusterId:JobMetadata'
, jobMetadata_clusterId
- The 39-character ID for the cluster, for example
CID123e4567-e89b-12d3-a456-426655440000
.
$sel:creationDate:JobMetadata'
, jobMetadata_creationDate
- The creation date for this job.
$sel:dataTransferProgress:JobMetadata'
, jobMetadata_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.
$sel:description:JobMetadata'
, jobMetadata_description
- The description of the job, provided at job creation.
$sel:deviceConfiguration:JobMetadata'
, jobMetadata_deviceConfiguration
- Undocumented member.
$sel:forwardingAddressId:JobMetadata'
, jobMetadata_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.
$sel:jobId:JobMetadata'
, jobMetadata_jobId
- The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000
.
$sel:jobLogInfo:JobMetadata'
, jobMetadata_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.
$sel:jobState:JobMetadata'
, jobMetadata_jobState
- The current status of the jobs.
$sel:jobType:JobMetadata'
, jobMetadata_jobType
- The type of job.
$sel:kmsKeyARN:JobMetadata'
, jobMetadata_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.
$sel:longTermPricingId:JobMetadata'
, jobMetadata_longTermPricingId
- The ID of the long-term pricing type for the device.
$sel:notification:JobMetadata'
, jobMetadata_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.
$sel:onDeviceServiceConfiguration:JobMetadata'
, jobMetadata_onDeviceServiceConfiguration
- Represents metadata and configuration settings for services on an Amazon
Web Services Snow Family device.
$sel:remoteManagement:JobMetadata'
, jobMetadata_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.
$sel:resources:JobMetadata'
, jobMetadata_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.
$sel:roleARN:JobMetadata'
, jobMetadata_roleARN
- The role ARN associated with this job. This ARN was created using the
CreateRole
API action in Identity and Access Management.
$sel:shippingDetails:JobMetadata'
, jobMetadata_shippingDetails
- A job's shipping information, including inbound and outbound tracking
numbers and shipping speed options.
$sel:snowballCapacityPreference:JobMetadata'
, jobMetadata_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.
$sel:snowballType:JobMetadata'
, jobMetadata_snowballType
- The type of device used with this job.
$sel:taxDocuments:JobMetadata'
, jobMetadata_taxDocuments
- The metadata associated with the tax documents required in your Amazon
Web Services Region.
JobResource
data JobResource Source #
Contains an array of Amazon Web Services resource objects. Each object represents an Amazon S3 bucket, an Lambda function, or an Amazon Machine Image (AMI) based on Amazon EC2 that is associated with a particular job.
See: newJobResource
smart constructor.
JobResource' (Maybe [Ec2AmiResource]) (Maybe [LambdaResource]) (Maybe [S3Resource]) |
Instances
newJobResource :: JobResource Source #
Create a value of JobResource
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:
$sel:ec2AmiResources:JobResource'
, jobResource_ec2AmiResources
- The Amazon Machine Images (AMIs) associated with this job.
$sel:lambdaResources:JobResource'
, jobResource_lambdaResources
- The Python-language Lambda functions for this job.
$sel:s3Resources:JobResource'
, jobResource_s3Resources
- An array of S3Resource
objects.
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.
See: newKeyRange
smart constructor.
Instances
FromJSON KeyRange Source # | |
ToJSON KeyRange Source # | |
Defined in Amazonka.Snowball.Types.KeyRange | |
Generic KeyRange Source # | |
Read KeyRange Source # | |
Show KeyRange Source # | |
NFData KeyRange Source # | |
Defined in Amazonka.Snowball.Types.KeyRange | |
Eq KeyRange Source # | |
Hashable KeyRange Source # | |
Defined in Amazonka.Snowball.Types.KeyRange | |
type Rep KeyRange Source # | |
Defined in Amazonka.Snowball.Types.KeyRange type Rep KeyRange = D1 ('MetaData "KeyRange" "Amazonka.Snowball.Types.KeyRange" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "KeyRange'" 'PrefixI 'True) (S1 ('MetaSel ('Just "beginMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "endMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
newKeyRange :: KeyRange Source #
Create a value of KeyRange
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:
$sel:beginMarker:KeyRange'
, keyRange_beginMarker
- The key that starts an optional key range for an export job. Ranges are
inclusive and UTF-8 binary sorted.
$sel:endMarker:KeyRange'
, keyRange_endMarker
- The key that ends an optional key range for an export job. Ranges are
inclusive and UTF-8 binary sorted.
LambdaResource
data LambdaResource Source #
Identifies
See: newLambdaResource
smart constructor.
Instances
newLambdaResource :: LambdaResource Source #
Create a value of LambdaResource
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:
$sel:eventTriggers:LambdaResource'
, lambdaResource_eventTriggers
- The array of ARNs for S3Resource objects to trigger the LambdaResource
objects associated with this job.
$sel:lambdaArn:LambdaResource'
, lambdaResource_lambdaArn
- An Amazon Resource Name (ARN) that represents an Lambda function to be
triggered by PUT object actions on the associated local Amazon S3
resource.
LongTermPricingListEntry
data LongTermPricingListEntry Source #
Each LongTermPricingListEntry
object contains information about a
long-term pricing type.
See: newLongTermPricingListEntry
smart constructor.
LongTermPricingListEntry' (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe LongTermPricingType) (Maybe Text) (Maybe SnowballType) |
Instances
newLongTermPricingListEntry :: LongTermPricingListEntry Source #
Create a value of LongTermPricingListEntry
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:
$sel:currentActiveJob:LongTermPricingListEntry'
, longTermPricingListEntry_currentActiveJob
- The current active jobs on the device the long-term pricing type.
$sel:isLongTermPricingAutoRenew:LongTermPricingListEntry'
, longTermPricingListEntry_isLongTermPricingAutoRenew
- If set to true
, specifies that the current long-term pricing type for
the device should be automatically renewed before the long-term pricing
contract expires.
$sel:jobIds:LongTermPricingListEntry'
, longTermPricingListEntry_jobIds
- The IDs of the jobs that are associated with a long-term pricing type.
$sel:longTermPricingEndDate:LongTermPricingListEntry'
, longTermPricingListEntry_longTermPricingEndDate
- The end date the long-term pricing contract.
$sel:longTermPricingId:LongTermPricingListEntry'
, longTermPricingListEntry_longTermPricingId
- The ID of the long-term pricing type for the device.
$sel:longTermPricingStartDate:LongTermPricingListEntry'
, longTermPricingListEntry_longTermPricingStartDate
- The start date of the long-term pricing contract.
$sel:longTermPricingStatus:LongTermPricingListEntry'
, longTermPricingListEntry_longTermPricingStatus
- The status of the long-term pricing type.
$sel:longTermPricingType:LongTermPricingListEntry'
, longTermPricingListEntry_longTermPricingType
- The type of long-term pricing that was selected for the device.
$sel:replacementJob:LongTermPricingListEntry'
, longTermPricingListEntry_replacementJob
- A new device that replaces a device that is ordered with long-term
pricing.
$sel:snowballType:LongTermPricingListEntry'
, longTermPricingListEntry_snowballType
- The type of Snow Family devices associated with this long-term pricing
job.
NFSOnDeviceServiceConfiguration
data NFSOnDeviceServiceConfiguration Source #
An object that represents the metadata and configuration settings for the NFS (Network File System) service on an Amazon Web Services Snow Family device.
See: newNFSOnDeviceServiceConfiguration
smart constructor.
Instances
newNFSOnDeviceServiceConfiguration :: NFSOnDeviceServiceConfiguration Source #
Create a value of NFSOnDeviceServiceConfiguration
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:
$sel:storageLimit:NFSOnDeviceServiceConfiguration'
, nFSOnDeviceServiceConfiguration_storageLimit
- The maximum NFS storage for one Snow Family device.
$sel:storageUnit:NFSOnDeviceServiceConfiguration'
, nFSOnDeviceServiceConfiguration_storageUnit
- The scale unit of the NFS storage on the device.
Valid values: TB.
Notification
data Notification Source #
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.
See: newNotification
smart constructor.
Instances
newNotification :: Notification Source #
Create a value of Notification
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:
$sel:jobStatesToNotify:Notification'
, notification_jobStatesToNotify
- The list of job states that will trigger a notification for this job.
$sel:notifyAll:Notification'
, notification_notifyAll
- Any change in job state will trigger a notification for this job.
$sel:snsTopicARN:Notification'
, notification_snsTopicARN
- The new SNS TopicArn
that you want to associate with this job. You can
create Amazon Resource Names (ARNs) for topics by using the
CreateTopic
Amazon SNS API action.
You can subscribe email addresses to an Amazon SNS topic through the Amazon Web Services Management Console, or by using the Subscribe Amazon Simple Notification Service (Amazon SNS) API action.
OnDeviceServiceConfiguration
data OnDeviceServiceConfiguration Source #
An object that represents the metadata and configuration settings for services on an Amazon Web Services Snow Family device.
See: newOnDeviceServiceConfiguration
smart constructor.
OnDeviceServiceConfiguration' (Maybe NFSOnDeviceServiceConfiguration) (Maybe TGWOnDeviceServiceConfiguration) |
Instances
newOnDeviceServiceConfiguration :: OnDeviceServiceConfiguration Source #
Create a value of OnDeviceServiceConfiguration
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:
$sel:nFSOnDeviceService:OnDeviceServiceConfiguration'
, onDeviceServiceConfiguration_nFSOnDeviceService
- Represents the NFS (Network File System) service on a Snow Family
device.
$sel:tGWOnDeviceService:OnDeviceServiceConfiguration'
, onDeviceServiceConfiguration_tGWOnDeviceService
- Represents the Storage Gateway service Tape Gateway type on a Snow
Family device.
S3Resource
data S3Resource Source #
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.
See: newS3Resource
smart constructor.
Instances
newS3Resource :: S3Resource Source #
Create a value of S3Resource
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:
$sel:bucketArn:S3Resource'
, s3Resource_bucketArn
- The Amazon Resource Name (ARN) of an Amazon S3 bucket.
$sel:keyRange:S3Resource'
, s3Resource_keyRange
- For export jobs, you can provide an optional KeyRange
within a
specific Amazon S3 bucket. 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.
$sel:targetOnDeviceServices:S3Resource'
, s3Resource_targetOnDeviceServices
- 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).
Shipment
The Status
and TrackingNumber
information for an inbound or outbound
shipment.
See: newShipment
smart constructor.
Instances
FromJSON Shipment Source # | |
Generic Shipment Source # | |
Read Shipment Source # | |
Show Shipment Source # | |
NFData Shipment Source # | |
Defined in Amazonka.Snowball.Types.Shipment | |
Eq Shipment Source # | |
Hashable Shipment Source # | |
Defined in Amazonka.Snowball.Types.Shipment | |
type Rep Shipment Source # | |
Defined in Amazonka.Snowball.Types.Shipment type Rep Shipment = D1 ('MetaData "Shipment" "Amazonka.Snowball.Types.Shipment" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "Shipment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "trackingNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
newShipment :: Shipment Source #
Create a value of Shipment
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:
$sel:status:Shipment'
, shipment_status
- Status information for a shipment.
$sel:trackingNumber:Shipment'
, shipment_trackingNumber
- The tracking number for this job. Using this tracking number with your
region's carrier's website, you can track a Snow device as the carrier
transports it.
For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier.
ShippingDetails
data ShippingDetails Source #
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
See: newShippingDetails
smart constructor.
Instances
newShippingDetails :: ShippingDetails Source #
Create a value of ShippingDetails
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:
$sel:inboundShipment:ShippingDetails'
, shippingDetails_inboundShipment
- The Status
and TrackingNumber
values for a Snow device being
returned to Amazon Web Services for a particular job.
$sel:outboundShipment:ShippingDetails'
, shippingDetails_outboundShipment
- The Status
and TrackingNumber
values for a Snow device being
delivered to the address that you specified for a particular job.
$sel:shippingOption:ShippingDetails'
, shippingDetails_shippingOption
- The shipping speed for a particular job. This speed doesn't dictate how
soon you'll get the Snow device from the job's creation date. This
speed represents how quickly it 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 United States of America (US), you have access to one-day shipping and two-day shipping.
SnowconeDeviceConfiguration
data SnowconeDeviceConfiguration Source #
Specifies the device configuration for an Snowcone job.
See: newSnowconeDeviceConfiguration
smart constructor.
Instances
newSnowconeDeviceConfiguration :: SnowconeDeviceConfiguration Source #
Create a value of SnowconeDeviceConfiguration
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:
$sel:wirelessConnection:SnowconeDeviceConfiguration'
, snowconeDeviceConfiguration_wirelessConnection
- Configures the wireless connection for the Snowcone device.
TGWOnDeviceServiceConfiguration
data TGWOnDeviceServiceConfiguration Source #
An object that represents the metadata and configuration settings for the Storage Gateway service Tape Gateway type on an Amazon Web Services Snow Family device.
See: newTGWOnDeviceServiceConfiguration
smart constructor.
Instances
newTGWOnDeviceServiceConfiguration :: TGWOnDeviceServiceConfiguration Source #
Create a value of TGWOnDeviceServiceConfiguration
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:
$sel:storageLimit:TGWOnDeviceServiceConfiguration'
, tGWOnDeviceServiceConfiguration_storageLimit
- The maximum number of virtual tapes to store on one Snow Family device.
Due to physical resource limitations, this value must be set to 80 for
Snowball Edge.
$sel:storageUnit:TGWOnDeviceServiceConfiguration'
, tGWOnDeviceServiceConfiguration_storageUnit
- The scale unit of the virtual tapes on the device.
TargetOnDeviceService
data TargetOnDeviceService Source #
An object that represents 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).
See: newTargetOnDeviceService
smart constructor.
Instances
newTargetOnDeviceService :: TargetOnDeviceService Source #
Create a value of TargetOnDeviceService
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:
$sel:serviceName:TargetOnDeviceService'
, targetOnDeviceService_serviceName
- Specifies the name of the service on the Snow Family device that your
transferred data will be exported from or imported into.
$sel:transferOption:TargetOnDeviceService'
, targetOnDeviceService_transferOption
- Specifies whether the data is being imported or exported. You can import
or export the data, or use it locally on the device.
TaxDocuments
data TaxDocuments Source #
The tax documents required in your Amazon Web Services Region.
See: newTaxDocuments
smart constructor.
Instances
newTaxDocuments :: TaxDocuments Source #
Create a value of TaxDocuments
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:
$sel:ind:TaxDocuments'
, taxDocuments_ind
- Undocumented member.
WirelessConnection
data WirelessConnection Source #
Configures the wireless connection on an Snowcone device.
See: newWirelessConnection
smart constructor.
Instances
newWirelessConnection :: WirelessConnection Source #
Create a value of WirelessConnection
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:
$sel:isWifiEnabled:WirelessConnection'
, wirelessConnection_isWifiEnabled
- Enables the Wi-Fi adapter on an Snowcone device.