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.ECS.ListServices

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of services. You can filter the results by cluster, launch type, and scheduling strategy.

This operation returns paginated results.

Synopsis

data ListServices = ListServices' {
- cluster :: Maybe Text
- launchType :: Maybe LaunchType
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- schedulingStrategy :: Maybe SchedulingStrategy
}
newListServices :: ListServices
listServices_cluster :: Lens' ListServices (Maybe Text)
listServices_launchType :: Lens' ListServices (Maybe LaunchType)
listServices_maxResults :: Lens' ListServices (Maybe Int)
listServices_nextToken :: Lens' ListServices (Maybe Text)
listServices_schedulingStrategy :: Lens' ListServices (Maybe SchedulingStrategy)
data ListServicesResponse = ListServicesResponse' {
- nextToken :: Maybe Text
- serviceArns :: Maybe [Text]
- httpStatus :: Int
}
newListServicesResponse :: Int -> ListServicesResponse
listServicesResponse_nextToken :: Lens' ListServicesResponse (Maybe Text)
listServicesResponse_serviceArns :: Lens' ListServicesResponse (Maybe [Text])
listServicesResponse_httpStatus :: Lens' ListServicesResponse Int

Creating a Request

data ListServices Source #

See: newListServices smart constructor.

Constructors

ListServices'

Fields

cluster :: Maybe Text
The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListServices results. If you do not specify a cluster, the default cluster is assumed.
launchType :: Maybe LaunchType
The launch type to use when filtering the ListServices results.
maxResults :: Maybe Int
The maximum number of service results that ListServices returned in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServices returns up to 10 results and a nextToken value if applicable.
nextToken :: Maybe Text
The nextToken value returned from a ListServices request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
schedulingStrategy :: Maybe SchedulingStrategy
The scheduling strategy to use when filtering the ListServices results.

Instances

Instances details

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

newListServices :: ListServices Source #

Create a value of ListServices 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:cluster:ListServices', listServices_cluster - The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListServices results. If you do not specify a cluster, the default cluster is assumed.

ListServices, listServices_launchType - The launch type to use when filtering the ListServices results.

$sel:maxResults:ListServices', listServices_maxResults - The maximum number of service results that ListServices returned in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServices returns up to 10 results and a nextToken value if applicable.

ListServices, listServices_nextToken - The nextToken value returned from a ListServices request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

ListServices, listServices_schedulingStrategy - The scheduling strategy to use when filtering the ListServices results.

Request Lenses

listServices_cluster :: Lens' ListServices (Maybe Text) Source #

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the ListServices results. If you do not specify a cluster, the default cluster is assumed.

listServices_launchType :: Lens' ListServices (Maybe LaunchType) Source #

The launch type to use when filtering the ListServices results.

listServices_maxResults :: Lens' ListServices (Maybe Int) Source #

The maximum number of service results that ListServices returned in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServices returns up to 10 results and a nextToken value if applicable.

listServices_nextToken :: Lens' ListServices (Maybe Text) Source #

The nextToken value returned from a ListServices request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

listServices_schedulingStrategy :: Lens' ListServices (Maybe SchedulingStrategy) Source #

The scheduling strategy to use when filtering the ListServices results.

Destructuring the Response

data ListServicesResponse Source #

See: newListServicesResponse smart constructor.

Constructors

ListServicesResponse'

Fields

nextToken :: Maybe Text
The nextToken value to include in a future ListServices request. When the results of a ListServices request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
serviceArns :: Maybe [Text]
The list of full ARN entries for each service that's associated with the specified cluster.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListServicesResponse Source #
Instance details Defined in Amazonka.ECS.ListServices Associated Types type Rep ListServicesResponse :: Type -> Type # Methods from :: ListServicesResponse -> Rep ListServicesResponse x # to :: Rep ListServicesResponse x -> ListServicesResponse #
Read ListServicesResponse Source #
Instance details Defined in Amazonka.ECS.ListServices Methods readsPrec :: Int -> ReadS ListServicesResponse # readList :: ReadS [ListServicesResponse] # readPrec :: ReadPrec ListServicesResponse # readListPrec :: ReadPrec [ListServicesResponse] #
Show ListServicesResponse Source #
Instance details Defined in Amazonka.ECS.ListServices Methods showsPrec :: Int -> ListServicesResponse -> ShowS # show :: ListServicesResponse -> String # showList :: [ListServicesResponse] -> ShowS #
NFData ListServicesResponse Source #
Instance details Defined in Amazonka.ECS.ListServices Methods rnf :: ListServicesResponse -> () #
Eq ListServicesResponse Source #
Instance details Defined in Amazonka.ECS.ListServices Methods (==) :: ListServicesResponse -> ListServicesResponse -> Bool # (/=) :: ListServicesResponse -> ListServicesResponse -> Bool #
type Rep ListServicesResponse Source #
Instance details Defined in Amazonka.ECS.ListServices type Rep ListServicesResponse = D1 ('MetaData "ListServicesResponse" "Amazonka.ECS.ListServices" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ListServicesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "serviceArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListServicesResponse Source #

Arguments

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

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

ListServices, listServicesResponse_nextToken - The nextToken value to include in a future ListServices request. When the results of a ListServices request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

$sel:serviceArns:ListServicesResponse', listServicesResponse_serviceArns - The list of full ARN entries for each service that's associated with the specified cluster.

$sel:httpStatus:ListServicesResponse', listServicesResponse_httpStatus - The response's http status code.

Response Lenses

listServicesResponse_nextToken :: Lens' ListServicesResponse (Maybe Text) Source #

The nextToken value to include in a future ListServices request. When the results of a ListServices request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

listServicesResponse_serviceArns :: Lens' ListServicesResponse (Maybe [Text]) Source #

The list of full ARN entries for each service that's associated with the specified cluster.

listServicesResponse_httpStatus :: Lens' ListServicesResponse Int Source #

The response's http status code.