Network.AWS.ECR.DescribeImages

Returns metadata about the images in a repository, including image size, image tags, and creation date.

This operation returns paginated results.

Creating a Request

describeImages

Arguments

:: Text

diRepositoryName

-> DescribeImages

Creates a value of DescribeImages with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• diRegistryId - The AWS account ID associated with the registry that contains the repository in which to describe images. If you do not specify a registry, the default registry is assumed.
• diImageIds - The list of image IDs for the requested repository.
• diNextToken - The nextToken value returned from a previous paginated DescribeImages 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.
• diFilter - The filter key and value with which to filter your DescribeImages results.
• diMaxResults - The maximum number of repository results returned by DescribeImages in paginated output. When this parameter is used, DescribeImages 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 DescribeImages request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeImages returns up to 100 results and a nextToken value, if applicable.
• diRepositoryName - A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.

data DescribeImages

See: describeImages smart constructor.

Instances

Eq DescribeImages

Methods

(==) :: DescribeImages -> DescribeImages -> Bool

(/=) :: DescribeImages -> DescribeImages -> Bool

Data DescribeImages

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeImages -> c DescribeImages

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeImages

toConstr :: DescribeImages -> Constr

dataTypeOf :: DescribeImages -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeImages)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeImages)

gmapT :: (forall b. Data b => b -> b) -> DescribeImages -> DescribeImages

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeImages -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeImages -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeImages -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeImages -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeImages -> m DescribeImages

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeImages -> m DescribeImages

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeImages -> m DescribeImages

Read DescribeImages

Methods

readsPrec :: Int -> ReadS DescribeImages

readList :: ReadS [DescribeImages]

readPrec :: ReadPrec DescribeImages

readListPrec :: ReadPrec [DescribeImages]

Show DescribeImages

Methods

showsPrec :: Int -> DescribeImages -> ShowS

show :: DescribeImages -> String

showList :: [DescribeImages] -> ShowS

Generic DescribeImages

Associated Types

type Rep DescribeImages :: * -> *

Methods

from :: DescribeImages -> Rep DescribeImages x

to :: Rep DescribeImages x -> DescribeImages

Hashable DescribeImages

Methods

hashWithSalt :: Int -> DescribeImages -> Int

hash :: DescribeImages -> Int

ToJSON DescribeImages

Methods

toJSON :: DescribeImages -> Value

toEncoding :: DescribeImages -> Encoding

toJSONList :: [DescribeImages] -> Value

toEncodingList :: [DescribeImages] -> Encoding

NFData DescribeImages

Methods

rnf :: DescribeImages -> ()

AWSPager DescribeImages

Methods

page :: DescribeImages -> Rs DescribeImages -> Maybe DescribeImages

AWSRequest DescribeImages

Associated Types

type Rs DescribeImages :: *

Methods

request :: DescribeImages -> Request DescribeImages

response :: MonadResource m => Logger -> Service -> Proxy * DescribeImages -> ClientResponse -> m (Response DescribeImages)

ToQuery DescribeImages

Methods

toQuery :: DescribeImages -> QueryString

ToPath DescribeImages

Methods

toPath :: DescribeImages -> ByteString

ToHeaders DescribeImages

Methods

toHeaders :: DescribeImages -> [Header]

type Rep DescribeImages

type Rep DescribeImages = D1 (MetaData "DescribeImages" "Network.AWS.ECR.DescribeImages" "amazonka-ecr-1.5.0-1vFH5BbiUOBDG4NzPySvaV" False) (C1 (MetaCons "DescribeImages'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_diRegistryId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_diImageIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ImageIdentifier]))) (S1 (MetaSel (Just Symbol "_diNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_diFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DescribeImagesFilter))) ((:*:) (S1 (MetaSel (Just Symbol "_diMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_diRepositoryName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs DescribeImages

type Rs DescribeImages = DescribeImagesResponse

Request Lenses

diRegistryId :: Lens' DescribeImages (Maybe Text)

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

diImageIds :: Lens' DescribeImages [ImageIdentifier]

The list of image IDs for the requested repository.

diNextToken :: Lens' DescribeImages (Maybe Text)

The nextToken value returned from a previous paginated DescribeImages 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.

diFilter :: Lens' DescribeImages (Maybe DescribeImagesFilter)

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

diMaxResults :: Lens' DescribeImages (Maybe Natural)

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

diRepositoryName :: Lens' DescribeImages Text

A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.

Destructuring the Response

describeImagesResponse

Arguments

:: Int

dirsResponseStatus

-> DescribeImagesResponse

Creates a value of DescribeImagesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dirsImageDetails - A list of ImageDetail objects that contain data about the image.
• dirsNextToken - The nextToken value to include in a future DescribeImages request. When the results of a DescribeImages 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.
• dirsResponseStatus - -- | The response status code.

data DescribeImagesResponse

See: describeImagesResponse smart constructor.

Instances

Eq DescribeImagesResponse

Methods

(==) :: DescribeImagesResponse -> DescribeImagesResponse -> Bool

(/=) :: DescribeImagesResponse -> DescribeImagesResponse -> Bool

Data DescribeImagesResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeImagesResponse -> c DescribeImagesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeImagesResponse

toConstr :: DescribeImagesResponse -> Constr

dataTypeOf :: DescribeImagesResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeImagesResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeImagesResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeImagesResponse -> DescribeImagesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeImagesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeImagesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeImagesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeImagesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeImagesResponse -> m DescribeImagesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeImagesResponse -> m DescribeImagesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeImagesResponse -> m DescribeImagesResponse

Read DescribeImagesResponse

Methods

readsPrec :: Int -> ReadS DescribeImagesResponse

readList :: ReadS [DescribeImagesResponse]

readPrec :: ReadPrec DescribeImagesResponse

readListPrec :: ReadPrec [DescribeImagesResponse]

Show DescribeImagesResponse

Methods

showsPrec :: Int -> DescribeImagesResponse -> ShowS

show :: DescribeImagesResponse -> String

showList :: [DescribeImagesResponse] -> ShowS

Generic DescribeImagesResponse

Associated Types

type Rep DescribeImagesResponse :: * -> *

Methods

from :: DescribeImagesResponse -> Rep DescribeImagesResponse x

to :: Rep DescribeImagesResponse x -> DescribeImagesResponse

NFData DescribeImagesResponse

Methods

rnf :: DescribeImagesResponse -> ()

type Rep DescribeImagesResponse

type Rep DescribeImagesResponse = D1 (MetaData "DescribeImagesResponse" "Network.AWS.ECR.DescribeImages" "amazonka-ecr-1.5.0-1vFH5BbiUOBDG4NzPySvaV" False) (C1 (MetaCons "DescribeImagesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dirsImageDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ImageDetail]))) ((:*:) (S1 (MetaSel (Just Symbol "_dirsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

dirsImageDetails :: Lens' DescribeImagesResponse [ImageDetail]

A list of ImageDetail objects that contain data about the image.

dirsNextToken :: Lens' DescribeImagesResponse (Maybe Text)

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

dirsResponseStatus :: Lens' DescribeImagesResponse Int

• - | The response status code.