reserve_contact ¶

def reserve_contact(
    self,
    mission_profile_arn: "capo_groundstation.types.mission_profile_arn.MissionProfileArn",
    start_time: datetime.datetime,
    end_time: datetime.datetime,
    ground_station: "capo_groundstation.types.ground_station_name.GroundStationName",
    *,
    config_overrides: Optional[GroundStationClientConfig] = None,
    satellite_arn: Optional[
        "capo_groundstation.types.satellite_arn.satelliteArn"
    ] = None,
    tags: Optional["capo_groundstation.types.tags_map.TagsMap"] = None,
    tracking_overrides: Optional[
        "capo_groundstation.types.tracking_overrides.TrackingOverrides"
    ] = None,
) -> "capo_groundstation.types.contact_id_response.ContactIdResponse":
    """<p>Reserves a contact using specified parameters.</p>

    Args:
        mission_profile_arn: <p>ARN of a mission profile.</p>
        satellite_arn: <p>ARN of a satellite</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>
        tags: <p>Tags assigned to a contact.</p>
        tracking_overrides: <p>Tracking configuration overrides for the contact.</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_limit_exceeded_exception.ResourceLimitExceededException: <p>Account limits for this resource have been exceeded.</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.
    """

    def _handler(
        req: "OperationRequest[capo_groundstation.types.reserve_contact_request.ReserveContactRequest]",
    ) -> OperationResponse[
        "capo_groundstation.types.contact_id_response.ContactIdResponse"
    ]:
        import capo_groundstation._operations.ground_station.reserve_contact

        output, http_response = (
            capo_groundstation._operations.ground_station.reserve_contact.reserve_contact(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ReserveContact")
    )
    input_: capo_groundstation.types.reserve_contact_request.ReserveContactRequest = {
        "mission_profile_arn": mission_profile_arn,
        "start_time": start_time,
        "end_time": end_time,
        "ground_station": ground_station,
    }
    if satellite_arn is not None:
        input_["satellite_arn"] = satellite_arn
    if tags is not None:
        input_["tags"] = tags
    if tracking_overrides is not None:
        input_["tracking_overrides"] = tracking_overrides

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output