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.ListContainerRecipes

Description

Returns a list of container recipes.

Synopsis

Creating a Request

data ListContainerRecipes Source #

See: newListContainerRecipes smart constructor.

Constructors

ListContainerRecipes' 

Fields

  • filters :: Maybe (NonEmpty Filter)

    Use the following filters to streamline results:

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

    Returns container recipes belonging to the specified owner, that have been shared with you. You can omit this field to return container recipes belonging to your account.

  • nextToken :: Maybe Text

    Provides a token for pagination, which determines where to begin the next set of results when the current set reaches the maximum for one request.

  • maxResults :: Maybe Natural

    The maximum number of results to return in the list.

Instances

Instances details
Eq ListContainerRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListContainerRecipes

Read ListContainerRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListContainerRecipes

Show ListContainerRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListContainerRecipes

Generic ListContainerRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListContainerRecipes

Associated Types

type Rep ListContainerRecipes :: Type -> Type #

NFData ListContainerRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListContainerRecipes

Methods

rnf :: ListContainerRecipes -> () #

Hashable ListContainerRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListContainerRecipes

ToJSON ListContainerRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListContainerRecipes

AWSRequest ListContainerRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListContainerRecipes

Associated Types

type AWSResponse ListContainerRecipes #

ToHeaders ListContainerRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListContainerRecipes

ToPath ListContainerRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListContainerRecipes

ToQuery ListContainerRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListContainerRecipes

type Rep ListContainerRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListContainerRecipes

type Rep ListContainerRecipes = D1 ('MetaData "ListContainerRecipes" "Amazonka.ImageBuilder.ListContainerRecipes" "libZSservicesZSamazonka-imagebuilderZSamazonka-imagebuilder" 'False) (C1 ('MetaCons "ListContainerRecipes'" '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 ListContainerRecipes Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListContainerRecipes

newListContainerRecipes :: ListContainerRecipes Source #

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

  • containerType
  • name
  • parentImage
  • platform

$sel:owner:ListContainerRecipes', listContainerRecipes_owner - Returns container recipes belonging to the specified owner, that have been shared with you. You can omit this field to return container recipes belonging to your account.

$sel:nextToken:ListContainerRecipes', listContainerRecipes_nextToken - Provides a token for pagination, which determines where to begin the next set of results when the current set reaches the maximum for one request.

$sel:maxResults:ListContainerRecipes', listContainerRecipes_maxResults - The maximum number of results to return in the list.

Request Lenses

listContainerRecipes_filters :: Lens' ListContainerRecipes (Maybe (NonEmpty Filter)) Source #

Use the following filters to streamline results:

  • containerType
  • name
  • parentImage
  • platform

listContainerRecipes_owner :: Lens' ListContainerRecipes (Maybe Ownership) Source #

Returns container recipes belonging to the specified owner, that have been shared with you. You can omit this field to return container recipes belonging to your account.

listContainerRecipes_nextToken :: Lens' ListContainerRecipes (Maybe Text) Source #

Provides a token for pagination, which determines where to begin the next set of results when the current set reaches the maximum for one request.

listContainerRecipes_maxResults :: Lens' ListContainerRecipes (Maybe Natural) Source #

The maximum number of results to return in the list.

Destructuring the Response

data ListContainerRecipesResponse Source #

See: newListContainerRecipesResponse smart constructor.

Constructors

ListContainerRecipesResponse' 

Fields

Instances

Instances details
Eq ListContainerRecipesResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListContainerRecipes

Read ListContainerRecipesResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListContainerRecipes

Show ListContainerRecipesResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListContainerRecipes

Generic ListContainerRecipesResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListContainerRecipes

Associated Types

type Rep ListContainerRecipesResponse :: Type -> Type #

NFData ListContainerRecipesResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListContainerRecipes

type Rep ListContainerRecipesResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.ListContainerRecipes

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

newListContainerRecipesResponse Source #

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

$sel:containerRecipeSummaryList:ListContainerRecipesResponse', listContainerRecipesResponse_containerRecipeSummaryList - The list of container recipes returned for the request.

$sel:nextToken:ListContainerRecipes', listContainerRecipesResponse_nextToken - The next token field is used for paginated responses. When this is not empty, there are additional container recipes that the service has not included in this response. Use this token with the next request to retrieve additional list items.

$sel:httpStatus:ListContainerRecipesResponse', listContainerRecipesResponse_httpStatus - The response's http status code.

Response Lenses

listContainerRecipesResponse_requestId :: Lens' ListContainerRecipesResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

listContainerRecipesResponse_nextToken :: Lens' ListContainerRecipesResponse (Maybe Text) Source #

The next token field is used for paginated responses. When this is not empty, there are additional container recipes that the service has not included in this response. Use this token with the next request to retrieve additional list items.