Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ECR.DescribeImageScanFindings

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

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.
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.
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.
repositoryName :: Text
The repository for the image for which to describe the scan findings.
imageId :: ImageIdentifier

Instances

Instances details

ToJSON DescribeImageScanFindings Source #
Instance details Defined in Amazonka.ECR.DescribeImageScanFindings Methods toJSON :: DescribeImageScanFindings -> Value # toEncoding :: DescribeImageScanFindings -> Encoding # toJSONList :: [DescribeImageScanFindings] -> Value # toEncodingList :: [DescribeImageScanFindings] -> Encoding #
ToHeaders DescribeImageScanFindings Source #
Instance details Defined in Amazonka.ECR.DescribeImageScanFindings Methods toHeaders :: DescribeImageScanFindings -> [Header] #
ToPath DescribeImageScanFindings Source #
Instance details Defined in Amazonka.ECR.DescribeImageScanFindings Methods toPath :: DescribeImageScanFindings -> ByteString #
ToQuery DescribeImageScanFindings Source #
Instance details Defined in Amazonka.ECR.DescribeImageScanFindings Methods toQuery :: DescribeImageScanFindings -> QueryString #
AWSPager DescribeImageScanFindings Source #
Instance details Defined in Amazonka.ECR.DescribeImageScanFindings Methods page :: DescribeImageScanFindings -> AWSResponse DescribeImageScanFindings -> Maybe DescribeImageScanFindings #
AWSRequest DescribeImageScanFindings Source #
Instance details Defined in Amazonka.ECR.DescribeImageScanFindings Associated Types type AWSResponse DescribeImageScanFindings # Methods request :: (Service -> Service) -> DescribeImageScanFindings -> Request DescribeImageScanFindings # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeImageScanFindings -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeImageScanFindings))) #
Generic DescribeImageScanFindings Source #
Instance details Defined in Amazonka.ECR.DescribeImageScanFindings Associated Types type Rep DescribeImageScanFindings :: Type -> Type # Methods from :: DescribeImageScanFindings -> Rep DescribeImageScanFindings x # to :: Rep DescribeImageScanFindings x -> DescribeImageScanFindings #
Read DescribeImageScanFindings Source #
Instance details Defined in Amazonka.ECR.DescribeImageScanFindings Methods readsPrec :: Int -> ReadS DescribeImageScanFindings # readList :: ReadS [DescribeImageScanFindings] # readPrec :: ReadPrec DescribeImageScanFindings # readListPrec :: ReadPrec [DescribeImageScanFindings] #
Show DescribeImageScanFindings Source #
Instance details Defined in Amazonka.ECR.DescribeImageScanFindings Methods showsPrec :: Int -> DescribeImageScanFindings -> ShowS # show :: DescribeImageScanFindings -> String # showList :: [DescribeImageScanFindings] -> ShowS #
NFData DescribeImageScanFindings Source #
Instance details Defined in Amazonka.ECR.DescribeImageScanFindings Methods rnf :: DescribeImageScanFindings -> () #
Eq DescribeImageScanFindings Source #
Instance details Defined in Amazonka.ECR.DescribeImageScanFindings Methods (==) :: DescribeImageScanFindings -> DescribeImageScanFindings -> Bool # (/=) :: DescribeImageScanFindings -> DescribeImageScanFindings -> Bool #
Hashable DescribeImageScanFindings Source #
Instance details Defined in Amazonka.ECR.DescribeImageScanFindings Methods hashWithSalt :: Int -> DescribeImageScanFindings -> Int # hash :: DescribeImageScanFindings -> Int #
type AWSResponse DescribeImageScanFindings Source #
Instance details Defined in Amazonka.ECR.DescribeImageScanFindings type AWSResponse DescribeImageScanFindings = DescribeImageScanFindingsResponse
type Rep DescribeImageScanFindings Source #
Instance details Defined in Amazonka.ECR.DescribeImageScanFindings type Rep DescribeImageScanFindings = D1 ('MetaData "DescribeImageScanFindings" "Amazonka.ECR.DescribeImageScanFindings" "amazonka-ecr-2.0-BqgZWPod2JCFn2nq69DCrJ" 'False) (C1 ('MetaCons "DescribeImageScanFindings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "registryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "imageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ImageIdentifier)))))

newDescribeImageScanFindings Source #

Arguments

:: Text	`DescribeImageScanFindings`
-> ImageIdentifier	`DescribeImageScanFindings`
-> DescribeImageScanFindings

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

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.

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.

DescribeImageScanFindings, describeImageScanFindings_repositoryName - The repository for the image for which to describe the scan findings.

DescribeImageScanFindings, describeImageScanFindings_imageId - Undocumented member.

Request Lenses

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_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_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_repositoryName :: Lens' DescribeImageScanFindings Text Source #

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

describeImageScanFindings_imageId :: Lens' DescribeImageScanFindings ImageIdentifier Source #

Undocumented member.

Destructuring the Response

data DescribeImageScanFindingsResponse Source #

See: newDescribeImageScanFindingsResponse smart constructor.

Constructors

DescribeImageScanFindingsResponse'

Fields

imageId :: Maybe ImageIdentifier
imageScanFindings :: Maybe ImageScanFindings
The information contained in the image scan findings.
imageScanStatus :: Maybe ImageScanStatus
The current state of the scan.
nextToken :: Maybe Text
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.
registryId :: Maybe Text
The registry ID associated with the request.
repositoryName :: Maybe Text
The repository name associated with the request.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeImageScanFindingsResponse Source #
Instance details Defined in Amazonka.ECR.DescribeImageScanFindings Associated Types type Rep DescribeImageScanFindingsResponse :: Type -> Type # Methods from :: DescribeImageScanFindingsResponse -> Rep DescribeImageScanFindingsResponse x # to :: Rep DescribeImageScanFindingsResponse x -> DescribeImageScanFindingsResponse #
Read DescribeImageScanFindingsResponse Source #
Instance details Defined in Amazonka.ECR.DescribeImageScanFindings Methods readsPrec :: Int -> ReadS DescribeImageScanFindingsResponse # readList :: ReadS [DescribeImageScanFindingsResponse] # readPrec :: ReadPrec DescribeImageScanFindingsResponse # readListPrec :: ReadPrec [DescribeImageScanFindingsResponse] #
Show DescribeImageScanFindingsResponse Source #
Instance details Defined in Amazonka.ECR.DescribeImageScanFindings Methods showsPrec :: Int -> DescribeImageScanFindingsResponse -> ShowS # show :: DescribeImageScanFindingsResponse -> String # showList :: [DescribeImageScanFindingsResponse] -> ShowS #
NFData DescribeImageScanFindingsResponse Source #
Instance details Defined in Amazonka.ECR.DescribeImageScanFindings Methods rnf :: DescribeImageScanFindingsResponse -> () #
Eq DescribeImageScanFindingsResponse Source #
Instance details Defined in Amazonka.ECR.DescribeImageScanFindings Methods (==) :: DescribeImageScanFindingsResponse -> DescribeImageScanFindingsResponse -> Bool # (/=) :: DescribeImageScanFindingsResponse -> DescribeImageScanFindingsResponse -> Bool #
type Rep DescribeImageScanFindingsResponse Source #
Instance details Defined in Amazonka.ECR.DescribeImageScanFindings type Rep DescribeImageScanFindingsResponse = D1 ('MetaData "DescribeImageScanFindingsResponse" "Amazonka.ECR.DescribeImageScanFindings" "amazonka-ecr-2.0-BqgZWPod2JCFn2nq69DCrJ" 'False) (C1 ('MetaCons "DescribeImageScanFindingsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "imageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImageIdentifier)) :: (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 "registryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeImageScanFindingsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeImageScanFindingsResponse'`
-> DescribeImageScanFindingsResponse

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:

DescribeImageScanFindings, describeImageScanFindingsResponse_imageId - Undocumented member.

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

DescribeImageScanFindingsResponse, describeImageScanFindingsResponse_imageScanStatus - The current state of the scan.

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.

DescribeImageScanFindings, describeImageScanFindingsResponse_registryId - The registry ID associated with the request.

DescribeImageScanFindings, describeImageScanFindingsResponse_repositoryName - The repository name associated with the request.

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

Response Lenses

describeImageScanFindingsResponse_imageId :: Lens' DescribeImageScanFindingsResponse (Maybe ImageIdentifier) Source #

Undocumented member.

describeImageScanFindingsResponse_imageScanFindings :: Lens' DescribeImageScanFindingsResponse (Maybe ImageScanFindings) Source #

The information contained in the image scan findings.

describeImageScanFindingsResponse_imageScanStatus :: Lens' DescribeImageScanFindingsResponse (Maybe ImageScanStatus) Source #

The current state of the scan.

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.

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

The registry ID associated with the request.

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

The repository name associated with the request.

describeImageScanFindingsResponse_httpStatus :: Lens' DescribeImageScanFindingsResponse Int Source #

The response's http status code.