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

Description

Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate to a security issue that requires attention or remediation.

To group the related findings in the insight, use the GroupByAttribute.

Synopsis

Creating a Request

data CreateInsight Source #

See: newCreateInsight smart constructor.

Constructors

CreateInsight' 

Fields

  • name :: Text

    The name of the custom insight to create.

  • filters :: AwsSecurityFindingFilters

    One or more attributes used to filter the findings included in the insight. The insight only includes findings that match the criteria defined in the filters.

  • groupByAttribute :: Text

    The attribute used to group the findings for the insight. The grouping attribute identifies the type of item that the insight applies to. For example, if an insight is grouped by resource identifier, then the insight produces a list of resource identifiers.

Instances

Instances details
Eq CreateInsight Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateInsight

Read CreateInsight Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateInsight

Show CreateInsight Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateInsight

Generic CreateInsight Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateInsight

Associated Types

type Rep CreateInsight :: Type -> Type #

NFData CreateInsight Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateInsight

Methods

rnf :: CreateInsight -> () #

Hashable CreateInsight Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateInsight

ToJSON CreateInsight Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateInsight

AWSRequest CreateInsight Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateInsight

Associated Types

type AWSResponse CreateInsight #

ToHeaders CreateInsight Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateInsight

ToPath CreateInsight Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateInsight

ToQuery CreateInsight Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateInsight

type Rep CreateInsight Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateInsight

type Rep CreateInsight = D1 ('MetaData "CreateInsight" "Amazonka.SecurityHub.CreateInsight" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "CreateInsight'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AwsSecurityFindingFilters) :*: S1 ('MetaSel ('Just "groupByAttribute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse CreateInsight Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateInsight

newCreateInsight Source #

Create a value of CreateInsight 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:name:CreateInsight', createInsight_name - The name of the custom insight to create.

$sel:filters:CreateInsight', createInsight_filters - One or more attributes used to filter the findings included in the insight. The insight only includes findings that match the criteria defined in the filters.

$sel:groupByAttribute:CreateInsight', createInsight_groupByAttribute - The attribute used to group the findings for the insight. The grouping attribute identifies the type of item that the insight applies to. For example, if an insight is grouped by resource identifier, then the insight produces a list of resource identifiers.

Request Lenses

createInsight_name :: Lens' CreateInsight Text Source #

The name of the custom insight to create.

createInsight_filters :: Lens' CreateInsight AwsSecurityFindingFilters Source #

One or more attributes used to filter the findings included in the insight. The insight only includes findings that match the criteria defined in the filters.

createInsight_groupByAttribute :: Lens' CreateInsight Text Source #

The attribute used to group the findings for the insight. The grouping attribute identifies the type of item that the insight applies to. For example, if an insight is grouped by resource identifier, then the insight produces a list of resource identifiers.

Destructuring the Response

data CreateInsightResponse Source #

See: newCreateInsightResponse smart constructor.

Constructors

CreateInsightResponse' 

Fields

Instances

Instances details
Eq CreateInsightResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateInsight

Read CreateInsightResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateInsight

Show CreateInsightResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateInsight

Generic CreateInsightResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateInsight

Associated Types

type Rep CreateInsightResponse :: Type -> Type #

NFData CreateInsightResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateInsight

Methods

rnf :: CreateInsightResponse -> () #

type Rep CreateInsightResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.CreateInsight

type Rep CreateInsightResponse = D1 ('MetaData "CreateInsightResponse" "Amazonka.SecurityHub.CreateInsight" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "CreateInsightResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "insightArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateInsightResponse Source #

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

$sel:insightArn:CreateInsightResponse', createInsightResponse_insightArn - The ARN of the insight created.

Response Lenses