Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IoT.UpdateScheduledAudit

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a scheduled audit, including which checks are performed and how often the audit takes place.

Requires permission to access the UpdateScheduledAudit action.

Synopsis

data UpdateScheduledAudit = UpdateScheduledAudit' {
- dayOfMonth :: Maybe Text
- dayOfWeek :: Maybe DayOfWeek
- frequency :: Maybe AuditFrequency
- targetCheckNames :: Maybe [Text]
- scheduledAuditName :: Text
}
newUpdateScheduledAudit :: Text -> UpdateScheduledAudit
updateScheduledAudit_dayOfMonth :: Lens' UpdateScheduledAudit (Maybe Text)
updateScheduledAudit_dayOfWeek :: Lens' UpdateScheduledAudit (Maybe DayOfWeek)
updateScheduledAudit_frequency :: Lens' UpdateScheduledAudit (Maybe AuditFrequency)
updateScheduledAudit_targetCheckNames :: Lens' UpdateScheduledAudit (Maybe [Text])
updateScheduledAudit_scheduledAuditName :: Lens' UpdateScheduledAudit Text
data UpdateScheduledAuditResponse = UpdateScheduledAuditResponse' {
- scheduledAuditArn :: Maybe Text
- httpStatus :: Int
}
newUpdateScheduledAuditResponse :: Int -> UpdateScheduledAuditResponse
updateScheduledAuditResponse_scheduledAuditArn :: Lens' UpdateScheduledAuditResponse (Maybe Text)
updateScheduledAuditResponse_httpStatus :: Lens' UpdateScheduledAuditResponse Int

Creating a Request

data UpdateScheduledAudit Source #

See: newUpdateScheduledAudit smart constructor.

Constructors

UpdateScheduledAudit'

Fields

dayOfMonth :: Maybe Text
The day of the month on which the scheduled audit takes place. This can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY. If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
dayOfWeek :: Maybe DayOfWeek
The day of the week on which the scheduled audit takes place. This can be one of SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the "frequency" parameter is set to WEEKLY or BIWEEKLY.
frequency :: Maybe AuditFrequency
How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.
targetCheckNames :: Maybe [Text]
Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
scheduledAuditName :: Text
The name of the scheduled audit. (Max. 128 chars)

Instances

Instances details

ToJSON UpdateScheduledAudit Source #
Instance details Defined in Amazonka.IoT.UpdateScheduledAudit Methods toJSON :: UpdateScheduledAudit -> Value # toEncoding :: UpdateScheduledAudit -> Encoding # toJSONList :: [UpdateScheduledAudit] -> Value # toEncodingList :: [UpdateScheduledAudit] -> Encoding #
ToHeaders UpdateScheduledAudit Source #
Instance details Defined in Amazonka.IoT.UpdateScheduledAudit Methods toHeaders :: UpdateScheduledAudit -> [Header] #
ToPath UpdateScheduledAudit Source #
Instance details Defined in Amazonka.IoT.UpdateScheduledAudit Methods toPath :: UpdateScheduledAudit -> ByteString #
ToQuery UpdateScheduledAudit Source #
Instance details Defined in Amazonka.IoT.UpdateScheduledAudit Methods toQuery :: UpdateScheduledAudit -> QueryString #
AWSRequest UpdateScheduledAudit Source #
Instance details Defined in Amazonka.IoT.UpdateScheduledAudit Associated Types type AWSResponse UpdateScheduledAudit # Methods request :: (Service -> Service) -> UpdateScheduledAudit -> Request UpdateScheduledAudit # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateScheduledAudit -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateScheduledAudit))) #
Generic UpdateScheduledAudit Source #
Instance details Defined in Amazonka.IoT.UpdateScheduledAudit Associated Types type Rep UpdateScheduledAudit :: Type -> Type # Methods from :: UpdateScheduledAudit -> Rep UpdateScheduledAudit x # to :: Rep UpdateScheduledAudit x -> UpdateScheduledAudit #
Read UpdateScheduledAudit Source #
Instance details Defined in Amazonka.IoT.UpdateScheduledAudit Methods readsPrec :: Int -> ReadS UpdateScheduledAudit # readList :: ReadS [UpdateScheduledAudit] # readPrec :: ReadPrec UpdateScheduledAudit # readListPrec :: ReadPrec [UpdateScheduledAudit] #
Show UpdateScheduledAudit Source #
Instance details Defined in Amazonka.IoT.UpdateScheduledAudit Methods showsPrec :: Int -> UpdateScheduledAudit -> ShowS # show :: UpdateScheduledAudit -> String # showList :: [UpdateScheduledAudit] -> ShowS #
NFData UpdateScheduledAudit Source #
Instance details Defined in Amazonka.IoT.UpdateScheduledAudit Methods rnf :: UpdateScheduledAudit -> () #
Eq UpdateScheduledAudit Source #
Instance details Defined in Amazonka.IoT.UpdateScheduledAudit Methods (==) :: UpdateScheduledAudit -> UpdateScheduledAudit -> Bool # (/=) :: UpdateScheduledAudit -> UpdateScheduledAudit -> Bool #
Hashable UpdateScheduledAudit Source #
Instance details Defined in Amazonka.IoT.UpdateScheduledAudit Methods hashWithSalt :: Int -> UpdateScheduledAudit -> Int # hash :: UpdateScheduledAudit -> Int #
type AWSResponse UpdateScheduledAudit Source #
Instance details Defined in Amazonka.IoT.UpdateScheduledAudit type AWSResponse UpdateScheduledAudit = UpdateScheduledAuditResponse
type Rep UpdateScheduledAudit Source #
Instance details Defined in Amazonka.IoT.UpdateScheduledAudit type Rep UpdateScheduledAudit = D1 ('MetaData "UpdateScheduledAudit" "Amazonka.IoT.UpdateScheduledAudit" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "UpdateScheduledAudit'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dayOfMonth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dayOfWeek") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DayOfWeek))) :: (S1 ('MetaSel ('Just "frequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuditFrequency)) :: (S1 ('MetaSel ('Just "targetCheckNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "scheduledAuditName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateScheduledAudit Source #

Arguments

:: Text	`UpdateScheduledAudit`
-> UpdateScheduledAudit

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

UpdateScheduledAudit, updateScheduledAudit_dayOfMonth - The day of the month on which the scheduled audit takes place. This can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY. If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.

UpdateScheduledAudit, updateScheduledAudit_dayOfWeek - The day of the week on which the scheduled audit takes place. This can be one of SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the "frequency" parameter is set to WEEKLY or BIWEEKLY.

UpdateScheduledAudit, updateScheduledAudit_frequency - How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.

$sel:targetCheckNames:UpdateScheduledAudit', updateScheduledAudit_targetCheckNames - Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

UpdateScheduledAudit, updateScheduledAudit_scheduledAuditName - The name of the scheduled audit. (Max. 128 chars)

Request Lenses

updateScheduledAudit_dayOfMonth :: Lens' UpdateScheduledAudit (Maybe Text) Source #

The day of the month on which the scheduled audit takes place. This can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY. If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.

updateScheduledAudit_dayOfWeek :: Lens' UpdateScheduledAudit (Maybe DayOfWeek) Source #

The day of the week on which the scheduled audit takes place. This can be one of SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the "frequency" parameter is set to WEEKLY or BIWEEKLY.

updateScheduledAudit_frequency :: Lens' UpdateScheduledAudit (Maybe AuditFrequency) Source #

How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.

updateScheduledAudit_targetCheckNames :: Lens' UpdateScheduledAudit (Maybe [Text]) Source #

Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

updateScheduledAudit_scheduledAuditName :: Lens' UpdateScheduledAudit Text Source #

The name of the scheduled audit. (Max. 128 chars)

Destructuring the Response

data UpdateScheduledAuditResponse Source #

See: newUpdateScheduledAuditResponse smart constructor.

Constructors

UpdateScheduledAuditResponse'
Fields scheduledAuditArn :: Maybe Text The ARN of the scheduled audit. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateScheduledAuditResponse Source #
Instance details Defined in Amazonka.IoT.UpdateScheduledAudit Associated Types type Rep UpdateScheduledAuditResponse :: Type -> Type # Methods from :: UpdateScheduledAuditResponse -> Rep UpdateScheduledAuditResponse x # to :: Rep UpdateScheduledAuditResponse x -> UpdateScheduledAuditResponse #
Read UpdateScheduledAuditResponse Source #
Instance details Defined in Amazonka.IoT.UpdateScheduledAudit Methods readsPrec :: Int -> ReadS UpdateScheduledAuditResponse # readList :: ReadS [UpdateScheduledAuditResponse] # readPrec :: ReadPrec UpdateScheduledAuditResponse # readListPrec :: ReadPrec [UpdateScheduledAuditResponse] #
Show UpdateScheduledAuditResponse Source #
Instance details Defined in Amazonka.IoT.UpdateScheduledAudit Methods showsPrec :: Int -> UpdateScheduledAuditResponse -> ShowS # show :: UpdateScheduledAuditResponse -> String # showList :: [UpdateScheduledAuditResponse] -> ShowS #
NFData UpdateScheduledAuditResponse Source #
Instance details Defined in Amazonka.IoT.UpdateScheduledAudit Methods rnf :: UpdateScheduledAuditResponse -> () #
Eq UpdateScheduledAuditResponse Source #
Instance details Defined in Amazonka.IoT.UpdateScheduledAudit Methods (==) :: UpdateScheduledAuditResponse -> UpdateScheduledAuditResponse -> Bool # (/=) :: UpdateScheduledAuditResponse -> UpdateScheduledAuditResponse -> Bool #
type Rep UpdateScheduledAuditResponse Source #
Instance details Defined in Amazonka.IoT.UpdateScheduledAudit type Rep UpdateScheduledAuditResponse = D1 ('MetaData "UpdateScheduledAuditResponse" "Amazonka.IoT.UpdateScheduledAudit" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "UpdateScheduledAuditResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "scheduledAuditArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateScheduledAuditResponse Source #

Arguments

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

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

UpdateScheduledAuditResponse, updateScheduledAuditResponse_scheduledAuditArn - The ARN of the scheduled audit.

$sel:httpStatus:UpdateScheduledAuditResponse', updateScheduledAuditResponse_httpStatus - The response's http status code.

Response Lenses

updateScheduledAuditResponse_scheduledAuditArn :: Lens' UpdateScheduledAuditResponse (Maybe Text) Source #

The ARN of the scheduled audit.

updateScheduledAuditResponse_httpStatus :: Lens' UpdateScheduledAuditResponse Int Source #

The response's http status code.