aws_sdk_networkmanager/client/
get_network_resource_relationships.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetNetworkResourceRelationships`](crate::operation::get_network_resource_relationships::builders::GetNetworkResourceRelationshipsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_network_resource_relationships::builders::GetNetworkResourceRelationshipsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`global_network_id(impl Into<String>)`](crate::operation::get_network_resource_relationships::builders::GetNetworkResourceRelationshipsFluentBuilder::global_network_id) / [`set_global_network_id(Option<String>)`](crate::operation::get_network_resource_relationships::builders::GetNetworkResourceRelationshipsFluentBuilder::set_global_network_id):<br>required: **true**<br><p>The ID of the global network.</p><br>
8    ///   - [`core_network_id(impl Into<String>)`](crate::operation::get_network_resource_relationships::builders::GetNetworkResourceRelationshipsFluentBuilder::core_network_id) / [`set_core_network_id(Option<String>)`](crate::operation::get_network_resource_relationships::builders::GetNetworkResourceRelationshipsFluentBuilder::set_core_network_id):<br>required: **false**<br><p>The ID of a core network.</p><br>
9    ///   - [`registered_gateway_arn(impl Into<String>)`](crate::operation::get_network_resource_relationships::builders::GetNetworkResourceRelationshipsFluentBuilder::registered_gateway_arn) / [`set_registered_gateway_arn(Option<String>)`](crate::operation::get_network_resource_relationships::builders::GetNetworkResourceRelationshipsFluentBuilder::set_registered_gateway_arn):<br>required: **false**<br><p>The ARN of the registered gateway.</p><br>
10    ///   - [`aws_region(impl Into<String>)`](crate::operation::get_network_resource_relationships::builders::GetNetworkResourceRelationshipsFluentBuilder::aws_region) / [`set_aws_region(Option<String>)`](crate::operation::get_network_resource_relationships::builders::GetNetworkResourceRelationshipsFluentBuilder::set_aws_region):<br>required: **false**<br><p>The Amazon Web Services Region.</p><br>
11    ///   - [`account_id(impl Into<String>)`](crate::operation::get_network_resource_relationships::builders::GetNetworkResourceRelationshipsFluentBuilder::account_id) / [`set_account_id(Option<String>)`](crate::operation::get_network_resource_relationships::builders::GetNetworkResourceRelationshipsFluentBuilder::set_account_id):<br>required: **false**<br><p>The Amazon Web Services account ID.</p><br>
12    ///   - [`resource_type(impl Into<String>)`](crate::operation::get_network_resource_relationships::builders::GetNetworkResourceRelationshipsFluentBuilder::resource_type) / [`set_resource_type(Option<String>)`](crate::operation::get_network_resource_relationships::builders::GetNetworkResourceRelationshipsFluentBuilder::set_resource_type):<br>required: **false**<br><p>The resource type.</p> <p>The following are the supported resource types for Direct Connect:</p> <ul>  <li>   <p><code>dxcon</code></p></li>  <li>   <p><code>dx-gateway</code></p></li>  <li>   <p><code>dx-vif</code></p></li> </ul> <p>The following are the supported resource types for Network Manager:</p> <ul>  <li>   <p><code>attachment</code></p></li>  <li>   <p><code>connect-peer</code></p></li>  <li>   <p><code>connection</code></p></li>  <li>   <p><code>core-network</code></p></li>  <li>   <p><code>device</code></p></li>  <li>   <p><code>link</code></p></li>  <li>   <p><code>peering</code></p></li>  <li>   <p><code>site</code></p></li> </ul> <p>The following are the supported resource types for Amazon VPC:</p> <ul>  <li>   <p><code>customer-gateway</code></p></li>  <li>   <p><code>transit-gateway</code></p></li>  <li>   <p><code>transit-gateway-attachment</code></p></li>  <li>   <p><code>transit-gateway-connect-peer</code></p></li>  <li>   <p><code>transit-gateway-route-table</code></p></li>  <li>   <p><code>vpn-connection</code></p></li> </ul><br>
13    ///   - [`resource_arn(impl Into<String>)`](crate::operation::get_network_resource_relationships::builders::GetNetworkResourceRelationshipsFluentBuilder::resource_arn) / [`set_resource_arn(Option<String>)`](crate::operation::get_network_resource_relationships::builders::GetNetworkResourceRelationshipsFluentBuilder::set_resource_arn):<br>required: **false**<br><p>The ARN of the gateway.</p><br>
14    ///   - [`max_results(i32)`](crate::operation::get_network_resource_relationships::builders::GetNetworkResourceRelationshipsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_network_resource_relationships::builders::GetNetworkResourceRelationshipsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return.</p><br>
15    ///   - [`next_token(impl Into<String>)`](crate::operation::get_network_resource_relationships::builders::GetNetworkResourceRelationshipsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_network_resource_relationships::builders::GetNetworkResourceRelationshipsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
16    /// - On success, responds with [`GetNetworkResourceRelationshipsOutput`](crate::operation::get_network_resource_relationships::GetNetworkResourceRelationshipsOutput) with field(s):
17    ///   - [`relationships(Option<Vec::<Relationship>>)`](crate::operation::get_network_resource_relationships::GetNetworkResourceRelationshipsOutput::relationships): <p>The resource relationships.</p>
18    ///   - [`next_token(Option<String>)`](crate::operation::get_network_resource_relationships::GetNetworkResourceRelationshipsOutput::next_token): <p>The token for the next page of results.</p>
19    /// - On failure, responds with [`SdkError<GetNetworkResourceRelationshipsError>`](crate::operation::get_network_resource_relationships::GetNetworkResourceRelationshipsError)
20    pub fn get_network_resource_relationships(
21        &self,
22    ) -> crate::operation::get_network_resource_relationships::builders::GetNetworkResourceRelationshipsFluentBuilder {
23        crate::operation::get_network_resource_relationships::builders::GetNetworkResourceRelationshipsFluentBuilder::new(self.handle.clone())
24    }
25}