libZSservicesZSamazonka-iotZSamazonka-iot
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.IoT.UpdateAccountAuditConfiguration

Description

Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.

Requires permission to access the UpdateAccountAuditConfiguration action.

Synopsis

Creating a Request

data UpdateAccountAuditConfiguration Source #

See: newUpdateAccountAuditConfiguration smart constructor.

Constructors

UpdateAccountAuditConfiguration' 

Fields

  • auditCheckConfigurations :: Maybe (HashMap Text AuditCheckConfiguration)

    Specifies which audit checks are enabled and disabled for this account. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are currently enabled.

    Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted.

    You cannot disable a check if it's used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself.

    On the first call to UpdateAccountAuditConfiguration, this parameter is required and must specify at least one enabled check.

  • auditNotificationTargetConfigurations :: Maybe (HashMap AuditNotificationType AuditNotificationTarget)

    Information about the targets to which audit notifications are sent.

  • roleArn :: Maybe Text

    The Amazon Resource Name (ARN) of the role that grants permission to IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.

Instances

Instances details
Eq UpdateAccountAuditConfiguration Source # 
Instance details

Defined in Amazonka.IoT.UpdateAccountAuditConfiguration

Read UpdateAccountAuditConfiguration Source # 
Instance details

Defined in Amazonka.IoT.UpdateAccountAuditConfiguration

Show UpdateAccountAuditConfiguration Source # 
Instance details

Defined in Amazonka.IoT.UpdateAccountAuditConfiguration

Generic UpdateAccountAuditConfiguration Source # 
Instance details

Defined in Amazonka.IoT.UpdateAccountAuditConfiguration

Associated Types

type Rep UpdateAccountAuditConfiguration :: Type -> Type #

NFData UpdateAccountAuditConfiguration Source # 
Instance details

Defined in Amazonka.IoT.UpdateAccountAuditConfiguration

Hashable UpdateAccountAuditConfiguration Source # 
Instance details

Defined in Amazonka.IoT.UpdateAccountAuditConfiguration

ToJSON UpdateAccountAuditConfiguration Source # 
Instance details

Defined in Amazonka.IoT.UpdateAccountAuditConfiguration

AWSRequest UpdateAccountAuditConfiguration Source # 
Instance details

Defined in Amazonka.IoT.UpdateAccountAuditConfiguration

ToHeaders UpdateAccountAuditConfiguration Source # 
Instance details

Defined in Amazonka.IoT.UpdateAccountAuditConfiguration

ToPath UpdateAccountAuditConfiguration Source # 
Instance details

Defined in Amazonka.IoT.UpdateAccountAuditConfiguration

ToQuery UpdateAccountAuditConfiguration Source # 
Instance details

Defined in Amazonka.IoT.UpdateAccountAuditConfiguration

type Rep UpdateAccountAuditConfiguration Source # 
Instance details

Defined in Amazonka.IoT.UpdateAccountAuditConfiguration

type Rep UpdateAccountAuditConfiguration = D1 ('MetaData "UpdateAccountAuditConfiguration" "Amazonka.IoT.UpdateAccountAuditConfiguration" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "UpdateAccountAuditConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "auditCheckConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text AuditCheckConfiguration))) :*: (S1 ('MetaSel ('Just "auditNotificationTargetConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap AuditNotificationType AuditNotificationTarget))) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))
type AWSResponse UpdateAccountAuditConfiguration Source # 
Instance details

Defined in Amazonka.IoT.UpdateAccountAuditConfiguration

newUpdateAccountAuditConfiguration :: UpdateAccountAuditConfiguration Source #

Create a value of UpdateAccountAuditConfiguration 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:auditCheckConfigurations:UpdateAccountAuditConfiguration', updateAccountAuditConfiguration_auditCheckConfigurations - Specifies which audit checks are enabled and disabled for this account. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are currently enabled.

Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted.

You cannot disable a check if it's used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself.

On the first call to UpdateAccountAuditConfiguration, this parameter is required and must specify at least one enabled check.

$sel:auditNotificationTargetConfigurations:UpdateAccountAuditConfiguration', updateAccountAuditConfiguration_auditNotificationTargetConfigurations - Information about the targets to which audit notifications are sent.

$sel:roleArn:UpdateAccountAuditConfiguration', updateAccountAuditConfiguration_roleArn - The Amazon Resource Name (ARN) of the role that grants permission to IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.

Request Lenses

updateAccountAuditConfiguration_auditCheckConfigurations :: Lens' UpdateAccountAuditConfiguration (Maybe (HashMap Text AuditCheckConfiguration)) Source #

Specifies which audit checks are enabled and disabled for this account. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are currently enabled.

Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted.

You cannot disable a check if it's used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself.

On the first call to UpdateAccountAuditConfiguration, this parameter is required and must specify at least one enabled check.

updateAccountAuditConfiguration_roleArn :: Lens' UpdateAccountAuditConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) of the role that grants permission to IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.

Destructuring the Response

data UpdateAccountAuditConfigurationResponse Source #

Constructors

UpdateAccountAuditConfigurationResponse' 

Fields

Instances

Instances details
Eq UpdateAccountAuditConfigurationResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateAccountAuditConfiguration

Read UpdateAccountAuditConfigurationResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateAccountAuditConfiguration

Show UpdateAccountAuditConfigurationResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateAccountAuditConfiguration

Generic UpdateAccountAuditConfigurationResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateAccountAuditConfiguration

NFData UpdateAccountAuditConfigurationResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateAccountAuditConfiguration

type Rep UpdateAccountAuditConfigurationResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateAccountAuditConfiguration

type Rep UpdateAccountAuditConfigurationResponse = D1 ('MetaData "UpdateAccountAuditConfigurationResponse" "Amazonka.IoT.UpdateAccountAuditConfiguration" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "UpdateAccountAuditConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateAccountAuditConfigurationResponse Source #

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

Response Lenses