describe_outpost_lags¶
Operation¶
describe_outpost_lags
¶
describe_outpost_lags(request: DescribeOutpostLagsInput | DescribeOutpostLagsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeOutpostLagsInputDict]) -> DescribeOutpostLagsOutput
Describes the Outposts link aggregation groups (LAGs).
Note
LAGs are only available for second-generation Outposts racks at this time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeOutpostLagsInput | DescribeOutpostLagsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DescribeOutpostLagsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeOutpostLagsOutput
|
An instance of |
describe_outpost_lags
async
¶
describe_outpost_lags(request: DescribeOutpostLagsInput | DescribeOutpostLagsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeOutpostLagsInputDict]) -> DescribeOutpostLagsOutput
Describes the Outposts link aggregation groups (LAGs).
Note
LAGs are only available for second-generation Outposts racks at this time.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DescribeOutpostLagsInput | DescribeOutpostLagsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DescribeOutpostLagsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeOutpostLagsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DescribeOutpostLagsInputDict
¶
Bases: TypedDict
Dictionary form of DescribeOutpostLagsInput.
Attributes¶
dry_run
instance-attribute
¶
dry_run: bool | 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.
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | 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.
DescribeOutpostLagsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeOutpostLagsInput structure.
Attributes¶
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | 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.
filters
class-attribute
instance-attribute
¶
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
class-attribute
instance-attribute
¶
max_results: int | 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.
Output¶
DescribeOutpostLagsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeOutpostLagsOutput structure.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
outpost_lags
class-attribute
instance-attribute
¶
outpost_lags: list[OutpostLag] | None = ...
The Outpost LAGs.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.