Skip to content

describe_outpost_lags

describe_outpost_lags(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    outpost_lag_ids: Optional[OutpostLagIdSet] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[OutpostLagMaxResults] = None,
    next_token: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
) -> DescribeOutpostLagsResult

Describes the Outposts link aggregation groups (LAGs).

LAGs are only available for second-generation Outposts racks at this time.

Parameters:

  • outpost_lag_ids (Optional[OutpostLagIdSet], default: None ) –

    The IDs of the Outpost LAGs.

  • filters (Optional[FilterList], default: None ) –

    The filters to use for narrowing down the request. The following filters are supported:

    • service-link-virtual-interface-id - The ID of the service link virtual interface.

    • service-link-virtual-interface-arn - The ARN of the service link virtual interface.

    • outpost-id - The Outpost ID.

    • outpost-arn - The Outpost ARN.

    • owner-id - The ID of the Amazon Web Services account that owns the service link virtual interface.

    • vlan - The ID of the address pool.

    • local-address - The local address.

    • peer-address - The peer address.

    • peer-bgp-asn - The peer BGP ASN.

    • outpost-lag-id - The Outpost LAG ID.

    • configuration-state - The configuration state of the service link virtual interface.

  • max_results (Optional[OutpostLagMaxResults], 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.

  • next_token (Optional[String], default: None ) –

    The token for the next page of results.

  • dry_run (Optional[Boolean], default: None ) –

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def describe_outpost_lags(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    outpost_lag_ids: Optional[
        "capo_ec2.types.outpost_lag_id_set.OutpostLagIdSet"
    ] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional[
        "capo_ec2.types.outpost_lag_max_results.OutpostLagMaxResults"
    ] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.describe_outpost_lags_result.DescribeOutpostLagsResult":
    """<p>Describes the Outposts link aggregation groups (LAGs).</p> <note> <p>LAGs are only available for second-generation Outposts racks at this time.</p> </note>

    Args:
        outpost_lag_ids: <p>The IDs of the Outpost LAGs.</p>
        filters: <p>The filters to use for narrowing down the request. The following filters are supported:</p> <ul> <li> <p> <code>service-link-virtual-interface-id</code> - The ID of the service link virtual interface.</p> </li> <li> <p> <code>service-link-virtual-interface-arn</code> - The ARN of the service link virtual interface.</p> </li> <li> <p> <code>outpost-id</code> - The Outpost ID.</p> </li> <li> <p> <code>outpost-arn</code> - The Outpost ARN.</p> </li> <li> <p> <code>owner-id</code> - The ID of the Amazon Web Services account that owns the service link virtual interface.</p> </li> <li> <p> <code>vlan</code> - The ID of the address pool.</p> </li> <li> <p> <code>local-address</code> - The local address.</p> </li> <li> <p> <code>peer-address</code> - The peer address.</p> </li> <li> <p> <code>peer-bgp-asn</code> - The peer BGP ASN.</p> </li> <li> <p> <code>outpost-lag-id</code> - The Outpost LAG ID.</p> </li> <li> <p> <code>configuration-state</code> - The configuration state of the service link virtual interface.</p> </li> </ul>
        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>
        next_token: <p>The token for the next page of results.</p>
        dry_run: <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_outpost_lags_request.DescribeOutpostLagsRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_outpost_lags_result.DescribeOutpostLagsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_outpost_lags

        output, http_response = (
            capo_ec2._operations.amazon_ec2.describe_outpost_lags.describe_outpost_lags(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeOutpostLags")
    )
    input_: capo_ec2.types.describe_outpost_lags_request.DescribeOutpostLagsRequest = {}
    if outpost_lag_ids is not None:
        input_["outpost_lag_ids"] = outpost_lag_ids
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if dry_run is not None:
        input_["dry_run"] = dry_run

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