Amazonka.Kafka.DescribeCluster

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

Creating a Request

data DescribeCluster

See: newDescribeCluster smart constructor.

Constructors

DescribeCluster'

Fields

• clusterArn :: Text

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

Instances

ToHeaders DescribeCluster

Defined in Amazonka.Kafka.DescribeCluster

Methods

toHeaders :: DescribeCluster -> [Header]

ToPath DescribeCluster

Defined in Amazonka.Kafka.DescribeCluster

Methods

toPath :: DescribeCluster -> ByteString

ToQuery DescribeCluster

Defined in Amazonka.Kafka.DescribeCluster

Methods

toQuery :: DescribeCluster -> QueryString

AWSRequest DescribeCluster

Defined in Amazonka.Kafka.DescribeCluster

Associated Types

type AWSResponse DescribeCluster

Methods

request :: (Service -> Service) -> DescribeCluster -> Request DescribeCluster

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

Generic DescribeCluster

Defined in Amazonka.Kafka.DescribeCluster

Associated Types

type Rep DescribeCluster :: Type -> Type

Methods

from :: DescribeCluster -> Rep DescribeCluster x

to :: Rep DescribeCluster x -> DescribeCluster

Read DescribeCluster

Defined in Amazonka.Kafka.DescribeCluster

Methods

readsPrec :: Int -> ReadS DescribeCluster

readList :: ReadS [DescribeCluster]

readPrec :: ReadPrec DescribeCluster

readListPrec :: ReadPrec [DescribeCluster]

Show DescribeCluster

Defined in Amazonka.Kafka.DescribeCluster

Methods

showsPrec :: Int -> DescribeCluster -> ShowS

show :: DescribeCluster -> String

showList :: [DescribeCluster] -> ShowS

NFData DescribeCluster

Defined in Amazonka.Kafka.DescribeCluster

Methods

rnf :: DescribeCluster -> ()

Eq DescribeCluster

Defined in Amazonka.Kafka.DescribeCluster

Methods

(==) :: DescribeCluster -> DescribeCluster -> Bool

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

Hashable DescribeCluster

Defined in Amazonka.Kafka.DescribeCluster

Methods

hashWithSalt :: Int -> DescribeCluster -> Int

hash :: DescribeCluster -> Int

type AWSResponse DescribeCluster

Defined in Amazonka.Kafka.DescribeCluster

type AWSResponse DescribeCluster = DescribeClusterResponse

type Rep DescribeCluster

Defined in Amazonka.Kafka.DescribeCluster

type Rep DescribeCluster = D1 ('MetaData "DescribeCluster" "Amazonka.Kafka.DescribeCluster" "amazonka-kafka-2.0-Go9aKmtSH8zJub8xGjzkib" 'False) (C1 ('MetaCons "DescribeCluster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusterArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeCluster

Arguments

:: Text

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:

DescribeCluster, describeCluster_clusterArn - The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Request Lenses

describeCluster_clusterArn :: Lens' DescribeCluster Text

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

Destructuring the Response

data DescribeClusterResponse

See: newDescribeClusterResponse smart constructor.

Constructors

DescribeClusterResponse'

Fields

• clusterInfo :: Maybe ClusterInfo

  The cluster information.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeClusterResponse

Defined in Amazonka.Kafka.DescribeCluster

Associated Types

type Rep DescribeClusterResponse :: Type -> Type

Methods

from :: DescribeClusterResponse -> Rep DescribeClusterResponse x

to :: Rep DescribeClusterResponse x -> DescribeClusterResponse

Read DescribeClusterResponse

Defined in Amazonka.Kafka.DescribeCluster

Methods

readsPrec :: Int -> ReadS DescribeClusterResponse

readList :: ReadS [DescribeClusterResponse]

readPrec :: ReadPrec DescribeClusterResponse

readListPrec :: ReadPrec [DescribeClusterResponse]

Show DescribeClusterResponse

Defined in Amazonka.Kafka.DescribeCluster

Methods

showsPrec :: Int -> DescribeClusterResponse -> ShowS

show :: DescribeClusterResponse -> String

showList :: [DescribeClusterResponse] -> ShowS

NFData DescribeClusterResponse

Defined in Amazonka.Kafka.DescribeCluster

Methods

rnf :: DescribeClusterResponse -> ()

Eq DescribeClusterResponse

Defined in Amazonka.Kafka.DescribeCluster

Methods

(==) :: DescribeClusterResponse -> DescribeClusterResponse -> Bool

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

type Rep DescribeClusterResponse

Defined in Amazonka.Kafka.DescribeCluster

type Rep DescribeClusterResponse = D1 ('MetaData "DescribeClusterResponse" "Amazonka.Kafka.DescribeCluster" "amazonka-kafka-2.0-Go9aKmtSH8zJub8xGjzkib" '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

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)

The cluster information.

describeClusterResponse_httpStatus :: Lens' DescribeClusterResponse Int

The response's http status code.