Skip to content

get_connection

get_connection(
    catalog: Catalog,
    identifier: ConnectionId,
    *,
    config_overrides: Optional[PartnerCentralAccountClientConfig] = None,
) -> GetConnectionResponse

Retrieves detailed information about a specific connection between partners.

Parameters:

  • catalog (Catalog) –

    The catalog identifier where the connection exists.

  • identifier (ConnectionId) –

    The unique identifier of the connection to retrieve.

Raises:

  • AccessDeniedException –

    The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.

  • InternalServerException –

    An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.

  • ResourceNotFoundException –

    The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.

  • ThrottlingException –

    The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.

  • ValidationException –

    The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_partnercentral_account/_services/partner_central_account.py
def get_connection(
    self,
    catalog: "capo_partnercentral_account.types.catalog.Catalog",
    identifier: "capo_partnercentral_account.types.connection_id.ConnectionId",
    *,
    config_overrides: Optional[PartnerCentralAccountClientConfig] = None,
) -> "capo_partnercentral_account.types.get_connection_response.GetConnectionResponse":
    """<p>Retrieves detailed information about a specific connection between partners.</p>

    Args:
        catalog: <p>The catalog identifier where the connection exists.</p>
        identifier: <p>The unique identifier of the connection to retrieve.</p>

    Raises:
        capo_partnercentral_account.errors.access_denied_exception.AccessDeniedException: <p>The request was denied due to insufficient permissions. The caller does not have the required permissions to perform this operation.</p>
        capo_partnercentral_account.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred while processing the request. This is typically a temporary condition and the request may be retried.</p>
        capo_partnercentral_account.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource could not be found. This may occur when referencing a resource that does not exist or has been deleted.</p>
        capo_partnercentral_account.errors.throttling_exception.ThrottlingException: <p>The request was throttled due to too many requests being sent in a short period of time. The client should implement exponential backoff and retry the request.</p>
        capo_partnercentral_account.errors.validation_exception.ValidationException: <p>The request failed validation. One or more input parameters are invalid, missing, or do not meet the required format or constraints.</p>
        capo_partnercentral_account.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_partnercentral_account.types.get_connection_request.GetConnectionRequest]",
    ) -> OperationResponse[
        "capo_partnercentral_account.types.get_connection_response.GetConnectionResponse"
    ]:
        import capo_partnercentral_account._operations.partner_central_account.get_connection

        output, http_response = (
            capo_partnercentral_account._operations.partner_central_account.get_connection.get_connection(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_partnercentral_account.types.get_connection_response.GetConnectionResponse",
    ) -> dict[str, Any]:
        import capo_partnercentral_account.types.get_connection_response

        return capo_partnercentral_account.types.get_connection_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetConnection", redact_output=_redact_output),
    )
    input_: capo_partnercentral_account.types.get_connection_request.GetConnectionRequest = {
        "catalog": catalog,
        "identifier": identifier,
    }

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