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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of container recipes.

Synopsis

data ListContainerRecipes = ListContainerRecipes' {
- filters :: Maybe (NonEmpty Filter)
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- owner :: Maybe Ownership
}
newListContainerRecipes :: ListContainerRecipes
listContainerRecipes_filters :: Lens' ListContainerRecipes (Maybe (NonEmpty Filter))
listContainerRecipes_maxResults :: Lens' ListContainerRecipes (Maybe Natural)
listContainerRecipes_nextToken :: Lens' ListContainerRecipes (Maybe Text)
listContainerRecipes_owner :: Lens' ListContainerRecipes (Maybe Ownership)
data ListContainerRecipesResponse = ListContainerRecipesResponse' {
- containerRecipeSummaryList :: Maybe [ContainerRecipeSummary]
- nextToken :: Maybe Text
- requestId :: Maybe Text
- httpStatus :: Int
}
newListContainerRecipesResponse :: Int -> ListContainerRecipesResponse
listContainerRecipesResponse_containerRecipeSummaryList :: Lens' ListContainerRecipesResponse (Maybe [ContainerRecipeSummary])
listContainerRecipesResponse_nextToken :: Lens' ListContainerRecipesResponse (Maybe Text)
listContainerRecipesResponse_requestId :: Lens' ListContainerRecipesResponse (Maybe Text)
listContainerRecipesResponse_httpStatus :: Lens' ListContainerRecipesResponse Int

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
```
maxResults :: Maybe Natural
The maximum number of results to return in the list.
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.
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.

Instances

Instances details

ToJSON ListContainerRecipes Source #
Instance details Defined in Amazonka.ImageBuilder.ListContainerRecipes Methods toJSON :: ListContainerRecipes -> Value # toEncoding :: ListContainerRecipes -> Encoding # toJSONList :: [ListContainerRecipes] -> Value # toEncodingList :: [ListContainerRecipes] -> Encoding #
ToHeaders ListContainerRecipes Source #
Instance details Defined in Amazonka.ImageBuilder.ListContainerRecipes Methods toHeaders :: ListContainerRecipes -> [Header] #
ToPath ListContainerRecipes Source #
Instance details Defined in Amazonka.ImageBuilder.ListContainerRecipes Methods toPath :: ListContainerRecipes -> ByteString #
ToQuery ListContainerRecipes Source #
Instance details Defined in Amazonka.ImageBuilder.ListContainerRecipes Methods toQuery :: ListContainerRecipes -> QueryString #
AWSRequest ListContainerRecipes Source #
Instance details Defined in Amazonka.ImageBuilder.ListContainerRecipes Associated Types type AWSResponse ListContainerRecipes # Methods request :: (Service -> Service) -> ListContainerRecipes -> Request ListContainerRecipes # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListContainerRecipes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListContainerRecipes))) #
Generic ListContainerRecipes Source #
Instance details Defined in Amazonka.ImageBuilder.ListContainerRecipes Associated Types type Rep ListContainerRecipes :: Type -> Type # Methods from :: ListContainerRecipes -> Rep ListContainerRecipes x # to :: Rep ListContainerRecipes x -> ListContainerRecipes #
Read ListContainerRecipes Source #
Instance details Defined in Amazonka.ImageBuilder.ListContainerRecipes Methods readsPrec :: Int -> ReadS ListContainerRecipes # readList :: ReadS [ListContainerRecipes] # readPrec :: ReadPrec ListContainerRecipes # readListPrec :: ReadPrec [ListContainerRecipes] #
Show ListContainerRecipes Source #
Instance details Defined in Amazonka.ImageBuilder.ListContainerRecipes Methods showsPrec :: Int -> ListContainerRecipes -> ShowS # show :: ListContainerRecipes -> String # showList :: [ListContainerRecipes] -> ShowS #
NFData ListContainerRecipes Source #
Instance details Defined in Amazonka.ImageBuilder.ListContainerRecipes Methods rnf :: ListContainerRecipes -> () #
Eq ListContainerRecipes Source #
Instance details Defined in Amazonka.ImageBuilder.ListContainerRecipes Methods (==) :: ListContainerRecipes -> ListContainerRecipes -> Bool # (/=) :: ListContainerRecipes -> ListContainerRecipes -> Bool #
Hashable ListContainerRecipes Source #
Instance details Defined in Amazonka.ImageBuilder.ListContainerRecipes Methods hashWithSalt :: Int -> ListContainerRecipes -> Int # hash :: ListContainerRecipes -> Int #
type AWSResponse ListContainerRecipes Source #
Instance details Defined in Amazonka.ImageBuilder.ListContainerRecipes type AWSResponse ListContainerRecipes = ListContainerRecipesResponse
type Rep ListContainerRecipes Source #
Instance details Defined in Amazonka.ImageBuilder.ListContainerRecipes type Rep ListContainerRecipes = D1 ('MetaData "ListContainerRecipes" "Amazonka.ImageBuilder.ListContainerRecipes" "amazonka-imagebuilder-2.0-BBLLjX59RW72O8VbQ3vKvH" 'False) (C1 ('MetaCons "ListContainerRecipes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Filter))) :: 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)))))

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:maxResults:ListContainerRecipes', listContainerRecipes_maxResults - The maximum number of results to return in the list.

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.

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.

Request Lenses

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

Use the following filters to streamline results:

```
containerType
```
```
name
```
```
parentImage
```
```
platform
```

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

The maximum number of results to return in the list.

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

Destructuring the Response

data ListContainerRecipesResponse Source #

See: newListContainerRecipesResponse smart constructor.

Constructors

ListContainerRecipesResponse'

Fields

containerRecipeSummaryList :: Maybe [ContainerRecipeSummary]
The list of container recipes returned for the request.
nextToken :: Maybe Text
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.
requestId :: Maybe Text
The request ID that uniquely identifies this request.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListContainerRecipesResponse Source #
Instance details Defined in Amazonka.ImageBuilder.ListContainerRecipes Associated Types type Rep ListContainerRecipesResponse :: Type -> Type # Methods from :: ListContainerRecipesResponse -> Rep ListContainerRecipesResponse x # to :: Rep ListContainerRecipesResponse x -> ListContainerRecipesResponse #
Read ListContainerRecipesResponse Source #
Instance details Defined in Amazonka.ImageBuilder.ListContainerRecipes Methods readsPrec :: Int -> ReadS ListContainerRecipesResponse # readList :: ReadS [ListContainerRecipesResponse] # readPrec :: ReadPrec ListContainerRecipesResponse # readListPrec :: ReadPrec [ListContainerRecipesResponse] #
Show ListContainerRecipesResponse Source #
Instance details Defined in Amazonka.ImageBuilder.ListContainerRecipes Methods showsPrec :: Int -> ListContainerRecipesResponse -> ShowS # show :: ListContainerRecipesResponse -> String # showList :: [ListContainerRecipesResponse] -> ShowS #
NFData ListContainerRecipesResponse Source #
Instance details Defined in Amazonka.ImageBuilder.ListContainerRecipes Methods rnf :: ListContainerRecipesResponse -> () #
Eq ListContainerRecipesResponse Source #
Instance details Defined in Amazonka.ImageBuilder.ListContainerRecipes Methods (==) :: ListContainerRecipesResponse -> ListContainerRecipesResponse -> Bool # (/=) :: ListContainerRecipesResponse -> ListContainerRecipesResponse -> Bool #
type Rep ListContainerRecipesResponse Source #
Instance details Defined in Amazonka.ImageBuilder.ListContainerRecipes type Rep ListContainerRecipesResponse = D1 ('MetaData "ListContainerRecipesResponse" "Amazonka.ImageBuilder.ListContainerRecipes" "amazonka-imagebuilder-2.0-BBLLjX59RW72O8VbQ3vKvH" 'False) (C1 ('MetaCons "ListContainerRecipesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "containerRecipeSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ContainerRecipeSummary])) :: 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))))

newListContainerRecipesResponse Source #

Arguments

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

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:containerRecipeSummaryList:ListContainerRecipesResponse', listContainerRecipesResponse_containerRecipeSummaryList - The list of container recipes returned for the request.

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

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

Response Lenses

listContainerRecipesResponse_containerRecipeSummaryList :: Lens' ListContainerRecipesResponse (Maybe [ContainerRecipeSummary]) Source #

The list of container recipes returned for the 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.

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

The request ID that uniquely identifies this request.

listContainerRecipesResponse_httpStatus :: Lens' ListContainerRecipesResponse Int Source #

The response's http status code.