get_transit_gateway_prefix_list_references¶
Operation¶
get_transit_gateway_prefix_list_references
¶
get_transit_gateway_prefix_list_references(request: GetTransitGatewayPrefixListReferencesInput | GetTransitGatewayPrefixListReferencesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetTransitGatewayPrefixListReferencesInputDict]) -> GetTransitGatewayPrefixListReferencesOutput
Gets information about the prefix list references in a specified transit gateway route table.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetTransitGatewayPrefixListReferencesInput | GetTransitGatewayPrefixListReferencesInputDict | 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[GetTransitGatewayPrefixListReferencesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetTransitGatewayPrefixListReferencesOutput
|
An instance of |
get_transit_gateway_prefix_list_references
async
¶
get_transit_gateway_prefix_list_references(request: GetTransitGatewayPrefixListReferencesInput | GetTransitGatewayPrefixListReferencesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetTransitGatewayPrefixListReferencesInputDict]) -> GetTransitGatewayPrefixListReferencesOutput
Gets information about the prefix list references in a specified transit gateway route table.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetTransitGatewayPrefixListReferencesInput | GetTransitGatewayPrefixListReferencesInputDict | 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[GetTransitGatewayPrefixListReferencesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetTransitGatewayPrefixListReferencesOutput
|
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.
GetTransitGatewayPrefixListReferencesInputDict
¶
Bases: TypedDict
Dictionary form of GetTransitGatewayPrefixListReferencesInput.
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
One or more filters. The possible values are:
-
attachment.resource-id- The ID of the resource for the attachment. -
attachment.resource-type- The type of resource for the attachment. Valid values arevpc|vpn|direct-connect-gateway|peering. -
attachment.transit-gateway-attachment-id- The ID of the attachment. -
is-blackhole- Whether traffic matching the route is blocked (true|false). -
prefix-list-id- The ID of the prefix list. -
prefix-list-owner-id- The ID of the owner of the prefix list. -
state- The state of the prefix list reference (pending|available|modifying|deleting).
GetTransitGatewayPrefixListReferencesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetTransitGatewayPrefixListReferencesInput 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
¶
One or more filters. The possible values are:
-
attachment.resource-id- The ID of the resource for the attachment. -
attachment.resource-type- The type of resource for the attachment. Valid values arevpc|vpn|direct-connect-gateway|peering. -
attachment.transit-gateway-attachment-id- The ID of the attachment. -
is-blackhole- Whether traffic matching the route is blocked (true|false). -
prefix-list-id- The ID of the prefix list. -
prefix-list-owner-id- The ID of the owner of the prefix list. -
state- The state of the prefix list reference (pending|available|modifying|deleting).
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¶
GetTransitGatewayPrefixListReferencesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetTransitGatewayPrefixListReferencesOutput 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.
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.
transit_gateway_prefix_list_references
class-attribute
instance-attribute
¶
transit_gateway_prefix_list_references: list[TransitGatewayPrefixListReference] | None = ...
Information about the prefix list references.