Network.AWS.Snowball.CreateJob

Creates a job to import or export data between Amazon S3 and your on-premises data center. Note that your AWS account must have the right trust policies and permissions in place to create a job for Snowball. For more information, see api-reference-policies.

Creating a Request

createJob

Arguments

:: JobType

cjJobType

-> JobResource

cjResources

-> Text

cjAddressId

-> Text

cjRoleARN

-> ShippingOption

cjShippingOption

-> CreateJob

Creates a value of CreateJob with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cjKMSKeyARN
• cjNotification
• cjDescription
• cjSnowballCapacityPreference
• cjJobType
• cjResources
• cjAddressId
• cjRoleARN
• cjShippingOption

data CreateJob

See: createJob smart constructor.

Instances

Eq CreateJob

Methods

(==) :: CreateJob -> CreateJob -> Bool

(/=) :: CreateJob -> CreateJob -> Bool

Data CreateJob

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateJob -> c CreateJob

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateJob

toConstr :: CreateJob -> Constr

dataTypeOf :: CreateJob -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateJob)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateJob)

gmapT :: (forall b. Data b => b -> b) -> CreateJob -> CreateJob

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateJob -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateJob -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateJob -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateJob -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateJob -> m CreateJob

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateJob -> m CreateJob

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateJob -> m CreateJob

Read CreateJob

Methods

readsPrec :: Int -> ReadS CreateJob

readList :: ReadS [CreateJob]

readPrec :: ReadPrec CreateJob

readListPrec :: ReadPrec [CreateJob]

Show CreateJob

Methods

showsPrec :: Int -> CreateJob -> ShowS

show :: CreateJob -> String

showList :: [CreateJob] -> ShowS

Generic CreateJob

Associated Types

type Rep CreateJob :: * -> *

Methods

from :: CreateJob -> Rep CreateJob x

to :: Rep CreateJob x -> CreateJob

Hashable CreateJob

Methods

hashWithSalt :: Int -> CreateJob -> Int

hash :: CreateJob -> Int

NFData CreateJob

Methods

rnf :: CreateJob -> ()

AWSRequest CreateJob

Associated Types

type Rs CreateJob :: *

Methods

request :: CreateJob -> Request CreateJob

response :: MonadResource m => Logger -> Service -> Proxy * CreateJob -> ClientResponse -> m (Response CreateJob)

ToPath CreateJob

Methods

toPath :: CreateJob -> ByteString

ToHeaders CreateJob

Methods

toHeaders :: CreateJob -> [Header]

ToQuery CreateJob

Methods

toQuery :: CreateJob -> QueryString

ToJSON CreateJob

Methods

toJSON :: CreateJob -> Value

toEncoding :: CreateJob -> Encoding

type Rep CreateJob

type Rep CreateJob = D1 (MetaData "CreateJob" "Network.AWS.Snowball.CreateJob" "amazonka-snowball-1.4.4-EBeC3AOt1avBHCFPByW5Jr" False) (C1 (MetaCons "CreateJob'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cjKMSKeyARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cjNotification") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Notification)))) ((:*:) (S1 (MetaSel (Just Symbol "_cjDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cjSnowballCapacityPreference") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SnowballCapacity))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cjJobType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 JobType)) (S1 (MetaSel (Just Symbol "_cjResources") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 JobResource))) ((:*:) (S1 (MetaSel (Just Symbol "_cjAddressId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_cjRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cjShippingOption") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ShippingOption)))))))

type Rs CreateJob

type Rs CreateJob = CreateJobResponse

Request Lenses

cjKMSKeyARN :: Lens' CreateJob (Maybe Text)

The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey AWS Key Management Service (KMS) API action.

cjNotification :: Lens' CreateJob (Maybe Notification)

Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.

cjDescription :: Lens' CreateJob (Maybe Text)

Defines an optional description of this specific job, for example 'Important Photos 2016-08-11'.

cjSnowballCapacityPreference :: Lens' CreateJob (Maybe SnowballCapacity)

If your job is being created in one of the US regions, you have the option of specifying what size Snowball you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.

cjJobType :: Lens' CreateJob JobType

Defines the type of job that you're creating.

cjResources :: Lens' CreateJob JobResource

Defines the Amazon S3 buckets associated with this job.

With IMPORT jobs, you specify the bucket or buckets that your transferred data will be imported into.

With EXPORT jobs, you specify the bucket or buckets that your transferred data will be exported from. Optionally, you can also specify a KeyRange value. If you choose to export a range, you define the length of the range by providing either an inclusive BeginMarker value, an inclusive EndMarker value, or both. Ranges are UTF-8 binary sorted.

cjAddressId :: Lens' CreateJob Text

The ID for the address that you want the Snowball shipped to.

cjRoleARN :: Lens' CreateJob Text

The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole AWS Identity and Access Management (IAM) API action.

cjShippingOption :: Lens' CreateJob ShippingOption

The shipping speed for this job. Note that this speed does not dictate how soon you'll get the Snowball, rather it represents how quickly the Snowball 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 US, you have access to one-day shipping and two-day shipping.

Destructuring the Response

createJobResponse

Arguments

:: Int

cjrsResponseStatus

-> CreateJobResponse

Creates a value of CreateJobResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cjrsJobId
• cjrsResponseStatus

data CreateJobResponse

See: createJobResponse smart constructor.

Instances

Eq CreateJobResponse

Methods

(==) :: CreateJobResponse -> CreateJobResponse -> Bool

(/=) :: CreateJobResponse -> CreateJobResponse -> Bool

Data CreateJobResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateJobResponse -> c CreateJobResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateJobResponse

toConstr :: CreateJobResponse -> Constr

dataTypeOf :: CreateJobResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateJobResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateJobResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateJobResponse -> CreateJobResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateJobResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateJobResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateJobResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateJobResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateJobResponse -> m CreateJobResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateJobResponse -> m CreateJobResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateJobResponse -> m CreateJobResponse

Read CreateJobResponse

Methods

readsPrec :: Int -> ReadS CreateJobResponse

readList :: ReadS [CreateJobResponse]

readPrec :: ReadPrec CreateJobResponse

readListPrec :: ReadPrec [CreateJobResponse]

Show CreateJobResponse

Methods

showsPrec :: Int -> CreateJobResponse -> ShowS

show :: CreateJobResponse -> String

showList :: [CreateJobResponse] -> ShowS

Generic CreateJobResponse

Associated Types

type Rep CreateJobResponse :: * -> *

Methods

from :: CreateJobResponse -> Rep CreateJobResponse x

to :: Rep CreateJobResponse x -> CreateJobResponse

NFData CreateJobResponse

Methods

rnf :: CreateJobResponse -> ()

type Rep CreateJobResponse

type Rep CreateJobResponse = D1 (MetaData "CreateJobResponse" "Network.AWS.Snowball.CreateJob" "amazonka-snowball-1.4.4-EBeC3AOt1avBHCFPByW5Jr" False) (C1 (MetaCons "CreateJobResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cjrsJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cjrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

cjrsJobId :: Lens' CreateJobResponse (Maybe Text)

The automatically generated ID for a job, for example 'JID123e4567-e89b-12d3-a456-426655440000'.

cjrsResponseStatus :: Lens' CreateJobResponse Int

The response status code.