Amazonka.ImageBuilder.ListImages

Returns the list of images that you have access to.

Creating a Request

data ListImages

See: newListImages smart constructor.

Constructors

ListImages'

Fields

• byName :: Maybe Bool

  Requests a list of images with a specific recipe name.

• filters :: Maybe (NonEmpty Filter)

  Use the following filters to streamline results:

  • name

  • osVersion

  • platform

  • type

  • version

• includeDeprecated :: Maybe Bool

  Includes deprecated images in the response list.

• maxResults :: Maybe Natural

  The maximum items to return in a request.

• nextToken :: Maybe Text

  A token to specify where to start paginating. This is the NextToken from a previously truncated response.

• owner :: Maybe Ownership

  The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.

Instances

ToJSON ListImages

Defined in Amazonka.ImageBuilder.ListImages

Methods

toJSON :: ListImages -> Value

toEncoding :: ListImages -> Encoding

toJSONList :: [ListImages] -> Value

toEncodingList :: [ListImages] -> Encoding

ToHeaders ListImages

Defined in Amazonka.ImageBuilder.ListImages

Methods

toHeaders :: ListImages -> [Header]

ToPath ListImages

Defined in Amazonka.ImageBuilder.ListImages

Methods

toPath :: ListImages -> ByteString

ToQuery ListImages

Defined in Amazonka.ImageBuilder.ListImages

Methods

toQuery :: ListImages -> QueryString

AWSRequest ListImages

Defined in Amazonka.ImageBuilder.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

Defined in Amazonka.ImageBuilder.ListImages

Associated Types

type Rep ListImages :: Type -> Type

Methods

from :: ListImages -> Rep ListImages x

to :: Rep ListImages x -> ListImages

Read ListImages

Defined in Amazonka.ImageBuilder.ListImages

Methods

readsPrec :: Int -> ReadS ListImages

readList :: ReadS [ListImages]

readPrec :: ReadPrec ListImages

readListPrec :: ReadPrec [ListImages]

Show ListImages

Defined in Amazonka.ImageBuilder.ListImages

Methods

showsPrec :: Int -> ListImages -> ShowS

show :: ListImages -> String

showList :: [ListImages] -> ShowS

NFData ListImages

Defined in Amazonka.ImageBuilder.ListImages

Methods

rnf :: ListImages -> ()

Eq ListImages

Defined in Amazonka.ImageBuilder.ListImages

Methods

(==) :: ListImages -> ListImages -> Bool

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

Hashable ListImages

Defined in Amazonka.ImageBuilder.ListImages

Methods

hashWithSalt :: Int -> ListImages -> Int

hash :: ListImages -> Int

type AWSResponse ListImages

Defined in Amazonka.ImageBuilder.ListImages

type AWSResponse ListImages = ListImagesResponse

type Rep ListImages

Defined in Amazonka.ImageBuilder.ListImages

type Rep ListImages = D1 ('MetaData "ListImages" "Amazonka.ImageBuilder.ListImages" "amazonka-imagebuilder-2.0-BBLLjX59RW72O8VbQ3vKvH" 'False) (C1 ('MetaCons "ListImages'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "byName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Filter))) :*: S1 ('MetaSel ('Just "includeDeprecated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "owner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Ownership))))))

newListImages :: ListImages

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:byName:ListImages', listImages_byName - Requests a list of images with a specific recipe name.

$sel:filters:ListImages', listImages_filters - Use the following filters to streamline results:

• name

• osVersion

• platform

• type

• version

$sel:includeDeprecated:ListImages', listImages_includeDeprecated - Includes deprecated images in the response list.

$sel:maxResults:ListImages', listImages_maxResults - The maximum items to return in a request.

ListImages, listImages_nextToken - A token to specify where to start paginating. This is the NextToken from a previously truncated response.

ListImages, listImages_owner - The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.

Request Lenses

listImages_byName :: Lens' ListImages (Maybe Bool)

Requests a list of images with a specific recipe name.

listImages_filters :: Lens' ListImages (Maybe (NonEmpty Filter))

Use the following filters to streamline results:

• name

• osVersion

• platform

• type

• version

listImages_includeDeprecated :: Lens' ListImages (Maybe Bool)

Includes deprecated images in the response list.

listImages_maxResults :: Lens' ListImages (Maybe Natural)

The maximum items to return in a request.

listImages_nextToken :: Lens' ListImages (Maybe Text)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

listImages_owner :: Lens' ListImages (Maybe Ownership)

The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.

Destructuring the Response

data ListImagesResponse

See: newListImagesResponse smart constructor.

Constructors

ListImagesResponse'

Fields

• imageVersionList :: Maybe [ImageVersion]

  The list of image semantic versions.

  The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

  Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

• nextToken :: Maybe Text

  The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

• requestId :: Maybe Text

  The request ID that uniquely identifies this request.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListImagesResponse

Defined in Amazonka.ImageBuilder.ListImages

Associated Types

type Rep ListImagesResponse :: Type -> Type

Methods

from :: ListImagesResponse -> Rep ListImagesResponse x

to :: Rep ListImagesResponse x -> ListImagesResponse

Read ListImagesResponse

Defined in Amazonka.ImageBuilder.ListImages

Methods

readsPrec :: Int -> ReadS ListImagesResponse

readList :: ReadS [ListImagesResponse]

readPrec :: ReadPrec ListImagesResponse

readListPrec :: ReadPrec [ListImagesResponse]

Show ListImagesResponse

Defined in Amazonka.ImageBuilder.ListImages

Methods

showsPrec :: Int -> ListImagesResponse -> ShowS

show :: ListImagesResponse -> String

showList :: [ListImagesResponse] -> ShowS

NFData ListImagesResponse

Defined in Amazonka.ImageBuilder.ListImages

Methods

rnf :: ListImagesResponse -> ()

Eq ListImagesResponse

Defined in Amazonka.ImageBuilder.ListImages

Methods

(==) :: ListImagesResponse -> ListImagesResponse -> Bool

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

type Rep ListImagesResponse

Defined in Amazonka.ImageBuilder.ListImages

type Rep ListImagesResponse = D1 ('MetaData "ListImagesResponse" "Amazonka.ImageBuilder.ListImages" "amazonka-imagebuilder-2.0-BBLLjX59RW72O8VbQ3vKvH" 'False) (C1 ('MetaCons "ListImagesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "imageVersionList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ImageVersion])) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListImagesResponse

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:imageVersionList:ListImagesResponse', listImagesResponse_imageVersionList - The list of image semantic versions.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

ListImages, listImagesResponse_nextToken - The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

$sel:requestId:ListImagesResponse', listImagesResponse_requestId - The request ID that uniquely identifies this request.

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

Response Lenses

listImagesResponse_imageVersionList :: Lens' ListImagesResponse (Maybe [ImageVersion])

The list of image semantic versions.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

listImagesResponse_nextToken :: Lens' ListImagesResponse (Maybe Text)

The next token used for paginated responses. When this is not empty, there are additional elements that the service has not included in this request. Use this token with the next request to retrieve additional objects.

listImagesResponse_requestId :: Lens' ListImagesResponse (Maybe Text)

The request ID that uniquely identifies this request.

listImagesResponse_httpStatus :: Lens' ListImagesResponse Int

The response's http status code.