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 |
While a job's JobState
value is New
, you can update some of the
information associated with a job. Once the job changes to a different
job state, usually within 60 minutes of the job being created, this
action is no longer available.
Synopsis
- data UpdateJob = UpdateJob' {
- addressId :: Maybe Text
- description :: Maybe Text
- forwardingAddressId :: Maybe Text
- notification :: Maybe Notification
- onDeviceServiceConfiguration :: Maybe OnDeviceServiceConfiguration
- resources :: Maybe JobResource
- roleARN :: Maybe Text
- shippingOption :: Maybe ShippingOption
- snowballCapacityPreference :: Maybe SnowballCapacity
- jobId :: Text
- newUpdateJob :: Text -> UpdateJob
- updateJob_addressId :: Lens' UpdateJob (Maybe Text)
- updateJob_description :: Lens' UpdateJob (Maybe Text)
- updateJob_forwardingAddressId :: Lens' UpdateJob (Maybe Text)
- updateJob_notification :: Lens' UpdateJob (Maybe Notification)
- updateJob_onDeviceServiceConfiguration :: Lens' UpdateJob (Maybe OnDeviceServiceConfiguration)
- updateJob_resources :: Lens' UpdateJob (Maybe JobResource)
- updateJob_roleARN :: Lens' UpdateJob (Maybe Text)
- updateJob_shippingOption :: Lens' UpdateJob (Maybe ShippingOption)
- updateJob_snowballCapacityPreference :: Lens' UpdateJob (Maybe SnowballCapacity)
- updateJob_jobId :: Lens' UpdateJob Text
- data UpdateJobResponse = UpdateJobResponse' {
- httpStatus :: Int
- newUpdateJobResponse :: Int -> UpdateJobResponse
- updateJobResponse_httpStatus :: Lens' UpdateJobResponse Int
Creating a Request
See: newUpdateJob
smart constructor.
UpdateJob' | |
|
Instances
Create a value of UpdateJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateJob
, updateJob_addressId
- The ID of the updated Address object.
UpdateJob
, updateJob_description
- The updated description of this job's JobMetadata object.
UpdateJob
, updateJob_forwardingAddressId
- The updated ID for the forwarding address for a job. This field is not
supported in most regions.
UpdateJob
, updateJob_notification
- The new or updated Notification object.
UpdateJob
, updateJob_onDeviceServiceConfiguration
- Specifies the service or services on the Snow Family device that your
transferred data will be exported from or imported into. Amazon Web
Services Snow Family supports Amazon S3 and NFS (Network File System)
and the Amazon Web Services Storage Gateway service Tape Gateway type.
UpdateJob
, updateJob_resources
- The updated JobResource
object, or the updated JobResource object.
UpdateJob
, updateJob_roleARN
- The new role Amazon Resource Name (ARN) that you want to associate with
this job. To create a role ARN, use the
CreateRoleIdentity
and Access Management (IAM) API action.
UpdateJob
, updateJob_shippingOption
- The updated shipping option value of this job's ShippingDetails object.
UpdateJob
, updateJob_snowballCapacityPreference
- The updated SnowballCapacityPreference
of this job's JobMetadata
object. The 50 TB Snowballs are only available in the US regions.
For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
UpdateJob
, updateJob_jobId
- The job ID of the job that you want to update, for example
JID123e4567-e89b-12d3-a456-426655440000
.
Request Lenses
updateJob_description :: Lens' UpdateJob (Maybe Text) Source #
The updated description of this job's JobMetadata object.
updateJob_forwardingAddressId :: Lens' UpdateJob (Maybe Text) Source #
The updated ID for the forwarding address for a job. This field is not supported in most regions.
updateJob_notification :: Lens' UpdateJob (Maybe Notification) Source #
The new or updated Notification object.
updateJob_onDeviceServiceConfiguration :: Lens' UpdateJob (Maybe OnDeviceServiceConfiguration) Source #
Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family supports Amazon S3 and NFS (Network File System) and the Amazon Web Services Storage Gateway service Tape Gateway type.
updateJob_resources :: Lens' UpdateJob (Maybe JobResource) Source #
The updated JobResource
object, or the updated JobResource object.
updateJob_roleARN :: Lens' UpdateJob (Maybe Text) Source #
The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the CreateRoleIdentity and Access Management (IAM) API action.
updateJob_shippingOption :: Lens' UpdateJob (Maybe ShippingOption) Source #
The updated shipping option value of this job's ShippingDetails object.
updateJob_snowballCapacityPreference :: Lens' UpdateJob (Maybe SnowballCapacity) Source #
The updated SnowballCapacityPreference
of this job's JobMetadata
object. The 50 TB Snowballs are only available in the US regions.
For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
updateJob_jobId :: Lens' UpdateJob Text Source #
The job ID of the job that you want to update, for example
JID123e4567-e89b-12d3-a456-426655440000
.
Destructuring the Response
data UpdateJobResponse Source #
See: newUpdateJobResponse
smart constructor.
UpdateJobResponse' | |
|
Instances
Create a value of UpdateJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateJobResponse'
, updateJobResponse_httpStatus
- The response's http status code.
Response Lenses
updateJobResponse_httpStatus :: Lens' UpdateJobResponse Int Source #
The response's http status code.