Skip to content

get_transit_gateway_prefix_list_references async

get_transit_gateway_prefix_list_references(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    transit_gateway_route_table_id: Optional[TransitGatewayRouteTableId] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[TransitGatewayMaxResults] = None,
    next_token: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
) -> GetTransitGatewayPrefixListReferencesResult

Gets information about the prefix list references in a specified transit gateway route table.

Parameters:

  • transit_gateway_route_table_id (Optional[TransitGatewayRouteTableId], default: None ) –

    The ID of the transit gateway route table.

  • filters (Optional[FilterList], default: 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 are vpc | 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 (Optional[TransitGatewayMaxResults], 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/async_ec2.py
async def get_transit_gateway_prefix_list_references(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    transit_gateway_route_table_id: Optional[
        "capo_ec2.types.transit_gateway_route_table_id.TransitGatewayRouteTableId"
    ] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional[
        "capo_ec2.types.transit_gateway_max_results.TransitGatewayMaxResults"
    ] = None,
    next_token: Optional["capo_ec2.types.string.String"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.get_transit_gateway_prefix_list_references_result.GetTransitGatewayPrefixListReferencesResult":
    """<p>Gets information about the prefix list references in a specified transit gateway route table.</p>

    Args:
        transit_gateway_route_table_id: <p>The ID of the transit gateway route table.</p>
        filters: <p>One or more filters. The possible values are:</p> <ul> <li> <p> <code>attachment.resource-id</code> - The ID of the resource for the attachment.</p> </li> <li> <p> <code>attachment.resource-type</code> - The type of resource for the attachment. Valid values are <code>vpc</code> | <code>vpn</code> | <code>direct-connect-gateway</code> | <code>peering</code>.</p> </li> <li> <p> <code>attachment.transit-gateway-attachment-id</code> - The ID of the attachment.</p> </li> <li> <p> <code>is-blackhole</code> - Whether traffic matching the route is blocked (<code>true</code> | <code>false</code>).</p> </li> <li> <p> <code>prefix-list-id</code> - The ID of the prefix list.</p> </li> <li> <p> <code>prefix-list-owner-id</code> - The ID of the owner of the prefix list.</p> </li> <li> <p> <code>state</code> - The state of the prefix list reference (<code>pending</code> | <code>available</code> | <code>modifying</code> | <code>deleting</code>).</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.get_transit_gateway_prefix_list_references_request.GetTransitGatewayPrefixListReferencesRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.get_transit_gateway_prefix_list_references_result.GetTransitGatewayPrefixListReferencesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.get_transit_gateway_prefix_list_references

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.get_transit_gateway_prefix_list_references.async_get_transit_gateway_prefix_list_references(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetTransitGatewayPrefixListReferences")
    )
    input_: capo_ec2.types.get_transit_gateway_prefix_list_references_request.GetTransitGatewayPrefixListReferencesRequest = {}
    if transit_gateway_route_table_id is not None:
        input_["transit_gateway_route_table_id"] = transit_gateway_route_table_id
    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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output