Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- snowball :: Service
- _InvalidResourceException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnsupportedAddressException :: AsError a => Getting (First ServiceError) a ServiceError
- _KMSRequestFailedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidJobStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidAddressException :: AsError a => Getting (First ServiceError) a ServiceError
- data JobState
- data JobType
- data ShippingOption
- data SnowballCapacity
- = NoPreference
- | T50
- | T80
- data Address
- address :: Address
- aStreet3 :: Lens' Address (Maybe Text)
- aLandmark :: Lens' Address (Maybe Text)
- aPostalCode :: Lens' Address (Maybe Text)
- aCountry :: Lens' Address (Maybe Text)
- aStateOrProvince :: Lens' Address (Maybe Text)
- aStreet2 :: Lens' Address (Maybe Text)
- aAddressId :: Lens' Address (Maybe Text)
- aCity :: Lens' Address (Maybe Text)
- aPhoneNumber :: Lens' Address (Maybe Text)
- aCompany :: Lens' Address (Maybe Text)
- aName :: Lens' Address (Maybe Text)
- aPrefectureOrDistrict :: Lens' Address (Maybe Text)
- aStreet1 :: Lens' Address (Maybe Text)
- data DataTransfer
- dataTransfer :: DataTransfer
- dtTotalObjects :: Lens' DataTransfer (Maybe Integer)
- dtTotalBytes :: Lens' DataTransfer (Maybe Integer)
- dtObjectsTransferred :: Lens' DataTransfer (Maybe Integer)
- dtBytesTransferred :: Lens' DataTransfer (Maybe Integer)
- data JobListEntry
- jobListEntry :: JobListEntry
- jleJobId :: Lens' JobListEntry (Maybe Text)
- jleJobState :: Lens' JobListEntry (Maybe JobState)
- jleIsMaster :: Lens' JobListEntry (Maybe Bool)
- data JobLogs
- jobLogs :: JobLogs
- jlJobFailureLogURI :: Lens' JobLogs (Maybe Text)
- jlJobCompletionReportURI :: Lens' JobLogs (Maybe Text)
- jlJobSuccessLogURI :: Lens' JobLogs (Maybe Text)
- data JobMetadata
- jobMetadata :: JobMetadata
- jmJobType :: Lens' JobMetadata (Maybe JobType)
- jmKMSKeyARN :: Lens' JobMetadata (Maybe Text)
- jmJobId :: Lens' JobMetadata (Maybe Text)
- jmJobLogInfo :: Lens' JobMetadata (Maybe JobLogs)
- jmNotification :: Lens' JobMetadata (Maybe Notification)
- jmJobState :: Lens' JobMetadata (Maybe JobState)
- jmShippingDetails :: Lens' JobMetadata (Maybe ShippingDetails)
- jmAddressId :: Lens' JobMetadata (Maybe Text)
- jmDataTransferProgress :: Lens' JobMetadata (Maybe DataTransfer)
- jmResources :: Lens' JobMetadata (Maybe JobResource)
- jmCreationDate :: Lens' JobMetadata (Maybe UTCTime)
- jmDescription :: Lens' JobMetadata (Maybe Text)
- jmRoleARN :: Lens' JobMetadata (Maybe Text)
- jmSnowballCapacityPreference :: Lens' JobMetadata (Maybe SnowballCapacity)
- data JobResource
- jobResource :: JobResource
- jrS3Resources :: Lens' JobResource [S3Resource]
- data KeyRange
- keyRange :: KeyRange
- krEndMarker :: Lens' KeyRange (Maybe Text)
- krBeginMarker :: Lens' KeyRange (Maybe Text)
- data Notification
- notification :: Notification
- nNotifyAll :: Lens' Notification (Maybe Bool)
- nSNSTopicARN :: Lens' Notification (Maybe Text)
- nJobStatesToNotify :: Lens' Notification [JobState]
- data S3Resource
- s3Resource :: S3Resource
- srKeyRange :: Lens' S3Resource (Maybe KeyRange)
- srBucketARN :: Lens' S3Resource (Maybe Text)
- data Shipment
- shipment :: Shipment
- sStatus :: Lens' Shipment (Maybe Text)
- sTrackingNumber :: Lens' Shipment (Maybe Text)
- data ShippingDetails
- shippingDetails :: ShippingDetails
- sdShippingOption :: Lens' ShippingDetails (Maybe ShippingOption)
- sdOutboundShipment :: Lens' ShippingDetails (Maybe Shipment)
- sdInboundShipment :: Lens' ShippingDetails (Maybe Shipment)
Service Configuration
API version '2016-06-30' of the Amazon Import/Export Snowball SDK configuration.
Errors
_InvalidResourceException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource can't be found. Check the information you provided in your last request, and try again.
_UnsupportedAddressException :: AsError a => Getting (First ServiceError) 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 AWS Support.
_KMSRequestFailedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
_InvalidJobStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The action can't be performed because the job's current state doesn't allow that action to be performed.
_InvalidAddressException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The address provided was invalid. Check the address with your region's carrier, and try again.
JobState
Cancelled | |
Complete | |
InProgress | |
InTransitToAWS | |
InTransitToCustomer | |
Listing | |
New | |
Pending | |
PreparingAppliance | |
PreparingShipment | |
WithAWS | |
WithCustomer |
JobType
ShippingOption
data ShippingOption Source #
SnowballCapacity
data SnowballCapacity Source #
Address
The address that you want the Snowball or Snowballs associated with a specific job to be shipped to. Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. Although no individual elements of the Address
are required, if the address is invalid or unsupported, then an exception is thrown.
See: address
smart constructor.
Creates a value of Address
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aStreet3 :: Lens' Address (Maybe Text) Source #
The third line in a street address that a Snowball is to be delivered to.
aLandmark :: Lens' Address (Maybe Text) Source #
A landmark listed in an address that a Snowball is to be delivered to.
aPostalCode :: Lens' Address (Maybe Text) Source #
The postal code in an address that a Snowball is to be delivered to.
aCountry :: Lens' Address (Maybe Text) Source #
The country in an address that a Snowball is to be delivered to.
aStateOrProvince :: Lens' Address (Maybe Text) Source #
The state or province in an address that a Snowball is to be delivered to.
aStreet2 :: Lens' Address (Maybe Text) Source #
The second line in a street address that a Snowball is to be delivered to.
aCity :: Lens' Address (Maybe Text) Source #
The city in an address that a Snowball is to be delivered to.
aPhoneNumber :: Lens' Address (Maybe Text) Source #
The phone number associated with an address that a Snowball is to be delivered to.
aCompany :: Lens' Address (Maybe Text) Source #
The name of the company to receive a Snowball at an address.
aName :: Lens' Address (Maybe Text) Source #
The name of a person to receive a Snowball at an address.
aPrefectureOrDistrict :: Lens' Address (Maybe Text) Source #
The prefecture or district in an address that a Snowball is to be delivered to.
aStreet1 :: Lens' Address (Maybe Text) Source #
The first line in a street address that a Snowball is to be delivered to.
DataTransfer
data DataTransfer Source #
Defines the real-time status of a Snowball's data transfer while the appliance is at AWS. Note that this data is only available while a job has a JobState
value of InProgress
, for both import and export jobs.
See: dataTransfer
smart constructor.
dataTransfer :: DataTransfer Source #
Creates a value of DataTransfer
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dtTotalObjects :: Lens' DataTransfer (Maybe Integer) Source #
The total number of objects for a transfer between a Snowball and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.
dtTotalBytes :: Lens' DataTransfer (Maybe Integer) Source #
The total bytes of data for a transfer between a Snowball and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.
dtObjectsTransferred :: Lens' DataTransfer (Maybe Integer) Source #
The number of objects transferred between a Snowball and Amazon S3.
dtBytesTransferred :: Lens' DataTransfer (Maybe Integer) Source #
The number of bytes transferred between a Snowball and Amazon S3.
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: jobListEntry
smart constructor.
jobListEntry :: JobListEntry Source #
Creates a value of JobListEntry
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jleJobId :: Lens' JobListEntry (Maybe Text) Source #
The automatically generated ID for a job, for example 'JID123e4567-e89b-12d3-a456-426655440000'.
jleJobState :: Lens' JobListEntry (Maybe JobState) Source #
The current state of this job.
jleIsMaster :: Lens' JobListEntry (Maybe Bool) Source #
A value that indicates that this job is a master job. A master job represents a successful request to create an export job. Master jobs aren't associated with any Snowballs. Instead, each master 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 master job are listed, because they are created after the master job is created.
JobLogs
Contains job logs. Whenever Snowball is used to import data into or export data out of Amazon S3, you'll have the option of downloading a PDF job report. Job logs are returned as a part of the response syntax of the DescribeJob
action in the JobMetadata
data type. The job logs can be accessed for up to 60 minutes after this request has been made. To access any of the job logs after 60 minutes have passed, you'll have to make another call to the DescribeJob
action.
For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snowball for your job part is being delivered to you.
The job report provides you insight into the state of your Amazon S3 data transfer. The report includes details about your job or job part for your records.
For deeper visibility into the status of your transferred objects, you can look at the two associated logs: a success log and a failure log. The logs are saved in comma-separated value (CSV) format, and the name of each log includes the ID of the job or job part that the log describes.
See: jobLogs
smart constructor.
Creates a value of JobLogs
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jlJobFailureLogURI :: Lens' JobLogs (Maybe Text) Source #
A link to an Amazon S3 presigned URL where the job failure log is located.
jlJobCompletionReportURI :: Lens' JobLogs (Maybe Text) Source #
A link to an Amazon S3 presigned URL where the job completion report is located.
jlJobSuccessLogURI :: 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: jobMetadata
smart constructor.
jobMetadata :: JobMetadata Source #
Creates a value of JobMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jmKMSKeyARN :: Lens' JobMetadata (Maybe Text) Source #
The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job. This ARN was created using the CreateKey
API action in AWS KMS.
jmJobId :: Lens' JobMetadata (Maybe Text) Source #
The automatically generated ID for a job, for example 'JID123e4567-e89b-12d3-a456-426655440000'.
jmJobLogInfo :: 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 Snowball for your job part is being delivered to you.
jmNotification :: 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.
jmJobState :: Lens' JobMetadata (Maybe JobState) Source #
The current state of the jobs.
jmShippingDetails :: Lens' JobMetadata (Maybe ShippingDetails) Source #
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
jmAddressId :: Lens' JobMetadata (Maybe Text) Source #
The ID for the address that you want the Snowball shipped to.
jmDataTransferProgress :: Lens' JobMetadata (Maybe DataTransfer) Source #
A value that defines the real-time status of a Snowball's data transfer while the appliance is at AWS. Note that this data is only available while a job has a JobState
value of InProgress
, for both import and export jobs.
jmResources :: 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.
jmCreationDate :: Lens' JobMetadata (Maybe UTCTime) Source #
The creation date for this job.
jmDescription :: Lens' JobMetadata (Maybe Text) Source #
The description of the job, provided at job creation.
jmRoleARN :: Lens' JobMetadata (Maybe Text) Source #
The role ARN associated with this job. This ARN was created using the CreateRole
API action in AWS Identity and Access Management (IAM).
jmSnowballCapacityPreference :: Lens' JobMetadata (Maybe SnowballCapacity) Source #
The Snowball 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.
JobResource
data JobResource Source #
Contains an array of S3Resource
objects. Each S3Resource
object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.
See: jobResource
smart constructor.
jobResource :: JobResource Source #
Creates a value of JobResource
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jrS3Resources :: Lens' JobResource [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: keyRange
smart constructor.
Creates a value of KeyRange
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
krEndMarker :: 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.
krBeginMarker :: 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.
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: notification
smart constructor.
notification :: Notification Source #
Creates a value of Notification
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nNotifyAll :: Lens' Notification (Maybe Bool) Source #
Any change in job state will trigger a notification for this job.
nSNSTopicARN :: 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.
Note that you can subscribe email addresses to an Amazon SNS topic through the AWS Management Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action.
nJobStatesToNotify :: Lens' Notification [JobState] Source #
The list of job states that will trigger a notification for this job.
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: s3Resource
smart constructor.
s3Resource :: S3Resource Source #
Creates a value of S3Resource
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srKeyRange :: 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.
srBucketARN :: Lens' S3Resource (Maybe Text) Source #
The Amazon Resource Name (ARN) of an Amazon S3 bucket.
Shipment
Creates a value of Shipment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sStatus :: Lens' Shipment (Maybe Text) Source #
Status information for a shipment. Valid statuses include NEW
, IN_TRANSIT
, and DELIVERED
.
sTrackingNumber :: 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 Snowball 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: shippingDetails
smart constructor.
shippingDetails :: ShippingDetails Source #
Creates a value of ShippingDetails
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdShippingOption :: Lens' ShippingDetails (Maybe ShippingOption) Source #
The shipping speed for a particular job. Note that this speed does not dictate how soon you'll get the Snowball 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, Snowballs shipped express are delivered in about a day.
- In the European Union (EU), you have access to express shipping. Typically, Snowballs 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, Snowballs 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.
sdOutboundShipment :: Lens' ShippingDetails (Maybe Shipment) Source #
The Status
and TrackingNumber
values for a Snowball being returned to AWS for a particular job.
sdInboundShipment :: Lens' ShippingDetails (Maybe Shipment) Source #
The Status
and TrackingNumber
values for a Snowball being delivered to the address that you specified for a particular job.