Skip to content

describe_connector async

describe_connector(
    connector_id: ConnectorId,
    *,
    config_overrides: Optional[AsyncTransferClientConfig] = None,
) -> DescribeConnectorResponse

Describes the connector that's identified by the ConnectorId.

Parameters:

  • connector_id (ConnectorId) –

    The unique identifier for the connector.

Raises:

Source code in docs_src/capo_transfer/_services/async_transfer.py
async def describe_connector(
    self,
    connector_id: "capo_transfer.types.connector_id.ConnectorId",
    *,
    config_overrides: Optional[AsyncTransferClientConfig] = None,
) -> "capo_transfer.types.describe_connector_response.DescribeConnectorResponse":
    """<p>Describes the connector that's identified by the <code>ConnectorId.</code> </p>

    Args:
        connector_id: <p>The unique identifier for the connector.</p>

    Raises:
        capo_transfer.errors.internal_service_error.InternalServiceError: <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
        capo_transfer.errors.invalid_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
        capo_transfer.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
        capo_transfer.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
        capo_transfer.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_transfer.types.describe_connector_request.DescribeConnectorRequest]",
    ) -> AsyncOperationResponse[
        "capo_transfer.types.describe_connector_response.DescribeConnectorResponse"
    ]:
        import capo_transfer._operations.transfer_service.describe_connector

        (
            output,
            http_response,
        ) = await capo_transfer._operations.transfer_service.describe_connector.async_describe_connector(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_transfer.types.describe_connector_response.DescribeConnectorResponse",
    ) -> dict[str, Any]:
        import capo_transfer.types.describe_connector_response

        return capo_transfer.types.describe_connector_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeConnector", redact_output=_redact_output),
    )
    input_: capo_transfer.types.describe_connector_request.DescribeConnectorRequest = {
        "connector_id": connector_id
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output