Network.AWS.OpsWorks.DescribeEcsClusters

Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the MaxResults and NextToken parameters to paginate the response. However, AWS OpsWorks Stacks currently supports only one cluster per layer, so the result set has a maximum of one element.

Required Permissions : To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information on user permissions, see Managing User Permissions .

This call accepts only one resource-identifying parameter.

This operation returns paginated results.

Creating a Request

describeEcsClusters :: DescribeEcsClusters

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

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

• decNextToken - If the previous paginated request did not return all of the remaining results, the response object'sNextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null .
• decStackId - A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.
• decMaxResults - To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
• decEcsClusterARNs - A list of ARNs, one for each cluster to be described.

data DescribeEcsClusters

See: describeEcsClusters smart constructor.

Instances

Eq DescribeEcsClusters

Methods

(==) :: DescribeEcsClusters -> DescribeEcsClusters -> Bool

(/=) :: DescribeEcsClusters -> DescribeEcsClusters -> Bool

Data DescribeEcsClusters

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeEcsClusters -> c DescribeEcsClusters

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeEcsClusters

toConstr :: DescribeEcsClusters -> Constr

dataTypeOf :: DescribeEcsClusters -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeEcsClusters)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeEcsClusters)

gmapT :: (forall b. Data b => b -> b) -> DescribeEcsClusters -> DescribeEcsClusters

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEcsClusters -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEcsClusters -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeEcsClusters -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeEcsClusters -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeEcsClusters -> m DescribeEcsClusters

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEcsClusters -> m DescribeEcsClusters

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEcsClusters -> m DescribeEcsClusters

Read DescribeEcsClusters

Methods

readsPrec :: Int -> ReadS DescribeEcsClusters

readList :: ReadS [DescribeEcsClusters]

readPrec :: ReadPrec DescribeEcsClusters

readListPrec :: ReadPrec [DescribeEcsClusters]

Show DescribeEcsClusters

Methods

showsPrec :: Int -> DescribeEcsClusters -> ShowS

show :: DescribeEcsClusters -> String

showList :: [DescribeEcsClusters] -> ShowS

Generic DescribeEcsClusters

Associated Types

type Rep DescribeEcsClusters :: * -> *

Methods

from :: DescribeEcsClusters -> Rep DescribeEcsClusters x

to :: Rep DescribeEcsClusters x -> DescribeEcsClusters

Hashable DescribeEcsClusters

Methods

hashWithSalt :: Int -> DescribeEcsClusters -> Int

hash :: DescribeEcsClusters -> Int

ToJSON DescribeEcsClusters

Methods

toJSON :: DescribeEcsClusters -> Value

toEncoding :: DescribeEcsClusters -> Encoding

toJSONList :: [DescribeEcsClusters] -> Value

toEncodingList :: [DescribeEcsClusters] -> Encoding

NFData DescribeEcsClusters

Methods

rnf :: DescribeEcsClusters -> ()

AWSPager DescribeEcsClusters

Methods

page :: DescribeEcsClusters -> Rs DescribeEcsClusters -> Maybe DescribeEcsClusters

AWSRequest DescribeEcsClusters

Associated Types

type Rs DescribeEcsClusters :: *

Methods

request :: DescribeEcsClusters -> Request DescribeEcsClusters

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeEcsClusters -> ClientResponse -> m (Response DescribeEcsClusters)

ToHeaders DescribeEcsClusters

Methods

toHeaders :: DescribeEcsClusters -> [Header]

ToPath DescribeEcsClusters

Methods

toPath :: DescribeEcsClusters -> ByteString

ToQuery DescribeEcsClusters

Methods

toQuery :: DescribeEcsClusters -> QueryString

type Rep DescribeEcsClusters

type Rep DescribeEcsClusters = D1 * (MetaData "DescribeEcsClusters" "Network.AWS.OpsWorks.DescribeEcsClusters" "amazonka-opsworks-1.6.0-dhw3H9lmJm2qKjEl8vg7Z" False) (C1 * (MetaCons "DescribeEcsClusters'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_decNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_decStackId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_decMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_decEcsClusterARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))))))

type Rs DescribeEcsClusters

type Rs DescribeEcsClusters = DescribeEcsClustersResponse

Request Lenses

decNextToken :: Lens' DescribeEcsClusters (Maybe Text)

If the previous paginated request did not return all of the remaining results, the response object'sNextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null .

decStackId :: Lens' DescribeEcsClusters (Maybe Text)

A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.

decMaxResults :: Lens' DescribeEcsClusters (Maybe Int)

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

decEcsClusterARNs :: Lens' DescribeEcsClusters [Text]

A list of ARNs, one for each cluster to be described.

Destructuring the Response

describeEcsClustersResponse

Arguments

:: Int

decrsResponseStatus

-> DescribeEcsClustersResponse

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

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

• decrsNextToken - If a paginated request does not return all of the remaining results, this parameter is set to a token that you can assign to the request object's NextToken parameter to retrieve the next set of results. If the previous paginated request returned all of the remaining results, this parameter is set to null .
• decrsEcsClusters - A list of EcsCluster objects containing the cluster descriptions.
• decrsResponseStatus - -- | The response status code.

data DescribeEcsClustersResponse

Contains the response to a DescribeEcsClusters request.

See: describeEcsClustersResponse smart constructor.

Instances

Eq DescribeEcsClustersResponse

Methods

(==) :: DescribeEcsClustersResponse -> DescribeEcsClustersResponse -> Bool

(/=) :: DescribeEcsClustersResponse -> DescribeEcsClustersResponse -> Bool

Data DescribeEcsClustersResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeEcsClustersResponse -> c DescribeEcsClustersResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeEcsClustersResponse

toConstr :: DescribeEcsClustersResponse -> Constr

dataTypeOf :: DescribeEcsClustersResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeEcsClustersResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeEcsClustersResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeEcsClustersResponse -> DescribeEcsClustersResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEcsClustersResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeEcsClustersResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeEcsClustersResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeEcsClustersResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeEcsClustersResponse -> m DescribeEcsClustersResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEcsClustersResponse -> m DescribeEcsClustersResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeEcsClustersResponse -> m DescribeEcsClustersResponse

Read DescribeEcsClustersResponse

Methods

readsPrec :: Int -> ReadS DescribeEcsClustersResponse

readList :: ReadS [DescribeEcsClustersResponse]

readPrec :: ReadPrec DescribeEcsClustersResponse

readListPrec :: ReadPrec [DescribeEcsClustersResponse]

Show DescribeEcsClustersResponse

Methods

showsPrec :: Int -> DescribeEcsClustersResponse -> ShowS

show :: DescribeEcsClustersResponse -> String

showList :: [DescribeEcsClustersResponse] -> ShowS

Generic DescribeEcsClustersResponse

Associated Types

type Rep DescribeEcsClustersResponse :: * -> *

Methods

from :: DescribeEcsClustersResponse -> Rep DescribeEcsClustersResponse x

to :: Rep DescribeEcsClustersResponse x -> DescribeEcsClustersResponse

NFData DescribeEcsClustersResponse

Methods

rnf :: DescribeEcsClustersResponse -> ()

type Rep DescribeEcsClustersResponse

type Rep DescribeEcsClustersResponse = D1 * (MetaData "DescribeEcsClustersResponse" "Network.AWS.OpsWorks.DescribeEcsClusters" "amazonka-opsworks-1.6.0-dhw3H9lmJm2qKjEl8vg7Z" False) (C1 * (MetaCons "DescribeEcsClustersResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_decrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_decrsEcsClusters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [EcsCluster]))) (S1 * (MetaSel (Just Symbol "_decrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

decrsNextToken :: Lens' DescribeEcsClustersResponse (Maybe Text)

If a paginated request does not return all of the remaining results, this parameter is set to a token that you can assign to the request object's NextToken parameter to retrieve the next set of results. If the previous paginated request returned all of the remaining results, this parameter is set to null .

decrsEcsClusters :: Lens' DescribeEcsClustersResponse [EcsCluster]

A list of EcsCluster objects containing the cluster descriptions.

decrsResponseStatus :: Lens' DescribeEcsClustersResponse Int

• - | The response status code.