list_contacts async ¶

async def list_contacts(
    self,
    status_list: "capo_groundstation.types.status_list.StatusList",
    start_time: datetime.datetime,
    end_time: datetime.datetime,
    *,
    config_overrides: Optional[AsyncGroundStationClientConfig] = None,
    max_results: Optional[
        "capo_groundstation.types.pagination_max_results.PaginationMaxResults"
    ] = None,
    next_token: Optional[
        "capo_groundstation.types.pagination_token.PaginationToken"
    ] = None,
    ground_station: Optional[
        "capo_groundstation.types.ground_station_name.GroundStationName"
    ] = None,
    satellite_arn: Optional[
        "capo_groundstation.types.satellite_arn.satelliteArn"
    ] = None,
    mission_profile_arn: Optional[
        "capo_groundstation.types.mission_profile_arn.MissionProfileArn"
    ] = None,
    ephemeris: Optional[
        "capo_groundstation.types.ephemeris_filter.EphemerisFilter"
    ] = None,
) -> "capo_groundstation.types.list_contacts_response.ListContactsResponse":
    """<p>Returns a list of contacts.</p> <p>If <code>statusList</code> contains AVAILABLE, the request must include <code> groundStation</code>, <code>missionprofileArn</code>, and <code>satelliteArn</code>. </p>

    Args:
        max_results: <p>Maximum number of contacts returned.</p>
        next_token: <p>Next token returned in the request of a previous <code>ListContacts</code> call. Used to get the next page of results.</p>
        status_list: <p>Status of a contact reservation.</p>
        start_time: <p>Start time of a contact in UTC.</p>
        end_time: <p>End time of a contact in UTC.</p>
        ground_station: <p>Name of a ground station.</p>
        satellite_arn: <p>ARN of a satellite.</p>
        mission_profile_arn: <p>ARN of a mission profile.</p>
        ephemeris: <p>Filter for selecting contacts that use a specific ephemeris".</p>

    Raises:
        capo_groundstation.errors.dependency_exception.DependencyException: <p>Dependency encountered an error.</p>
        capo_groundstation.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters are not valid.</p>
        capo_groundstation.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource was not found.</p>
        capo_groundstation.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_groundstation.types.list_contacts_request.ListContactsRequest]",
    ) -> AsyncOperationResponse[
        "capo_groundstation.types.list_contacts_response.ListContactsResponse"
    ]:
        import capo_groundstation._operations.ground_station.list_contacts

        (
            output,
            http_response,
        ) = await capo_groundstation._operations.ground_station.list_contacts.async_list_contacts(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListContacts")
    )
    input_: capo_groundstation.types.list_contacts_request.ListContactsRequest = {
        "status_list": status_list,
        "start_time": start_time,
        "end_time": end_time,
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if ground_station is not None:
        input_["ground_station"] = ground_station
    if satellite_arn is not None:
        input_["satellite_arn"] = satellite_arn
    if mission_profile_arn is not None:
        input_["mission_profile_arn"] = mission_profile_arn
    if ephemeris is not None:
        input_["ephemeris"] = ephemeris

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output