You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::GroundStation::Types::ListContactsRequest

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

Overview

Note:

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

{
  end_time: Time.now, # required
  ground_station: "String",
  max_results: 1,
  mission_profile_arn: "MissionProfileArn",
  next_token: "String",
  satellite_arn: "satelliteArn",
  start_time: Time.now, # required
  status_list: ["AVAILABLE"], # required, accepts AVAILABLE, AWS_CANCELLED, CANCELLED, COMPLETED, FAILED, FAILED_TO_SCHEDULE, PASS, POSTPASS, PREPASS, SCHEDULED, SCHEDULING
}

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTime

End time of a contact.

Returns:

  • (Time)


1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/types.rb', line 1323

class ListContactsRequest < Struct.new(
  :end_time,
  :ground_station,
  :max_results,
  :mission_profile_arn,
  :next_token,
  :satellite_arn,
  :start_time,
  :status_list)
  include Aws::Structure
end

#ground_stationString

Name of a ground station.

Returns:

  • (String)


1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/types.rb', line 1323

class ListContactsRequest < Struct.new(
  :end_time,
  :ground_station,
  :max_results,
  :mission_profile_arn,
  :next_token,
  :satellite_arn,
  :start_time,
  :status_list)
  include Aws::Structure
end

#max_resultsInteger

Maximum number of contacts returned.

Returns:

  • (Integer)


1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/types.rb', line 1323

class ListContactsRequest < Struct.new(
  :end_time,
  :ground_station,
  :max_results,
  :mission_profile_arn,
  :next_token,
  :satellite_arn,
  :start_time,
  :status_list)
  include Aws::Structure
end

#mission_profile_arnString

ARN of a mission profile.

Returns:

  • (String)


1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/types.rb', line 1323

class ListContactsRequest < Struct.new(
  :end_time,
  :ground_station,
  :max_results,
  :mission_profile_arn,
  :next_token,
  :satellite_arn,
  :start_time,
  :status_list)
  include Aws::Structure
end

#next_tokenString

Next token returned in the request of a previous ListContacts call. Used to get the next page of results.

Returns:

  • (String)


1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/types.rb', line 1323

class ListContactsRequest < Struct.new(
  :end_time,
  :ground_station,
  :max_results,
  :mission_profile_arn,
  :next_token,
  :satellite_arn,
  :start_time,
  :status_list)
  include Aws::Structure
end

#satellite_arnString

ARN of a satellite.

Returns:

  • (String)


1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/types.rb', line 1323

class ListContactsRequest < Struct.new(
  :end_time,
  :ground_station,
  :max_results,
  :mission_profile_arn,
  :next_token,
  :satellite_arn,
  :start_time,
  :status_list)
  include Aws::Structure
end

#start_timeTime

Start time of a contact.

Returns:

  • (Time)


1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/types.rb', line 1323

class ListContactsRequest < Struct.new(
  :end_time,
  :ground_station,
  :max_results,
  :mission_profile_arn,
  :next_token,
  :satellite_arn,
  :start_time,
  :status_list)
  include Aws::Structure
end

#status_listArray<String>

Status of a contact reservation.

Returns:

  • (Array<String>)


1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
# File 'gems/aws-sdk-groundstation/lib/aws-sdk-groundstation/types.rb', line 1323

class ListContactsRequest < Struct.new(
  :end_time,
  :ground_station,
  :max_results,
  :mission_profile_arn,
  :next_token,
  :satellite_arn,
  :start_time,
  :status_list)
  include Aws::Structure
end