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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux ).

Creating a Request

listAttributes #

Arguments

:: TargetType	`laTargetType`
-> ListAttributes

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

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

laAttributeValue - The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.
laCluster - The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.
laNextToken - The nextToken value returned from a previous paginated ListAttributes 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.
laAttributeName - The name of the attribute with which to filter the results.
laMaxResults - The maximum number of cluster results returned by ListAttributes in paginated output. When this parameter is used, ListAttributes 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 ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListAttributes returns up to 100 results and a nextToken value if applicable.
laTargetType - The type of the target with which to list attributes.

data ListAttributes #

See: listAttributes smart constructor.

Instances

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

Request Lenses

laAttributeValue :: Lens' ListAttributes (Maybe Text) #

The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.

laCluster :: Lens' ListAttributes (Maybe Text) #

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

laNextToken :: Lens' ListAttributes (Maybe Text) #

The nextToken value returned from a previous paginated ListAttributes 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.

laAttributeName :: Lens' ListAttributes (Maybe Text) #

The name of the attribute with which to filter the results.

laMaxResults :: Lens' ListAttributes (Maybe Int) #

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

laTargetType :: Lens' ListAttributes TargetType #

The type of the target with which to list attributes.

Destructuring the Response

listAttributesResponse #

Arguments

:: Int	`larsResponseStatus`
-> ListAttributesResponse

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

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

larsNextToken - The nextToken value to include in a future ListAttributes request. When the results of a ListAttributes 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.
larsAttributes - A list of attribute objects that meet the criteria of the request.
larsResponseStatus - -- | The response status code.

data ListAttributesResponse #

See: listAttributesResponse smart constructor.

Instances

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

Response Lenses

larsNextToken :: Lens' ListAttributesResponse (Maybe Text) #

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

larsAttributes :: Lens' ListAttributesResponse [Attribute] #

A list of attribute objects that meet the criteria of the request.

larsResponseStatus :: Lens' ListAttributesResponse Int #

- | The response status code.