Amazonka.Snowball.CancelJob

Cancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action returns a job's JobState as part of the response element data returned.

Creating a Request

data CancelJob

See: newCancelJob smart constructor.

Constructors

CancelJob'

Fields

• jobId :: Text

  The 39-character job ID for the job that you want to cancel, for example JID123e4567-e89b-12d3-a456-426655440000.

Instances

ToJSON CancelJob

Defined in Amazonka.Snowball.CancelJob

Methods

toJSON :: CancelJob -> Value

toEncoding :: CancelJob -> Encoding

toJSONList :: [CancelJob] -> Value

toEncodingList :: [CancelJob] -> Encoding

ToHeaders CancelJob

Defined in Amazonka.Snowball.CancelJob

Methods

toHeaders :: CancelJob -> [Header]

ToPath CancelJob

Defined in Amazonka.Snowball.CancelJob

Methods

toPath :: CancelJob -> ByteString

ToQuery CancelJob

Defined in Amazonka.Snowball.CancelJob

Methods

toQuery :: CancelJob -> QueryString

AWSRequest CancelJob

Defined in Amazonka.Snowball.CancelJob

Associated Types

type AWSResponse CancelJob

Methods

request :: (Service -> Service) -> CancelJob -> Request CancelJob

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CancelJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CancelJob)))

Generic CancelJob

Defined in Amazonka.Snowball.CancelJob

Associated Types

type Rep CancelJob :: Type -> Type

Methods

from :: CancelJob -> Rep CancelJob x

to :: Rep CancelJob x -> CancelJob

Read CancelJob

Defined in Amazonka.Snowball.CancelJob

Methods

readsPrec :: Int -> ReadS CancelJob

readList :: ReadS [CancelJob]

readPrec :: ReadPrec CancelJob

readListPrec :: ReadPrec [CancelJob]

Show CancelJob

Defined in Amazonka.Snowball.CancelJob

Methods

showsPrec :: Int -> CancelJob -> ShowS

show :: CancelJob -> String

showList :: [CancelJob] -> ShowS

NFData CancelJob

Defined in Amazonka.Snowball.CancelJob

Methods

rnf :: CancelJob -> ()

Eq CancelJob

Defined in Amazonka.Snowball.CancelJob

Methods

(==) :: CancelJob -> CancelJob -> Bool

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

Hashable CancelJob

Defined in Amazonka.Snowball.CancelJob

Methods

hashWithSalt :: Int -> CancelJob -> Int

hash :: CancelJob -> Int

type AWSResponse CancelJob

Defined in Amazonka.Snowball.CancelJob

type AWSResponse CancelJob = CancelJobResponse

type Rep CancelJob

Defined in Amazonka.Snowball.CancelJob

type Rep CancelJob = D1 ('MetaData "CancelJob" "Amazonka.Snowball.CancelJob" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "CancelJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCancelJob

Arguments

:: Text

CancelJob

-> CancelJob

Create a value of CancelJob 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:

CancelJob, cancelJob_jobId - The 39-character job ID for the job that you want to cancel, for example JID123e4567-e89b-12d3-a456-426655440000.

Request Lenses

cancelJob_jobId :: Lens' CancelJob Text

The 39-character job ID for the job that you want to cancel, for example JID123e4567-e89b-12d3-a456-426655440000.

Destructuring the Response

data CancelJobResponse

See: newCancelJobResponse smart constructor.

Constructors

CancelJobResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic CancelJobResponse

Defined in Amazonka.Snowball.CancelJob

Associated Types

type Rep CancelJobResponse :: Type -> Type

Methods

from :: CancelJobResponse -> Rep CancelJobResponse x

to :: Rep CancelJobResponse x -> CancelJobResponse

Read CancelJobResponse

Defined in Amazonka.Snowball.CancelJob

Methods

readsPrec :: Int -> ReadS CancelJobResponse

readList :: ReadS [CancelJobResponse]

readPrec :: ReadPrec CancelJobResponse

readListPrec :: ReadPrec [CancelJobResponse]

Show CancelJobResponse

Defined in Amazonka.Snowball.CancelJob

Methods

showsPrec :: Int -> CancelJobResponse -> ShowS

show :: CancelJobResponse -> String

showList :: [CancelJobResponse] -> ShowS

NFData CancelJobResponse

Defined in Amazonka.Snowball.CancelJob

Methods

rnf :: CancelJobResponse -> ()

Eq CancelJobResponse

Defined in Amazonka.Snowball.CancelJob

Methods

(==) :: CancelJobResponse -> CancelJobResponse -> Bool

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

type Rep CancelJobResponse

Defined in Amazonka.Snowball.CancelJob

type Rep CancelJobResponse = D1 ('MetaData "CancelJobResponse" "Amazonka.Snowball.CancelJob" "amazonka-snowball-2.0-6vnXQdr1CFv4zLyXDWX7zH" 'False) (C1 ('MetaCons "CancelJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCancelJobResponse

Arguments

:: Int

$sel:httpStatus:CancelJobResponse'

-> CancelJobResponse

Create a value of CancelJobResponse 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:CancelJobResponse', cancelJobResponse_httpStatus - The response's http status code.

Response Lenses

cancelJobResponse_httpStatus :: Lens' CancelJobResponse Int

The response's http status code.