| Copyright | (c) 2013-2018 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.Snowball.Types
Contents
Description
Synopsis
- 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
- _InvalidInputCombinationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidAddressException :: AsError a => Getting (First ServiceError) a ServiceError
- _ClusterLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- data ClusterState
- data JobState
- data JobType
- data ShippingOption
- data SnowballCapacity
- = NoPreference
- | T100
- | T50
- | T80
- data SnowballType
- data Address
- address :: Address
- aIsRestricted :: Lens' Address (Maybe Bool)
- 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 ClusterListEntry
- clusterListEntry :: ClusterListEntry
- cleClusterState :: Lens' ClusterListEntry (Maybe ClusterState)
- cleClusterId :: Lens' ClusterListEntry (Maybe Text)
- cleCreationDate :: Lens' ClusterListEntry (Maybe UTCTime)
- cleDescription :: Lens' ClusterListEntry (Maybe Text)
- data ClusterMetadata
- clusterMetadata :: ClusterMetadata
- cmJobType :: Lens' ClusterMetadata (Maybe JobType)
- cmKMSKeyARN :: Lens' ClusterMetadata (Maybe Text)
- cmClusterState :: Lens' ClusterMetadata (Maybe ClusterState)
- cmNotification :: Lens' ClusterMetadata (Maybe Notification)
- cmForwardingAddressId :: Lens' ClusterMetadata (Maybe Text)
- cmAddressId :: Lens' ClusterMetadata (Maybe Text)
- cmSnowballType :: Lens' ClusterMetadata (Maybe SnowballType)
- cmShippingOption :: Lens' ClusterMetadata (Maybe ShippingOption)
- cmResources :: Lens' ClusterMetadata (Maybe JobResource)
- cmClusterId :: Lens' ClusterMetadata (Maybe Text)
- cmCreationDate :: Lens' ClusterMetadata (Maybe UTCTime)
- cmDescription :: Lens' ClusterMetadata (Maybe Text)
- cmRoleARN :: Lens' ClusterMetadata (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 EventTriggerDefinition
- eventTriggerDefinition :: EventTriggerDefinition
- etdEventResourceARN :: Lens' EventTriggerDefinition (Maybe Text)
- data JobListEntry
- jobListEntry :: JobListEntry
- jleJobType :: Lens' JobListEntry (Maybe JobType)
- jleJobId :: Lens' JobListEntry (Maybe Text)
- jleJobState :: Lens' JobListEntry (Maybe JobState)
- jleSnowballType :: Lens' JobListEntry (Maybe SnowballType)
- jleCreationDate :: Lens' JobListEntry (Maybe UTCTime)
- jleDescription :: Lens' JobListEntry (Maybe Text)
- 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)
- jmForwardingAddressId :: Lens' JobMetadata (Maybe Text)
- jmShippingDetails :: Lens' JobMetadata (Maybe ShippingDetails)
- jmAddressId :: Lens' JobMetadata (Maybe Text)
- jmSnowballType :: Lens' JobMetadata (Maybe SnowballType)
- jmDataTransferProgress :: Lens' JobMetadata (Maybe DataTransfer)
- jmResources :: Lens' JobMetadata (Maybe JobResource)
- jmClusterId :: Lens' JobMetadata (Maybe Text)
- jmCreationDate :: Lens' JobMetadata (Maybe UTCTime)
- jmDescription :: Lens' JobMetadata (Maybe Text)
- jmRoleARN :: Lens' JobMetadata (Maybe Text)
- jmSnowballCapacityPreference :: Lens' JobMetadata (Maybe SnowballCapacity)
- data JobResource
- jobResource :: JobResource
- jrLambdaResources :: Lens' JobResource [LambdaResource]
- jrS3Resources :: Lens' JobResource [S3Resource]
- data KeyRange
- keyRange :: KeyRange
- krEndMarker :: Lens' KeyRange (Maybe Text)
- krBeginMarker :: Lens' KeyRange (Maybe Text)
- data LambdaResource
- lambdaResource :: LambdaResource
- lrEventTriggers :: Lens' LambdaResource [EventTriggerDefinition]
- lrLambdaARN :: Lens' LambdaResource (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
Errors
_InvalidResourceException :: AsError a => Getting (First ServiceError) a ServiceError #
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 #
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 #
The provided AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.
_InvalidJobStateException :: AsError a => Getting (First ServiceError) a ServiceError #
The action can't be performed because the job's current state doesn't allow that action to be performed.
_InvalidInputCombinationException :: AsError a => Getting (First ServiceError) a ServiceError #
Job or cluster creation failed. One ore more inputs were invalid. Confirm that the 'CreateClusterRequest$SnowballType' value supports your 'CreateJobRequest$JobType' , and try again.
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError #
The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.
_InvalidAddressException :: AsError a => Getting (First ServiceError) a ServiceError #
The address provided was invalid. Check the address with your region's carrier, and try again.
_ClusterLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError #
Job creation failed. Currently, clusters support five nodes. If you have less 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 notes.
ClusterState
data ClusterState #
Constructors
| AwaitingQuorum | |
| Cancelled | |
| Complete | |
| InUse | |
| Pending |
Instances
JobState
Constructors
| JSCancelled | |
| JSComplete | |
| JSInProgress | |
| JSInTransitToAWS | |
| JSInTransitToCustomer | |
| JSListing | |
| JSNew | |
| JSPending | |
| JSPreparingAppliance | |
| JSPreparingShipment | |
| JSWithAWS | |
| JSWithCustomer |
Instances
JobType
Instances
ShippingOption
data ShippingOption #
Constructors
| SOExpress | |
| SONextDay | |
| SOSecondDay | |
| SOStandard |
Instances
SnowballCapacity
data SnowballCapacity #
Constructors
| NoPreference | |
| T100 | |
| T50 | |
| T80 |
Instances
SnowballType
data SnowballType #
Instances
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.
Instances
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:
aIsRestricted- If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.aStreet3- The third line in a street address that a Snowball is to be delivered to.aLandmark- This field is no longer used and the value is ignored.aPostalCode- The postal code in an address that a Snowball is to be delivered to.aCountry- The country in an address that a Snowball is to be delivered to.aStateOrProvince- The state or province in an address that a Snowball is to be delivered to.aStreet2- The second line in a street address that a Snowball is to be delivered to.aAddressId- The unique ID for an address.aCity- The city in an address that a Snowball is to be delivered to.aPhoneNumber- The phone number associated with an address that a Snowball is to be delivered to.aCompany- The name of the company to receive a Snowball at an address.aName- The name of a person to receive a Snowball at an address.aPrefectureOrDistrict- This field is no longer used and the value is ignored.aStreet1- The first line in a street address that a Snowball is to be delivered to.
aIsRestricted :: Lens' Address (Maybe Bool) #
If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.
aStreet3 :: Lens' Address (Maybe Text) #
The third line in a street address that a Snowball is to be delivered to.
aPostalCode :: Lens' Address (Maybe Text) #
The postal code in an address that a Snowball is to be delivered to.
aCountry :: Lens' Address (Maybe Text) #
The country in an address that a Snowball is to be delivered to.
aStateOrProvince :: Lens' Address (Maybe Text) #
The state or province in an address that a Snowball is to be delivered to.
aStreet2 :: Lens' Address (Maybe Text) #
The second line in a street address that a Snowball is to be delivered to.
aPhoneNumber :: Lens' Address (Maybe Text) #
The phone number associated with an address that a Snowball is to be delivered to.
aCompany :: Lens' Address (Maybe Text) #
The name of the company to receive a Snowball at an address.
aPrefectureOrDistrict :: Lens' Address (Maybe Text) #
This field is no longer used and the value is ignored.
aStreet1 :: Lens' Address (Maybe Text) #
The first line in a street address that a Snowball is to be delivered to.
ClusterListEntry
data ClusterListEntry #
Contains a cluster's state, a cluster's ID, and other important information.
See: clusterListEntry smart constructor.
Instances
clusterListEntry :: ClusterListEntry #
Creates a value of ClusterListEntry with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cleClusterState- The current state of this cluster. For information about the state of a specific node, see 'JobListEntry$JobState' .cleClusterId- The 39-character ID for the cluster that you want to list, for exampleCID123e4567-e89b-12d3-a456-426655440000.cleCreationDate- The creation date for this cluster.cleDescription- Defines an optional description of the cluster, for exampleEnvironmental Data Cluster-01.
cleClusterState :: Lens' ClusterListEntry (Maybe ClusterState) #
The current state of this cluster. For information about the state of a specific node, see 'JobListEntry$JobState' .
cleClusterId :: Lens' ClusterListEntry (Maybe Text) #
The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000 .
cleCreationDate :: Lens' ClusterListEntry (Maybe UTCTime) #
The creation date for this cluster.
cleDescription :: Lens' ClusterListEntry (Maybe Text) #
Defines an optional description of the cluster, for example Environmental Data Cluster-01 .
ClusterMetadata
data ClusterMetadata #
Contains metadata about a specific cluster.
See: clusterMetadata smart constructor.
Instances
clusterMetadata :: ClusterMetadata #
Creates a value of ClusterMetadata with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cmJobType- The type of job for this cluster. Currently, the only job type supported for clusters isLOCAL_USE.cmKMSKeyARN- TheKmsKeyARNAmazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in AWS Key Management Service (AWS KMS).cmClusterState- The current status of the cluster.cmNotification- The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.cmForwardingAddressId- 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.cmAddressId- The automatically generated ID for a specific address.cmSnowballType- The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for cluster jobs isEDGE.cmShippingOption- The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge appliance, rather it represents how quickly each appliance moves to its destination while in transit. Regional shipping speeds are as follows: * In Australia, you have access to express shipping. Typically, appliances shipped express are delivered in about a day. * In the European Union (EU), you have access to express shipping. Typically, Snowball Edges 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, Snowball Edges are delivered in one to seven days. * In the US, you have access to one-day shipping and two-day shipping.cmResources- The arrays ofJobResourceobjects that can include updatedS3Resourceobjects orLambdaResourceobjects.cmClusterId- The automatically generated ID for a cluster.cmCreationDate- The creation date for this cluster.cmDescription- The optional description of the cluster.cmRoleARN- The role ARN associated with this cluster. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).
cmJobType :: Lens' ClusterMetadata (Maybe JobType) #
The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE .
cmKMSKeyARN :: Lens' ClusterMetadata (Maybe Text) #
The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in AWS Key Management Service (AWS KMS).
cmClusterState :: Lens' ClusterMetadata (Maybe ClusterState) #
The current status of the cluster.
cmNotification :: Lens' ClusterMetadata (Maybe Notification) #
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
cmForwardingAddressId :: Lens' ClusterMetadata (Maybe Text) #
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.
cmAddressId :: Lens' ClusterMetadata (Maybe Text) #
The automatically generated ID for a specific address.
cmSnowballType :: Lens' ClusterMetadata (Maybe SnowballType) #
The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for cluster jobs is EDGE .
cmShippingOption :: Lens' ClusterMetadata (Maybe ShippingOption) #
The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge appliance, rather it represents how quickly each appliance moves to its destination while in transit. Regional shipping speeds are as follows: * In Australia, you have access to express shipping. Typically, appliances shipped express are delivered in about a day. * In the European Union (EU), you have access to express shipping. Typically, Snowball Edges 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, Snowball Edges are delivered in one to seven days. * In the US, you have access to one-day shipping and two-day shipping.
cmResources :: Lens' ClusterMetadata (Maybe JobResource) #
The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
cmClusterId :: Lens' ClusterMetadata (Maybe Text) #
The automatically generated ID for a cluster.
cmCreationDate :: Lens' ClusterMetadata (Maybe UTCTime) #
The creation date for this cluster.
cmDescription :: Lens' ClusterMetadata (Maybe Text) #
The optional description of the cluster.
cmRoleARN :: Lens' ClusterMetadata (Maybe Text) #
The role ARN associated with this cluster. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).
DataTransfer
data DataTransfer #
Defines the real-time status of a Snowball's data transfer while the appliance is at AWS. This data is only available while a job has a JobState value of InProgress , for both import and export jobs.
See: dataTransfer smart constructor.
Instances
dataTransfer :: DataTransfer #
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- 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- 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- The number of objects transferred between a Snowball and Amazon S3.dtBytesTransferred- The number of bytes transferred between a Snowball and Amazon S3.
dtTotalObjects :: Lens' DataTransfer (Maybe Integer) #
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) #
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) #
The number of objects transferred between a Snowball and Amazon S3.
dtBytesTransferred :: Lens' DataTransfer (Maybe Integer) #
The number of bytes transferred between a Snowball and Amazon S3.
EventTriggerDefinition
data EventTriggerDefinition #
The container for the 'EventTriggerDefinition$EventResourceARN' .
See: eventTriggerDefinition smart constructor.
Instances
eventTriggerDefinition :: EventTriggerDefinition #
Creates a value of EventTriggerDefinition with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
etdEventResourceARN- The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an AWS Lambda function's event trigger associated with this job.
etdEventResourceARN :: Lens' EventTriggerDefinition (Maybe Text) #
The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an AWS Lambda function's event trigger associated with this job.
JobListEntry
data JobListEntry #
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.
Instances
jobListEntry :: JobListEntry #
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:
jleJobType- The type of job.jleJobId- The automatically generated ID for a job, for exampleJID123e4567-e89b-12d3-a456-426655440000.jleJobState- The current state of this job.jleSnowballType- The type of appliance used with this job.jleCreationDate- The creation date for this job.jleDescription- The optional description of this specific job, for exampleImportant Photos 2016-08-11.jleIsMaster- 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.
jleJobType :: Lens' JobListEntry (Maybe JobType) #
The type of job.
jleJobId :: Lens' JobListEntry (Maybe Text) #
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000 .
jleJobState :: Lens' JobListEntry (Maybe JobState) #
The current state of this job.
jleSnowballType :: Lens' JobListEntry (Maybe SnowballType) #
The type of appliance used with this job.
jleCreationDate :: Lens' JobListEntry (Maybe UTCTime) #
The creation date for this job.
jleDescription :: Lens' JobListEntry (Maybe Text) #
The optional description of this specific job, for example Important Photos 2016-08-11 .
jleIsMaster :: Lens' JobListEntry (Maybe Bool) #
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.
Instances
| Eq JobLogs # | |
| Data JobLogs # | |
Defined in Network.AWS.Snowball.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> JobLogs -> c JobLogs # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c JobLogs # toConstr :: JobLogs -> Constr # dataTypeOf :: JobLogs -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c JobLogs) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c JobLogs) # gmapT :: (forall b. Data b => b -> b) -> JobLogs -> JobLogs # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> JobLogs -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> JobLogs -> r # gmapQ :: (forall d. Data d => d -> u) -> JobLogs -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> JobLogs -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> JobLogs -> m JobLogs # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> JobLogs -> m JobLogs # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> JobLogs -> m JobLogs # | |
| Read JobLogs # | |
| Show JobLogs # | |
| Generic JobLogs # | |
| Hashable JobLogs # | |
Defined in Network.AWS.Snowball.Types.Product | |
| FromJSON JobLogs # | |
| NFData JobLogs # | |
Defined in Network.AWS.Snowball.Types.Product | |
| type Rep JobLogs # | |
Defined in Network.AWS.Snowball.Types.Product type Rep JobLogs = D1 (MetaData "JobLogs" "Network.AWS.Snowball.Types.Product" "amazonka-snowball-1.6.0-8yJ8aNw8nw6I7L9Jr6XQX1" False) (C1 (MetaCons "JobLogs'" PrefixI True) (S1 (MetaSel (Just "_jlJobFailureLogURI") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_jlJobCompletionReportURI") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_jlJobSuccessLogURI") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) | |
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- A link to an Amazon S3 presigned URL where the job failure log is located.jlJobCompletionReportURI- A link to an Amazon S3 presigned URL where the job completion report is located.jlJobSuccessLogURI- A link to an Amazon S3 presigned URL where the job success log is located.
jlJobFailureLogURI :: Lens' JobLogs (Maybe Text) #
A link to an Amazon S3 presigned URL where the job failure log is located.
jlJobCompletionReportURI :: Lens' JobLogs (Maybe Text) #
A link to an Amazon S3 presigned URL where the job completion report is located.
jlJobSuccessLogURI :: Lens' JobLogs (Maybe Text) #
A link to an Amazon S3 presigned URL where the job success log is located.
JobMetadata
data JobMetadata #
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.
Instances
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:
jmJobType- The type of job.jmKMSKeyARN- 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- The automatically generated ID for a job, for exampleJID123e4567-e89b-12d3-a456-426655440000.jmJobLogInfo- 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- The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. TheNotificationobject is returned as a part of the response syntax of theDescribeJobaction in theJobMetadatadata type.jmJobState- The current status of the jobs.jmForwardingAddressId- 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.jmShippingDetails- A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.jmAddressId- The ID for the address that you want the Snowball shipped to.jmSnowballType- The type of appliance used with this job.jmDataTransferProgress- A value that defines the real-time status of a Snowball's data transfer while the appliance is at AWS. This data is only available while a job has aJobStatevalue ofInProgress, for both import and export jobs.jmResources- An array ofS3Resourceobjects. EachS3Resourceobject represents an Amazon S3 bucket that your transferred data will be exported from or imported into.jmClusterId- The 39-character ID for the cluster, for exampleCID123e4567-e89b-12d3-a456-426655440000.jmCreationDate- The creation date for this job.jmDescription- The description of the job, provided at job creation.jmRoleARN- The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).jmSnowballCapacityPreference- 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.
jmKMSKeyARN :: Lens' JobMetadata (Maybe Text) #
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) #
The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000 .
jmJobLogInfo :: Lens' JobMetadata (Maybe JobLogs) #
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) #
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) #
The current status of the jobs.
jmForwardingAddressId :: Lens' JobMetadata (Maybe Text) #
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.
jmShippingDetails :: Lens' JobMetadata (Maybe ShippingDetails) #
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
jmAddressId :: Lens' JobMetadata (Maybe Text) #
The ID for the address that you want the Snowball shipped to.
jmSnowballType :: Lens' JobMetadata (Maybe SnowballType) #
The type of appliance used with this job.
jmDataTransferProgress :: Lens' JobMetadata (Maybe DataTransfer) #
A value that defines the real-time status of a Snowball's data transfer while the appliance is at AWS. 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) #
An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.
jmClusterId :: Lens' JobMetadata (Maybe Text) #
The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000 .
jmCreationDate :: Lens' JobMetadata (Maybe UTCTime) #
The creation date for this job.
jmDescription :: Lens' JobMetadata (Maybe Text) #
The description of the job, provided at job creation.
jmRoleARN :: Lens' JobMetadata (Maybe Text) #
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) #
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 #
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.
Instances
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:
jrLambdaResources- The Python-language Lambda functions for this job.jrS3Resources- An array ofS3Resourceobjects.
jrLambdaResources :: Lens' JobResource [LambdaResource] #
The Python-language Lambda functions for this job.
jrS3Resources :: Lens' JobResource [S3Resource] #
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.
Instances
| Eq KeyRange # | |
| Data KeyRange # | |
Defined in Network.AWS.Snowball.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> KeyRange -> c KeyRange # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c KeyRange # toConstr :: KeyRange -> Constr # dataTypeOf :: KeyRange -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c KeyRange) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c KeyRange) # gmapT :: (forall b. Data b => b -> b) -> KeyRange -> KeyRange # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> KeyRange -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> KeyRange -> r # gmapQ :: (forall d. Data d => d -> u) -> KeyRange -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> KeyRange -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> KeyRange -> m KeyRange # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> KeyRange -> m KeyRange # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> KeyRange -> m KeyRange # | |
| Read KeyRange # | |
| Show KeyRange # | |
| Generic KeyRange # | |
| Hashable KeyRange # | |
Defined in Network.AWS.Snowball.Types.Product | |
| ToJSON KeyRange # | |
Defined in Network.AWS.Snowball.Types.Product | |
| FromJSON KeyRange # | |
| NFData KeyRange # | |
Defined in Network.AWS.Snowball.Types.Product | |
| type Rep KeyRange # | |
Defined in Network.AWS.Snowball.Types.Product type Rep KeyRange = D1 (MetaData "KeyRange" "Network.AWS.Snowball.Types.Product" "amazonka-snowball-1.6.0-8yJ8aNw8nw6I7L9Jr6XQX1" False) (C1 (MetaCons "KeyRange'" PrefixI True) (S1 (MetaSel (Just "_krEndMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_krBeginMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) | |
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- The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.krBeginMarker- The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
krEndMarker :: Lens' KeyRange (Maybe Text) #
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) #
The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.
LambdaResource
data LambdaResource #
Identifies
See: lambdaResource smart constructor.
Instances
lambdaResource :: LambdaResource #
Creates a value of LambdaResource with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lrEventTriggers- The array of ARNs forS3Resourceobjects to trigger theLambdaResourceobjects associated with this job.lrLambdaARN- An Amazon Resource Name (ARN) that represents an AWS Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.
lrEventTriggers :: Lens' LambdaResource [EventTriggerDefinition] #
The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.
lrLambdaARN :: Lens' LambdaResource (Maybe Text) #
An Amazon Resource Name (ARN) that represents an AWS Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.
Notification
data 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.
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.
Instances
notification :: Notification #
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- Any change in job state will trigger a notification for this job.nSNSTopicARN- The new SNSTopicArnthat 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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action.nJobStatesToNotify- The list of job states that will trigger a notification for this job.
nNotifyAll :: Lens' Notification (Maybe Bool) #
Any change in job state will trigger a notification for this job.
nSNSTopicARN :: Lens' Notification (Maybe Text) #
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 AWS Management Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action.
nJobStatesToNotify :: Lens' Notification [JobState] #
The list of job states that will trigger a notification for this job.
S3Resource
data S3Resource #
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.
Instances
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- For export jobs, you can provide an optionalKeyRangewithin a specific Amazon S3 bucket. The length of the range is defined at job creation, and has either an inclusiveBeginMarker, an inclusiveEndMarker, or both. Ranges are UTF-8 binary sorted.srBucketARN- The Amazon Resource Name (ARN) of an Amazon S3 bucket.
srKeyRange :: Lens' S3Resource (Maybe 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.
srBucketARN :: Lens' S3Resource (Maybe Text) #
The Amazon Resource Name (ARN) of an Amazon S3 bucket.
Shipment
The Status and TrackingNumber information for an inbound or outbound shipment.
See: shipment smart constructor.
Instances
| Eq Shipment # | |
| Data Shipment # | |
Defined in Network.AWS.Snowball.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Shipment -> c Shipment # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Shipment # toConstr :: Shipment -> Constr # dataTypeOf :: Shipment -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Shipment) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Shipment) # gmapT :: (forall b. Data b => b -> b) -> Shipment -> Shipment # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Shipment -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Shipment -> r # gmapQ :: (forall d. Data d => d -> u) -> Shipment -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Shipment -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Shipment -> m Shipment # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Shipment -> m Shipment # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Shipment -> m Shipment # | |
| Read Shipment # | |
| Show Shipment # | |
| Generic Shipment # | |
| Hashable Shipment # | |
Defined in Network.AWS.Snowball.Types.Product | |
| FromJSON Shipment # | |
| NFData Shipment # | |
Defined in Network.AWS.Snowball.Types.Product | |
| type Rep Shipment # | |
Defined in Network.AWS.Snowball.Types.Product type Rep Shipment = D1 (MetaData "Shipment" "Network.AWS.Snowball.Types.Product" "amazonka-snowball-1.6.0-8yJ8aNw8nw6I7L9Jr6XQX1" False) (C1 (MetaCons "Shipment'" PrefixI True) (S1 (MetaSel (Just "_sStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_sTrackingNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) | |
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- Status information for a shipment.sTrackingNumber- 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.
sTrackingNumber :: Lens' Shipment (Maybe Text) #
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 #
A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.
See: shippingDetails smart constructor.
Instances
shippingDetails :: ShippingDetails #
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- The shipping speed for a particular job. This speed doesn't 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- TheStatusandTrackingNumbervalues for a Snowball being delivered to the address that you specified for a particular job.sdInboundShipment- TheStatusandTrackingNumbervalues for a Snowball being returned to AWS for a particular job.
sdShippingOption :: Lens' ShippingDetails (Maybe ShippingOption) #
The shipping speed for a particular job. This speed doesn't 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) #
The Status and TrackingNumber values for a Snowball being delivered to the address that you specified for a particular job.
sdInboundShipment :: Lens' ShippingDetails (Maybe Shipment) #
The Status and TrackingNumber values for a Snowball being returned to AWS for a particular job.