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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts an image vulnerability scan. An image scan can only be started once per 24 hours on an individual image. This limit includes if an image was scanned on initial push. For more information, see Image scanning in the Amazon Elastic Container Registry User Guide.

Synopsis

data StartImageScan = StartImageScan' {
- registryId :: Maybe Text
- repositoryName :: Text
- imageId :: ImageIdentifier
}
newStartImageScan :: Text -> ImageIdentifier -> StartImageScan
startImageScan_registryId :: Lens' StartImageScan (Maybe Text)
startImageScan_repositoryName :: Lens' StartImageScan Text
startImageScan_imageId :: Lens' StartImageScan ImageIdentifier
data StartImageScanResponse = StartImageScanResponse' {
- imageId :: Maybe ImageIdentifier
- imageScanStatus :: Maybe ImageScanStatus
- registryId :: Maybe Text
- repositoryName :: Maybe Text
- httpStatus :: Int
}
newStartImageScanResponse :: Int -> StartImageScanResponse
startImageScanResponse_imageId :: Lens' StartImageScanResponse (Maybe ImageIdentifier)
startImageScanResponse_imageScanStatus :: Lens' StartImageScanResponse (Maybe ImageScanStatus)
startImageScanResponse_registryId :: Lens' StartImageScanResponse (Maybe Text)
startImageScanResponse_repositoryName :: Lens' StartImageScanResponse (Maybe Text)
startImageScanResponse_httpStatus :: Lens' StartImageScanResponse Int

Creating a Request

data StartImageScan Source #

See: newStartImageScan smart constructor.

Constructors

StartImageScan'
Fields registryId :: Maybe Text The Amazon Web Services account ID associated with the registry that contains the repository in which to start an image scan request. If you do not specify a registry, the default registry is assumed. repositoryName :: Text The name of the repository that contains the images to scan. imageId :: ImageIdentifier

Instances

Instances details

ToJSON StartImageScan Source #
Instance details Defined in Amazonka.ECR.StartImageScan Methods toJSON :: StartImageScan -> Value # toEncoding :: StartImageScan -> Encoding # toJSONList :: [StartImageScan] -> Value # toEncodingList :: [StartImageScan] -> Encoding #
ToHeaders StartImageScan Source #
Instance details Defined in Amazonka.ECR.StartImageScan Methods toHeaders :: StartImageScan -> [Header] #
ToPath StartImageScan Source #
Instance details Defined in Amazonka.ECR.StartImageScan Methods toPath :: StartImageScan -> ByteString #
ToQuery StartImageScan Source #
Instance details Defined in Amazonka.ECR.StartImageScan Methods toQuery :: StartImageScan -> QueryString #
AWSRequest StartImageScan Source #
Instance details Defined in Amazonka.ECR.StartImageScan Associated Types type AWSResponse StartImageScan # Methods request :: (Service -> Service) -> StartImageScan -> Request StartImageScan # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartImageScan -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartImageScan))) #
Generic StartImageScan Source #
Instance details Defined in Amazonka.ECR.StartImageScan Associated Types type Rep StartImageScan :: Type -> Type # Methods from :: StartImageScan -> Rep StartImageScan x # to :: Rep StartImageScan x -> StartImageScan #
Read StartImageScan Source #
Instance details Defined in Amazonka.ECR.StartImageScan Methods readsPrec :: Int -> ReadS StartImageScan # readList :: ReadS [StartImageScan] # readPrec :: ReadPrec StartImageScan # readListPrec :: ReadPrec [StartImageScan] #
Show StartImageScan Source #
Instance details Defined in Amazonka.ECR.StartImageScan Methods showsPrec :: Int -> StartImageScan -> ShowS # show :: StartImageScan -> String # showList :: [StartImageScan] -> ShowS #
NFData StartImageScan Source #
Instance details Defined in Amazonka.ECR.StartImageScan Methods rnf :: StartImageScan -> () #
Eq StartImageScan Source #
Instance details Defined in Amazonka.ECR.StartImageScan Methods (==) :: StartImageScan -> StartImageScan -> Bool # (/=) :: StartImageScan -> StartImageScan -> Bool #
Hashable StartImageScan Source #
Instance details Defined in Amazonka.ECR.StartImageScan Methods hashWithSalt :: Int -> StartImageScan -> Int # hash :: StartImageScan -> Int #
type AWSResponse StartImageScan Source #
Instance details Defined in Amazonka.ECR.StartImageScan type AWSResponse StartImageScan = StartImageScanResponse
type Rep StartImageScan Source #
Instance details Defined in Amazonka.ECR.StartImageScan type Rep StartImageScan = D1 ('MetaData "StartImageScan" "Amazonka.ECR.StartImageScan" "amazonka-ecr-2.0-BqgZWPod2JCFn2nq69DCrJ" 'False) (C1 ('MetaCons "StartImageScan'" 'PrefixI 'True) (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))))

newStartImageScan Source #

Arguments

:: Text	`StartImageScan`
-> ImageIdentifier	`StartImageScan`
-> StartImageScan

Create a value of StartImageScan 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:

StartImageScan, startImageScan_registryId - The Amazon Web Services account ID associated with the registry that contains the repository in which to start an image scan request. If you do not specify a registry, the default registry is assumed.

StartImageScan, startImageScan_repositoryName - The name of the repository that contains the images to scan.

StartImageScan, startImageScan_imageId - Undocumented member.

Request Lenses

startImageScan_registryId :: Lens' StartImageScan (Maybe Text) Source #

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

startImageScan_repositoryName :: Lens' StartImageScan Text Source #

The name of the repository that contains the images to scan.

startImageScan_imageId :: Lens' StartImageScan ImageIdentifier Source #

Undocumented member.

Destructuring the Response

data StartImageScanResponse Source #

See: newStartImageScanResponse smart constructor.

Constructors

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

newStartImageScanResponse Source #

Arguments

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

Create a value of StartImageScanResponse 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:

StartImageScan, startImageScanResponse_imageId - Undocumented member.

StartImageScanResponse, startImageScanResponse_imageScanStatus - The current state of the scan.

StartImageScan, startImageScanResponse_registryId - The registry ID associated with the request.

StartImageScan, startImageScanResponse_repositoryName - The repository name associated with the request.

$sel:httpStatus:StartImageScanResponse', startImageScanResponse_httpStatus - The response's http status code.

Response Lenses

startImageScanResponse_imageId :: Lens' StartImageScanResponse (Maybe ImageIdentifier) Source #

Undocumented member.

startImageScanResponse_imageScanStatus :: Lens' StartImageScanResponse (Maybe ImageScanStatus) Source #

The current state of the scan.

startImageScanResponse_registryId :: Lens' StartImageScanResponse (Maybe Text) Source #

The registry ID associated with the request.

startImageScanResponse_repositoryName :: Lens' StartImageScanResponse (Maybe Text) Source #

The repository name associated with the request.

startImageScanResponse_httpStatus :: Lens' StartImageScanResponse Int Source #

The response's http status code.