Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.MacieV2.UpdateClassificationJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Changes the status of a classification job.

Creating a Request

data UpdateClassificationJob Source #

See: newUpdateClassificationJob smart constructor.

Constructors

UpdateClassificationJob'

Fields

jobId :: Text
The unique identifier for the classification job.
jobStatus :: JobStatus
The new status for the job. Valid values are:
- CANCELLED - Stops the job permanently and cancels it. This value is valid only if the job's current status is IDLE, PAUSED, RUNNING, or USER_PAUSED.
  If you specify this value and the job's current status is RUNNING, Amazon Macie immediately begins to stop all processing tasks for the job. You can't resume or restart a job after you cancel it.
- RUNNING - Resumes the job. This value is valid only if the job's current status is USER_PAUSED.
  If you paused the job while it was actively running and you specify this value less than 30 days after you paused the job, Macie immediately resumes processing from the point where you paused the job. Otherwise, Macie resumes the job according to the schedule and other settings for the job.
- USER_PAUSED - Pauses the job temporarily. This value is valid only if the job's current status is IDLE, PAUSED, or RUNNING. If you specify this value and the job's current status is RUNNING, Macie immediately begins to pause all processing tasks for the job.
  If you pause a one-time job and you don't resume it within 30 days, the job expires and Macie cancels the job. If you pause a recurring job when its status is RUNNING and you don't resume it within 30 days, the job run expires and Macie cancels the run. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

Instances

Instances details

Eq UpdateClassificationJob Source #
Instance details Defined in Amazonka.MacieV2.UpdateClassificationJob Methods (==) :: UpdateClassificationJob -> UpdateClassificationJob -> Bool # (/=) :: UpdateClassificationJob -> UpdateClassificationJob -> Bool #
Read UpdateClassificationJob Source #
Instance details Defined in Amazonka.MacieV2.UpdateClassificationJob Methods readsPrec :: Int -> ReadS UpdateClassificationJob # readList :: ReadS [UpdateClassificationJob] # readPrec :: ReadPrec UpdateClassificationJob # readListPrec :: ReadPrec [UpdateClassificationJob] #
Show UpdateClassificationJob Source #
Instance details Defined in Amazonka.MacieV2.UpdateClassificationJob Methods showsPrec :: Int -> UpdateClassificationJob -> ShowS # show :: UpdateClassificationJob -> String # showList :: [UpdateClassificationJob] -> ShowS #
Generic UpdateClassificationJob Source #
Instance details Defined in Amazonka.MacieV2.UpdateClassificationJob Associated Types type Rep UpdateClassificationJob :: Type -> Type # Methods from :: UpdateClassificationJob -> Rep UpdateClassificationJob x # to :: Rep UpdateClassificationJob x -> UpdateClassificationJob #
NFData UpdateClassificationJob Source #
Instance details Defined in Amazonka.MacieV2.UpdateClassificationJob Methods rnf :: UpdateClassificationJob -> () #
Hashable UpdateClassificationJob Source #
Instance details Defined in Amazonka.MacieV2.UpdateClassificationJob Methods hashWithSalt :: Int -> UpdateClassificationJob -> Int # hash :: UpdateClassificationJob -> Int #
ToJSON UpdateClassificationJob Source #
Instance details Defined in Amazonka.MacieV2.UpdateClassificationJob Methods toJSON :: UpdateClassificationJob -> Value # toEncoding :: UpdateClassificationJob -> Encoding # toJSONList :: [UpdateClassificationJob] -> Value # toEncodingList :: [UpdateClassificationJob] -> Encoding #
AWSRequest UpdateClassificationJob Source #
Instance details Defined in Amazonka.MacieV2.UpdateClassificationJob Associated Types type AWSResponse UpdateClassificationJob # Methods request :: UpdateClassificationJob -> Request UpdateClassificationJob # response :: MonadResource m => Logger -> Service -> Proxy UpdateClassificationJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateClassificationJob))) #
ToHeaders UpdateClassificationJob Source #
Instance details Defined in Amazonka.MacieV2.UpdateClassificationJob Methods toHeaders :: UpdateClassificationJob -> [Header] #
ToPath UpdateClassificationJob Source #
Instance details Defined in Amazonka.MacieV2.UpdateClassificationJob Methods toPath :: UpdateClassificationJob -> ByteString #
ToQuery UpdateClassificationJob Source #
Instance details Defined in Amazonka.MacieV2.UpdateClassificationJob Methods toQuery :: UpdateClassificationJob -> QueryString #
type Rep UpdateClassificationJob Source #
Instance details Defined in Amazonka.MacieV2.UpdateClassificationJob type Rep UpdateClassificationJob = D1 ('MetaData "UpdateClassificationJob" "Amazonka.MacieV2.UpdateClassificationJob" "libZSservicesZSamazonka-maciev2ZSamazonka-maciev2" 'False) (C1 ('MetaCons "UpdateClassificationJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "jobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobStatus)))
type AWSResponse UpdateClassificationJob Source #
Instance details Defined in Amazonka.MacieV2.UpdateClassificationJob type AWSResponse UpdateClassificationJob = UpdateClassificationJobResponse

newUpdateClassificationJob Source #

Arguments

:: Text	`$sel:jobId:UpdateClassificationJob'`
-> JobStatus	`$sel:jobStatus:UpdateClassificationJob'`
-> UpdateClassificationJob

Create a value of UpdateClassificationJob 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:UpdateClassificationJob', updateClassificationJob_jobId - The unique identifier for the classification job.

$sel:jobStatus:UpdateClassificationJob', updateClassificationJob_jobStatus - The new status for the job. Valid values are:

CANCELLED - Stops the job permanently and cancels it. This value is valid only if the job's current status is IDLE, PAUSED, RUNNING, or USER_PAUSED.
If you specify this value and the job's current status is RUNNING, Amazon Macie immediately begins to stop all processing tasks for the job. You can't resume or restart a job after you cancel it.
RUNNING - Resumes the job. This value is valid only if the job's current status is USER_PAUSED.
If you paused the job while it was actively running and you specify this value less than 30 days after you paused the job, Macie immediately resumes processing from the point where you paused the job. Otherwise, Macie resumes the job according to the schedule and other settings for the job.
USER_PAUSED - Pauses the job temporarily. This value is valid only if the job's current status is IDLE, PAUSED, or RUNNING. If you specify this value and the job's current status is RUNNING, Macie immediately begins to pause all processing tasks for the job.
If you pause a one-time job and you don't resume it within 30 days, the job expires and Macie cancels the job. If you pause a recurring job when its status is RUNNING and you don't resume it within 30 days, the job run expires and Macie cancels the run. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

Request Lenses

updateClassificationJob_jobId :: Lens' UpdateClassificationJob Text Source #

The unique identifier for the classification job.

updateClassificationJob_jobStatus :: Lens' UpdateClassificationJob JobStatus Source #

The new status for the job. Valid values are:

CANCELLED - Stops the job permanently and cancels it. This value is valid only if the job's current status is IDLE, PAUSED, RUNNING, or USER_PAUSED.
If you specify this value and the job's current status is RUNNING, Amazon Macie immediately begins to stop all processing tasks for the job. You can't resume or restart a job after you cancel it.
RUNNING - Resumes the job. This value is valid only if the job's current status is USER_PAUSED.
If you paused the job while it was actively running and you specify this value less than 30 days after you paused the job, Macie immediately resumes processing from the point where you paused the job. Otherwise, Macie resumes the job according to the schedule and other settings for the job.
USER_PAUSED - Pauses the job temporarily. This value is valid only if the job's current status is IDLE, PAUSED, or RUNNING. If you specify this value and the job's current status is RUNNING, Macie immediately begins to pause all processing tasks for the job.
If you pause a one-time job and you don't resume it within 30 days, the job expires and Macie cancels the job. If you pause a recurring job when its status is RUNNING and you don't resume it within 30 days, the job run expires and Macie cancels the run. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

Destructuring the Response

data UpdateClassificationJobResponse Source #

See: newUpdateClassificationJobResponse smart constructor.

Constructors

UpdateClassificationJobResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Eq UpdateClassificationJobResponse Source #
Instance details Defined in Amazonka.MacieV2.UpdateClassificationJob Methods (==) :: UpdateClassificationJobResponse -> UpdateClassificationJobResponse -> Bool # (/=) :: UpdateClassificationJobResponse -> UpdateClassificationJobResponse -> Bool #
Read UpdateClassificationJobResponse Source #
Instance details Defined in Amazonka.MacieV2.UpdateClassificationJob Methods readsPrec :: Int -> ReadS UpdateClassificationJobResponse # readList :: ReadS [UpdateClassificationJobResponse] # readPrec :: ReadPrec UpdateClassificationJobResponse # readListPrec :: ReadPrec [UpdateClassificationJobResponse] #
Show UpdateClassificationJobResponse Source #
Instance details Defined in Amazonka.MacieV2.UpdateClassificationJob Methods showsPrec :: Int -> UpdateClassificationJobResponse -> ShowS # show :: UpdateClassificationJobResponse -> String # showList :: [UpdateClassificationJobResponse] -> ShowS #
Generic UpdateClassificationJobResponse Source #
Instance details Defined in Amazonka.MacieV2.UpdateClassificationJob Associated Types type Rep UpdateClassificationJobResponse :: Type -> Type # Methods from :: UpdateClassificationJobResponse -> Rep UpdateClassificationJobResponse x # to :: Rep UpdateClassificationJobResponse x -> UpdateClassificationJobResponse #
NFData UpdateClassificationJobResponse Source #
Instance details Defined in Amazonka.MacieV2.UpdateClassificationJob Methods rnf :: UpdateClassificationJobResponse -> () #
type Rep UpdateClassificationJobResponse Source #
Instance details Defined in Amazonka.MacieV2.UpdateClassificationJob type Rep UpdateClassificationJobResponse = D1 ('MetaData "UpdateClassificationJobResponse" "Amazonka.MacieV2.UpdateClassificationJob" "libZSservicesZSamazonka-maciev2ZSamazonka-maciev2" 'False) (C1 ('MetaCons "UpdateClassificationJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateClassificationJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateClassificationJobResponse'`
-> UpdateClassificationJobResponse

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

Response Lenses

updateClassificationJobResponse_httpStatus :: Lens' UpdateClassificationJobResponse Int Source #

The response's http status code.