Amazonka.KafkaConnect.DescribeConnector

Returns summary information about the connector.

Creating a Request

data DescribeConnector

See: newDescribeConnector smart constructor.

Constructors

DescribeConnector'

Fields

• connectorArn :: Text

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

Instances

ToHeaders DescribeConnector

Defined in Amazonka.KafkaConnect.DescribeConnector

Methods

toHeaders :: DescribeConnector -> [Header]

ToPath DescribeConnector

Defined in Amazonka.KafkaConnect.DescribeConnector

Methods

toPath :: DescribeConnector -> ByteString

ToQuery DescribeConnector

Defined in Amazonka.KafkaConnect.DescribeConnector

Methods

toQuery :: DescribeConnector -> QueryString

AWSRequest DescribeConnector

Defined in Amazonka.KafkaConnect.DescribeConnector

Associated Types

type AWSResponse DescribeConnector

Methods

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

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

Generic DescribeConnector

Defined in Amazonka.KafkaConnect.DescribeConnector

Associated Types

type Rep DescribeConnector :: Type -> Type

Methods

from :: DescribeConnector -> Rep DescribeConnector x

to :: Rep DescribeConnector x -> DescribeConnector

Read DescribeConnector

Defined in Amazonka.KafkaConnect.DescribeConnector

Methods

readsPrec :: Int -> ReadS DescribeConnector

readList :: ReadS [DescribeConnector]

readPrec :: ReadPrec DescribeConnector

readListPrec :: ReadPrec [DescribeConnector]

Show DescribeConnector

Defined in Amazonka.KafkaConnect.DescribeConnector

Methods

showsPrec :: Int -> DescribeConnector -> ShowS

show :: DescribeConnector -> String

showList :: [DescribeConnector] -> ShowS

NFData DescribeConnector

Defined in Amazonka.KafkaConnect.DescribeConnector

Methods

rnf :: DescribeConnector -> ()

Eq DescribeConnector

Defined in Amazonka.KafkaConnect.DescribeConnector

Methods

(==) :: DescribeConnector -> DescribeConnector -> Bool

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

Hashable DescribeConnector

Defined in Amazonka.KafkaConnect.DescribeConnector

Methods

hashWithSalt :: Int -> DescribeConnector -> Int

hash :: DescribeConnector -> Int

type AWSResponse DescribeConnector

Defined in Amazonka.KafkaConnect.DescribeConnector

type AWSResponse DescribeConnector = DescribeConnectorResponse

type Rep DescribeConnector

Defined in Amazonka.KafkaConnect.DescribeConnector

type Rep DescribeConnector = D1 ('MetaData "DescribeConnector" "Amazonka.KafkaConnect.DescribeConnector" "amazonka-kafkaconnect-2.0-4ed6DFGevt995RzDsMjJqs" 'False) (C1 ('MetaCons "DescribeConnector'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connectorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeConnector

Arguments

:: Text

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:

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

Request Lenses

describeConnector_connectorArn :: Lens' DescribeConnector Text

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

Destructuring the Response

data DescribeConnectorResponse

See: newDescribeConnectorResponse smart constructor.

Constructors

DescribeConnectorResponse'

Fields

• capacity :: Maybe CapacityDescription

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

• connectorArn :: Maybe Text

  The Amazon Resource Name (ARN) of the connector.

• connectorConfiguration :: Maybe (Sensitive (HashMap Text Text))

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

• connectorDescription :: Maybe Text

  A summary description of the connector.

• connectorName :: Maybe Text

  The name of the connector.

• connectorState :: Maybe ConnectorState

  The state of the connector.

• creationTime :: Maybe ISO8601

  The time the connector was created.

• currentVersion :: Maybe Text

  The current version of the connector.

• kafkaCluster :: Maybe KafkaClusterDescription

  The Apache Kafka cluster that the connector is connected to.

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

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

• plugins :: Maybe [PluginDescription]

  Specifies which plugins were used for this connector.

• serviceExecutionRoleArn :: Maybe Text

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

• stateDescription :: Maybe StateDescription

  Details about the state of a connector.

• workerConfiguration :: Maybe WorkerConfigurationDescription

  Specifies which worker configuration was used for the connector.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeConnectorResponse

Defined in Amazonka.KafkaConnect.DescribeConnector

Associated Types

type Rep DescribeConnectorResponse :: Type -> Type

Methods

from :: DescribeConnectorResponse -> Rep DescribeConnectorResponse x

to :: Rep DescribeConnectorResponse x -> DescribeConnectorResponse

Show DescribeConnectorResponse

Defined in Amazonka.KafkaConnect.DescribeConnector

Methods

showsPrec :: Int -> DescribeConnectorResponse -> ShowS

show :: DescribeConnectorResponse -> String

showList :: [DescribeConnectorResponse] -> ShowS

NFData DescribeConnectorResponse

Defined in Amazonka.KafkaConnect.DescribeConnector

Methods

rnf :: DescribeConnectorResponse -> ()

Eq DescribeConnectorResponse

Defined in Amazonka.KafkaConnect.DescribeConnector

Methods

(==) :: DescribeConnectorResponse -> DescribeConnectorResponse -> Bool

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

type Rep DescribeConnectorResponse

Defined in Amazonka.KafkaConnect.DescribeConnector

type Rep DescribeConnectorResponse = D1 ('MetaData "DescribeConnectorResponse" "Amazonka.KafkaConnect.DescribeConnector" "amazonka-kafkaconnect-2.0-4ed6DFGevt995RzDsMjJqs" 'False) (C1 ('MetaCons "DescribeConnectorResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "capacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CapacityDescription)) :*: S1 ('MetaSel ('Just "connectorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "connectorConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text Text)))) :*: S1 ('MetaSel ('Just "connectorDescription") '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 "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: (S1 ('MetaSel ('Just "currentVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "kafkaCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KafkaClusterDescription)))))) :*: (((S1 ('MetaSel ('Just "kafkaClusterClientAuthentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KafkaClusterClientAuthenticationDescription)) :*: S1 ('MetaSel ('Just "kafkaClusterEncryptionInTransit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KafkaClusterEncryptionInTransitDescription))) :*: (S1 ('MetaSel ('Just "kafkaConnectVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "logDelivery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogDeliveryDescription)))) :*: ((S1 ('MetaSel ('Just "plugins") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PluginDescription])) :*: S1 ('MetaSel ('Just "serviceExecutionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "stateDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StateDescription)) :*: (S1 ('MetaSel ('Just "workerConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkerConfigurationDescription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newDescribeConnectorResponse

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:

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

DescribeConnector, describeConnectorResponse_connectorArn - The Amazon Resource Name (ARN) of the connector.

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

DescribeConnectorResponse, describeConnectorResponse_connectorDescription - A summary description of the connector.

DescribeConnectorResponse, describeConnectorResponse_connectorName - The name of the connector.

DescribeConnectorResponse, describeConnectorResponse_connectorState - The state of the connector.

DescribeConnectorResponse, describeConnectorResponse_creationTime - The time the connector was created.

DescribeConnectorResponse, describeConnectorResponse_currentVersion - The current version of the connector.

DescribeConnectorResponse, describeConnectorResponse_kafkaCluster - The Apache Kafka cluster that the connector is connected to.

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.

DescribeConnectorResponse, describeConnectorResponse_kafkaClusterEncryptionInTransit - Details of encryption in transit to the Apache Kafka cluster.

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

DescribeConnectorResponse, describeConnectorResponse_logDelivery - Details about delivering logs to Amazon CloudWatch Logs.

DescribeConnectorResponse, describeConnectorResponse_plugins - Specifies which plugins were used for this connector.

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

$sel:stateDescription:DescribeConnectorResponse', describeConnectorResponse_stateDescription - Details about the state of a connector.

DescribeConnectorResponse, describeConnectorResponse_workerConfiguration - Specifies which worker configuration was used for the connector.

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

Response Lenses

describeConnectorResponse_capacity :: Lens' DescribeConnectorResponse (Maybe CapacityDescription)

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

describeConnectorResponse_connectorArn :: Lens' DescribeConnectorResponse (Maybe Text)

The Amazon Resource Name (ARN) of the connector.

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

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

describeConnectorResponse_connectorDescription :: Lens' DescribeConnectorResponse (Maybe Text)

A summary description of the connector.

describeConnectorResponse_connectorName :: Lens' DescribeConnectorResponse (Maybe Text)

The name of the connector.

describeConnectorResponse_connectorState :: Lens' DescribeConnectorResponse (Maybe ConnectorState)

The state of the connector.

describeConnectorResponse_creationTime :: Lens' DescribeConnectorResponse (Maybe UTCTime)

The time the connector was created.

describeConnectorResponse_currentVersion :: Lens' DescribeConnectorResponse (Maybe Text)

The current version of the connector.

describeConnectorResponse_kafkaCluster :: Lens' DescribeConnectorResponse (Maybe KafkaClusterDescription)

The Apache Kafka cluster that the connector is connected to.

describeConnectorResponse_kafkaClusterClientAuthentication :: Lens' DescribeConnectorResponse (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.

describeConnectorResponse_kafkaClusterEncryptionInTransit :: Lens' DescribeConnectorResponse (Maybe KafkaClusterEncryptionInTransitDescription)

Details of encryption in transit to the Apache Kafka cluster.

describeConnectorResponse_kafkaConnectVersion :: Lens' DescribeConnectorResponse (Maybe Text)

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)

Details about delivering logs to Amazon CloudWatch Logs.

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

Specifies which plugins were used for this connector.

describeConnectorResponse_serviceExecutionRoleArn :: Lens' DescribeConnectorResponse (Maybe Text)

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

describeConnectorResponse_stateDescription :: Lens' DescribeConnectorResponse (Maybe StateDescription)

Details about the state of a connector.

describeConnectorResponse_workerConfiguration :: Lens' DescribeConnectorResponse (Maybe WorkerConfigurationDescription)

Specifies which worker configuration was used for the connector.

describeConnectorResponse_httpStatus :: Lens' DescribeConnectorResponse Int

The response's http status code.