amazonka-ecs-2.0: Amazon EC2 Container Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ECS.DescribeClusters

Description

Describes one or more of your clusters.

Synopsis

Creating a Request

data DescribeClusters Source #

See: newDescribeClusters smart constructor.

Constructors

DescribeClusters' 

Fields

  • clusters :: Maybe [Text]

    A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

  • include :: Maybe [ClusterField]

    Determines whether to include additional information about the clusters in the response. If this field is omitted, this information isn't included.

    If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included, for example the capacity providers.

    If SETTINGS is specified, the settings for the cluster are included.

    If CONFIGURATIONS is specified, the configuration for the cluster is included.

    If STATISTICS is specified, the task and service count is included, separated by launch type.

    If TAGS is specified, the metadata tags associated with the cluster are included.

Instances

Instances details
ToJSON DescribeClusters Source # 
Instance details

Defined in Amazonka.ECS.DescribeClusters

Methods

toJSON :: DescribeClusters -> Value #

toEncoding :: DescribeClusters -> Encoding #

toJSONList :: [DescribeClusters] -> Value #

toEncodingList :: [DescribeClusters] -> Encoding #

ToHeaders DescribeClusters Source # 
Instance details

Defined in Amazonka.ECS.DescribeClusters

Methods

toHeaders :: DescribeClusters -> [Header] #

ToPath DescribeClusters Source # 
Instance details

Defined in Amazonka.ECS.DescribeClusters

Methods

toPath :: DescribeClusters -> ByteString #

ToQuery DescribeClusters Source # 
Instance details

Defined in Amazonka.ECS.DescribeClusters

Methods

toQuery :: DescribeClusters -> QueryString #

AWSRequest DescribeClusters Source # 
Instance details

Defined in Amazonka.ECS.DescribeClusters

Associated Types

type AWSResponse DescribeClusters #

Methods

request :: (Service -> Service) -> DescribeClusters -> Request DescribeClusters #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeClusters -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeClusters))) #

Generic DescribeClusters Source # 
Instance details

Defined in Amazonka.ECS.DescribeClusters

Associated Types

type Rep DescribeClusters :: Type -> Type #

Methods

from :: DescribeClusters -> Rep DescribeClusters x #

to :: Rep DescribeClusters x -> DescribeClusters #

Read DescribeClusters Source # 
Instance details

Defined in Amazonka.ECS.DescribeClusters

Methods

readsPrec :: Int -> ReadS DescribeClusters #

readList :: ReadS [DescribeClusters] #

readPrec :: ReadPrec DescribeClusters #

readListPrec :: ReadPrec [DescribeClusters] #

Show DescribeClusters Source # 
Instance details

Defined in Amazonka.ECS.DescribeClusters

Methods

showsPrec :: Int -> DescribeClusters -> ShowS #

show :: DescribeClusters -> String #

showList :: [DescribeClusters] -> ShowS #

NFData DescribeClusters Source # 
Instance details

Defined in Amazonka.ECS.DescribeClusters

Methods

rnf :: DescribeClusters -> () #

Eq DescribeClusters Source # 
Instance details

Defined in Amazonka.ECS.DescribeClusters

Methods

(==) :: DescribeClusters -> DescribeClusters -> Bool #

(/=) :: DescribeClusters -> DescribeClusters -> Bool #

Hashable DescribeClusters Source # 
Instance details

Defined in Amazonka.ECS.DescribeClusters

Methods

hashWithSalt :: Int -> DescribeClusters -> Int #

hash :: DescribeClusters -> Int #

type AWSResponse DescribeClusters Source # 
Instance details

Defined in Amazonka.ECS.DescribeClusters

type AWSResponse DescribeClusters = DescribeClustersResponse
type Rep DescribeClusters Source # 
Instance details

Defined in Amazonka.ECS.DescribeClusters

type Rep DescribeClusters = D1 ('MetaData "DescribeClusters" "Amazonka.ECS.DescribeClusters" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "DescribeClusters'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "include") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ClusterField]))))

newDescribeClusters :: DescribeClusters Source #

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

DescribeClusters, describeClusters_clusters - A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

$sel:include:DescribeClusters', describeClusters_include - Determines whether to include additional information about the clusters in the response. If this field is omitted, this information isn't included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included, for example the capacity providers.

If SETTINGS is specified, the settings for the cluster are included.

If CONFIGURATIONS is specified, the configuration for the cluster is included.

If STATISTICS is specified, the task and service count is included, separated by launch type.

If TAGS is specified, the metadata tags associated with the cluster are included.

Request Lenses

describeClusters_clusters :: Lens' DescribeClusters (Maybe [Text]) Source #

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

describeClusters_include :: Lens' DescribeClusters (Maybe [ClusterField]) Source #

Determines whether to include additional information about the clusters in the response. If this field is omitted, this information isn't included.

If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster are included, for example the capacity providers.

If SETTINGS is specified, the settings for the cluster are included.

If CONFIGURATIONS is specified, the configuration for the cluster is included.

If STATISTICS is specified, the task and service count is included, separated by launch type.

If TAGS is specified, the metadata tags associated with the cluster are included.

Destructuring the Response

data DescribeClustersResponse Source #

See: newDescribeClustersResponse smart constructor.

Constructors

DescribeClustersResponse' 

Fields

Instances

Instances details
Generic DescribeClustersResponse Source # 
Instance details

Defined in Amazonka.ECS.DescribeClusters

Associated Types

type Rep DescribeClustersResponse :: Type -> Type #

Methods

from :: DescribeClustersResponse -> Rep DescribeClustersResponse x #

to :: Rep DescribeClustersResponse x -> DescribeClustersResponse #

Read DescribeClustersResponse Source # 
Instance details

Defined in Amazonka.ECS.DescribeClusters

Methods

readsPrec :: Int -> ReadS DescribeClustersResponse #

readList :: ReadS [DescribeClustersResponse] #

readPrec :: ReadPrec DescribeClustersResponse #

readListPrec :: ReadPrec [DescribeClustersResponse] #

Show DescribeClustersResponse Source # 
Instance details

Defined in Amazonka.ECS.DescribeClusters

Methods

showsPrec :: Int -> DescribeClustersResponse -> ShowS #

show :: DescribeClustersResponse -> String #

showList :: [DescribeClustersResponse] -> ShowS #

NFData DescribeClustersResponse Source # 
Instance details

Defined in Amazonka.ECS.DescribeClusters

Methods

rnf :: DescribeClustersResponse -> () #

Eq DescribeClustersResponse Source # 
Instance details

Defined in Amazonka.ECS.DescribeClusters

Methods

(==) :: DescribeClustersResponse -> DescribeClustersResponse -> Bool #

(/=) :: DescribeClustersResponse -> DescribeClustersResponse -> Bool #

type Rep DescribeClustersResponse Source # 
Instance details

Defined in Amazonka.ECS.DescribeClusters

type Rep DescribeClustersResponse = D1 ('MetaData "DescribeClustersResponse" "Amazonka.ECS.DescribeClusters" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "DescribeClustersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Cluster])) :*: (S1 ('MetaSel ('Just "failures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Failure])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeClustersResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeClustersResponse'

-> DescribeClustersResponse 

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

DescribeClusters, describeClustersResponse_clusters - The list of clusters.

$sel:failures:DescribeClustersResponse', describeClustersResponse_failures - Any failures associated with the call.

$sel:httpStatus:DescribeClustersResponse', describeClustersResponse_httpStatus - The response's http status code.

Response Lenses

describeClustersResponse_clusters :: Lens' DescribeClustersResponse (Maybe [Cluster]) Source #

The list of clusters.

describeClustersResponse_failures :: Lens' DescribeClustersResponse (Maybe [Failure]) Source #

Any failures associated with the call.

describeClustersResponse_httpStatus :: Lens' DescribeClustersResponse Int Source #

The response's http status code.