| 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 |
Amazonka.Snowball.Types
Contents
- Service Configuration
- Errors
- 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
Description
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
- 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' {
- addressId :: Maybe Text
- city :: Maybe Text
- company :: Maybe Text
- country :: Maybe Text
- isRestricted :: Maybe Bool
- landmark :: Maybe Text
- name :: Maybe Text
- phoneNumber :: Maybe Text
- postalCode :: Maybe Text
- prefectureOrDistrict :: Maybe Text
- stateOrProvince :: Maybe Text
- street1 :: Maybe Text
- street2 :: Maybe Text
- street3 :: Maybe Text
- newAddress :: Address
- address_addressId :: Lens' Address (Maybe Text)
- address_city :: Lens' Address (Maybe Text)
- address_company :: Lens' Address (Maybe Text)
- address_country :: Lens' Address (Maybe Text)
- address_isRestricted :: Lens' Address (Maybe Bool)
- address_landmark :: Lens' Address (Maybe Text)
- address_name :: Lens' Address (Maybe Text)
- address_phoneNumber :: Lens' Address (Maybe Text)
- address_postalCode :: Lens' Address (Maybe Text)
- address_prefectureOrDistrict :: Lens' Address (Maybe Text)
- address_stateOrProvince :: Lens' Address (Maybe Text)
- address_street1 :: Lens' Address (Maybe Text)
- address_street2 :: Lens' Address (Maybe Text)
- address_street3 :: Lens' Address (Maybe Text)
- data ClusterListEntry = ClusterListEntry' {}
- newClusterListEntry :: ClusterListEntry
- clusterListEntry_clusterId :: Lens' ClusterListEntry (Maybe Text)
- clusterListEntry_clusterState :: Lens' ClusterListEntry (Maybe ClusterState)
- clusterListEntry_creationDate :: Lens' ClusterListEntry (Maybe UTCTime)
- clusterListEntry_description :: Lens' ClusterListEntry (Maybe Text)
- data ClusterMetadata = ClusterMetadata' {
- addressId :: Maybe Text
- clusterId :: Maybe Text
- clusterState :: Maybe ClusterState
- creationDate :: Maybe POSIX
- description :: Maybe Text
- forwardingAddressId :: Maybe Text
- jobType :: Maybe JobType
- kmsKeyARN :: Maybe Text
- notification :: Maybe Notification
- onDeviceServiceConfiguration :: Maybe OnDeviceServiceConfiguration
- resources :: Maybe JobResource
- roleARN :: Maybe Text
- shippingOption :: Maybe ShippingOption
- snowballType :: Maybe SnowballType
- taxDocuments :: Maybe TaxDocuments
- newClusterMetadata :: ClusterMetadata
- clusterMetadata_addressId :: Lens' ClusterMetadata (Maybe Text)
- clusterMetadata_clusterId :: Lens' ClusterMetadata (Maybe Text)
- clusterMetadata_clusterState :: Lens' ClusterMetadata (Maybe ClusterState)
- clusterMetadata_creationDate :: Lens' ClusterMetadata (Maybe UTCTime)
- clusterMetadata_description :: Lens' ClusterMetadata (Maybe Text)
- clusterMetadata_forwardingAddressId :: Lens' ClusterMetadata (Maybe Text)
- clusterMetadata_jobType :: Lens' ClusterMetadata (Maybe JobType)
- clusterMetadata_kmsKeyARN :: Lens' ClusterMetadata (Maybe Text)
- clusterMetadata_notification :: Lens' ClusterMetadata (Maybe Notification)
- clusterMetadata_onDeviceServiceConfiguration :: Lens' ClusterMetadata (Maybe OnDeviceServiceConfiguration)
- clusterMetadata_resources :: Lens' ClusterMetadata (Maybe JobResource)
- clusterMetadata_roleARN :: Lens' ClusterMetadata (Maybe Text)
- clusterMetadata_shippingOption :: Lens' ClusterMetadata (Maybe ShippingOption)
- clusterMetadata_snowballType :: Lens' ClusterMetadata (Maybe SnowballType)
- clusterMetadata_taxDocuments :: Lens' ClusterMetadata (Maybe TaxDocuments)
- data CompatibleImage = CompatibleImage' {}
- newCompatibleImage :: CompatibleImage
- compatibleImage_amiId :: Lens' CompatibleImage (Maybe Text)
- compatibleImage_name :: Lens' CompatibleImage (Maybe Text)
- data DataTransfer = DataTransfer' {}
- newDataTransfer :: DataTransfer
- dataTransfer_bytesTransferred :: Lens' DataTransfer (Maybe Integer)
- dataTransfer_objectsTransferred :: Lens' DataTransfer (Maybe Integer)
- dataTransfer_totalBytes :: Lens' DataTransfer (Maybe Integer)
- dataTransfer_totalObjects :: Lens' DataTransfer (Maybe Integer)
- data DeviceConfiguration = DeviceConfiguration' {}
- newDeviceConfiguration :: DeviceConfiguration
- deviceConfiguration_snowconeDeviceConfiguration :: Lens' DeviceConfiguration (Maybe SnowconeDeviceConfiguration)
- data Ec2AmiResource = Ec2AmiResource' {
- snowballAmiId :: Maybe Text
- amiId :: Text
- newEc2AmiResource :: Text -> Ec2AmiResource
- ec2AmiResource_snowballAmiId :: Lens' Ec2AmiResource (Maybe Text)
- ec2AmiResource_amiId :: Lens' Ec2AmiResource Text
- data EventTriggerDefinition = EventTriggerDefinition' {}
- newEventTriggerDefinition :: EventTriggerDefinition
- eventTriggerDefinition_eventResourceARN :: Lens' EventTriggerDefinition (Maybe Text)
- data INDTaxDocuments = INDTaxDocuments' {}
- newINDTaxDocuments :: INDTaxDocuments
- iNDTaxDocuments_gstin :: Lens' INDTaxDocuments (Maybe Text)
- data JobListEntry = JobListEntry' {}
- newJobListEntry :: JobListEntry
- jobListEntry_creationDate :: Lens' JobListEntry (Maybe UTCTime)
- jobListEntry_description :: Lens' JobListEntry (Maybe Text)
- jobListEntry_isMaster :: Lens' JobListEntry (Maybe Bool)
- jobListEntry_jobId :: Lens' JobListEntry (Maybe Text)
- jobListEntry_jobState :: Lens' JobListEntry (Maybe JobState)
- jobListEntry_jobType :: Lens' JobListEntry (Maybe JobType)
- jobListEntry_snowballType :: Lens' JobListEntry (Maybe SnowballType)
- data JobLogs = JobLogs' {}
- newJobLogs :: JobLogs
- jobLogs_jobCompletionReportURI :: Lens' JobLogs (Maybe Text)
- jobLogs_jobFailureLogURI :: Lens' JobLogs (Maybe Text)
- jobLogs_jobSuccessLogURI :: Lens' JobLogs (Maybe Text)
- data JobMetadata = JobMetadata' {
- addressId :: Maybe Text
- clusterId :: Maybe Text
- creationDate :: Maybe POSIX
- dataTransferProgress :: Maybe DataTransfer
- description :: Maybe Text
- deviceConfiguration :: Maybe DeviceConfiguration
- forwardingAddressId :: Maybe Text
- jobId :: Maybe Text
- jobLogInfo :: Maybe JobLogs
- jobState :: Maybe JobState
- jobType :: Maybe JobType
- kmsKeyARN :: Maybe Text
- longTermPricingId :: Maybe Text
- notification :: Maybe Notification
- onDeviceServiceConfiguration :: Maybe OnDeviceServiceConfiguration
- remoteManagement :: Maybe RemoteManagement
- resources :: Maybe JobResource
- roleARN :: Maybe Text
- shippingDetails :: Maybe ShippingDetails
- snowballCapacityPreference :: Maybe SnowballCapacity
- snowballType :: Maybe SnowballType
- taxDocuments :: Maybe TaxDocuments
- newJobMetadata :: JobMetadata
- jobMetadata_addressId :: Lens' JobMetadata (Maybe Text)
- jobMetadata_clusterId :: Lens' JobMetadata (Maybe Text)
- jobMetadata_creationDate :: Lens' JobMetadata (Maybe UTCTime)
- jobMetadata_dataTransferProgress :: Lens' JobMetadata (Maybe DataTransfer)
- jobMetadata_description :: Lens' JobMetadata (Maybe Text)
- jobMetadata_deviceConfiguration :: Lens' JobMetadata (Maybe DeviceConfiguration)
- jobMetadata_forwardingAddressId :: Lens' JobMetadata (Maybe Text)
- jobMetadata_jobId :: Lens' JobMetadata (Maybe Text)
- jobMetadata_jobLogInfo :: Lens' JobMetadata (Maybe JobLogs)
- jobMetadata_jobState :: Lens' JobMetadata (Maybe JobState)
- jobMetadata_jobType :: Lens' JobMetadata (Maybe JobType)
- jobMetadata_kmsKeyARN :: Lens' JobMetadata (Maybe Text)
- jobMetadata_longTermPricingId :: Lens' JobMetadata (Maybe Text)
- jobMetadata_notification :: Lens' JobMetadata (Maybe Notification)
- jobMetadata_onDeviceServiceConfiguration :: Lens' JobMetadata (Maybe OnDeviceServiceConfiguration)
- jobMetadata_remoteManagement :: Lens' JobMetadata (Maybe RemoteManagement)
- jobMetadata_resources :: Lens' JobMetadata (Maybe JobResource)
- jobMetadata_roleARN :: Lens' JobMetadata (Maybe Text)
- jobMetadata_shippingDetails :: Lens' JobMetadata (Maybe ShippingDetails)
- jobMetadata_snowballCapacityPreference :: Lens' JobMetadata (Maybe SnowballCapacity)
- jobMetadata_snowballType :: Lens' JobMetadata (Maybe SnowballType)
- jobMetadata_taxDocuments :: Lens' JobMetadata (Maybe TaxDocuments)
- data JobResource = JobResource' {}
- newJobResource :: JobResource
- jobResource_ec2AmiResources :: Lens' JobResource (Maybe [Ec2AmiResource])
- jobResource_lambdaResources :: Lens' JobResource (Maybe [LambdaResource])
- jobResource_s3Resources :: Lens' JobResource (Maybe [S3Resource])
- data KeyRange = KeyRange' {}
- newKeyRange :: KeyRange
- keyRange_beginMarker :: Lens' KeyRange (Maybe Text)
- keyRange_endMarker :: Lens' KeyRange (Maybe Text)
- data LambdaResource = LambdaResource' {}
- newLambdaResource :: LambdaResource
- lambdaResource_eventTriggers :: Lens' LambdaResource (Maybe [EventTriggerDefinition])
- lambdaResource_lambdaArn :: Lens' LambdaResource (Maybe Text)
- data LongTermPricingListEntry = LongTermPricingListEntry' {
- currentActiveJob :: Maybe Text
- isLongTermPricingAutoRenew :: Maybe Bool
- jobIds :: Maybe [Text]
- longTermPricingEndDate :: Maybe POSIX
- longTermPricingId :: Maybe Text
- longTermPricingStartDate :: Maybe POSIX
- longTermPricingStatus :: Maybe Text
- longTermPricingType :: Maybe LongTermPricingType
- replacementJob :: Maybe Text
- snowballType :: Maybe SnowballType
- newLongTermPricingListEntry :: LongTermPricingListEntry
- longTermPricingListEntry_currentActiveJob :: Lens' LongTermPricingListEntry (Maybe Text)
- longTermPricingListEntry_isLongTermPricingAutoRenew :: Lens' LongTermPricingListEntry (Maybe Bool)
- longTermPricingListEntry_jobIds :: Lens' LongTermPricingListEntry (Maybe [Text])
- longTermPricingListEntry_longTermPricingEndDate :: Lens' LongTermPricingListEntry (Maybe UTCTime)
- longTermPricingListEntry_longTermPricingId :: Lens' LongTermPricingListEntry (Maybe Text)
- longTermPricingListEntry_longTermPricingStartDate :: Lens' LongTermPricingListEntry (Maybe UTCTime)
- longTermPricingListEntry_longTermPricingStatus :: Lens' LongTermPricingListEntry (Maybe Text)
- longTermPricingListEntry_longTermPricingType :: Lens' LongTermPricingListEntry (Maybe LongTermPricingType)
- longTermPricingListEntry_replacementJob :: Lens' LongTermPricingListEntry (Maybe Text)
- longTermPricingListEntry_snowballType :: Lens' LongTermPricingListEntry (Maybe SnowballType)
- data NFSOnDeviceServiceConfiguration = NFSOnDeviceServiceConfiguration' {}
- newNFSOnDeviceServiceConfiguration :: NFSOnDeviceServiceConfiguration
- nFSOnDeviceServiceConfiguration_storageLimit :: Lens' NFSOnDeviceServiceConfiguration (Maybe Natural)
- nFSOnDeviceServiceConfiguration_storageUnit :: Lens' NFSOnDeviceServiceConfiguration (Maybe StorageUnit)
- data Notification = Notification' {
- jobStatesToNotify :: Maybe [JobState]
- notifyAll :: Maybe Bool
- snsTopicARN :: Maybe Text
- newNotification :: Notification
- notification_jobStatesToNotify :: Lens' Notification (Maybe [JobState])
- notification_notifyAll :: Lens' Notification (Maybe Bool)
- notification_snsTopicARN :: Lens' Notification (Maybe Text)
- data OnDeviceServiceConfiguration = OnDeviceServiceConfiguration' {}
- newOnDeviceServiceConfiguration :: OnDeviceServiceConfiguration
- onDeviceServiceConfiguration_nFSOnDeviceService :: Lens' OnDeviceServiceConfiguration (Maybe NFSOnDeviceServiceConfiguration)
- onDeviceServiceConfiguration_tGWOnDeviceService :: Lens' OnDeviceServiceConfiguration (Maybe TGWOnDeviceServiceConfiguration)
- data S3Resource = S3Resource' {}
- newS3Resource :: S3Resource
- s3Resource_bucketArn :: Lens' S3Resource (Maybe Text)
- s3Resource_keyRange :: Lens' S3Resource (Maybe KeyRange)
- s3Resource_targetOnDeviceServices :: Lens' S3Resource (Maybe [TargetOnDeviceService])
- data Shipment = Shipment' {}
- newShipment :: Shipment
- shipment_status :: Lens' Shipment (Maybe Text)
- shipment_trackingNumber :: Lens' Shipment (Maybe Text)
- data ShippingDetails = ShippingDetails' {}
- newShippingDetails :: ShippingDetails
- shippingDetails_inboundShipment :: Lens' ShippingDetails (Maybe Shipment)
- shippingDetails_outboundShipment :: Lens' ShippingDetails (Maybe Shipment)
- shippingDetails_shippingOption :: Lens' ShippingDetails (Maybe ShippingOption)
- data SnowconeDeviceConfiguration = SnowconeDeviceConfiguration' {}
- newSnowconeDeviceConfiguration :: SnowconeDeviceConfiguration
- snowconeDeviceConfiguration_wirelessConnection :: Lens' SnowconeDeviceConfiguration (Maybe WirelessConnection)
- data TGWOnDeviceServiceConfiguration = TGWOnDeviceServiceConfiguration' {}
- newTGWOnDeviceServiceConfiguration :: TGWOnDeviceServiceConfiguration
- tGWOnDeviceServiceConfiguration_storageLimit :: Lens' TGWOnDeviceServiceConfiguration (Maybe Natural)
- tGWOnDeviceServiceConfiguration_storageUnit :: Lens' TGWOnDeviceServiceConfiguration (Maybe StorageUnit)
- data TargetOnDeviceService = TargetOnDeviceService' {}
- newTargetOnDeviceService :: TargetOnDeviceService
- targetOnDeviceService_serviceName :: Lens' TargetOnDeviceService (Maybe DeviceServiceName)
- targetOnDeviceService_transferOption :: Lens' TargetOnDeviceService (Maybe TransferOption)
- data TaxDocuments = TaxDocuments' {}
- newTaxDocuments :: TaxDocuments
- taxDocuments_ind :: Lens' TaxDocuments (Maybe INDTaxDocuments)
- data WirelessConnection = WirelessConnection' {}
- newWirelessConnection :: WirelessConnection
- wirelessConnection_isWifiEnabled :: Lens' WirelessConnection (Maybe Bool)
Service Configuration
defaultService :: Service Source #
API version 2016-06-30 of the Amazon Import/Export Snowball SDK configuration.
Errors
_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 :: AsError a => Fold a ServiceError Source #
You get this exception when you call CreateReturnShippingLabel more
than once when other requests are not completed.
_Ec2RequestFailedException :: AsError a => Fold a ServiceError Source #
Your IAM user lacks the necessary Amazon EC2 permissions to perform the attempted action.
_InvalidAddressException :: AsError a => Fold a ServiceError Source #
The address provided was invalid. Check the address with your region's carrier, and try again.
_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 :: 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 :: 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 :: 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 :: AsError a => Fold a ServiceError Source #
The provided Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
_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 :: 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.
ClusterState
newtype ClusterState Source #
Constructors
| ClusterState' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| DeviceServiceName' | |
Fields | |
Bundled Patterns
| pattern DeviceServiceName_NFS_ON_DEVICE_SERVICE :: DeviceServiceName | |
| pattern DeviceServiceName_S3_ON_DEVICE_SERVICE :: DeviceServiceName |
Instances
JobState
Constructors
| JobState' | |
Fields
| |
Bundled Patterns
| 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
Constructors
| JobType' | |
Fields
| |
Bundled Patterns
| pattern JobType_EXPORT :: JobType | |
| pattern JobType_IMPORT :: JobType | |
| pattern JobType_LOCAL_USE :: JobType |
Instances
LongTermPricingType
newtype LongTermPricingType Source #
Constructors
| LongTermPricingType' | |
Fields | |
Bundled Patterns
| pattern LongTermPricingType_OneYear :: LongTermPricingType | |
| pattern LongTermPricingType_ThreeYear :: LongTermPricingType |
Instances
RemoteManagement
newtype RemoteManagement Source #
Constructors
| RemoteManagement' | |
Fields | |
Bundled Patterns
| pattern RemoteManagement_INSTALLED_AUTOSTART :: RemoteManagement | |
| pattern RemoteManagement_INSTALLED_ONLY :: RemoteManagement |
Instances
ShipmentState
newtype ShipmentState Source #
Constructors
| ShipmentState' | |
Fields | |
Bundled Patterns
| pattern ShipmentState_RECEIVED :: ShipmentState | |
| pattern ShipmentState_RETURNED :: ShipmentState |
Instances
ShippingLabelStatus
newtype ShippingLabelStatus Source #
Constructors
| ShippingLabelStatus' | |
Fields | |
Bundled Patterns
| pattern ShippingLabelStatus_Failed :: ShippingLabelStatus | |
| pattern ShippingLabelStatus_InProgress :: ShippingLabelStatus | |
| pattern ShippingLabelStatus_Succeeded :: ShippingLabelStatus | |
| pattern ShippingLabelStatus_TimedOut :: ShippingLabelStatus |
Instances
ShippingOption
newtype ShippingOption Source #
Constructors
| ShippingOption' | |
Fields | |
Bundled Patterns
| pattern ShippingOption_EXPRESS :: ShippingOption | |
| pattern ShippingOption_NEXT_DAY :: ShippingOption | |
| pattern ShippingOption_SECOND_DAY :: ShippingOption | |
| pattern ShippingOption_STANDARD :: ShippingOption |
Instances
SnowballCapacity
newtype SnowballCapacity Source #
Constructors
| SnowballCapacity' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| SnowballType' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| StorageUnit' | |
Fields | |
Bundled Patterns
| pattern StorageUnit_TB :: StorageUnit |
Instances
TransferOption
newtype TransferOption Source #
Constructors
| TransferOption' | |
Fields | |
Bundled Patterns
| 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.
Constructors
| Address' | |
Fields
| |
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.
address_city :: Lens' Address (Maybe Text) Source #
The city in an address that a Snow device is to be delivered to.
address_company :: Lens' Address (Maybe Text) Source #
The name of the company to receive a Snow device at an address.
address_country :: Lens' Address (Maybe Text) Source #
The country in an address that a Snow device is to be delivered to.
address_isRestricted :: Lens' Address (Maybe Bool) Source #
If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.
address_landmark :: Lens' Address (Maybe Text) Source #
This field is no longer used and the value is ignored.
address_name :: Lens' Address (Maybe Text) Source #
The name of a person to receive a Snow device at an address.
address_phoneNumber :: Lens' Address (Maybe Text) Source #
The phone number associated with an address that a Snow device is to be delivered to.
address_postalCode :: Lens' Address (Maybe Text) Source #
The postal code in an address that a Snow device is to be delivered to.
address_prefectureOrDistrict :: Lens' Address (Maybe Text) Source #
This field is no longer used and the value is ignored.
address_stateOrProvince :: Lens' Address (Maybe Text) Source #
The state or province in an address that a Snow device is to be delivered to.
address_street1 :: Lens' Address (Maybe Text) Source #
The first line in a street address that a Snow device is to be delivered to.
address_street2 :: Lens' Address (Maybe Text) Source #
The second line in a street address that a Snow device is to be delivered to.
address_street3 :: Lens' Address (Maybe Text) Source #
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.
Constructors
| ClusterListEntry' | |
Fields
| |
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.
clusterListEntry_clusterId :: Lens' ClusterListEntry (Maybe Text) Source #
The 39-character ID for the cluster that you want to list, for example
CID123e4567-e89b-12d3-a456-426655440000.
clusterListEntry_clusterState :: Lens' ClusterListEntry (Maybe ClusterState) Source #
The current state of this cluster. For information about the state of a specific node, see JobListEntry$JobState.
clusterListEntry_creationDate :: Lens' ClusterListEntry (Maybe UTCTime) Source #
The creation date for this cluster.
clusterListEntry_description :: Lens' ClusterListEntry (Maybe Text) Source #
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.
Constructors
| ClusterMetadata' | |
Fields
| |
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.
clusterMetadata_addressId :: Lens' ClusterMetadata (Maybe Text) Source #
The automatically generated ID for a specific address.
clusterMetadata_clusterId :: Lens' ClusterMetadata (Maybe Text) Source #
The automatically generated ID for a cluster.
clusterMetadata_clusterState :: Lens' ClusterMetadata (Maybe ClusterState) Source #
The current status of the cluster.
clusterMetadata_creationDate :: Lens' ClusterMetadata (Maybe UTCTime) Source #
The creation date for this cluster.
clusterMetadata_description :: Lens' ClusterMetadata (Maybe Text) Source #
The optional description of the cluster.
clusterMetadata_forwardingAddressId :: Lens' ClusterMetadata (Maybe Text) Source #
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.
clusterMetadata_jobType :: Lens' ClusterMetadata (Maybe JobType) Source #
The type of job for this cluster. Currently, the only job type supported
for clusters is LOCAL_USE.
clusterMetadata_kmsKeyARN :: Lens' ClusterMetadata (Maybe Text) Source #
The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster.
This ARN was created using the
CreateKey
API action in Key Management Service (KMS.
clusterMetadata_notification :: Lens' ClusterMetadata (Maybe Notification) Source #
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
clusterMetadata_onDeviceServiceConfiguration :: Lens' ClusterMetadata (Maybe OnDeviceServiceConfiguration) Source #
Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
clusterMetadata_resources :: Lens' ClusterMetadata (Maybe JobResource) Source #
The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
clusterMetadata_roleARN :: Lens' ClusterMetadata (Maybe Text) Source #
The role ARN associated with this cluster. This ARN was created using the CreateRole API action in Identity and Access Management (IAM).
clusterMetadata_shippingOption :: Lens' ClusterMetadata (Maybe ShippingOption) Source #
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.
clusterMetadata_snowballType :: Lens' ClusterMetadata (Maybe SnowballType) Source #
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.
clusterMetadata_taxDocuments :: Lens' ClusterMetadata (Maybe TaxDocuments) Source #
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.
Constructors
| CompatibleImage' | |
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.
compatibleImage_amiId :: Lens' CompatibleImage (Maybe Text) Source #
The unique identifier for an individual Snow device AMI.
compatibleImage_name :: Lens' CompatibleImage (Maybe Text) Source #
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.
Constructors
| DataTransfer' | |
Fields
| |
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.
dataTransfer_bytesTransferred :: Lens' DataTransfer (Maybe Integer) Source #
The number of bytes transferred between a Snow device and Amazon S3.
dataTransfer_objectsTransferred :: Lens' DataTransfer (Maybe Integer) Source #
The number of objects transferred between a Snow device and Amazon S3.
dataTransfer_totalBytes :: Lens' DataTransfer (Maybe Integer) Source #
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.
dataTransfer_totalObjects :: Lens' DataTransfer (Maybe Integer) Source #
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.
Constructors
| DeviceConfiguration' | |
Fields
| |
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.
deviceConfiguration_snowconeDeviceConfiguration :: Lens' DeviceConfiguration (Maybe SnowconeDeviceConfiguration) Source #
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.
Constructors
| Ec2AmiResource' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Ec2AmiResource |
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.
ec2AmiResource_snowballAmiId :: Lens' Ec2AmiResource (Maybe Text) Source #
The ID of the AMI on the Snow device.
ec2AmiResource_amiId :: Lens' Ec2AmiResource Text Source #
The ID of the AMI in Amazon EC2.
EventTriggerDefinition
data EventTriggerDefinition Source #
The container for the EventTriggerDefinition$EventResourceARN.
See: newEventTriggerDefinition smart constructor.
Constructors
| EventTriggerDefinition' | |
Fields
| |
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.
eventTriggerDefinition_eventResourceARN :: Lens' EventTriggerDefinition (Maybe Text) Source #
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.
Constructors
| INDTaxDocuments' | |
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.
iNDTaxDocuments_gstin :: Lens' INDTaxDocuments (Maybe Text) Source #
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.
Constructors
| JobListEntry' | |
Fields
| |
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.
jobListEntry_creationDate :: Lens' JobListEntry (Maybe UTCTime) Source #
The creation date for this job.
jobListEntry_description :: Lens' JobListEntry (Maybe Text) Source #
The optional description of this specific job, for example
Important Photos 2016-08-11.
jobListEntry_isMaster :: Lens' JobListEntry (Maybe Bool) Source #
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.
jobListEntry_jobId :: Lens' JobListEntry (Maybe Text) Source #
The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000.
jobListEntry_jobState :: Lens' JobListEntry (Maybe JobState) Source #
The current state of this job.
jobListEntry_jobType :: Lens' JobListEntry (Maybe JobType) Source #
The type of job.
jobListEntry_snowballType :: Lens' JobListEntry (Maybe SnowballType) Source #
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.
Constructors
| JobLogs' | |
Fields
| |
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.
jobLogs_jobCompletionReportURI :: Lens' JobLogs (Maybe Text) Source #
A link to an Amazon S3 presigned URL where the job completion report is located.
jobLogs_jobFailureLogURI :: Lens' JobLogs (Maybe Text) Source #
A link to an Amazon S3 presigned URL where the job failure log is located.
jobLogs_jobSuccessLogURI :: Lens' JobLogs (Maybe Text) Source #
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.
Constructors
| JobMetadata' | |
Fields
| |
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.
jobMetadata_addressId :: Lens' JobMetadata (Maybe Text) Source #
The ID for the address that you want the Snow device shipped to.
jobMetadata_clusterId :: Lens' JobMetadata (Maybe Text) Source #
The 39-character ID for the cluster, for example
CID123e4567-e89b-12d3-a456-426655440000.
jobMetadata_creationDate :: Lens' JobMetadata (Maybe UTCTime) Source #
The creation date for this job.
jobMetadata_dataTransferProgress :: Lens' JobMetadata (Maybe DataTransfer) Source #
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.
jobMetadata_description :: Lens' JobMetadata (Maybe Text) Source #
The description of the job, provided at job creation.
jobMetadata_deviceConfiguration :: Lens' JobMetadata (Maybe DeviceConfiguration) Source #
Undocumented member.
jobMetadata_forwardingAddressId :: Lens' JobMetadata (Maybe Text) Source #
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.
jobMetadata_jobId :: Lens' JobMetadata (Maybe Text) Source #
The automatically generated ID for a job, for example
JID123e4567-e89b-12d3-a456-426655440000.
jobMetadata_jobLogInfo :: Lens' JobMetadata (Maybe JobLogs) Source #
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.
jobMetadata_jobState :: Lens' JobMetadata (Maybe JobState) Source #
The current status of the jobs.
jobMetadata_jobType :: Lens' JobMetadata (Maybe JobType) Source #
The type of job.
jobMetadata_kmsKeyARN :: Lens' JobMetadata (Maybe Text) Source #
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.
jobMetadata_longTermPricingId :: Lens' JobMetadata (Maybe Text) Source #
The ID of the long-term pricing type for the device.
jobMetadata_notification :: Lens' JobMetadata (Maybe 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.
jobMetadata_onDeviceServiceConfiguration :: Lens' JobMetadata (Maybe OnDeviceServiceConfiguration) Source #
Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.
jobMetadata_remoteManagement :: Lens' JobMetadata (Maybe RemoteManagement) Source #
Allows you to securely operate and manage Snowcone devices remotely from
outside of your internal network. When set to INSTALLED_AUTOSTART,
remote management will automatically be available when the device
arrives at your location. Otherwise, you need to use the Snowball Client
to manage the device.
jobMetadata_resources :: Lens' JobMetadata (Maybe JobResource) Source #
An array of S3Resource objects. Each S3Resource object represents an
Amazon S3 bucket that your transferred data will be exported from or
imported into.
jobMetadata_roleARN :: Lens' JobMetadata (Maybe Text) Source #
The role ARN associated with this job. This ARN was created using the CreateRole API action in Identity and Access Management.
jobMetadata_shippingDetails :: Lens' JobMetadata (Maybe ShippingDetails) Source #
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
jobMetadata_snowballCapacityPreference :: Lens' JobMetadata (Maybe SnowballCapacity) Source #
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.
jobMetadata_snowballType :: Lens' JobMetadata (Maybe SnowballType) Source #
The type of device used with this job.
jobMetadata_taxDocuments :: Lens' JobMetadata (Maybe TaxDocuments) Source #
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.
Constructors
| JobResource' | |
Fields
| |
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.
jobResource_ec2AmiResources :: Lens' JobResource (Maybe [Ec2AmiResource]) Source #
The Amazon Machine Images (AMIs) associated with this job.
jobResource_lambdaResources :: Lens' JobResource (Maybe [LambdaResource]) Source #
The Python-language Lambda functions for this job.
jobResource_s3Resources :: Lens' JobResource (Maybe [S3Resource]) Source #
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.
Constructors
| KeyRange' | |
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.
keyRange_beginMarker :: Lens' KeyRange (Maybe Text) Source #
The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
keyRange_endMarker :: Lens' KeyRange (Maybe Text) Source #
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.
Constructors
| LambdaResource' | |
Fields
| |
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.
lambdaResource_eventTriggers :: Lens' LambdaResource (Maybe [EventTriggerDefinition]) Source #
The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.
lambdaResource_lambdaArn :: Lens' LambdaResource (Maybe Text) Source #
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.
Constructors
| LongTermPricingListEntry' | |
Fields
| |
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.
longTermPricingListEntry_currentActiveJob :: Lens' LongTermPricingListEntry (Maybe Text) Source #
The current active jobs on the device the long-term pricing type.
longTermPricingListEntry_isLongTermPricingAutoRenew :: Lens' LongTermPricingListEntry (Maybe Bool) Source #
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.
longTermPricingListEntry_jobIds :: Lens' LongTermPricingListEntry (Maybe [Text]) Source #
The IDs of the jobs that are associated with a long-term pricing type.
longTermPricingListEntry_longTermPricingEndDate :: Lens' LongTermPricingListEntry (Maybe UTCTime) Source #
The end date the long-term pricing contract.
longTermPricingListEntry_longTermPricingId :: Lens' LongTermPricingListEntry (Maybe Text) Source #
The ID of the long-term pricing type for the device.
longTermPricingListEntry_longTermPricingStartDate :: Lens' LongTermPricingListEntry (Maybe UTCTime) Source #
The start date of the long-term pricing contract.
longTermPricingListEntry_longTermPricingStatus :: Lens' LongTermPricingListEntry (Maybe Text) Source #
The status of the long-term pricing type.
longTermPricingListEntry_longTermPricingType :: Lens' LongTermPricingListEntry (Maybe LongTermPricingType) Source #
The type of long-term pricing that was selected for the device.
longTermPricingListEntry_replacementJob :: Lens' LongTermPricingListEntry (Maybe Text) Source #
A new device that replaces a device that is ordered with long-term pricing.
longTermPricingListEntry_snowballType :: Lens' LongTermPricingListEntry (Maybe SnowballType) Source #
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.
Constructors
| NFSOnDeviceServiceConfiguration' | |
Fields
| |
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.
nFSOnDeviceServiceConfiguration_storageLimit :: Lens' NFSOnDeviceServiceConfiguration (Maybe Natural) Source #
The maximum NFS storage for one Snow Family device.
nFSOnDeviceServiceConfiguration_storageUnit :: Lens' NFSOnDeviceServiceConfiguration (Maybe StorageUnit) Source #
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.
Constructors
| Notification' | |
Fields
| |
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.
notification_jobStatesToNotify :: Lens' Notification (Maybe [JobState]) Source #
The list of job states that will trigger a notification for this job.
notification_notifyAll :: Lens' Notification (Maybe Bool) Source #
Any change in job state will trigger a notification for this job.
notification_snsTopicARN :: Lens' Notification (Maybe Text) Source #
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.
Constructors
| OnDeviceServiceConfiguration' | |
Fields
| |
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.
onDeviceServiceConfiguration_nFSOnDeviceService :: Lens' OnDeviceServiceConfiguration (Maybe NFSOnDeviceServiceConfiguration) Source #
Represents the NFS (Network File System) service on a Snow Family device.
onDeviceServiceConfiguration_tGWOnDeviceService :: Lens' OnDeviceServiceConfiguration (Maybe TGWOnDeviceServiceConfiguration) Source #
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.
Constructors
| S3Resource' | |
Fields
| |
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).
s3Resource_bucketArn :: Lens' S3Resource (Maybe Text) Source #
The Amazon Resource Name (ARN) of an Amazon S3 bucket.
s3Resource_keyRange :: Lens' S3Resource (Maybe KeyRange) Source #
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.
s3Resource_targetOnDeviceServices :: Lens' S3Resource (Maybe [TargetOnDeviceService]) Source #
Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System).
Shipment
The Status and TrackingNumber information for an inbound or outbound
shipment.
See: newShipment smart constructor.
Constructors
| Shipment' | |
Fields
| |
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.
shipment_trackingNumber :: Lens' Shipment (Maybe Text) Source #
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.
Constructors
| ShippingDetails' | |
Fields
| |
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.
shippingDetails_inboundShipment :: Lens' ShippingDetails (Maybe Shipment) Source #
The Status and TrackingNumber values for a Snow device being
returned to Amazon Web Services for a particular job.
shippingDetails_outboundShipment :: Lens' ShippingDetails (Maybe Shipment) Source #
The Status and TrackingNumber values for a Snow device being
delivered to the address that you specified for a particular job.
shippingDetails_shippingOption :: Lens' ShippingDetails (Maybe ShippingOption) Source #
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.
Constructors
| SnowconeDeviceConfiguration' | |
Fields
| |
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.
snowconeDeviceConfiguration_wirelessConnection :: Lens' SnowconeDeviceConfiguration (Maybe WirelessConnection) Source #
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.
Constructors
| TGWOnDeviceServiceConfiguration' | |
Fields
| |
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.
tGWOnDeviceServiceConfiguration_storageLimit :: Lens' TGWOnDeviceServiceConfiguration (Maybe Natural) Source #
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.
tGWOnDeviceServiceConfiguration_storageUnit :: Lens' TGWOnDeviceServiceConfiguration (Maybe StorageUnit) Source #
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.
Constructors
| TargetOnDeviceService' | |
Fields
| |
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.
targetOnDeviceService_serviceName :: Lens' TargetOnDeviceService (Maybe DeviceServiceName) Source #
Specifies the name of the service on the Snow Family device that your transferred data will be exported from or imported into.
targetOnDeviceService_transferOption :: Lens' TargetOnDeviceService (Maybe TransferOption) Source #
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.
Constructors
| TaxDocuments' | |
Fields | |
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.
taxDocuments_ind :: Lens' TaxDocuments (Maybe INDTaxDocuments) Source #
Undocumented member.
WirelessConnection
data WirelessConnection Source #
Configures the wireless connection on an Snowcone device.
See: newWirelessConnection smart constructor.
Constructors
| WirelessConnection' | |
Fields
| |
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.
wirelessConnection_isWifiEnabled :: Lens' WirelessConnection (Maybe Bool) Source #
Enables the Wi-Fi adapter on an Snowcone device.