Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.ECS.ListContainerInstances

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances operation with cluster query language statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide .

This operation returns paginated results.

Creating a Request

listContainerInstances :: ListContainerInstances #

Creates a value of ListContainerInstances with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lciStatus - Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState . If you do not specify this parameter, the default is to include container instances set to ACTIVE and DRAINING .
lciCluster - The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.
lciNextToken - The nextToken value returned from a previous paginated ListContainerInstances request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
lciFilter - You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide .
lciMaxResults - The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances 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 ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.

data ListContainerInstances #

See: listContainerInstances smart constructor.

Instances

Eq ListContainerInstances #
Instance details Defined in Network.AWS.ECS.ListContainerInstances Methods (==) :: ListContainerInstances -> ListContainerInstances -> Bool # (/=) :: ListContainerInstances -> ListContainerInstances -> Bool #
Data ListContainerInstances #
Instance details Defined in Network.AWS.ECS.ListContainerInstances Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListContainerInstances -> c ListContainerInstances # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListContainerInstances # toConstr :: ListContainerInstances -> Constr # dataTypeOf :: ListContainerInstances -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListContainerInstances) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListContainerInstances) # gmapT :: (forall b. Data b => b -> b) -> ListContainerInstances -> ListContainerInstances # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListContainerInstances -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListContainerInstances -> r # gmapQ :: (forall d. Data d => d -> u) -> ListContainerInstances -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListContainerInstances -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListContainerInstances -> m ListContainerInstances # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListContainerInstances -> m ListContainerInstances # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListContainerInstances -> m ListContainerInstances #
Read ListContainerInstances #
Instance details Defined in Network.AWS.ECS.ListContainerInstances Methods readsPrec :: Int -> ReadS ListContainerInstances # readList :: ReadS [ListContainerInstances] # readPrec :: ReadPrec ListContainerInstances # readListPrec :: ReadPrec [ListContainerInstances] #
Show ListContainerInstances #
Instance details Defined in Network.AWS.ECS.ListContainerInstances Methods showsPrec :: Int -> ListContainerInstances -> ShowS # show :: ListContainerInstances -> String # showList :: [ListContainerInstances] -> ShowS #
Generic ListContainerInstances #
Instance details Defined in Network.AWS.ECS.ListContainerInstances Associated Types type Rep ListContainerInstances :: Type -> Type # Methods from :: ListContainerInstances -> Rep ListContainerInstances x # to :: Rep ListContainerInstances x -> ListContainerInstances #
Hashable ListContainerInstances #
Instance details Defined in Network.AWS.ECS.ListContainerInstances Methods hashWithSalt :: Int -> ListContainerInstances -> Int # hash :: ListContainerInstances -> Int #
ToJSON ListContainerInstances #
Instance details Defined in Network.AWS.ECS.ListContainerInstances Methods toJSON :: ListContainerInstances -> Value # toEncoding :: ListContainerInstances -> Encoding # toJSONList :: [ListContainerInstances] -> Value # toEncodingList :: [ListContainerInstances] -> Encoding #
AWSPager ListContainerInstances #
Instance details Defined in Network.AWS.ECS.ListContainerInstances Methods page :: ListContainerInstances -> Rs ListContainerInstances -> Maybe ListContainerInstances #
AWSRequest ListContainerInstances #
Instance details Defined in Network.AWS.ECS.ListContainerInstances Associated Types type Rs ListContainerInstances :: Type # Methods request :: ListContainerInstances -> Request ListContainerInstances # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ListContainerInstances -> ClientResponse -> m (Response ListContainerInstances) #
ToHeaders ListContainerInstances #
Instance details Defined in Network.AWS.ECS.ListContainerInstances Methods toHeaders :: ListContainerInstances -> [Header] #
ToPath ListContainerInstances #
Instance details Defined in Network.AWS.ECS.ListContainerInstances Methods toPath :: ListContainerInstances -> ByteString #
ToQuery ListContainerInstances #
Instance details Defined in Network.AWS.ECS.ListContainerInstances Methods toQuery :: ListContainerInstances -> QueryString #
NFData ListContainerInstances #
Instance details Defined in Network.AWS.ECS.ListContainerInstances Methods rnf :: ListContainerInstances -> () #
type Rep ListContainerInstances #
Instance details Defined in Network.AWS.ECS.ListContainerInstances type Rep ListContainerInstances = D1 (MetaData "ListContainerInstances" "Network.AWS.ECS.ListContainerInstances" "amazonka-ecs-1.6.1-L1UdJla9EUcK0wHkUmqs0y" False) (C1 (MetaCons "ListContainerInstances'" PrefixI True) ((S1 (MetaSel (Just "_lciStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ContainerInstanceStatus)) :: S1 (MetaSel (Just "_lciCluster") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_lciNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_lciFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_lciMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))))))
type Rs ListContainerInstances #
Instance details Defined in Network.AWS.ECS.ListContainerInstances type Rs ListContainerInstances = ListContainerInstancesResponse

Request Lenses

lciStatus :: Lens' ListContainerInstances (Maybe ContainerInstanceStatus) #

Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState . If you do not specify this parameter, the default is to include container instances set to ACTIVE and DRAINING .

lciCluster :: Lens' ListContainerInstances (Maybe Text) #

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.

lciNextToken :: Lens' ListContainerInstances (Maybe Text) #

The nextToken value returned from a previous paginated ListContainerInstances request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

lciFilter :: Lens' ListContainerInstances (Maybe Text) #

You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide .

lciMaxResults :: Lens' ListContainerInstances (Maybe Int) #

The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances 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 ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.

Destructuring the Response

listContainerInstancesResponse #

Arguments

:: Int	`lcirsResponseStatus`
-> ListContainerInstancesResponse

Creates a value of ListContainerInstancesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lcirsContainerInstanceARNs - The list of container instances with full ARN entries for each container instance associated with the specified cluster.
lcirsNextToken - The nextToken value to include in a future ListContainerInstances request. When the results of a ListContainerInstances 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.
lcirsResponseStatus - -- | The response status code.

data ListContainerInstancesResponse #

See: listContainerInstancesResponse smart constructor.

Instances

Eq ListContainerInstancesResponse #
Instance details Defined in Network.AWS.ECS.ListContainerInstances Methods (==) :: ListContainerInstancesResponse -> ListContainerInstancesResponse -> Bool # (/=) :: ListContainerInstancesResponse -> ListContainerInstancesResponse -> Bool #
Data ListContainerInstancesResponse #
Instance details Defined in Network.AWS.ECS.ListContainerInstances Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListContainerInstancesResponse -> c ListContainerInstancesResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListContainerInstancesResponse # toConstr :: ListContainerInstancesResponse -> Constr # dataTypeOf :: ListContainerInstancesResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListContainerInstancesResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListContainerInstancesResponse) # gmapT :: (forall b. Data b => b -> b) -> ListContainerInstancesResponse -> ListContainerInstancesResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListContainerInstancesResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListContainerInstancesResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> ListContainerInstancesResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListContainerInstancesResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListContainerInstancesResponse -> m ListContainerInstancesResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListContainerInstancesResponse -> m ListContainerInstancesResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListContainerInstancesResponse -> m ListContainerInstancesResponse #
Read ListContainerInstancesResponse #
Instance details Defined in Network.AWS.ECS.ListContainerInstances Methods readsPrec :: Int -> ReadS ListContainerInstancesResponse # readList :: ReadS [ListContainerInstancesResponse] # readPrec :: ReadPrec ListContainerInstancesResponse # readListPrec :: ReadPrec [ListContainerInstancesResponse] #
Show ListContainerInstancesResponse #
Instance details Defined in Network.AWS.ECS.ListContainerInstances Methods showsPrec :: Int -> ListContainerInstancesResponse -> ShowS # show :: ListContainerInstancesResponse -> String # showList :: [ListContainerInstancesResponse] -> ShowS #
Generic ListContainerInstancesResponse #
Instance details Defined in Network.AWS.ECS.ListContainerInstances Associated Types type Rep ListContainerInstancesResponse :: Type -> Type # Methods from :: ListContainerInstancesResponse -> Rep ListContainerInstancesResponse x # to :: Rep ListContainerInstancesResponse x -> ListContainerInstancesResponse #
NFData ListContainerInstancesResponse #
Instance details Defined in Network.AWS.ECS.ListContainerInstances Methods rnf :: ListContainerInstancesResponse -> () #
type Rep ListContainerInstancesResponse #
Instance details Defined in Network.AWS.ECS.ListContainerInstances type Rep ListContainerInstancesResponse = D1 (MetaData "ListContainerInstancesResponse" "Network.AWS.ECS.ListContainerInstances" "amazonka-ecs-1.6.1-L1UdJla9EUcK0wHkUmqs0y" False) (C1 (MetaCons "ListContainerInstancesResponse'" PrefixI True) (S1 (MetaSel (Just "_lcirsContainerInstanceARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 (MetaSel (Just "_lcirsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_lcirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

lcirsContainerInstanceARNs :: Lens' ListContainerInstancesResponse [Text] #

The list of container instances with full ARN entries for each container instance associated with the specified cluster.

lcirsNextToken :: Lens' ListContainerInstancesResponse (Maybe Text) #

The nextToken value to include in a future ListContainerInstances request. When the results of a ListContainerInstances 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.

lcirsResponseStatus :: Lens' ListContainerInstancesResponse Int #

- | The response status code.