Skip to content

describe_connection_proposal

describe_connection_proposal(
    activation_key: ActivationKey,
    *,
    config_overrides: Optional[InterconnectClientConfig] = None,
) -> DescribeConnectionProposalResponse

Describes the details of a connection proposal generated at a partner's portal.

Parameters:

  • activation_key (ActivationKey) –

    An Activation Key that was generated on a supported partner's portal. This key captures the desired parameters from the initial creation request.

Raises:

Examples:

Describe Connection Proposal

>>> client.describe_connection_proposal(activation_key='<Activation Key Data>')
Source code in docs_src/capo_interconnect/_services/interconnect.py
def describe_connection_proposal(
    self,
    activation_key: "capo_interconnect.types.activation_key.ActivationKey",
    *,
    config_overrides: Optional[InterconnectClientConfig] = None,
) -> "capo_interconnect.types.describe_connection_proposal_response.DescribeConnectionProposalResponse":
    """<p>Describes the details of a connection proposal generated at a partner's portal.</p>

    Args:
        activation_key: <p>An Activation Key that was generated on a supported partner's portal. This key captures the desired parameters from the initial creation request.</p>

    Raises:
        capo_interconnect.errors.access_denied_exception.AccessDeniedException: <p>The calling principal is not allowed to access the specified resource, or the resource does not exist.</p>
        capo_interconnect.errors.interconnect_client_exception.InterconnectClientException: <p>The request was denied due to incorrect client supplied parameters.</p>
        capo_interconnect.errors.interconnect_server_exception.InterconnectServerException: <p>The request resulted in an exception internal to the service.</p>
        capo_interconnect.errors.interconnect_validation_exception.InterconnectValidationException: <p>The input fails to satisfy the constraints specified.</p>
        capo_interconnect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request specifies a resource that does not exist on the server.</p>
        capo_interconnect.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The requested operation would result in the calling principal exceeding their allotted quota.</p>
        capo_interconnect.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_interconnect.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Describe Connection Proposal

        >>> client.describe_connection_proposal(activation_key='<Activation Key Data>')
    """

    def _handler(
        req: "OperationRequest[capo_interconnect.types.describe_connection_proposal_request.DescribeConnectionProposalRequest]",
    ) -> OperationResponse[
        "capo_interconnect.types.describe_connection_proposal_response.DescribeConnectionProposalResponse"
    ]:
        import capo_interconnect._operations.interconnect.describe_connection_proposal

        output, http_response = (
            capo_interconnect._operations.interconnect.describe_connection_proposal.describe_connection_proposal(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_interconnect.types.describe_connection_proposal_request.DescribeConnectionProposalRequest",
    ) -> dict[str, Any]:
        import capo_interconnect.types.describe_connection_proposal_request

        return capo_interconnect.types.describe_connection_proposal_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeConnectionProposal", redact_input=_redact_input),
    )
    input_: capo_interconnect.types.describe_connection_proposal_request.DescribeConnectionProposalRequest = {
        "activation_key": activation_key
    }

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