Reserving and Managing Contacts with AWS CLI - AWS Ground Station

Reserving and Managing Contacts with AWS CLI

You can use AWS CLI to reserve and manage your contacts in AWS Ground Station. Before using AWS CLI to reserve and manage contacts, the following AWS CLI prerequisites must be fulfilled:

  • Ensure that AWS CLI is installed. For information about installing AWS CLI, see Installing the AWS CLI version 2.

  • Ensure that AWS CLI is configured. For information about configuring AWS CLI, see Configuring the AWS CLI version 2.

  • Save your frequently used configuration settings and credentials in files that are maintained by the AWS CLI. You need these settings and credentials to reserve and manage your AWS Ground Station contacts with AWS CLI. For more information about saving your configuration and credential settings, see Configuration and Credential File Settings .

Once AWS CLI is configured and ready to use, review the AWS Ground Station CLI Command Reference page to familiarize yourself with available commands. Follow the AWS CLI command structure when using this service and prefix your commands with groundstation to specify AWS Ground Station as the service you want to use. For more information on the AWS CLI command structure, see Command Structure in the AWS CLI page. An example command structure is provided below.

aws groundstation <command> <subcommand> [options and parameters]

Use the following topics to reserve, view, and cancel contacts with AWS CLI.

View and List Contacts with AWS CLI

To list and view CANCELLED, COMPLETED, or SCHEDULED contacts with AWS CLI, run aws groundstation list-contacts with the following parameters.

  • Start Time - Specify the start time of your contact with --start-time <value>. The following is an acceptable time value format: YYYY-MM-DDTHH:MM:SSZ

  • End Time - Specify the end time of your contact with --end-time <value>. The following is an acceptable time value format: YYYY-MM-DDTHH:MM:SSZ

  • Status List - Specify the status of your contact with --status-list <value>. Acceptable values include AVAILABLE, CANCELLED, COMPLETED, or SCHEDULED. To see a full list of valid values, see list-contacts.

To list and view AVAILABLE contacts with AWS CLI the following parameters are required in addition to the ones listed above.

  • Ground Station ID - Specify your ground station's ID with --ground-station <value>.

  • Mission Profile ARN - Specify your mission profile's ARN with --mission-profile-arn <value>.

  • Satellite ARN - Specify your satellite ARN with --satellite-arn <value>.

You can use list commands to look up your resources. For more information on specifying your parameters, see list-contacts

An example command to list available contacts is provided below.

aws groundstation --region us-east-2 list-contacts --ground-station 'Ohio 1' --mission-profile-arn 'arn:aws:groundstation:us-east-2:123456789012:mission-profile/11111111-2222-3333-4444-555555555555' --satellite-arn 'arn:aws:groundstation::123456789012:satellite/11111111-2222-3333-4444-555555555555' --start-time '2020-04-10T00:09:22Z' --end-time '2020-04-10T00:11:22' --status-list 'AVAILABLE'

An example of a list of available contacts is provided below.

{ "contactList": [ { "contactStatus": "AVAILABLE", "endTime": "2020-04-15T03:16:35-06:00", "groundStation": "Oregon 1", "maximumElevation": { "unit": "DEGREE_ANGLE", "value": 11.22 }, "missionProfileArn": "arn:aws:groundstation:us-west-2:111111111111:mission-profile/11111111-2222-3333-4444-555555555555", "region": "us-west-2", "satelliteArn": "arn:aws:groundstation::111111111111:satellite/11111111-2222-3333-4444-555555555555", "startTime": "2020-04-15T03:06:08-06:00" } ] }

Reserve a Contact with AWS CLI

AWS CLI gives you the option to reserve contacts by the minute. This feature is unique to the AWS CLI and cannot be done in the AWS Ground Station console.

To reserve contacts with AWS CLI, run aws groundstation reserve-contact with the following parameters.

  • Ground Station ID - Specify your ground station's ID with --ground-station <value>.

  • Mission Profile ARN - Specify your mission profile's ARN with --mission-profile-arn <value>.

  • Satellite ARN - Specify your satellite ARN with --satellite-arn <value>.

  • Start Time - Specify the start time of your contact with --start-time <value>. The following is an acceptable time value format: YYYY-MM-DDTHH:MM:SSZ

  • End Time - Specify the end time of your contact with --end-time <value>. The following is an acceptable time value format: YYYY-MM-DDTHH:MM:SSZ

Contact reservation is an asynchronous process. The response to the reserve-contact command provides the contact identifier. In order to determine the outcome of the asynchronous reservation process, use describe-contact. For more information on this, see the section below titled Describe a Contact with AWS CLI.

You can use list commands to look up your resources. For more information on specifying your parameters, see reserve-contact.

An example command of reserving a contact is provided below.

aws groundstation reserve-contact --ground-station 'Ohio 1' --mission-profile-arn 'arn:aws:groundstation:us-east-2:123456789012:mission-profile/11111111-2222-3333-4444-555555555555' --satellite-arn 'arn:aws:groundstation::123456789012:satellite/11111111-2222-3333-4444-555555555555' --start-time '2020-04-10T00:09:22Z' --end-time '2020-04-10T00:11:22'

An example of a successfully reserved contact is provided below.

{ "contactId": "11111111-2222-3333-4444-555555555555" }

Describe a Contact with AWS CLI

To see the status of a contact/reservation with AWS CLI, use the describe-contact CLI command. This is helpful for verifying the outcome of the asynchronous contact reservation process, monitoring the status of an in-progress contact, and determining the status of a finished contact.

To describe contacts with AWS CLI, run aws groundstation describe-contact with the following parameters.

  • Contact ID - Specify your contact ID with --contact-id <value>.

You can use list commands to look up your resources. For more information on specifying your parameters, see describe-contact.

An example command of describing a contact is provided below.

aws groundstation describe-contact --contact-id 11111111-2222-3333-4444-555555555555

An example of a successfully scheduled contact is provided below.

{ "groundStation": "Ireland 1", "tags": {}, "missionProfileArn": "arn:aws:groundstation:us-west-2:111111111111:mission-profile/11111111-2222-3333-4444-555555555555", "region": "us-west-2", "contactId": "11111111-2222-3333-4444-555555555555", "prePassStartTime": 1645850471.0, "postPassEndTime": 1645851172.0, "startTime": 1645850591.0, "maximumElevation": { "value": 12.66, "unit": "DEGREE_ANGLE" }, "satelliteArn": "arn:aws:groundstation::111111111111:satellite/11111111-2222-3333-4444-555555555555", "endTime": 1645851052.0, "contactStatus": "SCHEDULED" }

Cancel a Contact with AWS CLI

To cancel a contact with AWS CLI, run aws groundstation cancel-contact with the following parameters.

  • Region - Specify your ground station's region with --region <value>.

  • Contact ID - Specify the contact ID with --contact-id <value>.

You can use list commands to look up your resources. For more information on specifying your parameters, see cancel-contacts

An example command of reserving a contact is provided below.

aws groundstation --region us-east-2 cancel-contact --contact-id '11111111-2222-3333-4444-555555555555'

An example of a successfully cancelled contact is provided below.

{ "contactId": "11111111-2222-3333-4444-555555555555" }