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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This operation lists all of the services that are associated with a Cloud Map namespace. This list might include services in different clusters. In contrast, ListServices can only list services in one cluster at a time. If you need to filter the list of services in a single cluster by various parameters, use ListServices. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

This operation returns paginated results.

Synopsis

Creating a Request

data ListServicesByNamespace Source #

See: newListServicesByNamespace smart constructor.

Constructors

ListServicesByNamespace'

Fields

maxResults :: Maybe Int
The maximum number of service results that ListServicesByNamespace returns in paginated output. When this parameter is used, ListServicesByNamespace 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 ListServicesByNamespace request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServicesByNamespace returns up to 10 results and a nextToken value if applicable.
nextToken :: Maybe Text
The nextToken value that's returned from a ListServicesByNamespace request. It indicates that more results are available to fulfill the request and further calls are needed. If maxResults is returned, it is possible the number of results is less than maxResults.
namespace :: Text
The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace to list the services in.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

Instances

Instances details

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

newListServicesByNamespace Source #

Arguments

:: Text	`ListServicesByNamespace`
-> ListServicesByNamespace

Create a value of ListServicesByNamespace 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:maxResults:ListServicesByNamespace', listServicesByNamespace_maxResults - The maximum number of service results that ListServicesByNamespace returns in paginated output. When this parameter is used, ListServicesByNamespace 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 ListServicesByNamespace request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServicesByNamespace returns up to 10 results and a nextToken value if applicable.

ListServicesByNamespace, listServicesByNamespace_nextToken - The nextToken value that's returned from a ListServicesByNamespace request. It indicates that more results are available to fulfill the request and further calls are needed. If maxResults is returned, it is possible the number of results is less than maxResults.

ListServicesByNamespace, listServicesByNamespace_namespace - The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace to list the services in.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

Request Lenses

listServicesByNamespace_maxResults :: Lens' ListServicesByNamespace (Maybe Int) Source #

The maximum number of service results that ListServicesByNamespace returns in paginated output. When this parameter is used, ListServicesByNamespace 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 ListServicesByNamespace request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListServicesByNamespace returns up to 10 results and a nextToken value if applicable.

listServicesByNamespace_nextToken :: Lens' ListServicesByNamespace (Maybe Text) Source #

The nextToken value that's returned from a ListServicesByNamespace request. It indicates that more results are available to fulfill the request and further calls are needed. If maxResults is returned, it is possible the number of results is less than maxResults.

listServicesByNamespace_namespace :: Lens' ListServicesByNamespace Text Source #

The namespace name or full Amazon Resource Name (ARN) of the Cloud Map namespace to list the services in.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

Destructuring the Response

data ListServicesByNamespaceResponse Source #

See: newListServicesByNamespaceResponse smart constructor.

Constructors

ListServicesByNamespaceResponse'

Fields

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

Instances

Instances details

Generic ListServicesByNamespaceResponse Source #
Instance details Defined in Amazonka.ECS.ListServicesByNamespace Associated Types type Rep ListServicesByNamespaceResponse :: Type -> Type # Methods from :: ListServicesByNamespaceResponse -> Rep ListServicesByNamespaceResponse x # to :: Rep ListServicesByNamespaceResponse x -> ListServicesByNamespaceResponse #
Read ListServicesByNamespaceResponse Source #
Instance details Defined in Amazonka.ECS.ListServicesByNamespace Methods readsPrec :: Int -> ReadS ListServicesByNamespaceResponse # readList :: ReadS [ListServicesByNamespaceResponse] # readPrec :: ReadPrec ListServicesByNamespaceResponse # readListPrec :: ReadPrec [ListServicesByNamespaceResponse] #
Show ListServicesByNamespaceResponse Source #
Instance details Defined in Amazonka.ECS.ListServicesByNamespace Methods showsPrec :: Int -> ListServicesByNamespaceResponse -> ShowS # show :: ListServicesByNamespaceResponse -> String # showList :: [ListServicesByNamespaceResponse] -> ShowS #
NFData ListServicesByNamespaceResponse Source #
Instance details Defined in Amazonka.ECS.ListServicesByNamespace Methods rnf :: ListServicesByNamespaceResponse -> () #
Eq ListServicesByNamespaceResponse Source #
Instance details Defined in Amazonka.ECS.ListServicesByNamespace Methods (==) :: ListServicesByNamespaceResponse -> ListServicesByNamespaceResponse -> Bool # (/=) :: ListServicesByNamespaceResponse -> ListServicesByNamespaceResponse -> Bool #
type Rep ListServicesByNamespaceResponse Source #
Instance details Defined in Amazonka.ECS.ListServicesByNamespace type Rep ListServicesByNamespaceResponse = D1 ('MetaData "ListServicesByNamespaceResponse" "Amazonka.ECS.ListServicesByNamespace" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ListServicesByNamespaceResponse'" '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))))

newListServicesByNamespaceResponse Source #

Arguments

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

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

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

$sel:serviceArns:ListServicesByNamespaceResponse', listServicesByNamespaceResponse_serviceArns - The list of full ARN entries for each service that's associated with the specified namespace.

$sel:httpStatus:ListServicesByNamespaceResponse', listServicesByNamespaceResponse_httpStatus - The response's http status code.

Response Lenses

listServicesByNamespaceResponse_nextToken :: Lens' ListServicesByNamespaceResponse (Maybe Text) Source #

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

listServicesByNamespaceResponse_serviceArns :: Lens' ListServicesByNamespaceResponse (Maybe [Text]) Source #

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

listServicesByNamespaceResponse_httpStatus :: Lens' ListServicesByNamespaceResponse Int Source #

The response's http status code.