Skip to content

describe_transit_gateway_route_table_announcements

describe_transit_gateway_route_table_announcements(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    transit_gateway_route_table_announcement_ids: Optional[
        TransitGatewayRouteTableAnnouncementIdStringList
    ] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[TransitGatewayMaxResults] = None,
    next_token: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
) -> DescribeTransitGatewayRouteTableAnnouncementsResult

Describes one or more transit gateway route table advertisements.

Parameters:

  • transit_gateway_route_table_announcement_ids (Optional[TransitGatewayRouteTableAnnouncementIdStringList], default: None ) –

    The IDs of the transit gateway route tables that are being advertised.

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

    The filters associated with the transit gateway policy table.

  • 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 describe_transit_gateway_route_table_announcements(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    transit_gateway_route_table_announcement_ids: Optional[
        "capo_ec2.types.transit_gateway_route_table_announcement_id_string_list.TransitGatewayRouteTableAnnouncementIdStringList"
    ] = 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.describe_transit_gateway_route_table_announcements_result.DescribeTransitGatewayRouteTableAnnouncementsResult":
    """<p>Describes one or more transit gateway route table advertisements.</p>

    Args:
        transit_gateway_route_table_announcement_ids: <p>The IDs of the transit gateway route tables that are being advertised.</p>
        filters: <p>The filters associated with the transit gateway policy table.</p>
        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_transit_gateway_route_table_announcements_request.DescribeTransitGatewayRouteTableAnnouncementsRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_transit_gateway_route_table_announcements_result.DescribeTransitGatewayRouteTableAnnouncementsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_transit_gateway_route_table_announcements

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

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeTransitGatewayRouteTableAnnouncements"),
    )
    input_: capo_ec2.types.describe_transit_gateway_route_table_announcements_request.DescribeTransitGatewayRouteTableAnnouncementsRequest = {}
    if transit_gateway_route_table_announcement_ids is not None:
        input_["transit_gateway_route_table_announcement_ids"] = (
            transit_gateway_route_table_announcement_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