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.UpdateJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

data UpdateJob Source #

See: newUpdateJob smart constructor.

Constructors

UpdateJob'

Fields

addressId :: Maybe Text
The ID of the updated Address object.
description :: Maybe Text
The updated description of this job's JobMetadata object.
forwardingAddressId :: Maybe Text
The updated ID for the forwarding address for a job. This field is not supported in most regions.
notification :: Maybe Notification
The new or updated Notification object.
onDeviceServiceConfiguration :: Maybe 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.
resources :: Maybe JobResource
The updated JobResource object, or the updated JobResource object.
roleARN :: Maybe Text
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.
shippingOption :: Maybe ShippingOption
The updated shipping option value of this job's ShippingDetails object.
snowballCapacityPreference :: Maybe SnowballCapacity
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.
jobId :: Text
The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.

Instances

Instances details

ToJSON UpdateJob Source #
Instance details Defined in Amazonka.Snowball.UpdateJob Methods toJSON :: UpdateJob -> Value # toEncoding :: UpdateJob -> Encoding # toJSONList :: [UpdateJob] -> Value # toEncodingList :: [UpdateJob] -> Encoding #
ToHeaders UpdateJob Source #
Instance details Defined in Amazonka.Snowball.UpdateJob Methods toHeaders :: UpdateJob -> [Header] #
ToPath UpdateJob Source #
Instance details Defined in Amazonka.Snowball.UpdateJob Methods toPath :: UpdateJob -> ByteString #
ToQuery UpdateJob Source #
Instance details Defined in Amazonka.Snowball.UpdateJob Methods toQuery :: UpdateJob -> QueryString #
AWSRequest UpdateJob Source #
Instance details Defined in Amazonka.Snowball.UpdateJob Associated Types type AWSResponse UpdateJob # Methods request :: (Service -> Service) -> UpdateJob -> Request UpdateJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateJob))) #
Generic UpdateJob Source #
Instance details Defined in Amazonka.Snowball.UpdateJob Associated Types type Rep UpdateJob :: Type -> Type # Methods from :: UpdateJob -> Rep UpdateJob x # to :: Rep UpdateJob x -> UpdateJob #
Read UpdateJob Source #
Instance details Defined in Amazonka.Snowball.UpdateJob Methods readsPrec :: Int -> ReadS UpdateJob # readList :: ReadS [UpdateJob] # readPrec :: ReadPrec UpdateJob # readListPrec :: ReadPrec [UpdateJob] #
Show UpdateJob Source #
Instance details Defined in Amazonka.Snowball.UpdateJob Methods showsPrec :: Int -> UpdateJob -> ShowS # show :: UpdateJob -> String # showList :: [UpdateJob] -> ShowS #
NFData UpdateJob Source #
Instance details Defined in Amazonka.Snowball.UpdateJob Methods rnf :: UpdateJob -> () #
Eq UpdateJob Source #
Instance details Defined in Amazonka.Snowball.UpdateJob Methods (==) :: UpdateJob -> UpdateJob -> Bool # (/=) :: UpdateJob -> UpdateJob -> Bool #
Hashable UpdateJob Source #
Instance details Defined in Amazonka.Snowball.UpdateJob Methods hashWithSalt :: Int -> UpdateJob -> Int # hash :: UpdateJob -> Int #
type AWSResponse UpdateJob Source #
Instance details Defined in Amazonka.Snowball.UpdateJob type AWSResponse UpdateJob = UpdateJobResponse
type Rep UpdateJob Source #
Instance details Defined in Amazonka.Snowball.UpdateJob type Rep UpdateJob = D1 ('MetaData "UpdateJob" "Amazonka.Snowball.UpdateJob" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "UpdateJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "addressId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "forwardingAddressId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "notification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Notification)) :: S1 ('MetaSel ('Just "onDeviceServiceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OnDeviceServiceConfiguration))))) :: ((S1 ('MetaSel ('Just "resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobResource)) :: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "shippingOption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ShippingOption)) :: (S1 ('MetaSel ('Just "snowballCapacityPreference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SnowballCapacity)) :*: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateJob Source #

Arguments

:: Text	`UpdateJob`
-> UpdateJob

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_addressId :: Lens' UpdateJob (Maybe Text) Source #

The ID of the updated Address object.

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.

Constructors

UpdateJobResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateJobResponse Source #
Instance details Defined in Amazonka.Snowball.UpdateJob Associated Types type Rep UpdateJobResponse :: Type -> Type # Methods from :: UpdateJobResponse -> Rep UpdateJobResponse x # to :: Rep UpdateJobResponse x -> UpdateJobResponse #
Read UpdateJobResponse Source #
Instance details Defined in Amazonka.Snowball.UpdateJob Methods readsPrec :: Int -> ReadS UpdateJobResponse # readList :: ReadS [UpdateJobResponse] # readPrec :: ReadPrec UpdateJobResponse # readListPrec :: ReadPrec [UpdateJobResponse] #
Show UpdateJobResponse Source #
Instance details Defined in Amazonka.Snowball.UpdateJob Methods showsPrec :: Int -> UpdateJobResponse -> ShowS # show :: UpdateJobResponse -> String # showList :: [UpdateJobResponse] -> ShowS #
NFData UpdateJobResponse Source #
Instance details Defined in Amazonka.Snowball.UpdateJob Methods rnf :: UpdateJobResponse -> () #
Eq UpdateJobResponse Source #
Instance details Defined in Amazonka.Snowball.UpdateJob Methods (==) :: UpdateJobResponse -> UpdateJobResponse -> Bool # (/=) :: UpdateJobResponse -> UpdateJobResponse -> Bool #
type Rep UpdateJobResponse Source #
Instance details Defined in Amazonka.Snowball.UpdateJob type Rep UpdateJobResponse = D1 ('MetaData "UpdateJobResponse" "Amazonka.Snowball.UpdateJob" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "UpdateJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateJobResponse'`
-> UpdateJobResponse

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.