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.GetDatalakeStatus

Description

Retrieves a snapshot of the current Region, including whether Amazon Security Lake is enabled for those accounts and which sources Security Lake is collecting data from.

This operation returns paginated results.

Synopsis

Creating a Request

data GetDatalakeStatus Source #

See: newGetDatalakeStatus smart constructor.

Constructors

GetDatalakeStatus' 

Fields

  • accountSet :: Maybe [Text]

    The Amazon Web Services account ID for which a static snapshot of the current Amazon Web Services Region, including enabled accounts and log sources, is retrieved.

  • maxAccountResults :: Maybe Int

    The maximum limit of accounts for which the static snapshot of the current Region, including enabled accounts and log sources, is retrieved.

  • nextToken :: Maybe Text

    Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.

    Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Instances

Instances details
ToJSON GetDatalakeStatus Source # 
Instance details

Defined in Amazonka.SecurityLake.GetDatalakeStatus

ToHeaders GetDatalakeStatus Source # 
Instance details

Defined in Amazonka.SecurityLake.GetDatalakeStatus

ToPath GetDatalakeStatus Source # 
Instance details

Defined in Amazonka.SecurityLake.GetDatalakeStatus

ToQuery GetDatalakeStatus Source # 
Instance details

Defined in Amazonka.SecurityLake.GetDatalakeStatus

AWSPager GetDatalakeStatus Source # 
Instance details

Defined in Amazonka.SecurityLake.GetDatalakeStatus

AWSRequest GetDatalakeStatus Source # 
Instance details

Defined in Amazonka.SecurityLake.GetDatalakeStatus

Associated Types

type AWSResponse GetDatalakeStatus #

Generic GetDatalakeStatus Source # 
Instance details

Defined in Amazonka.SecurityLake.GetDatalakeStatus

Associated Types

type Rep GetDatalakeStatus :: Type -> Type #

Read GetDatalakeStatus Source # 
Instance details

Defined in Amazonka.SecurityLake.GetDatalakeStatus

Show GetDatalakeStatus Source # 
Instance details

Defined in Amazonka.SecurityLake.GetDatalakeStatus

NFData GetDatalakeStatus Source # 
Instance details

Defined in Amazonka.SecurityLake.GetDatalakeStatus

Methods

rnf :: GetDatalakeStatus -> () #

Eq GetDatalakeStatus Source # 
Instance details

Defined in Amazonka.SecurityLake.GetDatalakeStatus

Hashable GetDatalakeStatus Source # 
Instance details

Defined in Amazonka.SecurityLake.GetDatalakeStatus

type AWSResponse GetDatalakeStatus Source # 
Instance details

Defined in Amazonka.SecurityLake.GetDatalakeStatus

type Rep GetDatalakeStatus Source # 
Instance details

Defined in Amazonka.SecurityLake.GetDatalakeStatus

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

newGetDatalakeStatus :: GetDatalakeStatus Source #

Create a value of GetDatalakeStatus 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:accountSet:GetDatalakeStatus', getDatalakeStatus_accountSet - The Amazon Web Services account ID for which a static snapshot of the current Amazon Web Services Region, including enabled accounts and log sources, is retrieved.

$sel:maxAccountResults:GetDatalakeStatus', getDatalakeStatus_maxAccountResults - The maximum limit of accounts for which the static snapshot of the current Region, including enabled accounts and log sources, is retrieved.

GetDatalakeStatus, getDatalakeStatus_nextToken - Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.

Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Request Lenses

getDatalakeStatus_accountSet :: Lens' GetDatalakeStatus (Maybe [Text]) Source #

The Amazon Web Services account ID for which a static snapshot of the current Amazon Web Services Region, including enabled accounts and log sources, is retrieved.

getDatalakeStatus_maxAccountResults :: Lens' GetDatalakeStatus (Maybe Int) Source #

The maximum limit of accounts for which the static snapshot of the current Region, including enabled accounts and log sources, is retrieved.

getDatalakeStatus_nextToken :: Lens' GetDatalakeStatus (Maybe Text) Source #

Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.

Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Destructuring the Response

data GetDatalakeStatusResponse Source #

See: newGetDatalakeStatusResponse smart constructor.

Constructors

GetDatalakeStatusResponse' 

Fields

  • nextToken :: Maybe Text

    Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.

    Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

  • httpStatus :: Int

    The response's http status code.

  • accountSourcesList :: [AccountSources]

    The list of enabled accounts and enabled sources.

Instances

Instances details
Generic GetDatalakeStatusResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.GetDatalakeStatus

Associated Types

type Rep GetDatalakeStatusResponse :: Type -> Type #

Read GetDatalakeStatusResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.GetDatalakeStatus

Show GetDatalakeStatusResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.GetDatalakeStatus

NFData GetDatalakeStatusResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.GetDatalakeStatus

Eq GetDatalakeStatusResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.GetDatalakeStatus

type Rep GetDatalakeStatusResponse Source # 
Instance details

Defined in Amazonka.SecurityLake.GetDatalakeStatus

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

newGetDatalakeStatusResponse Source #

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

GetDatalakeStatus, getDatalakeStatusResponse_nextToken - Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.

Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

$sel:httpStatus:GetDatalakeStatusResponse', getDatalakeStatusResponse_httpStatus - The response's http status code.

$sel:accountSourcesList:GetDatalakeStatusResponse', getDatalakeStatusResponse_accountSourcesList - The list of enabled accounts and enabled sources.

Response Lenses

getDatalakeStatusResponse_nextToken :: Lens' GetDatalakeStatusResponse (Maybe Text) Source #

Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.

Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.