amazonka-snowball-1.6.0: Amazon Import/Export Snowball SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Snowball.CreateJob

Contents

Description

Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must have the right trust policies and permissions in place to create a job for Snowball. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster.

Synopsis

Creating a Request

createJob :: 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:

  • cjJobType - Defines the type of job that you're creating.
  • cjKMSKeyARN - The KmsKeyARN that you want to associate with this job. KmsKeyARN s are created using the CreateKey AWS Key Management Service (KMS) API action.
  • cjNotification - Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.
  • cjForwardingAddressId - The forwarding address ID for a job. This field is not supported in most regions.
  • cjAddressId - The ID for the address that you want the Snowball shipped to.
  • cjSnowballType - The type of AWS Snowball appliance to use for this job. Currently, the only supported appliance type for cluster jobs is EDGE .
  • cjShippingOption - The shipping speed for this job. This speed doesn't 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.
  • cjResources - 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.
  • cjClusterId - The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster.
  • cjDescription - Defines an optional description of this specific job, for example Important Photos 2016-08-11 .
  • cjRoleARN - The RoleARN that you want to associate with this job. RoleArn s are created using the CreateRole AWS Identity and Access Management (IAM) API action.
  • cjSnowballCapacityPreference - 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.

data CreateJob #

See: createJob smart constructor.

Instances

Eq CreateJob # 
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 # 
Show CreateJob # 
Generic CreateJob # 

Associated Types

type Rep CreateJob :: * -> * #

Hashable CreateJob # 
ToJSON CreateJob # 
NFData CreateJob # 

Methods

rnf :: CreateJob -> () #

AWSRequest CreateJob # 
ToHeaders CreateJob # 

Methods

toHeaders :: CreateJob -> [Header] #

ToPath CreateJob # 
ToQuery CreateJob # 
type Rep CreateJob # 
type Rep CreateJob = D1 * (MetaData "CreateJob" "Network.AWS.Snowball.CreateJob" "amazonka-snowball-1.6.0-CpRkSYaTAPzF30R6kNaJAh" False) (C1 * (MetaCons "CreateJob'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cjJobType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe JobType))) ((:*:) * (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 "_cjForwardingAddressId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cjAddressId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cjSnowballType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe SnowballType)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_cjShippingOption") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ShippingOption))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cjResources") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe JobResource))) (S1 * (MetaSel (Just Symbol "_cjClusterId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cjDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_cjRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cjSnowballCapacityPreference") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe SnowballCapacity))))))))
type Rs CreateJob # 

Request Lenses

cjJobType :: Lens' CreateJob (Maybe JobType) #

Defines the type of job that you're creating.

cjKMSKeyARN :: Lens' CreateJob (Maybe Text) #

The KmsKeyARN that you want to associate with this job. KmsKeyARN s 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.

cjForwardingAddressId :: Lens' CreateJob (Maybe Text) #

The forwarding address ID for a job. This field is not supported in most regions.

cjAddressId :: Lens' CreateJob (Maybe Text) #

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

cjSnowballType :: Lens' CreateJob (Maybe SnowballType) #

The type of AWS Snowball appliance to use for this job. Currently, the only supported appliance type for cluster jobs is EDGE .

cjShippingOption :: Lens' CreateJob (Maybe ShippingOption) #

The shipping speed for this job. This speed doesn't 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.

cjResources :: Lens' CreateJob (Maybe 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.

cjClusterId :: Lens' CreateJob (Maybe Text) #

The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster.

cjDescription :: Lens' CreateJob (Maybe Text) #

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

cjRoleARN :: Lens' CreateJob (Maybe Text) #

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

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.

Destructuring the Response

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 - The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000 .
  • cjrsResponseStatus - -- | The response status code.

data CreateJobResponse #

See: createJobResponse smart constructor.

Instances

Eq CreateJobResponse # 
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 # 
Show CreateJobResponse # 
Generic CreateJobResponse # 
NFData CreateJobResponse # 

Methods

rnf :: CreateJobResponse -> () #

type Rep CreateJobResponse # 
type Rep CreateJobResponse = D1 * (MetaData "CreateJobResponse" "Network.AWS.Snowball.CreateJob" "amazonka-snowball-1.6.0-CpRkSYaTAPzF30R6kNaJAh" False) (C1 * (MetaCons "CreateJobResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_cjrsJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_cjrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (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.