libZSservicesZSamazonka-imagebuilderZSamazonka-imagebuilder
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ImageBuilder.ListImageRecipes

Description

Returns a list of image recipes.

Synopsis

Creating a Request

data ListImageRecipes Source #

See: newListImageRecipes smart constructor.

Constructors

ListImageRecipes' 

Fields

  • filters :: Maybe (NonEmpty Filter)

    Use the following filters to streamline results:

    • name
    • parentImage
    • platform
  • owner :: Maybe Ownership

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

  • nextToken :: Maybe Text

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

  • maxResults :: Maybe Natural

    The maximum items to return in a request.

Instances

Instances details
Eq ListImageRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImageRecipes

Read ListImageRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImageRecipes

Show ListImageRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImageRecipes

Generic ListImageRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImageRecipes

Associated Types

type Rep ListImageRecipes :: Type -> Type #

NFData ListImageRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImageRecipes

Methods

rnf :: ListImageRecipes -> () #

Hashable ListImageRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImageRecipes

ToJSON ListImageRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImageRecipes

AWSRequest ListImageRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImageRecipes

Associated Types

type AWSResponse ListImageRecipes #

ToHeaders ListImageRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImageRecipes

ToPath ListImageRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImageRecipes

ToQuery ListImageRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImageRecipes

type Rep ListImageRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImageRecipes

type Rep ListImageRecipes = D1 ('MetaData "ListImageRecipes" "Amazonka.ImageBuilder.ListImageRecipes" "libZSservicesZSamazonka-imagebuilderZSamazonka-imagebuilder" 'False) (C1 ('MetaCons "ListImageRecipes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Filter))) :*: S1 ('MetaSel ('Just "owner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Ownership))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListImageRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImageRecipes

newListImageRecipes :: ListImageRecipes Source #

Create a value of ListImageRecipes 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:filters:ListImageRecipes', listImageRecipes_filters - Use the following filters to streamline results:

  • name
  • parentImage
  • platform

$sel:owner:ListImageRecipes', listImageRecipes_owner - The owner defines which image recipes you want to list. By default, this request will only show image recipes owned by your account. You can use this field to specify if you want to view image recipes owned by yourself, by Amazon, or those image recipes that have been shared with you by other customers.

$sel:nextToken:ListImageRecipes', listImageRecipes_nextToken - A token to specify where to start paginating. This is the NextToken from a previously truncated response.

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

Request Lenses

listImageRecipes_filters :: Lens' ListImageRecipes (Maybe (NonEmpty Filter)) Source #

Use the following filters to streamline results:

  • name
  • parentImage
  • platform

listImageRecipes_owner :: Lens' ListImageRecipes (Maybe Ownership) Source #

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

listImageRecipes_nextToken :: Lens' ListImageRecipes (Maybe Text) Source #

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

listImageRecipes_maxResults :: Lens' ListImageRecipes (Maybe Natural) Source #

The maximum items to return in a request.

Destructuring the Response

data ListImageRecipesResponse Source #

See: newListImageRecipesResponse smart constructor.

Constructors

ListImageRecipesResponse' 

Fields

Instances

Instances details
Eq ListImageRecipesResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImageRecipes

Read ListImageRecipesResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImageRecipes

Show ListImageRecipesResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImageRecipes

Generic ListImageRecipesResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImageRecipes

Associated Types

type Rep ListImageRecipesResponse :: Type -> Type #

NFData ListImageRecipesResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImageRecipes

type Rep ListImageRecipesResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListImageRecipes

type Rep ListImageRecipesResponse = D1 ('MetaData "ListImageRecipesResponse" "Amazonka.ImageBuilder.ListImageRecipes" "libZSservicesZSamazonka-imagebuilderZSamazonka-imagebuilder" 'False) (C1 ('MetaCons "ListImageRecipesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "imageRecipeSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ImageRecipeSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListImageRecipesResponse Source #

Create a value of ListImageRecipesResponse 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:requestId:ListImageRecipesResponse', listImageRecipesResponse_requestId - The request ID that uniquely identifies this request.

$sel:nextToken:ListImageRecipes', listImageRecipesResponse_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:imageRecipeSummaryList:ListImageRecipesResponse', listImageRecipesResponse_imageRecipeSummaryList - The list of image pipelines.

$sel:httpStatus:ListImageRecipesResponse', listImageRecipesResponse_httpStatus - The response's http status code.

Response Lenses

listImageRecipesResponse_requestId :: Lens' ListImageRecipesResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

listImageRecipesResponse_nextToken :: Lens' ListImageRecipesResponse (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.