Skip to content

describe_service_link_virtual_interfaces

describe_service_link_virtual_interfaces(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    service_link_virtual_interface_ids: Optional[
        ServiceLinkVirtualInterfaceIdSet
    ] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[ServiceLinkMaxResults] = None,
    next_token: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
) -> DescribeServiceLinkVirtualInterfacesResult

Describes the Outpost service link virtual interfaces.

Parameters:

  • service_link_virtual_interface_ids (Optional[ServiceLinkVirtualInterfaceIdSet], default: None ) –

    The IDs of the service link virtual interfaces.

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

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

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

    • outpost-arn - The Outpost ARN.

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

    • state - The state of the Outpost LAG.

    • vlan - The ID of the address pool.

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

    • local-gateway-virtual-interface-id - The ID of the local gateway virtual interface.

  • max_results (Optional[ServiceLinkMaxResults], 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_service_link_virtual_interfaces(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    service_link_virtual_interface_ids: Optional[
        "capo_ec2.types.service_link_virtual_interface_id_set.ServiceLinkVirtualInterfaceIdSet"
    ] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional[
        "capo_ec2.types.service_link_max_results.ServiceLinkMaxResults"
    ] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.describe_service_link_virtual_interfaces_result.DescribeServiceLinkVirtualInterfacesResult":
    """<p>Describes the Outpost service link virtual interfaces.</p>

    Args:
        service_link_virtual_interface_ids: <p>The IDs of the service link virtual interfaces.</p>
        filters: <p>The filters to use for narrowing down the request. The following filters are supported:</p> <ul> <li> <p> <code>outpost-lag-id</code> - The ID of the Outpost LAG.</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>state</code> - The state of the Outpost LAG.</p> </li> <li> <p> <code>vlan</code> - The ID of the address pool.</p> </li> <li> <p> <code>service-link-virtual-interface-id</code> - The ID of the service link virtual interface.</p> </li> <li> <p> <code>local-gateway-virtual-interface-id</code> - The ID of the local gateway 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_service_link_virtual_interfaces_request.DescribeServiceLinkVirtualInterfacesRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_service_link_virtual_interfaces_result.DescribeServiceLinkVirtualInterfacesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_service_link_virtual_interfaces

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeServiceLinkVirtualInterfaces")
    )
    input_: capo_ec2.types.describe_service_link_virtual_interfaces_request.DescribeServiceLinkVirtualInterfacesRequest = {}
    if service_link_virtual_interface_ids is not None:
        input_["service_link_virtual_interface_ids"] = (
            service_link_virtual_interface_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