amazonka-securitylake-2.0: Amazon Security Lake SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SecurityLake.DeleteAwsLogSource

Description

Removes a natively supported Amazon Web Service as an Amazon Security Lake source. When you remove the source, Security Lake stops collecting data from that source, and subscribers can no longer consume new data from the source. Subscribers can still consume data that Security Lake collected from the source before disablement.

You can choose any source type in any Amazon Web Services Region for either accounts that are part of a trusted organization or standalone accounts. At least one of the three dimensions is a mandatory input to this API. However, you can supply any combination of the three dimensions to this API.

By default, a dimension refers to the entire set. This is overridden when you supply any one of the inputs. For instance, when you do not specify members, the API disables all Security Lake member accounts for sources. Similarly, when you do not specify Regions, Security Lake is disabled for all the Regions where Security Lake is available as a service.

When you don't provide a dimension, Security Lake assumes that the missing dimension refers to the entire set. For example, if you don't provide specific accounts, the API applies to the entire set of accounts in your organization.

Synopsis

Creating a Request

data DeleteAwsLogSource Source #

See: newDeleteAwsLogSource smart constructor.

Constructors

DeleteAwsLogSource' 

Fields

Instances

Instances details
ToJSON DeleteAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.DeleteAwsLogSource

ToHeaders DeleteAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.DeleteAwsLogSource

ToPath DeleteAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.DeleteAwsLogSource

ToQuery DeleteAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.DeleteAwsLogSource

AWSRequest DeleteAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.DeleteAwsLogSource

Associated Types

type AWSResponse DeleteAwsLogSource #

Generic DeleteAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.DeleteAwsLogSource

Associated Types

type Rep DeleteAwsLogSource :: Type -> Type #

Read DeleteAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.DeleteAwsLogSource

Show DeleteAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.DeleteAwsLogSource

NFData DeleteAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.DeleteAwsLogSource

Methods

rnf :: DeleteAwsLogSource -> () #

Eq DeleteAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.DeleteAwsLogSource

Hashable DeleteAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.DeleteAwsLogSource

type AWSResponse DeleteAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.DeleteAwsLogSource

type Rep DeleteAwsLogSource Source # 
Instance details

Defined in Amazonka.SecurityLake.DeleteAwsLogSource

type Rep DeleteAwsLogSource = D1 ('MetaData "DeleteAwsLogSource" "Amazonka.SecurityLake.DeleteAwsLogSource" "amazonka-securitylake-2.0-4WRm07ESU278sNrKhxoCOb" 'False) (C1 ('MetaCons "DeleteAwsLogSource'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "disableAllDimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (HashMap Text [Text])))) :*: S1 ('MetaSel ('Just "disableSingleDimension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "disableTwoDimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: S1 ('MetaSel ('Just "inputOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Dimension]))))

newDeleteAwsLogSource :: DeleteAwsLogSource Source #

Create a value of DeleteAwsLogSource 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:disableAllDimensions:DeleteAwsLogSource', deleteAwsLogSource_disableAllDimensions - Removes the specific Amazon Web Services sources from specific accounts and specific Regions.

$sel:disableSingleDimension:DeleteAwsLogSource', deleteAwsLogSource_disableSingleDimension - Removes all Amazon Web Services sources from specific accounts or Regions.

$sel:disableTwoDimensions:DeleteAwsLogSource', deleteAwsLogSource_disableTwoDimensions - Remove a specific Amazon Web Services source from specific accounts or Regions.

$sel:inputOrder:DeleteAwsLogSource', deleteAwsLogSource_inputOrder - This is a mandatory input. Specify the input order to disable dimensions in Security Lake, namely Region (Amazon Web Services Region code, source type, and member (account ID of a specific Amazon Web Services account).

Request Lenses

deleteAwsLogSource_disableAllDimensions :: Lens' DeleteAwsLogSource (Maybe (HashMap Text (HashMap Text [Text]))) Source #

Removes the specific Amazon Web Services sources from specific accounts and specific Regions.

deleteAwsLogSource_disableSingleDimension :: Lens' DeleteAwsLogSource (Maybe [Text]) Source #

Removes all Amazon Web Services sources from specific accounts or Regions.

deleteAwsLogSource_disableTwoDimensions :: Lens' DeleteAwsLogSource (Maybe (HashMap Text [Text])) Source #

Remove a specific Amazon Web Services source from specific accounts or Regions.

deleteAwsLogSource_inputOrder :: Lens' DeleteAwsLogSource [Dimension] Source #

This is a mandatory input. Specify the input order to disable dimensions in Security Lake, namely Region (Amazon Web Services Region code, source type, and member (account ID of a specific Amazon Web Services account).

Destructuring the Response

data DeleteAwsLogSourceResponse Source #

See: newDeleteAwsLogSourceResponse smart constructor.

Constructors

DeleteAwsLogSourceResponse' 

Fields

  • failed :: Maybe [Text]

    Deletion of the Amazon Web Services sources failed as the account is not a part of the organization.

  • processing :: Maybe [Text]

    Deletion of the Amazon Web Services sources is in progress.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DeleteAwsLogSourceResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.DeleteAwsLogSource

Associated Types

type Rep DeleteAwsLogSourceResponse :: Type -> Type #

Read DeleteAwsLogSourceResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.DeleteAwsLogSource

Show DeleteAwsLogSourceResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.DeleteAwsLogSource

NFData DeleteAwsLogSourceResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.DeleteAwsLogSource

Eq DeleteAwsLogSourceResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.DeleteAwsLogSource

type Rep DeleteAwsLogSourceResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.DeleteAwsLogSource

type Rep DeleteAwsLogSourceResponse = D1 ('MetaData "DeleteAwsLogSourceResponse" "Amazonka.SecurityLake.DeleteAwsLogSource" "amazonka-securitylake-2.0-4WRm07ESU278sNrKhxoCOb" 'False) (C1 ('MetaCons "DeleteAwsLogSourceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "processing") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDeleteAwsLogSourceResponse Source #

Create a value of DeleteAwsLogSourceResponse 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:failed:DeleteAwsLogSourceResponse', deleteAwsLogSourceResponse_failed - Deletion of the Amazon Web Services sources failed as the account is not a part of the organization.

$sel:processing:DeleteAwsLogSourceResponse', deleteAwsLogSourceResponse_processing - Deletion of the Amazon Web Services sources is in progress.

$sel:httpStatus:DeleteAwsLogSourceResponse', deleteAwsLogSourceResponse_httpStatus - The response's http status code.

Response Lenses

deleteAwsLogSourceResponse_failed :: Lens' DeleteAwsLogSourceResponse (Maybe [Text]) Source #

Deletion of the Amazon Web Services sources failed as the account is not a part of the organization.

deleteAwsLogSourceResponse_processing :: Lens' DeleteAwsLogSourceResponse (Maybe [Text]) Source #

Deletion of the Amazon Web Services sources is in progress.