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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the results of the lifecycle policy preview request for the specified repository.

This operation returns paginated results.

Synopsis

Creating a Request

data GetLifecyclePolicyPreview Source #

See: newGetLifecyclePolicyPreview smart constructor.

Constructors

GetLifecyclePolicyPreview'

Fields

filter' :: Maybe LifecyclePolicyPreviewFilter
An optional parameter that filters results based on image tag status and all tags, if tagged.
imageIds :: Maybe [ImageIdentifier]
The list of imageIDs to be included.
maxResults :: Maybe Natural
The maximum number of repository results returned by GetLifecyclePolicyPreviewRequest in  paginated output. When this parameter is used, GetLifecyclePolicyPreviewRequest 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 GetLifecyclePolicyPreviewRequest request with the returned nextToken  value. This value can be between 1 and 1000. If this  parameter is not used, then GetLifecyclePolicyPreviewRequest returns up to  100 results and a nextToken value, if  applicable. This option cannot be used when you specify images with imageIds.
nextToken :: Maybe Text
The nextToken value returned from a previous paginated  GetLifecyclePolicyPreviewRequest 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. This option cannot be used when you specify images with imageIds.
registryId :: Maybe Text
The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.
repositoryName :: Text
The name of the repository.

Instances

Instances details

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

newGetLifecyclePolicyPreview Source #

Arguments

:: Text	`GetLifecyclePolicyPreview`
-> GetLifecyclePolicyPreview

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

GetLifecyclePolicyPreview, getLifecyclePolicyPreview_filter - An optional parameter that filters results based on image tag status and all tags, if tagged.

$sel:imageIds:GetLifecyclePolicyPreview', getLifecyclePolicyPreview_imageIds - The list of imageIDs to be included.

$sel:maxResults:GetLifecyclePolicyPreview', getLifecyclePolicyPreview_maxResults - The maximum number of repository results returned by GetLifecyclePolicyPreviewRequest in  paginated output. When this parameter is used, GetLifecyclePolicyPreviewRequest 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 GetLifecyclePolicyPreviewRequest request with the returned nextToken  value. This value can be between 1 and 1000. If this  parameter is not used, then GetLifecyclePolicyPreviewRequest returns up to  100 results and a nextToken value, if  applicable. This option cannot be used when you specify images with imageIds.

GetLifecyclePolicyPreview, getLifecyclePolicyPreview_nextToken - The nextToken value returned from a previous paginated  GetLifecyclePolicyPreviewRequest 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. This option cannot be used when you specify images with imageIds.

GetLifecyclePolicyPreview, getLifecyclePolicyPreview_registryId - The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

GetLifecyclePolicyPreview, getLifecyclePolicyPreview_repositoryName - The name of the repository.

Request Lenses

getLifecyclePolicyPreview_filter :: Lens' GetLifecyclePolicyPreview (Maybe LifecyclePolicyPreviewFilter) Source #

An optional parameter that filters results based on image tag status and all tags, if tagged.

getLifecyclePolicyPreview_imageIds :: Lens' GetLifecyclePolicyPreview (Maybe [ImageIdentifier]) Source #

The list of imageIDs to be included.

getLifecyclePolicyPreview_maxResults :: Lens' GetLifecyclePolicyPreview (Maybe Natural) Source #

The maximum number of repository results returned by GetLifecyclePolicyPreviewRequest in  paginated output. When this parameter is used, GetLifecyclePolicyPreviewRequest 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 GetLifecyclePolicyPreviewRequest request with the returned nextToken  value. This value can be between 1 and 1000. If this  parameter is not used, then GetLifecyclePolicyPreviewRequest returns up to  100 results and a nextToken value, if  applicable. This option cannot be used when you specify images with imageIds.

getLifecyclePolicyPreview_nextToken :: Lens' GetLifecyclePolicyPreview (Maybe Text) Source #

The nextToken value returned from a previous paginated  GetLifecyclePolicyPreviewRequest 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. This option cannot be used when you specify images with imageIds.

getLifecyclePolicyPreview_registryId :: Lens' GetLifecyclePolicyPreview (Maybe Text) Source #

The Amazon Web Services account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

getLifecyclePolicyPreview_repositoryName :: Lens' GetLifecyclePolicyPreview Text Source #

The name of the repository.

Destructuring the Response

data GetLifecyclePolicyPreviewResponse Source #

See: newGetLifecyclePolicyPreviewResponse smart constructor.

Constructors

GetLifecyclePolicyPreviewResponse'

Fields

lifecyclePolicyText :: Maybe Text
The JSON lifecycle policy text.
nextToken :: Maybe Text
The nextToken value to include in a future GetLifecyclePolicyPreview request. When the results of a GetLifecyclePolicyPreview 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.
previewResults :: Maybe [LifecyclePolicyPreviewResult]
The results of the lifecycle policy preview request.
registryId :: Maybe Text
The registry ID associated with the request.
repositoryName :: Maybe Text
The repository name associated with the request.
status :: Maybe LifecyclePolicyPreviewStatus
The status of the lifecycle policy preview request.
summary :: Maybe LifecyclePolicyPreviewSummary
The list of images that is returned as a result of the action.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetLifecyclePolicyPreviewResponse Source #
Instance details Defined in Amazonka.ECR.GetLifecyclePolicyPreview Associated Types type Rep GetLifecyclePolicyPreviewResponse :: Type -> Type # Methods from :: GetLifecyclePolicyPreviewResponse -> Rep GetLifecyclePolicyPreviewResponse x # to :: Rep GetLifecyclePolicyPreviewResponse x -> GetLifecyclePolicyPreviewResponse #
Read GetLifecyclePolicyPreviewResponse Source #
Instance details Defined in Amazonka.ECR.GetLifecyclePolicyPreview Methods readsPrec :: Int -> ReadS GetLifecyclePolicyPreviewResponse # readList :: ReadS [GetLifecyclePolicyPreviewResponse] # readPrec :: ReadPrec GetLifecyclePolicyPreviewResponse # readListPrec :: ReadPrec [GetLifecyclePolicyPreviewResponse] #
Show GetLifecyclePolicyPreviewResponse Source #
Instance details Defined in Amazonka.ECR.GetLifecyclePolicyPreview Methods showsPrec :: Int -> GetLifecyclePolicyPreviewResponse -> ShowS # show :: GetLifecyclePolicyPreviewResponse -> String # showList :: [GetLifecyclePolicyPreviewResponse] -> ShowS #
NFData GetLifecyclePolicyPreviewResponse Source #
Instance details Defined in Amazonka.ECR.GetLifecyclePolicyPreview Methods rnf :: GetLifecyclePolicyPreviewResponse -> () #
Eq GetLifecyclePolicyPreviewResponse Source #
Instance details Defined in Amazonka.ECR.GetLifecyclePolicyPreview Methods (==) :: GetLifecyclePolicyPreviewResponse -> GetLifecyclePolicyPreviewResponse -> Bool # (/=) :: GetLifecyclePolicyPreviewResponse -> GetLifecyclePolicyPreviewResponse -> Bool #
type Rep GetLifecyclePolicyPreviewResponse Source #
Instance details Defined in Amazonka.ECR.GetLifecyclePolicyPreview type Rep GetLifecyclePolicyPreviewResponse = D1 ('MetaData "GetLifecyclePolicyPreviewResponse" "Amazonka.ECR.GetLifecyclePolicyPreview" "amazonka-ecr-2.0-BqgZWPod2JCFn2nq69DCrJ" 'False) (C1 ('MetaCons "GetLifecyclePolicyPreviewResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "lifecyclePolicyText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "previewResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LifecyclePolicyPreviewResult])) :: S1 ('MetaSel ('Just "registryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "repositoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LifecyclePolicyPreviewStatus))) :: (S1 ('MetaSel ('Just "summary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LifecyclePolicyPreviewSummary)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetLifecyclePolicyPreviewResponse Source #

Arguments

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

Create a value of GetLifecyclePolicyPreviewResponse 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:lifecyclePolicyText:GetLifecyclePolicyPreviewResponse', getLifecyclePolicyPreviewResponse_lifecyclePolicyText - The JSON lifecycle policy text.

GetLifecyclePolicyPreview, getLifecyclePolicyPreviewResponse_nextToken - The nextToken value to include in a future GetLifecyclePolicyPreview request. When the results of a GetLifecyclePolicyPreview 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:previewResults:GetLifecyclePolicyPreviewResponse', getLifecyclePolicyPreviewResponse_previewResults - The results of the lifecycle policy preview request.

GetLifecyclePolicyPreview, getLifecyclePolicyPreviewResponse_registryId - The registry ID associated with the request.

GetLifecyclePolicyPreview, getLifecyclePolicyPreviewResponse_repositoryName - The repository name associated with the request.

GetLifecyclePolicyPreviewResponse, getLifecyclePolicyPreviewResponse_status - The status of the lifecycle policy preview request.

$sel:summary:GetLifecyclePolicyPreviewResponse', getLifecyclePolicyPreviewResponse_summary - The list of images that is returned as a result of the action.

$sel:httpStatus:GetLifecyclePolicyPreviewResponse', getLifecyclePolicyPreviewResponse_httpStatus - The response's http status code.

Response Lenses

getLifecyclePolicyPreviewResponse_lifecyclePolicyText :: Lens' GetLifecyclePolicyPreviewResponse (Maybe Text) Source #

The JSON lifecycle policy text.

getLifecyclePolicyPreviewResponse_nextToken :: Lens' GetLifecyclePolicyPreviewResponse (Maybe Text) Source #

The nextToken value to include in a future GetLifecyclePolicyPreview request. When the results of a GetLifecyclePolicyPreview 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.

getLifecyclePolicyPreviewResponse_previewResults :: Lens' GetLifecyclePolicyPreviewResponse (Maybe [LifecyclePolicyPreviewResult]) Source #

The results of the lifecycle policy preview request.

getLifecyclePolicyPreviewResponse_registryId :: Lens' GetLifecyclePolicyPreviewResponse (Maybe Text) Source #

The registry ID associated with the request.

getLifecyclePolicyPreviewResponse_repositoryName :: Lens' GetLifecyclePolicyPreviewResponse (Maybe Text) Source #

The repository name associated with the request.

getLifecyclePolicyPreviewResponse_status :: Lens' GetLifecyclePolicyPreviewResponse (Maybe LifecyclePolicyPreviewStatus) Source #

The status of the lifecycle policy preview request.

getLifecyclePolicyPreviewResponse_summary :: Lens' GetLifecyclePolicyPreviewResponse (Maybe LifecyclePolicyPreviewSummary) Source #

The list of images that is returned as a result of the action.

getLifecyclePolicyPreviewResponse_httpStatus :: Lens' GetLifecyclePolicyPreviewResponse Int Source #

The response's http status code.