Skip to content

get_transit_gateway_policy_table_entries

get_transit_gateway_policy_table_entries(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    transit_gateway_policy_table_id: Optional[TransitGatewayPolicyTableId] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[TransitGatewayMaxResults] = None,
    next_token: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
) -> GetTransitGatewayPolicyTableEntriesResult

Returns a list of transit gateway policy table entries.

Parameters:

  • transit_gateway_policy_table_id (Optional[TransitGatewayPolicyTableId], default: None ) –

    The ID of the transit gateway policy table.

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

    One or more filters. The possible values are:

    • policy-rule-number - The rule number for the transit gateway policy table entry.

    • target-route-table-id - The ID of the target route table.

    • policy-rule.source-ip - The source CIDR block for the policy rule.

    • policy-rule.destination-ip - The destination CIDR block for the policy rule.

    • policy-rule.source-port - The source port or port range for the policy rule.

    • policy-rule.destination-port - The destination port or port range for the policy rule.

    • policy-rule.protocol - The protocol for the policy rule.

    • policy-rule.meta-data.key - The metadata key for the policy rule.

    • policy-rule.meta-data.value - The metadata value for the policy rule.

  • 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/ec2.py
def get_transit_gateway_policy_table_entries(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    transit_gateway_policy_table_id: Optional[
        "capo_ec2.types.transit_gateway_policy_table_id.TransitGatewayPolicyTableId"
    ] = 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_policy_table_entries_result.GetTransitGatewayPolicyTableEntriesResult":
    """<p>Returns a list of transit gateway policy table entries.</p>

    Args:
        transit_gateway_policy_table_id: <p>The ID of the transit gateway policy table.</p>
        filters: <p>One or more filters. The possible values are:</p> <ul> <li> <p> <code>policy-rule-number</code> - The rule number for the transit gateway policy table entry.</p> </li> <li> <p> <code>target-route-table-id</code> - The ID of the target route table.</p> </li> <li> <p> <code>policy-rule.source-ip</code> - The source CIDR block for the policy rule.</p> </li> <li> <p> <code>policy-rule.destination-ip</code> - The destination CIDR block for the policy rule.</p> </li> <li> <p> <code>policy-rule.source-port</code> - The source port or port range for the policy rule.</p> </li> <li> <p> <code>policy-rule.destination-port</code> - The destination port or port range for the policy rule.</p> </li> <li> <p> <code>policy-rule.protocol</code> - The protocol for the policy rule.</p> </li> <li> <p> <code>policy-rule.meta-data.key</code> - The metadata key for the policy rule.</p> </li> <li> <p> <code>policy-rule.meta-data.value</code> - The metadata value for the policy rule.</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.get_transit_gateway_policy_table_entries_request.GetTransitGatewayPolicyTableEntriesRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.get_transit_gateway_policy_table_entries_result.GetTransitGatewayPolicyTableEntriesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.get_transit_gateway_policy_table_entries

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetTransitGatewayPolicyTableEntries")
    )
    input_: capo_ec2.types.get_transit_gateway_policy_table_entries_request.GetTransitGatewayPolicyTableEntriesRequest = {}
    if transit_gateway_policy_table_id is not None:
        input_["transit_gateway_policy_table_id"] = transit_gateway_policy_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 = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output