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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

List components with summary data. You can filter the result list by environment, service, or a single service instance.

For more information about components, see Proton components in the Proton User Guide.

This operation returns paginated results.

Synopsis

data ListComponents = ListComponents' {
- environmentName :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- serviceInstanceName :: Maybe Text
- serviceName :: Maybe Text
}
newListComponents :: ListComponents
listComponents_environmentName :: Lens' ListComponents (Maybe Text)
listComponents_maxResults :: Lens' ListComponents (Maybe Natural)
listComponents_nextToken :: Lens' ListComponents (Maybe Text)
listComponents_serviceInstanceName :: Lens' ListComponents (Maybe Text)
listComponents_serviceName :: Lens' ListComponents (Maybe Text)
data ListComponentsResponse = ListComponentsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- components :: [ComponentSummary]
}
newListComponentsResponse :: Int -> ListComponentsResponse
listComponentsResponse_nextToken :: Lens' ListComponentsResponse (Maybe Text)
listComponentsResponse_httpStatus :: Lens' ListComponentsResponse Int
listComponentsResponse_components :: Lens' ListComponentsResponse [ComponentSummary]

Creating a Request

data ListComponents Source #

See: newListComponents smart constructor.

Constructors

ListComponents'

Fields

environmentName :: Maybe Text
The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.
maxResults :: Maybe Natural
The maximum number of components to list.
nextToken :: Maybe Text
A token that indicates the location of the next component in the array of components, after the list of components that was previously requested.
serviceInstanceName :: Maybe Text
The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.
serviceName :: Maybe Text
The name of a service for result list filtering. Proton returns components attached to service instances of the service.

Instances

Instances details

ToJSON ListComponents Source #
Instance details Defined in Amazonka.Proton.ListComponents Methods toJSON :: ListComponents -> Value # toEncoding :: ListComponents -> Encoding # toJSONList :: [ListComponents] -> Value # toEncodingList :: [ListComponents] -> Encoding #
ToHeaders ListComponents Source #
Instance details Defined in Amazonka.Proton.ListComponents Methods toHeaders :: ListComponents -> [Header] #
ToPath ListComponents Source #
Instance details Defined in Amazonka.Proton.ListComponents Methods toPath :: ListComponents -> ByteString #
ToQuery ListComponents Source #
Instance details Defined in Amazonka.Proton.ListComponents Methods toQuery :: ListComponents -> QueryString #
AWSPager ListComponents Source #
Instance details Defined in Amazonka.Proton.ListComponents Methods page :: ListComponents -> AWSResponse ListComponents -> Maybe ListComponents #
AWSRequest ListComponents Source #
Instance details Defined in Amazonka.Proton.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.Proton.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.Proton.ListComponents Methods readsPrec :: Int -> ReadS ListComponents # readList :: ReadS [ListComponents] # readPrec :: ReadPrec ListComponents # readListPrec :: ReadPrec [ListComponents] #
Show ListComponents Source #
Instance details Defined in Amazonka.Proton.ListComponents Methods showsPrec :: Int -> ListComponents -> ShowS # show :: ListComponents -> String # showList :: [ListComponents] -> ShowS #
NFData ListComponents Source #
Instance details Defined in Amazonka.Proton.ListComponents Methods rnf :: ListComponents -> () #
Eq ListComponents Source #
Instance details Defined in Amazonka.Proton.ListComponents Methods (==) :: ListComponents -> ListComponents -> Bool # (/=) :: ListComponents -> ListComponents -> Bool #
Hashable ListComponents Source #
Instance details Defined in Amazonka.Proton.ListComponents Methods hashWithSalt :: Int -> ListComponents -> Int # hash :: ListComponents -> Int #
type AWSResponse ListComponents Source #
Instance details Defined in Amazonka.Proton.ListComponents type AWSResponse ListComponents = ListComponentsResponse
type Rep ListComponents Source #
Instance details Defined in Amazonka.Proton.ListComponents type Rep ListComponents = D1 ('MetaData "ListComponents" "Amazonka.Proton.ListComponents" "amazonka-proton-2.0-LlJ92rKPVfGGXHsLqGeI74" 'False) (C1 ('MetaCons "ListComponents'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "environmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "serviceInstanceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "serviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

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:

ListComponents, listComponents_environmentName - The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.

$sel:maxResults:ListComponents', listComponents_maxResults - The maximum number of components to list.

ListComponents, listComponents_nextToken - A token that indicates the location of the next component in the array of components, after the list of components that was previously requested.

ListComponents, listComponents_serviceInstanceName - The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.

ListComponents, listComponents_serviceName - The name of a service for result list filtering. Proton returns components attached to service instances of the service.

Request Lenses

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

The name of an environment for result list filtering. Proton returns components associated with the environment or attached to service instances running in it.

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

The maximum number of components to list.

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

A token that indicates the location of the next component in the array of components, after the list of components that was previously requested.

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

The name of a service instance for result list filtering. Proton returns the component attached to the service instance, if any.

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

The name of a service for result list filtering. Proton returns components attached to service instances of the service.

Destructuring the Response

data ListComponentsResponse Source #

See: newListComponentsResponse smart constructor.

Constructors

ListComponentsResponse'
Fields nextToken :: Maybe Text A token that indicates the location of the next component in the array of components, after the current requested list of components. httpStatus :: Int The response's http status code. components :: [ComponentSummary] An array of components with summary data.

Instances

Instances details

Generic ListComponentsResponse Source #
Instance details Defined in Amazonka.Proton.ListComponents Associated Types type Rep ListComponentsResponse :: Type -> Type # Methods from :: ListComponentsResponse -> Rep ListComponentsResponse x # to :: Rep ListComponentsResponse x -> ListComponentsResponse #
Show ListComponentsResponse Source #
Instance details Defined in Amazonka.Proton.ListComponents Methods showsPrec :: Int -> ListComponentsResponse -> ShowS # show :: ListComponentsResponse -> String # showList :: [ListComponentsResponse] -> ShowS #
NFData ListComponentsResponse Source #
Instance details Defined in Amazonka.Proton.ListComponents Methods rnf :: ListComponentsResponse -> () #
Eq ListComponentsResponse Source #
Instance details Defined in Amazonka.Proton.ListComponents Methods (==) :: ListComponentsResponse -> ListComponentsResponse -> Bool # (/=) :: ListComponentsResponse -> ListComponentsResponse -> Bool #
type Rep ListComponentsResponse Source #
Instance details Defined in Amazonka.Proton.ListComponents type Rep ListComponentsResponse = D1 ('MetaData "ListComponentsResponse" "Amazonka.Proton.ListComponents" "amazonka-proton-2.0-LlJ92rKPVfGGXHsLqGeI74" 'False) (C1 ('MetaCons "ListComponentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "components") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ComponentSummary]))))

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:

ListComponents, listComponentsResponse_nextToken - A token that indicates the location of the next component in the array of components, after the current requested list of components.

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

$sel:components:ListComponentsResponse', listComponentsResponse_components - An array of components with summary data.

Response Lenses

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

A token that indicates the location of the next component in the array of components, after the current requested list of components.

listComponentsResponse_httpStatus :: Lens' ListComponentsResponse Int Source #

The response's http status code.

listComponentsResponse_components :: Lens' ListComponentsResponse [ComponentSummary] Source #

An array of components with summary data.