libZSservicesZSamazonka-securityhubZSamazonka-securityhub
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.SecurityHub.GetInsights

Description

Lists and describes insights for the specified insight ARNs.

This operation returns paginated results.

Synopsis

Creating a Request

data GetInsights Source #

See: newGetInsights smart constructor.

Constructors

GetInsights' 

Fields

  • nextToken :: Maybe Text

    The token that is required for pagination. On your first call to the GetInsights operation, set the value of this parameter to NULL.

    For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

  • insightArns :: Maybe [Text]

    The ARNs of the insights to describe. If you do not provide any insight ARNs, then GetInsights returns all of your custom insights. It does not return any managed insights.

  • maxResults :: Maybe Natural

    The maximum number of items to return in the response.

Instances

Instances details
Eq GetInsights Source # 
Instance details

Defined in Amazonka.SecurityHub.GetInsights

Read GetInsights Source # 
Instance details

Defined in Amazonka.SecurityHub.GetInsights

Show GetInsights Source # 
Instance details

Defined in Amazonka.SecurityHub.GetInsights

Generic GetInsights Source # 
Instance details

Defined in Amazonka.SecurityHub.GetInsights

Associated Types

type Rep GetInsights :: Type -> Type #

NFData GetInsights Source # 
Instance details

Defined in Amazonka.SecurityHub.GetInsights

Methods

rnf :: GetInsights -> () #

Hashable GetInsights Source # 
Instance details

Defined in Amazonka.SecurityHub.GetInsights

ToJSON GetInsights Source # 
Instance details

Defined in Amazonka.SecurityHub.GetInsights

AWSPager GetInsights Source # 
Instance details

Defined in Amazonka.SecurityHub.GetInsights

AWSRequest GetInsights Source # 
Instance details

Defined in Amazonka.SecurityHub.GetInsights

Associated Types

type AWSResponse GetInsights #

ToHeaders GetInsights Source # 
Instance details

Defined in Amazonka.SecurityHub.GetInsights

Methods

toHeaders :: GetInsights -> [Header] #

ToPath GetInsights Source # 
Instance details

Defined in Amazonka.SecurityHub.GetInsights

ToQuery GetInsights Source # 
Instance details

Defined in Amazonka.SecurityHub.GetInsights

type Rep GetInsights Source # 
Instance details

Defined in Amazonka.SecurityHub.GetInsights

type Rep GetInsights = D1 ('MetaData "GetInsights" "Amazonka.SecurityHub.GetInsights" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "GetInsights'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "insightArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse GetInsights Source # 
Instance details

Defined in Amazonka.SecurityHub.GetInsights

newGetInsights :: GetInsights Source #

Create a value of GetInsights 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:nextToken:GetInsights', getInsights_nextToken - The token that is required for pagination. On your first call to the GetInsights operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

$sel:insightArns:GetInsights', getInsights_insightArns - The ARNs of the insights to describe. If you do not provide any insight ARNs, then GetInsights returns all of your custom insights. It does not return any managed insights.

$sel:maxResults:GetInsights', getInsights_maxResults - The maximum number of items to return in the response.

Request Lenses

getInsights_nextToken :: Lens' GetInsights (Maybe Text) Source #

The token that is required for pagination. On your first call to the GetInsights operation, set the value of this parameter to NULL.

For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.

getInsights_insightArns :: Lens' GetInsights (Maybe [Text]) Source #

The ARNs of the insights to describe. If you do not provide any insight ARNs, then GetInsights returns all of your custom insights. It does not return any managed insights.

getInsights_maxResults :: Lens' GetInsights (Maybe Natural) Source #

The maximum number of items to return in the response.

Destructuring the Response

data GetInsightsResponse Source #

See: newGetInsightsResponse smart constructor.

Constructors

GetInsightsResponse' 

Fields

Instances

Instances details
Eq GetInsightsResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.GetInsights

Read GetInsightsResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.GetInsights

Show GetInsightsResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.GetInsights

Generic GetInsightsResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.GetInsights

Associated Types

type Rep GetInsightsResponse :: Type -> Type #

NFData GetInsightsResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.GetInsights

Methods

rnf :: GetInsightsResponse -> () #

type Rep GetInsightsResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.GetInsights

type Rep GetInsightsResponse = D1 ('MetaData "GetInsightsResponse" "Amazonka.SecurityHub.GetInsights" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "GetInsightsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "insights") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Insight]))))

newGetInsightsResponse Source #

Create a value of GetInsightsResponse 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:nextToken:GetInsights', getInsightsResponse_nextToken - The pagination token to use to request the next page of results.

$sel:httpStatus:GetInsightsResponse', getInsightsResponse_httpStatus - The response's http status code.

$sel:insights:GetInsightsResponse', getInsightsResponse_insights - The insights returned by the operation.

Response Lenses

getInsightsResponse_nextToken :: Lens' GetInsightsResponse (Maybe Text) Source #

The pagination token to use to request the next page of results.

getInsightsResponse_insights :: Lens' GetInsightsResponse [Insight] Source #

The insights returned by the operation.