GroundStation / Client / list_contacts

list_contacts

GroundStation.Client.list_contacts(**kwargs)

Returns a list of contacts.

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

See also: AWS API Documentation

Request Syntax

response = client.list_contacts(
    endTime=datetime(2015, 1, 1),
    groundStation='string',
    maxResults=123,
    missionProfileArn='string',
    nextToken='string',
    satelliteArn='string',
    startTime=datetime(2015, 1, 1),
    statusList=[
        'AVAILABLE'|'AWS_CANCELLED'|'AWS_FAILED'|'CANCELLED'|'CANCELLING'|'COMPLETED'|'FAILED'|'FAILED_TO_SCHEDULE'|'PASS'|'POSTPASS'|'PREPASS'|'SCHEDULED'|'SCHEDULING',
    ]
)

Parameters:

• endTime (datetime) –

  [REQUIRED]

  End time of a contact in UTC.

• groundStation (string) – Name of a ground station.

• maxResults (integer) – Maximum number of contacts returned.

• missionProfileArn (string) – ARN of a mission profile.

• nextToken (string) – Next token returned in the request of a previous ListContacts call. Used to get the next page of results.

• satelliteArn (string) – ARN of a satellite.

• startTime (datetime) –

  [REQUIRED]

  Start time of a contact in UTC.

• statusList (list) –

  [REQUIRED]

  Status of a contact reservation.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'contactList': [
        {
            'contactId': 'string',
            'contactStatus': 'AVAILABLE'|'AWS_CANCELLED'|'AWS_FAILED'|'CANCELLED'|'CANCELLING'|'COMPLETED'|'FAILED'|'FAILED_TO_SCHEDULE'|'PASS'|'POSTPASS'|'PREPASS'|'SCHEDULED'|'SCHEDULING',
            'endTime': datetime(2015, 1, 1),
            'errorMessage': 'string',
            'groundStation': 'string',
            'maximumElevation': {
                'unit': 'DEGREE_ANGLE'|'RADIAN',
                'value': 123.0
            },
            'missionProfileArn': 'string',
            'postPassEndTime': datetime(2015, 1, 1),
            'prePassStartTime': datetime(2015, 1, 1),
            'region': 'string',
            'satelliteArn': 'string',
            'startTime': datetime(2015, 1, 1),
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • contactList (list) –

    List of contacts.

    • (dict) –

      Data describing a contact.

      • contactId (string) –

        UUID of a contact.

      • contactStatus (string) –

        Status of a contact.

      • endTime (datetime) –

        End time of a contact in UTC.

      • errorMessage (string) –

        Error message of a contact.

      • groundStation (string) –

        Name of a ground station.

      • maximumElevation (dict) –

        Maximum elevation angle of a contact.

        • unit (string) –

          Elevation angle units.

        • value (float) –

          Elevation angle value.

      • missionProfileArn (string) –

        ARN of a mission profile.

      • postPassEndTime (datetime) –

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

      • prePassStartTime (datetime) –

        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 (datetime) –

        Start time of a contact in UTC.

      • tags (dict) –

        Tags assigned to a contact.

        • (string) –

          • (string) –

  • nextToken (string) –

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

Exceptions

• GroundStation.Client.exceptions.InvalidParameterException

• GroundStation.Client.exceptions.DependencyException

• GroundStation.Client.exceptions.ResourceNotFoundException