AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::NetworkManager::Types::GetLinksRequest

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 GetLinksRequest data as a hash:

{
  global_network_id: "String", # required
  link_ids: ["String"],
  site_id: "String",
  type: "String",
  provider: "String",
  max_results: 1,
  next_token: "String",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#global_network_idString

The ID of the global network.

Returns:

  • (String)


1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 1475

class GetLinksRequest < Struct.new(
  :global_network_id,
  :link_ids,
  :site_id,
  :type,
  :provider,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

One or more link IDs. The maximum is 10.

Returns:

  • (Array<String>)


1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 1475

class GetLinksRequest < Struct.new(
  :global_network_id,
  :link_ids,
  :site_id,
  :type,
  :provider,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return.

Returns:

  • (Integer)


1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 1475

class GetLinksRequest < Struct.new(
  :global_network_id,
  :link_ids,
  :site_id,
  :type,
  :provider,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The token for the next page of results.

Returns:

  • (String)


1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 1475

class GetLinksRequest < Struct.new(
  :global_network_id,
  :link_ids,
  :site_id,
  :type,
  :provider,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#providerString

The link provider.

Returns:

  • (String)


1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 1475

class GetLinksRequest < Struct.new(
  :global_network_id,
  :link_ids,
  :site_id,
  :type,
  :provider,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#site_idString

The ID of the site.

Returns:

  • (String)


1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 1475

class GetLinksRequest < Struct.new(
  :global_network_id,
  :link_ids,
  :site_id,
  :type,
  :provider,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#typeString

The link type.

Returns:

  • (String)


1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 1475

class GetLinksRequest < Struct.new(
  :global_network_id,
  :link_ids,
  :site_id,
  :type,
  :provider,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end