Class: Aws::NetworkManager::Types::ListPeeringsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb

Overview

Note:

When making an API call, you may pass ListPeeringsRequest data as a hash:

{
  core_network_id: "CoreNetworkId",
  peering_type: "TRANSIT_GATEWAY", # accepts TRANSIT_GATEWAY
  edge_location: "ExternalRegionCode",
  state: "CREATING", # accepts CREATING, FAILED, AVAILABLE, DELETING
  max_results: 1,
  next_token: "NextToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#core_network_idString

The ID of a core network.

Returns:

  • (String)


4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 4791

class ListPeeringsRequest < Struct.new(
  :core_network_id,
  :peering_type,
  :edge_location,
  :state,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#edge_locationString

Returns a list edge locations for the

Returns:

  • (String)


4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 4791

class ListPeeringsRequest < Struct.new(
  :core_network_id,
  :peering_type,
  :edge_location,
  :state,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return.

Returns:

  • (Integer)


4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 4791

class ListPeeringsRequest < Struct.new(
  :core_network_id,
  :peering_type,
  :edge_location,
  :state,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The token for the next page of results.

Returns:

  • (String)


4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 4791

class ListPeeringsRequest < Struct.new(
  :core_network_id,
  :peering_type,
  :edge_location,
  :state,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#peering_typeString

Returns a list of a peering requests.

Returns:

  • (String)


4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 4791

class ListPeeringsRequest < Struct.new(
  :core_network_id,
  :peering_type,
  :edge_location,
  :state,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

Returns a list of the peering request states.

Returns:

  • (String)


4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 4791

class ListPeeringsRequest < Struct.new(
  :core_network_id,
  :peering_type,
  :edge_location,
  :state,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end