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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the list of component build versions for the specified semantic version.

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.

Synopsis

data ListComponents = ListComponents' {
- byName :: Maybe Bool
- filters :: Maybe (NonEmpty Filter)
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- owner :: Maybe Ownership
}
newListComponents :: ListComponents
listComponents_byName :: Lens' ListComponents (Maybe Bool)
listComponents_filters :: Lens' ListComponents (Maybe (NonEmpty Filter))
listComponents_maxResults :: Lens' ListComponents (Maybe Natural)
listComponents_nextToken :: Lens' ListComponents (Maybe Text)
listComponents_owner :: Lens' ListComponents (Maybe Ownership)
data ListComponentsResponse = ListComponentsResponse' {
- componentVersionList :: Maybe [ComponentVersion]
- nextToken :: Maybe Text
- requestId :: Maybe Text
- httpStatus :: Int
}
newListComponentsResponse :: Int -> ListComponentsResponse
listComponentsResponse_componentVersionList :: Lens' ListComponentsResponse (Maybe [ComponentVersion])
listComponentsResponse_nextToken :: Lens' ListComponentsResponse (Maybe Text)
listComponentsResponse_requestId :: Lens' ListComponentsResponse (Maybe Text)
listComponentsResponse_httpStatus :: Lens' ListComponentsResponse Int

Creating a Request

data ListComponents Source #

See: newListComponents smart constructor.

Constructors

ListComponents'

Fields

byName :: Maybe Bool
Returns the list of component build versions for the specified name.
filters :: Maybe (NonEmpty Filter)
Use the following filters to streamline results:
- ```
description
```
- ```
name
```
- ```
platform
```
- ```
supportedOsVersion
```
- ```
type
```
- ```
version
```
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 components you want to list. By default, this request will only show components owned by your account. You can use this field to specify if you want to view components owned by yourself, by Amazon, or those components that have been shared with you by other customers.

Instances

Instances details

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

newListComponents :: ListComponents Source #

Create a value of ListComponents 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:ListComponents', listComponents_byName - Returns the list of component build versions for the specified name.

$sel:filters:ListComponents', listComponents_filters - Use the following filters to streamline results:

```
description
```
```
name
```
```
platform
```
```
supportedOsVersion
```
```
type
```
```
version
```

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

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

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

Request Lenses

listComponents_byName :: Lens' ListComponents (Maybe Bool) Source #

Returns the list of component build versions for the specified name.

listComponents_filters :: Lens' ListComponents (Maybe (NonEmpty Filter)) Source #

Use the following filters to streamline results:

```
description
```
```
name
```
```
platform
```
```
supportedOsVersion
```
```
type
```
```
version
```

listComponents_maxResults :: Lens' ListComponents (Maybe Natural) Source #

The maximum items to return in a request.

listComponents_nextToken :: Lens' ListComponents (Maybe Text) Source #

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

listComponents_owner :: Lens' ListComponents (Maybe Ownership) Source #

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

Destructuring the Response

data ListComponentsResponse Source #

See: newListComponentsResponse smart constructor.

Constructors

ListComponentsResponse'

Fields

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

newListComponentsResponse Source #

Arguments

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

Create a value of ListComponentsResponse 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:componentVersionList:ListComponentsResponse', listComponentsResponse_componentVersionList - The list of component 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.

ListComponents, listComponentsResponse_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:ListComponentsResponse', listComponentsResponse_requestId - The request ID that uniquely identifies this request.

$sel:httpStatus:ListComponentsResponse', listComponentsResponse_httpStatus - The response's http status code.

Response Lenses

listComponentsResponse_componentVersionList :: Lens' ListComponentsResponse (Maybe [ComponentVersion]) Source #

The list of component 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.

listComponentsResponse_nextToken :: Lens' ListComponentsResponse (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.

listComponentsResponse_requestId :: Lens' ListComponentsResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

listComponentsResponse_httpStatus :: Lens' ListComponentsResponse Int Source #

The response's http status code.