libZSservicesZSamazonka-ecrZSamazonka-ecr
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.ECR.DescribeImageScanFindings

Description

Returns the scan findings for the specified image.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeImageScanFindings Source #

See: newDescribeImageScanFindings smart constructor.

Constructors

DescribeImageScanFindings' 

Fields

  • registryId :: Maybe Text

    The Amazon Web Services account ID associated with the registry that contains the repository in which to describe the image scan findings for. If you do not specify a registry, the default registry is assumed.

  • nextToken :: Maybe Text

    The nextToken value returned from a previous paginated DescribeImageScanFindings request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

  • maxResults :: Maybe Natural

    The maximum number of image scan results returned by DescribeImageScanFindings in paginated output. When this parameter is used, DescribeImageScanFindings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeImageScanFindings request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImageScanFindings returns up to 100 results and a nextToken value, if applicable.

  • repositoryName :: Text

    The repository for the image for which to describe the scan findings.

  • imageId :: ImageIdentifier
     

Instances

Instances details
Eq DescribeImageScanFindings Source # 
Instance details

Defined in Amazonka.ECR.DescribeImageScanFindings

Read DescribeImageScanFindings Source # 
Instance details

Defined in Amazonka.ECR.DescribeImageScanFindings

Show DescribeImageScanFindings Source # 
Instance details

Defined in Amazonka.ECR.DescribeImageScanFindings

Generic DescribeImageScanFindings Source # 
Instance details

Defined in Amazonka.ECR.DescribeImageScanFindings

Associated Types

type Rep DescribeImageScanFindings :: Type -> Type #

NFData DescribeImageScanFindings Source # 
Instance details

Defined in Amazonka.ECR.DescribeImageScanFindings

Hashable DescribeImageScanFindings Source # 
Instance details

Defined in Amazonka.ECR.DescribeImageScanFindings

ToJSON DescribeImageScanFindings Source # 
Instance details

Defined in Amazonka.ECR.DescribeImageScanFindings

AWSPager DescribeImageScanFindings Source # 
Instance details

Defined in Amazonka.ECR.DescribeImageScanFindings

AWSRequest DescribeImageScanFindings Source # 
Instance details

Defined in Amazonka.ECR.DescribeImageScanFindings

ToHeaders DescribeImageScanFindings Source # 
Instance details

Defined in Amazonka.ECR.DescribeImageScanFindings

ToPath DescribeImageScanFindings Source # 
Instance details

Defined in Amazonka.ECR.DescribeImageScanFindings

ToQuery DescribeImageScanFindings Source # 
Instance details

Defined in Amazonka.ECR.DescribeImageScanFindings

type Rep DescribeImageScanFindings Source # 
Instance details

Defined in Amazonka.ECR.DescribeImageScanFindings

type Rep DescribeImageScanFindings = D1 ('MetaData "DescribeImageScanFindings" "Amazonka.ECR.DescribeImageScanFindings" "libZSservicesZSamazonka-ecrZSamazonka-ecr" 'False) (C1 ('MetaCons "DescribeImageScanFindings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "registryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "imageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ImageIdentifier)))))
type AWSResponse DescribeImageScanFindings Source # 
Instance details

Defined in Amazonka.ECR.DescribeImageScanFindings

newDescribeImageScanFindings Source #

Create a value of DescribeImageScanFindings 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:registryId:DescribeImageScanFindings', describeImageScanFindings_registryId - The Amazon Web Services account ID associated with the registry that contains the repository in which to describe the image scan findings for. If you do not specify a registry, the default registry is assumed.

$sel:nextToken:DescribeImageScanFindings', describeImageScanFindings_nextToken - The nextToken value returned from a previous paginated DescribeImageScanFindings request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

$sel:maxResults:DescribeImageScanFindings', describeImageScanFindings_maxResults - The maximum number of image scan results returned by DescribeImageScanFindings in paginated output. When this parameter is used, DescribeImageScanFindings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeImageScanFindings request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImageScanFindings returns up to 100 results and a nextToken value, if applicable.

$sel:repositoryName:DescribeImageScanFindings', describeImageScanFindings_repositoryName - The repository for the image for which to describe the scan findings.

$sel:imageId:DescribeImageScanFindings', describeImageScanFindings_imageId - Undocumented member.

Request Lenses

describeImageScanFindings_registryId :: Lens' DescribeImageScanFindings (Maybe Text) Source #

The Amazon Web Services account ID associated with the registry that contains the repository in which to describe the image scan findings for. If you do not specify a registry, the default registry is assumed.

describeImageScanFindings_nextToken :: Lens' DescribeImageScanFindings (Maybe Text) Source #

The nextToken value returned from a previous paginated DescribeImageScanFindings request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

describeImageScanFindings_maxResults :: Lens' DescribeImageScanFindings (Maybe Natural) Source #

The maximum number of image scan results returned by DescribeImageScanFindings in paginated output. When this parameter is used, DescribeImageScanFindings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeImageScanFindings request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImageScanFindings returns up to 100 results and a nextToken value, if applicable.

describeImageScanFindings_repositoryName :: Lens' DescribeImageScanFindings Text Source #

The repository for the image for which to describe the scan findings.

Destructuring the Response

data DescribeImageScanFindingsResponse Source #

See: newDescribeImageScanFindingsResponse smart constructor.

Constructors

DescribeImageScanFindingsResponse' 

Fields

Instances

Instances details
Eq DescribeImageScanFindingsResponse Source # 
Instance details

Defined in Amazonka.ECR.DescribeImageScanFindings

Read DescribeImageScanFindingsResponse Source # 
Instance details

Defined in Amazonka.ECR.DescribeImageScanFindings

Show DescribeImageScanFindingsResponse Source # 
Instance details

Defined in Amazonka.ECR.DescribeImageScanFindings

Generic DescribeImageScanFindingsResponse Source # 
Instance details

Defined in Amazonka.ECR.DescribeImageScanFindings

Associated Types

type Rep DescribeImageScanFindingsResponse :: Type -> Type #

NFData DescribeImageScanFindingsResponse Source # 
Instance details

Defined in Amazonka.ECR.DescribeImageScanFindings

type Rep DescribeImageScanFindingsResponse Source # 
Instance details

Defined in Amazonka.ECR.DescribeImageScanFindings

type Rep DescribeImageScanFindingsResponse = D1 ('MetaData "DescribeImageScanFindingsResponse" "Amazonka.ECR.DescribeImageScanFindings" "libZSservicesZSamazonka-ecrZSamazonka-ecr" 'False) (C1 ('MetaCons "DescribeImageScanFindingsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "registryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "imageScanFindings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImageScanFindings)) :*: S1 ('MetaSel ('Just "imageScanStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImageScanStatus)))) :*: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "imageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImageIdentifier))) :*: (S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeImageScanFindingsResponse Source #

Create a value of DescribeImageScanFindingsResponse 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:registryId:DescribeImageScanFindings', describeImageScanFindingsResponse_registryId - The registry ID associated with the request.

$sel:imageScanFindings:DescribeImageScanFindingsResponse', describeImageScanFindingsResponse_imageScanFindings - The information contained in the image scan findings.

$sel:imageScanStatus:DescribeImageScanFindingsResponse', describeImageScanFindingsResponse_imageScanStatus - The current state of the scan.

$sel:nextToken:DescribeImageScanFindings', describeImageScanFindingsResponse_nextToken - The nextToken value to include in a future DescribeImageScanFindings request. When the results of a DescribeImageScanFindings request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

$sel:imageId:DescribeImageScanFindings', describeImageScanFindingsResponse_imageId - Undocumented member.

$sel:repositoryName:DescribeImageScanFindings', describeImageScanFindingsResponse_repositoryName - The repository name associated with the request.

$sel:httpStatus:DescribeImageScanFindingsResponse', describeImageScanFindingsResponse_httpStatus - The response's http status code.

Response Lenses

describeImageScanFindingsResponse_nextToken :: Lens' DescribeImageScanFindingsResponse (Maybe Text) Source #

The nextToken value to include in a future DescribeImageScanFindings request. When the results of a DescribeImageScanFindings request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.