amazonka-kafka-2.0: Amazon Managed Streaming for Kafka 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.Kafka.DescribeConfiguration

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
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 #

AWSRequest DescribeConfiguration Source # 
Instance details

Defined in Amazonka.Kafka.DescribeConfiguration

Associated Types

type AWSResponse DescribeConfiguration #

Methods

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

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

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 #

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 #

NFData DescribeConfiguration Source # 
Instance details

Defined in Amazonka.Kafka.DescribeConfiguration

Methods

rnf :: DescribeConfiguration -> () #

Eq DescribeConfiguration Source # 
Instance details

Defined in Amazonka.Kafka.DescribeConfiguration

Methods

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

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

Hashable DescribeConfiguration Source # 
Instance details

Defined in Amazonka.Kafka.DescribeConfiguration

Methods

hashWithSalt :: Int -> DescribeConfiguration -> Int #

hash :: DescribeConfiguration -> Int #

type AWSResponse DescribeConfiguration Source # 
Instance details

Defined in Amazonka.Kafka.DescribeConfiguration

type AWSResponse DescribeConfiguration = DescribeConfigurationResponse
type Rep DescribeConfiguration Source # 
Instance details

Defined in Amazonka.Kafka.DescribeConfiguration

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

newDescribeConfiguration Source #

Arguments

:: Text

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:

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

Instances

Instances details
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 #

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 #

NFData DescribeConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kafka.DescribeConfiguration

Methods

rnf :: DescribeConfigurationResponse -> () #

Eq DescribeConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kafka.DescribeConfiguration

Methods

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

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

type Rep DescribeConfigurationResponse Source # 
Instance details

Defined in Amazonka.Kafka.DescribeConfiguration

type Rep DescribeConfigurationResponse = D1 ('MetaData "DescribeConfigurationResponse" "Amazonka.Kafka.DescribeConfiguration" "amazonka-kafka-2.0-Go9aKmtSH8zJub8xGjzkib" 'False) (C1 ('MetaCons "DescribeConfigurationResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "kafkaVersions") '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 "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfigurationState)) :*: 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:

DescribeConfiguration, describeConfigurationResponse_arn - The Amazon Resource Name (ARN) of the configuration.

DescribeConfigurationResponse, describeConfigurationResponse_creationTime - The time when the configuration was created.

DescribeConfigurationResponse, describeConfigurationResponse_description - The description of the configuration.

DescribeConfigurationResponse, describeConfigurationResponse_kafkaVersions - The versions of Apache Kafka with which you can use this MSK configuration.

DescribeConfigurationResponse, describeConfigurationResponse_latestRevision - Latest revision of the configuration.

DescribeConfigurationResponse, describeConfigurationResponse_name - The name of the configuration.

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

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

Response Lenses

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

The Amazon Resource Name (ARN) of the configuration.

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

The time when the configuration was created.

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

The description of the configuration.

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

The versions of Apache Kafka with which you can use this MSK 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_state :: Lens' DescribeConfigurationResponse (Maybe ConfigurationState) Source #

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

describeConfigurationResponse_httpStatus :: Lens' DescribeConfigurationResponse Int Source #

The response's http status code.