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.KafkaConnect.DescribeConnector

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns summary information about the connector.

Synopsis

Creating a Request

data DescribeConnector Source #

See: newDescribeConnector smart constructor.

Constructors

DescribeConnector'
Fields connectorArn :: Text The Amazon Resource Name (ARN) of the connector that you want to describe.

Instances

Instances details

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

newDescribeConnector Source #

Arguments

:: Text	`$sel:connectorArn:DescribeConnector'`
-> DescribeConnector

Create a value of DescribeConnector 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:connectorArn:DescribeConnector', describeConnector_connectorArn - The Amazon Resource Name (ARN) of the connector that you want to describe.

Request Lenses

describeConnector_connectorArn :: Lens' DescribeConnector Text Source #

The Amazon Resource Name (ARN) of the connector that you want to describe.

Destructuring the Response

data DescribeConnectorResponse Source #

See: newDescribeConnectorResponse smart constructor.

Constructors

DescribeConnectorResponse'

Fields

creationTime :: Maybe POSIX
The time the connector was created.
kafkaCluster :: Maybe KafkaClusterDescription
The Apache Kafka cluster that the connector is connected to.
kafkaConnectVersion :: Maybe Text
The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.
logDelivery :: Maybe LogDeliveryDescription
Details about delivering logs to Amazon CloudWatch Logs.
currentVersion :: Maybe Text
The current version of the connector.
connectorConfiguration :: Maybe (HashMap Text Text)
A map of keys to values that represent the configuration for the connector.
workerConfiguration :: Maybe WorkerConfigurationDescription
Specifies which worker configuration was used for the connector.
connectorArn :: Maybe Text
The Amazon Resource Name (ARN) of the connector.
connectorName :: Maybe Text
The name of the connector.
connectorState :: Maybe ConnectorState
The state of the connector.
capacity :: Maybe CapacityDescription
Information about the capacity of the connector, whether it is auto scaled or provisioned.
plugins :: Maybe [PluginDescription]
Specifies which plugins were used for this connector.
connectorDescription :: Maybe Text
A summary description of the connector.
kafkaClusterClientAuthentication :: Maybe KafkaClusterClientAuthenticationDescription
The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.
kafkaClusterEncryptionInTransit :: Maybe KafkaClusterEncryptionInTransitDescription
Details of encryption in transit to the Apache Kafka cluster.
serviceExecutionRoleArn :: Maybe Text
The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeConnectorResponse Source #
Instance details Defined in Amazonka.KafkaConnect.DescribeConnector Methods (==) :: DescribeConnectorResponse -> DescribeConnectorResponse -> Bool # (/=) :: DescribeConnectorResponse -> DescribeConnectorResponse -> Bool #
Read DescribeConnectorResponse Source #
Instance details Defined in Amazonka.KafkaConnect.DescribeConnector Methods readsPrec :: Int -> ReadS DescribeConnectorResponse # readList :: ReadS [DescribeConnectorResponse] # readPrec :: ReadPrec DescribeConnectorResponse # readListPrec :: ReadPrec [DescribeConnectorResponse] #
Show DescribeConnectorResponse Source #
Instance details Defined in Amazonka.KafkaConnect.DescribeConnector Methods showsPrec :: Int -> DescribeConnectorResponse -> ShowS # show :: DescribeConnectorResponse -> String # showList :: [DescribeConnectorResponse] -> ShowS #
Generic DescribeConnectorResponse Source #
Instance details Defined in Amazonka.KafkaConnect.DescribeConnector Associated Types type Rep DescribeConnectorResponse :: Type -> Type # Methods from :: DescribeConnectorResponse -> Rep DescribeConnectorResponse x # to :: Rep DescribeConnectorResponse x -> DescribeConnectorResponse #
NFData DescribeConnectorResponse Source #
Instance details Defined in Amazonka.KafkaConnect.DescribeConnector Methods rnf :: DescribeConnectorResponse -> () #
type Rep DescribeConnectorResponse Source #
Instance details Defined in Amazonka.KafkaConnect.DescribeConnector type Rep DescribeConnectorResponse = D1 ('MetaData "DescribeConnectorResponse" "Amazonka.KafkaConnect.DescribeConnector" "libZSservicesZSamazonka-kafkaconnectZSamazonka-kafkaconnect" 'False) (C1 ('MetaCons "DescribeConnectorResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "kafkaCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KafkaClusterDescription))) :: (S1 ('MetaSel ('Just "kafkaConnectVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "logDelivery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogDeliveryDescription)))) :: ((S1 ('MetaSel ('Just "currentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "connectorConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "workerConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkerConfigurationDescription)) :: S1 ('MetaSel ('Just "connectorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "connectorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "connectorState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectorState))) :: (S1 ('MetaSel ('Just "capacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CapacityDescription)) :: S1 ('MetaSel ('Just "plugins") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PluginDescription])))) :: ((S1 ('MetaSel ('Just "connectorDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "kafkaClusterClientAuthentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KafkaClusterClientAuthenticationDescription))) :: (S1 ('MetaSel ('Just "kafkaClusterEncryptionInTransit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KafkaClusterEncryptionInTransitDescription)) :: (S1 ('MetaSel ('Just "serviceExecutionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribeConnectorResponse Source #

Arguments

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

Create a value of DescribeConnectorResponse 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:DescribeConnectorResponse', describeConnectorResponse_creationTime - The time the connector was created.

$sel:kafkaCluster:DescribeConnectorResponse', describeConnectorResponse_kafkaCluster - The Apache Kafka cluster that the connector is connected to.

$sel:kafkaConnectVersion:DescribeConnectorResponse', describeConnectorResponse_kafkaConnectVersion - The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.

$sel:logDelivery:DescribeConnectorResponse', describeConnectorResponse_logDelivery - Details about delivering logs to Amazon CloudWatch Logs.

$sel:currentVersion:DescribeConnectorResponse', describeConnectorResponse_currentVersion - The current version of the connector.

$sel:connectorConfiguration:DescribeConnectorResponse', describeConnectorResponse_connectorConfiguration - A map of keys to values that represent the configuration for the connector.

$sel:workerConfiguration:DescribeConnectorResponse', describeConnectorResponse_workerConfiguration - Specifies which worker configuration was used for the connector.

$sel:connectorArn:DescribeConnector', describeConnectorResponse_connectorArn - The Amazon Resource Name (ARN) of the connector.

$sel:connectorName:DescribeConnectorResponse', describeConnectorResponse_connectorName - The name of the connector.

$sel:connectorState:DescribeConnectorResponse', describeConnectorResponse_connectorState - The state of the connector.

$sel:capacity:DescribeConnectorResponse', describeConnectorResponse_capacity - Information about the capacity of the connector, whether it is auto scaled or provisioned.

$sel:plugins:DescribeConnectorResponse', describeConnectorResponse_plugins - Specifies which plugins were used for this connector.

$sel:connectorDescription:DescribeConnectorResponse', describeConnectorResponse_connectorDescription - A summary description of the connector.

$sel:kafkaClusterClientAuthentication:DescribeConnectorResponse', describeConnectorResponse_kafkaClusterClientAuthentication - The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.

$sel:kafkaClusterEncryptionInTransit:DescribeConnectorResponse', describeConnectorResponse_kafkaClusterEncryptionInTransit - Details of encryption in transit to the Apache Kafka cluster.

$sel:serviceExecutionRoleArn:DescribeConnectorResponse', describeConnectorResponse_serviceExecutionRoleArn - The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.

$sel:httpStatus:DescribeConnectorResponse', describeConnectorResponse_httpStatus - The response's http status code.

Response Lenses

describeConnectorResponse_creationTime :: Lens' DescribeConnectorResponse (Maybe UTCTime) Source #

The time the connector was created.

describeConnectorResponse_kafkaCluster :: Lens' DescribeConnectorResponse (Maybe KafkaClusterDescription) Source #

The Apache Kafka cluster that the connector is connected to.

describeConnectorResponse_kafkaConnectVersion :: Lens' DescribeConnectorResponse (Maybe Text) Source #

The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.

describeConnectorResponse_logDelivery :: Lens' DescribeConnectorResponse (Maybe LogDeliveryDescription) Source #

Details about delivering logs to Amazon CloudWatch Logs.

describeConnectorResponse_currentVersion :: Lens' DescribeConnectorResponse (Maybe Text) Source #

The current version of the connector.

describeConnectorResponse_connectorConfiguration :: Lens' DescribeConnectorResponse (Maybe (HashMap Text Text)) Source #

A map of keys to values that represent the configuration for the connector.

describeConnectorResponse_workerConfiguration :: Lens' DescribeConnectorResponse (Maybe WorkerConfigurationDescription) Source #

Specifies which worker configuration was used for the connector.

describeConnectorResponse_connectorArn :: Lens' DescribeConnectorResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the connector.

describeConnectorResponse_connectorName :: Lens' DescribeConnectorResponse (Maybe Text) Source #

The name of the connector.

describeConnectorResponse_connectorState :: Lens' DescribeConnectorResponse (Maybe ConnectorState) Source #

The state of the connector.

describeConnectorResponse_capacity :: Lens' DescribeConnectorResponse (Maybe CapacityDescription) Source #

Information about the capacity of the connector, whether it is auto scaled or provisioned.

describeConnectorResponse_plugins :: Lens' DescribeConnectorResponse (Maybe [PluginDescription]) Source #

Specifies which plugins were used for this connector.

describeConnectorResponse_connectorDescription :: Lens' DescribeConnectorResponse (Maybe Text) Source #

A summary description of the connector.

describeConnectorResponse_kafkaClusterClientAuthentication :: Lens' DescribeConnectorResponse (Maybe KafkaClusterClientAuthenticationDescription) Source #

The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.

describeConnectorResponse_kafkaClusterEncryptionInTransit :: Lens' DescribeConnectorResponse (Maybe KafkaClusterEncryptionInTransitDescription) Source #

Details of encryption in transit to the Apache Kafka cluster.

describeConnectorResponse_serviceExecutionRoleArn :: Lens' DescribeConnectorResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.

describeConnectorResponse_httpStatus :: Lens' DescribeConnectorResponse Int Source #

The response's http status code.