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

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

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

  • imageIds :: Maybe [ImageIdentifier]

    The list of imageIDs to be included.

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

  • filter' :: Maybe LifecyclePolicyPreviewFilter

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

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

  • repositoryName :: Text

    The name of the repository.

Instances

Instances details
Eq GetLifecyclePolicyPreview Source # 
Instance details

Defined in Amazonka.ECR.GetLifecyclePolicyPreview

Read GetLifecyclePolicyPreview Source # 
Instance details

Defined in Amazonka.ECR.GetLifecyclePolicyPreview

Show GetLifecyclePolicyPreview Source # 
Instance details

Defined in Amazonka.ECR.GetLifecyclePolicyPreview

Generic GetLifecyclePolicyPreview Source # 
Instance details

Defined in Amazonka.ECR.GetLifecyclePolicyPreview

Associated Types

type Rep GetLifecyclePolicyPreview :: Type -> Type #

NFData GetLifecyclePolicyPreview Source # 
Instance details

Defined in Amazonka.ECR.GetLifecyclePolicyPreview

Hashable GetLifecyclePolicyPreview Source # 
Instance details

Defined in Amazonka.ECR.GetLifecyclePolicyPreview

ToJSON GetLifecyclePolicyPreview Source # 
Instance details

Defined in Amazonka.ECR.GetLifecyclePolicyPreview

AWSPager GetLifecyclePolicyPreview Source # 
Instance details

Defined in Amazonka.ECR.GetLifecyclePolicyPreview

AWSRequest GetLifecyclePolicyPreview Source # 
Instance details

Defined in Amazonka.ECR.GetLifecyclePolicyPreview

ToHeaders GetLifecyclePolicyPreview Source # 
Instance details

Defined in Amazonka.ECR.GetLifecyclePolicyPreview

ToPath GetLifecyclePolicyPreview Source # 
Instance details

Defined in Amazonka.ECR.GetLifecyclePolicyPreview

ToQuery GetLifecyclePolicyPreview Source # 
Instance details

Defined in Amazonka.ECR.GetLifecyclePolicyPreview

type Rep GetLifecyclePolicyPreview Source # 
Instance details

Defined in Amazonka.ECR.GetLifecyclePolicyPreview

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

Defined in Amazonka.ECR.GetLifecyclePolicyPreview

newGetLifecyclePolicyPreview Source #

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:

$sel:registryId: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.

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

$sel:nextToken: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.

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

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

$sel:repositoryName:GetLifecyclePolicyPreview', getLifecyclePolicyPreview_repositoryName - The name of the repository.

Request Lenses

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_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_filter :: Lens' GetLifecyclePolicyPreview (Maybe LifecyclePolicyPreviewFilter) Source #

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

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.

Destructuring the Response

data GetLifecyclePolicyPreviewResponse Source #

See: newGetLifecyclePolicyPreviewResponse smart constructor.

Constructors

GetLifecyclePolicyPreviewResponse' 

Fields

Instances

Instances details
Eq GetLifecyclePolicyPreviewResponse Source # 
Instance details

Defined in Amazonka.ECR.GetLifecyclePolicyPreview

Read GetLifecyclePolicyPreviewResponse Source # 
Instance details

Defined in Amazonka.ECR.GetLifecyclePolicyPreview

Show GetLifecyclePolicyPreviewResponse Source # 
Instance details

Defined in Amazonka.ECR.GetLifecyclePolicyPreview

Generic GetLifecyclePolicyPreviewResponse Source # 
Instance details

Defined in Amazonka.ECR.GetLifecyclePolicyPreview

Associated Types

type Rep GetLifecyclePolicyPreviewResponse :: Type -> Type #

NFData GetLifecyclePolicyPreviewResponse Source # 
Instance details

Defined in Amazonka.ECR.GetLifecyclePolicyPreview

type Rep GetLifecyclePolicyPreviewResponse Source # 
Instance details

Defined in Amazonka.ECR.GetLifecyclePolicyPreview

newGetLifecyclePolicyPreviewResponse Source #

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:summary:GetLifecyclePolicyPreviewResponse', getLifecyclePolicyPreviewResponse_summary - The list of images that is returned as a result of the action.

$sel:status:GetLifecyclePolicyPreviewResponse', getLifecyclePolicyPreviewResponse_status - The status of the lifecycle policy preview request.

$sel:registryId:GetLifecyclePolicyPreview', getLifecyclePolicyPreviewResponse_registryId - The registry ID associated with the request.

$sel:lifecyclePolicyText:GetLifecyclePolicyPreviewResponse', getLifecyclePolicyPreviewResponse_lifecyclePolicyText - The JSON lifecycle policy text.

$sel:nextToken: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:repositoryName:GetLifecyclePolicyPreview', getLifecyclePolicyPreviewResponse_repositoryName - The repository name associated with the request.

$sel:previewResults:GetLifecyclePolicyPreviewResponse', getLifecyclePolicyPreviewResponse_previewResults - The results of the lifecycle policy preview request.

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

Response Lenses

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.