Skip to content

describe_transit_gateway_peering_attachments

describe_transit_gateway_peering_attachments(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    transit_gateway_attachment_ids: Optional[
        TransitGatewayAttachmentIdStringList
    ] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[TransitGatewayMaxResults] = None,
    next_token: Optional[String] = None,
    dry_run: Optional[Boolean] = None,
) -> DescribeTransitGatewayPeeringAttachmentsResult

Describes your transit gateway peering attachments.

Parameters:

  • transit_gateway_attachment_ids (Optional[TransitGatewayAttachmentIdStringList], default: None ) –

    One or more IDs of the transit gateway peering attachments.

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

    One or more filters. The possible values are:

    • transit-gateway-attachment-id - The ID of the transit gateway attachment.

    • local-owner-id - The ID of your Amazon Web Services account.

    • remote-owner-id - The ID of the Amazon Web Services account in the remote Region that owns the transit gateway.

    • state - The state of the peering attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).

    • tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

    • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

    • transit-gateway-id - The ID of the transit gateway.

  • 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_peering_attachments(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    transit_gateway_attachment_ids: Optional[
        "capo_ec2.types.transit_gateway_attachment_id_string_list.TransitGatewayAttachmentIdStringList"
    ] = 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_peering_attachments_result.DescribeTransitGatewayPeeringAttachmentsResult":
    """<p>Describes your transit gateway peering attachments.</p>

    Args:
        transit_gateway_attachment_ids: <p>One or more IDs of the transit gateway peering attachments.</p>
        filters: <p>One or more filters. The possible values are:</p> <ul> <li> <p> <code>transit-gateway-attachment-id</code> - The ID of the transit gateway attachment.</p> </li> <li> <p> <code>local-owner-id</code> - The ID of your Amazon Web Services account.</p> </li> <li> <p> <code>remote-owner-id</code> - The ID of the Amazon Web Services account in the remote Region that owns the transit gateway.</p> </li> <li> <p> <code>state</code> - The state of the peering attachment. Valid values are <code>available</code> | <code>deleted</code> | <code>deleting</code> | <code>failed</code> | <code>failing</code> | <code>initiatingRequest</code> | <code>modifying</code> | <code>pendingAcceptance</code> | <code>pending</code> | <code>rollingBack</code> | <code>rejected</code> | <code>rejecting</code>).</p> </li> <li> <p> <code>tag</code>:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code> - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.</p> </li> <li> <p> <code>transit-gateway-id</code> - The ID of the transit gateway.</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.describe_transit_gateway_peering_attachments_request.DescribeTransitGatewayPeeringAttachmentsRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_transit_gateway_peering_attachments_result.DescribeTransitGatewayPeeringAttachmentsResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_transit_gateway_peering_attachments

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

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeTransitGatewayPeeringAttachments"),
    )
    input_: capo_ec2.types.describe_transit_gateway_peering_attachments_request.DescribeTransitGatewayPeeringAttachmentsRequest = {}
    if transit_gateway_attachment_ids is not None:
        input_["transit_gateway_attachment_ids"] = transit_gateway_attachment_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