Network.AWS.Glacier.InitiateJob

This operation initiates a job of the specified type, which can be a select, an archival retrieval, or a vault retrieval. For more information about using this operation, see the documentation for the underlying REST API Initiate a Job .

Creating a Request

initiateJob

Arguments

:: Text

ijAccountId

-> Text

ijVaultName

-> InitiateJob

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

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

• ijJobParameters - Provides options for specifying job information.
• ijAccountId - The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '- ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (-) in the ID.
• ijVaultName - The name of the vault.

data InitiateJob

Provides options for initiating an Amazon Glacier job.

See: initiateJob smart constructor.

Instances

Eq InitiateJob

Defined in Network.AWS.Glacier.InitiateJob

Methods

(==) :: InitiateJob -> InitiateJob -> Bool

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

Data InitiateJob

Defined in Network.AWS.Glacier.InitiateJob

Methods

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

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

toConstr :: InitiateJob -> Constr

dataTypeOf :: InitiateJob -> DataType

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

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

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

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

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

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

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

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

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

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

Read InitiateJob

Defined in Network.AWS.Glacier.InitiateJob

Methods

readsPrec :: Int -> ReadS InitiateJob

readList :: ReadS [InitiateJob]

readPrec :: ReadPrec InitiateJob

readListPrec :: ReadPrec [InitiateJob]

Show InitiateJob

Defined in Network.AWS.Glacier.InitiateJob

Methods

showsPrec :: Int -> InitiateJob -> ShowS

show :: InitiateJob -> String

showList :: [InitiateJob] -> ShowS

Generic InitiateJob

Defined in Network.AWS.Glacier.InitiateJob

Associated Types

type Rep InitiateJob :: Type -> Type

Methods

from :: InitiateJob -> Rep InitiateJob x

to :: Rep InitiateJob x -> InitiateJob

Hashable InitiateJob

Defined in Network.AWS.Glacier.InitiateJob

Methods

hashWithSalt :: Int -> InitiateJob -> Int

hash :: InitiateJob -> Int

ToJSON InitiateJob

Defined in Network.AWS.Glacier.InitiateJob

Methods

toJSON :: InitiateJob -> Value

toEncoding :: InitiateJob -> Encoding

toJSONList :: [InitiateJob] -> Value

toEncodingList :: [InitiateJob] -> Encoding

AWSRequest InitiateJob

Defined in Network.AWS.Glacier.InitiateJob

Associated Types

type Rs InitiateJob :: Type

Methods

request :: InitiateJob -> Request InitiateJob

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy InitiateJob -> ClientResponse -> m (Response InitiateJob)

ToHeaders InitiateJob

Defined in Network.AWS.Glacier.InitiateJob

Methods

toHeaders :: InitiateJob -> [Header]

ToPath InitiateJob

Defined in Network.AWS.Glacier.InitiateJob

Methods

toPath :: InitiateJob -> ByteString

ToQuery InitiateJob

Defined in Network.AWS.Glacier.InitiateJob

Methods

toQuery :: InitiateJob -> QueryString

NFData InitiateJob

Defined in Network.AWS.Glacier.InitiateJob

Methods

rnf :: InitiateJob -> ()

type Rep InitiateJob

Defined in Network.AWS.Glacier.InitiateJob

type Rep InitiateJob = D1 (MetaData "InitiateJob" "Network.AWS.Glacier.InitiateJob" "amazonka-glacier-1.6.1-1jk94OYE8nZKrGhzWrcb8m" False) (C1 (MetaCons "InitiateJob'" PrefixI True) (S1 (MetaSel (Just "_ijJobParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe JobParameters)) :*: (S1 (MetaSel (Just "_ijAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_ijVaultName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs InitiateJob

Defined in Network.AWS.Glacier.InitiateJob

type Rs InitiateJob = InitiateJobResponse

Request Lenses

ijJobParameters :: Lens' InitiateJob (Maybe JobParameters)

Provides options for specifying job information.

ijAccountId :: Lens' InitiateJob Text

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '- ' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (-) in the ID.

ijVaultName :: Lens' InitiateJob Text

The name of the vault.

Destructuring the Response

initiateJobResponse

Arguments

:: Int

ijrsResponseStatus

-> InitiateJobResponse

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

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

• ijrsJobId - The ID of the job.
• ijrsJobOutputPath - The path to the location of where the select results are stored.
• ijrsLocation - The relative URI path of the job.
• ijrsResponseStatus - -- | The response status code.

data InitiateJobResponse

Contains the Amazon Glacier response to your request.

See: initiateJobResponse smart constructor.

Instances

Eq InitiateJobResponse

Defined in Network.AWS.Glacier.InitiateJob

Methods

(==) :: InitiateJobResponse -> InitiateJobResponse -> Bool

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

Data InitiateJobResponse

Defined in Network.AWS.Glacier.InitiateJob

Methods

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

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

toConstr :: InitiateJobResponse -> Constr

dataTypeOf :: InitiateJobResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read InitiateJobResponse

Defined in Network.AWS.Glacier.InitiateJob

Methods

readsPrec :: Int -> ReadS InitiateJobResponse

readList :: ReadS [InitiateJobResponse]

readPrec :: ReadPrec InitiateJobResponse

readListPrec :: ReadPrec [InitiateJobResponse]

Show InitiateJobResponse

Defined in Network.AWS.Glacier.InitiateJob

Methods

showsPrec :: Int -> InitiateJobResponse -> ShowS

show :: InitiateJobResponse -> String

showList :: [InitiateJobResponse] -> ShowS

Generic InitiateJobResponse

Defined in Network.AWS.Glacier.InitiateJob

Associated Types

type Rep InitiateJobResponse :: Type -> Type

Methods

from :: InitiateJobResponse -> Rep InitiateJobResponse x

to :: Rep InitiateJobResponse x -> InitiateJobResponse

NFData InitiateJobResponse

Defined in Network.AWS.Glacier.InitiateJob

Methods

rnf :: InitiateJobResponse -> ()

type Rep InitiateJobResponse

Defined in Network.AWS.Glacier.InitiateJob

type Rep InitiateJobResponse = D1 (MetaData "InitiateJobResponse" "Network.AWS.Glacier.InitiateJob" "amazonka-glacier-1.6.1-1jk94OYE8nZKrGhzWrcb8m" False) (C1 (MetaCons "InitiateJobResponse'" PrefixI True) ((S1 (MetaSel (Just "_ijrsJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ijrsJobOutputPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_ijrsLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ijrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

ijrsJobId :: Lens' InitiateJobResponse (Maybe Text)

The ID of the job.

ijrsJobOutputPath :: Lens' InitiateJobResponse (Maybe Text)

The path to the location of where the select results are stored.

ijrsLocation :: Lens' InitiateJobResponse (Maybe Text)

The relative URI path of the job.

ijrsResponseStatus :: Lens' InitiateJobResponse Int

• - | The response status code.