Skip to content

associate_connections_to_resiliency_group

associate_connections_to_resiliency_group(
    connection_identifiers: ConnectionIdentifierList,
    resiliency_group_id: ResiliencyGroupId,
    *,
    config_overrides: Optional[DirectConnectClientConfig] = None,
    client_token: Optional[IdempotencyToken] = None,
) -> AssociateConnectionsToResiliencyGroupResult

Associates one or more connections with the specified resiliency group. This operation is atomic: either all of the specified connections are associated, or the operation fails and no changes are made.

Parameters:

  • connection_identifiers (ConnectionIdentifierList) –

    The IDs or ARNs of the connections to associate with the resiliency group.

  • resiliency_group_id (ResiliencyGroupId) –

    The ID of the resiliency group.

  • client_token (Optional[IdempotencyToken], default: None ) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Raises:

Source code in docs_src/capo_direct_connect/_services/direct_connect.py
def associate_connections_to_resiliency_group(
    self,
    connection_identifiers: "capo_direct_connect.types.connection_identifier_list.ConnectionIdentifierList",
    resiliency_group_id: "capo_direct_connect.types.resiliency_group_id.ResiliencyGroupId",
    *,
    config_overrides: Optional[DirectConnectClientConfig] = None,
    client_token: Optional[
        "capo_direct_connect.types.idempotency_token.IdempotencyToken"
    ] = None,
) -> "capo_direct_connect.types.associate_connections_to_resiliency_group_result.AssociateConnectionsToResiliencyGroupResult":
    """<p>Associates one or more connections with the specified resiliency group. This operation is atomic: either all of the specified connections are associated, or the operation fails and no changes are made.</p>

    Args:
        connection_identifiers: <p>The IDs or ARNs of the connections to associate with the resiliency group.</p>
        resiliency_group_id: <p>The ID of the resiliency group.</p>
        client_token: <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>

    Raises:
        capo_direct_connect.errors.direct_connect_client_exception.DirectConnectClientException: <p>One or more parameters are not valid.</p>
        capo_direct_connect.errors.direct_connect_server_exception.DirectConnectServerException: <p>A server-side error occurred.</p>
        capo_direct_connect.errors.limit_exceeded_exception.LimitExceededException: <p>The rate limiter limit has been exceeded for the connection. You cannot add more rate limiters to virtual interfaces on this connection.</p>
        capo_direct_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_direct_connect.types.associate_connections_to_resiliency_group_request.AssociateConnectionsToResiliencyGroupRequest]",
    ) -> OperationResponse[
        "capo_direct_connect.types.associate_connections_to_resiliency_group_result.AssociateConnectionsToResiliencyGroupResult"
    ]:
        import capo_direct_connect._operations.overture_service.associate_connections_to_resiliency_group

        output, http_response = (
            capo_direct_connect._operations.overture_service.associate_connections_to_resiliency_group.associate_connections_to_resiliency_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AssociateConnectionsToResiliencyGroup")
    )
    input_: capo_direct_connect.types.associate_connections_to_resiliency_group_request.AssociateConnectionsToResiliencyGroupRequest = {
        "connection_identifiers": connection_identifiers,
        "resiliency_group_id": resiliency_group_id,
    }
    if client_token is not None:
        input_["client_token"] = client_token

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