[ aws . groundstation ]

list-contacts

Description

Returns a list of contacts.

If statusList contains AVAILABLE, the request must include groundStation , missionprofileArn , and satelliteArn .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-contacts is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: contactList

Synopsis

  list-contacts
--end-time <value>
[--ground-station <value>]
[--mission-profile-arn <value>]
[--satellite-arn <value>]
--start-time <value>
--status-list <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--end-time (timestamp)

End time of a contact.

--ground-station (string)

Name of a ground station.

--mission-profile-arn (string)

ARN of a mission profile.

--satellite-arn (string)

ARN of a satellite.

--start-time (timestamp)

Start time of a contact.

--status-list (list)

Status of a contact reservation.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  AVAILABLE
  AWS_CANCELLED
  AWS_FAILED
  CANCELLED
  CANCELLING
  COMPLETED
  FAILED
  FAILED_TO_SCHEDULE
  PASS
  POSTPASS
  PREPASS
  SCHEDULED
  SCHEDULING

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

contactList -> (list)

List of contacts.

(structure)

Data describing a contact.

contactId -> (string)

UUID of a contact.

contactStatus -> (string)

Status of a contact.

endTime -> (timestamp)

End time of a contact.

errorMessage -> (string)

Error message of a contact.

groundStation -> (string)

Name of a ground station.

maximumElevation -> (structure)

Maximum elevation angle of a contact.

unit -> (string)

Elevation angle units.

value -> (double)

Elevation angle value.

missionProfileArn -> (string)

ARN of a mission profile.

postPassEndTime -> (timestamp)

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

prePassStartTime -> (timestamp)

Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.

region -> (string)

Region of a contact.

satelliteArn -> (string)

ARN of a satellite.

startTime -> (timestamp)

Start time of a contact.

tags -> (map)

Tags assigned to a contact.

key -> (string)

value -> (string)

nextToken -> (string)

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