describe_lags `async` ¶

describe_lags(
    *,
    config_overrides: Optional[AsyncDirectConnectClientConfig] = None,
    lag_id: Optional[LagId] = None,
    max_results: Optional[MaxResultSetSize] = None,
    next_token: Optional[PaginationToken] = None,
) -> Lags

Describes all your link aggregation groups (LAG) or the specified LAG.

Parameters:

lag_id (Optional[LagId], default: None ) –

The ID of the LAG.
max_results (Optional[MaxResultSetSize], default: None ) –

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.
next_token (Optional[PaginationToken], default: None ) –

The token for the next page of results.

Raises:

DirectConnectClientException –

One or more parameters are not valid.
DirectConnectServerException –

A server-side error occurred.
UnknownServiceError –

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

Source code in docs_src/capo_direct_connect/_services/async_direct_connect.py

async def describe_lags(
    self,
    *,
    config_overrides: Optional[AsyncDirectConnectClientConfig] = None,
    lag_id: Optional["capo_direct_connect.types.lag_id.LagId"] = None,
    max_results: Optional[
        "capo_direct_connect.types.max_result_set_size.MaxResultSetSize"
    ] = None,
    next_token: Optional[
        "capo_direct_connect.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_direct_connect.types.lags.Lags":
    """<p>Describes all your link aggregation groups (LAG) or the specified LAG.</p>

    Args:
        lag_id: <p>The ID of the LAG.</p>
        max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p> <p>If <code>MaxResults</code> is given a value larger than 100, only 100 results are returned.</p>
        next_token: <p>The token for the next page of results.</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.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_direct_connect.types.describe_lags_request.DescribeLagsRequest]",
    ) -> AsyncOperationResponse["capo_direct_connect.types.lags.Lags"]:
        import capo_direct_connect._operations.overture_service.describe_lags

        (
            output,
            http_response,
        ) = await capo_direct_connect._operations.overture_service.describe_lags.async_describe_lags(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeLags")
    )
    input_: capo_direct_connect.types.describe_lags_request.DescribeLagsRequest = {}
    if lag_id is not None:
        input_["lag_id"] = lag_id
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_lags async ¶

describe_lags `async` ¶