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.OpsWorks.DescribeEcsClusters

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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 about user permissions, see Managing User Permissions.

This call accepts only one resource-identifying parameter.

This operation returns paginated results.

Synopsis

data DescribeEcsClusters = DescribeEcsClusters' {
- ecsClusterArns :: Maybe [Text]
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- stackId :: Maybe Text
}
newDescribeEcsClusters :: DescribeEcsClusters
describeEcsClusters_ecsClusterArns :: Lens' DescribeEcsClusters (Maybe [Text])
describeEcsClusters_maxResults :: Lens' DescribeEcsClusters (Maybe Int)
describeEcsClusters_nextToken :: Lens' DescribeEcsClusters (Maybe Text)
describeEcsClusters_stackId :: Lens' DescribeEcsClusters (Maybe Text)
data DescribeEcsClustersResponse = DescribeEcsClustersResponse' {
- ecsClusters :: Maybe [EcsCluster]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newDescribeEcsClustersResponse :: Int -> DescribeEcsClustersResponse
describeEcsClustersResponse_ecsClusters :: Lens' DescribeEcsClustersResponse (Maybe [EcsCluster])
describeEcsClustersResponse_nextToken :: Lens' DescribeEcsClustersResponse (Maybe Text)
describeEcsClustersResponse_httpStatus :: Lens' DescribeEcsClustersResponse Int

Creating a Request

data DescribeEcsClusters Source #

See: newDescribeEcsClusters smart constructor.

Constructors

DescribeEcsClusters'

Fields

ecsClusterArns :: Maybe [Text]
A list of ARNs, one for each cluster to be described.
maxResults :: 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.
nextToken :: 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.
stackId :: Maybe Text
A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.

Instances

Instances details

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

newDescribeEcsClusters :: DescribeEcsClusters Source #

Create a value of DescribeEcsClusters 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:ecsClusterArns:DescribeEcsClusters', describeEcsClusters_ecsClusterArns - A list of ARNs, one for each cluster to be described.

$sel:maxResults:DescribeEcsClusters', describeEcsClusters_maxResults - 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.

DescribeEcsClusters, describeEcsClusters_nextToken - 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.

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

Request Lenses

describeEcsClusters_ecsClusterArns :: Lens' DescribeEcsClusters (Maybe [Text]) Source #

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

describeEcsClusters_maxResults :: Lens' DescribeEcsClusters (Maybe Int) Source #

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.

describeEcsClusters_nextToken :: Lens' DescribeEcsClusters (Maybe Text) Source #

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.

describeEcsClusters_stackId :: Lens' DescribeEcsClusters (Maybe Text) Source #

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

Destructuring the Response

data DescribeEcsClustersResponse Source #

Contains the response to a DescribeEcsClusters request.

See: newDescribeEcsClustersResponse smart constructor.

Constructors

DescribeEcsClustersResponse'

Fields

ecsClusters :: Maybe [EcsCluster]
A list of EcsCluster objects containing the cluster descriptions.
nextToken :: 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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeEcsClustersResponse Source #

Arguments

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

Create a value of DescribeEcsClustersResponse 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:ecsClusters:DescribeEcsClustersResponse', describeEcsClustersResponse_ecsClusters - A list of EcsCluster objects containing the cluster descriptions.

DescribeEcsClusters, describeEcsClustersResponse_nextToken - 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.

$sel:httpStatus:DescribeEcsClustersResponse', describeEcsClustersResponse_httpStatus - The response's http status code.

Response Lenses

describeEcsClustersResponse_ecsClusters :: Lens' DescribeEcsClustersResponse (Maybe [EcsCluster]) Source #

A list of EcsCluster objects containing the cluster descriptions.

describeEcsClustersResponse_nextToken :: Lens' DescribeEcsClustersResponse (Maybe Text) Source #

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.

describeEcsClustersResponse_httpStatus :: Lens' DescribeEcsClustersResponse Int Source #

The response's http status code.