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.DescribeConfiguration

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a description of this MSK configuration.

Synopsis

Creating a Request

data DescribeConfiguration Source #

See: newDescribeConfiguration smart constructor.

Constructors

DescribeConfiguration'
Fields arn :: Text The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

Instances

Instances details

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

newDescribeConfiguration Source #

Arguments

:: Text	`$sel:arn:DescribeConfiguration'`
-> DescribeConfiguration

Create a value of DescribeConfiguration 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:arn:DescribeConfiguration', describeConfiguration_arn - The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

Request Lenses

describeConfiguration_arn :: Lens' DescribeConfiguration Text Source #

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

Destructuring the Response

data DescribeConfigurationResponse Source #

See: newDescribeConfigurationResponse smart constructor.

Constructors

DescribeConfigurationResponse'

Fields

creationTime :: Maybe POSIX
The time when the configuration was created.
state :: Maybe ConfigurationState
The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.
kafkaVersions :: Maybe [Text]
The versions of Apache Kafka with which you can use this MSK configuration.
arn :: Maybe Text
The Amazon Resource Name (ARN) of the configuration.
latestRevision :: Maybe ConfigurationRevision
Latest revision of the configuration.
name :: Maybe Text
The name of the configuration.
description :: Maybe Text
The description of the configuration.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeConfigurationResponse Source #

Arguments

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

Create a value of DescribeConfigurationResponse 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:creationTime:DescribeConfigurationResponse', describeConfigurationResponse_creationTime - The time when the configuration was created.

$sel:state:DescribeConfigurationResponse', describeConfigurationResponse_state - The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

$sel:kafkaVersions:DescribeConfigurationResponse', describeConfigurationResponse_kafkaVersions - The versions of Apache Kafka with which you can use this MSK configuration.

$sel:arn:DescribeConfiguration', describeConfigurationResponse_arn - The Amazon Resource Name (ARN) of the configuration.

$sel:latestRevision:DescribeConfigurationResponse', describeConfigurationResponse_latestRevision - Latest revision of the configuration.

$sel:name:DescribeConfigurationResponse', describeConfigurationResponse_name - The name of the configuration.

$sel:description:DescribeConfigurationResponse', describeConfigurationResponse_description - The description of the configuration.

$sel:httpStatus:DescribeConfigurationResponse', describeConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

describeConfigurationResponse_creationTime :: Lens' DescribeConfigurationResponse (Maybe UTCTime) Source #

The time when the configuration was created.

describeConfigurationResponse_state :: Lens' DescribeConfigurationResponse (Maybe ConfigurationState) Source #

The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

describeConfigurationResponse_kafkaVersions :: Lens' DescribeConfigurationResponse (Maybe [Text]) Source #

The versions of Apache Kafka with which you can use this MSK configuration.

describeConfigurationResponse_arn :: Lens' DescribeConfigurationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the configuration.

describeConfigurationResponse_latestRevision :: Lens' DescribeConfigurationResponse (Maybe ConfigurationRevision) Source #

Latest revision of the configuration.

describeConfigurationResponse_name :: Lens' DescribeConfigurationResponse (Maybe Text) Source #

The name of the configuration.

describeConfigurationResponse_description :: Lens' DescribeConfigurationResponse (Maybe Text) Source #

The description of the configuration.

describeConfigurationResponse_httpStatus :: Lens' DescribeConfigurationResponse Int Source #

The response's http status code.