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

Description

Returns information about product integrations in Security Hub.

You can optionally provide an integration ARN. If you provide an integration ARN, then the results only include that integration.

If you do not provide an integration ARN, then the results include all of the available product integrations.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeProducts Source #

See: newDescribeProducts smart constructor.

Constructors

DescribeProducts' 

Fields

  • nextToken :: Maybe Text

    The token that is required for pagination. On your first call to the DescribeProducts 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.

  • productArn :: Maybe Text

    The ARN of the integration to return.

  • maxResults :: Maybe Natural

    The maximum number of results to return.

Instances

Instances details
Eq DescribeProducts Source # 
Instance details

Defined in Amazonka.SecurityHub.DescribeProducts

Methods

(==) :: DescribeProducts -> DescribeProducts -> Bool #

(/=) :: DescribeProducts -> DescribeProducts -> Bool #

Read DescribeProducts Source # 
Instance details

Defined in Amazonka.SecurityHub.DescribeProducts

Methods

readsPrec :: Int -> ReadS DescribeProducts #

readList :: ReadS [DescribeProducts] #

readPrec :: ReadPrec DescribeProducts #

readListPrec :: ReadPrec [DescribeProducts] #

Show DescribeProducts Source # 
Instance details

Defined in Amazonka.SecurityHub.DescribeProducts

Methods

showsPrec :: Int -> DescribeProducts -> ShowS #

show :: DescribeProducts -> String #

showList :: [DescribeProducts] -> ShowS #

Generic DescribeProducts Source # 
Instance details

Defined in Amazonka.SecurityHub.DescribeProducts

Associated Types

type Rep DescribeProducts :: Type -> Type #

Methods

from :: DescribeProducts -> Rep DescribeProducts x #

to :: Rep DescribeProducts x -> DescribeProducts #

NFData DescribeProducts Source # 
Instance details

Defined in Amazonka.SecurityHub.DescribeProducts

Methods

rnf :: DescribeProducts -> () #

Hashable DescribeProducts Source # 
Instance details

Defined in Amazonka.SecurityHub.DescribeProducts

Methods

hashWithSalt :: Int -> DescribeProducts -> Int #

hash :: DescribeProducts -> Int #

AWSPager DescribeProducts Source # 
Instance details

Defined in Amazonka.SecurityHub.DescribeProducts

Methods

page :: DescribeProducts -> AWSResponse DescribeProducts -> Maybe DescribeProducts #

AWSRequest DescribeProducts Source # 
Instance details

Defined in Amazonka.SecurityHub.DescribeProducts

Associated Types

type AWSResponse DescribeProducts #

Methods

request :: DescribeProducts -> Request DescribeProducts #

response :: MonadResource m => Logger -> Service -> Proxy DescribeProducts -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeProducts))) #

ToHeaders DescribeProducts Source # 
Instance details

Defined in Amazonka.SecurityHub.DescribeProducts

Methods

toHeaders :: DescribeProducts -> [Header] #

ToPath DescribeProducts Source # 
Instance details

Defined in Amazonka.SecurityHub.DescribeProducts

Methods

toPath :: DescribeProducts -> ByteString #

ToQuery DescribeProducts Source # 
Instance details

Defined in Amazonka.SecurityHub.DescribeProducts

Methods

toQuery :: DescribeProducts -> QueryString #

type Rep DescribeProducts Source # 
Instance details

Defined in Amazonka.SecurityHub.DescribeProducts

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

Defined in Amazonka.SecurityHub.DescribeProducts

type AWSResponse DescribeProducts = DescribeProductsResponse

newDescribeProducts :: DescribeProducts Source #

Create a value of DescribeProducts 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:DescribeProducts', describeProducts_nextToken - The token that is required for pagination. On your first call to the DescribeProducts 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:productArn:DescribeProducts', describeProducts_productArn - The ARN of the integration to return.

$sel:maxResults:DescribeProducts', describeProducts_maxResults - The maximum number of results to return.

Request Lenses

describeProducts_nextToken :: Lens' DescribeProducts (Maybe Text) Source #

The token that is required for pagination. On your first call to the DescribeProducts 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.

describeProducts_productArn :: Lens' DescribeProducts (Maybe Text) Source #

The ARN of the integration to return.

describeProducts_maxResults :: Lens' DescribeProducts (Maybe Natural) Source #

The maximum number of results to return.

Destructuring the Response

data DescribeProductsResponse Source #

See: newDescribeProductsResponse smart constructor.

Constructors

DescribeProductsResponse' 

Fields

Instances

Instances details
Eq DescribeProductsResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.DescribeProducts

Methods

(==) :: DescribeProductsResponse -> DescribeProductsResponse -> Bool #

(/=) :: DescribeProductsResponse -> DescribeProductsResponse -> Bool #

Read DescribeProductsResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.DescribeProducts

Methods

readsPrec :: Int -> ReadS DescribeProductsResponse #

readList :: ReadS [DescribeProductsResponse] #

readPrec :: ReadPrec DescribeProductsResponse #

readListPrec :: ReadPrec [DescribeProductsResponse] #

Show DescribeProductsResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.DescribeProducts

Methods

showsPrec :: Int -> DescribeProductsResponse -> ShowS #

show :: DescribeProductsResponse -> String #

showList :: [DescribeProductsResponse] -> ShowS #

Generic DescribeProductsResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.DescribeProducts

Associated Types

type Rep DescribeProductsResponse :: Type -> Type #

Methods

from :: DescribeProductsResponse -> Rep DescribeProductsResponse x #

to :: Rep DescribeProductsResponse x -> DescribeProductsResponse #

NFData DescribeProductsResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.DescribeProducts

Methods

rnf :: DescribeProductsResponse -> () #

type Rep DescribeProductsResponse Source # 
Instance details

Defined in Amazonka.SecurityHub.DescribeProducts

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

newDescribeProductsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeProductsResponse'

-> DescribeProductsResponse 

Create a value of DescribeProductsResponse 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:DescribeProducts', describeProductsResponse_nextToken - The pagination token to use to request the next page of results.

$sel:httpStatus:DescribeProductsResponse', describeProductsResponse_httpStatus - The response's http status code.

$sel:products:DescribeProductsResponse', describeProductsResponse_products - A list of products, including details for each product.

Response Lenses

describeProductsResponse_nextToken :: Lens' DescribeProductsResponse (Maybe Text) Source #

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

describeProductsResponse_httpStatus :: Lens' DescribeProductsResponse Int Source #

The response's http status code.

describeProductsResponse_products :: Lens' DescribeProductsResponse [Product] Source #

A list of products, including details for each product.