Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SecurityHub.BatchImportFindings

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Imports security findings generated from an integrated product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub.

The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.

After a finding is created, BatchImportFindings cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow.

```
Note
```
```
UserDefinedFields
```
```
VerificationState
```
```
Workflow
```

Finding providers also should not use BatchImportFindings to update the following attributes.

```
Confidence
```
```
Criticality
```
```
RelatedFindings
```
```
Severity
```
```
Types
```

Instead, finding providers use FindingProviderFields to provide values for these attributes.

Synopsis

Creating a Request

data BatchImportFindings Source #

See: newBatchImportFindings smart constructor.

Constructors

BatchImportFindings'
Fields findings :: NonEmpty AwsSecurityFinding A list of findings to import. To successfully import a finding, it must follow the Amazon Web Services Security Finding Format. Maximum of 100 findings per request.

Instances

Instances details

Eq BatchImportFindings Source #
Instance details Defined in Amazonka.SecurityHub.BatchImportFindings Methods (==) :: BatchImportFindings -> BatchImportFindings -> Bool # (/=) :: BatchImportFindings -> BatchImportFindings -> Bool #
Read BatchImportFindings Source #
Instance details Defined in Amazonka.SecurityHub.BatchImportFindings Methods readsPrec :: Int -> ReadS BatchImportFindings # readList :: ReadS [BatchImportFindings] # readPrec :: ReadPrec BatchImportFindings # readListPrec :: ReadPrec [BatchImportFindings] #
Show BatchImportFindings Source #
Instance details Defined in Amazonka.SecurityHub.BatchImportFindings Methods showsPrec :: Int -> BatchImportFindings -> ShowS # show :: BatchImportFindings -> String # showList :: [BatchImportFindings] -> ShowS #
Generic BatchImportFindings Source #
Instance details Defined in Amazonka.SecurityHub.BatchImportFindings Associated Types type Rep BatchImportFindings :: Type -> Type # Methods from :: BatchImportFindings -> Rep BatchImportFindings x # to :: Rep BatchImportFindings x -> BatchImportFindings #
NFData BatchImportFindings Source #
Instance details Defined in Amazonka.SecurityHub.BatchImportFindings Methods rnf :: BatchImportFindings -> () #
Hashable BatchImportFindings Source #
Instance details Defined in Amazonka.SecurityHub.BatchImportFindings Methods hashWithSalt :: Int -> BatchImportFindings -> Int # hash :: BatchImportFindings -> Int #
ToJSON BatchImportFindings Source #
Instance details Defined in Amazonka.SecurityHub.BatchImportFindings Methods toJSON :: BatchImportFindings -> Value # toEncoding :: BatchImportFindings -> Encoding # toJSONList :: [BatchImportFindings] -> Value # toEncodingList :: [BatchImportFindings] -> Encoding #
AWSRequest BatchImportFindings Source #
Instance details Defined in Amazonka.SecurityHub.BatchImportFindings Associated Types type AWSResponse BatchImportFindings # Methods request :: BatchImportFindings -> Request BatchImportFindings # response :: MonadResource m => Logger -> Service -> Proxy BatchImportFindings -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse BatchImportFindings))) #
ToHeaders BatchImportFindings Source #
Instance details Defined in Amazonka.SecurityHub.BatchImportFindings Methods toHeaders :: BatchImportFindings -> [Header] #
ToPath BatchImportFindings Source #
Instance details Defined in Amazonka.SecurityHub.BatchImportFindings Methods toPath :: BatchImportFindings -> ByteString #
ToQuery BatchImportFindings Source #
Instance details Defined in Amazonka.SecurityHub.BatchImportFindings Methods toQuery :: BatchImportFindings -> QueryString #
type Rep BatchImportFindings Source #
Instance details Defined in Amazonka.SecurityHub.BatchImportFindings type Rep BatchImportFindings = D1 ('MetaData "BatchImportFindings" "Amazonka.SecurityHub.BatchImportFindings" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "BatchImportFindings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "findings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty AwsSecurityFinding))))
type AWSResponse BatchImportFindings Source #
Instance details Defined in Amazonka.SecurityHub.BatchImportFindings type AWSResponse BatchImportFindings = BatchImportFindingsResponse

newBatchImportFindings Source #

Arguments

:: NonEmpty AwsSecurityFinding	`$sel:findings:BatchImportFindings'`
-> BatchImportFindings

Create a value of BatchImportFindings 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:findings:BatchImportFindings', batchImportFindings_findings - A list of findings to import. To successfully import a finding, it must follow the Amazon Web Services Security Finding Format. Maximum of 100 findings per request.

Request Lenses

batchImportFindings_findings :: Lens' BatchImportFindings (NonEmpty AwsSecurityFinding) Source #

A list of findings to import. To successfully import a finding, it must follow the Amazon Web Services Security Finding Format. Maximum of 100 findings per request.

Destructuring the Response

data BatchImportFindingsResponse Source #

See: newBatchImportFindingsResponse smart constructor.

Constructors

BatchImportFindingsResponse'
Fields failedFindings :: Maybe [ImportFindingsError] The list of findings that failed to import. httpStatus :: Int The response's http status code. failedCount :: Int The number of findings that failed to import. successCount :: Int The number of findings that were successfully imported.

Instances

Instances details

Eq BatchImportFindingsResponse Source #
Instance details Defined in Amazonka.SecurityHub.BatchImportFindings Methods (==) :: BatchImportFindingsResponse -> BatchImportFindingsResponse -> Bool # (/=) :: BatchImportFindingsResponse -> BatchImportFindingsResponse -> Bool #
Read BatchImportFindingsResponse Source #
Instance details Defined in Amazonka.SecurityHub.BatchImportFindings Methods readsPrec :: Int -> ReadS BatchImportFindingsResponse # readList :: ReadS [BatchImportFindingsResponse] # readPrec :: ReadPrec BatchImportFindingsResponse # readListPrec :: ReadPrec [BatchImportFindingsResponse] #
Show BatchImportFindingsResponse Source #
Instance details Defined in Amazonka.SecurityHub.BatchImportFindings Methods showsPrec :: Int -> BatchImportFindingsResponse -> ShowS # show :: BatchImportFindingsResponse -> String # showList :: [BatchImportFindingsResponse] -> ShowS #
Generic BatchImportFindingsResponse Source #
Instance details Defined in Amazonka.SecurityHub.BatchImportFindings Associated Types type Rep BatchImportFindingsResponse :: Type -> Type # Methods from :: BatchImportFindingsResponse -> Rep BatchImportFindingsResponse x # to :: Rep BatchImportFindingsResponse x -> BatchImportFindingsResponse #
NFData BatchImportFindingsResponse Source #
Instance details Defined in Amazonka.SecurityHub.BatchImportFindings Methods rnf :: BatchImportFindingsResponse -> () #
type Rep BatchImportFindingsResponse Source #
Instance details Defined in Amazonka.SecurityHub.BatchImportFindings type Rep BatchImportFindingsResponse = D1 ('MetaData "BatchImportFindingsResponse" "Amazonka.SecurityHub.BatchImportFindings" "libZSservicesZSamazonka-securityhubZSamazonka-securityhub" 'False) (C1 ('MetaCons "BatchImportFindingsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "failedFindings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ImportFindingsError])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "failedCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "successCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newBatchImportFindingsResponse Source #

Arguments

:: Int	`$sel:httpStatus:BatchImportFindingsResponse'`
-> Int	`$sel:failedCount:BatchImportFindingsResponse'`
-> Int	`$sel:successCount:BatchImportFindingsResponse'`
-> BatchImportFindingsResponse

Create a value of BatchImportFindingsResponse 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:failedFindings:BatchImportFindingsResponse', batchImportFindingsResponse_failedFindings - The list of findings that failed to import.

$sel:httpStatus:BatchImportFindingsResponse', batchImportFindingsResponse_httpStatus - The response's http status code.

$sel:failedCount:BatchImportFindingsResponse', batchImportFindingsResponse_failedCount - The number of findings that failed to import.

$sel:successCount:BatchImportFindingsResponse', batchImportFindingsResponse_successCount - The number of findings that were successfully imported.

Response Lenses

batchImportFindingsResponse_failedFindings :: Lens' BatchImportFindingsResponse (Maybe [ImportFindingsError]) Source #

The list of findings that failed to import.

batchImportFindingsResponse_httpStatus :: Lens' BatchImportFindingsResponse Int Source #

The response's http status code.

batchImportFindingsResponse_failedCount :: Lens' BatchImportFindingsResponse Int Source #

The number of findings that failed to import.

batchImportFindingsResponse_successCount :: Lens' BatchImportFindingsResponse Int Source #

The number of findings that were successfully imported.