Skip to content

create_private_connection

create_private_connection(
    private_connection_name: PrivateConnectionName,
    mode: PrivateConnectionMode,
    *,
    config_overrides: Optional[SecurityAgentClientConfig] = None,
    tags: Optional[TagMap] = None,
) -> CreatePrivateConnectionOutput

Creates a private connection for reaching a self-hosted provider instance over private networking using Amazon VPC Lattice.

Parameters:

  • private_connection_name (PrivateConnectionName) –

    A unique name for the private connection within your account.

  • mode (PrivateConnectionMode) –

    The configuration for the private connection. Specify either a service-managed or a self-managed mode.

  • tags (Optional[TagMap], default: None ) –

    The tags to attach to the private connection.

Raises:

  • AccessDeniedException –

    You do not have sufficient access to perform this action.

  • ConflictException –

    The request could not be completed due to a conflict with the current state of the resource.

  • InternalServerException –

    An unexpected error occurred during the processing of your request.

  • ResourceNotFoundException –

    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.

  • ThrottlingException –

    The request was denied due to request throttling.

  • ValidationException –

    The input fails to satisfy the constraints specified by the service.

  • UnknownServiceError –

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

Source code in docs_src/capo_securityagent/_services/security_agent.py
def create_private_connection(
    self,
    private_connection_name: "capo_securityagent.types.private_connection_name.PrivateConnectionName",
    mode: "capo_securityagent.types.private_connection_mode.PrivateConnectionMode",
    *,
    config_overrides: Optional[SecurityAgentClientConfig] = None,
    tags: Optional["capo_securityagent.types.tag_map.TagMap"] = None,
) -> "capo_securityagent.types.create_private_connection_output.CreatePrivateConnectionOutput":
    """<p>Creates a private connection for reaching a self-hosted provider instance over private networking using Amazon VPC Lattice.</p>

    Args:
        private_connection_name: <p>A unique name for the private connection within your account.</p>
        mode: <p>The configuration for the private connection. Specify either a service-managed or a self-managed mode.</p>
        tags: <p>The tags to attach to the private connection.</p>

    Raises:
        capo_securityagent.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_securityagent.errors.conflict_exception.ConflictException: <p>The request could not be completed due to a conflict with the current state of the resource.</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.create_private_connection_input.CreatePrivateConnectionInput]",
    ) -> OperationResponse[
        "capo_securityagent.types.create_private_connection_output.CreatePrivateConnectionOutput"
    ]:
        import capo_securityagent._operations.security_agent.create_private_connection

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

    def _redact_input(
        input_: "capo_securityagent.types.create_private_connection_input.CreatePrivateConnectionInput",
    ) -> dict[str, Any]:
        import capo_securityagent.types.create_private_connection_input

        return capo_securityagent.types.create_private_connection_input.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreatePrivateConnection", redact_input=_redact_input),
    )
    input_: capo_securityagent.types.create_private_connection_input.CreatePrivateConnectionInput = {
        "private_connection_name": private_connection_name,
        "mode": mode,
    }
    if tags is not None:
        input_["tags"] = tags

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