amazonka-imagebuilder-2.0: Amazon EC2 Image Builder SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ImageBuilder.ListImages

Description

Returns the list of images that you have access to.

Synopsis

Creating a Request

data ListImages Source #

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

Instances details
ToJSON ListImages Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImages

ToHeaders ListImages Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImages

Methods

toHeaders :: ListImages -> [Header] #

ToPath ListImages Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImages

ToQuery ListImages Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImages

AWSRequest ListImages Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImages

Associated Types

type AWSResponse ListImages #

Generic ListImages Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImages

Associated Types

type Rep ListImages :: Type -> Type #

Read ListImages Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImages

Show ListImages Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImages

NFData ListImages Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImages

Methods

rnf :: ListImages -> () #

Eq ListImages Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImages

Hashable ListImages Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImages

type AWSResponse ListImages Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImages

type Rep ListImages Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImages

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: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) Source #

Requests a list of images with a specific recipe name.

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

Use the following filters to streamline results:

  • name
  • osVersion
  • platform
  • type
  • version

listImages_includeDeprecated :: Lens' ListImages (Maybe Bool) Source #

Includes deprecated images in the response list.

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

The maximum items to return in a request.

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

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

listImages_owner :: Lens' ListImages (Maybe Ownership) Source #

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 Source #

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

Instances details
Generic ListImagesResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImages

Associated Types

type Rep ListImagesResponse :: Type -> Type #

Read ListImagesResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImages

Show ListImagesResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImages

NFData ListImagesResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImages

Methods

rnf :: ListImagesResponse -> () #

Eq ListImagesResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImages

type Rep ListImagesResponse Source # 
Instance details

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 Source #

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]) Source #

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) Source #

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) Source #

The request ID that uniquely identifies this request.