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.SageMaker.ListImages

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the images in your account and their properties. The list can be filtered by creation time or modified time, and whether the image name contains a specified string.

This operation returns paginated results.

Synopsis

data ListImages = ListImages' {
- creationTimeAfter :: Maybe POSIX
- creationTimeBefore :: Maybe POSIX
- lastModifiedTimeAfter :: Maybe POSIX
- lastModifiedTimeBefore :: Maybe POSIX
- maxResults :: Maybe Natural
- nameContains :: Maybe Text
- nextToken :: Maybe Text
- sortBy :: Maybe ImageSortBy
- sortOrder :: Maybe ImageSortOrder
}
newListImages :: ListImages
listImages_creationTimeAfter :: Lens' ListImages (Maybe UTCTime)
listImages_creationTimeBefore :: Lens' ListImages (Maybe UTCTime)
listImages_lastModifiedTimeAfter :: Lens' ListImages (Maybe UTCTime)
listImages_lastModifiedTimeBefore :: Lens' ListImages (Maybe UTCTime)
listImages_maxResults :: Lens' ListImages (Maybe Natural)
listImages_nameContains :: Lens' ListImages (Maybe Text)
listImages_nextToken :: Lens' ListImages (Maybe Text)
listImages_sortBy :: Lens' ListImages (Maybe ImageSortBy)
listImages_sortOrder :: Lens' ListImages (Maybe ImageSortOrder)
data ListImagesResponse = ListImagesResponse' {
- images :: Maybe [Image]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListImagesResponse :: Int -> ListImagesResponse
listImagesResponse_images :: Lens' ListImagesResponse (Maybe [Image])
listImagesResponse_nextToken :: Lens' ListImagesResponse (Maybe Text)
listImagesResponse_httpStatus :: Lens' ListImagesResponse Int

Creating a Request

data ListImages Source #

See: newListImages smart constructor.

Constructors

ListImages'

Fields

creationTimeAfter :: Maybe POSIX
A filter that returns only images created on or after the specified time.
creationTimeBefore :: Maybe POSIX
A filter that returns only images created on or before the specified time.
lastModifiedTimeAfter :: Maybe POSIX
A filter that returns only images modified on or after the specified time.
lastModifiedTimeBefore :: Maybe POSIX
A filter that returns only images modified on or before the specified time.
maxResults :: Maybe Natural
The maximum number of images to return in the response. The default value is 10.
nameContains :: Maybe Text
A filter that returns only images whose name contains the specified string.
nextToken :: Maybe Text
If the previous call to ListImages didn't return the full set of images, the call returns a token for getting the next set of images.
sortBy :: Maybe ImageSortBy
The property used to sort results. The default value is CREATION_TIME.
sortOrder :: Maybe ImageSortOrder
The sort order. The default value is DESCENDING.

Instances

Instances details

ToJSON ListImages Source #
Instance details Defined in Amazonka.SageMaker.ListImages Methods toJSON :: ListImages -> Value # toEncoding :: ListImages -> Encoding # toJSONList :: [ListImages] -> Value # toEncodingList :: [ListImages] -> Encoding #
ToHeaders ListImages Source #
Instance details Defined in Amazonka.SageMaker.ListImages Methods toHeaders :: ListImages -> [Header] #
ToPath ListImages Source #
Instance details Defined in Amazonka.SageMaker.ListImages Methods toPath :: ListImages -> ByteString #
ToQuery ListImages Source #
Instance details Defined in Amazonka.SageMaker.ListImages Methods toQuery :: ListImages -> QueryString #
AWSPager ListImages Source #
Instance details Defined in Amazonka.SageMaker.ListImages Methods page :: ListImages -> AWSResponse ListImages -> Maybe ListImages #
AWSRequest ListImages Source #
Instance details Defined in Amazonka.SageMaker.ListImages Associated Types type AWSResponse ListImages # Methods request :: (Service -> Service) -> ListImages -> Request ListImages # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListImages -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListImages))) #
Generic ListImages Source #
Instance details Defined in Amazonka.SageMaker.ListImages Associated Types type Rep ListImages :: Type -> Type # Methods from :: ListImages -> Rep ListImages x # to :: Rep ListImages x -> ListImages #
Read ListImages Source #
Instance details Defined in Amazonka.SageMaker.ListImages Methods readsPrec :: Int -> ReadS ListImages # readList :: ReadS [ListImages] # readPrec :: ReadPrec ListImages # readListPrec :: ReadPrec [ListImages] #
Show ListImages Source #
Instance details Defined in Amazonka.SageMaker.ListImages Methods showsPrec :: Int -> ListImages -> ShowS # show :: ListImages -> String # showList :: [ListImages] -> ShowS #
NFData ListImages Source #
Instance details Defined in Amazonka.SageMaker.ListImages Methods rnf :: ListImages -> () #
Eq ListImages Source #
Instance details Defined in Amazonka.SageMaker.ListImages Methods (==) :: ListImages -> ListImages -> Bool # (/=) :: ListImages -> ListImages -> Bool #
Hashable ListImages Source #
Instance details Defined in Amazonka.SageMaker.ListImages Methods hashWithSalt :: Int -> ListImages -> Int # hash :: ListImages -> Int #
type AWSResponse ListImages Source #
Instance details Defined in Amazonka.SageMaker.ListImages type AWSResponse ListImages = ListImagesResponse
type Rep ListImages Source #
Instance details Defined in Amazonka.SageMaker.ListImages type Rep ListImages = D1 ('MetaData "ListImages" "Amazonka.SageMaker.ListImages" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListImages'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "creationTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "lastModifiedTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "lastModifiedTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nameContains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImageSortBy)) :: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImageSortOrder)))))))

newListImages :: ListImages Source #

Create a value of ListImages 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:creationTimeAfter:ListImages', listImages_creationTimeAfter - A filter that returns only images created on or after the specified time.

$sel:creationTimeBefore:ListImages', listImages_creationTimeBefore - A filter that returns only images created on or before the specified time.

$sel:lastModifiedTimeAfter:ListImages', listImages_lastModifiedTimeAfter - A filter that returns only images modified on or after the specified time.

$sel:lastModifiedTimeBefore:ListImages', listImages_lastModifiedTimeBefore - A filter that returns only images modified on or before the specified time.

$sel:maxResults:ListImages', listImages_maxResults - The maximum number of images to return in the response. The default value is 10.

$sel:nameContains:ListImages', listImages_nameContains - A filter that returns only images whose name contains the specified string.

ListImages, listImages_nextToken - If the previous call to ListImages didn't return the full set of images, the call returns a token for getting the next set of images.

$sel:sortBy:ListImages', listImages_sortBy - The property used to sort results. The default value is CREATION_TIME.

$sel:sortOrder:ListImages', listImages_sortOrder - The sort order. The default value is DESCENDING.

Request Lenses

listImages_creationTimeAfter :: Lens' ListImages (Maybe UTCTime) Source #

A filter that returns only images created on or after the specified time.

listImages_creationTimeBefore :: Lens' ListImages (Maybe UTCTime) Source #

A filter that returns only images created on or before the specified time.

listImages_lastModifiedTimeAfter :: Lens' ListImages (Maybe UTCTime) Source #

A filter that returns only images modified on or after the specified time.

listImages_lastModifiedTimeBefore :: Lens' ListImages (Maybe UTCTime) Source #

A filter that returns only images modified on or before the specified time.

listImages_maxResults :: Lens' ListImages (Maybe Natural) Source #

The maximum number of images to return in the response. The default value is 10.

listImages_nameContains :: Lens' ListImages (Maybe Text) Source #

A filter that returns only images whose name contains the specified string.

listImages_nextToken :: Lens' ListImages (Maybe Text) Source #

If the previous call to ListImages didn't return the full set of images, the call returns a token for getting the next set of images.

listImages_sortBy :: Lens' ListImages (Maybe ImageSortBy) Source #

The property used to sort results. The default value is CREATION_TIME.

listImages_sortOrder :: Lens' ListImages (Maybe ImageSortOrder) Source #

The sort order. The default value is DESCENDING.

Destructuring the Response

data ListImagesResponse Source #

See: newListImagesResponse smart constructor.

Constructors

ListImagesResponse'
Fields images :: Maybe [Image] A list of images and their properties. nextToken :: Maybe Text A token for getting the next set of images, if there are any. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListImagesResponse Source #
Instance details Defined in Amazonka.SageMaker.ListImages Associated Types type Rep ListImagesResponse :: Type -> Type # Methods from :: ListImagesResponse -> Rep ListImagesResponse x # to :: Rep ListImagesResponse x -> ListImagesResponse #
Read ListImagesResponse Source #
Instance details Defined in Amazonka.SageMaker.ListImages Methods readsPrec :: Int -> ReadS ListImagesResponse # readList :: ReadS [ListImagesResponse] # readPrec :: ReadPrec ListImagesResponse # readListPrec :: ReadPrec [ListImagesResponse] #
Show ListImagesResponse Source #
Instance details Defined in Amazonka.SageMaker.ListImages Methods showsPrec :: Int -> ListImagesResponse -> ShowS # show :: ListImagesResponse -> String # showList :: [ListImagesResponse] -> ShowS #
NFData ListImagesResponse Source #
Instance details Defined in Amazonka.SageMaker.ListImages Methods rnf :: ListImagesResponse -> () #
Eq ListImagesResponse Source #
Instance details Defined in Amazonka.SageMaker.ListImages Methods (==) :: ListImagesResponse -> ListImagesResponse -> Bool # (/=) :: ListImagesResponse -> ListImagesResponse -> Bool #
type Rep ListImagesResponse Source #
Instance details Defined in Amazonka.SageMaker.ListImages type Rep ListImagesResponse = D1 ('MetaData "ListImagesResponse" "Amazonka.SageMaker.ListImages" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListImagesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "images") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Image])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListImagesResponse Source #

Arguments

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

Create a value of ListImagesResponse 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:images:ListImagesResponse', listImagesResponse_images - A list of images and their properties.

ListImages, listImagesResponse_nextToken - A token for getting the next set of images, if there are any.

$sel:httpStatus:ListImagesResponse', listImagesResponse_httpStatus - The response's http status code.

Response Lenses

listImagesResponse_images :: Lens' ListImagesResponse (Maybe [Image]) Source #

A list of images and their properties.

listImagesResponse_nextToken :: Lens' ListImagesResponse (Maybe Text) Source #

A token for getting the next set of images, if there are any.

listImagesResponse_httpStatus :: Lens' ListImagesResponse Int Source #

The response's http status code.