Jump to Content

Interface ListImagesRequest

Hierarchy

Properties

filter? maxResults? nextToken? registryId? repositoryName

Properties

Optional filter

filter?: ListImagesFilter

The filter key and value with which to filter your ListImages results.

Optional maxResults

maxResults?: number

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

Optional nextToken

nextToken?: string

The nextToken value returned from a previous paginated ListImages 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 token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Optional registryId

registryId?: string

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

repositoryName

repositoryName: undefined | string

The repository with image IDs to be listed.

Settings

Member Visibility

Theme