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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

List service instances with summary data. This action lists service instances of all services in the Amazon Web Services account.

This operation returns paginated results.

Synopsis

Creating a Request

data ListServiceInstances Source #

See: newListServiceInstances smart constructor.

Constructors

ListServiceInstances'

Fields

filters :: Maybe [ListServiceInstancesFilter]
An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.
maxResults :: Maybe Natural
The maximum number of service instances to list.
nextToken :: Maybe Text
A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.
serviceName :: Maybe Text
The name of the service that the service instance belongs to.
sortBy :: Maybe ListServiceInstancesSortBy
The field that the result list is sorted by.
When you choose to sort by serviceName, service instances within each service are sorted by service instance name.
Default: serviceName
sortOrder :: Maybe SortOrder
Result list sort order.
Default: ASCENDING

Instances

Instances details

ToJSON ListServiceInstances Source #
Instance details Defined in Amazonka.Proton.ListServiceInstances Methods toJSON :: ListServiceInstances -> Value # toEncoding :: ListServiceInstances -> Encoding # toJSONList :: [ListServiceInstances] -> Value # toEncodingList :: [ListServiceInstances] -> Encoding #
ToHeaders ListServiceInstances Source #
Instance details Defined in Amazonka.Proton.ListServiceInstances Methods toHeaders :: ListServiceInstances -> [Header] #
ToPath ListServiceInstances Source #
Instance details Defined in Amazonka.Proton.ListServiceInstances Methods toPath :: ListServiceInstances -> ByteString #
ToQuery ListServiceInstances Source #
Instance details Defined in Amazonka.Proton.ListServiceInstances Methods toQuery :: ListServiceInstances -> QueryString #
AWSPager ListServiceInstances Source #
Instance details Defined in Amazonka.Proton.ListServiceInstances Methods page :: ListServiceInstances -> AWSResponse ListServiceInstances -> Maybe ListServiceInstances #
AWSRequest ListServiceInstances Source #
Instance details Defined in Amazonka.Proton.ListServiceInstances Associated Types type AWSResponse ListServiceInstances # Methods request :: (Service -> Service) -> ListServiceInstances -> Request ListServiceInstances # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListServiceInstances -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListServiceInstances))) #
Generic ListServiceInstances Source #
Instance details Defined in Amazonka.Proton.ListServiceInstances Associated Types type Rep ListServiceInstances :: Type -> Type # Methods from :: ListServiceInstances -> Rep ListServiceInstances x # to :: Rep ListServiceInstances x -> ListServiceInstances #
Read ListServiceInstances Source #
Instance details Defined in Amazonka.Proton.ListServiceInstances Methods readsPrec :: Int -> ReadS ListServiceInstances # readList :: ReadS [ListServiceInstances] # readPrec :: ReadPrec ListServiceInstances # readListPrec :: ReadPrec [ListServiceInstances] #
Show ListServiceInstances Source #
Instance details Defined in Amazonka.Proton.ListServiceInstances Methods showsPrec :: Int -> ListServiceInstances -> ShowS # show :: ListServiceInstances -> String # showList :: [ListServiceInstances] -> ShowS #
NFData ListServiceInstances Source #
Instance details Defined in Amazonka.Proton.ListServiceInstances Methods rnf :: ListServiceInstances -> () #
Eq ListServiceInstances Source #
Instance details Defined in Amazonka.Proton.ListServiceInstances Methods (==) :: ListServiceInstances -> ListServiceInstances -> Bool # (/=) :: ListServiceInstances -> ListServiceInstances -> Bool #
Hashable ListServiceInstances Source #
Instance details Defined in Amazonka.Proton.ListServiceInstances Methods hashWithSalt :: Int -> ListServiceInstances -> Int # hash :: ListServiceInstances -> Int #
type AWSResponse ListServiceInstances Source #
Instance details Defined in Amazonka.Proton.ListServiceInstances type AWSResponse ListServiceInstances = ListServiceInstancesResponse
type Rep ListServiceInstances Source #
Instance details Defined in Amazonka.Proton.ListServiceInstances type Rep ListServiceInstances = D1 ('MetaData "ListServiceInstances" "Amazonka.Proton.ListServiceInstances" "amazonka-proton-2.0-LlJ92rKPVfGGXHsLqGeI74" 'False) (C1 ('MetaCons "ListServiceInstances'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ListServiceInstancesFilter])) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "serviceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ListServiceInstancesSortBy)) :*: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder))))))

newListServiceInstances :: ListServiceInstances Source #

Create a value of ListServiceInstances 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:ListServiceInstances', listServiceInstances_filters - An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.

$sel:maxResults:ListServiceInstances', listServiceInstances_maxResults - The maximum number of service instances to list.

ListServiceInstances, listServiceInstances_nextToken - A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.

ListServiceInstances, listServiceInstances_serviceName - The name of the service that the service instance belongs to.

$sel:sortBy:ListServiceInstances', listServiceInstances_sortBy - The field that the result list is sorted by.

When you choose to sort by serviceName, service instances within each service are sorted by service instance name.

Default: serviceName

$sel:sortOrder:ListServiceInstances', listServiceInstances_sortOrder - Result list sort order.

Default: ASCENDING

Request Lenses

listServiceInstances_filters :: Lens' ListServiceInstances (Maybe [ListServiceInstancesFilter]) Source #

An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.

listServiceInstances_maxResults :: Lens' ListServiceInstances (Maybe Natural) Source #

The maximum number of service instances to list.

listServiceInstances_nextToken :: Lens' ListServiceInstances (Maybe Text) Source #

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

listServiceInstances_serviceName :: Lens' ListServiceInstances (Maybe Text) Source #

The name of the service that the service instance belongs to.

listServiceInstances_sortBy :: Lens' ListServiceInstances (Maybe ListServiceInstancesSortBy) Source #

The field that the result list is sorted by.

When you choose to sort by serviceName, service instances within each service are sorted by service instance name.

Default: serviceName

listServiceInstances_sortOrder :: Lens' ListServiceInstances (Maybe SortOrder) Source #

Result list sort order.

Default: ASCENDING

Destructuring the Response

data ListServiceInstancesResponse Source #

See: newListServiceInstancesResponse smart constructor.

Constructors

ListServiceInstancesResponse'
Fields nextToken :: Maybe Text A token that indicates the location of the next service instance in the array of service instances, after the current requested list of service instances. httpStatus :: Int The response's http status code. serviceInstances :: [ServiceInstanceSummary] An array of service instances with summary data.

Instances

Instances details

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

newListServiceInstancesResponse Source #

Arguments

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

Create a value of ListServiceInstancesResponse 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:

ListServiceInstances, listServiceInstancesResponse_nextToken - A token that indicates the location of the next service instance in the array of service instances, after the current requested list of service instances.

$sel:httpStatus:ListServiceInstancesResponse', listServiceInstancesResponse_httpStatus - The response's http status code.

$sel:serviceInstances:ListServiceInstancesResponse', listServiceInstancesResponse_serviceInstances - An array of service instances with summary data.

Response Lenses

listServiceInstancesResponse_nextToken :: Lens' ListServiceInstancesResponse (Maybe Text) Source #

A token that indicates the location of the next service instance in the array of service instances, after the current requested list of service instances.

listServiceInstancesResponse_httpStatus :: Lens' ListServiceInstancesResponse Int Source #

The response's http status code.

listServiceInstancesResponse_serviceInstances :: Lens' ListServiceInstancesResponse [ServiceInstanceSummary] Source #

An array of service instances with summary data.