Skip to content

GetLifecyclePolicyPreviewRequest

Source code in docs_src/capo_ecr/types/get_lifecycle_policy_preview_request.py
class GetLifecyclePolicyPreviewRequest(TypedDict, closed=True):
    registry_id: NotRequired["capo_ecr.types.registry_id.RegistryId"]
    """<p>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.</p>"""
    repository_name: "capo_ecr.types.repository_name.RepositoryName"
    """<p>The name of the repository.</p>"""
    image_ids: NotRequired["capo_ecr.types.image_identifier_list.ImageIdentifierList"]
    """<p>The list of imageIDs to be included.</p>"""
    next_token: NotRequired["capo_ecr.types.next_token.NextToken"]
    """<p>The <code>nextToken</code> value returned from a previous paginated <code>GetLifecyclePolicyPreviewRequest</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return. This option cannot be used when you specify images with <code>imageIds</code>.</p>"""
    max_results: NotRequired[
        "capo_ecr.types.lifecycle_preview_max_results.LifecyclePreviewMaxResults"
    ]
    """<p>The maximum number of repository results returned by <code>GetLifecyclePolicyPreviewRequest</code> in paginated output. When this parameter is used, <code>GetLifecyclePolicyPreviewRequest</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>GetLifecyclePolicyPreviewRequest</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>GetLifecyclePolicyPreviewRequest</code> returns up to 100 results and a <code>nextToken</code> value, if applicable. This option cannot be used when you specify images with <code>imageIds</code>.</p>"""
    filter: NotRequired[
        "capo_ecr.types.lifecycle_policy_preview_filter.LifecyclePolicyPreviewFilter"
    ]
    """<p>An optional parameter that filters results based on image tag status and all tags, if tagged.</p>"""

filter instance-attribute

filter: NotRequired[LifecyclePolicyPreviewFilter]

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

image_ids instance-attribute

image_ids: NotRequired[ImageIdentifierList]

The list of imageIDs to be included.

max_results instance-attribute

max_results: NotRequired[LifecyclePreviewMaxResults]

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

next_token instance-attribute

next_token: NotRequired[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.

registry_id instance-attribute

registry_id: NotRequired[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.

repository_name instance-attribute

repository_name: RepositoryName

The name of the repository.