Class: Aws::NetworkManager::Types::GetSitesRequest

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

{
  global_network_id: "String", # required
  site_ids: ["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)


1168
1169
1170
1171
1172
1173
1174
1175
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 1168

class GetSitesRequest < Struct.new(
  :global_network_id,
  :site_ids,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return.

Returns:

  • (Integer)


1168
1169
1170
1171
1172
1173
1174
1175
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 1168

class GetSitesRequest < Struct.new(
  :global_network_id,
  :site_ids,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The token for the next page of results.

Returns:

  • (String)


1168
1169
1170
1171
1172
1173
1174
1175
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 1168

class GetSitesRequest < Struct.new(
  :global_network_id,
  :site_ids,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#site_idsArray<String>

One or more site IDs. The maximum is 10.

Returns:

  • (Array<String>)


1168
1169
1170
1171
1172
1173
1174
1175
# File 'gems/aws-sdk-networkmanager/lib/aws-sdk-networkmanager/types.rb', line 1168

class GetSitesRequest < Struct.new(
  :global_network_id,
  :site_ids,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end