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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of image recipes.

Synopsis

data ListImageRecipes = ListImageRecipes' {
- filters :: Maybe (NonEmpty Filter)
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- owner :: Maybe Ownership
}
newListImageRecipes :: ListImageRecipes
listImageRecipes_filters :: Lens' ListImageRecipes (Maybe (NonEmpty Filter))
listImageRecipes_maxResults :: Lens' ListImageRecipes (Maybe Natural)
listImageRecipes_nextToken :: Lens' ListImageRecipes (Maybe Text)
listImageRecipes_owner :: Lens' ListImageRecipes (Maybe Ownership)
data ListImageRecipesResponse = ListImageRecipesResponse' {
- imageRecipeSummaryList :: Maybe [ImageRecipeSummary]
- nextToken :: Maybe Text
- requestId :: Maybe Text
- httpStatus :: Int
}
newListImageRecipesResponse :: Int -> ListImageRecipesResponse
listImageRecipesResponse_imageRecipeSummaryList :: Lens' ListImageRecipesResponse (Maybe [ImageRecipeSummary])
listImageRecipesResponse_nextToken :: Lens' ListImageRecipesResponse (Maybe Text)
listImageRecipesResponse_requestId :: Lens' ListImageRecipesResponse (Maybe Text)
listImageRecipesResponse_httpStatus :: Lens' ListImageRecipesResponse Int

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

Instances

Instances details

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

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:maxResults:ListImageRecipes', listImageRecipes_maxResults - The maximum items to return in a request.

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

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.

Request Lenses

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

Use the following filters to streamline results:

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

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

The maximum items to return in a request.

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

Destructuring the Response

data ListImageRecipesResponse Source #

See: newListImageRecipesResponse smart constructor.

Constructors

ListImageRecipesResponse'

Fields

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

newListImageRecipesResponse Source #

Arguments

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

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

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

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

Response Lenses

listImageRecipesResponse_imageRecipeSummaryList :: Lens' ListImageRecipesResponse (Maybe [ImageRecipeSummary]) Source #

The list of image pipelines.

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.

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

The request ID that uniquely identifies this request.

listImageRecipesResponse_httpStatus :: Lens' ListImageRecipesResponse Int Source #

The response's http status code.