Skip to content

get_connection

get_connection(
    domain_identifier: DomainId,
    identifier: ConnectionId,
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    with_secret: Optional[bool] = None,
) -> GetConnectionOutput

Gets a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.

Parameters:

  • domain_identifier (DomainId) –

    The ID of the domain where we get the connection.

  • identifier (ConnectionId) –

    The connection ID.

  • with_secret (Optional[bool], default: None ) –

    Specifies whether a connection has a secret.

Raises:

Source code in docs_src/capo_datazone/_services/data_zone.py
def get_connection(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    identifier: "capo_datazone.types.connection_id.ConnectionId",
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    with_secret: Optional[bool] = None,
) -> "capo_datazone.types.get_connection_output.GetConnectionOutput":
    """<p>Gets a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.</p>

    Args:
        domain_identifier: <p>The ID of the domain where we get the connection.</p>
        identifier: <p>The connection ID.</p>
        with_secret: <p>Specifies whether a connection has a secret.</p>

    Raises:
        capo_datazone.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_datazone.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_datazone.errors.unauthorized_exception.UnauthorizedException: <p>You do not have permission to perform this action.</p>
        capo_datazone.errors.internal_server_exception.InternalServerException: <p>The request has failed because of an unknown error, exception or failure.</p>
        capo_datazone.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource cannot be found.</p>
        capo_datazone.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
        capo_datazone.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_datazone.types.get_connection_input.GetConnectionInput]",
    ) -> OperationResponse[
        "capo_datazone.types.get_connection_output.GetConnectionOutput"
    ]:
        import capo_datazone._operations.data_zone.get_connection

        output, http_response = (
            capo_datazone._operations.data_zone.get_connection.get_connection(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_datazone.types.get_connection_output.GetConnectionOutput",
    ) -> dict[str, Any]:
        import capo_datazone.types.get_connection_output

        return capo_datazone.types.get_connection_output.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetConnection", redact_output=_redact_output),
    )
    input_: capo_datazone.types.get_connection_input.GetConnectionInput = {
        "domain_identifier": domain_identifier,
        "identifier": identifier,
    }
    if with_secret is not None:
        input_["with_secret"] = with_secret

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output