Copyright	(c) 2013-2021 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

Amazonka.Kafka.DescribeCluster

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

Creating a Request

data DescribeCluster Source #

See: newDescribeCluster smart constructor.

Constructors

DescribeCluster'
Fields clusterArn :: Text The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Instances

Instances details

Eq DescribeCluster Source #
Instance details Defined in Amazonka.Kafka.DescribeCluster Methods (==) :: DescribeCluster -> DescribeCluster -> Bool # (/=) :: DescribeCluster -> DescribeCluster -> Bool #
Read DescribeCluster Source #
Instance details Defined in Amazonka.Kafka.DescribeCluster Methods readsPrec :: Int -> ReadS DescribeCluster # readList :: ReadS [DescribeCluster] # readPrec :: ReadPrec DescribeCluster # readListPrec :: ReadPrec [DescribeCluster] #
Show DescribeCluster Source #
Instance details Defined in Amazonka.Kafka.DescribeCluster Methods showsPrec :: Int -> DescribeCluster -> ShowS # show :: DescribeCluster -> String # showList :: [DescribeCluster] -> ShowS #
Generic DescribeCluster Source #
Instance details Defined in Amazonka.Kafka.DescribeCluster Associated Types type Rep DescribeCluster :: Type -> Type # Methods from :: DescribeCluster -> Rep DescribeCluster x # to :: Rep DescribeCluster x -> DescribeCluster #
NFData DescribeCluster Source #
Instance details Defined in Amazonka.Kafka.DescribeCluster Methods rnf :: DescribeCluster -> () #
Hashable DescribeCluster Source #
Instance details Defined in Amazonka.Kafka.DescribeCluster Methods hashWithSalt :: Int -> DescribeCluster -> Int # hash :: DescribeCluster -> Int #
AWSRequest DescribeCluster Source #
Instance details Defined in Amazonka.Kafka.DescribeCluster Associated Types type AWSResponse DescribeCluster # Methods request :: DescribeCluster -> Request DescribeCluster # response :: MonadResource m => Logger -> Service -> Proxy DescribeCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeCluster))) #
ToHeaders DescribeCluster Source #
Instance details Defined in Amazonka.Kafka.DescribeCluster Methods toHeaders :: DescribeCluster -> [Header] #
ToPath DescribeCluster Source #
Instance details Defined in Amazonka.Kafka.DescribeCluster Methods toPath :: DescribeCluster -> ByteString #
ToQuery DescribeCluster Source #
Instance details Defined in Amazonka.Kafka.DescribeCluster Methods toQuery :: DescribeCluster -> QueryString #
type Rep DescribeCluster Source #
Instance details Defined in Amazonka.Kafka.DescribeCluster type Rep DescribeCluster = D1 ('MetaData "DescribeCluster" "Amazonka.Kafka.DescribeCluster" "libZSservicesZSamazonka-kafkaZSamazonka-kafka" 'False) (C1 ('MetaCons "DescribeCluster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeCluster Source #
Instance details Defined in Amazonka.Kafka.DescribeCluster type AWSResponse DescribeCluster = DescribeClusterResponse

newDescribeCluster Source #

Arguments

:: Text	`$sel:clusterArn:DescribeCluster'`
-> DescribeCluster

Create a value of DescribeCluster 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:clusterArn:DescribeCluster', describeCluster_clusterArn - The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Request Lenses

describeCluster_clusterArn :: Lens' DescribeCluster Text Source #

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Destructuring the Response

data DescribeClusterResponse Source #

See: newDescribeClusterResponse smart constructor.

Constructors

DescribeClusterResponse'
Fields clusterInfo :: Maybe ClusterInfo The cluster information. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeClusterResponse Source #
Instance details Defined in Amazonka.Kafka.DescribeCluster Methods (==) :: DescribeClusterResponse -> DescribeClusterResponse -> Bool # (/=) :: DescribeClusterResponse -> DescribeClusterResponse -> Bool #
Read DescribeClusterResponse Source #
Instance details Defined in Amazonka.Kafka.DescribeCluster Methods readsPrec :: Int -> ReadS DescribeClusterResponse # readList :: ReadS [DescribeClusterResponse] # readPrec :: ReadPrec DescribeClusterResponse # readListPrec :: ReadPrec [DescribeClusterResponse] #
Show DescribeClusterResponse Source #
Instance details Defined in Amazonka.Kafka.DescribeCluster Methods showsPrec :: Int -> DescribeClusterResponse -> ShowS # show :: DescribeClusterResponse -> String # showList :: [DescribeClusterResponse] -> ShowS #
Generic DescribeClusterResponse Source #
Instance details Defined in Amazonka.Kafka.DescribeCluster Associated Types type Rep DescribeClusterResponse :: Type -> Type # Methods from :: DescribeClusterResponse -> Rep DescribeClusterResponse x # to :: Rep DescribeClusterResponse x -> DescribeClusterResponse #
NFData DescribeClusterResponse Source #
Instance details Defined in Amazonka.Kafka.DescribeCluster Methods rnf :: DescribeClusterResponse -> () #
type Rep DescribeClusterResponse Source #
Instance details Defined in Amazonka.Kafka.DescribeCluster type Rep DescribeClusterResponse = D1 ('MetaData "DescribeClusterResponse" "Amazonka.Kafka.DescribeCluster" "libZSservicesZSamazonka-kafkaZSamazonka-kafka" 'False) (C1 ('MetaCons "DescribeClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusterInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterInfo)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeClusterResponse Source #

Arguments

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

Create a value of DescribeClusterResponse 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:clusterInfo:DescribeClusterResponse', describeClusterResponse_clusterInfo - The cluster information.

$sel:httpStatus:DescribeClusterResponse', describeClusterResponse_httpStatus - The response's http status code.

Response Lenses

describeClusterResponse_clusterInfo :: Lens' DescribeClusterResponse (Maybe ClusterInfo) Source #

The cluster information.

describeClusterResponse_httpStatus :: Lens' DescribeClusterResponse Int Source #

The response's http status code.