Skip to content

describe_private_connection

describe_private_connection(
    private_connection_name: PrivateConnectionName,
    *,
    config_overrides: Optional[SecurityAgentClientConfig] = None,
) -> DescribePrivateConnectionOutput

Retrieves the details of a private connection.

Parameters:

Raises:

Source code in docs_src/capo_securityagent/_services/security_agent.py
def describe_private_connection(
    self,
    private_connection_name: "capo_securityagent.types.private_connection_name.PrivateConnectionName",
    *,
    config_overrides: Optional[SecurityAgentClientConfig] = None,
) -> "capo_securityagent.types.describe_private_connection_output.DescribePrivateConnectionOutput":
    """<p>Retrieves the details of a private connection.</p>

    Args:
        private_connection_name: <p>The name of the private connection to describe.</p>

    Raises:
        capo_securityagent.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_securityagent.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred during the processing of your request.</p>
        capo_securityagent.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found. Verify that the resource identifier is correct and that the resource exists in the specified agent space or account.</p>
        capo_securityagent.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_securityagent.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
        capo_securityagent.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_securityagent.types.describe_private_connection_input.DescribePrivateConnectionInput]",
    ) -> OperationResponse[
        "capo_securityagent.types.describe_private_connection_output.DescribePrivateConnectionOutput"
    ]:
        import capo_securityagent._operations.security_agent.describe_private_connection

        output, http_response = (
            capo_securityagent._operations.security_agent.describe_private_connection.describe_private_connection(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribePrivateConnection")
    )
    input_: capo_securityagent.types.describe_private_connection_input.DescribePrivateConnectionInput = {
        "private_connection_name": private_connection_name
    }

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