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

Amazonka.Glacier.InitiateJob

Description

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.

Synopsis

Creating a Request

data InitiateJob Source #

Provides options for initiating an Amazon S3 Glacier job.

See: newInitiateJob smart constructor.

Constructors

InitiateJob' 

Fields

  • jobParameters :: Maybe JobParameters

    Provides options for specifying job information.

  • accountId :: 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 S3 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.

  • vaultName :: Text

    The name of the vault.

Instances

Instances details
Eq InitiateJob Source # 
Instance details

Defined in Amazonka.Glacier.InitiateJob

Methods

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

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

Read InitiateJob Source # 
Instance details

Defined in Amazonka.Glacier.InitiateJob

Methods

readsPrec :: Int -> ReadS InitiateJob #

readList :: ReadS [InitiateJob] #

readPrec :: ReadPrec InitiateJob #

readListPrec :: ReadPrec [InitiateJob] #

Show InitiateJob Source # 
Instance details

Defined in Amazonka.Glacier.InitiateJob

Methods

showsPrec :: Int -> InitiateJob -> ShowS #

show :: InitiateJob -> String #

showList :: [InitiateJob] -> ShowS #

Generic InitiateJob Source # 
Instance details

Defined in Amazonka.Glacier.InitiateJob

Associated Types

type Rep InitiateJob :: Type -> Type #

Methods

from :: InitiateJob -> Rep InitiateJob x #

to :: Rep InitiateJob x -> InitiateJob #

NFData InitiateJob Source # 
Instance details

Defined in Amazonka.Glacier.InitiateJob

Methods

rnf :: InitiateJob -> () #

Hashable InitiateJob Source # 
Instance details

Defined in Amazonka.Glacier.InitiateJob

Methods

hashWithSalt :: Int -> InitiateJob -> Int #

hash :: InitiateJob -> Int #

ToJSON InitiateJob Source # 
Instance details

Defined in Amazonka.Glacier.InitiateJob

Methods

toJSON :: InitiateJob -> Value #

toEncoding :: InitiateJob -> Encoding #

toJSONList :: [InitiateJob] -> Value #

toEncodingList :: [InitiateJob] -> Encoding #

AWSRequest InitiateJob Source # 
Instance details

Defined in Amazonka.Glacier.InitiateJob

Associated Types

type AWSResponse InitiateJob #

Methods

request :: InitiateJob -> Request InitiateJob #

response :: MonadResource m => Logger -> Service -> Proxy InitiateJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse InitiateJob))) #

ToHeaders InitiateJob Source # 
Instance details

Defined in Amazonka.Glacier.InitiateJob

Methods

toHeaders :: InitiateJob -> [Header] #

ToPath InitiateJob Source # 
Instance details

Defined in Amazonka.Glacier.InitiateJob

Methods

toPath :: InitiateJob -> ByteString #

ToQuery InitiateJob Source # 
Instance details

Defined in Amazonka.Glacier.InitiateJob

Methods

toQuery :: InitiateJob -> QueryString #

type Rep InitiateJob Source # 
Instance details

Defined in Amazonka.Glacier.InitiateJob

type Rep InitiateJob = D1 ('MetaData "InitiateJob" "Amazonka.Glacier.InitiateJob" "libZSservicesZSamazonka-glacierZSamazonka-glacier" 'False) (C1 ('MetaCons "InitiateJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobParameters)) :*: (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "vaultName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse InitiateJob Source # 
Instance details

Defined in Amazonka.Glacier.InitiateJob

type AWSResponse InitiateJob = InitiateJobResponse

newInitiateJob Source #

Arguments

:: Text

$sel:accountId:InitiateJob'

-> Text

$sel:vaultName:InitiateJob'

-> InitiateJob 

Create a value of InitiateJob 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:jobParameters:InitiateJob', initiateJob_jobParameters - Provides options for specifying job information.

$sel:accountId:InitiateJob', initiateJob_accountId - 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 S3 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.

$sel:vaultName:InitiateJob', initiateJob_vaultName - The name of the vault.

Request Lenses

initiateJob_jobParameters :: Lens' InitiateJob (Maybe JobParameters) Source #

Provides options for specifying job information.

initiateJob_accountId :: Lens' InitiateJob Text Source #

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

initiateJob_vaultName :: Lens' InitiateJob Text Source #

The name of the vault.

Destructuring the Response

data InitiateJobResponse Source #

Contains the Amazon S3 Glacier response to your request.

See: newInitiateJobResponse smart constructor.

Constructors

InitiateJobResponse' 

Fields

Instances

Instances details
Eq InitiateJobResponse Source # 
Instance details

Defined in Amazonka.Glacier.InitiateJob

Methods

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

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

Read InitiateJobResponse Source # 
Instance details

Defined in Amazonka.Glacier.InitiateJob

Methods

readsPrec :: Int -> ReadS InitiateJobResponse #

readList :: ReadS [InitiateJobResponse] #

readPrec :: ReadPrec InitiateJobResponse #

readListPrec :: ReadPrec [InitiateJobResponse] #

Show InitiateJobResponse Source # 
Instance details

Defined in Amazonka.Glacier.InitiateJob

Methods

showsPrec :: Int -> InitiateJobResponse -> ShowS #

show :: InitiateJobResponse -> String #

showList :: [InitiateJobResponse] -> ShowS #

Generic InitiateJobResponse Source # 
Instance details

Defined in Amazonka.Glacier.InitiateJob

Associated Types

type Rep InitiateJobResponse :: Type -> Type #

Methods

from :: InitiateJobResponse -> Rep InitiateJobResponse x #

to :: Rep InitiateJobResponse x -> InitiateJobResponse #

NFData InitiateJobResponse Source # 
Instance details

Defined in Amazonka.Glacier.InitiateJob

Methods

rnf :: InitiateJobResponse -> () #

type Rep InitiateJobResponse Source # 
Instance details

Defined in Amazonka.Glacier.InitiateJob

type Rep InitiateJobResponse = D1 ('MetaData "InitiateJobResponse" "Amazonka.Glacier.InitiateJob" "libZSservicesZSamazonka-glacierZSamazonka-glacier" 'False) (C1 ('MetaCons "InitiateJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobOutputPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newInitiateJobResponse Source #

Arguments

:: Int

$sel:httpStatus:InitiateJobResponse'

-> InitiateJobResponse 

Create a value of InitiateJobResponse 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:jobId:InitiateJobResponse', initiateJobResponse_jobId - The ID of the job.

$sel:jobOutputPath:InitiateJobResponse', initiateJobResponse_jobOutputPath - The path to the location of where the select results are stored.

$sel:location:InitiateJobResponse', initiateJobResponse_location - The relative URI path of the job.

$sel:httpStatus:InitiateJobResponse', initiateJobResponse_httpStatus - The response's http status code.

Response Lenses

initiateJobResponse_jobId :: Lens' InitiateJobResponse (Maybe Text) Source #

The ID of the job.

initiateJobResponse_jobOutputPath :: Lens' InitiateJobResponse (Maybe Text) Source #

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

initiateJobResponse_location :: Lens' InitiateJobResponse (Maybe Text) Source #

The relative URI path of the job.

initiateJobResponse_httpStatus :: Lens' InitiateJobResponse Int Source #

The response's http status code.